1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
from testsweet import TestBase, run_suite, InTempDir
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
38
from pprint import pformat
43
from subprocess import Popen, PIPE, STDOUT
19
68
import bzrlib.commands
22
MODULES_TO_DOCTEST = []
25
class BzrTestBase(InTempDir):
26
"""bzr-specific test base class"""
27
def run_bzr(self, *args, **kwargs):
28
retcode = kwargs.get('retcode', 0)
29
self.assertEquals(bzrlib.commands.run_bzr(args), retcode)
69
import bzrlib.timestamp
71
import bzrlib.inventory
72
import bzrlib.iterablefile
77
# lsprof not available
79
from bzrlib.merge import merge_inner
82
from bzrlib.smart import client, request, server
84
from bzrlib import symbol_versioning
85
from bzrlib.symbol_versioning import (
92
from bzrlib.transport import get_transport
93
import bzrlib.transport
94
from bzrlib.transport.local import LocalURLServer
95
from bzrlib.transport.memory import MemoryServer
96
from bzrlib.transport.readonly import ReadonlyServer
97
from bzrlib.trace import mutter, note
98
from bzrlib.tests import TestUtil
99
from bzrlib.tests.http_server import HttpServer
100
from bzrlib.tests.TestUtil import (
104
from bzrlib.tests.treeshape import build_tree_contents
105
from bzrlib.ui import NullProgressView
106
from bzrlib.ui.text import TextUIFactory
107
import bzrlib.version_info_formats.format_custom
108
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
110
# Mark this python module as being part of the implementation
111
# of unittest: this gives us better tracebacks where the last
112
# shown frame is the test code, not our assertXYZ.
115
default_transport = LocalURLServer
118
class ExtendedTestResult(unittest._TextTestResult):
119
"""Accepts, reports and accumulates the results of running tests.
121
Compared to the unittest version this class adds support for
122
profiling, benchmarking, stopping as soon as a test fails, and
123
skipping tests. There are further-specialized subclasses for
124
different types of display.
126
When a test finishes, in whatever way, it calls one of the addSuccess,
127
addFailure or addError classes. These in turn may redirect to a more
128
specific case for the special test results supported by our extended
131
Note that just one of these objects is fed the results from many tests.
136
def __init__(self, stream, descriptions, verbosity,
141
"""Construct new TestResult.
143
:param bench_history: Optionally, a writable file object to accumulate
146
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
147
if bench_history is not None:
148
from bzrlib.version import _get_bzr_source_tree
149
src_tree = _get_bzr_source_tree()
152
revision_id = src_tree.get_parent_ids()[0]
154
# XXX: if this is a brand new tree, do the same as if there
158
# XXX: If there's no branch, what should we do?
160
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
161
self._bench_history = bench_history
162
self.ui = ui.ui_factory
163
self.num_tests = num_tests
165
self.failure_count = 0
166
self.known_failure_count = 0
168
self.not_applicable_count = 0
169
self.unsupported = {}
171
self._overall_start_time = time.time()
172
self._strict = strict
176
ok = self.wasStrictlySuccessful()
178
ok = self.wasSuccessful()
180
self.stream.write('tests passed\n')
182
self.stream.write('tests failed\n')
183
if TestCase._first_thread_leaker_id:
185
'%s is leaking threads among %d leaking tests.\n' % (
186
TestCase._first_thread_leaker_id,
187
TestCase._leaking_threads_tests))
189
def _extractBenchmarkTime(self, testCase):
190
"""Add a benchmark time for the current test case."""
191
return getattr(testCase, "_benchtime", None)
193
def _elapsedTestTimeString(self):
194
"""Return a time string for the overall time the current test has taken."""
195
return self._formatTime(time.time() - self._start_time)
197
def _testTimeString(self, testCase):
198
benchmark_time = self._extractBenchmarkTime(testCase)
199
if benchmark_time is not None:
200
return self._formatTime(benchmark_time) + "*"
202
return self._elapsedTestTimeString()
204
def _formatTime(self, seconds):
205
"""Format seconds as milliseconds with leading spaces."""
206
# some benchmarks can take thousands of seconds to run, so we need 8
208
return "%8dms" % (1000 * seconds)
210
def _shortened_test_description(self, test):
212
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
215
def startTest(self, test):
216
unittest.TestResult.startTest(self, test)
219
self.report_test_start(test)
220
test.number = self.count
221
self._recordTestStartTime()
223
def startTests(self):
225
'testing: %s\n' % (osutils.realpath(sys.argv[0]),))
227
' %s (%s python%s)\n' % (
229
bzrlib.version_string,
230
bzrlib._format_version_tuple(sys.version_info),
232
self.stream.write('\n')
234
def _recordTestStartTime(self):
235
"""Record that a test has started."""
236
self._start_time = time.time()
238
def _cleanupLogFile(self, test):
239
# We can only do this if we have one of our TestCases, not if
241
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
242
if setKeepLogfile is not None:
245
def addError(self, test, err):
246
"""Tell result that test finished with an error.
248
Called from the TestCase run() method when the test
249
fails with an unexpected error.
251
self._testConcluded(test)
252
if isinstance(err[1], TestNotApplicable):
253
return self._addNotApplicable(test, err)
254
elif isinstance(err[1], UnavailableFeature):
255
return self.addNotSupported(test, err[1].args[0])
257
unittest.TestResult.addError(self, test, err)
258
self.error_count += 1
259
self.report_error(test, err)
262
self._cleanupLogFile(test)
264
def addFailure(self, test, err):
265
"""Tell result that test failed.
267
Called from the TestCase run() method when the test
268
fails because e.g. an assert() method failed.
270
self._testConcluded(test)
271
if isinstance(err[1], KnownFailure):
272
return self._addKnownFailure(test, err)
274
unittest.TestResult.addFailure(self, test, err)
275
self.failure_count += 1
276
self.report_failure(test, err)
279
self._cleanupLogFile(test)
281
def addSuccess(self, test):
282
"""Tell result that test completed successfully.
284
Called from the TestCase run()
286
self._testConcluded(test)
287
if self._bench_history is not None:
288
benchmark_time = self._extractBenchmarkTime(test)
289
if benchmark_time is not None:
290
self._bench_history.write("%s %s\n" % (
291
self._formatTime(benchmark_time),
293
self.report_success(test)
294
self._cleanupLogFile(test)
295
unittest.TestResult.addSuccess(self, test)
296
test._log_contents = ''
298
def _testConcluded(self, test):
299
"""Common code when a test has finished.
301
Called regardless of whether it succeded, failed, etc.
305
def _addKnownFailure(self, test, err):
306
self.known_failure_count += 1
307
self.report_known_failure(test, err)
309
def addNotSupported(self, test, feature):
310
"""The test will not be run because of a missing feature.
312
# this can be called in two different ways: it may be that the
313
# test started running, and then raised (through addError)
314
# UnavailableFeature. Alternatively this method can be called
315
# while probing for features before running the tests; in that
316
# case we will see startTest and stopTest, but the test will never
318
self.unsupported.setdefault(str(feature), 0)
319
self.unsupported[str(feature)] += 1
320
self.report_unsupported(test, feature)
322
def addSkip(self, test, reason):
323
"""A test has not run for 'reason'."""
325
self.report_skip(test, reason)
327
def _addNotApplicable(self, test, skip_excinfo):
328
if isinstance(skip_excinfo[1], TestNotApplicable):
329
self.not_applicable_count += 1
330
self.report_not_applicable(test, skip_excinfo)
333
except KeyboardInterrupt:
336
self.addError(test, test.exc_info())
338
# seems best to treat this as success from point-of-view of unittest
339
# -- it actually does nothing so it barely matters :)
340
unittest.TestResult.addSuccess(self, test)
341
test._log_contents = ''
343
def printErrorList(self, flavour, errors):
344
for test, err in errors:
345
self.stream.writeln(self.separator1)
346
self.stream.write("%s: " % flavour)
347
self.stream.writeln(self.getDescription(test))
348
if getattr(test, '_get_log', None) is not None:
349
log_contents = test._get_log()
351
self.stream.write('\n')
353
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
354
self.stream.write('\n')
355
self.stream.write(log_contents)
356
self.stream.write('\n')
358
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
359
self.stream.write('\n')
360
self.stream.writeln(self.separator2)
361
self.stream.writeln("%s" % err)
366
def report_cleaning_up(self):
369
def report_success(self, test):
372
def wasStrictlySuccessful(self):
373
if self.unsupported or self.known_failure_count:
375
return self.wasSuccessful()
378
class TextTestResult(ExtendedTestResult):
379
"""Displays progress and results of tests in text form"""
381
def __init__(self, stream, descriptions, verbosity,
387
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
388
bench_history, num_tests, strict)
390
self.pb = self.ui.nested_progress_bar()
391
self._supplied_pb = False
394
self._supplied_pb = True
395
self.pb.show_pct = False
396
self.pb.show_spinner = False
397
self.pb.show_eta = False,
398
self.pb.show_count = False
399
self.pb.show_bar = False
401
def report_starting(self):
402
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
404
def _progress_prefix_text(self):
405
# the longer this text, the less space we have to show the test
407
a = '[%d' % self.count # total that have been run
408
# tests skipped as known not to be relevant are not important enough
410
## if self.skip_count:
411
## a += ', %d skip' % self.skip_count
412
## if self.known_failure_count:
413
## a += '+%dX' % self.known_failure_count
414
if self.num_tests is not None:
415
a +='/%d' % self.num_tests
417
runtime = time.time() - self._overall_start_time
419
a += '%dm%ds' % (runtime / 60, runtime % 60)
423
a += ', %d err' % self.error_count
424
if self.failure_count:
425
a += ', %d fail' % self.failure_count
427
a += ', %d missing' % len(self.unsupported)
431
def report_test_start(self, test):
434
self._progress_prefix_text()
436
+ self._shortened_test_description(test))
438
def _test_description(self, test):
439
return self._shortened_test_description(test)
441
def report_error(self, test, err):
442
self.pb.note('ERROR: %s\n %s\n',
443
self._test_description(test),
447
def report_failure(self, test, err):
448
self.pb.note('FAIL: %s\n %s\n',
449
self._test_description(test),
453
def report_known_failure(self, test, err):
454
self.pb.note('XFAIL: %s\n%s\n',
455
self._test_description(test), err[1])
457
def report_skip(self, test, reason):
460
def report_not_applicable(self, test, skip_excinfo):
463
def report_unsupported(self, test, feature):
464
"""test cannot be run because feature is missing."""
466
def report_cleaning_up(self):
467
self.pb.update('Cleaning up')
470
if not self._supplied_pb:
474
class VerboseTestResult(ExtendedTestResult):
475
"""Produce long output, with one line per test run plus times"""
477
def _ellipsize_to_right(self, a_string, final_width):
478
"""Truncate and pad a string, keeping the right hand side"""
479
if len(a_string) > final_width:
480
result = '...' + a_string[3-final_width:]
483
return result.ljust(final_width)
485
def report_starting(self):
486
self.stream.write('running %d tests...\n' % self.num_tests)
488
def report_test_start(self, test):
490
name = self._shortened_test_description(test)
491
# width needs space for 6 char status, plus 1 for slash, plus an
492
# 11-char time string, plus a trailing blank
493
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
494
self.stream.write(self._ellipsize_to_right(name,
495
osutils.terminal_width()-18))
498
def _error_summary(self, err):
500
return '%s%s' % (indent, err[1])
502
def report_error(self, test, err):
503
self.stream.writeln('ERROR %s\n%s'
504
% (self._testTimeString(test),
505
self._error_summary(err)))
507
def report_failure(self, test, err):
508
self.stream.writeln(' FAIL %s\n%s'
509
% (self._testTimeString(test),
510
self._error_summary(err)))
512
def report_known_failure(self, test, err):
513
self.stream.writeln('XFAIL %s\n%s'
514
% (self._testTimeString(test),
515
self._error_summary(err)))
517
def report_success(self, test):
518
self.stream.writeln(' OK %s' % self._testTimeString(test))
519
for bench_called, stats in getattr(test, '_benchcalls', []):
520
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
521
stats.pprint(file=self.stream)
522
# flush the stream so that we get smooth output. This verbose mode is
523
# used to show the output in PQM.
526
def report_skip(self, test, reason):
527
self.stream.writeln(' SKIP %s\n%s'
528
% (self._testTimeString(test), reason))
530
def report_not_applicable(self, test, skip_excinfo):
531
self.stream.writeln(' N/A %s\n%s'
532
% (self._testTimeString(test),
533
self._error_summary(skip_excinfo)))
535
def report_unsupported(self, test, feature):
536
"""test cannot be run because feature is missing."""
537
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
538
%(self._testTimeString(test), feature))
541
class TextTestRunner(object):
542
stop_on_failure = False
552
self.stream = unittest._WritelnDecorator(stream)
553
self.descriptions = descriptions
554
self.verbosity = verbosity
555
self._bench_history = bench_history
556
self.list_only = list_only
557
self._strict = strict
560
"Run the given test case or test suite."
561
startTime = time.time()
562
if self.verbosity == 1:
563
result_class = TextTestResult
564
elif self.verbosity >= 2:
565
result_class = VerboseTestResult
566
result = result_class(self.stream,
569
bench_history=self._bench_history,
570
num_tests=test.countTestCases(),
573
result.stop_early = self.stop_on_failure
574
result.report_starting()
576
if self.verbosity >= 2:
577
self.stream.writeln("Listing tests only ...\n")
579
for t in iter_suite_tests(test):
580
self.stream.writeln("%s" % (t.id()))
589
if isinstance(test, testtools.ConcurrentTestSuite):
590
# We need to catch bzr specific behaviors
591
test.run(BZRTransformingResult(result))
594
run = result.testsRun
596
stopTime = time.time()
597
timeTaken = stopTime - startTime
599
self.stream.writeln(result.separator2)
600
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
601
run, run != 1 and "s" or "", timeTaken))
602
self.stream.writeln()
603
if not result.wasSuccessful():
604
self.stream.write("FAILED (")
605
failed, errored = map(len, (result.failures, result.errors))
607
self.stream.write("failures=%d" % failed)
609
if failed: self.stream.write(", ")
610
self.stream.write("errors=%d" % errored)
611
if result.known_failure_count:
612
if failed or errored: self.stream.write(", ")
613
self.stream.write("known_failure_count=%d" %
614
result.known_failure_count)
615
self.stream.writeln(")")
617
if result.known_failure_count:
618
self.stream.writeln("OK (known_failures=%d)" %
619
result.known_failure_count)
621
self.stream.writeln("OK")
622
if result.skip_count > 0:
623
skipped = result.skip_count
624
self.stream.writeln('%d test%s skipped' %
625
(skipped, skipped != 1 and "s" or ""))
626
if result.unsupported:
627
for feature, count in sorted(result.unsupported.items()):
628
self.stream.writeln("Missing feature '%s' skipped %d tests." %
634
def iter_suite_tests(suite):
635
"""Return all tests in a suite, recursing through nested suites"""
636
if isinstance(suite, unittest.TestCase):
638
elif isinstance(suite, unittest.TestSuite):
640
for r in iter_suite_tests(item):
643
raise Exception('unknown type %r for object %r'
644
% (type(suite), suite))
647
class TestSkipped(Exception):
648
"""Indicates that a test was intentionally skipped, rather than failing."""
651
class TestNotApplicable(TestSkipped):
652
"""A test is not applicable to the situation where it was run.
654
This is only normally raised by parameterized tests, if they find that
655
the instance they're constructed upon does not support one aspect
660
class KnownFailure(AssertionError):
661
"""Indicates that a test failed in a precisely expected manner.
663
Such failures dont block the whole test suite from passing because they are
664
indicators of partially completed code or of future work. We have an
665
explicit error for them so that we can ensure that they are always visible:
666
KnownFailures are always shown in the output of bzr selftest.
670
class UnavailableFeature(Exception):
671
"""A feature required for this test was not available.
673
The feature should be used to construct the exception.
677
class CommandFailed(Exception):
681
class StringIOWrapper(object):
682
"""A wrapper around cStringIO which just adds an encoding attribute.
684
Internally we can check sys.stdout to see what the output encoding
685
should be. However, cStringIO has no encoding attribute that we can
686
set. So we wrap it instead.
691
def __init__(self, s=None):
693
self.__dict__['_cstring'] = StringIO(s)
695
self.__dict__['_cstring'] = StringIO()
697
def __getattr__(self, name, getattr=getattr):
698
return getattr(self.__dict__['_cstring'], name)
700
def __setattr__(self, name, val):
701
if name == 'encoding':
702
self.__dict__['encoding'] = val
704
return setattr(self._cstring, name, val)
707
class TestUIFactory(TextUIFactory):
708
"""A UI Factory for testing.
710
Hide the progress bar but emit note()s.
712
Allows get_password to be tested without real tty attached.
714
See also CannedInputUIFactory which lets you provide programmatic input in
717
# XXX: Should probably unify more with CannedInputUIFactory or a
718
# particular configuration of TextUIFactory, or otherwise have a clearer
719
# idea of how they're supposed to be different.
721
def __init__(self, stdout=None, stderr=None, stdin=None):
722
if stdin is not None:
723
# We use a StringIOWrapper to be able to test various
724
# encodings, but the user is still responsible to
725
# encode the string and to set the encoding attribute
726
# of StringIOWrapper.
727
stdin = StringIOWrapper(stdin)
728
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
730
def make_progress_view(self):
731
return NullProgressView()
733
def update(self, message, count=None, total=None):
734
"""See progress.ProgressBar.update()."""
736
def get_non_echoed_password(self):
737
"""Get password from stdin without trying to handle the echo mode"""
738
password = self.stdin.readline()
741
if password[-1] == '\n':
742
password = password[:-1]
746
class TestCase(unittest.TestCase):
747
"""Base class for bzr unit tests.
749
Tests that need access to disk resources should subclass
750
TestCaseInTempDir not TestCase.
752
Error and debug log messages are redirected from their usual
753
location into a temporary file, the contents of which can be
754
retrieved by _get_log(). We use a real OS file, not an in-memory object,
755
so that it can also capture file IO. When the test completes this file
756
is read into memory and removed from disk.
758
There are also convenience functions to invoke bzr's command-line
759
routine, and to build and check bzr trees.
761
In addition to the usual method of overriding tearDown(), this class also
762
allows subclasses to register functions into the _cleanups list, which is
763
run in order as the object is torn down. It's less likely this will be
764
accidentally overlooked.
767
_active_threads = None
768
_leaking_threads_tests = 0
769
_first_thread_leaker_id = None
770
_log_file_name = None
772
_keep_log_file = False
773
# record lsprof data when performing benchmark calls.
774
_gather_lsprof_in_benchmarks = False
775
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
776
'_log_contents', '_log_file_name', '_benchtime',
777
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
779
def __init__(self, methodName='testMethod'):
780
super(TestCase, self).__init__(methodName)
782
self._bzr_test_setUp_run = False
783
self._bzr_test_tearDown_run = False
786
unittest.TestCase.setUp(self)
787
self._bzr_test_setUp_run = True
788
self._cleanEnvironment()
791
self._benchcalls = []
792
self._benchtime = None
794
# Track locks - needs to be called before _clear_debug_flags.
796
self._clear_debug_flags()
797
TestCase._active_threads = threading.activeCount()
798
self.addCleanup(self._check_leaked_threads)
803
pdb.Pdb().set_trace(sys._getframe().f_back)
805
def _check_leaked_threads(self):
806
active = threading.activeCount()
807
leaked_threads = active - TestCase._active_threads
808
TestCase._active_threads = active
810
TestCase._leaking_threads_tests += 1
811
if TestCase._first_thread_leaker_id is None:
812
TestCase._first_thread_leaker_id = self.id()
814
def _clear_debug_flags(self):
815
"""Prevent externally set debug flags affecting tests.
817
Tests that want to use debug flags can just set them in the
818
debug_flags set during setup/teardown.
820
self._preserved_debug_flags = set(debug.debug_flags)
821
if 'allow_debug' not in selftest_debug_flags:
822
debug.debug_flags.clear()
823
self.addCleanup(self._restore_debug_flags)
825
def _clear_hooks(self):
826
# prevent hooks affecting tests
827
self._preserved_hooks = {}
828
for key, factory in hooks.known_hooks.items():
829
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
830
current_hooks = hooks.known_hooks_key_to_object(key)
831
self._preserved_hooks[parent] = (name, current_hooks)
832
self.addCleanup(self._restoreHooks)
833
for key, factory in hooks.known_hooks.items():
834
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
835
setattr(parent, name, factory())
836
# this hook should always be installed
837
request._install_hook()
839
def _silenceUI(self):
840
"""Turn off UI for duration of test"""
841
# by default the UI is off; tests can turn it on if they want it.
842
saved = ui.ui_factory
844
ui.ui_factory = saved
845
ui.ui_factory = ui.SilentUIFactory()
846
self.addCleanup(_restore)
848
def _check_locks(self):
849
"""Check that all lock take/release actions have been paired."""
850
# once we have fixed all the current lock problems, we can change the
851
# following code to always check for mismatched locks, but only do
852
# traceback showing with -Dlock (self._lock_check_thorough is True).
853
# For now, because the test suite will fail, we only assert that lock
854
# matching has occured with -Dlock.
856
acquired_locks = [lock for action, lock in self._lock_actions
857
if action == 'acquired']
858
released_locks = [lock for action, lock in self._lock_actions
859
if action == 'released']
860
broken_locks = [lock for action, lock in self._lock_actions
861
if action == 'broken']
862
# trivially, given the tests for lock acquistion and release, if we
863
# have as many in each list, it should be ok. Some lock tests also
864
# break some locks on purpose and should be taken into account by
865
# considering that breaking a lock is just a dirty way of releasing it.
866
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
867
message = ('Different number of acquired and '
868
'released or broken locks. (%s, %s + %s)' %
869
(acquired_locks, released_locks, broken_locks))
870
if not self._lock_check_thorough:
871
# Rather than fail, just warn
872
print "Broken test %s: %s" % (self, message)
876
def _track_locks(self):
877
"""Track lock activity during tests."""
878
self._lock_actions = []
879
self._lock_check_thorough = 'lock' not in debug.debug_flags
880
self.addCleanup(self._check_locks)
881
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
882
self._lock_acquired, None)
883
_mod_lock.Lock.hooks.install_named_hook('lock_released',
884
self._lock_released, None)
885
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
886
self._lock_broken, None)
888
def _lock_acquired(self, result):
889
self._lock_actions.append(('acquired', result))
891
def _lock_released(self, result):
892
self._lock_actions.append(('released', result))
894
def _lock_broken(self, result):
895
self._lock_actions.append(('broken', result))
897
def _ndiff_strings(self, a, b):
898
"""Return ndiff between two strings containing lines.
900
A trailing newline is added if missing to make the strings
902
if b and b[-1] != '\n':
904
if a and a[-1] != '\n':
906
difflines = difflib.ndiff(a.splitlines(True),
908
linejunk=lambda x: False,
909
charjunk=lambda x: False)
910
return ''.join(difflines)
912
def assertEqual(self, a, b, message=''):
916
except UnicodeError, e:
917
# If we can't compare without getting a UnicodeError, then
918
# obviously they are different
919
mutter('UnicodeError: %s', e)
922
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
924
pformat(a), pformat(b)))
926
assertEquals = assertEqual
928
def assertEqualDiff(self, a, b, message=None):
929
"""Assert two texts are equal, if not raise an exception.
931
This is intended for use with multi-line strings where it can
932
be hard to find the differences by eye.
934
# TODO: perhaps override assertEquals to call this for strings?
938
message = "texts not equal:\n"
940
message = 'first string is missing a final newline.\n'
942
message = 'second string is missing a final newline.\n'
943
raise AssertionError(message +
944
self._ndiff_strings(a, b))
946
def assertEqualMode(self, mode, mode_test):
947
self.assertEqual(mode, mode_test,
948
'mode mismatch %o != %o' % (mode, mode_test))
950
def assertEqualStat(self, expected, actual):
951
"""assert that expected and actual are the same stat result.
953
:param expected: A stat result.
954
:param actual: A stat result.
955
:raises AssertionError: If the expected and actual stat values differ
958
self.assertEqual(expected.st_size, actual.st_size)
959
self.assertEqual(expected.st_mtime, actual.st_mtime)
960
self.assertEqual(expected.st_ctime, actual.st_ctime)
961
self.assertEqual(expected.st_dev, actual.st_dev)
962
self.assertEqual(expected.st_ino, actual.st_ino)
963
self.assertEqual(expected.st_mode, actual.st_mode)
965
def assertLength(self, length, obj_with_len):
966
"""Assert that obj_with_len is of length length."""
967
if len(obj_with_len) != length:
968
self.fail("Incorrect length: wanted %d, got %d for %r" % (
969
length, len(obj_with_len), obj_with_len))
971
def assertPositive(self, val):
972
"""Assert that val is greater than 0."""
973
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
975
def assertNegative(self, val):
976
"""Assert that val is less than 0."""
977
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
979
def assertStartsWith(self, s, prefix):
980
if not s.startswith(prefix):
981
raise AssertionError('string %r does not start with %r' % (s, prefix))
983
def assertEndsWith(self, s, suffix):
984
"""Asserts that s ends with suffix."""
985
if not s.endswith(suffix):
986
raise AssertionError('string %r does not end with %r' % (s, suffix))
988
def assertContainsRe(self, haystack, needle_re, flags=0):
989
"""Assert that a contains something matching a regular expression."""
990
if not re.search(needle_re, haystack, flags):
991
if '\n' in haystack or len(haystack) > 60:
992
# a long string, format it in a more readable way
993
raise AssertionError(
994
'pattern "%s" not found in\n"""\\\n%s"""\n'
995
% (needle_re, haystack))
997
raise AssertionError('pattern "%s" not found in "%s"'
998
% (needle_re, haystack))
1000
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1001
"""Assert that a does not match a regular expression"""
1002
if re.search(needle_re, haystack, flags):
1003
raise AssertionError('pattern "%s" found in "%s"'
1004
% (needle_re, haystack))
1006
def assertSubset(self, sublist, superlist):
1007
"""Assert that every entry in sublist is present in superlist."""
1008
missing = set(sublist) - set(superlist)
1009
if len(missing) > 0:
1010
raise AssertionError("value(s) %r not present in container %r" %
1011
(missing, superlist))
1013
def assertListRaises(self, excClass, func, *args, **kwargs):
1014
"""Fail unless excClass is raised when the iterator from func is used.
1016
Many functions can return generators this makes sure
1017
to wrap them in a list() call to make sure the whole generator
1018
is run, and that the proper exception is raised.
1021
list(func(*args, **kwargs))
1025
if getattr(excClass,'__name__', None) is not None:
1026
excName = excClass.__name__
1028
excName = str(excClass)
1029
raise self.failureException, "%s not raised" % excName
1031
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1032
"""Assert that a callable raises a particular exception.
1034
:param excClass: As for the except statement, this may be either an
1035
exception class, or a tuple of classes.
1036
:param callableObj: A callable, will be passed ``*args`` and
1039
Returns the exception so that you can examine it.
1042
callableObj(*args, **kwargs)
1046
if getattr(excClass,'__name__', None) is not None:
1047
excName = excClass.__name__
1050
excName = str(excClass)
1051
raise self.failureException, "%s not raised" % excName
1053
def assertIs(self, left, right, message=None):
1054
if not (left is right):
1055
if message is not None:
1056
raise AssertionError(message)
1058
raise AssertionError("%r is not %r." % (left, right))
1060
def assertIsNot(self, left, right, message=None):
1062
if message is not None:
1063
raise AssertionError(message)
1065
raise AssertionError("%r is %r." % (left, right))
1067
def assertTransportMode(self, transport, path, mode):
1068
"""Fail if a path does not have mode "mode".
1070
If modes are not supported on this transport, the assertion is ignored.
1072
if not transport._can_roundtrip_unix_modebits():
1074
path_stat = transport.stat(path)
1075
actual_mode = stat.S_IMODE(path_stat.st_mode)
1076
self.assertEqual(mode, actual_mode,
1077
'mode of %r incorrect (%s != %s)'
1078
% (path, oct(mode), oct(actual_mode)))
1080
def assertIsSameRealPath(self, path1, path2):
1081
"""Fail if path1 and path2 points to different files"""
1082
self.assertEqual(osutils.realpath(path1),
1083
osutils.realpath(path2),
1084
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1086
def assertIsInstance(self, obj, kls, msg=None):
1087
"""Fail if obj is not an instance of kls
32
def selftest(verbose=False):
33
from unittest import TestLoader, TestSuite
34
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
35
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
36
from doctest import DocTestSuite
43
global MODULES_TO_TEST, MODULES_TO_DOCTEST
46
['bzrlib.selftest.whitebox',
47
'bzrlib.selftest.versioning',
48
'bzrlib.selftest.testinv',
49
'bzrlib.selftest.testmerge3',
50
'bzrlib.selftest.testhashcache',
51
'bzrlib.selftest.teststatus',
52
'bzrlib.selftest.testlog',
53
'bzrlib.selftest.blackbox',
54
'bzrlib.selftest.testrevisionnamespaces',
55
'bzrlib.selftest.testbranch',
56
'bzrlib.selftest.testrevision',
58
'bzrlib.selftest.testdiff',
1089
:param msg: Supplementary message to show if the assertion fails.
1091
if not isinstance(obj, kls):
1092
m = "%r is an instance of %s rather than %s" % (
1093
obj, obj.__class__, kls)
1098
def expectFailure(self, reason, assertion, *args, **kwargs):
1099
"""Invoke a test, expecting it to fail for the given reason.
1101
This is for assertions that ought to succeed, but currently fail.
1102
(The failure is *expected* but not *wanted*.) Please be very precise
1103
about the failure you're expecting. If a new bug is introduced,
1104
AssertionError should be raised, not KnownFailure.
1106
Frequently, expectFailure should be followed by an opposite assertion.
1109
Intended to be used with a callable that raises AssertionError as the
1110
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1112
Raises KnownFailure if the test fails. Raises AssertionError if the
1117
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1119
self.assertEqual(42, dynamic_val)
1121
This means that a dynamic_val of 54 will cause the test to raise
1122
a KnownFailure. Once math is fixed and the expectFailure is removed,
1123
only a dynamic_val of 42 will allow the test to pass. Anything other
1124
than 54 or 42 will cause an AssertionError.
1127
assertion(*args, **kwargs)
1128
except AssertionError:
1129
raise KnownFailure(reason)
1131
self.fail('Unexpected success. Should have failed: %s' % reason)
1133
def assertFileEqual(self, content, path):
1134
"""Fail if path does not contain 'content'."""
1135
self.failUnlessExists(path)
1136
f = file(path, 'rb')
1141
self.assertEqualDiff(content, s)
1143
def failUnlessExists(self, path):
1144
"""Fail unless path or paths, which may be abs or relative, exist."""
1145
if not isinstance(path, basestring):
1147
self.failUnlessExists(p)
1149
self.failUnless(osutils.lexists(path),path+" does not exist")
1151
def failIfExists(self, path):
1152
"""Fail if path or paths, which may be abs or relative, exist."""
1153
if not isinstance(path, basestring):
1155
self.failIfExists(p)
1157
self.failIf(osutils.lexists(path),path+" exists")
1159
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1160
"""A helper for callDeprecated and applyDeprecated.
1162
:param a_callable: A callable to call.
1163
:param args: The positional arguments for the callable
1164
:param kwargs: The keyword arguments for the callable
1165
:return: A tuple (warnings, result). result is the result of calling
1166
a_callable(``*args``, ``**kwargs``).
1169
def capture_warnings(msg, cls=None, stacklevel=None):
1170
# we've hooked into a deprecation specific callpath,
1171
# only deprecations should getting sent via it.
1172
self.assertEqual(cls, DeprecationWarning)
1173
local_warnings.append(msg)
1174
original_warning_method = symbol_versioning.warn
1175
symbol_versioning.set_warning_method(capture_warnings)
1177
result = a_callable(*args, **kwargs)
1179
symbol_versioning.set_warning_method(original_warning_method)
1180
return (local_warnings, result)
1182
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1183
"""Call a deprecated callable without warning the user.
1185
Note that this only captures warnings raised by symbol_versioning.warn,
1186
not other callers that go direct to the warning module.
1188
To test that a deprecated method raises an error, do something like
1191
self.assertRaises(errors.ReservedId,
1192
self.applyDeprecated,
1193
deprecated_in((1, 5, 0)),
1197
:param deprecation_format: The deprecation format that the callable
1198
should have been deprecated with. This is the same type as the
1199
parameter to deprecated_method/deprecated_function. If the
1200
callable is not deprecated with this format, an assertion error
1202
:param a_callable: A callable to call. This may be a bound method or
1203
a regular function. It will be called with ``*args`` and
1205
:param args: The positional arguments for the callable
1206
:param kwargs: The keyword arguments for the callable
1207
:return: The result of a_callable(``*args``, ``**kwargs``)
1209
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1211
expected_first_warning = symbol_versioning.deprecation_string(
1212
a_callable, deprecation_format)
1213
if len(call_warnings) == 0:
1214
self.fail("No deprecation warning generated by call to %s" %
1216
self.assertEqual(expected_first_warning, call_warnings[0])
1219
def callCatchWarnings(self, fn, *args, **kw):
1220
"""Call a callable that raises python warnings.
1222
The caller's responsible for examining the returned warnings.
1224
If the callable raises an exception, the exception is not
1225
caught and propagates up to the caller. In that case, the list
1226
of warnings is not available.
1228
:returns: ([warning_object, ...], fn_result)
1230
# XXX: This is not perfect, because it completely overrides the
1231
# warnings filters, and some code may depend on suppressing particular
1232
# warnings. It's the easiest way to insulate ourselves from -Werror,
1233
# though. -- Andrew, 20071062
1235
def _catcher(message, category, filename, lineno, file=None, line=None):
1236
# despite the name, 'message' is normally(?) a Warning subclass
1238
wlist.append(message)
1239
saved_showwarning = warnings.showwarning
1240
saved_filters = warnings.filters
1242
warnings.showwarning = _catcher
1243
warnings.filters = []
1244
result = fn(*args, **kw)
1246
warnings.showwarning = saved_showwarning
1247
warnings.filters = saved_filters
1248
return wlist, result
1250
def callDeprecated(self, expected, callable, *args, **kwargs):
1251
"""Assert that a callable is deprecated in a particular way.
1253
This is a very precise test for unusual requirements. The
1254
applyDeprecated helper function is probably more suited for most tests
1255
as it allows you to simply specify the deprecation format being used
1256
and will ensure that that is issued for the function being called.
1258
Note that this only captures warnings raised by symbol_versioning.warn,
1259
not other callers that go direct to the warning module. To catch
1260
general warnings, use callCatchWarnings.
1262
:param expected: a list of the deprecation warnings expected, in order
1263
:param callable: The callable to call
1264
:param args: The positional arguments for the callable
1265
:param kwargs: The keyword arguments for the callable
1267
call_warnings, result = self._capture_deprecation_warnings(callable,
1269
self.assertEqual(expected, call_warnings)
1272
def _startLogFile(self):
1273
"""Send bzr and test log messages to a temporary file.
1275
The file is removed as the test is torn down.
1277
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1278
self._log_file = os.fdopen(fileno, 'w+')
1279
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1280
self._log_file_name = name
1281
self.addCleanup(self._finishLogFile)
1283
def _finishLogFile(self):
1284
"""Finished with the log file.
1286
Close the file and delete it, unless setKeepLogfile was called.
1288
if self._log_file is None:
1290
bzrlib.trace.pop_log_file(self._log_memento)
1291
self._log_file.close()
1292
self._log_file = None
1293
if not self._keep_log_file:
1294
os.remove(self._log_file_name)
1295
self._log_file_name = None
1297
def setKeepLogfile(self):
1298
"""Make the logfile not be deleted when _finishLogFile is called."""
1299
self._keep_log_file = True
1301
def addCleanup(self, callable, *args, **kwargs):
1302
"""Arrange to run a callable when this case is torn down.
1304
Callables are run in the reverse of the order they are registered,
1305
ie last-in first-out.
1307
self._cleanups.append((callable, args, kwargs))
1309
def _cleanEnvironment(self):
1311
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1312
'HOME': os.getcwd(),
1313
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1314
# tests do check our impls match APPDATA
1315
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1319
'BZREMAIL': None, # may still be present in the environment
1321
'BZR_PROGRESS_BAR': None,
1323
'BZR_PLUGIN_PATH': None,
1324
# Make sure that any text ui tests are consistent regardless of
1325
# the environment the test case is run in; you may want tests that
1326
# test other combinations. 'dumb' is a reasonable guess for tests
1327
# going to a pipe or a StringIO.
1332
'SSH_AUTH_SOCK': None,
1336
'https_proxy': None,
1337
'HTTPS_PROXY': None,
1342
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1343
# least. If you do (care), please update this comment
1347
'BZR_REMOTE_PATH': None,
1350
self.addCleanup(self._restoreEnvironment)
1351
for name, value in new_env.iteritems():
1352
self._captureVar(name, value)
1354
def _captureVar(self, name, newvalue):
1355
"""Set an environment variable, and reset it when finished."""
1356
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1358
def _restore_debug_flags(self):
1359
debug.debug_flags.clear()
1360
debug.debug_flags.update(self._preserved_debug_flags)
1362
def _restoreEnvironment(self):
1363
for name, value in self.__old_env.iteritems():
1364
osutils.set_or_unset_env(name, value)
1366
def _restoreHooks(self):
1367
for klass, (name, hooks) in self._preserved_hooks.items():
1368
setattr(klass, name, hooks)
1370
def knownFailure(self, reason):
1371
"""This test has failed for some known reason."""
1372
raise KnownFailure(reason)
1374
def _do_skip(self, result, reason):
1375
addSkip = getattr(result, 'addSkip', None)
1376
if not callable(addSkip):
1377
result.addError(self, sys.exc_info())
1379
addSkip(self, reason)
1381
def run(self, result=None):
1382
if result is None: result = self.defaultTestResult()
1383
for feature in getattr(self, '_test_needs_features', []):
1384
if not feature.available():
1385
result.startTest(self)
1386
if getattr(result, 'addNotSupported', None):
1387
result.addNotSupported(self, feature)
1389
result.addSuccess(self)
1390
result.stopTest(self)
1394
result.startTest(self)
1395
absent_attr = object()
1397
method_name = getattr(self, '_testMethodName', absent_attr)
1398
if method_name is absent_attr:
1400
method_name = getattr(self, '_TestCase__testMethodName')
1401
testMethod = getattr(self, method_name)
1405
if not self._bzr_test_setUp_run:
1407
"test setUp did not invoke "
1408
"bzrlib.tests.TestCase's setUp")
1409
except KeyboardInterrupt:
1412
except TestSkipped, e:
1413
self._do_skip(result, e.args[0])
1417
result.addError(self, sys.exc_info())
1425
except self.failureException:
1426
result.addFailure(self, sys.exc_info())
1427
except TestSkipped, e:
1429
reason = "No reason given."
1432
self._do_skip(result, reason)
1433
except KeyboardInterrupt:
1437
result.addError(self, sys.exc_info())
1441
if not self._bzr_test_tearDown_run:
1443
"test tearDown did not invoke "
1444
"bzrlib.tests.TestCase's tearDown")
1445
except KeyboardInterrupt:
1449
result.addError(self, sys.exc_info())
1452
if ok: result.addSuccess(self)
1454
result.stopTest(self)
1456
except TestNotApplicable:
1457
# Not moved from the result [yet].
1460
except KeyboardInterrupt:
1465
for attr_name in self.attrs_to_keep:
1466
if attr_name in self.__dict__:
1467
saved_attrs[attr_name] = self.__dict__[attr_name]
1468
self.__dict__ = saved_attrs
1472
self._log_contents = ''
1473
self._bzr_test_tearDown_run = True
1474
unittest.TestCase.tearDown(self)
1476
def time(self, callable, *args, **kwargs):
1477
"""Run callable and accrue the time it takes to the benchmark time.
1479
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1480
this will cause lsprofile statistics to be gathered and stored in
1483
if self._benchtime is None:
1487
if not self._gather_lsprof_in_benchmarks:
1488
return callable(*args, **kwargs)
1490
# record this benchmark
1491
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1493
self._benchcalls.append(((callable, args, kwargs), stats))
1496
self._benchtime += time.time() - start
1498
def _runCleanups(self):
1499
"""Run registered cleanup functions.
1501
This should only be called from TestCase.tearDown.
1503
# TODO: Perhaps this should keep running cleanups even if
1504
# one of them fails?
1506
# Actually pop the cleanups from the list so tearDown running
1507
# twice is safe (this happens for skipped tests).
1508
while self._cleanups:
1509
cleanup, args, kwargs = self._cleanups.pop()
1510
cleanup(*args, **kwargs)
1512
def log(self, *args):
1515
def _get_log(self, keep_log_file=False):
1516
"""Get the log from bzrlib.trace calls from this test.
1518
:param keep_log_file: When True, if the log is still a file on disk
1519
leave it as a file on disk. When False, if the log is still a file
1520
on disk, the log file is deleted and the log preserved as
1522
:return: A string containing the log.
1524
# flush the log file, to get all content
1526
if bzrlib.trace._trace_file:
1527
bzrlib.trace._trace_file.flush()
1528
if self._log_contents:
1529
# XXX: this can hardly contain the content flushed above --vila
1531
return self._log_contents
1532
if self._log_file_name is not None:
1533
logfile = open(self._log_file_name)
1535
log_contents = logfile.read()
1538
if not keep_log_file:
1539
self._log_contents = log_contents
1541
os.remove(self._log_file_name)
1543
if sys.platform == 'win32' and e.errno == errno.EACCES:
1544
sys.stderr.write(('Unable to delete log file '
1545
' %r\n' % self._log_file_name))
1550
return "DELETED log file to reduce memory footprint"
1552
def requireFeature(self, feature):
1553
"""This test requires a specific feature is available.
1555
:raises UnavailableFeature: When feature is not available.
1557
if not feature.available():
1558
raise UnavailableFeature(feature)
1560
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1562
"""Run bazaar command line, splitting up a string command line."""
1563
if isinstance(args, basestring):
1564
# shlex don't understand unicode strings,
1565
# so args should be plain string (bialix 20070906)
1566
args = list(shlex.split(str(args)))
1567
return self._run_bzr_core(args, retcode=retcode,
1568
encoding=encoding, stdin=stdin, working_dir=working_dir,
1571
def _run_bzr_core(self, args, retcode, encoding, stdin,
1573
if encoding is None:
1574
encoding = osutils.get_user_encoding()
1575
stdout = StringIOWrapper()
1576
stderr = StringIOWrapper()
1577
stdout.encoding = encoding
1578
stderr.encoding = encoding
1580
self.log('run bzr: %r', args)
1581
# FIXME: don't call into logging here
1582
handler = logging.StreamHandler(stderr)
1583
handler.setLevel(logging.INFO)
1584
logger = logging.getLogger('')
1585
logger.addHandler(handler)
1586
old_ui_factory = ui.ui_factory
1587
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1590
if working_dir is not None:
1591
cwd = osutils.getcwd()
1592
os.chdir(working_dir)
1595
result = self.apply_redirected(ui.ui_factory.stdin,
1597
bzrlib.commands.run_bzr_catch_user_errors,
1600
logger.removeHandler(handler)
1601
ui.ui_factory = old_ui_factory
1605
out = stdout.getvalue()
1606
err = stderr.getvalue()
1608
self.log('output:\n%r', out)
1610
self.log('errors:\n%r', err)
1611
if retcode is not None:
1612
self.assertEquals(retcode, result,
1613
message='Unexpected return code')
1616
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1617
working_dir=None, error_regexes=[], output_encoding=None):
1618
"""Invoke bzr, as if it were run from the command line.
1620
The argument list should not include the bzr program name - the
1621
first argument is normally the bzr command. Arguments may be
1622
passed in three ways:
1624
1- A list of strings, eg ["commit", "a"]. This is recommended
1625
when the command contains whitespace or metacharacters, or
1626
is built up at run time.
1628
2- A single string, eg "add a". This is the most convenient
1629
for hardcoded commands.
1631
This runs bzr through the interface that catches and reports
1632
errors, and with logging set to something approximating the
1633
default, so that error reporting can be checked.
1635
This should be the main method for tests that want to exercise the
1636
overall behavior of the bzr application (rather than a unit test
1637
or a functional test of the library.)
1639
This sends the stdout/stderr results into the test's log,
1640
where it may be useful for debugging. See also run_captured.
1642
:keyword stdin: A string to be used as stdin for the command.
1643
:keyword retcode: The status code the command should return;
1645
:keyword working_dir: The directory to run the command in
1646
:keyword error_regexes: A list of expected error messages. If
1647
specified they must be seen in the error output of the command.
1649
out, err = self._run_bzr_autosplit(
1654
working_dir=working_dir,
1656
self.assertIsInstance(error_regexes, (list, tuple))
1657
for regex in error_regexes:
1658
self.assertContainsRe(err, regex)
1661
def run_bzr_error(self, error_regexes, *args, **kwargs):
1662
"""Run bzr, and check that stderr contains the supplied regexes
1664
:param error_regexes: Sequence of regular expressions which
1665
must each be found in the error output. The relative ordering
1667
:param args: command-line arguments for bzr
1668
:param kwargs: Keyword arguments which are interpreted by run_bzr
1669
This function changes the default value of retcode to be 3,
1670
since in most cases this is run when you expect bzr to fail.
1672
:return: (out, err) The actual output of running the command (in case
1673
you want to do more inspection)
1677
# Make sure that commit is failing because there is nothing to do
1678
self.run_bzr_error(['no changes to commit'],
1679
['commit', '-m', 'my commit comment'])
1680
# Make sure --strict is handling an unknown file, rather than
1681
# giving us the 'nothing to do' error
1682
self.build_tree(['unknown'])
1683
self.run_bzr_error(['Commit refused because there are unknown files'],
1684
['commit', --strict', '-m', 'my commit comment'])
1686
kwargs.setdefault('retcode', 3)
1687
kwargs['error_regexes'] = error_regexes
1688
out, err = self.run_bzr(*args, **kwargs)
1691
def run_bzr_subprocess(self, *args, **kwargs):
1692
"""Run bzr in a subprocess for testing.
1694
This starts a new Python interpreter and runs bzr in there.
1695
This should only be used for tests that have a justifiable need for
1696
this isolation: e.g. they are testing startup time, or signal
1697
handling, or early startup code, etc. Subprocess code can't be
1698
profiled or debugged so easily.
1700
:keyword retcode: The status code that is expected. Defaults to 0. If
1701
None is supplied, the status code is not checked.
1702
:keyword env_changes: A dictionary which lists changes to environment
1703
variables. A value of None will unset the env variable.
1704
The values must be strings. The change will only occur in the
1705
child, so you don't need to fix the environment after running.
1706
:keyword universal_newlines: Convert CRLF => LF
1707
:keyword allow_plugins: By default the subprocess is run with
1708
--no-plugins to ensure test reproducibility. Also, it is possible
1709
for system-wide plugins to create unexpected output on stderr,
1710
which can cause unnecessary test failures.
1712
env_changes = kwargs.get('env_changes', {})
1713
working_dir = kwargs.get('working_dir', None)
1714
allow_plugins = kwargs.get('allow_plugins', False)
1716
if isinstance(args[0], list):
1718
elif isinstance(args[0], basestring):
1719
args = list(shlex.split(args[0]))
1721
raise ValueError("passing varargs to run_bzr_subprocess")
1722
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1723
working_dir=working_dir,
1724
allow_plugins=allow_plugins)
1725
# We distinguish between retcode=None and retcode not passed.
1726
supplied_retcode = kwargs.get('retcode', 0)
1727
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1728
universal_newlines=kwargs.get('universal_newlines', False),
1731
def start_bzr_subprocess(self, process_args, env_changes=None,
1732
skip_if_plan_to_signal=False,
1734
allow_plugins=False):
1735
"""Start bzr in a subprocess for testing.
1737
This starts a new Python interpreter and runs bzr in there.
1738
This should only be used for tests that have a justifiable need for
1739
this isolation: e.g. they are testing startup time, or signal
1740
handling, or early startup code, etc. Subprocess code can't be
1741
profiled or debugged so easily.
1743
:param process_args: a list of arguments to pass to the bzr executable,
1744
for example ``['--version']``.
1745
:param env_changes: A dictionary which lists changes to environment
1746
variables. A value of None will unset the env variable.
1747
The values must be strings. The change will only occur in the
1748
child, so you don't need to fix the environment after running.
1749
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1751
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1753
:returns: Popen object for the started process.
1755
if skip_if_plan_to_signal:
1756
if not getattr(os, 'kill', None):
1757
raise TestSkipped("os.kill not available.")
1759
if env_changes is None:
1763
def cleanup_environment():
1764
for env_var, value in env_changes.iteritems():
1765
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1767
def restore_environment():
1768
for env_var, value in old_env.iteritems():
1769
osutils.set_or_unset_env(env_var, value)
1771
bzr_path = self.get_bzr_path()
1774
if working_dir is not None:
1775
cwd = osutils.getcwd()
1776
os.chdir(working_dir)
1779
# win32 subprocess doesn't support preexec_fn
1780
# so we will avoid using it on all platforms, just to
1781
# make sure the code path is used, and we don't break on win32
1782
cleanup_environment()
1783
command = [sys.executable]
1784
# frozen executables don't need the path to bzr
1785
if getattr(sys, "frozen", None) is None:
1786
command.append(bzr_path)
1787
if not allow_plugins:
1788
command.append('--no-plugins')
1789
command.extend(process_args)
1790
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1792
restore_environment()
1798
def _popen(self, *args, **kwargs):
1799
"""Place a call to Popen.
1801
Allows tests to override this method to intercept the calls made to
1802
Popen for introspection.
1804
return Popen(*args, **kwargs)
1806
def get_bzr_path(self):
1807
"""Return the path of the 'bzr' executable for this test suite."""
1808
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1809
if not os.path.isfile(bzr_path):
1810
# We are probably installed. Assume sys.argv is the right file
1811
bzr_path = sys.argv[0]
1814
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1815
universal_newlines=False, process_args=None):
1816
"""Finish the execution of process.
1818
:param process: the Popen object returned from start_bzr_subprocess.
1819
:param retcode: The status code that is expected. Defaults to 0. If
1820
None is supplied, the status code is not checked.
1821
:param send_signal: an optional signal to send to the process.
1822
:param universal_newlines: Convert CRLF => LF
1823
:returns: (stdout, stderr)
1825
if send_signal is not None:
1826
os.kill(process.pid, send_signal)
1827
out, err = process.communicate()
1829
if universal_newlines:
1830
out = out.replace('\r\n', '\n')
1831
err = err.replace('\r\n', '\n')
1833
if retcode is not None and retcode != process.returncode:
1834
if process_args is None:
1835
process_args = "(unknown args)"
1836
mutter('Output of bzr %s:\n%s', process_args, out)
1837
mutter('Error for bzr %s:\n%s', process_args, err)
1838
self.fail('Command bzr %s failed with retcode %s != %s'
1839
% (process_args, retcode, process.returncode))
1842
def check_inventory_shape(self, inv, shape):
1843
"""Compare an inventory to a list of expected names.
1845
Fail if they are not precisely equal.
1848
shape = list(shape) # copy
1849
for path, ie in inv.entries():
1850
name = path.replace('\\', '/')
1851
if ie.kind == 'directory':
1858
self.fail("expected paths not found in inventory: %r" % shape)
1860
self.fail("unexpected paths found in inventory: %r" % extras)
1862
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1863
a_callable=None, *args, **kwargs):
1864
"""Call callable with redirected std io pipes.
1866
Returns the return code."""
1867
if not callable(a_callable):
1868
raise ValueError("a_callable must be callable.")
1870
stdin = StringIO("")
1872
if getattr(self, "_log_file", None) is not None:
1873
stdout = self._log_file
1877
if getattr(self, "_log_file", None is not None):
1878
stderr = self._log_file
1881
real_stdin = sys.stdin
1882
real_stdout = sys.stdout
1883
real_stderr = sys.stderr
1888
return a_callable(*args, **kwargs)
1890
sys.stdout = real_stdout
1891
sys.stderr = real_stderr
1892
sys.stdin = real_stdin
1894
def reduceLockdirTimeout(self):
1895
"""Reduce the default lock timeout for the duration of the test, so that
1896
if LockContention occurs during a test, it does so quickly.
1898
Tests that expect to provoke LockContention errors should call this.
1900
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1902
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1903
self.addCleanup(resetTimeout)
1904
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1906
def make_utf8_encoded_stringio(self, encoding_type=None):
1907
"""Return a StringIOWrapper instance, that will encode Unicode
1910
if encoding_type is None:
1911
encoding_type = 'strict'
1913
output_encoding = 'utf-8'
1914
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1915
sio.encoding = output_encoding
1919
class CapturedCall(object):
1920
"""A helper for capturing smart server calls for easy debug analysis."""
1922
def __init__(self, params, prefix_length):
1923
"""Capture the call with params and skip prefix_length stack frames."""
1926
# The last 5 frames are the __init__, the hook frame, and 3 smart
1927
# client frames. Beyond this we could get more clever, but this is good
1929
stack = traceback.extract_stack()[prefix_length:-5]
1930
self.stack = ''.join(traceback.format_list(stack))
1933
return self.call.method
1936
return self.call.method
1942
class TestCaseWithMemoryTransport(TestCase):
1943
"""Common test class for tests that do not need disk resources.
1945
Tests that need disk resources should derive from TestCaseWithTransport.
1947
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1949
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1950
a directory which does not exist. This serves to help ensure test isolation
1951
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1952
must exist. However, TestCaseWithMemoryTransport does not offer local
1953
file defaults for the transport in tests, nor does it obey the command line
1954
override, so tests that accidentally write to the common directory should
1957
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1958
a .bzr directory that stops us ascending higher into the filesystem.
1964
def __init__(self, methodName='runTest'):
1965
# allow test parameterization after test construction and before test
1966
# execution. Variables that the parameterizer sets need to be
1967
# ones that are not set by setUp, or setUp will trash them.
1968
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1969
self.vfs_transport_factory = default_transport
1970
self.transport_server = None
1971
self.transport_readonly_server = None
1972
self.__vfs_server = None
1974
def get_transport(self, relpath=None):
1975
"""Return a writeable transport.
1977
This transport is for the test scratch space relative to
1980
:param relpath: a path relative to the base url.
1982
t = get_transport(self.get_url(relpath))
1983
self.assertFalse(t.is_readonly())
1986
def get_readonly_transport(self, relpath=None):
1987
"""Return a readonly transport for the test scratch space
1989
This can be used to test that operations which should only need
1990
readonly access in fact do not try to write.
1992
:param relpath: a path relative to the base url.
1994
t = get_transport(self.get_readonly_url(relpath))
1995
self.assertTrue(t.is_readonly())
1998
def create_transport_readonly_server(self):
1999
"""Create a transport server from class defined at init.
2001
This is mostly a hook for daughter classes.
2003
return self.transport_readonly_server()
2005
def get_readonly_server(self):
2006
"""Get the server instance for the readonly transport
2008
This is useful for some tests with specific servers to do diagnostics.
2010
if self.__readonly_server is None:
2011
if self.transport_readonly_server is None:
2012
# readonly decorator requested
2013
# bring up the server
2014
self.__readonly_server = ReadonlyServer()
2015
self.__readonly_server.setUp(self.get_vfs_only_server())
2017
self.__readonly_server = self.create_transport_readonly_server()
2018
self.__readonly_server.setUp(self.get_vfs_only_server())
2019
self.addCleanup(self.__readonly_server.tearDown)
2020
return self.__readonly_server
2022
def get_readonly_url(self, relpath=None):
2023
"""Get a URL for the readonly transport.
2025
This will either be backed by '.' or a decorator to the transport
2026
used by self.get_url()
2027
relpath provides for clients to get a path relative to the base url.
2028
These should only be downwards relative, not upwards.
2030
base = self.get_readonly_server().get_url()
2031
return self._adjust_url(base, relpath)
2033
def get_vfs_only_server(self):
2034
"""Get the vfs only read/write server instance.
2036
This is useful for some tests with specific servers that need
2039
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2040
is no means to override it.
2042
if self.__vfs_server is None:
2043
self.__vfs_server = MemoryServer()
2044
self.__vfs_server.setUp()
2045
self.addCleanup(self.__vfs_server.tearDown)
2046
return self.__vfs_server
2048
def get_server(self):
2049
"""Get the read/write server instance.
2051
This is useful for some tests with specific servers that need
2054
This is built from the self.transport_server factory. If that is None,
2055
then the self.get_vfs_server is returned.
2057
if self.__server is None:
2058
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
2059
return self.get_vfs_only_server()
2061
# bring up a decorated means of access to the vfs only server.
2062
self.__server = self.transport_server()
2064
self.__server.setUp(self.get_vfs_only_server())
2065
except TypeError, e:
2066
# This should never happen; the try:Except here is to assist
2067
# developers having to update code rather than seeing an
2068
# uninformative TypeError.
2069
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2070
self.addCleanup(self.__server.tearDown)
2071
return self.__server
2073
def _adjust_url(self, base, relpath):
2074
"""Get a URL (or maybe a path) for the readwrite transport.
2076
This will either be backed by '.' or to an equivalent non-file based
2078
relpath provides for clients to get a path relative to the base url.
2079
These should only be downwards relative, not upwards.
2081
if relpath is not None and relpath != '.':
2082
if not base.endswith('/'):
2084
# XXX: Really base should be a url; we did after all call
2085
# get_url()! But sometimes it's just a path (from
2086
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2087
# to a non-escaped local path.
2088
if base.startswith('./') or base.startswith('/'):
2091
base += urlutils.escape(relpath)
2094
def get_url(self, relpath=None):
2095
"""Get a URL (or maybe a path) for the readwrite transport.
2097
This will either be backed by '.' or to an equivalent non-file based
2099
relpath provides for clients to get a path relative to the base url.
2100
These should only be downwards relative, not upwards.
2102
base = self.get_server().get_url()
2103
return self._adjust_url(base, relpath)
2105
def get_vfs_only_url(self, relpath=None):
2106
"""Get a URL (or maybe a path for the plain old vfs transport.
2108
This will never be a smart protocol. It always has all the
2109
capabilities of the local filesystem, but it might actually be a
2110
MemoryTransport or some other similar virtual filesystem.
2112
This is the backing transport (if any) of the server returned by
2113
get_url and get_readonly_url.
2115
:param relpath: provides for clients to get a path relative to the base
2116
url. These should only be downwards relative, not upwards.
2119
base = self.get_vfs_only_server().get_url()
2120
return self._adjust_url(base, relpath)
2122
def _create_safety_net(self):
2123
"""Make a fake bzr directory.
2125
This prevents any tests propagating up onto the TEST_ROOT directory's
2128
root = TestCaseWithMemoryTransport.TEST_ROOT
2129
bzrdir.BzrDir.create_standalone_workingtree(root)
2131
def _check_safety_net(self):
2132
"""Check that the safety .bzr directory have not been touched.
2134
_make_test_root have created a .bzr directory to prevent tests from
2135
propagating. This method ensures than a test did not leaked.
2137
root = TestCaseWithMemoryTransport.TEST_ROOT
2138
wt = workingtree.WorkingTree.open(root)
2139
last_rev = wt.last_revision()
2140
if last_rev != 'null:':
2141
# The current test have modified the /bzr directory, we need to
2142
# recreate a new one or all the followng tests will fail.
2143
# If you need to inspect its content uncomment the following line
2144
# import pdb; pdb.set_trace()
2145
_rmtree_temp_dir(root + '/.bzr')
2146
self._create_safety_net()
2147
raise AssertionError('%s/.bzr should not be modified' % root)
2149
def _make_test_root(self):
2150
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2151
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2152
TestCaseWithMemoryTransport.TEST_ROOT = root
2154
self._create_safety_net()
2156
# The same directory is used by all tests, and we're not
2157
# specifically told when all tests are finished. This will do.
2158
atexit.register(_rmtree_temp_dir, root)
2160
self.addCleanup(self._check_safety_net)
2162
def makeAndChdirToTestDir(self):
2163
"""Create a temporary directories for this one test.
2165
This must set self.test_home_dir and self.test_dir and chdir to
2168
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2170
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2171
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2172
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2174
def make_branch(self, relpath, format=None):
2175
"""Create a branch on the transport at relpath."""
2176
repo = self.make_repository(relpath, format=format)
2177
return repo.bzrdir.create_branch()
2179
def make_bzrdir(self, relpath, format=None):
2181
# might be a relative or absolute path
2182
maybe_a_url = self.get_url(relpath)
2183
segments = maybe_a_url.rsplit('/', 1)
2184
t = get_transport(maybe_a_url)
2185
if len(segments) > 1 and segments[-1] not in ('', '.'):
2189
if isinstance(format, basestring):
2190
format = bzrdir.format_registry.make_bzrdir(format)
2191
return format.initialize_on_transport(t)
2192
except errors.UninitializableFormat:
2193
raise TestSkipped("Format %s is not initializable." % format)
2195
def make_repository(self, relpath, shared=False, format=None):
2196
"""Create a repository on our default transport at relpath.
2198
Note that relpath must be a relative path, not a full url.
2200
# FIXME: If you create a remoterepository this returns the underlying
2201
# real format, which is incorrect. Actually we should make sure that
2202
# RemoteBzrDir returns a RemoteRepository.
2203
# maybe mbp 20070410
2204
made_control = self.make_bzrdir(relpath, format=format)
2205
return made_control.create_repository(shared=shared)
2207
def make_smart_server(self, path):
2208
smart_server = server.SmartTCPServer_for_testing()
2209
smart_server.setUp(self.get_server())
2210
remote_transport = get_transport(smart_server.get_url()).clone(path)
2211
self.addCleanup(smart_server.tearDown)
2212
return remote_transport
2214
def make_branch_and_memory_tree(self, relpath, format=None):
2215
"""Create a branch on the default transport and a MemoryTree for it."""
2216
b = self.make_branch(relpath, format=format)
2217
return memorytree.MemoryTree.create_on_branch(b)
2219
def make_branch_builder(self, relpath, format=None):
2220
branch = self.make_branch(relpath, format=format)
2221
return branchbuilder.BranchBuilder(branch=branch)
2223
def overrideEnvironmentForTesting(self):
2224
os.environ['HOME'] = self.test_home_dir
2225
os.environ['BZR_HOME'] = self.test_home_dir
2228
super(TestCaseWithMemoryTransport, self).setUp()
2229
self._make_test_root()
2230
_currentdir = os.getcwdu()
2231
def _leaveDirectory():
2232
os.chdir(_currentdir)
2233
self.addCleanup(_leaveDirectory)
2234
self.makeAndChdirToTestDir()
2235
self.overrideEnvironmentForTesting()
2236
self.__readonly_server = None
2237
self.__server = None
2238
self.reduceLockdirTimeout()
2240
def setup_smart_server_with_call_log(self):
2241
"""Sets up a smart server as the transport server with a call log."""
2242
self.transport_server = server.SmartTCPServer_for_testing
2243
self.hpss_calls = []
2245
# Skip the current stack down to the caller of
2246
# setup_smart_server_with_call_log
2247
prefix_length = len(traceback.extract_stack()) - 2
2248
def capture_hpss_call(params):
2249
self.hpss_calls.append(
2250
CapturedCall(params, prefix_length))
2251
client._SmartClient.hooks.install_named_hook(
2252
'call', capture_hpss_call, None)
2254
def reset_smart_call_log(self):
2255
self.hpss_calls = []
2258
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2259
"""Derived class that runs a test within a temporary directory.
2261
This is useful for tests that need to create a branch, etc.
2263
The directory is created in a slightly complex way: for each
2264
Python invocation, a new temporary top-level directory is created.
2265
All test cases create their own directory within that. If the
2266
tests complete successfully, the directory is removed.
2268
:ivar test_base_dir: The path of the top-level directory for this
2269
test, which contains a home directory and a work directory.
2271
:ivar test_home_dir: An initially empty directory under test_base_dir
2272
which is used as $HOME for this test.
2274
:ivar test_dir: A directory under test_base_dir used as the current
2275
directory when the test proper is run.
2278
OVERRIDE_PYTHON = 'python'
2280
def check_file_contents(self, filename, expect):
2281
self.log("check contents of file %s" % filename)
2282
contents = file(filename, 'r').read()
2283
if contents != expect:
2284
self.log("expected: %r" % expect)
2285
self.log("actually: %r" % contents)
2286
self.fail("contents of %s not as expected" % filename)
2288
def _getTestDirPrefix(self):
2289
# create a directory within the top level test directory
2290
if sys.platform == 'win32':
2291
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2292
# windows is likely to have path-length limits so use a short name
2293
name_prefix = name_prefix[-30:]
2295
name_prefix = re.sub('[/]', '_', self.id())
2298
def makeAndChdirToTestDir(self):
2299
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2301
For TestCaseInTempDir we create a temporary directory based on the test
2302
name and then create two subdirs - test and home under it.
2304
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2305
self._getTestDirPrefix())
2307
for i in range(100):
2308
if os.path.exists(name):
2309
name = name_prefix + '_' + str(i)
2313
# now create test and home directories within this dir
2314
self.test_base_dir = name
2315
self.test_home_dir = self.test_base_dir + '/home'
2316
os.mkdir(self.test_home_dir)
2317
self.test_dir = self.test_base_dir + '/work'
2318
os.mkdir(self.test_dir)
2319
os.chdir(self.test_dir)
2320
# put name of test inside
2321
f = file(self.test_base_dir + '/name', 'w')
2326
self.addCleanup(self.deleteTestDir)
2328
def deleteTestDir(self):
2329
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2330
_rmtree_temp_dir(self.test_base_dir)
2332
def build_tree(self, shape, line_endings='binary', transport=None):
2333
"""Build a test tree according to a pattern.
2335
shape is a sequence of file specifications. If the final
2336
character is '/', a directory is created.
2338
This assumes that all the elements in the tree being built are new.
2340
This doesn't add anything to a branch.
2342
:type shape: list or tuple.
2343
:param line_endings: Either 'binary' or 'native'
2344
in binary mode, exact contents are written in native mode, the
2345
line endings match the default platform endings.
2346
:param transport: A transport to write to, for building trees on VFS's.
2347
If the transport is readonly or None, "." is opened automatically.
2350
if type(shape) not in (list, tuple):
2351
raise AssertionError("Parameter 'shape' should be "
2352
"a list or a tuple. Got %r instead" % (shape,))
2353
# It's OK to just create them using forward slashes on windows.
2354
if transport is None or transport.is_readonly():
2355
transport = get_transport(".")
2357
self.assertIsInstance(name, basestring)
2359
transport.mkdir(urlutils.escape(name[:-1]))
2361
if line_endings == 'binary':
2363
elif line_endings == 'native':
2366
raise errors.BzrError(
2367
'Invalid line ending request %r' % line_endings)
2368
content = "contents of %s%s" % (name.encode('utf-8'), end)
2369
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2371
def build_tree_contents(self, shape):
2372
build_tree_contents(shape)
2374
def assertInWorkingTree(self, path, root_path='.', tree=None):
2375
"""Assert whether path or paths are in the WorkingTree"""
2377
tree = workingtree.WorkingTree.open(root_path)
2378
if not isinstance(path, basestring):
2380
self.assertInWorkingTree(p, tree=tree)
2382
self.assertIsNot(tree.path2id(path), None,
2383
path+' not in working tree.')
2385
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2386
"""Assert whether path or paths are not in the WorkingTree"""
2388
tree = workingtree.WorkingTree.open(root_path)
2389
if not isinstance(path, basestring):
2391
self.assertNotInWorkingTree(p,tree=tree)
2393
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2396
class TestCaseWithTransport(TestCaseInTempDir):
2397
"""A test case that provides get_url and get_readonly_url facilities.
2399
These back onto two transport servers, one for readonly access and one for
2402
If no explicit class is provided for readonly access, a
2403
ReadonlyTransportDecorator is used instead which allows the use of non disk
2404
based read write transports.
2406
If an explicit class is provided for readonly access, that server and the
2407
readwrite one must both define get_url() as resolving to os.getcwd().
2410
def get_vfs_only_server(self):
2411
"""See TestCaseWithMemoryTransport.
2413
This is useful for some tests with specific servers that need
2416
if self.__vfs_server is None:
2417
self.__vfs_server = self.vfs_transport_factory()
2418
self.__vfs_server.setUp()
2419
self.addCleanup(self.__vfs_server.tearDown)
2420
return self.__vfs_server
2422
def make_branch_and_tree(self, relpath, format=None):
2423
"""Create a branch on the transport and a tree locally.
2425
If the transport is not a LocalTransport, the Tree can't be created on
2426
the transport. In that case if the vfs_transport_factory is
2427
LocalURLServer the working tree is created in the local
2428
directory backing the transport, and the returned tree's branch and
2429
repository will also be accessed locally. Otherwise a lightweight
2430
checkout is created and returned.
2432
:param format: The BzrDirFormat.
2433
:returns: the WorkingTree.
2435
# TODO: always use the local disk path for the working tree,
2436
# this obviously requires a format that supports branch references
2437
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2439
b = self.make_branch(relpath, format=format)
2441
return b.bzrdir.create_workingtree()
2442
except errors.NotLocalUrl:
2443
# We can only make working trees locally at the moment. If the
2444
# transport can't support them, then we keep the non-disk-backed
2445
# branch and create a local checkout.
2446
if self.vfs_transport_factory is LocalURLServer:
2447
# the branch is colocated on disk, we cannot create a checkout.
2448
# hopefully callers will expect this.
2449
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2450
wt = local_controldir.create_workingtree()
2451
if wt.branch._format != b._format:
2453
# Make sure that assigning to wt._branch fixes wt.branch,
2454
# in case the implementation details of workingtree objects
2456
self.assertIs(b, wt.branch)
2459
return b.create_checkout(relpath, lightweight=True)
2461
def assertIsDirectory(self, relpath, transport):
2462
"""Assert that relpath within transport is a directory.
2464
This may not be possible on all transports; in that case it propagates
2465
a TransportNotPossible.
2468
mode = transport.stat(relpath).st_mode
2469
except errors.NoSuchFile:
2470
self.fail("path %s is not a directory; no such file"
2472
if not stat.S_ISDIR(mode):
2473
self.fail("path %s is not a directory; has mode %#o"
2476
def assertTreesEqual(self, left, right):
2477
"""Check that left and right have the same content and properties."""
2478
# we use a tree delta to check for equality of the content, and we
2479
# manually check for equality of other things such as the parents list.
2480
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2481
differences = left.changes_from(right)
2482
self.assertFalse(differences.has_changed(),
2483
"Trees %r and %r are different: %r" % (left, right, differences))
2486
super(TestCaseWithTransport, self).setUp()
2487
self.__vfs_server = None
2490
class ChrootedTestCase(TestCaseWithTransport):
2491
"""A support class that provides readonly urls outside the local namespace.
2493
This is done by checking if self.transport_server is a MemoryServer. if it
2494
is then we are chrooted already, if it is not then an HttpServer is used
2497
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2498
be used without needed to redo it when a different
2499
subclass is in use ?
2503
super(ChrootedTestCase, self).setUp()
2504
if not self.vfs_transport_factory == MemoryServer:
2505
self.transport_readonly_server = HttpServer
2508
def condition_id_re(pattern):
2509
"""Create a condition filter which performs a re check on a test's id.
2511
:param pattern: A regular expression string.
2512
:return: A callable that returns True if the re matches.
2514
filter_re = osutils.re_compile_checked(pattern, 0,
2516
def condition(test):
2518
return filter_re.search(test_id)
2522
def condition_isinstance(klass_or_klass_list):
2523
"""Create a condition filter which returns isinstance(param, klass).
2525
:return: A callable which when called with one parameter obj return the
2526
result of isinstance(obj, klass_or_klass_list).
2529
return isinstance(obj, klass_or_klass_list)
2533
def condition_id_in_list(id_list):
2534
"""Create a condition filter which verify that test's id in a list.
2536
:param id_list: A TestIdList object.
2537
:return: A callable that returns True if the test's id appears in the list.
2539
def condition(test):
2540
return id_list.includes(test.id())
2544
def condition_id_startswith(starts):
2545
"""Create a condition filter verifying that test's id starts with a string.
2547
:param starts: A list of string.
2548
:return: A callable that returns True if the test's id starts with one of
2551
def condition(test):
2552
for start in starts:
2553
if test.id().startswith(start):
2559
def exclude_tests_by_condition(suite, condition):
2560
"""Create a test suite which excludes some tests from suite.
2562
:param suite: The suite to get tests from.
2563
:param condition: A callable whose result evaluates True when called with a
2564
test case which should be excluded from the result.
2565
:return: A suite which contains the tests found in suite that fail
2569
for test in iter_suite_tests(suite):
2570
if not condition(test):
2572
return TestUtil.TestSuite(result)
2575
def filter_suite_by_condition(suite, condition):
2576
"""Create a test suite by filtering another one.
2578
:param suite: The source suite.
2579
:param condition: A callable whose result evaluates True when called with a
2580
test case which should be included in the result.
2581
:return: A suite which contains the tests found in suite that pass
2585
for test in iter_suite_tests(suite):
2588
return TestUtil.TestSuite(result)
2591
def filter_suite_by_re(suite, pattern):
2592
"""Create a test suite by filtering another one.
2594
:param suite: the source suite
2595
:param pattern: pattern that names must match
2596
:returns: the newly created suite
2598
condition = condition_id_re(pattern)
2599
result_suite = filter_suite_by_condition(suite, condition)
2603
def filter_suite_by_id_list(suite, test_id_list):
2604
"""Create a test suite by filtering another one.
2606
:param suite: The source suite.
2607
:param test_id_list: A list of the test ids to keep as strings.
2608
:returns: the newly created suite
2610
condition = condition_id_in_list(test_id_list)
2611
result_suite = filter_suite_by_condition(suite, condition)
2615
def filter_suite_by_id_startswith(suite, start):
2616
"""Create a test suite by filtering another one.
2618
:param suite: The source suite.
2619
:param start: A list of string the test id must start with one of.
2620
:returns: the newly created suite
2622
condition = condition_id_startswith(start)
2623
result_suite = filter_suite_by_condition(suite, condition)
2627
def exclude_tests_by_re(suite, pattern):
2628
"""Create a test suite which excludes some tests from suite.
2630
:param suite: The suite to get tests from.
2631
:param pattern: A regular expression string. Test ids that match this
2632
pattern will be excluded from the result.
2633
:return: A TestSuite that contains all the tests from suite without the
2634
tests that matched pattern. The order of tests is the same as it was in
2637
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2640
def preserve_input(something):
2641
"""A helper for performing test suite transformation chains.
2643
:param something: Anything you want to preserve.
2649
def randomize_suite(suite):
2650
"""Return a new TestSuite with suite's tests in random order.
2652
The tests in the input suite are flattened into a single suite in order to
2653
accomplish this. Any nested TestSuites are removed to provide global
2656
tests = list(iter_suite_tests(suite))
2657
random.shuffle(tests)
2658
return TestUtil.TestSuite(tests)
2661
def split_suite_by_condition(suite, condition):
2662
"""Split a test suite into two by a condition.
2664
:param suite: The suite to split.
2665
:param condition: The condition to match on. Tests that match this
2666
condition are returned in the first test suite, ones that do not match
2667
are in the second suite.
2668
:return: A tuple of two test suites, where the first contains tests from
2669
suite matching the condition, and the second contains the remainder
2670
from suite. The order within each output suite is the same as it was in
2675
for test in iter_suite_tests(suite):
2677
matched.append(test)
2679
did_not_match.append(test)
2680
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2683
def split_suite_by_re(suite, pattern):
2684
"""Split a test suite into two by a regular expression.
2686
:param suite: The suite to split.
2687
:param pattern: A regular expression string. Test ids that match this
2688
pattern will be in the first test suite returned, and the others in the
2689
second test suite returned.
2690
:return: A tuple of two test suites, where the first contains tests from
2691
suite matching pattern, and the second contains the remainder from
2692
suite. The order within each output suite is the same as it was in
2695
return split_suite_by_condition(suite, condition_id_re(pattern))
2698
def run_suite(suite, name='test', verbose=False, pattern=".*",
2699
stop_on_failure=False,
2700
transport=None, lsprof_timed=None, bench_history=None,
2701
matching_tests_first=None,
2704
exclude_pattern=None,
2707
suite_decorators=None,
2709
"""Run a test suite for bzr selftest.
2711
:param runner_class: The class of runner to use. Must support the
2712
constructor arguments passed by run_suite which are more than standard
2714
:return: A boolean indicating success.
2716
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2721
if runner_class is None:
2722
runner_class = TextTestRunner
2725
runner = runner_class(stream=stream,
2727
verbosity=verbosity,
2728
bench_history=bench_history,
2729
list_only=list_only,
2732
runner.stop_on_failure=stop_on_failure
2733
# built in decorator factories:
2735
random_order(random_seed, runner),
2736
exclude_tests(exclude_pattern),
2738
if matching_tests_first:
2739
decorators.append(tests_first(pattern))
2741
decorators.append(filter_tests(pattern))
2742
if suite_decorators:
2743
decorators.extend(suite_decorators)
2744
for decorator in decorators:
2745
suite = decorator(suite)
2746
result = runner.run(suite)
2751
return result.wasStrictlySuccessful()
2753
return result.wasSuccessful()
2756
# A registry where get() returns a suite decorator.
2757
parallel_registry = registry.Registry()
2760
def fork_decorator(suite):
2761
concurrency = osutils.local_concurrency()
2762
if concurrency == 1:
2764
from testtools import ConcurrentTestSuite
2765
return ConcurrentTestSuite(suite, fork_for_tests)
2766
parallel_registry.register('fork', fork_decorator)
2769
def subprocess_decorator(suite):
2770
concurrency = osutils.local_concurrency()
2771
if concurrency == 1:
2773
from testtools import ConcurrentTestSuite
2774
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2775
parallel_registry.register('subprocess', subprocess_decorator)
2778
def exclude_tests(exclude_pattern):
2779
"""Return a test suite decorator that excludes tests."""
2780
if exclude_pattern is None:
2781
return identity_decorator
2782
def decorator(suite):
2783
return ExcludeDecorator(suite, exclude_pattern)
2787
def filter_tests(pattern):
2789
return identity_decorator
2790
def decorator(suite):
2791
return FilterTestsDecorator(suite, pattern)
2795
def random_order(random_seed, runner):
2796
"""Return a test suite decorator factory for randomising tests order.
2798
:param random_seed: now, a string which casts to a long, or a long.
2799
:param runner: A test runner with a stream attribute to report on.
2801
if random_seed is None:
2802
return identity_decorator
2803
def decorator(suite):
2804
return RandomDecorator(suite, random_seed, runner.stream)
2808
def tests_first(pattern):
2810
return identity_decorator
2811
def decorator(suite):
2812
return TestFirstDecorator(suite, pattern)
2816
def identity_decorator(suite):
2821
class TestDecorator(TestSuite):
2822
"""A decorator for TestCase/TestSuite objects.
2824
Usually, subclasses should override __iter__(used when flattening test
2825
suites), which we do to filter, reorder, parallelise and so on, run() and
2829
def __init__(self, suite):
2830
TestSuite.__init__(self)
2833
def countTestCases(self):
2836
cases += test.countTestCases()
2843
def run(self, result):
2844
# Use iteration on self, not self._tests, to allow subclasses to hook
2847
if result.shouldStop:
2853
class ExcludeDecorator(TestDecorator):
2854
"""A decorator which excludes test matching an exclude pattern."""
2856
def __init__(self, suite, exclude_pattern):
2857
TestDecorator.__init__(self, suite)
2858
self.exclude_pattern = exclude_pattern
2859
self.excluded = False
2863
return iter(self._tests)
2864
self.excluded = True
2865
suite = exclude_tests_by_re(self, self.exclude_pattern)
2867
self.addTests(suite)
2868
return iter(self._tests)
2871
class FilterTestsDecorator(TestDecorator):
2872
"""A decorator which filters tests to those matching a pattern."""
2874
def __init__(self, suite, pattern):
2875
TestDecorator.__init__(self, suite)
2876
self.pattern = pattern
2877
self.filtered = False
2881
return iter(self._tests)
2882
self.filtered = True
2883
suite = filter_suite_by_re(self, self.pattern)
2885
self.addTests(suite)
2886
return iter(self._tests)
2889
class RandomDecorator(TestDecorator):
2890
"""A decorator which randomises the order of its tests."""
2892
def __init__(self, suite, random_seed, stream):
2893
TestDecorator.__init__(self, suite)
2894
self.random_seed = random_seed
2895
self.randomised = False
2896
self.stream = stream
2900
return iter(self._tests)
2901
self.randomised = True
2902
self.stream.writeln("Randomizing test order using seed %s\n" %
2903
(self.actual_seed()))
2904
# Initialise the random number generator.
2905
random.seed(self.actual_seed())
2906
suite = randomize_suite(self)
2908
self.addTests(suite)
2909
return iter(self._tests)
2911
def actual_seed(self):
2912
if self.random_seed == "now":
2913
# We convert the seed to a long to make it reuseable across
2914
# invocations (because the user can reenter it).
2915
self.random_seed = long(time.time())
2917
# Convert the seed to a long if we can
2919
self.random_seed = long(self.random_seed)
2922
return self.random_seed
2925
class TestFirstDecorator(TestDecorator):
2926
"""A decorator which moves named tests to the front."""
2928
def __init__(self, suite, pattern):
2929
TestDecorator.__init__(self, suite)
2930
self.pattern = pattern
2931
self.filtered = False
2935
return iter(self._tests)
2936
self.filtered = True
2937
suites = split_suite_by_re(self, self.pattern)
2939
self.addTests(suites)
2940
return iter(self._tests)
2943
def partition_tests(suite, count):
2944
"""Partition suite into count lists of tests."""
2946
tests = list(iter_suite_tests(suite))
2947
tests_per_process = int(math.ceil(float(len(tests)) / count))
2948
for block in range(count):
2949
low_test = block * tests_per_process
2950
high_test = low_test + tests_per_process
2951
process_tests = tests[low_test:high_test]
2952
result.append(process_tests)
2956
def fork_for_tests(suite):
2957
"""Take suite and start up one runner per CPU by forking()
2959
:return: An iterable of TestCase-like objects which can each have
2960
run(result) called on them to feed tests to result.
2962
concurrency = osutils.local_concurrency()
2964
from subunit import TestProtocolClient, ProtocolTestCase
2966
from subunit.test_results import AutoTimingTestResultDecorator
2968
AutoTimingTestResultDecorator = lambda x:x
2969
class TestInOtherProcess(ProtocolTestCase):
2970
# Should be in subunit, I think. RBC.
2971
def __init__(self, stream, pid):
2972
ProtocolTestCase.__init__(self, stream)
2975
def run(self, result):
2977
ProtocolTestCase.run(self, result)
2979
os.waitpid(self.pid, os.WNOHANG)
2981
test_blocks = partition_tests(suite, concurrency)
2982
for process_tests in test_blocks:
2983
process_suite = TestSuite()
2984
process_suite.addTests(process_tests)
2985
c2pread, c2pwrite = os.pipe()
2990
# Leave stderr and stdout open so we can see test noise
2991
# Close stdin so that the child goes away if it decides to
2992
# read from stdin (otherwise its a roulette to see what
2993
# child actually gets keystrokes for pdb etc).
2996
stream = os.fdopen(c2pwrite, 'wb', 1)
2997
subunit_result = AutoTimingTestResultDecorator(
2998
TestProtocolClient(stream))
2999
process_suite.run(subunit_result)
3004
stream = os.fdopen(c2pread, 'rb', 1)
3005
test = TestInOtherProcess(stream, pid)
3010
def reinvoke_for_tests(suite):
3011
"""Take suite and start up one runner per CPU using subprocess().
3013
:return: An iterable of TestCase-like objects which can each have
3014
run(result) called on them to feed tests to result.
3016
concurrency = osutils.local_concurrency()
3018
from subunit import ProtocolTestCase
3019
class TestInSubprocess(ProtocolTestCase):
3020
def __init__(self, process, name):
3021
ProtocolTestCase.__init__(self, process.stdout)
3022
self.process = process
3023
self.process.stdin.close()
3026
def run(self, result):
3028
ProtocolTestCase.run(self, result)
3031
os.unlink(self.name)
3032
# print "pid %d finished" % finished_process
3033
test_blocks = partition_tests(suite, concurrency)
3034
for process_tests in test_blocks:
3035
# ugly; currently reimplement rather than reuses TestCase methods.
3036
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3037
if not os.path.isfile(bzr_path):
3038
# We are probably installed. Assume sys.argv is the right file
3039
bzr_path = sys.argv[0]
3040
fd, test_list_file_name = tempfile.mkstemp()
3041
test_list_file = os.fdopen(fd, 'wb', 1)
3042
for test in process_tests:
3043
test_list_file.write(test.id() + '\n')
3044
test_list_file.close()
3046
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3048
if '--no-plugins' in sys.argv:
3049
argv.append('--no-plugins')
3050
# stderr=STDOUT would be ideal, but until we prevent noise on
3051
# stderr it can interrupt the subunit protocol.
3052
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3054
test = TestInSubprocess(process, test_list_file_name)
3057
os.unlink(test_list_file_name)
3062
class BZRTransformingResult(unittest.TestResult):
3064
def __init__(self, target):
3065
unittest.TestResult.__init__(self)
3066
self.result = target
3068
def startTest(self, test):
3069
self.result.startTest(test)
3071
def stopTest(self, test):
3072
self.result.stopTest(test)
3074
def addError(self, test, err):
3075
feature = self._error_looks_like('UnavailableFeature: ', err)
3076
if feature is not None:
3077
self.result.addNotSupported(test, feature)
3079
self.result.addError(test, err)
3081
def addFailure(self, test, err):
3082
known = self._error_looks_like('KnownFailure: ', err)
3083
if known is not None:
3084
self.result._addKnownFailure(test, [KnownFailure,
3085
KnownFailure(known), None])
3087
self.result.addFailure(test, err)
3089
def addSkip(self, test, reason):
3090
self.result.addSkip(test, reason)
3092
def addSuccess(self, test):
3093
self.result.addSuccess(test)
3095
def _error_looks_like(self, prefix, err):
3096
"""Deserialize exception and returns the stringify value."""
3100
if isinstance(exc, subunit.RemoteException):
3101
# stringify the exception gives access to the remote traceback
3102
# We search the last line for 'prefix'
3103
lines = str(exc).split('\n')
3104
while lines and not lines[-1]:
3107
if lines[-1].startswith(prefix):
3108
value = lines[-1][len(prefix):]
3112
# Controlled by "bzr selftest -E=..." option
3113
selftest_debug_flags = set()
3116
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3118
test_suite_factory=None,
3121
matching_tests_first=None,
3124
exclude_pattern=None,
3130
suite_decorators=None,
3132
"""Run the whole test suite under the enhanced runner"""
3133
# XXX: Very ugly way to do this...
3134
# Disable warning about old formats because we don't want it to disturb
3135
# any blackbox tests.
3136
from bzrlib import repository
3137
repository._deprecation_warning_done = True
3139
global default_transport
3140
if transport is None:
3141
transport = default_transport
3142
old_transport = default_transport
3143
default_transport = transport
3144
global selftest_debug_flags
3145
old_debug_flags = selftest_debug_flags
3146
if debug_flags is not None:
3147
selftest_debug_flags = set(debug_flags)
3149
if load_list is None:
3152
keep_only = load_test_id_list(load_list)
3153
if test_suite_factory is None:
3154
suite = test_suite(keep_only, starting_with)
3156
suite = test_suite_factory()
3157
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3158
stop_on_failure=stop_on_failure,
3159
transport=transport,
3160
lsprof_timed=lsprof_timed,
3161
bench_history=bench_history,
3162
matching_tests_first=matching_tests_first,
3163
list_only=list_only,
3164
random_seed=random_seed,
3165
exclude_pattern=exclude_pattern,
3167
runner_class=runner_class,
3168
suite_decorators=suite_decorators,
3171
default_transport = old_transport
3172
selftest_debug_flags = old_debug_flags
3175
def load_test_id_list(file_name):
3176
"""Load a test id list from a text file.
3178
The format is one test id by line. No special care is taken to impose
3179
strict rules, these test ids are used to filter the test suite so a test id
3180
that do not match an existing test will do no harm. This allows user to add
3181
comments, leave blank lines, etc.
3185
ftest = open(file_name, 'rt')
3187
if e.errno != errno.ENOENT:
3190
raise errors.NoSuchFile(file_name)
3192
for test_name in ftest.readlines():
3193
test_list.append(test_name.strip())
3198
def suite_matches_id_list(test_suite, id_list):
3199
"""Warns about tests not appearing or appearing more than once.
3201
:param test_suite: A TestSuite object.
3202
:param test_id_list: The list of test ids that should be found in
3205
:return: (absents, duplicates) absents is a list containing the test found
3206
in id_list but not in test_suite, duplicates is a list containing the
3207
test found multiple times in test_suite.
3209
When using a prefined test id list, it may occurs that some tests do not
3210
exist anymore or that some tests use the same id. This function warns the
3211
tester about potential problems in his workflow (test lists are volatile)
3212
or in the test suite itself (using the same id for several tests does not
3213
help to localize defects).
3215
# Build a dict counting id occurrences
3217
for test in iter_suite_tests(test_suite):
3219
tests[id] = tests.get(id, 0) + 1
3224
occurs = tests.get(id, 0)
3226
not_found.append(id)
3228
duplicates.append(id)
3230
return not_found, duplicates
3233
class TestIdList(object):
3234
"""Test id list to filter a test suite.
3236
Relying on the assumption that test ids are built as:
3237
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3238
notation, this class offers methods to :
3239
- avoid building a test suite for modules not refered to in the test list,
3240
- keep only the tests listed from the module test suite.
3243
def __init__(self, test_id_list):
3244
# When a test suite needs to be filtered against us we compare test ids
3245
# for equality, so a simple dict offers a quick and simple solution.
3246
self.tests = dict().fromkeys(test_id_list, True)
3248
# While unittest.TestCase have ids like:
3249
# <module>.<class>.<method>[(<param+)],
3250
# doctest.DocTestCase can have ids like:
3253
# <module>.<function>
3254
# <module>.<class>.<method>
3256
# Since we can't predict a test class from its name only, we settle on
3257
# a simple constraint: a test id always begins with its module name.
3260
for test_id in test_id_list:
3261
parts = test_id.split('.')
3262
mod_name = parts.pop(0)
3263
modules[mod_name] = True
3265
mod_name += '.' + part
3266
modules[mod_name] = True
3267
self.modules = modules
3269
def refers_to(self, module_name):
3270
"""Is there tests for the module or one of its sub modules."""
3271
return self.modules.has_key(module_name)
3273
def includes(self, test_id):
3274
return self.tests.has_key(test_id)
3277
class TestPrefixAliasRegistry(registry.Registry):
3278
"""A registry for test prefix aliases.
3280
This helps implement shorcuts for the --starting-with selftest
3281
option. Overriding existing prefixes is not allowed but not fatal (a
3282
warning will be emitted).
3285
def register(self, key, obj, help=None, info=None,
3286
override_existing=False):
3287
"""See Registry.register.
3289
Trying to override an existing alias causes a warning to be emitted,
3290
not a fatal execption.
3293
super(TestPrefixAliasRegistry, self).register(
3294
key, obj, help=help, info=info, override_existing=False)
3296
actual = self.get(key)
3297
note('Test prefix alias %s is already used for %s, ignoring %s'
3298
% (key, actual, obj))
3300
def resolve_alias(self, id_start):
3301
"""Replace the alias by the prefix in the given string.
3303
Using an unknown prefix is an error to help catching typos.
3305
parts = id_start.split('.')
3307
parts[0] = self.get(parts[0])
3309
raise errors.BzrCommandError(
3310
'%s is not a known test prefix alias' % parts[0])
3311
return '.'.join(parts)
3314
test_prefix_alias_registry = TestPrefixAliasRegistry()
3315
"""Registry of test prefix aliases."""
3318
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3319
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3320
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3322
# Obvious higest levels prefixes, feel free to add your own via a plugin
3323
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3324
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3325
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3326
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3327
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3330
def test_suite(keep_only=None, starting_with=None):
3331
"""Build and return TestSuite for the whole of bzrlib.
3333
:param keep_only: A list of test ids limiting the suite returned.
3335
:param starting_with: An id limiting the suite returned to the tests
3338
This function can be replaced if you need to change the default test
3339
suite on a global basis, but it is not encouraged.
3343
'bzrlib.tests.blackbox',
3344
'bzrlib.tests.commands',
3345
'bzrlib.tests.per_branch',
3346
'bzrlib.tests.per_bzrdir',
3347
'bzrlib.tests.per_interrepository',
3348
'bzrlib.tests.per_intertree',
3349
'bzrlib.tests.per_inventory',
3350
'bzrlib.tests.per_interbranch',
3351
'bzrlib.tests.per_lock',
3352
'bzrlib.tests.per_transport',
3353
'bzrlib.tests.per_tree',
3354
'bzrlib.tests.per_repository',
3355
'bzrlib.tests.per_repository_chk',
3356
'bzrlib.tests.per_repository_reference',
3357
'bzrlib.tests.per_workingtree',
3358
'bzrlib.tests.test__annotator',
3359
'bzrlib.tests.test__chk_map',
3360
'bzrlib.tests.test__dirstate_helpers',
3361
'bzrlib.tests.test__groupcompress',
3362
'bzrlib.tests.test__known_graph',
3363
'bzrlib.tests.test__rio',
3364
'bzrlib.tests.test__walkdirs_win32',
3365
'bzrlib.tests.test_ancestry',
3366
'bzrlib.tests.test_annotate',
3367
'bzrlib.tests.test_api',
3368
'bzrlib.tests.test_atomicfile',
3369
'bzrlib.tests.test_bad_files',
3370
'bzrlib.tests.test_bencode',
3371
'bzrlib.tests.test_bisect_multi',
3372
'bzrlib.tests.test_branch',
3373
'bzrlib.tests.test_branchbuilder',
3374
'bzrlib.tests.test_btree_index',
3375
'bzrlib.tests.test_bugtracker',
3376
'bzrlib.tests.test_bundle',
3377
'bzrlib.tests.test_bzrdir',
3378
'bzrlib.tests.test__chunks_to_lines',
3379
'bzrlib.tests.test_cache_utf8',
3380
'bzrlib.tests.test_chk_map',
3381
'bzrlib.tests.test_chk_serializer',
3382
'bzrlib.tests.test_chunk_writer',
3383
'bzrlib.tests.test_clean_tree',
3384
'bzrlib.tests.test_commands',
3385
'bzrlib.tests.test_commit',
3386
'bzrlib.tests.test_commit_merge',
3387
'bzrlib.tests.test_config',
3388
'bzrlib.tests.test_conflicts',
3389
'bzrlib.tests.test_counted_lock',
3390
'bzrlib.tests.test_decorators',
3391
'bzrlib.tests.test_delta',
3392
'bzrlib.tests.test_debug',
3393
'bzrlib.tests.test_deprecated_graph',
3394
'bzrlib.tests.test_diff',
3395
'bzrlib.tests.test_directory_service',
3396
'bzrlib.tests.test_dirstate',
3397
'bzrlib.tests.test_email_message',
3398
'bzrlib.tests.test_eol_filters',
3399
'bzrlib.tests.test_errors',
3400
'bzrlib.tests.test_export',
3401
'bzrlib.tests.test_extract',
3402
'bzrlib.tests.test_fetch',
3403
'bzrlib.tests.test_fifo_cache',
3404
'bzrlib.tests.test_filters',
3405
'bzrlib.tests.test_ftp_transport',
3406
'bzrlib.tests.test_foreign',
3407
'bzrlib.tests.test_generate_docs',
3408
'bzrlib.tests.test_generate_ids',
3409
'bzrlib.tests.test_globbing',
3410
'bzrlib.tests.test_gpg',
3411
'bzrlib.tests.test_graph',
3412
'bzrlib.tests.test_groupcompress',
3413
'bzrlib.tests.test_hashcache',
3414
'bzrlib.tests.test_help',
3415
'bzrlib.tests.test_hooks',
3416
'bzrlib.tests.test_http',
3417
'bzrlib.tests.test_http_response',
3418
'bzrlib.tests.test_https_ca_bundle',
3419
'bzrlib.tests.test_identitymap',
3420
'bzrlib.tests.test_ignores',
3421
'bzrlib.tests.test_index',
3422
'bzrlib.tests.test_info',
3423
'bzrlib.tests.test_inv',
3424
'bzrlib.tests.test_inventory_delta',
3425
'bzrlib.tests.test_knit',
3426
'bzrlib.tests.test_lazy_import',
3427
'bzrlib.tests.test_lazy_regex',
3428
'bzrlib.tests.test_lockable_files',
3429
'bzrlib.tests.test_lockdir',
3430
'bzrlib.tests.test_log',
3431
'bzrlib.tests.test_lru_cache',
3432
'bzrlib.tests.test_lsprof',
3433
'bzrlib.tests.test_mail_client',
3434
'bzrlib.tests.test_memorytree',
3435
'bzrlib.tests.test_merge',
3436
'bzrlib.tests.test_merge3',
3437
'bzrlib.tests.test_merge_core',
3438
'bzrlib.tests.test_merge_directive',
3439
'bzrlib.tests.test_missing',
3440
'bzrlib.tests.test_msgeditor',
3441
'bzrlib.tests.test_multiparent',
3442
'bzrlib.tests.test_mutabletree',
3443
'bzrlib.tests.test_nonascii',
3444
'bzrlib.tests.test_options',
3445
'bzrlib.tests.test_osutils',
3446
'bzrlib.tests.test_osutils_encodings',
3447
'bzrlib.tests.test_pack',
3448
'bzrlib.tests.test_pack_repository',
3449
'bzrlib.tests.test_patch',
3450
'bzrlib.tests.test_patches',
3451
'bzrlib.tests.test_permissions',
3452
'bzrlib.tests.test_plugins',
3453
'bzrlib.tests.test_progress',
3454
'bzrlib.tests.test_read_bundle',
3455
'bzrlib.tests.test_reconcile',
3456
'bzrlib.tests.test_reconfigure',
3457
'bzrlib.tests.test_registry',
3458
'bzrlib.tests.test_remote',
3459
'bzrlib.tests.test_rename_map',
3460
'bzrlib.tests.test_repository',
3461
'bzrlib.tests.test_revert',
3462
'bzrlib.tests.test_revision',
3463
'bzrlib.tests.test_revisionspec',
3464
'bzrlib.tests.test_revisiontree',
3465
'bzrlib.tests.test_rio',
3466
'bzrlib.tests.test_rules',
3467
'bzrlib.tests.test_sampler',
3468
'bzrlib.tests.test_selftest',
3469
'bzrlib.tests.test_serializer',
3470
'bzrlib.tests.test_setup',
3471
'bzrlib.tests.test_sftp_transport',
3472
'bzrlib.tests.test_shelf',
3473
'bzrlib.tests.test_shelf_ui',
3474
'bzrlib.tests.test_smart',
3475
'bzrlib.tests.test_smart_add',
3476
'bzrlib.tests.test_smart_request',
3477
'bzrlib.tests.test_smart_transport',
3478
'bzrlib.tests.test_smtp_connection',
3479
'bzrlib.tests.test_source',
3480
'bzrlib.tests.test_ssh_transport',
3481
'bzrlib.tests.test_status',
3482
'bzrlib.tests.test_store',
3483
'bzrlib.tests.test_strace',
3484
'bzrlib.tests.test_subsume',
3485
'bzrlib.tests.test_switch',
3486
'bzrlib.tests.test_symbol_versioning',
3487
'bzrlib.tests.test_tag',
3488
'bzrlib.tests.test_testament',
3489
'bzrlib.tests.test_textfile',
3490
'bzrlib.tests.test_textmerge',
3491
'bzrlib.tests.test_timestamp',
3492
'bzrlib.tests.test_trace',
3493
'bzrlib.tests.test_transactions',
3494
'bzrlib.tests.test_transform',
3495
'bzrlib.tests.test_transport',
3496
'bzrlib.tests.test_transport_log',
3497
'bzrlib.tests.test_tree',
3498
'bzrlib.tests.test_treebuilder',
3499
'bzrlib.tests.test_tsort',
3500
'bzrlib.tests.test_tuned_gzip',
3501
'bzrlib.tests.test_ui',
3502
'bzrlib.tests.test_uncommit',
3503
'bzrlib.tests.test_upgrade',
3504
'bzrlib.tests.test_upgrade_stacked',
3505
'bzrlib.tests.test_urlutils',
3506
'bzrlib.tests.test_version',
3507
'bzrlib.tests.test_version_info',
3508
'bzrlib.tests.test_versionedfile',
3509
'bzrlib.tests.test_weave',
3510
'bzrlib.tests.test_whitebox',
3511
'bzrlib.tests.test_win32utils',
3512
'bzrlib.tests.test_workingtree',
3513
'bzrlib.tests.test_workingtree_4',
3514
'bzrlib.tests.test_wsgi',
3515
'bzrlib.tests.test_xml',
61
# XXX: should also test bzrlib.merge_core, but they seem to be out
62
# of date with the code.
64
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
65
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
66
if m not in MODULES_TO_DOCTEST:
67
MODULES_TO_DOCTEST.append(m)
70
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
71
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
77
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
79
for m in MODULES_TO_TEST:
80
suite.addTest(TestLoader().loadTestsFromModule(m))
82
for m in (MODULES_TO_DOCTEST):
83
suite.addTest(DocTestSuite(m))
85
for p in bzrlib.plugin.all_plugins:
86
if hasattr(p, 'test_suite'):
87
suite.addTest(p.test_suite())
89
import bzrlib.merge_core
90
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
92
return run_suite(suite, 'testbzr', verbose=verbose)
3518
loader = TestUtil.TestLoader()
3520
if keep_only is not None:
3521
id_filter = TestIdList(keep_only)
3523
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3524
for start in starting_with]
3525
# We take precedence over keep_only because *at loading time* using
3526
# both options means we will load less tests for the same final result.
3527
def interesting_module(name):
3528
for start in starting_with:
3530
# Either the module name starts with the specified string
3531
name.startswith(start)
3532
# or it may contain tests starting with the specified string
3533
or start.startswith(name)
3537
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3539
elif keep_only is not None:
3540
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3541
def interesting_module(name):
3542
return id_filter.refers_to(name)
3545
loader = TestUtil.TestLoader()
3546
def interesting_module(name):
3547
# No filtering, all modules are interesting
3550
suite = loader.suiteClass()
3552
# modules building their suite with loadTestsFromModuleNames
3553
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3555
modules_to_doctest = [
3557
'bzrlib.branchbuilder',
3560
'bzrlib.iterablefile',
3564
'bzrlib.symbol_versioning',
3567
'bzrlib.version_info_formats.format_custom',
3570
for mod in modules_to_doctest:
3571
if not interesting_module(mod):
3572
# No tests to keep here, move along
3575
# note that this really does mean "report only" -- doctest
3576
# still runs the rest of the examples
3577
doc_suite = doctest.DocTestSuite(mod,
3578
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3579
except ValueError, e:
3580
print '**failed to get doctest for: %s\n%s' % (mod, e)
3582
if len(doc_suite._tests) == 0:
3583
raise errors.BzrError("no doctests found in %s" % (mod,))
3584
suite.addTest(doc_suite)
3586
default_encoding = sys.getdefaultencoding()
3587
for name, plugin in bzrlib.plugin.plugins().items():
3588
if not interesting_module(plugin.module.__name__):
3590
plugin_suite = plugin.test_suite()
3591
# We used to catch ImportError here and turn it into just a warning,
3592
# but really if you don't have --no-plugins this should be a failure.
3593
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3594
if plugin_suite is None:
3595
plugin_suite = plugin.load_plugin_tests(loader)
3596
if plugin_suite is not None:
3597
suite.addTest(plugin_suite)
3598
if default_encoding != sys.getdefaultencoding():
3599
bzrlib.trace.warning(
3600
'Plugin "%s" tried to reset default encoding to: %s', name,
3601
sys.getdefaultencoding())
3603
sys.setdefaultencoding(default_encoding)
3606
suite = filter_suite_by_id_startswith(suite, starting_with)
3608
if keep_only is not None:
3609
# Now that the referred modules have loaded their tests, keep only the
3611
suite = filter_suite_by_id_list(suite, id_filter)
3612
# Do some sanity checks on the id_list filtering
3613
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3615
# The tester has used both keep_only and starting_with, so he is
3616
# already aware that some tests are excluded from the list, there
3617
# is no need to tell him which.
3620
# Some tests mentioned in the list are not in the test suite. The
3621
# list may be out of date, report to the tester.
3622
for id in not_found:
3623
bzrlib.trace.warning('"%s" not found in the test suite', id)
3624
for id in duplicates:
3625
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3630
def multiply_scenarios(scenarios_left, scenarios_right):
3631
"""Multiply two sets of scenarios.
3633
:returns: the cartesian product of the two sets of scenarios, that is
3634
a scenario for every possible combination of a left scenario and a
3638
('%s,%s' % (left_name, right_name),
3639
dict(left_dict.items() + right_dict.items()))
3640
for left_name, left_dict in scenarios_left
3641
for right_name, right_dict in scenarios_right]
3644
def multiply_tests(tests, scenarios, result):
3645
"""Multiply tests_list by scenarios into result.
3647
This is the core workhorse for test parameterisation.
3649
Typically the load_tests() method for a per-implementation test suite will
3650
call multiply_tests and return the result.
3652
:param tests: The tests to parameterise.
3653
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3654
scenario_param_dict).
3655
:param result: A TestSuite to add created tests to.
3657
This returns the passed in result TestSuite with the cross product of all
3658
the tests repeated once for each scenario. Each test is adapted by adding
3659
the scenario name at the end of its id(), and updating the test object's
3660
__dict__ with the scenario_param_dict.
3662
>>> import bzrlib.tests.test_sampler
3663
>>> r = multiply_tests(
3664
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3665
... [('one', dict(param=1)),
3666
... ('two', dict(param=2))],
3668
>>> tests = list(iter_suite_tests(r))
3672
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3678
for test in iter_suite_tests(tests):
3679
apply_scenarios(test, scenarios, result)
3683
def apply_scenarios(test, scenarios, result):
3684
"""Apply the scenarios in scenarios to test and add to result.
3686
:param test: The test to apply scenarios to.
3687
:param scenarios: An iterable of scenarios to apply to test.
3689
:seealso: apply_scenario
3691
for scenario in scenarios:
3692
result.addTest(apply_scenario(test, scenario))
3696
def apply_scenario(test, scenario):
3697
"""Copy test and apply scenario to it.
3699
:param test: A test to adapt.
3700
:param scenario: A tuple describing the scenarion.
3701
The first element of the tuple is the new test id.
3702
The second element is a dict containing attributes to set on the
3704
:return: The adapted test.
3706
new_id = "%s(%s)" % (test.id(), scenario[0])
3707
new_test = clone_test(test, new_id)
3708
for name, value in scenario[1].items():
3709
setattr(new_test, name, value)
3713
def clone_test(test, new_id):
3714
"""Clone a test giving it a new id.
3716
:param test: The test to clone.
3717
:param new_id: The id to assign to it.
3718
:return: The new test.
3720
from copy import deepcopy
3721
new_test = deepcopy(test)
3722
new_test.id = lambda: new_id
3726
def _rmtree_temp_dir(dirname):
3727
# If LANG=C we probably have created some bogus paths
3728
# which rmtree(unicode) will fail to delete
3729
# so make sure we are using rmtree(str) to delete everything
3730
# except on win32, where rmtree(str) will fail
3731
# since it doesn't have the property of byte-stream paths
3732
# (they are either ascii or mbcs)
3733
if sys.platform == 'win32':
3734
# make sure we are using the unicode win32 api
3735
dirname = unicode(dirname)
3737
dirname = dirname.encode(sys.getfilesystemencoding())
3739
osutils.rmtree(dirname)
3741
if sys.platform == 'win32' and e.errno == errno.EACCES:
3742
sys.stderr.write('Permission denied: '
3743
'unable to remove testing dir '
3745
% (os.path.basename(dirname), e))
3750
class Feature(object):
3751
"""An operating system Feature."""
3754
self._available = None
3756
def available(self):
3757
"""Is the feature available?
3759
:return: True if the feature is available.
3761
if self._available is None:
3762
self._available = self._probe()
3763
return self._available
3766
"""Implement this method in concrete features.
3768
:return: True if the feature is available.
3770
raise NotImplementedError
3773
if getattr(self, 'feature_name', None):
3774
return self.feature_name()
3775
return self.__class__.__name__
3778
class _SymlinkFeature(Feature):
3781
return osutils.has_symlinks()
3783
def feature_name(self):
3786
SymlinkFeature = _SymlinkFeature()
3789
class _HardlinkFeature(Feature):
3792
return osutils.has_hardlinks()
3794
def feature_name(self):
3797
HardlinkFeature = _HardlinkFeature()
3800
class _OsFifoFeature(Feature):
3803
return getattr(os, 'mkfifo', None)
3805
def feature_name(self):
3806
return 'filesystem fifos'
3808
OsFifoFeature = _OsFifoFeature()
3811
class _UnicodeFilenameFeature(Feature):
3812
"""Does the filesystem support Unicode filenames?"""
3816
# Check for character combinations unlikely to be covered by any
3817
# single non-unicode encoding. We use the characters
3818
# - greek small letter alpha (U+03B1) and
3819
# - braille pattern dots-123456 (U+283F).
3820
os.stat(u'\u03b1\u283f')
3821
except UnicodeEncodeError:
3823
except (IOError, OSError):
3824
# The filesystem allows the Unicode filename but the file doesn't
3828
# The filesystem allows the Unicode filename and the file exists,
3832
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3835
def probe_unicode_in_user_encoding():
3836
"""Try to encode several unicode strings to use in unicode-aware tests.
3837
Return first successfull match.
3839
:return: (unicode value, encoded plain string value) or (None, None)
3841
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3842
for uni_val in possible_vals:
3844
str_val = uni_val.encode(osutils.get_user_encoding())
3845
except UnicodeEncodeError:
3846
# Try a different character
3849
return uni_val, str_val
3853
def probe_bad_non_ascii(encoding):
3854
"""Try to find [bad] character with code [128..255]
3855
that cannot be decoded to unicode in some encoding.
3856
Return None if all non-ascii characters is valid
3859
for i in xrange(128, 256):
3862
char.decode(encoding)
3863
except UnicodeDecodeError:
3868
class _HTTPSServerFeature(Feature):
3869
"""Some tests want an https Server, check if one is available.
3871
Right now, the only way this is available is under python2.6 which provides
3882
def feature_name(self):
3883
return 'HTTPSServer'
3886
HTTPSServerFeature = _HTTPSServerFeature()
3889
class _UnicodeFilename(Feature):
3890
"""Does the filesystem support Unicode filenames?"""
3895
except UnicodeEncodeError:
3897
except (IOError, OSError):
3898
# The filesystem allows the Unicode filename but the file doesn't
3902
# The filesystem allows the Unicode filename and the file exists,
3906
UnicodeFilename = _UnicodeFilename()
3909
class _UTF8Filesystem(Feature):
3910
"""Is the filesystem UTF-8?"""
3913
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3917
UTF8Filesystem = _UTF8Filesystem()
3920
class _CaseInsCasePresFilenameFeature(Feature):
3921
"""Is the file-system case insensitive, but case-preserving?"""
3924
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3926
# first check truly case-preserving for created files, then check
3927
# case insensitive when opening existing files.
3928
name = osutils.normpath(name)
3929
base, rel = osutils.split(name)
3930
found_rel = osutils.canonical_relpath(base, name)
3931
return (found_rel == rel
3932
and os.path.isfile(name.upper())
3933
and os.path.isfile(name.lower()))
3938
def feature_name(self):
3939
return "case-insensitive case-preserving filesystem"
3941
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3944
class _CaseInsensitiveFilesystemFeature(Feature):
3945
"""Check if underlying filesystem is case-insensitive but *not* case
3948
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3949
# more likely to be case preserving, so this case is rare.
3952
if CaseInsCasePresFilenameFeature.available():
3955
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3956
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3957
TestCaseWithMemoryTransport.TEST_ROOT = root
3959
root = TestCaseWithMemoryTransport.TEST_ROOT
3960
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3962
name_a = osutils.pathjoin(tdir, 'a')
3963
name_A = osutils.pathjoin(tdir, 'A')
3965
result = osutils.isdir(name_A)
3966
_rmtree_temp_dir(tdir)
3969
def feature_name(self):
3970
return 'case-insensitive filesystem'
3972
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
3975
class _SubUnitFeature(Feature):
3976
"""Check if subunit is available."""
3985
def feature_name(self):
3988
SubUnitFeature = _SubUnitFeature()
3989
# Only define SubUnitBzrRunner if subunit is available.
3991
from subunit import TestProtocolClient
3993
from subunit.test_results import AutoTimingTestResultDecorator
3995
AutoTimingTestResultDecorator = lambda x:x
3996
class SubUnitBzrRunner(TextTestRunner):
3997
def run(self, test):
3998
result = AutoTimingTestResultDecorator(
3999
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
