1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
31
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
65
import bzrlib.commands
66
import bzrlib.timestamp
68
import bzrlib.inventory
69
import bzrlib.iterablefile
74
# lsprof not available
76
from bzrlib.merge import merge_inner
79
from bzrlib.smart import client, server
81
from bzrlib import symbol_versioning
82
from bzrlib.symbol_versioning import (
89
from bzrlib.transport import get_transport
90
import bzrlib.transport
91
from bzrlib.transport.local import LocalURLServer
92
from bzrlib.transport.memory import MemoryServer
93
from bzrlib.transport.readonly import ReadonlyServer
94
from bzrlib.trace import mutter, note
95
from bzrlib.tests import TestUtil
96
from bzrlib.tests.http_server import HttpServer
97
from bzrlib.tests.TestUtil import (
101
from bzrlib.tests.treeshape import build_tree_contents
102
import bzrlib.version_info_formats.format_custom
103
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
105
# Mark this python module as being part of the implementation
106
# of unittest: this gives us better tracebacks where the last
107
# shown frame is the test code, not our assertXYZ.
110
default_transport = LocalURLServer
113
class ExtendedTestResult(unittest._TextTestResult):
114
"""Accepts, reports and accumulates the results of running tests.
116
Compared to the unittest version this class adds support for
117
profiling, benchmarking, stopping as soon as a test fails, and
118
skipping tests. There are further-specialized subclasses for
119
different types of display.
121
When a test finishes, in whatever way, it calls one of the addSuccess,
122
addFailure or addError classes. These in turn may redirect to a more
123
specific case for the special test results supported by our extended
126
Note that just one of these objects is fed the results from many tests.
131
def __init__(self, stream, descriptions, verbosity,
135
"""Construct new TestResult.
137
:param bench_history: Optionally, a writable file object to accumulate
140
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
141
if bench_history is not None:
142
from bzrlib.version import _get_bzr_source_tree
143
src_tree = _get_bzr_source_tree()
146
revision_id = src_tree.get_parent_ids()[0]
148
# XXX: if this is a brand new tree, do the same as if there
152
# XXX: If there's no branch, what should we do?
154
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
155
self._bench_history = bench_history
156
self.ui = ui.ui_factory
157
self.num_tests = num_tests
159
self.failure_count = 0
160
self.known_failure_count = 0
162
self.not_applicable_count = 0
163
self.unsupported = {}
165
self._overall_start_time = time.time()
167
def _extractBenchmarkTime(self, testCase):
168
"""Add a benchmark time for the current test case."""
169
return getattr(testCase, "_benchtime", None)
171
def _elapsedTestTimeString(self):
172
"""Return a time string for the overall time the current test has taken."""
173
return self._formatTime(time.time() - self._start_time)
175
def _testTimeString(self, testCase):
176
benchmark_time = self._extractBenchmarkTime(testCase)
177
if benchmark_time is not None:
179
self._formatTime(benchmark_time),
180
self._elapsedTestTimeString())
182
return " %s" % self._elapsedTestTimeString()
184
def _formatTime(self, seconds):
185
"""Format seconds as milliseconds with leading spaces."""
186
# some benchmarks can take thousands of seconds to run, so we need 8
188
return "%8dms" % (1000 * seconds)
190
def _shortened_test_description(self, test):
192
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
195
def startTest(self, test):
196
unittest.TestResult.startTest(self, test)
197
self.report_test_start(test)
198
test.number = self.count
199
self._recordTestStartTime()
201
def _recordTestStartTime(self):
202
"""Record that a test has started."""
203
self._start_time = time.time()
205
def _cleanupLogFile(self, test):
206
# We can only do this if we have one of our TestCases, not if
208
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
209
if setKeepLogfile is not None:
212
def addError(self, test, err):
213
"""Tell result that test finished with an error.
215
Called from the TestCase run() method when the test
216
fails with an unexpected error.
218
self._testConcluded(test)
219
if isinstance(err[1], TestNotApplicable):
220
return self._addNotApplicable(test, err)
221
elif isinstance(err[1], UnavailableFeature):
222
return self.addNotSupported(test, err[1].args[0])
224
unittest.TestResult.addError(self, test, err)
225
self.error_count += 1
226
self.report_error(test, err)
229
self._cleanupLogFile(test)
231
def addFailure(self, test, err):
232
"""Tell result that test failed.
234
Called from the TestCase run() method when the test
235
fails because e.g. an assert() method failed.
237
self._testConcluded(test)
238
if isinstance(err[1], KnownFailure):
239
return self._addKnownFailure(test, err)
241
unittest.TestResult.addFailure(self, test, err)
242
self.failure_count += 1
243
self.report_failure(test, err)
246
self._cleanupLogFile(test)
248
def addSuccess(self, test):
249
"""Tell result that test completed successfully.
251
Called from the TestCase run()
253
self._testConcluded(test)
254
if self._bench_history is not None:
255
benchmark_time = self._extractBenchmarkTime(test)
256
if benchmark_time is not None:
257
self._bench_history.write("%s %s\n" % (
258
self._formatTime(benchmark_time),
260
self.report_success(test)
261
self._cleanupLogFile(test)
262
unittest.TestResult.addSuccess(self, test)
263
test._log_contents = ''
265
def _testConcluded(self, test):
266
"""Common code when a test has finished.
268
Called regardless of whether it succeded, failed, etc.
272
def _addKnownFailure(self, test, err):
273
self.known_failure_count += 1
274
self.report_known_failure(test, err)
276
def addNotSupported(self, test, feature):
277
"""The test will not be run because of a missing feature.
279
# this can be called in two different ways: it may be that the
280
# test started running, and then raised (through addError)
281
# UnavailableFeature. Alternatively this method can be called
282
# while probing for features before running the tests; in that
283
# case we will see startTest and stopTest, but the test will never
285
self.unsupported.setdefault(str(feature), 0)
286
self.unsupported[str(feature)] += 1
287
self.report_unsupported(test, feature)
289
def addSkip(self, test, reason):
290
"""A test has not run for 'reason'."""
292
self.report_skip(test, reason)
294
def _addNotApplicable(self, test, skip_excinfo):
295
if isinstance(skip_excinfo[1], TestNotApplicable):
296
self.not_applicable_count += 1
297
self.report_not_applicable(test, skip_excinfo)
300
except KeyboardInterrupt:
303
self.addError(test, test.exc_info())
305
# seems best to treat this as success from point-of-view of unittest
306
# -- it actually does nothing so it barely matters :)
307
unittest.TestResult.addSuccess(self, test)
308
test._log_contents = ''
310
def printErrorList(self, flavour, errors):
311
for test, err in errors:
312
self.stream.writeln(self.separator1)
313
self.stream.write("%s: " % flavour)
314
self.stream.writeln(self.getDescription(test))
315
if getattr(test, '_get_log', None) is not None:
316
self.stream.write('\n')
318
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
319
self.stream.write('\n')
320
self.stream.write(test._get_log())
321
self.stream.write('\n')
323
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
324
self.stream.write('\n')
325
self.stream.writeln(self.separator2)
326
self.stream.writeln("%s" % err)
331
def report_cleaning_up(self):
334
def report_success(self, test):
337
def wasStrictlySuccessful(self):
338
if self.unsupported or self.known_failure_count:
340
return self.wasSuccessful()
343
class TextTestResult(ExtendedTestResult):
344
"""Displays progress and results of tests in text form"""
346
def __init__(self, stream, descriptions, verbosity,
351
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
352
bench_history, num_tests)
354
self.pb = self.ui.nested_progress_bar()
355
self._supplied_pb = False
358
self._supplied_pb = True
359
self.pb.show_pct = False
360
self.pb.show_spinner = False
361
self.pb.show_eta = False,
362
self.pb.show_count = False
363
self.pb.show_bar = False
365
def report_starting(self):
366
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
368
def _progress_prefix_text(self):
369
# the longer this text, the less space we have to show the test
371
a = '[%d' % self.count # total that have been run
372
# tests skipped as known not to be relevant are not important enough
374
## if self.skip_count:
375
## a += ', %d skip' % self.skip_count
376
## if self.known_failure_count:
377
## a += '+%dX' % self.known_failure_count
378
if self.num_tests is not None:
379
a +='/%d' % self.num_tests
381
runtime = time.time() - self._overall_start_time
383
a += '%dm%ds' % (runtime / 60, runtime % 60)
387
a += ', %d err' % self.error_count
388
if self.failure_count:
389
a += ', %d fail' % self.failure_count
391
a += ', %d missing' % len(self.unsupported)
395
def report_test_start(self, test):
398
self._progress_prefix_text()
400
+ self._shortened_test_description(test))
402
def _test_description(self, test):
403
return self._shortened_test_description(test)
405
def report_error(self, test, err):
406
self.pb.note('ERROR: %s\n %s\n',
407
self._test_description(test),
411
def report_failure(self, test, err):
412
self.pb.note('FAIL: %s\n %s\n',
413
self._test_description(test),
417
def report_known_failure(self, test, err):
418
self.pb.note('XFAIL: %s\n%s\n',
419
self._test_description(test), err[1])
421
def report_skip(self, test, reason):
424
def report_not_applicable(self, test, skip_excinfo):
427
def report_unsupported(self, test, feature):
428
"""test cannot be run because feature is missing."""
430
def report_cleaning_up(self):
431
self.pb.update('cleaning up...')
434
if not self._supplied_pb:
438
class VerboseTestResult(ExtendedTestResult):
439
"""Produce long output, with one line per test run plus times"""
441
def _ellipsize_to_right(self, a_string, final_width):
442
"""Truncate and pad a string, keeping the right hand side"""
443
if len(a_string) > final_width:
444
result = '...' + a_string[3-final_width:]
447
return result.ljust(final_width)
449
def report_starting(self):
450
self.stream.write('running %d tests...\n' % self.num_tests)
452
def report_test_start(self, test):
454
name = self._shortened_test_description(test)
455
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
456
# numbers, plus a trailing blank
457
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
458
self.stream.write(self._ellipsize_to_right(name,
459
osutils.terminal_width()-30))
462
def _error_summary(self, err):
464
return '%s%s' % (indent, err[1])
466
def report_error(self, test, err):
467
self.stream.writeln('ERROR %s\n%s'
468
% (self._testTimeString(test),
469
self._error_summary(err)))
471
def report_failure(self, test, err):
472
self.stream.writeln(' FAIL %s\n%s'
473
% (self._testTimeString(test),
474
self._error_summary(err)))
476
def report_known_failure(self, test, err):
477
self.stream.writeln('XFAIL %s\n%s'
478
% (self._testTimeString(test),
479
self._error_summary(err)))
481
def report_success(self, test):
482
self.stream.writeln(' OK %s' % self._testTimeString(test))
483
for bench_called, stats in getattr(test, '_benchcalls', []):
484
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
485
stats.pprint(file=self.stream)
486
# flush the stream so that we get smooth output. This verbose mode is
487
# used to show the output in PQM.
490
def report_skip(self, test, reason):
491
self.stream.writeln(' SKIP %s\n%s'
492
% (self._testTimeString(test), reason))
494
def report_not_applicable(self, test, skip_excinfo):
495
self.stream.writeln(' N/A %s\n%s'
496
% (self._testTimeString(test),
497
self._error_summary(skip_excinfo)))
499
def report_unsupported(self, test, feature):
500
"""test cannot be run because feature is missing."""
501
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
502
%(self._testTimeString(test), feature))
505
class TextTestRunner(object):
506
stop_on_failure = False
515
self.stream = unittest._WritelnDecorator(stream)
516
self.descriptions = descriptions
517
self.verbosity = verbosity
518
self._bench_history = bench_history
519
self.list_only = list_only
522
"Run the given test case or test suite."
523
startTime = time.time()
524
if self.verbosity == 1:
525
result_class = TextTestResult
526
elif self.verbosity >= 2:
527
result_class = VerboseTestResult
528
result = result_class(self.stream,
531
bench_history=self._bench_history,
532
num_tests=test.countTestCases(),
534
result.stop_early = self.stop_on_failure
535
result.report_starting()
537
if self.verbosity >= 2:
538
self.stream.writeln("Listing tests only ...\n")
540
for t in iter_suite_tests(test):
541
self.stream.writeln("%s" % (t.id()))
543
actionTaken = "Listed"
546
run = result.testsRun
548
stopTime = time.time()
549
timeTaken = stopTime - startTime
551
self.stream.writeln(result.separator2)
552
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
553
run, run != 1 and "s" or "", timeTaken))
554
self.stream.writeln()
555
if not result.wasSuccessful():
556
self.stream.write("FAILED (")
557
failed, errored = map(len, (result.failures, result.errors))
559
self.stream.write("failures=%d" % failed)
561
if failed: self.stream.write(", ")
562
self.stream.write("errors=%d" % errored)
563
if result.known_failure_count:
564
if failed or errored: self.stream.write(", ")
565
self.stream.write("known_failure_count=%d" %
566
result.known_failure_count)
567
self.stream.writeln(")")
569
if result.known_failure_count:
570
self.stream.writeln("OK (known_failures=%d)" %
571
result.known_failure_count)
573
self.stream.writeln("OK")
574
if result.skip_count > 0:
575
skipped = result.skip_count
576
self.stream.writeln('%d test%s skipped' %
577
(skipped, skipped != 1 and "s" or ""))
578
if result.unsupported:
579
for feature, count in sorted(result.unsupported.items()):
580
self.stream.writeln("Missing feature '%s' skipped %d tests." %
586
def iter_suite_tests(suite):
587
"""Return all tests in a suite, recursing through nested suites"""
588
for item in suite._tests:
589
if isinstance(item, unittest.TestCase):
591
elif isinstance(item, unittest.TestSuite):
592
for r in iter_suite_tests(item):
595
raise Exception('unknown object %r inside test suite %r'
599
class TestSkipped(Exception):
600
"""Indicates that a test was intentionally skipped, rather than failing."""
603
class TestNotApplicable(TestSkipped):
604
"""A test is not applicable to the situation where it was run.
606
This is only normally raised by parameterized tests, if they find that
607
the instance they're constructed upon does not support one aspect
612
class KnownFailure(AssertionError):
613
"""Indicates that a test failed in a precisely expected manner.
615
Such failures dont block the whole test suite from passing because they are
616
indicators of partially completed code or of future work. We have an
617
explicit error for them so that we can ensure that they are always visible:
618
KnownFailures are always shown in the output of bzr selftest.
622
class UnavailableFeature(Exception):
623
"""A feature required for this test was not available.
625
The feature should be used to construct the exception.
629
class CommandFailed(Exception):
633
class StringIOWrapper(object):
634
"""A wrapper around cStringIO which just adds an encoding attribute.
636
Internally we can check sys.stdout to see what the output encoding
637
should be. However, cStringIO has no encoding attribute that we can
638
set. So we wrap it instead.
643
def __init__(self, s=None):
645
self.__dict__['_cstring'] = StringIO(s)
647
self.__dict__['_cstring'] = StringIO()
649
def __getattr__(self, name, getattr=getattr):
650
return getattr(self.__dict__['_cstring'], name)
652
def __setattr__(self, name, val):
653
if name == 'encoding':
654
self.__dict__['encoding'] = val
656
return setattr(self._cstring, name, val)
659
class TestUIFactory(ui.CLIUIFactory):
660
"""A UI Factory for testing.
662
Hide the progress bar but emit note()s.
664
Allows get_password to be tested without real tty attached.
671
super(TestUIFactory, self).__init__()
672
if stdin is not None:
673
# We use a StringIOWrapper to be able to test various
674
# encodings, but the user is still responsible to
675
# encode the string and to set the encoding attribute
676
# of StringIOWrapper.
677
self.stdin = StringIOWrapper(stdin)
679
self.stdout = sys.stdout
683
self.stderr = sys.stderr
688
"""See progress.ProgressBar.clear()."""
690
def clear_term(self):
691
"""See progress.ProgressBar.clear_term()."""
693
def clear_term(self):
694
"""See progress.ProgressBar.clear_term()."""
697
"""See progress.ProgressBar.finished()."""
699
def note(self, fmt_string, *args, **kwargs):
700
"""See progress.ProgressBar.note()."""
701
self.stdout.write((fmt_string + "\n") % args)
703
def progress_bar(self):
706
def nested_progress_bar(self):
709
def update(self, message, count=None, total=None):
710
"""See progress.ProgressBar.update()."""
712
def get_non_echoed_password(self, prompt):
713
"""Get password from stdin without trying to handle the echo mode"""
715
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
716
password = self.stdin.readline()
719
if password[-1] == '\n':
720
password = password[:-1]
724
def _report_leaked_threads():
725
bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
726
TestCase._first_thread_leaker_id,
727
TestCase._leaking_threads_tests)
730
class TestCase(unittest.TestCase):
731
"""Base class for bzr unit tests.
733
Tests that need access to disk resources should subclass
734
TestCaseInTempDir not TestCase.
736
Error and debug log messages are redirected from their usual
737
location into a temporary file, the contents of which can be
738
retrieved by _get_log(). We use a real OS file, not an in-memory object,
739
so that it can also capture file IO. When the test completes this file
740
is read into memory and removed from disk.
742
There are also convenience functions to invoke bzr's command-line
743
routine, and to build and check bzr trees.
745
In addition to the usual method of overriding tearDown(), this class also
746
allows subclasses to register functions into the _cleanups list, which is
747
run in order as the object is torn down. It's less likely this will be
748
accidentally overlooked.
751
_active_threads = None
752
_leaking_threads_tests = 0
753
_first_thread_leaker_id = None
754
_log_file_name = None
756
_keep_log_file = False
757
# record lsprof data when performing benchmark calls.
758
_gather_lsprof_in_benchmarks = False
759
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
760
'_log_contents', '_log_file_name', '_benchtime',
761
'_TestCase__testMethodName')
763
def __init__(self, methodName='testMethod'):
764
super(TestCase, self).__init__(methodName)
768
unittest.TestCase.setUp(self)
769
self._cleanEnvironment()
772
self._benchcalls = []
773
self._benchtime = None
775
self._clear_debug_flags()
776
TestCase._active_threads = threading.activeCount()
777
self.addCleanup(self._check_leaked_threads)
780
absent_attr = object()
781
exc_info = getattr(self, '_exc_info', absent_attr)
782
if exc_info is absent_attr:
783
exc_info = getattr(self, '_TestCase__exc_info')
786
def _check_leaked_threads(self):
787
active = threading.activeCount()
788
leaked_threads = active - TestCase._active_threads
789
TestCase._active_threads = active
791
TestCase._leaking_threads_tests += 1
792
if TestCase._first_thread_leaker_id is None:
793
TestCase._first_thread_leaker_id = self.id()
794
# we're not specifically told when all tests are finished.
795
# This will do. We use a function to avoid keeping a reference
796
# to a TestCase object.
797
atexit.register(_report_leaked_threads)
799
def _clear_debug_flags(self):
800
"""Prevent externally set debug flags affecting tests.
802
Tests that want to use debug flags can just set them in the
803
debug_flags set during setup/teardown.
805
self._preserved_debug_flags = set(debug.debug_flags)
806
if 'allow_debug' not in selftest_debug_flags:
807
debug.debug_flags.clear()
808
self.addCleanup(self._restore_debug_flags)
810
def _clear_hooks(self):
811
# prevent hooks affecting tests
813
import bzrlib.smart.client
814
import bzrlib.smart.server
815
self._preserved_hooks = {
816
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
817
bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
818
bzrlib.smart.client._SmartClient: bzrlib.smart.client._SmartClient.hooks,
819
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
820
bzrlib.commands.Command: bzrlib.commands.Command.hooks,
822
self.addCleanup(self._restoreHooks)
823
# reset all hooks to an empty instance of the appropriate type
824
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
825
bzrlib.smart.client._SmartClient.hooks = bzrlib.smart.client.SmartClientHooks()
826
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
827
bzrlib.commands.Command.hooks = bzrlib.commands.CommandHooks()
829
def _silenceUI(self):
830
"""Turn off UI for duration of test"""
831
# by default the UI is off; tests can turn it on if they want it.
832
saved = ui.ui_factory
834
ui.ui_factory = saved
835
ui.ui_factory = ui.SilentUIFactory()
836
self.addCleanup(_restore)
838
def _ndiff_strings(self, a, b):
839
"""Return ndiff between two strings containing lines.
841
A trailing newline is added if missing to make the strings
843
if b and b[-1] != '\n':
845
if a and a[-1] != '\n':
847
difflines = difflib.ndiff(a.splitlines(True),
849
linejunk=lambda x: False,
850
charjunk=lambda x: False)
851
return ''.join(difflines)
853
def assertEqual(self, a, b, message=''):
857
except UnicodeError, e:
858
# If we can't compare without getting a UnicodeError, then
859
# obviously they are different
860
mutter('UnicodeError: %s', e)
863
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
865
pformat(a), pformat(b)))
867
assertEquals = assertEqual
869
def assertEqualDiff(self, a, b, message=None):
870
"""Assert two texts are equal, if not raise an exception.
872
This is intended for use with multi-line strings where it can
873
be hard to find the differences by eye.
875
# TODO: perhaps override assertEquals to call this for strings?
879
message = "texts not equal:\n"
881
message = 'first string is missing a final newline.\n'
883
message = 'second string is missing a final newline.\n'
884
raise AssertionError(message +
885
self._ndiff_strings(a, b))
887
def assertEqualMode(self, mode, mode_test):
888
self.assertEqual(mode, mode_test,
889
'mode mismatch %o != %o' % (mode, mode_test))
891
def assertEqualStat(self, expected, actual):
892
"""assert that expected and actual are the same stat result.
894
:param expected: A stat result.
895
:param actual: A stat result.
896
:raises AssertionError: If the expected and actual stat values differ
899
self.assertEqual(expected.st_size, actual.st_size)
900
self.assertEqual(expected.st_mtime, actual.st_mtime)
901
self.assertEqual(expected.st_ctime, actual.st_ctime)
902
self.assertEqual(expected.st_dev, actual.st_dev)
903
self.assertEqual(expected.st_ino, actual.st_ino)
904
self.assertEqual(expected.st_mode, actual.st_mode)
906
def assertPositive(self, val):
907
"""Assert that val is greater than 0."""
908
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
910
def assertNegative(self, val):
911
"""Assert that val is less than 0."""
912
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
914
def assertStartsWith(self, s, prefix):
915
if not s.startswith(prefix):
916
raise AssertionError('string %r does not start with %r' % (s, prefix))
918
def assertEndsWith(self, s, suffix):
919
"""Asserts that s ends with suffix."""
920
if not s.endswith(suffix):
921
raise AssertionError('string %r does not end with %r' % (s, suffix))
923
def assertContainsRe(self, haystack, needle_re, flags=0):
924
"""Assert that a contains something matching a regular expression."""
925
if not re.search(needle_re, haystack, flags):
926
if '\n' in haystack or len(haystack) > 60:
927
# a long string, format it in a more readable way
928
raise AssertionError(
929
'pattern "%s" not found in\n"""\\\n%s"""\n'
930
% (needle_re, haystack))
932
raise AssertionError('pattern "%s" not found in "%s"'
933
% (needle_re, haystack))
935
def assertNotContainsRe(self, haystack, needle_re, flags=0):
936
"""Assert that a does not match a regular expression"""
937
if re.search(needle_re, haystack, flags):
938
raise AssertionError('pattern "%s" found in "%s"'
939
% (needle_re, haystack))
941
def assertSubset(self, sublist, superlist):
942
"""Assert that every entry in sublist is present in superlist."""
943
missing = set(sublist) - set(superlist)
945
raise AssertionError("value(s) %r not present in container %r" %
946
(missing, superlist))
948
def assertListRaises(self, excClass, func, *args, **kwargs):
949
"""Fail unless excClass is raised when the iterator from func is used.
951
Many functions can return generators this makes sure
952
to wrap them in a list() call to make sure the whole generator
953
is run, and that the proper exception is raised.
956
list(func(*args, **kwargs))
960
if getattr(excClass,'__name__', None) is not None:
961
excName = excClass.__name__
963
excName = str(excClass)
964
raise self.failureException, "%s not raised" % excName
966
def assertRaises(self, excClass, callableObj, *args, **kwargs):
967
"""Assert that a callable raises a particular exception.
969
:param excClass: As for the except statement, this may be either an
970
exception class, or a tuple of classes.
971
:param callableObj: A callable, will be passed ``*args`` and
974
Returns the exception so that you can examine it.
977
callableObj(*args, **kwargs)
981
if getattr(excClass,'__name__', None) is not None:
982
excName = excClass.__name__
985
excName = str(excClass)
986
raise self.failureException, "%s not raised" % excName
988
def assertIs(self, left, right, message=None):
989
if not (left is right):
990
if message is not None:
991
raise AssertionError(message)
993
raise AssertionError("%r is not %r." % (left, right))
995
def assertIsNot(self, left, right, message=None):
997
if message is not None:
998
raise AssertionError(message)
1000
raise AssertionError("%r is %r." % (left, right))
1002
def assertTransportMode(self, transport, path, mode):
1003
"""Fail if a path does not have mode mode.
1005
If modes are not supported on this transport, the assertion is ignored.
1007
if not transport._can_roundtrip_unix_modebits():
1009
path_stat = transport.stat(path)
1010
actual_mode = stat.S_IMODE(path_stat.st_mode)
1011
self.assertEqual(mode, actual_mode,
1012
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
1014
def assertIsSameRealPath(self, path1, path2):
1015
"""Fail if path1 and path2 points to different files"""
1016
self.assertEqual(osutils.realpath(path1),
1017
osutils.realpath(path2),
1018
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1020
def assertIsInstance(self, obj, kls):
1021
"""Fail if obj is not an instance of kls"""
1022
if not isinstance(obj, kls):
1023
self.fail("%r is an instance of %s rather than %s" % (
1024
obj, obj.__class__, kls))
1026
def expectFailure(self, reason, assertion, *args, **kwargs):
1027
"""Invoke a test, expecting it to fail for the given reason.
1029
This is for assertions that ought to succeed, but currently fail.
1030
(The failure is *expected* but not *wanted*.) Please be very precise
1031
about the failure you're expecting. If a new bug is introduced,
1032
AssertionError should be raised, not KnownFailure.
1034
Frequently, expectFailure should be followed by an opposite assertion.
1037
Intended to be used with a callable that raises AssertionError as the
1038
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1040
Raises KnownFailure if the test fails. Raises AssertionError if the
1045
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1047
self.assertEqual(42, dynamic_val)
1049
This means that a dynamic_val of 54 will cause the test to raise
1050
a KnownFailure. Once math is fixed and the expectFailure is removed,
1051
only a dynamic_val of 42 will allow the test to pass. Anything other
1052
than 54 or 42 will cause an AssertionError.
1055
assertion(*args, **kwargs)
1056
except AssertionError:
1057
raise KnownFailure(reason)
1059
self.fail('Unexpected success. Should have failed: %s' % reason)
1061
def assertFileEqual(self, content, path):
1062
"""Fail if path does not contain 'content'."""
1063
self.failUnlessExists(path)
1064
f = file(path, 'rb')
1069
self.assertEqualDiff(content, s)
1071
def failUnlessExists(self, path):
1072
"""Fail unless path or paths, which may be abs or relative, exist."""
1073
if not isinstance(path, basestring):
1075
self.failUnlessExists(p)
1077
self.failUnless(osutils.lexists(path),path+" does not exist")
1079
def failIfExists(self, path):
1080
"""Fail if path or paths, which may be abs or relative, exist."""
1081
if not isinstance(path, basestring):
1083
self.failIfExists(p)
1085
self.failIf(osutils.lexists(path),path+" exists")
1087
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1088
"""A helper for callDeprecated and applyDeprecated.
1090
:param a_callable: A callable to call.
1091
:param args: The positional arguments for the callable
1092
:param kwargs: The keyword arguments for the callable
1093
:return: A tuple (warnings, result). result is the result of calling
1094
a_callable(``*args``, ``**kwargs``).
1097
def capture_warnings(msg, cls=None, stacklevel=None):
1098
# we've hooked into a deprecation specific callpath,
1099
# only deprecations should getting sent via it.
1100
self.assertEqual(cls, DeprecationWarning)
1101
local_warnings.append(msg)
1102
original_warning_method = symbol_versioning.warn
1103
symbol_versioning.set_warning_method(capture_warnings)
1105
result = a_callable(*args, **kwargs)
1107
symbol_versioning.set_warning_method(original_warning_method)
1108
return (local_warnings, result)
1110
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1111
"""Call a deprecated callable without warning the user.
1113
Note that this only captures warnings raised by symbol_versioning.warn,
1114
not other callers that go direct to the warning module.
1116
To test that a deprecated method raises an error, do something like
1119
self.assertRaises(errors.ReservedId,
1120
self.applyDeprecated,
1121
deprecated_in((1, 5, 0)),
1125
:param deprecation_format: The deprecation format that the callable
1126
should have been deprecated with. This is the same type as the
1127
parameter to deprecated_method/deprecated_function. If the
1128
callable is not deprecated with this format, an assertion error
1130
:param a_callable: A callable to call. This may be a bound method or
1131
a regular function. It will be called with ``*args`` and
1133
:param args: The positional arguments for the callable
1134
:param kwargs: The keyword arguments for the callable
1135
:return: The result of a_callable(``*args``, ``**kwargs``)
1137
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1139
expected_first_warning = symbol_versioning.deprecation_string(
1140
a_callable, deprecation_format)
1141
if len(call_warnings) == 0:
1142
self.fail("No deprecation warning generated by call to %s" %
1144
self.assertEqual(expected_first_warning, call_warnings[0])
1147
def callCatchWarnings(self, fn, *args, **kw):
1148
"""Call a callable that raises python warnings.
1150
The caller's responsible for examining the returned warnings.
1152
If the callable raises an exception, the exception is not
1153
caught and propagates up to the caller. In that case, the list
1154
of warnings is not available.
1156
:returns: ([warning_object, ...], fn_result)
1158
# XXX: This is not perfect, because it completely overrides the
1159
# warnings filters, and some code may depend on suppressing particular
1160
# warnings. It's the easiest way to insulate ourselves from -Werror,
1161
# though. -- Andrew, 20071062
1163
def _catcher(message, category, filename, lineno, file=None, line=None):
1164
# despite the name, 'message' is normally(?) a Warning subclass
1166
wlist.append(message)
1167
saved_showwarning = warnings.showwarning
1168
saved_filters = warnings.filters
1170
warnings.showwarning = _catcher
1171
warnings.filters = []
1172
result = fn(*args, **kw)
1174
warnings.showwarning = saved_showwarning
1175
warnings.filters = saved_filters
1176
return wlist, result
1178
def callDeprecated(self, expected, callable, *args, **kwargs):
1179
"""Assert that a callable is deprecated in a particular way.
1181
This is a very precise test for unusual requirements. The
1182
applyDeprecated helper function is probably more suited for most tests
1183
as it allows you to simply specify the deprecation format being used
1184
and will ensure that that is issued for the function being called.
1186
Note that this only captures warnings raised by symbol_versioning.warn,
1187
not other callers that go direct to the warning module. To catch
1188
general warnings, use callCatchWarnings.
1190
:param expected: a list of the deprecation warnings expected, in order
1191
:param callable: The callable to call
1192
:param args: The positional arguments for the callable
1193
:param kwargs: The keyword arguments for the callable
1195
call_warnings, result = self._capture_deprecation_warnings(callable,
1197
self.assertEqual(expected, call_warnings)
1200
def _startLogFile(self):
1201
"""Send bzr and test log messages to a temporary file.
1203
The file is removed as the test is torn down.
1205
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1206
self._log_file = os.fdopen(fileno, 'w+')
1207
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1208
self._log_file_name = name
1209
self.addCleanup(self._finishLogFile)
1211
def _finishLogFile(self):
1212
"""Finished with the log file.
1214
Close the file and delete it, unless setKeepLogfile was called.
1216
if self._log_file is None:
1218
bzrlib.trace.pop_log_file(self._log_memento)
1219
self._log_file.close()
1220
self._log_file = None
1221
if not self._keep_log_file:
1222
os.remove(self._log_file_name)
1223
self._log_file_name = None
1225
def setKeepLogfile(self):
1226
"""Make the logfile not be deleted when _finishLogFile is called."""
1227
self._keep_log_file = True
1229
def addCleanup(self, callable, *args, **kwargs):
1230
"""Arrange to run a callable when this case is torn down.
1232
Callables are run in the reverse of the order they are registered,
1233
ie last-in first-out.
1235
self._cleanups.append((callable, args, kwargs))
1237
def _cleanEnvironment(self):
1239
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1240
'HOME': os.getcwd(),
1241
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1242
# tests do check our impls match APPDATA
1243
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1245
'BZREMAIL': None, # may still be present in the environment
1247
'BZR_PROGRESS_BAR': None,
1249
'BZR_PLUGIN_PATH': None,
1251
'SSH_AUTH_SOCK': None,
1255
'https_proxy': None,
1256
'HTTPS_PROXY': None,
1261
# Nobody cares about these ones AFAIK. So far at
1262
# least. If you do (care), please update this comment
1266
'BZR_REMOTE_PATH': None,
1269
self.addCleanup(self._restoreEnvironment)
1270
for name, value in new_env.iteritems():
1271
self._captureVar(name, value)
1273
def _captureVar(self, name, newvalue):
1274
"""Set an environment variable, and reset it when finished."""
1275
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1277
def _restore_debug_flags(self):
1278
debug.debug_flags.clear()
1279
debug.debug_flags.update(self._preserved_debug_flags)
1281
def _restoreEnvironment(self):
1282
for name, value in self.__old_env.iteritems():
1283
osutils.set_or_unset_env(name, value)
1285
def _restoreHooks(self):
1286
for klass, hooks in self._preserved_hooks.items():
1287
setattr(klass, 'hooks', hooks)
1289
def knownFailure(self, reason):
1290
"""This test has failed for some known reason."""
1291
raise KnownFailure(reason)
1293
def _do_skip(self, result, reason):
1294
addSkip = getattr(result, 'addSkip', None)
1295
if not callable(addSkip):
1296
result.addError(self, self.exc_info())
1298
addSkip(self, reason)
1300
def run(self, result=None):
1301
if result is None: result = self.defaultTestResult()
1302
for feature in getattr(self, '_test_needs_features', []):
1303
if not feature.available():
1304
result.startTest(self)
1305
if getattr(result, 'addNotSupported', None):
1306
result.addNotSupported(self, feature)
1308
result.addSuccess(self)
1309
result.stopTest(self)
1313
result.startTest(self)
1314
absent_attr = object()
1316
method_name = getattr(self, '_testMethodName', absent_attr)
1317
if method_name is absent_attr:
1319
method_name = getattr(self, '_TestCase__testMethodName')
1320
testMethod = getattr(self, method_name)
1324
except KeyboardInterrupt:
1326
except TestSkipped, e:
1327
self._do_skip(result, e.args[0])
1331
result.addError(self, self.exc_info())
1338
except self.failureException:
1339
result.addFailure(self, self.exc_info())
1340
except TestSkipped, e:
1342
reason = "No reason given."
1345
self._do_skip(result, reason)
1346
except KeyboardInterrupt:
1349
result.addError(self, self.exc_info())
1353
except KeyboardInterrupt:
1356
result.addError(self, self.exc_info())
1358
if ok: result.addSuccess(self)
1360
result.stopTest(self)
1362
except TestNotApplicable:
1363
# Not moved from the result [yet].
1365
except KeyboardInterrupt:
1369
absent_attr = object()
1370
for attr_name in self.attrs_to_keep:
1371
attr = getattr(self, attr_name, absent_attr)
1372
if attr is not absent_attr:
1373
saved_attrs[attr_name] = attr
1374
self.__dict__ = saved_attrs
1378
self._log_contents = ''
1379
unittest.TestCase.tearDown(self)
1381
def time(self, callable, *args, **kwargs):
1382
"""Run callable and accrue the time it takes to the benchmark time.
1384
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1385
this will cause lsprofile statistics to be gathered and stored in
1388
if self._benchtime is None:
1392
if not self._gather_lsprof_in_benchmarks:
1393
return callable(*args, **kwargs)
1395
# record this benchmark
1396
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1398
self._benchcalls.append(((callable, args, kwargs), stats))
1401
self._benchtime += time.time() - start
1403
def _runCleanups(self):
1404
"""Run registered cleanup functions.
1406
This should only be called from TestCase.tearDown.
1408
# TODO: Perhaps this should keep running cleanups even if
1409
# one of them fails?
1411
# Actually pop the cleanups from the list so tearDown running
1412
# twice is safe (this happens for skipped tests).
1413
while self._cleanups:
1414
cleanup, args, kwargs = self._cleanups.pop()
1415
cleanup(*args, **kwargs)
1417
def log(self, *args):
1420
def _get_log(self, keep_log_file=False):
1421
"""Get the log from bzrlib.trace calls from this test.
1423
:param keep_log_file: When True, if the log is still a file on disk
1424
leave it as a file on disk. When False, if the log is still a file
1425
on disk, the log file is deleted and the log preserved as
1427
:return: A string containing the log.
1429
# flush the log file, to get all content
1431
if bzrlib.trace._trace_file:
1432
bzrlib.trace._trace_file.flush()
1433
if self._log_contents:
1434
# XXX: this can hardly contain the content flushed above --vila
1436
return self._log_contents
1437
if self._log_file_name is not None:
1438
logfile = open(self._log_file_name)
1440
log_contents = logfile.read()
1443
if not keep_log_file:
1444
self._log_contents = log_contents
1446
os.remove(self._log_file_name)
1448
if sys.platform == 'win32' and e.errno == errno.EACCES:
1449
sys.stderr.write(('Unable to delete log file '
1450
' %r\n' % self._log_file_name))
1455
return "DELETED log file to reduce memory footprint"
1457
def requireFeature(self, feature):
1458
"""This test requires a specific feature is available.
1460
:raises UnavailableFeature: When feature is not available.
1462
if not feature.available():
1463
raise UnavailableFeature(feature)
1465
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1467
"""Run bazaar command line, splitting up a string command line."""
1468
if isinstance(args, basestring):
1469
# shlex don't understand unicode strings,
1470
# so args should be plain string (bialix 20070906)
1471
args = list(shlex.split(str(args)))
1472
return self._run_bzr_core(args, retcode=retcode,
1473
encoding=encoding, stdin=stdin, working_dir=working_dir,
1476
def _run_bzr_core(self, args, retcode, encoding, stdin,
1478
if encoding is None:
1479
encoding = osutils.get_user_encoding()
1480
stdout = StringIOWrapper()
1481
stderr = StringIOWrapper()
1482
stdout.encoding = encoding
1483
stderr.encoding = encoding
1485
self.log('run bzr: %r', args)
1486
# FIXME: don't call into logging here
1487
handler = logging.StreamHandler(stderr)
1488
handler.setLevel(logging.INFO)
1489
logger = logging.getLogger('')
1490
logger.addHandler(handler)
1491
old_ui_factory = ui.ui_factory
1492
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1495
if working_dir is not None:
1496
cwd = osutils.getcwd()
1497
os.chdir(working_dir)
1500
result = self.apply_redirected(ui.ui_factory.stdin,
1502
bzrlib.commands.run_bzr_catch_user_errors,
1505
logger.removeHandler(handler)
1506
ui.ui_factory = old_ui_factory
1510
out = stdout.getvalue()
1511
err = stderr.getvalue()
1513
self.log('output:\n%r', out)
1515
self.log('errors:\n%r', err)
1516
if retcode is not None:
1517
self.assertEquals(retcode, result,
1518
message='Unexpected return code')
1521
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1522
working_dir=None, error_regexes=[], output_encoding=None):
1523
"""Invoke bzr, as if it were run from the command line.
1525
The argument list should not include the bzr program name - the
1526
first argument is normally the bzr command. Arguments may be
1527
passed in three ways:
1529
1- A list of strings, eg ["commit", "a"]. This is recommended
1530
when the command contains whitespace or metacharacters, or
1531
is built up at run time.
1533
2- A single string, eg "add a". This is the most convenient
1534
for hardcoded commands.
1536
This runs bzr through the interface that catches and reports
1537
errors, and with logging set to something approximating the
1538
default, so that error reporting can be checked.
1540
This should be the main method for tests that want to exercise the
1541
overall behavior of the bzr application (rather than a unit test
1542
or a functional test of the library.)
1544
This sends the stdout/stderr results into the test's log,
1545
where it may be useful for debugging. See also run_captured.
1547
:keyword stdin: A string to be used as stdin for the command.
1548
:keyword retcode: The status code the command should return;
1550
:keyword working_dir: The directory to run the command in
1551
:keyword error_regexes: A list of expected error messages. If
1552
specified they must be seen in the error output of the command.
1554
out, err = self._run_bzr_autosplit(
1559
working_dir=working_dir,
1561
for regex in error_regexes:
1562
self.assertContainsRe(err, regex)
1565
def run_bzr_error(self, error_regexes, *args, **kwargs):
1566
"""Run bzr, and check that stderr contains the supplied regexes
1568
:param error_regexes: Sequence of regular expressions which
1569
must each be found in the error output. The relative ordering
1571
:param args: command-line arguments for bzr
1572
:param kwargs: Keyword arguments which are interpreted by run_bzr
1573
This function changes the default value of retcode to be 3,
1574
since in most cases this is run when you expect bzr to fail.
1576
:return: (out, err) The actual output of running the command (in case
1577
you want to do more inspection)
1581
# Make sure that commit is failing because there is nothing to do
1582
self.run_bzr_error(['no changes to commit'],
1583
['commit', '-m', 'my commit comment'])
1584
# Make sure --strict is handling an unknown file, rather than
1585
# giving us the 'nothing to do' error
1586
self.build_tree(['unknown'])
1587
self.run_bzr_error(['Commit refused because there are unknown files'],
1588
['commit', --strict', '-m', 'my commit comment'])
1590
kwargs.setdefault('retcode', 3)
1591
kwargs['error_regexes'] = error_regexes
1592
out, err = self.run_bzr(*args, **kwargs)
1595
def run_bzr_subprocess(self, *args, **kwargs):
1596
"""Run bzr in a subprocess for testing.
1598
This starts a new Python interpreter and runs bzr in there.
1599
This should only be used for tests that have a justifiable need for
1600
this isolation: e.g. they are testing startup time, or signal
1601
handling, or early startup code, etc. Subprocess code can't be
1602
profiled or debugged so easily.
1604
:keyword retcode: The status code that is expected. Defaults to 0. If
1605
None is supplied, the status code is not checked.
1606
:keyword env_changes: A dictionary which lists changes to environment
1607
variables. A value of None will unset the env variable.
1608
The values must be strings. The change will only occur in the
1609
child, so you don't need to fix the environment after running.
1610
:keyword universal_newlines: Convert CRLF => LF
1611
:keyword allow_plugins: By default the subprocess is run with
1612
--no-plugins to ensure test reproducibility. Also, it is possible
1613
for system-wide plugins to create unexpected output on stderr,
1614
which can cause unnecessary test failures.
1616
env_changes = kwargs.get('env_changes', {})
1617
working_dir = kwargs.get('working_dir', None)
1618
allow_plugins = kwargs.get('allow_plugins', False)
1620
if isinstance(args[0], list):
1622
elif isinstance(args[0], basestring):
1623
args = list(shlex.split(args[0]))
1625
raise ValueError("passing varargs to run_bzr_subprocess")
1626
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1627
working_dir=working_dir,
1628
allow_plugins=allow_plugins)
1629
# We distinguish between retcode=None and retcode not passed.
1630
supplied_retcode = kwargs.get('retcode', 0)
1631
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1632
universal_newlines=kwargs.get('universal_newlines', False),
1635
def start_bzr_subprocess(self, process_args, env_changes=None,
1636
skip_if_plan_to_signal=False,
1638
allow_plugins=False):
1639
"""Start bzr in a subprocess for testing.
1641
This starts a new Python interpreter and runs bzr in there.
1642
This should only be used for tests that have a justifiable need for
1643
this isolation: e.g. they are testing startup time, or signal
1644
handling, or early startup code, etc. Subprocess code can't be
1645
profiled or debugged so easily.
1647
:param process_args: a list of arguments to pass to the bzr executable,
1648
for example ``['--version']``.
1649
:param env_changes: A dictionary which lists changes to environment
1650
variables. A value of None will unset the env variable.
1651
The values must be strings. The change will only occur in the
1652
child, so you don't need to fix the environment after running.
1653
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1655
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1657
:returns: Popen object for the started process.
1659
if skip_if_plan_to_signal:
1660
if not getattr(os, 'kill', None):
1661
raise TestSkipped("os.kill not available.")
1663
if env_changes is None:
1667
def cleanup_environment():
1668
for env_var, value in env_changes.iteritems():
1669
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1671
def restore_environment():
1672
for env_var, value in old_env.iteritems():
1673
osutils.set_or_unset_env(env_var, value)
1675
bzr_path = self.get_bzr_path()
1678
if working_dir is not None:
1679
cwd = osutils.getcwd()
1680
os.chdir(working_dir)
1683
# win32 subprocess doesn't support preexec_fn
1684
# so we will avoid using it on all platforms, just to
1685
# make sure the code path is used, and we don't break on win32
1686
cleanup_environment()
1687
command = [sys.executable]
1688
# frozen executables don't need the path to bzr
1689
if getattr(sys, "frozen", None) is None:
1690
command.append(bzr_path)
1691
if not allow_plugins:
1692
command.append('--no-plugins')
1693
command.extend(process_args)
1694
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1696
restore_environment()
1702
def _popen(self, *args, **kwargs):
1703
"""Place a call to Popen.
1705
Allows tests to override this method to intercept the calls made to
1706
Popen for introspection.
1708
return Popen(*args, **kwargs)
1710
def get_bzr_path(self):
1711
"""Return the path of the 'bzr' executable for this test suite."""
1712
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1713
if not os.path.isfile(bzr_path):
1714
# We are probably installed. Assume sys.argv is the right file
1715
bzr_path = sys.argv[0]
1718
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1719
universal_newlines=False, process_args=None):
1720
"""Finish the execution of process.
1722
:param process: the Popen object returned from start_bzr_subprocess.
1723
:param retcode: The status code that is expected. Defaults to 0. If
1724
None is supplied, the status code is not checked.
1725
:param send_signal: an optional signal to send to the process.
1726
:param universal_newlines: Convert CRLF => LF
1727
:returns: (stdout, stderr)
1729
if send_signal is not None:
1730
os.kill(process.pid, send_signal)
1731
out, err = process.communicate()
1733
if universal_newlines:
1734
out = out.replace('\r\n', '\n')
1735
err = err.replace('\r\n', '\n')
1737
if retcode is not None and retcode != process.returncode:
1738
if process_args is None:
1739
process_args = "(unknown args)"
1740
mutter('Output of bzr %s:\n%s', process_args, out)
1741
mutter('Error for bzr %s:\n%s', process_args, err)
1742
self.fail('Command bzr %s failed with retcode %s != %s'
1743
% (process_args, retcode, process.returncode))
1746
def check_inventory_shape(self, inv, shape):
1747
"""Compare an inventory to a list of expected names.
1749
Fail if they are not precisely equal.
1752
shape = list(shape) # copy
1753
for path, ie in inv.entries():
1754
name = path.replace('\\', '/')
1755
if ie.kind == 'directory':
1762
self.fail("expected paths not found in inventory: %r" % shape)
1764
self.fail("unexpected paths found in inventory: %r" % extras)
1766
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1767
a_callable=None, *args, **kwargs):
1768
"""Call callable with redirected std io pipes.
1770
Returns the return code."""
1771
if not callable(a_callable):
1772
raise ValueError("a_callable must be callable.")
1774
stdin = StringIO("")
1776
if getattr(self, "_log_file", None) is not None:
1777
stdout = self._log_file
1781
if getattr(self, "_log_file", None is not None):
1782
stderr = self._log_file
1785
real_stdin = sys.stdin
1786
real_stdout = sys.stdout
1787
real_stderr = sys.stderr
1792
return a_callable(*args, **kwargs)
1794
sys.stdout = real_stdout
1795
sys.stderr = real_stderr
1796
sys.stdin = real_stdin
1798
def reduceLockdirTimeout(self):
1799
"""Reduce the default lock timeout for the duration of the test, so that
1800
if LockContention occurs during a test, it does so quickly.
1802
Tests that expect to provoke LockContention errors should call this.
1804
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1806
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1807
self.addCleanup(resetTimeout)
1808
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1810
def make_utf8_encoded_stringio(self, encoding_type=None):
1811
"""Return a StringIOWrapper instance, that will encode Unicode
1814
if encoding_type is None:
1815
encoding_type = 'strict'
1817
output_encoding = 'utf-8'
1818
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1819
sio.encoding = output_encoding
1823
class CapturedCall(object):
1824
"""A helper for capturing smart server calls for easy debug analysis."""
1826
def __init__(self, params, prefix_length):
1827
"""Capture the call with params and skip prefix_length stack frames."""
1830
# The last 5 frames are the __init__, the hook frame, and 3 smart
1831
# client frames. Beyond this we could get more clever, but this is good
1833
stack = traceback.extract_stack()[prefix_length:-5]
1834
self.stack = ''.join(traceback.format_list(stack))
1837
return self.call.method
1840
return self.call.method
1846
class TestCaseWithMemoryTransport(TestCase):
1847
"""Common test class for tests that do not need disk resources.
1849
Tests that need disk resources should derive from TestCaseWithTransport.
1851
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1853
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1854
a directory which does not exist. This serves to help ensure test isolation
1855
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1856
must exist. However, TestCaseWithMemoryTransport does not offer local
1857
file defaults for the transport in tests, nor does it obey the command line
1858
override, so tests that accidentally write to the common directory should
1861
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1862
a .bzr directory that stops us ascending higher into the filesystem.
1868
def __init__(self, methodName='runTest'):
1869
# allow test parameterization after test construction and before test
1870
# execution. Variables that the parameterizer sets need to be
1871
# ones that are not set by setUp, or setUp will trash them.
1872
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1873
self.vfs_transport_factory = default_transport
1874
self.transport_server = None
1875
self.transport_readonly_server = None
1876
self.__vfs_server = None
1878
def get_transport(self, relpath=None):
1879
"""Return a writeable transport.
1881
This transport is for the test scratch space relative to
1884
:param relpath: a path relative to the base url.
1886
t = get_transport(self.get_url(relpath))
1887
self.assertFalse(t.is_readonly())
1890
def get_readonly_transport(self, relpath=None):
1891
"""Return a readonly transport for the test scratch space
1893
This can be used to test that operations which should only need
1894
readonly access in fact do not try to write.
1896
:param relpath: a path relative to the base url.
1898
t = get_transport(self.get_readonly_url(relpath))
1899
self.assertTrue(t.is_readonly())
1902
def create_transport_readonly_server(self):
1903
"""Create a transport server from class defined at init.
1905
This is mostly a hook for daughter classes.
1907
return self.transport_readonly_server()
1909
def get_readonly_server(self):
1910
"""Get the server instance for the readonly transport
1912
This is useful for some tests with specific servers to do diagnostics.
1914
if self.__readonly_server is None:
1915
if self.transport_readonly_server is None:
1916
# readonly decorator requested
1917
# bring up the server
1918
self.__readonly_server = ReadonlyServer()
1919
self.__readonly_server.setUp(self.get_vfs_only_server())
1921
self.__readonly_server = self.create_transport_readonly_server()
1922
self.__readonly_server.setUp(self.get_vfs_only_server())
1923
self.addCleanup(self.__readonly_server.tearDown)
1924
return self.__readonly_server
1926
def get_readonly_url(self, relpath=None):
1927
"""Get a URL for the readonly transport.
1929
This will either be backed by '.' or a decorator to the transport
1930
used by self.get_url()
1931
relpath provides for clients to get a path relative to the base url.
1932
These should only be downwards relative, not upwards.
1934
base = self.get_readonly_server().get_url()
1935
return self._adjust_url(base, relpath)
1937
def get_vfs_only_server(self):
1938
"""Get the vfs only read/write server instance.
1940
This is useful for some tests with specific servers that need
1943
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1944
is no means to override it.
1946
if self.__vfs_server is None:
1947
self.__vfs_server = MemoryServer()
1948
self.__vfs_server.setUp()
1949
self.addCleanup(self.__vfs_server.tearDown)
1950
return self.__vfs_server
1952
def get_server(self):
1953
"""Get the read/write server instance.
1955
This is useful for some tests with specific servers that need
1958
This is built from the self.transport_server factory. If that is None,
1959
then the self.get_vfs_server is returned.
1961
if self.__server is None:
1962
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1963
return self.get_vfs_only_server()
1965
# bring up a decorated means of access to the vfs only server.
1966
self.__server = self.transport_server()
1968
self.__server.setUp(self.get_vfs_only_server())
1969
except TypeError, e:
1970
# This should never happen; the try:Except here is to assist
1971
# developers having to update code rather than seeing an
1972
# uninformative TypeError.
1973
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1974
self.addCleanup(self.__server.tearDown)
1975
return self.__server
1977
def _adjust_url(self, base, relpath):
1978
"""Get a URL (or maybe a path) for the readwrite transport.
1980
This will either be backed by '.' or to an equivalent non-file based
1982
relpath provides for clients to get a path relative to the base url.
1983
These should only be downwards relative, not upwards.
1985
if relpath is not None and relpath != '.':
1986
if not base.endswith('/'):
1988
# XXX: Really base should be a url; we did after all call
1989
# get_url()! But sometimes it's just a path (from
1990
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1991
# to a non-escaped local path.
1992
if base.startswith('./') or base.startswith('/'):
1995
base += urlutils.escape(relpath)
1998
def get_url(self, relpath=None):
1999
"""Get a URL (or maybe a path) for the readwrite transport.
2001
This will either be backed by '.' or to an equivalent non-file based
2003
relpath provides for clients to get a path relative to the base url.
2004
These should only be downwards relative, not upwards.
2006
base = self.get_server().get_url()
2007
return self._adjust_url(base, relpath)
2009
def get_vfs_only_url(self, relpath=None):
2010
"""Get a URL (or maybe a path for the plain old vfs transport.
2012
This will never be a smart protocol. It always has all the
2013
capabilities of the local filesystem, but it might actually be a
2014
MemoryTransport or some other similar virtual filesystem.
2016
This is the backing transport (if any) of the server returned by
2017
get_url and get_readonly_url.
2019
:param relpath: provides for clients to get a path relative to the base
2020
url. These should only be downwards relative, not upwards.
2023
base = self.get_vfs_only_server().get_url()
2024
return self._adjust_url(base, relpath)
2026
def _create_safety_net(self):
2027
"""Make a fake bzr directory.
2029
This prevents any tests propagating up onto the TEST_ROOT directory's
2032
root = TestCaseWithMemoryTransport.TEST_ROOT
2033
bzrdir.BzrDir.create_standalone_workingtree(root)
2035
def _check_safety_net(self):
2036
"""Check that the safety .bzr directory have not been touched.
2038
_make_test_root have created a .bzr directory to prevent tests from
2039
propagating. This method ensures than a test did not leaked.
2041
root = TestCaseWithMemoryTransport.TEST_ROOT
2042
wt = workingtree.WorkingTree.open(root)
2043
last_rev = wt.last_revision()
2044
if last_rev != 'null:':
2045
# The current test have modified the /bzr directory, we need to
2046
# recreate a new one or all the followng tests will fail.
2047
# If you need to inspect its content uncomment the following line
2048
# import pdb; pdb.set_trace()
2049
_rmtree_temp_dir(root + '/.bzr')
2050
self._create_safety_net()
2051
raise AssertionError('%s/.bzr should not be modified' % root)
2053
def _make_test_root(self):
2054
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2055
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2056
TestCaseWithMemoryTransport.TEST_ROOT = root
2058
self._create_safety_net()
2060
# The same directory is used by all tests, and we're not
2061
# specifically told when all tests are finished. This will do.
2062
atexit.register(_rmtree_temp_dir, root)
2064
self.addCleanup(self._check_safety_net)
2066
def makeAndChdirToTestDir(self):
2067
"""Create a temporary directories for this one test.
2069
This must set self.test_home_dir and self.test_dir and chdir to
2072
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2074
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2075
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2076
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2078
def make_branch(self, relpath, format=None):
2079
"""Create a branch on the transport at relpath."""
2080
repo = self.make_repository(relpath, format=format)
2081
return repo.bzrdir.create_branch()
2083
def make_bzrdir(self, relpath, format=None):
2085
# might be a relative or absolute path
2086
maybe_a_url = self.get_url(relpath)
2087
segments = maybe_a_url.rsplit('/', 1)
2088
t = get_transport(maybe_a_url)
2089
if len(segments) > 1 and segments[-1] not in ('', '.'):
2093
if isinstance(format, basestring):
2094
format = bzrdir.format_registry.make_bzrdir(format)
2095
return format.initialize_on_transport(t)
2096
except errors.UninitializableFormat:
2097
raise TestSkipped("Format %s is not initializable." % format)
2099
def make_repository(self, relpath, shared=False, format=None):
2100
"""Create a repository on our default transport at relpath.
2102
Note that relpath must be a relative path, not a full url.
2104
# FIXME: If you create a remoterepository this returns the underlying
2105
# real format, which is incorrect. Actually we should make sure that
2106
# RemoteBzrDir returns a RemoteRepository.
2107
# maybe mbp 20070410
2108
made_control = self.make_bzrdir(relpath, format=format)
2109
return made_control.create_repository(shared=shared)
2111
def make_branch_and_memory_tree(self, relpath, format=None):
2112
"""Create a branch on the default transport and a MemoryTree for it."""
2113
b = self.make_branch(relpath, format=format)
2114
return memorytree.MemoryTree.create_on_branch(b)
2116
def make_branch_builder(self, relpath, format=None):
2117
return branchbuilder.BranchBuilder(self.get_transport(relpath),
2120
def overrideEnvironmentForTesting(self):
2121
os.environ['HOME'] = self.test_home_dir
2122
os.environ['BZR_HOME'] = self.test_home_dir
2125
super(TestCaseWithMemoryTransport, self).setUp()
2126
self._make_test_root()
2127
_currentdir = os.getcwdu()
2128
def _leaveDirectory():
2129
os.chdir(_currentdir)
2130
self.addCleanup(_leaveDirectory)
2131
self.makeAndChdirToTestDir()
2132
self.overrideEnvironmentForTesting()
2133
self.__readonly_server = None
2134
self.__server = None
2135
self.reduceLockdirTimeout()
2137
def setup_smart_server_with_call_log(self):
2138
"""Sets up a smart server as the transport server with a call log."""
2139
self.transport_server = server.SmartTCPServer_for_testing
2140
self.hpss_calls = []
2142
# Skip the current stack down to the caller of
2143
# setup_smart_server_with_call_log
2144
prefix_length = len(traceback.extract_stack()) - 2
2145
def capture_hpss_call(params):
2146
self.hpss_calls.append(
2147
CapturedCall(params, prefix_length))
2148
client._SmartClient.hooks.install_named_hook(
2149
'call', capture_hpss_call, None)
2151
def reset_smart_call_log(self):
2152
self.hpss_calls = []
2155
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2156
"""Derived class that runs a test within a temporary directory.
2158
This is useful for tests that need to create a branch, etc.
2160
The directory is created in a slightly complex way: for each
2161
Python invocation, a new temporary top-level directory is created.
2162
All test cases create their own directory within that. If the
2163
tests complete successfully, the directory is removed.
2165
:ivar test_base_dir: The path of the top-level directory for this
2166
test, which contains a home directory and a work directory.
2168
:ivar test_home_dir: An initially empty directory under test_base_dir
2169
which is used as $HOME for this test.
2171
:ivar test_dir: A directory under test_base_dir used as the current
2172
directory when the test proper is run.
2175
OVERRIDE_PYTHON = 'python'
2177
def check_file_contents(self, filename, expect):
2178
self.log("check contents of file %s" % filename)
2179
contents = file(filename, 'r').read()
2180
if contents != expect:
2181
self.log("expected: %r" % expect)
2182
self.log("actually: %r" % contents)
2183
self.fail("contents of %s not as expected" % filename)
2185
def _getTestDirPrefix(self):
2186
# create a directory within the top level test directory
2187
if sys.platform == 'win32':
2188
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2189
# windows is likely to have path-length limits so use a short name
2190
name_prefix = name_prefix[-30:]
2192
name_prefix = re.sub('[/]', '_', self.id())
2195
def makeAndChdirToTestDir(self):
2196
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2198
For TestCaseInTempDir we create a temporary directory based on the test
2199
name and then create two subdirs - test and home under it.
2201
name_prefix = osutils.pathjoin(self.TEST_ROOT, self._getTestDirPrefix())
2203
for i in range(100):
2204
if os.path.exists(name):
2205
name = name_prefix + '_' + str(i)
2209
# now create test and home directories within this dir
2210
self.test_base_dir = name
2211
self.test_home_dir = self.test_base_dir + '/home'
2212
os.mkdir(self.test_home_dir)
2213
self.test_dir = self.test_base_dir + '/work'
2214
os.mkdir(self.test_dir)
2215
os.chdir(self.test_dir)
2216
# put name of test inside
2217
f = file(self.test_base_dir + '/name', 'w')
2222
self.addCleanup(self.deleteTestDir)
2224
def deleteTestDir(self):
2225
os.chdir(self.TEST_ROOT)
2226
_rmtree_temp_dir(self.test_base_dir)
2228
def build_tree(self, shape, line_endings='binary', transport=None):
2229
"""Build a test tree according to a pattern.
2231
shape is a sequence of file specifications. If the final
2232
character is '/', a directory is created.
2234
This assumes that all the elements in the tree being built are new.
2236
This doesn't add anything to a branch.
2238
:type shape: list or tuple.
2239
:param line_endings: Either 'binary' or 'native'
2240
in binary mode, exact contents are written in native mode, the
2241
line endings match the default platform endings.
2242
:param transport: A transport to write to, for building trees on VFS's.
2243
If the transport is readonly or None, "." is opened automatically.
2246
if type(shape) not in (list, tuple):
2247
raise AssertionError("Parameter 'shape' should be "
2248
"a list or a tuple. Got %r instead" % (shape,))
2249
# It's OK to just create them using forward slashes on windows.
2250
if transport is None or transport.is_readonly():
2251
transport = get_transport(".")
2253
self.assertIsInstance(name, basestring)
2255
transport.mkdir(urlutils.escape(name[:-1]))
2257
if line_endings == 'binary':
2259
elif line_endings == 'native':
2262
raise errors.BzrError(
2263
'Invalid line ending request %r' % line_endings)
2264
content = "contents of %s%s" % (name.encode('utf-8'), end)
2265
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2267
def build_tree_contents(self, shape):
2268
build_tree_contents(shape)
2270
def assertInWorkingTree(self, path, root_path='.', tree=None):
2271
"""Assert whether path or paths are in the WorkingTree"""
2273
tree = workingtree.WorkingTree.open(root_path)
2274
if not isinstance(path, basestring):
2276
self.assertInWorkingTree(p, tree=tree)
2278
self.assertIsNot(tree.path2id(path), None,
2279
path+' not in working tree.')
2281
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2282
"""Assert whether path or paths are not in the WorkingTree"""
2284
tree = workingtree.WorkingTree.open(root_path)
2285
if not isinstance(path, basestring):
2287
self.assertNotInWorkingTree(p,tree=tree)
2289
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2292
class TestCaseWithTransport(TestCaseInTempDir):
2293
"""A test case that provides get_url and get_readonly_url facilities.
2295
These back onto two transport servers, one for readonly access and one for
2298
If no explicit class is provided for readonly access, a
2299
ReadonlyTransportDecorator is used instead which allows the use of non disk
2300
based read write transports.
2302
If an explicit class is provided for readonly access, that server and the
2303
readwrite one must both define get_url() as resolving to os.getcwd().
2306
def get_vfs_only_server(self):
2307
"""See TestCaseWithMemoryTransport.
2309
This is useful for some tests with specific servers that need
2312
if self.__vfs_server is None:
2313
self.__vfs_server = self.vfs_transport_factory()
2314
self.__vfs_server.setUp()
2315
self.addCleanup(self.__vfs_server.tearDown)
2316
return self.__vfs_server
2318
def make_branch_and_tree(self, relpath, format=None):
2319
"""Create a branch on the transport and a tree locally.
2321
If the transport is not a LocalTransport, the Tree can't be created on
2322
the transport. In that case if the vfs_transport_factory is
2323
LocalURLServer the working tree is created in the local
2324
directory backing the transport, and the returned tree's branch and
2325
repository will also be accessed locally. Otherwise a lightweight
2326
checkout is created and returned.
2328
:param format: The BzrDirFormat.
2329
:returns: the WorkingTree.
2331
# TODO: always use the local disk path for the working tree,
2332
# this obviously requires a format that supports branch references
2333
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2335
b = self.make_branch(relpath, format=format)
2337
return b.bzrdir.create_workingtree()
2338
except errors.NotLocalUrl:
2339
# We can only make working trees locally at the moment. If the
2340
# transport can't support them, then we keep the non-disk-backed
2341
# branch and create a local checkout.
2342
if self.vfs_transport_factory is LocalURLServer:
2343
# the branch is colocated on disk, we cannot create a checkout.
2344
# hopefully callers will expect this.
2345
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2346
wt = local_controldir.create_workingtree()
2347
if wt.branch._format != b._format:
2349
# Make sure that assigning to wt._branch fixes wt.branch,
2350
# in case the implementation details of workingtree objects
2352
self.assertIs(b, wt.branch)
2355
return b.create_checkout(relpath, lightweight=True)
2357
def assertIsDirectory(self, relpath, transport):
2358
"""Assert that relpath within transport is a directory.
2360
This may not be possible on all transports; in that case it propagates
2361
a TransportNotPossible.
2364
mode = transport.stat(relpath).st_mode
2365
except errors.NoSuchFile:
2366
self.fail("path %s is not a directory; no such file"
2368
if not stat.S_ISDIR(mode):
2369
self.fail("path %s is not a directory; has mode %#o"
2372
def assertTreesEqual(self, left, right):
2373
"""Check that left and right have the same content and properties."""
2374
# we use a tree delta to check for equality of the content, and we
2375
# manually check for equality of other things such as the parents list.
2376
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2377
differences = left.changes_from(right)
2378
self.assertFalse(differences.has_changed(),
2379
"Trees %r and %r are different: %r" % (left, right, differences))
2382
super(TestCaseWithTransport, self).setUp()
2383
self.__vfs_server = None
2386
class ChrootedTestCase(TestCaseWithTransport):
2387
"""A support class that provides readonly urls outside the local namespace.
2389
This is done by checking if self.transport_server is a MemoryServer. if it
2390
is then we are chrooted already, if it is not then an HttpServer is used
2393
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2394
be used without needed to redo it when a different
2395
subclass is in use ?
2399
super(ChrootedTestCase, self).setUp()
2400
if not self.vfs_transport_factory == MemoryServer:
2401
self.transport_readonly_server = HttpServer
2404
def condition_id_re(pattern):
2405
"""Create a condition filter which performs a re check on a test's id.
2407
:param pattern: A regular expression string.
2408
:return: A callable that returns True if the re matches.
2410
filter_re = re.compile(pattern)
2411
def condition(test):
2413
return filter_re.search(test_id)
2417
def condition_isinstance(klass_or_klass_list):
2418
"""Create a condition filter which returns isinstance(param, klass).
2420
:return: A callable which when called with one parameter obj return the
2421
result of isinstance(obj, klass_or_klass_list).
2424
return isinstance(obj, klass_or_klass_list)
2428
def condition_id_in_list(id_list):
2429
"""Create a condition filter which verify that test's id in a list.
2431
:param id_list: A TestIdList object.
2432
:return: A callable that returns True if the test's id appears in the list.
2434
def condition(test):
2435
return id_list.includes(test.id())
2439
def condition_id_startswith(starts):
2440
"""Create a condition filter verifying that test's id starts with a string.
2442
:param starts: A list of string.
2443
:return: A callable that returns True if the test's id starts with one of
2446
def condition(test):
2447
for start in starts:
2448
if test.id().startswith(start):
2454
def exclude_tests_by_condition(suite, condition):
2455
"""Create a test suite which excludes some tests from suite.
2457
:param suite: The suite to get tests from.
2458
:param condition: A callable whose result evaluates True when called with a
2459
test case which should be excluded from the result.
2460
:return: A suite which contains the tests found in suite that fail
2464
for test in iter_suite_tests(suite):
2465
if not condition(test):
2467
return TestUtil.TestSuite(result)
2470
def filter_suite_by_condition(suite, condition):
2471
"""Create a test suite by filtering another one.
2473
:param suite: The source suite.
2474
:param condition: A callable whose result evaluates True when called with a
2475
test case which should be included in the result.
2476
:return: A suite which contains the tests found in suite that pass
2480
for test in iter_suite_tests(suite):
2483
return TestUtil.TestSuite(result)
2486
def filter_suite_by_re(suite, pattern):
2487
"""Create a test suite by filtering another one.
2489
:param suite: the source suite
2490
:param pattern: pattern that names must match
2491
:returns: the newly created suite
2493
condition = condition_id_re(pattern)
2494
result_suite = filter_suite_by_condition(suite, condition)
2498
def filter_suite_by_id_list(suite, test_id_list):
2499
"""Create a test suite by filtering another one.
2501
:param suite: The source suite.
2502
:param test_id_list: A list of the test ids to keep as strings.
2503
:returns: the newly created suite
2505
condition = condition_id_in_list(test_id_list)
2506
result_suite = filter_suite_by_condition(suite, condition)
2510
def filter_suite_by_id_startswith(suite, start):
2511
"""Create a test suite by filtering another one.
2513
:param suite: The source suite.
2514
:param start: A list of string the test id must start with one of.
2515
:returns: the newly created suite
2517
condition = condition_id_startswith(start)
2518
result_suite = filter_suite_by_condition(suite, condition)
2522
def exclude_tests_by_re(suite, pattern):
2523
"""Create a test suite which excludes some tests from suite.
2525
:param suite: The suite to get tests from.
2526
:param pattern: A regular expression string. Test ids that match this
2527
pattern will be excluded from the result.
2528
:return: A TestSuite that contains all the tests from suite without the
2529
tests that matched pattern. The order of tests is the same as it was in
2532
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2535
def preserve_input(something):
2536
"""A helper for performing test suite transformation chains.
2538
:param something: Anything you want to preserve.
2544
def randomize_suite(suite):
2545
"""Return a new TestSuite with suite's tests in random order.
2547
The tests in the input suite are flattened into a single suite in order to
2548
accomplish this. Any nested TestSuites are removed to provide global
2551
tests = list(iter_suite_tests(suite))
2552
random.shuffle(tests)
2553
return TestUtil.TestSuite(tests)
2556
def split_suite_by_condition(suite, condition):
2557
"""Split a test suite into two by a condition.
2559
:param suite: The suite to split.
2560
:param condition: The condition to match on. Tests that match this
2561
condition are returned in the first test suite, ones that do not match
2562
are in the second suite.
2563
:return: A tuple of two test suites, where the first contains tests from
2564
suite matching the condition, and the second contains the remainder
2565
from suite. The order within each output suite is the same as it was in
2570
for test in iter_suite_tests(suite):
2572
matched.append(test)
2574
did_not_match.append(test)
2575
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2578
def split_suite_by_re(suite, pattern):
2579
"""Split a test suite into two by a regular expression.
2581
:param suite: The suite to split.
2582
:param pattern: A regular expression string. Test ids that match this
2583
pattern will be in the first test suite returned, and the others in the
2584
second test suite returned.
2585
:return: A tuple of two test suites, where the first contains tests from
2586
suite matching pattern, and the second contains the remainder from
2587
suite. The order within each output suite is the same as it was in
2590
return split_suite_by_condition(suite, condition_id_re(pattern))
2593
def run_suite(suite, name='test', verbose=False, pattern=".*",
2594
stop_on_failure=False,
2595
transport=None, lsprof_timed=None, bench_history=None,
2596
matching_tests_first=None,
2599
exclude_pattern=None,
2602
"""Run a test suite for bzr selftest.
2604
:param runner_class: The class of runner to use. Must support the
2605
constructor arguments passed by run_suite which are more than standard
2607
:return: A boolean indicating success.
2609
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2614
if runner_class is None:
2615
runner_class = TextTestRunner
2616
runner = runner_class(stream=sys.stdout,
2618
verbosity=verbosity,
2619
bench_history=bench_history,
2620
list_only=list_only,
2622
runner.stop_on_failure=stop_on_failure
2623
# Initialise the random number generator and display the seed used.
2624
# We convert the seed to a long to make it reuseable across invocations.
2625
random_order = False
2626
if random_seed is not None:
2628
if random_seed == "now":
2629
random_seed = long(time.time())
2631
# Convert the seed to a long if we can
2633
random_seed = long(random_seed)
2636
runner.stream.writeln("Randomizing test order using seed %s\n" %
2638
random.seed(random_seed)
2639
# Customise the list of tests if requested
2640
if exclude_pattern is not None:
2641
suite = exclude_tests_by_re(suite, exclude_pattern)
2643
order_changer = randomize_suite
2645
order_changer = preserve_input
2646
if pattern != '.*' or random_order:
2647
if matching_tests_first:
2648
suites = map(order_changer, split_suite_by_re(suite, pattern))
2649
suite = TestUtil.TestSuite(suites)
2651
suite = order_changer(filter_suite_by_re(suite, pattern))
2653
result = runner.run(suite)
2656
return result.wasStrictlySuccessful()
2658
return result.wasSuccessful()
2661
# Controlled by "bzr selftest -E=..." option
2662
selftest_debug_flags = set()
2665
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2667
test_suite_factory=None,
2670
matching_tests_first=None,
2673
exclude_pattern=None,
2680
"""Run the whole test suite under the enhanced runner"""
2681
# XXX: Very ugly way to do this...
2682
# Disable warning about old formats because we don't want it to disturb
2683
# any blackbox tests.
2684
from bzrlib import repository
2685
repository._deprecation_warning_done = True
2687
global default_transport
2688
if transport is None:
2689
transport = default_transport
2690
old_transport = default_transport
2691
default_transport = transport
2692
global selftest_debug_flags
2693
old_debug_flags = selftest_debug_flags
2694
if debug_flags is not None:
2695
selftest_debug_flags = set(debug_flags)
2697
if load_list is None:
2700
keep_only = load_test_id_list(load_list)
2701
if test_suite_factory is None:
2702
suite = test_suite(keep_only, starting_with)
2704
suite = test_suite_factory()
2705
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2706
stop_on_failure=stop_on_failure,
2707
transport=transport,
2708
lsprof_timed=lsprof_timed,
2709
bench_history=bench_history,
2710
matching_tests_first=matching_tests_first,
2711
list_only=list_only,
2712
random_seed=random_seed,
2713
exclude_pattern=exclude_pattern,
2715
runner_class=runner_class,
2718
default_transport = old_transport
2719
selftest_debug_flags = old_debug_flags
2722
def load_test_id_list(file_name):
2723
"""Load a test id list from a text file.
2725
The format is one test id by line. No special care is taken to impose
2726
strict rules, these test ids are used to filter the test suite so a test id
2727
that do not match an existing test will do no harm. This allows user to add
2728
comments, leave blank lines, etc.
2732
ftest = open(file_name, 'rt')
2734
if e.errno != errno.ENOENT:
2737
raise errors.NoSuchFile(file_name)
2739
for test_name in ftest.readlines():
2740
test_list.append(test_name.strip())
2745
def suite_matches_id_list(test_suite, id_list):
2746
"""Warns about tests not appearing or appearing more than once.
2748
:param test_suite: A TestSuite object.
2749
:param test_id_list: The list of test ids that should be found in
2752
:return: (absents, duplicates) absents is a list containing the test found
2753
in id_list but not in test_suite, duplicates is a list containing the
2754
test found multiple times in test_suite.
2756
When using a prefined test id list, it may occurs that some tests do not
2757
exist anymore or that some tests use the same id. This function warns the
2758
tester about potential problems in his workflow (test lists are volatile)
2759
or in the test suite itself (using the same id for several tests does not
2760
help to localize defects).
2762
# Build a dict counting id occurrences
2764
for test in iter_suite_tests(test_suite):
2766
tests[id] = tests.get(id, 0) + 1
2771
occurs = tests.get(id, 0)
2773
not_found.append(id)
2775
duplicates.append(id)
2777
return not_found, duplicates
2780
class TestIdList(object):
2781
"""Test id list to filter a test suite.
2783
Relying on the assumption that test ids are built as:
2784
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2785
notation, this class offers methods to :
2786
- avoid building a test suite for modules not refered to in the test list,
2787
- keep only the tests listed from the module test suite.
2790
def __init__(self, test_id_list):
2791
# When a test suite needs to be filtered against us we compare test ids
2792
# for equality, so a simple dict offers a quick and simple solution.
2793
self.tests = dict().fromkeys(test_id_list, True)
2795
# While unittest.TestCase have ids like:
2796
# <module>.<class>.<method>[(<param+)],
2797
# doctest.DocTestCase can have ids like:
2800
# <module>.<function>
2801
# <module>.<class>.<method>
2803
# Since we can't predict a test class from its name only, we settle on
2804
# a simple constraint: a test id always begins with its module name.
2807
for test_id in test_id_list:
2808
parts = test_id.split('.')
2809
mod_name = parts.pop(0)
2810
modules[mod_name] = True
2812
mod_name += '.' + part
2813
modules[mod_name] = True
2814
self.modules = modules
2816
def refers_to(self, module_name):
2817
"""Is there tests for the module or one of its sub modules."""
2818
return self.modules.has_key(module_name)
2820
def includes(self, test_id):
2821
return self.tests.has_key(test_id)
2824
class TestPrefixAliasRegistry(registry.Registry):
2825
"""A registry for test prefix aliases.
2827
This helps implement shorcuts for the --starting-with selftest
2828
option. Overriding existing prefixes is not allowed but not fatal (a
2829
warning will be emitted).
2832
def register(self, key, obj, help=None, info=None,
2833
override_existing=False):
2834
"""See Registry.register.
2836
Trying to override an existing alias causes a warning to be emitted,
2837
not a fatal execption.
2840
super(TestPrefixAliasRegistry, self).register(
2841
key, obj, help=help, info=info, override_existing=False)
2843
actual = self.get(key)
2844
note('Test prefix alias %s is already used for %s, ignoring %s'
2845
% (key, actual, obj))
2847
def resolve_alias(self, id_start):
2848
"""Replace the alias by the prefix in the given string.
2850
Using an unknown prefix is an error to help catching typos.
2852
parts = id_start.split('.')
2854
parts[0] = self.get(parts[0])
2856
raise errors.BzrCommandError(
2857
'%s is not a known test prefix alias' % parts[0])
2858
return '.'.join(parts)
2861
test_prefix_alias_registry = TestPrefixAliasRegistry()
2862
"""Registry of test prefix aliases."""
2865
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
2866
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
2867
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
2869
# Obvious higest levels prefixes, feel free to add your own via a plugin
2870
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
2871
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
2872
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
2873
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
2874
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
2877
def test_suite(keep_only=None, starting_with=None):
2878
"""Build and return TestSuite for the whole of bzrlib.
2880
:param keep_only: A list of test ids limiting the suite returned.
2882
:param starting_with: An id limiting the suite returned to the tests
2885
This function can be replaced if you need to change the default test
2886
suite on a global basis, but it is not encouraged.
2890
'bzrlib.tests.blackbox',
2891
'bzrlib.tests.branch_implementations',
2892
'bzrlib.tests.bzrdir_implementations',
2893
'bzrlib.tests.commands',
2894
'bzrlib.tests.interrepository_implementations',
2895
'bzrlib.tests.intertree_implementations',
2896
'bzrlib.tests.inventory_implementations',
2897
'bzrlib.tests.per_interbranch',
2898
'bzrlib.tests.per_lock',
2899
'bzrlib.tests.per_repository',
2900
'bzrlib.tests.per_repository_reference',
2901
'bzrlib.tests.test__dirstate_helpers',
2902
'bzrlib.tests.test__walkdirs_win32',
2903
'bzrlib.tests.test_ancestry',
2904
'bzrlib.tests.test_annotate',
2905
'bzrlib.tests.test_api',
2906
'bzrlib.tests.test_atomicfile',
2907
'bzrlib.tests.test_bad_files',
2908
'bzrlib.tests.test_bisect_multi',
2909
'bzrlib.tests.test_branch',
2910
'bzrlib.tests.test_branchbuilder',
2911
'bzrlib.tests.test_btree_index',
2912
'bzrlib.tests.test_bugtracker',
2913
'bzrlib.tests.test_bundle',
2914
'bzrlib.tests.test_bzrdir',
2915
'bzrlib.tests.test_cache_utf8',
2916
'bzrlib.tests.test_chunk_writer',
2917
'bzrlib.tests.test__chunks_to_lines',
2918
'bzrlib.tests.test_commands',
2919
'bzrlib.tests.test_commit',
2920
'bzrlib.tests.test_commit_merge',
2921
'bzrlib.tests.test_config',
2922
'bzrlib.tests.test_conflicts',
2923
'bzrlib.tests.test_counted_lock',
2924
'bzrlib.tests.test_decorators',
2925
'bzrlib.tests.test_delta',
2926
'bzrlib.tests.test_debug',
2927
'bzrlib.tests.test_deprecated_graph',
2928
'bzrlib.tests.test_diff',
2929
'bzrlib.tests.test_directory_service',
2930
'bzrlib.tests.test_dirstate',
2931
'bzrlib.tests.test_email_message',
2932
'bzrlib.tests.test_errors',
2933
'bzrlib.tests.test_export',
2934
'bzrlib.tests.test_extract',
2935
'bzrlib.tests.test_fetch',
2936
'bzrlib.tests.test_fifo_cache',
2937
'bzrlib.tests.test_ftp_transport',
2938
'bzrlib.tests.test_foreign',
2939
'bzrlib.tests.test_generate_docs',
2940
'bzrlib.tests.test_generate_ids',
2941
'bzrlib.tests.test_globbing',
2942
'bzrlib.tests.test_gpg',
2943
'bzrlib.tests.test_graph',
2944
'bzrlib.tests.test_hashcache',
2945
'bzrlib.tests.test_help',
2946
'bzrlib.tests.test_hooks',
2947
'bzrlib.tests.test_http',
2948
'bzrlib.tests.test_http_implementations',
2949
'bzrlib.tests.test_http_response',
2950
'bzrlib.tests.test_https_ca_bundle',
2951
'bzrlib.tests.test_identitymap',
2952
'bzrlib.tests.test_ignores',
2953
'bzrlib.tests.test_index',
2954
'bzrlib.tests.test_info',
2955
'bzrlib.tests.test_inv',
2956
'bzrlib.tests.test_knit',
2957
'bzrlib.tests.test_lazy_import',
2958
'bzrlib.tests.test_lazy_regex',
2959
'bzrlib.tests.test_lockable_files',
2960
'bzrlib.tests.test_lockdir',
2961
'bzrlib.tests.test_log',
2962
'bzrlib.tests.test_lru_cache',
2963
'bzrlib.tests.test_lsprof',
2964
'bzrlib.tests.test_mail_client',
2965
'bzrlib.tests.test_memorytree',
2966
'bzrlib.tests.test_merge',
2967
'bzrlib.tests.test_merge3',
2968
'bzrlib.tests.test_merge_core',
2969
'bzrlib.tests.test_merge_directive',
2970
'bzrlib.tests.test_missing',
2971
'bzrlib.tests.test_msgeditor',
2972
'bzrlib.tests.test_multiparent',
2973
'bzrlib.tests.test_mutabletree',
2974
'bzrlib.tests.test_nonascii',
2975
'bzrlib.tests.test_options',
2976
'bzrlib.tests.test_osutils',
2977
'bzrlib.tests.test_osutils_encodings',
2978
'bzrlib.tests.test_pack',
2979
'bzrlib.tests.test_pack_repository',
2980
'bzrlib.tests.test_patch',
2981
'bzrlib.tests.test_patches',
2982
'bzrlib.tests.test_permissions',
2983
'bzrlib.tests.test_plugins',
2984
'bzrlib.tests.test_progress',
2985
'bzrlib.tests.test_read_bundle',
2986
'bzrlib.tests.test_reconcile',
2987
'bzrlib.tests.test_reconfigure',
2988
'bzrlib.tests.test_registry',
2989
'bzrlib.tests.test_remote',
2990
'bzrlib.tests.test_repository',
2991
'bzrlib.tests.test_revert',
2992
'bzrlib.tests.test_revision',
2993
'bzrlib.tests.test_revisionspec',
2994
'bzrlib.tests.test_revisiontree',
2995
'bzrlib.tests.test_rio',
2996
'bzrlib.tests.test_rules',
2997
'bzrlib.tests.test_sampler',
2998
'bzrlib.tests.test_selftest',
2999
'bzrlib.tests.test_setup',
3000
'bzrlib.tests.test_sftp_transport',
3001
'bzrlib.tests.test_shelf',
3002
'bzrlib.tests.test_shelf_ui',
3003
'bzrlib.tests.test_smart',
3004
'bzrlib.tests.test_smart_add',
3005
'bzrlib.tests.test_smart_request',
3006
'bzrlib.tests.test_smart_transport',
3007
'bzrlib.tests.test_smtp_connection',
3008
'bzrlib.tests.test_source',
3009
'bzrlib.tests.test_ssh_transport',
3010
'bzrlib.tests.test_status',
3011
'bzrlib.tests.test_store',
3012
'bzrlib.tests.test_strace',
3013
'bzrlib.tests.test_subsume',
3014
'bzrlib.tests.test_switch',
3015
'bzrlib.tests.test_symbol_versioning',
3016
'bzrlib.tests.test_tag',
3017
'bzrlib.tests.test_testament',
3018
'bzrlib.tests.test_textfile',
3019
'bzrlib.tests.test_textmerge',
3020
'bzrlib.tests.test_timestamp',
3021
'bzrlib.tests.test_trace',
3022
'bzrlib.tests.test_transactions',
3023
'bzrlib.tests.test_transform',
3024
'bzrlib.tests.test_transport',
3025
'bzrlib.tests.test_transport_implementations',
3026
'bzrlib.tests.test_transport_log',
3027
'bzrlib.tests.test_tree',
3028
'bzrlib.tests.test_treebuilder',
3029
'bzrlib.tests.test_tsort',
3030
'bzrlib.tests.test_tuned_gzip',
3031
'bzrlib.tests.test_ui',
3032
'bzrlib.tests.test_uncommit',
3033
'bzrlib.tests.test_upgrade',
3034
'bzrlib.tests.test_upgrade_stacked',
3035
'bzrlib.tests.test_urlutils',
3036
'bzrlib.tests.test_version',
3037
'bzrlib.tests.test_version_info',
3038
'bzrlib.tests.test_versionedfile',
3039
'bzrlib.tests.test_weave',
3040
'bzrlib.tests.test_whitebox',
3041
'bzrlib.tests.test_win32utils',
3042
'bzrlib.tests.test_workingtree',
3043
'bzrlib.tests.test_workingtree_4',
3044
'bzrlib.tests.test_wsgi',
3045
'bzrlib.tests.test_xml',
3046
'bzrlib.tests.tree_implementations',
3047
'bzrlib.tests.workingtree_implementations',
3048
'bzrlib.util.tests.test_bencode',
3051
loader = TestUtil.TestLoader()
3054
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3055
for start in starting_with]
3056
# We take precedence over keep_only because *at loading time* using
3057
# both options means we will load less tests for the same final result.
3058
def interesting_module(name):
3059
for start in starting_with:
3061
# Either the module name starts with the specified string
3062
name.startswith(start)
3063
# or it may contain tests starting with the specified string
3064
or start.startswith(name)
3068
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3070
elif keep_only is not None:
3071
id_filter = TestIdList(keep_only)
3072
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3073
def interesting_module(name):
3074
return id_filter.refers_to(name)
3077
loader = TestUtil.TestLoader()
3078
def interesting_module(name):
3079
# No filtering, all modules are interesting
3082
suite = loader.suiteClass()
3084
# modules building their suite with loadTestsFromModuleNames
3085
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3087
modules_to_doctest = [
3089
'bzrlib.branchbuilder',
3092
'bzrlib.iterablefile',
3096
'bzrlib.symbol_versioning',
3099
'bzrlib.version_info_formats.format_custom',
3102
for mod in modules_to_doctest:
3103
if not interesting_module(mod):
3104
# No tests to keep here, move along
3107
# note that this really does mean "report only" -- doctest
3108
# still runs the rest of the examples
3109
doc_suite = doctest.DocTestSuite(mod,
3110
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3111
except ValueError, e:
3112
print '**failed to get doctest for: %s\n%s' % (mod, e)
3114
if len(doc_suite._tests) == 0:
3115
raise errors.BzrError("no doctests found in %s" % (mod,))
3116
suite.addTest(doc_suite)
3118
default_encoding = sys.getdefaultencoding()
3119
for name, plugin in bzrlib.plugin.plugins().items():
3120
if not interesting_module(plugin.module.__name__):
3122
plugin_suite = plugin.test_suite()
3123
# We used to catch ImportError here and turn it into just a warning,
3124
# but really if you don't have --no-plugins this should be a failure.
3125
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3126
if plugin_suite is None:
3127
plugin_suite = plugin.load_plugin_tests(loader)
3128
if plugin_suite is not None:
3129
suite.addTest(plugin_suite)
3130
if default_encoding != sys.getdefaultencoding():
3131
bzrlib.trace.warning(
3132
'Plugin "%s" tried to reset default encoding to: %s', name,
3133
sys.getdefaultencoding())
3135
sys.setdefaultencoding(default_encoding)
3138
suite = filter_suite_by_id_startswith(suite, starting_with)
3140
if keep_only is not None:
3141
# Now that the referred modules have loaded their tests, keep only the
3143
suite = filter_suite_by_id_list(suite, id_filter)
3144
# Do some sanity checks on the id_list filtering
3145
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3147
# The tester has used both keep_only and starting_with, so he is
3148
# already aware that some tests are excluded from the list, there
3149
# is no need to tell him which.
3152
# Some tests mentioned in the list are not in the test suite. The
3153
# list may be out of date, report to the tester.
3154
for id in not_found:
3155
bzrlib.trace.warning('"%s" not found in the test suite', id)
3156
for id in duplicates:
3157
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3162
def multiply_tests_from_modules(module_name_list, scenario_iter, loader=None):
3163
"""Adapt all tests in some given modules to given scenarios.
3165
This is the recommended public interface for test parameterization.
3166
Typically the test_suite() method for a per-implementation test
3167
suite will call multiply_tests_from_modules and return the
3170
:param module_name_list: List of fully-qualified names of test
3172
:param scenario_iter: Iterable of pairs of (scenario_name,
3173
scenario_param_dict).
3174
:param loader: If provided, will be used instead of a new
3175
bzrlib.tests.TestLoader() instance.
3177
This returns a new TestSuite containing the cross product of
3178
all the tests in all the modules, each repeated for each scenario.
3179
Each test is adapted by adding the scenario name at the end
3180
of its name, and updating the test object's __dict__ with the
3181
scenario_param_dict.
3183
>>> r = multiply_tests_from_modules(
3184
... ['bzrlib.tests.test_sampler'],
3185
... [('one', dict(param=1)),
3186
... ('two', dict(param=2))])
3187
>>> tests = list(iter_suite_tests(r))
3191
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3197
# XXX: Isn't load_tests() a better way to provide the same functionality
3198
# without forcing a predefined TestScenarioApplier ? --vila 080215
3200
loader = TestUtil.TestLoader()
3202
suite = loader.suiteClass()
3204
adapter = TestScenarioApplier()
3205
adapter.scenarios = list(scenario_iter)
3206
adapt_modules(module_name_list, adapter, loader, suite)
3210
def multiply_scenarios(scenarios_left, scenarios_right):
3211
"""Multiply two sets of scenarios.
3213
:returns: the cartesian product of the two sets of scenarios, that is
3214
a scenario for every possible combination of a left scenario and a
3218
('%s,%s' % (left_name, right_name),
3219
dict(left_dict.items() + right_dict.items()))
3220
for left_name, left_dict in scenarios_left
3221
for right_name, right_dict in scenarios_right]
3225
def adapt_modules(mods_list, adapter, loader, suite):
3226
"""Adapt the modules in mods_list using adapter and add to suite."""
3227
tests = loader.loadTestsFromModuleNames(mods_list)
3228
adapt_tests(tests, adapter, suite)
3231
def adapt_tests(tests_list, adapter, suite):
3232
"""Adapt the tests in tests_list using adapter and add to suite."""
3233
for test in iter_suite_tests(tests_list):
3234
suite.addTests(adapter.adapt(test))
3237
def _rmtree_temp_dir(dirname):
3238
# If LANG=C we probably have created some bogus paths
3239
# which rmtree(unicode) will fail to delete
3240
# so make sure we are using rmtree(str) to delete everything
3241
# except on win32, where rmtree(str) will fail
3242
# since it doesn't have the property of byte-stream paths
3243
# (they are either ascii or mbcs)
3244
if sys.platform == 'win32':
3245
# make sure we are using the unicode win32 api
3246
dirname = unicode(dirname)
3248
dirname = dirname.encode(sys.getfilesystemencoding())
3250
osutils.rmtree(dirname)
3252
if sys.platform == 'win32' and e.errno == errno.EACCES:
3253
sys.stderr.write(('Permission denied: '
3254
'unable to remove testing dir '
3255
'%s\n' % os.path.basename(dirname)))
3260
class Feature(object):
3261
"""An operating system Feature."""
3264
self._available = None
3266
def available(self):
3267
"""Is the feature available?
3269
:return: True if the feature is available.
3271
if self._available is None:
3272
self._available = self._probe()
3273
return self._available
3276
"""Implement this method in concrete features.
3278
:return: True if the feature is available.
3280
raise NotImplementedError
3283
if getattr(self, 'feature_name', None):
3284
return self.feature_name()
3285
return self.__class__.__name__
3288
class _SymlinkFeature(Feature):
3291
return osutils.has_symlinks()
3293
def feature_name(self):
3296
SymlinkFeature = _SymlinkFeature()
3299
class _HardlinkFeature(Feature):
3302
return osutils.has_hardlinks()
3304
def feature_name(self):
3307
HardlinkFeature = _HardlinkFeature()
3310
class _OsFifoFeature(Feature):
3313
return getattr(os, 'mkfifo', None)
3315
def feature_name(self):
3316
return 'filesystem fifos'
3318
OsFifoFeature = _OsFifoFeature()
3321
class _UnicodeFilenameFeature(Feature):
3322
"""Does the filesystem support Unicode filenames?"""
3326
# Check for character combinations unlikely to be covered by any
3327
# single non-unicode encoding. We use the characters
3328
# - greek small letter alpha (U+03B1) and
3329
# - braille pattern dots-123456 (U+283F).
3330
os.stat(u'\u03b1\u283f')
3331
except UnicodeEncodeError:
3333
except (IOError, OSError):
3334
# The filesystem allows the Unicode filename but the file doesn't
3338
# The filesystem allows the Unicode filename and the file exists,
3342
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3345
class TestScenarioApplier(object):
3346
"""A tool to apply scenarios to tests."""
3348
def adapt(self, test):
3349
"""Return a TestSuite containing a copy of test for each scenario."""
3350
result = unittest.TestSuite()
3351
for scenario in self.scenarios:
3352
result.addTest(self.adapt_test_to_scenario(test, scenario))
3355
def adapt_test_to_scenario(self, test, scenario):
3356
"""Copy test and apply scenario to it.
3358
:param test: A test to adapt.
3359
:param scenario: A tuple describing the scenarion.
3360
The first element of the tuple is the new test id.
3361
The second element is a dict containing attributes to set on the
3363
:return: The adapted test.
3365
from copy import deepcopy
3366
new_test = deepcopy(test)
3367
for name, value in scenario[1].items():
3368
setattr(new_test, name, value)
3369
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3370
new_test.id = lambda: new_id
3374
def probe_unicode_in_user_encoding():
3375
"""Try to encode several unicode strings to use in unicode-aware tests.
3376
Return first successfull match.
3378
:return: (unicode value, encoded plain string value) or (None, None)
3380
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3381
for uni_val in possible_vals:
3383
str_val = uni_val.encode(osutils.get_user_encoding())
3384
except UnicodeEncodeError:
3385
# Try a different character
3388
return uni_val, str_val
3392
def probe_bad_non_ascii(encoding):
3393
"""Try to find [bad] character with code [128..255]
3394
that cannot be decoded to unicode in some encoding.
3395
Return None if all non-ascii characters is valid
3398
for i in xrange(128, 256):
3401
char.decode(encoding)
3402
except UnicodeDecodeError:
3407
class _FTPServerFeature(Feature):
3408
"""Some tests want an FTP Server, check if one is available.
3410
Right now, the only way this is available is if 'medusa' is installed.
3411
http://www.amk.ca/python/code/medusa.html
3416
import bzrlib.tests.ftp_server
3421
def feature_name(self):
3425
FTPServerFeature = _FTPServerFeature()
3428
class _HTTPSServerFeature(Feature):
3429
"""Some tests want an https Server, check if one is available.
3431
Right now, the only way this is available is under python2.6 which provides
3442
def feature_name(self):
3443
return 'HTTPSServer'
3446
HTTPSServerFeature = _HTTPSServerFeature()
3449
class _UnicodeFilename(Feature):
3450
"""Does the filesystem support Unicode filenames?"""
3455
except UnicodeEncodeError:
3457
except (IOError, OSError):
3458
# The filesystem allows the Unicode filename but the file doesn't
3462
# The filesystem allows the Unicode filename and the file exists,
3466
UnicodeFilename = _UnicodeFilename()
3469
class _UTF8Filesystem(Feature):
3470
"""Is the filesystem UTF-8?"""
3473
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3477
UTF8Filesystem = _UTF8Filesystem()
3480
class _CaseInsCasePresFilenameFeature(Feature):
3481
"""Is the file-system case insensitive, but case-preserving?"""
3484
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3486
# first check truly case-preserving for created files, then check
3487
# case insensitive when opening existing files.
3488
name = osutils.normpath(name)
3489
base, rel = osutils.split(name)
3490
found_rel = osutils.canonical_relpath(base, name)
3491
return (found_rel == rel
3492
and os.path.isfile(name.upper())
3493
and os.path.isfile(name.lower()))
3498
def feature_name(self):
3499
return "case-insensitive case-preserving filesystem"
3501
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3504
class _CaseInsensitiveFilesystemFeature(Feature):
3505
"""Check if underlying filesystem is case-insensitive but *not* case
3508
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3509
# more likely to be case preserving, so this case is rare.
3512
if CaseInsCasePresFilenameFeature.available():
3515
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3516
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3517
TestCaseWithMemoryTransport.TEST_ROOT = root
3519
root = TestCaseWithMemoryTransport.TEST_ROOT
3520
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3522
name_a = osutils.pathjoin(tdir, 'a')
3523
name_A = osutils.pathjoin(tdir, 'A')
3525
result = osutils.isdir(name_A)
3526
_rmtree_temp_dir(tdir)
3529
def feature_name(self):
3530
return 'case-insensitive filesystem'
3532
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
