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
# 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)
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Testing framework extensions"""
24
19
# NOTE: Some classes in here use camelCaseNaming() rather than
25
20
# underscore_naming(). That's for consistency with unittest; it's not the
26
21
# general style of bzrlib. Please continue that consistency when adding e.g.
27
22
# new assertFoo() methods.
30
27
from cStringIO import StringIO
39
from subprocess import Popen, PIPE
50
# nb: check this before importing anything else from within it
51
_testtools_version = getattr(testtools, '__version__', ())
52
if _testtools_version < (0, 9, 5):
53
raise ImportError("need at least testtools 0.9.5: %s is %r"
54
% (testtools.__file__, _testtools_version))
55
from testtools import content
46
58
from bzrlib import (
62
commands as _mod_commands,
71
plugin as _mod_plugin,
78
transport as _mod_transport,
56
import bzrlib.commands
57
import bzrlib.bundle.serializer
59
import bzrlib.inventory
60
import bzrlib.iterablefile
63
82
import bzrlib.lsprof
64
83
except ImportError:
65
84
# lsprof not available
67
from bzrlib.merge import merge_inner
71
from bzrlib.revision import common_ancestor
73
from bzrlib import symbol_versioning
75
from bzrlib.transport import get_transport
76
import bzrlib.transport
77
from bzrlib.transport.local import LocalURLServer
78
from bzrlib.transport.memory import MemoryServer
79
from bzrlib.transport.readonly import ReadonlyServer
80
from bzrlib.trace import mutter, note
81
from bzrlib.tests import TestUtil
82
from bzrlib.tests.HttpServer import HttpServer
83
from bzrlib.tests.TestUtil import (
87
from bzrlib.tests.treeshape import build_tree_contents
88
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
90
default_transport = LocalURLServer
93
MODULES_TO_DOCTEST = [
94
bzrlib.bundle.serializer,
106
def packages_to_test():
107
"""Return a list of packages to test.
109
The packages are not globally imported so that import failures are
110
triggered when running selftest, not when importing the command.
113
import bzrlib.tests.blackbox
114
import bzrlib.tests.branch_implementations
115
import bzrlib.tests.bzrdir_implementations
116
import bzrlib.tests.interrepository_implementations
117
import bzrlib.tests.interversionedfile_implementations
118
import bzrlib.tests.intertree_implementations
119
import bzrlib.tests.repository_implementations
120
import bzrlib.tests.revisionstore_implementations
121
import bzrlib.tests.tree_implementations
122
import bzrlib.tests.workingtree_implementations
125
bzrlib.tests.blackbox,
126
bzrlib.tests.branch_implementations,
127
bzrlib.tests.bzrdir_implementations,
128
bzrlib.tests.interrepository_implementations,
129
bzrlib.tests.interversionedfile_implementations,
130
bzrlib.tests.intertree_implementations,
131
bzrlib.tests.repository_implementations,
132
bzrlib.tests.revisionstore_implementations,
133
bzrlib.tests.tree_implementations,
134
bzrlib.tests.workingtree_implementations,
138
class ExtendedTestResult(unittest._TextTestResult):
86
from bzrlib.smart import client, request
87
from bzrlib.transport import (
91
from bzrlib.symbol_versioning import (
95
from bzrlib.tests import (
100
from bzrlib.ui import NullProgressView
101
from bzrlib.ui.text import TextUIFactory
103
# Mark this python module as being part of the implementation
104
# of unittest: this gives us better tracebacks where the last
105
# shown frame is the test code, not our assertXYZ.
108
default_transport = test_server.LocalURLServer
111
_unitialized_attr = object()
112
"""A sentinel needed to act as a default value in a method signature."""
115
# Subunit result codes, defined here to prevent a hard dependency on subunit.
119
# These are intentionally brought into this namespace. That way plugins, etc
120
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
121
TestSuite = TestUtil.TestSuite
122
TestLoader = TestUtil.TestLoader
124
# Tests should run in a clean and clearly defined environment. The goal is to
125
# keep them isolated from the running environment as mush as possible. The test
126
# framework ensures the variables defined below are set (or deleted if the
127
# value is None) before a test is run and reset to their original value after
128
# the test is run. Generally if some code depends on an environment variable,
129
# the tests should start without this variable in the environment. There are a
130
# few exceptions but you shouldn't violate this rule lightly.
134
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
135
# tests do check our impls match APPDATA
136
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
140
'BZREMAIL': None, # may still be present in the environment
141
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
142
'BZR_PROGRESS_BAR': None,
143
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
144
# as a base class instead of TestCaseInTempDir. Tests inheriting from
145
# TestCase should not use disk resources, BZR_LOG is one.
146
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
147
'BZR_PLUGIN_PATH': None,
148
'BZR_DISABLE_PLUGINS': None,
149
'BZR_PLUGINS_AT': None,
150
'BZR_CONCURRENCY': None,
151
# Make sure that any text ui tests are consistent regardless of
152
# the environment the test case is run in; you may want tests that
153
# test other combinations. 'dumb' is a reasonable guess for tests
154
# going to a pipe or a StringIO.
160
'SSH_AUTH_SOCK': None,
170
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
171
# least. If you do (care), please update this comment
175
'BZR_REMOTE_PATH': None,
176
# Generally speaking, we don't want apport reporting on crashes in
177
# the test envirnoment unless we're specifically testing apport,
178
# so that it doesn't leak into the real system environment. We
179
# use an env var so it propagates to subprocesses.
180
'APPORT_DISABLE': '1',
184
def override_os_environ(test, env=None):
185
"""Modify os.environ keeping a copy.
187
:param test: A test instance
189
:param env: A dict containing variable definitions to be installed
192
env = isolated_environ
193
test._original_os_environ = dict([(var, value)
194
for var, value in os.environ.iteritems()])
195
for var, value in env.iteritems():
196
osutils.set_or_unset_env(var, value)
197
if var not in test._original_os_environ:
198
# The var is new, add it with a value of None, so
199
# restore_os_environ will delete it
200
test._original_os_environ[var] = None
203
def restore_os_environ(test):
204
"""Restore os.environ to its original state.
206
:param test: A test instance previously passed to override_os_environ.
208
for var, value in test._original_os_environ.iteritems():
209
# Restore the original value (or delete it if the value has been set to
210
# None in override_os_environ).
211
osutils.set_or_unset_env(var, value)
214
class ExtendedTestResult(testtools.TextTestResult):
139
215
"""Accepts, reports and accumulates the results of running tests.
141
Compared to this unittest version this class adds support for profiling,
142
benchmarking, stopping as soon as a test fails, and skipping tests.
143
There are further-specialized subclasses for different types of display.
217
Compared to the unittest version this class adds support for
218
profiling, benchmarking, stopping as soon as a test fails, and
219
skipping tests. There are further-specialized subclasses for
220
different types of display.
222
When a test finishes, in whatever way, it calls one of the addSuccess,
223
addFailure or addError classes. These in turn may redirect to a more
224
specific case for the special test results supported by our extended
227
Note that just one of these objects is fed the results from many tests.
146
230
stop_early = False
148
232
def __init__(self, stream, descriptions, verbosity,
149
233
bench_history=None,
152
236
"""Construct new TestResult.
154
238
:param bench_history: Optionally, a writable file object to accumulate
155
239
benchmark results.
157
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
241
testtools.TextTestResult.__init__(self, stream)
158
242
if bench_history is not None:
159
243
from bzrlib.version import _get_bzr_source_tree
160
244
src_tree = _get_bzr_source_tree()
203
352
def _shortened_test_description(self, test):
205
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
354
what = re.sub(r'^bzrlib\.tests\.', '', what)
357
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
358
# multiple times in a row, because the handler is added for
359
# each test but the container list is shared between cases.
360
# See lp:498869 lp:625574 and lp:637725 for background.
361
def _record_traceback_from_test(self, exc_info):
362
"""Store the traceback from passed exc_info tuple till"""
363
self._traceback_from_test = exc_info[2]
208
365
def startTest(self, test):
209
unittest.TestResult.startTest(self, test)
366
super(ExtendedTestResult, self).startTest(test)
210
370
self.report_test_start(test)
371
test.number = self.count
211
372
self._recordTestStartTime()
373
# Make testtools cases give us the real traceback on failure
374
addOnException = getattr(test, "addOnException", None)
375
if addOnException is not None:
376
addOnException(self._record_traceback_from_test)
377
# Only check for thread leaks on bzrlib derived test cases
378
if isinstance(test, TestCase):
379
test.addCleanup(self._check_leaked_threads, test)
381
def stopTest(self, test):
382
super(ExtendedTestResult, self).stopTest(test)
383
# Manually break cycles, means touching various private things but hey
384
getDetails = getattr(test, "getDetails", None)
385
if getDetails is not None:
387
# Clear _type_equality_funcs to try to stop TestCase instances
388
# from wasting memory. 'clear' is not available in all Python
389
# versions (bug 809048)
390
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
391
if type_equality_funcs is not None:
392
tef_clear = getattr(type_equality_funcs, "clear", None)
393
if tef_clear is None:
394
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
395
if tef_instance_dict is not None:
396
tef_clear = tef_instance_dict.clear
397
if tef_clear is not None:
399
self._traceback_from_test = None
401
def startTests(self):
402
self.report_tests_starting()
403
self._active_threads = threading.enumerate()
405
def _check_leaked_threads(self, test):
406
"""See if any threads have leaked since last call
408
A sample of live threads is stored in the _active_threads attribute,
409
when this method runs it compares the current live threads and any not
410
in the previous sample are treated as having leaked.
412
now_active_threads = set(threading.enumerate())
413
threads_leaked = now_active_threads.difference(self._active_threads)
415
self._report_thread_leak(test, threads_leaked, now_active_threads)
416
self._tests_leaking_threads_count += 1
417
if self._first_thread_leaker_id is None:
418
self._first_thread_leaker_id = test.id()
419
self._active_threads = now_active_threads
213
421
def _recordTestStartTime(self):
214
422
"""Record that a test has started."""
215
self._start_time = time.time()
423
self._start_datetime = self._now()
217
425
def addError(self, test, err):
218
if isinstance(err[1], TestSkipped):
219
return self.addSkipped(test, err)
220
unittest.TestResult.addError(self, test, err)
221
# We can only do this if we have one of our TestCases, not if
223
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
224
if setKeepLogfile is not None:
226
self.extractBenchmarkTime(test)
426
"""Tell result that test finished with an error.
428
Called from the TestCase run() method when the test
429
fails with an unexpected error.
431
self._post_mortem(self._traceback_from_test)
432
super(ExtendedTestResult, self).addError(test, err)
433
self.error_count += 1
227
434
self.report_error(test, err)
228
435
if self.stop_early:
231
438
def addFailure(self, test, err):
232
unittest.TestResult.addFailure(self, test, err)
233
# We can only do this if we have one of our TestCases, not if
235
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
236
if setKeepLogfile is not None:
238
self.extractBenchmarkTime(test)
439
"""Tell result that test failed.
441
Called from the TestCase run() method when the test
442
fails because e.g. an assert() method failed.
444
self._post_mortem(self._traceback_from_test)
445
super(ExtendedTestResult, self).addFailure(test, err)
446
self.failure_count += 1
239
447
self.report_failure(test, err)
240
448
if self.stop_early:
243
def addSuccess(self, test):
244
self.extractBenchmarkTime(test)
451
def addSuccess(self, test, details=None):
452
"""Tell result that test completed successfully.
454
Called from the TestCase run()
245
456
if self._bench_history is not None:
246
if self._benchmarkTime is not None:
457
benchmark_time = self._extractBenchmarkTime(test, details)
458
if benchmark_time is not None:
247
459
self._bench_history.write("%s %s\n" % (
248
self._formatTime(self._benchmarkTime),
460
self._formatTime(benchmark_time),
250
462
self.report_success(test)
251
unittest.TestResult.addSuccess(self, test)
253
def addSkipped(self, test, skip_excinfo):
254
self.extractBenchmarkTime(test)
255
self.report_skip(test, skip_excinfo)
256
# seems best to treat this as success from point-of-view of unittest
257
# -- it actually does nothing so it barely matters :)
260
except KeyboardInterrupt:
263
self.addError(test, test.__exc_info())
265
unittest.TestResult.addSuccess(self, test)
267
def printErrorList(self, flavour, errors):
268
for test, err in errors:
269
self.stream.writeln(self.separator1)
270
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
271
if getattr(test, '_get_log', None) is not None:
273
print >>self.stream, \
274
('vvvv[log from %s]' % test.id()).ljust(78,'-')
275
print >>self.stream, test._get_log()
276
print >>self.stream, \
277
('^^^^[log from %s]' % test.id()).ljust(78,'-')
278
self.stream.writeln(self.separator2)
279
self.stream.writeln("%s" % err)
284
def report_cleaning_up(self):
463
super(ExtendedTestResult, self).addSuccess(test)
464
test._log_contents = ''
466
def addExpectedFailure(self, test, err):
467
self.known_failure_count += 1
468
self.report_known_failure(test, err)
470
def addUnexpectedSuccess(self, test, details=None):
471
"""Tell result the test unexpectedly passed, counting as a failure
473
When the minimum version of testtools required becomes 0.9.8 this
474
can be updated to use the new handling there.
476
super(ExtendedTestResult, self).addFailure(test, details=details)
477
self.failure_count += 1
478
self.report_unexpected_success(test,
479
"".join(details["reason"].iter_text()))
483
def addNotSupported(self, test, feature):
484
"""The test will not be run because of a missing feature.
486
# this can be called in two different ways: it may be that the
487
# test started running, and then raised (through requireFeature)
488
# UnavailableFeature. Alternatively this method can be called
489
# while probing for features before running the test code proper; in
490
# that case we will see startTest and stopTest, but the test will
491
# never actually run.
492
self.unsupported.setdefault(str(feature), 0)
493
self.unsupported[str(feature)] += 1
494
self.report_unsupported(test, feature)
496
def addSkip(self, test, reason):
497
"""A test has not run for 'reason'."""
499
self.report_skip(test, reason)
501
def addNotApplicable(self, test, reason):
502
self.not_applicable_count += 1
503
self.report_not_applicable(test, reason)
505
def _post_mortem(self, tb=None):
506
"""Start a PDB post mortem session."""
507
if os.environ.get('BZR_TEST_PDB', None):
511
def progress(self, offset, whence):
512
"""The test is adjusting the count of tests to run."""
513
if whence == SUBUNIT_SEEK_SET:
514
self.num_tests = offset
515
elif whence == SUBUNIT_SEEK_CUR:
516
self.num_tests += offset
518
raise errors.BzrError("Unknown whence %r" % whence)
520
def report_tests_starting(self):
521
"""Display information before the test run begins"""
522
if getattr(sys, 'frozen', None) is None:
523
bzr_path = osutils.realpath(sys.argv[0])
525
bzr_path = sys.executable
527
'bzr selftest: %s\n' % (bzr_path,))
530
bzrlib.__path__[0],))
532
' bzr-%s python-%s %s\n' % (
533
bzrlib.version_string,
534
bzrlib._format_version_tuple(sys.version_info),
535
platform.platform(aliased=1),
537
self.stream.write('\n')
539
def report_test_start(self, test):
540
"""Display information on the test just about to be run"""
542
def _report_thread_leak(self, test, leaked_threads, active_threads):
543
"""Display information on a test that leaked one or more threads"""
544
# GZ 2010-09-09: A leak summary reported separately from the general
545
# thread debugging would be nice. Tests under subunit
546
# need something not using stream, perhaps adding a
547
# testtools details object would be fitting.
548
if 'threads' in selftest_debug_flags:
549
self.stream.write('%s is leaking, active is now %d\n' %
550
(test.id(), len(active_threads)))
552
def startTestRun(self):
553
self.startTime = time.time()
287
555
def report_success(self, test):
558
def wasStrictlySuccessful(self):
559
if self.unsupported or self.known_failure_count:
561
return self.wasSuccessful()
291
564
class TextTestResult(ExtendedTestResult):
292
565
"""Displays progress and results of tests in text form"""
294
def __init__(self, *args, **kw):
295
ExtendedTestResult.__init__(self, *args, **kw)
567
def __init__(self, stream, descriptions, verbosity,
572
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
573
bench_history, strict)
574
# We no longer pass them around, but just rely on the UIFactory stack
577
warnings.warn("Passing pb to TextTestResult is deprecated")
296
578
self.pb = self.ui.nested_progress_bar()
297
579
self.pb.show_pct = False
298
580
self.pb.show_spinner = False
299
self.pb.show_eta = False,
581
self.pb.show_eta = False,
300
582
self.pb.show_count = False
301
583
self.pb.show_bar = False
303
def report_starting(self):
304
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
584
self.pb.update_latency = 0
585
self.pb.show_transport_activity = False
587
def stopTestRun(self):
588
# called when the tests that are going to run have run
591
super(TextTestResult, self).stopTestRun()
593
def report_tests_starting(self):
594
super(TextTestResult, self).report_tests_starting()
595
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
306
597
def _progress_prefix_text(self):
307
a = '[%d' % self.count
308
if self.num_tests is not None:
598
# the longer this text, the less space we have to show the test
600
a = '[%d' % self.count # total that have been run
601
# tests skipped as known not to be relevant are not important enough
603
## if self.skip_count:
604
## a += ', %d skip' % self.skip_count
605
## if self.known_failure_count:
606
## a += '+%dX' % self.known_failure_count
309
608
a +='/%d' % self.num_tests
310
a += ' in %ds' % (time.time() - self._overall_start_time)
312
a += ', %d errors' % self.error_count
313
if self.failure_count:
314
a += ', %d failed' % self.failure_count
316
a += ', %d skipped' % self.skip_count
610
runtime = time.time() - self._overall_start_time
612
a += '%dm%ds' % (runtime / 60, runtime % 60)
615
total_fail_count = self.error_count + self.failure_count
617
a += ', %d failed' % total_fail_count
618
# if self.unsupported:
619
# a += ', %d missing' % len(self.unsupported)
320
623
def report_test_start(self, test):
323
625
self._progress_prefix_text()
325
627
+ self._shortened_test_description(test))
629
def _test_description(self, test):
630
return self._shortened_test_description(test)
327
632
def report_error(self, test, err):
328
self.error_count += 1
329
self.pb.note('ERROR: %s\n %s\n',
330
self._shortened_test_description(test),
633
self.stream.write('ERROR: %s\n %s\n' % (
634
self._test_description(test),
334
638
def report_failure(self, test, err):
335
self.failure_count += 1
336
self.pb.note('FAIL: %s\n %s\n',
337
self._shortened_test_description(test),
639
self.stream.write('FAIL: %s\n %s\n' % (
640
self._test_description(test),
341
def report_skip(self, test, skip_excinfo):
344
# at the moment these are mostly not things we can fix
345
# and so they just produce stipple; use the verbose reporter
348
# show test and reason for skip
349
self.pb.note('SKIP: %s\n %s\n',
350
self._shortened_test_description(test),
353
# since the class name was left behind in the still-visible
355
self.pb.note('SKIP: %s', skip_excinfo[1])
357
def report_cleaning_up(self):
358
self.pb.update('cleaning up...')
644
def report_known_failure(self, test, err):
647
def report_unexpected_success(self, test, reason):
648
self.stream.write('FAIL: %s\n %s: %s\n' % (
649
self._test_description(test),
650
"Unexpected success. Should have failed",
654
def report_skip(self, test, reason):
657
def report_not_applicable(self, test, reason):
660
def report_unsupported(self, test, feature):
661
"""test cannot be run because feature is missing."""
364
664
class VerboseTestResult(ExtendedTestResult):
541
955
retrieved by _get_log(). We use a real OS file, not an in-memory object,
542
956
so that it can also capture file IO. When the test completes this file
543
957
is read into memory and removed from disk.
545
959
There are also convenience functions to invoke bzr's command-line
546
960
routine, and to build and check bzr trees.
548
962
In addition to the usual method of overriding tearDown(), this class also
549
allows subclasses to register functions into the _cleanups list, which is
963
allows subclasses to register cleanup functions via addCleanup, which are
550
964
run in order as the object is torn down. It's less likely this will be
551
965
accidentally overlooked.
554
_log_file_name = None
556
_keep_log_file = False
557
969
# record lsprof data when performing benchmark calls.
558
970
_gather_lsprof_in_benchmarks = False
560
972
def __init__(self, methodName='testMethod'):
561
973
super(TestCase, self).__init__(methodName)
974
self._directory_isolation = True
975
self.exception_handlers.insert(0,
976
(UnavailableFeature, self._do_unsupported_or_skip))
977
self.exception_handlers.insert(0,
978
(TestNotApplicable, self._do_not_applicable))
565
unittest.TestCase.setUp(self)
981
super(TestCase, self).setUp()
982
for feature in getattr(self, '_test_needs_features', []):
983
self.requireFeature(feature)
566
984
self._cleanEnvironment()
567
bzrlib.trace.disable_default_logging()
568
985
self._silenceUI()
569
986
self._startLogFile()
570
987
self._benchcalls = []
571
988
self._benchtime = None
990
self._track_transports()
992
self._clear_debug_flags()
993
# Isolate global verbosity level, to make sure it's reproducible
994
# between tests. We should get rid of this altogether: bug 656694. --
996
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
997
# Isolate config option expansion until its default value for bzrlib is
998
# settled on or a the FIXME associated with _get_expand_default_value
999
# is addressed -- vila 20110219
1000
self.overrideAttr(config, '_expand_default_value', None)
1001
self._log_files = set()
1002
# Each key in the ``_counters`` dict holds a value for a different
1003
# counter. When the test ends, addDetail() should be used to output the
1004
# counter values. This happens in install_counter_hook().
1006
if 'config_stats' in selftest_debug_flags:
1007
self._install_config_stats_hooks()
1012
pdb.Pdb().set_trace(sys._getframe().f_back)
1014
def discardDetail(self, name):
1015
"""Extend the addDetail, getDetails api so we can remove a detail.
1017
eg. bzr always adds the 'log' detail at startup, but we don't want to
1018
include it for skipped, xfail, etc tests.
1020
It is safe to call this for a detail that doesn't exist, in case this
1021
gets called multiple times.
1023
# We cheat. details is stored in __details which means we shouldn't
1024
# touch it. but getDetails() returns the dict directly, so we can
1026
details = self.getDetails()
1030
def install_counter_hook(self, hooks, name, counter_name=None):
1031
"""Install a counting hook.
1033
Any hook can be counted as long as it doesn't need to return a value.
1035
:param hooks: Where the hook should be installed.
1037
:param name: The hook name that will be counted.
1039
:param counter_name: The counter identifier in ``_counters``, defaults
1042
_counters = self._counters # Avoid closing over self
1043
if counter_name is None:
1045
if _counters.has_key(counter_name):
1046
raise AssertionError('%s is already used as a counter name'
1048
_counters[counter_name] = 0
1049
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1050
lambda: ['%d' % (_counters[counter_name],)]))
1051
def increment_counter(*args, **kwargs):
1052
_counters[counter_name] += 1
1053
label = 'count %s calls' % (counter_name,)
1054
hooks.install_named_hook(name, increment_counter, label)
1055
self.addCleanup(hooks.uninstall_named_hook, name, label)
1057
def _install_config_stats_hooks(self):
1058
"""Install config hooks to count hook calls.
1061
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1062
self.install_counter_hook(config.ConfigHooks, hook_name,
1063
'config.%s' % (hook_name,))
1065
# The OldConfigHooks are private and need special handling to protect
1066
# against recursive tests (tests that run other tests), so we just do
1067
# manually what registering them into _builtin_known_hooks will provide
1069
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1070
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1071
self.install_counter_hook(config.OldConfigHooks, hook_name,
1072
'old_config.%s' % (hook_name,))
1074
def _clear_debug_flags(self):
1075
"""Prevent externally set debug flags affecting tests.
1077
Tests that want to use debug flags can just set them in the
1078
debug_flags set during setup/teardown.
1080
# Start with a copy of the current debug flags we can safely modify.
1081
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1082
if 'allow_debug' not in selftest_debug_flags:
1083
debug.debug_flags.clear()
1084
if 'disable_lock_checks' not in selftest_debug_flags:
1085
debug.debug_flags.add('strict_locks')
1087
def _clear_hooks(self):
572
1088
# prevent hooks affecting tests
573
self._preserved_hooks = bzrlib.branch.Branch.hooks
1089
known_hooks = hooks.known_hooks
1090
self._preserved_hooks = {}
1091
for key, (parent, name) in known_hooks.iter_parent_objects():
1092
current_hooks = getattr(parent, name)
1093
self._preserved_hooks[parent] = (name, current_hooks)
1094
self._preserved_lazy_hooks = hooks._lazy_hooks
1095
hooks._lazy_hooks = {}
574
1096
self.addCleanup(self._restoreHooks)
575
# this list of hooks must be kept in sync with the defaults
577
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
1097
for key, (parent, name) in known_hooks.iter_parent_objects():
1098
factory = known_hooks.get(key)
1099
setattr(parent, name, factory())
1100
# this hook should always be installed
1101
request._install_hook()
1103
def disable_directory_isolation(self):
1104
"""Turn off directory isolation checks."""
1105
self._directory_isolation = False
1107
def enable_directory_isolation(self):
1108
"""Enable directory isolation checks."""
1109
self._directory_isolation = True
579
1111
def _silenceUI(self):
580
1112
"""Turn off UI for duration of test"""
581
1113
# by default the UI is off; tests can turn it on if they want it.
582
saved = bzrlib.ui.ui_factory
584
bzrlib.ui.ui_factory = saved
585
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
586
self.addCleanup(_restore)
1114
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1116
def _check_locks(self):
1117
"""Check that all lock take/release actions have been paired."""
1118
# We always check for mismatched locks. If a mismatch is found, we
1119
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1120
# case we just print a warning.
1122
acquired_locks = [lock for action, lock in self._lock_actions
1123
if action == 'acquired']
1124
released_locks = [lock for action, lock in self._lock_actions
1125
if action == 'released']
1126
broken_locks = [lock for action, lock in self._lock_actions
1127
if action == 'broken']
1128
# trivially, given the tests for lock acquistion and release, if we
1129
# have as many in each list, it should be ok. Some lock tests also
1130
# break some locks on purpose and should be taken into account by
1131
# considering that breaking a lock is just a dirty way of releasing it.
1132
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1134
'Different number of acquired and '
1135
'released or broken locks.\n'
1139
(acquired_locks, released_locks, broken_locks))
1140
if not self._lock_check_thorough:
1141
# Rather than fail, just warn
1142
print "Broken test %s: %s" % (self, message)
1146
def _track_locks(self):
1147
"""Track lock activity during tests."""
1148
self._lock_actions = []
1149
if 'disable_lock_checks' in selftest_debug_flags:
1150
self._lock_check_thorough = False
1152
self._lock_check_thorough = True
1154
self.addCleanup(self._check_locks)
1155
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1156
self._lock_acquired, None)
1157
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1158
self._lock_released, None)
1159
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1160
self._lock_broken, None)
1162
def _lock_acquired(self, result):
1163
self._lock_actions.append(('acquired', result))
1165
def _lock_released(self, result):
1166
self._lock_actions.append(('released', result))
1168
def _lock_broken(self, result):
1169
self._lock_actions.append(('broken', result))
1171
def permit_dir(self, name):
1172
"""Permit a directory to be used by this test. See permit_url."""
1173
name_transport = _mod_transport.get_transport_from_path(name)
1174
self.permit_url(name)
1175
self.permit_url(name_transport.base)
1177
def permit_url(self, url):
1178
"""Declare that url is an ok url to use in this test.
1180
Do this for memory transports, temporary test directory etc.
1182
Do not do this for the current working directory, /tmp, or any other
1183
preexisting non isolated url.
1185
if not url.endswith('/'):
1187
self._bzr_selftest_roots.append(url)
1189
def permit_source_tree_branch_repo(self):
1190
"""Permit the source tree bzr is running from to be opened.
1192
Some code such as bzrlib.version attempts to read from the bzr branch
1193
that bzr is executing from (if any). This method permits that directory
1194
to be used in the test suite.
1196
path = self.get_source_path()
1197
self.record_directory_isolation()
1200
workingtree.WorkingTree.open(path)
1201
except (errors.NotBranchError, errors.NoWorkingTree):
1202
raise TestSkipped('Needs a working tree of bzr sources')
1204
self.enable_directory_isolation()
1206
def _preopen_isolate_transport(self, transport):
1207
"""Check that all transport openings are done in the test work area."""
1208
while isinstance(transport, pathfilter.PathFilteringTransport):
1209
# Unwrap pathfiltered transports
1210
transport = transport.server.backing_transport.clone(
1211
transport._filter('.'))
1212
url = transport.base
1213
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1214
# urls it is given by prepending readonly+. This is appropriate as the
1215
# client shouldn't know that the server is readonly (or not readonly).
1216
# We could register all servers twice, with readonly+ prepending, but
1217
# that makes for a long list; this is about the same but easier to
1219
if url.startswith('readonly+'):
1220
url = url[len('readonly+'):]
1221
self._preopen_isolate_url(url)
1223
def _preopen_isolate_url(self, url):
1224
if not self._directory_isolation:
1226
if self._directory_isolation == 'record':
1227
self._bzr_selftest_roots.append(url)
1229
# This prevents all transports, including e.g. sftp ones backed on disk
1230
# from working unless they are explicitly granted permission. We then
1231
# depend on the code that sets up test transports to check that they are
1232
# appropriately isolated and enable their use by calling
1233
# self.permit_transport()
1234
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1235
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1236
% (url, self._bzr_selftest_roots))
1238
def record_directory_isolation(self):
1239
"""Gather accessed directories to permit later access.
1241
This is used for tests that access the branch bzr is running from.
1243
self._directory_isolation = "record"
1245
def start_server(self, transport_server, backing_server=None):
1246
"""Start transport_server for this test.
1248
This starts the server, registers a cleanup for it and permits the
1249
server's urls to be used.
1251
if backing_server is None:
1252
transport_server.start_server()
1254
transport_server.start_server(backing_server)
1255
self.addCleanup(transport_server.stop_server)
1256
# Obtain a real transport because if the server supplies a password, it
1257
# will be hidden from the base on the client side.
1258
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1259
# Some transport servers effectively chroot the backing transport;
1260
# others like SFTPServer don't - users of the transport can walk up the
1261
# transport to read the entire backing transport. This wouldn't matter
1262
# except that the workdir tests are given - and that they expect the
1263
# server's url to point at - is one directory under the safety net. So
1264
# Branch operations into the transport will attempt to walk up one
1265
# directory. Chrooting all servers would avoid this but also mean that
1266
# we wouldn't be testing directly against non-root urls. Alternatively
1267
# getting the test framework to start the server with a backing server
1268
# at the actual safety net directory would work too, but this then
1269
# means that the self.get_url/self.get_transport methods would need
1270
# to transform all their results. On balance its cleaner to handle it
1271
# here, and permit a higher url when we have one of these transports.
1272
if t.base.endswith('/work/'):
1273
# we have safety net/test root/work
1274
t = t.clone('../..')
1275
elif isinstance(transport_server,
1276
test_server.SmartTCPServer_for_testing):
1277
# The smart server adds a path similar to work, which is traversed
1278
# up from by the client. But the server is chrooted - the actual
1279
# backing transport is not escaped from, and VFS requests to the
1280
# root will error (because they try to escape the chroot).
1282
while t2.base != t.base:
1285
self.permit_url(t.base)
1287
def _track_transports(self):
1288
"""Install checks for transport usage."""
1289
# TestCase has no safe place it can write to.
1290
self._bzr_selftest_roots = []
1291
# Currently the easiest way to be sure that nothing is going on is to
1292
# hook into bzr dir opening. This leaves a small window of error for
1293
# transport tests, but they are well known, and we can improve on this
1295
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1296
self._preopen_isolate_transport, "Check bzr directories are safe.")
588
1298
def _ndiff_strings(self, a, b):
589
1299
"""Return ndiff between two strings containing lines.
591
1301
A trailing newline is added if missing to make the strings
592
1302
print properly."""
593
1303
if b and b[-1] != '\n':
770
1701
The file is removed as the test is torn down.
772
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
773
self._log_file = os.fdopen(fileno, 'w+')
774
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
775
self._log_file_name = name
1703
pseudo_log_file = StringIO()
1704
def _get_log_contents_for_weird_testtools_api():
1705
return [pseudo_log_file.getvalue().decode(
1706
"utf-8", "replace").encode("utf-8")]
1707
self.addDetail("log", content.Content(content.ContentType("text",
1708
"plain", {"charset": "utf8"}),
1709
_get_log_contents_for_weird_testtools_api))
1710
self._log_file = pseudo_log_file
1711
self._log_memento = trace.push_log_file(self._log_file)
776
1712
self.addCleanup(self._finishLogFile)
778
1714
def _finishLogFile(self):
779
1715
"""Finished with the log file.
781
Close the file and delete it, unless setKeepLogfile was called.
783
if self._log_file is None:
785
bzrlib.trace.disable_test_log(self._log_nonce)
786
self._log_file.close()
787
self._log_file = None
788
if not self._keep_log_file:
789
os.remove(self._log_file_name)
790
self._log_file_name = None
792
def setKeepLogfile(self):
793
"""Make the logfile not be deleted when _finishLogFile is called."""
794
self._keep_log_file = True
796
def addCleanup(self, callable):
797
"""Arrange to run a callable when this case is torn down.
799
Callables are run in the reverse of the order they are registered,
800
ie last-in first-out.
802
if callable in self._cleanups:
803
raise ValueError("cleanup function %r already registered on %s"
805
self._cleanups.append(callable)
1717
Close the file and delete it.
1719
if trace._trace_file:
1720
# flush the log file, to get all content
1721
trace._trace_file.flush()
1722
trace.pop_log_file(self._log_memento)
1724
def thisFailsStrictLockCheck(self):
1725
"""It is known that this test would fail with -Dstrict_locks.
1727
By default, all tests are run with strict lock checking unless
1728
-Edisable_lock_checks is supplied. However there are some tests which
1729
we know fail strict locks at this point that have not been fixed.
1730
They should call this function to disable the strict checking.
1732
This should be used sparingly, it is much better to fix the locking
1733
issues rather than papering over the problem by calling this function.
1735
debug.debug_flags.discard('strict_locks')
1737
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1738
"""Overrides an object attribute restoring it after the test.
1740
:note: This should be used with discretion; you should think about
1741
whether it's better to make the code testable without monkey-patching.
1743
:param obj: The object that will be mutated.
1745
:param attr_name: The attribute name we want to preserve/override in
1748
:param new: The optional value we want to set the attribute to.
1750
:returns: The actual attr value.
1752
value = getattr(obj, attr_name)
1753
# The actual value is captured by the call below
1754
self.addCleanup(setattr, obj, attr_name, value)
1755
if new is not _unitialized_attr:
1756
setattr(obj, attr_name, new)
1759
def overrideEnv(self, name, new):
1760
"""Set an environment variable, and reset it after the test.
1762
:param name: The environment variable name.
1764
:param new: The value to set the variable to. If None, the
1765
variable is deleted from the environment.
1767
:returns: The actual variable value.
1769
value = osutils.set_or_unset_env(name, new)
1770
self.addCleanup(osutils.set_or_unset_env, name, value)
1773
def recordCalls(self, obj, attr_name):
1774
"""Monkeypatch in a wrapper that will record calls.
1776
The monkeypatch is automatically removed when the test concludes.
1778
:param obj: The namespace holding the reference to be replaced;
1779
typically a module, class, or object.
1780
:param attr_name: A string for the name of the attribute to
1782
:returns: A list that will be extended with one item every time the
1783
function is called, with a tuple of (args, kwargs).
1787
def decorator(*args, **kwargs):
1788
calls.append((args, kwargs))
1789
return orig(*args, **kwargs)
1790
orig = self.overrideAttr(obj, attr_name, decorator)
807
1793
def _cleanEnvironment(self):
809
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
811
'APPDATA': os.getcwd(),
813
'BZREMAIL': None, # may still be present in the environment
815
'BZR_PROGRESS_BAR': None,
825
# Nobody cares about these ones AFAIK. So far at
826
# least. If you do (care), please update this comment
832
self.addCleanup(self._restoreEnvironment)
833
for name, value in new_env.iteritems():
834
self._captureVar(name, value)
836
def _captureVar(self, name, newvalue):
837
"""Set an environment variable, and reset it when finished."""
838
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
840
def _restoreEnvironment(self):
841
for name, value in self.__old_env.iteritems():
842
osutils.set_or_unset_env(name, value)
1794
for name, value in isolated_environ.iteritems():
1795
self.overrideEnv(name, value)
844
1797
def _restoreHooks(self):
845
bzrlib.branch.Branch.hooks = self._preserved_hooks
849
unittest.TestCase.tearDown(self)
1798
for klass, (name, hooks) in self._preserved_hooks.items():
1799
setattr(klass, name, hooks)
1800
self._preserved_hooks.clear()
1801
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1802
self._preserved_lazy_hooks.clear()
1804
def knownFailure(self, reason):
1805
"""Declare that this test fails for a known reason
1807
Tests that are known to fail should generally be using expectedFailure
1808
with an appropriate reverse assertion if a change could cause the test
1809
to start passing. Conversely if the test has no immediate prospect of
1810
succeeding then using skip is more suitable.
1812
When this method is called while an exception is being handled, that
1813
traceback will be used, otherwise a new exception will be thrown to
1814
provide one but won't be reported.
1816
self._add_reason(reason)
1818
exc_info = sys.exc_info()
1819
if exc_info != (None, None, None):
1820
self._report_traceback(exc_info)
1823
raise self.failureException(reason)
1824
except self.failureException:
1825
exc_info = sys.exc_info()
1826
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1827
raise testtools.testcase._ExpectedFailure(exc_info)
1831
def _suppress_log(self):
1832
"""Remove the log info from details."""
1833
self.discardDetail('log')
1835
def _do_skip(self, result, reason):
1836
self._suppress_log()
1837
addSkip = getattr(result, 'addSkip', None)
1838
if not callable(addSkip):
1839
result.addSuccess(result)
1841
addSkip(self, reason)
1844
def _do_known_failure(self, result, e):
1845
self._suppress_log()
1846
err = sys.exc_info()
1847
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1848
if addExpectedFailure is not None:
1849
addExpectedFailure(self, err)
1851
result.addSuccess(self)
1854
def _do_not_applicable(self, result, e):
1856
reason = 'No reason given'
1859
self._suppress_log ()
1860
addNotApplicable = getattr(result, 'addNotApplicable', None)
1861
if addNotApplicable is not None:
1862
result.addNotApplicable(self, reason)
1864
self._do_skip(result, reason)
1867
def _report_skip(self, result, err):
1868
"""Override the default _report_skip.
1870
We want to strip the 'log' detail. If we waint until _do_skip, it has
1871
already been formatted into the 'reason' string, and we can't pull it
1874
self._suppress_log()
1875
super(TestCase, self)._report_skip(self, result, err)
1878
def _report_expected_failure(self, result, err):
1881
See _report_skip for motivation.
1883
self._suppress_log()
1884
super(TestCase, self)._report_expected_failure(self, result, err)
1887
def _do_unsupported_or_skip(self, result, e):
1889
self._suppress_log()
1890
addNotSupported = getattr(result, 'addNotSupported', None)
1891
if addNotSupported is not None:
1892
result.addNotSupported(self, reason)
1894
self._do_skip(result, reason)
851
1896
def time(self, callable, *args, **kwargs):
852
1897
"""Run callable and accrue the time it takes to the benchmark time.
854
1899
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
855
1900
this will cause lsprofile statistics to be gathered and stored in
856
1901
self._benchcalls.
858
1903
if self._benchtime is None:
1904
self.addDetail('benchtime', content.Content(content.ContentType(
1905
"text", "plain"), lambda:[str(self._benchtime)]))
859
1906
self._benchtime = 0
860
1907
start = time.time()
1667
2981
for readonly urls.
1669
2983
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
1670
be used without needed to redo it when a different
2984
be used without needed to redo it when a different
1671
2985
subclass is in use ?
1674
2988
def setUp(self):
2989
from bzrlib.tests import http_server
1675
2990
super(ChrootedTestCase, self).setUp()
1676
if not self.transport_server == MemoryServer:
1677
self.transport_readonly_server = HttpServer
2991
if not self.vfs_transport_factory == memory.MemoryServer:
2992
self.transport_readonly_server = http_server.HttpServer
2995
def condition_id_re(pattern):
2996
"""Create a condition filter which performs a re check on a test's id.
2998
:param pattern: A regular expression string.
2999
:return: A callable that returns True if the re matches.
3001
filter_re = re.compile(pattern, 0)
3002
def condition(test):
3004
return filter_re.search(test_id)
3008
def condition_isinstance(klass_or_klass_list):
3009
"""Create a condition filter which returns isinstance(param, klass).
3011
:return: A callable which when called with one parameter obj return the
3012
result of isinstance(obj, klass_or_klass_list).
3015
return isinstance(obj, klass_or_klass_list)
3019
def condition_id_in_list(id_list):
3020
"""Create a condition filter which verify that test's id in a list.
3022
:param id_list: A TestIdList object.
3023
:return: A callable that returns True if the test's id appears in the list.
3025
def condition(test):
3026
return id_list.includes(test.id())
3030
def condition_id_startswith(starts):
3031
"""Create a condition filter verifying that test's id starts with a string.
3033
:param starts: A list of string.
3034
:return: A callable that returns True if the test's id starts with one of
3037
def condition(test):
3038
for start in starts:
3039
if test.id().startswith(start):
3045
def exclude_tests_by_condition(suite, condition):
3046
"""Create a test suite which excludes some tests from suite.
3048
:param suite: The suite to get tests from.
3049
:param condition: A callable whose result evaluates True when called with a
3050
test case which should be excluded from the result.
3051
:return: A suite which contains the tests found in suite that fail
3055
for test in iter_suite_tests(suite):
3056
if not condition(test):
3058
return TestUtil.TestSuite(result)
3061
def filter_suite_by_condition(suite, condition):
3062
"""Create a test suite by filtering another one.
3064
:param suite: The source suite.
3065
:param condition: A callable whose result evaluates True when called with a
3066
test case which should be included in the result.
3067
:return: A suite which contains the tests found in suite that pass
3071
for test in iter_suite_tests(suite):
3074
return TestUtil.TestSuite(result)
1680
3077
def filter_suite_by_re(suite, pattern):
1681
result = TestUtil.TestSuite()
1682
filter_re = re.compile(pattern)
1683
for test in iter_suite_tests(suite):
1684
if filter_re.search(test.id()):
1685
result.addTest(test)
1689
def sort_suite_by_re(suite, pattern):
1692
filter_re = re.compile(pattern)
1693
for test in iter_suite_tests(suite):
1694
if filter_re.search(test.id()):
3078
"""Create a test suite by filtering another one.
3080
:param suite: the source suite
3081
:param pattern: pattern that names must match
3082
:returns: the newly created suite
3084
condition = condition_id_re(pattern)
3085
result_suite = filter_suite_by_condition(suite, condition)
3089
def filter_suite_by_id_list(suite, test_id_list):
3090
"""Create a test suite by filtering another one.
3092
:param suite: The source suite.
3093
:param test_id_list: A list of the test ids to keep as strings.
3094
:returns: the newly created suite
3096
condition = condition_id_in_list(test_id_list)
3097
result_suite = filter_suite_by_condition(suite, condition)
3101
def filter_suite_by_id_startswith(suite, start):
3102
"""Create a test suite by filtering another one.
3104
:param suite: The source suite.
3105
:param start: A list of string the test id must start with one of.
3106
:returns: the newly created suite
3108
condition = condition_id_startswith(start)
3109
result_suite = filter_suite_by_condition(suite, condition)
3113
def exclude_tests_by_re(suite, pattern):
3114
"""Create a test suite which excludes some tests from suite.
3116
:param suite: The suite to get tests from.
3117
:param pattern: A regular expression string. Test ids that match this
3118
pattern will be excluded from the result.
3119
:return: A TestSuite that contains all the tests from suite without the
3120
tests that matched pattern. The order of tests is the same as it was in
3123
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3126
def preserve_input(something):
3127
"""A helper for performing test suite transformation chains.
3129
:param something: Anything you want to preserve.
3135
def randomize_suite(suite):
3136
"""Return a new TestSuite with suite's tests in random order.
3138
The tests in the input suite are flattened into a single suite in order to
3139
accomplish this. Any nested TestSuites are removed to provide global
3142
tests = list(iter_suite_tests(suite))
3143
random.shuffle(tests)
3144
return TestUtil.TestSuite(tests)
3147
def split_suite_by_condition(suite, condition):
3148
"""Split a test suite into two by a condition.
3150
:param suite: The suite to split.
3151
:param condition: The condition to match on. Tests that match this
3152
condition are returned in the first test suite, ones that do not match
3153
are in the second suite.
3154
:return: A tuple of two test suites, where the first contains tests from
3155
suite matching the condition, and the second contains the remainder
3156
from suite. The order within each output suite is the same as it was in
3161
for test in iter_suite_tests(suite):
3163
matched.append(test)
1698
return TestUtil.TestSuite(first + second)
3165
did_not_match.append(test)
3166
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3169
def split_suite_by_re(suite, pattern):
3170
"""Split a test suite into two by a regular expression.
3172
:param suite: The suite to split.
3173
:param pattern: A regular expression string. Test ids that match this
3174
pattern will be in the first test suite returned, and the others in the
3175
second test suite returned.
3176
:return: A tuple of two test suites, where the first contains tests from
3177
suite matching pattern, and the second contains the remainder from
3178
suite. The order within each output suite is the same as it was in
3181
return split_suite_by_condition(suite, condition_id_re(pattern))
1701
3184
def run_suite(suite, name='test', verbose=False, pattern=".*",
1702
stop_on_failure=False, keep_output=False,
3185
stop_on_failure=False,
1703
3186
transport=None, lsprof_timed=None, bench_history=None,
1704
matching_tests_first=None):
3187
matching_tests_first=None,
3190
exclude_pattern=None,
3193
suite_decorators=None,
3195
result_decorators=None,
3197
"""Run a test suite for bzr selftest.
3199
:param runner_class: The class of runner to use. Must support the
3200
constructor arguments passed by run_suite which are more than standard
3202
:return: A boolean indicating success.
1705
3204
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
1710
runner = TextTestRunner(stream=sys.stdout,
3209
if runner_class is None:
3210
runner_class = TextTestRunner
3213
runner = runner_class(stream=stream,
1711
3214
descriptions=0,
1712
3215
verbosity=verbosity,
1713
keep_output=keep_output,
1714
bench_history=bench_history)
3216
bench_history=bench_history,
3218
result_decorators=result_decorators,
1715
3220
runner.stop_on_failure=stop_on_failure
1717
if matching_tests_first:
1718
suite = sort_suite_by_re(suite, pattern)
1720
suite = filter_suite_by_re(suite, pattern)
3221
# built in decorator factories:
3223
random_order(random_seed, runner),
3224
exclude_tests(exclude_pattern),
3226
if matching_tests_first:
3227
decorators.append(tests_first(pattern))
3229
decorators.append(filter_tests(pattern))
3230
if suite_decorators:
3231
decorators.extend(suite_decorators)
3232
# tell the result object how many tests will be running: (except if
3233
# --parallel=fork is being used. Robert said he will provide a better
3234
# progress design later -- vila 20090817)
3235
if fork_decorator not in decorators:
3236
decorators.append(CountingDecorator)
3237
for decorator in decorators:
3238
suite = decorator(suite)
3240
# Done after test suite decoration to allow randomisation etc
3241
# to take effect, though that is of marginal benefit.
3243
stream.write("Listing tests only ...\n")
3244
for t in iter_suite_tests(suite):
3245
stream.write("%s\n" % (t.id()))
1721
3247
result = runner.run(suite)
1722
return result.wasSuccessful()
3249
return result.wasStrictlySuccessful()
3251
return result.wasSuccessful()
3254
# A registry where get() returns a suite decorator.
3255
parallel_registry = registry.Registry()
3258
def fork_decorator(suite):
3259
if getattr(os, "fork", None) is None:
3260
raise errors.BzrCommandError("platform does not support fork,"
3261
" try --parallel=subprocess instead.")
3262
concurrency = osutils.local_concurrency()
3263
if concurrency == 1:
3265
from testtools import ConcurrentTestSuite
3266
return ConcurrentTestSuite(suite, fork_for_tests)
3267
parallel_registry.register('fork', fork_decorator)
3270
def subprocess_decorator(suite):
3271
concurrency = osutils.local_concurrency()
3272
if concurrency == 1:
3274
from testtools import ConcurrentTestSuite
3275
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3276
parallel_registry.register('subprocess', subprocess_decorator)
3279
def exclude_tests(exclude_pattern):
3280
"""Return a test suite decorator that excludes tests."""
3281
if exclude_pattern is None:
3282
return identity_decorator
3283
def decorator(suite):
3284
return ExcludeDecorator(suite, exclude_pattern)
3288
def filter_tests(pattern):
3290
return identity_decorator
3291
def decorator(suite):
3292
return FilterTestsDecorator(suite, pattern)
3296
def random_order(random_seed, runner):
3297
"""Return a test suite decorator factory for randomising tests order.
3299
:param random_seed: now, a string which casts to a long, or a long.
3300
:param runner: A test runner with a stream attribute to report on.
3302
if random_seed is None:
3303
return identity_decorator
3304
def decorator(suite):
3305
return RandomDecorator(suite, random_seed, runner.stream)
3309
def tests_first(pattern):
3311
return identity_decorator
3312
def decorator(suite):
3313
return TestFirstDecorator(suite, pattern)
3317
def identity_decorator(suite):
3322
class TestDecorator(TestUtil.TestSuite):
3323
"""A decorator for TestCase/TestSuite objects.
3325
Usually, subclasses should override __iter__(used when flattening test
3326
suites), which we do to filter, reorder, parallelise and so on, run() and
3330
def __init__(self, suite):
3331
TestUtil.TestSuite.__init__(self)
3334
def countTestCases(self):
3337
cases += test.countTestCases()
3344
def run(self, result):
3345
# Use iteration on self, not self._tests, to allow subclasses to hook
3348
if result.shouldStop:
3354
class CountingDecorator(TestDecorator):
3355
"""A decorator which calls result.progress(self.countTestCases)."""
3357
def run(self, result):
3358
progress_method = getattr(result, 'progress', None)
3359
if callable(progress_method):
3360
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3361
return super(CountingDecorator, self).run(result)
3364
class ExcludeDecorator(TestDecorator):
3365
"""A decorator which excludes test matching an exclude pattern."""
3367
def __init__(self, suite, exclude_pattern):
3368
TestDecorator.__init__(self, suite)
3369
self.exclude_pattern = exclude_pattern
3370
self.excluded = False
3374
return iter(self._tests)
3375
self.excluded = True
3376
suite = exclude_tests_by_re(self, self.exclude_pattern)
3378
self.addTests(suite)
3379
return iter(self._tests)
3382
class FilterTestsDecorator(TestDecorator):
3383
"""A decorator which filters tests to those matching a pattern."""
3385
def __init__(self, suite, pattern):
3386
TestDecorator.__init__(self, suite)
3387
self.pattern = pattern
3388
self.filtered = False
3392
return iter(self._tests)
3393
self.filtered = True
3394
suite = filter_suite_by_re(self, self.pattern)
3396
self.addTests(suite)
3397
return iter(self._tests)
3400
class RandomDecorator(TestDecorator):
3401
"""A decorator which randomises the order of its tests."""
3403
def __init__(self, suite, random_seed, stream):
3404
TestDecorator.__init__(self, suite)
3405
self.random_seed = random_seed
3406
self.randomised = False
3407
self.stream = stream
3411
return iter(self._tests)
3412
self.randomised = True
3413
self.stream.write("Randomizing test order using seed %s\n\n" %
3414
(self.actual_seed()))
3415
# Initialise the random number generator.
3416
random.seed(self.actual_seed())
3417
suite = randomize_suite(self)
3419
self.addTests(suite)
3420
return iter(self._tests)
3422
def actual_seed(self):
3423
if self.random_seed == "now":
3424
# We convert the seed to a long to make it reuseable across
3425
# invocations (because the user can reenter it).
3426
self.random_seed = long(time.time())
3428
# Convert the seed to a long if we can
3430
self.random_seed = long(self.random_seed)
3433
return self.random_seed
3436
class TestFirstDecorator(TestDecorator):
3437
"""A decorator which moves named tests to the front."""
3439
def __init__(self, suite, pattern):
3440
TestDecorator.__init__(self, suite)
3441
self.pattern = pattern
3442
self.filtered = False
3446
return iter(self._tests)
3447
self.filtered = True
3448
suites = split_suite_by_re(self, self.pattern)
3450
self.addTests(suites)
3451
return iter(self._tests)
3454
def partition_tests(suite, count):
3455
"""Partition suite into count lists of tests."""
3456
# This just assigns tests in a round-robin fashion. On one hand this
3457
# splits up blocks of related tests that might run faster if they shared
3458
# resources, but on the other it avoids assigning blocks of slow tests to
3459
# just one partition. So the slowest partition shouldn't be much slower
3461
partitions = [list() for i in range(count)]
3462
tests = iter_suite_tests(suite)
3463
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3464
partition.append(test)
3468
def workaround_zealous_crypto_random():
3469
"""Crypto.Random want to help us being secure, but we don't care here.
3471
This workaround some test failure related to the sftp server. Once paramiko
3472
stop using the controversial API in Crypto.Random, we may get rid of it.
3475
from Crypto.Random import atfork
3481
def fork_for_tests(suite):
3482
"""Take suite and start up one runner per CPU by forking()
3484
:return: An iterable of TestCase-like objects which can each have
3485
run(result) called on them to feed tests to result.
3487
concurrency = osutils.local_concurrency()
3489
from subunit import TestProtocolClient, ProtocolTestCase
3490
from subunit.test_results import AutoTimingTestResultDecorator
3491
class TestInOtherProcess(ProtocolTestCase):
3492
# Should be in subunit, I think. RBC.
3493
def __init__(self, stream, pid):
3494
ProtocolTestCase.__init__(self, stream)
3497
def run(self, result):
3499
ProtocolTestCase.run(self, result)
3501
os.waitpid(self.pid, 0)
3503
test_blocks = partition_tests(suite, concurrency)
3504
for process_tests in test_blocks:
3505
process_suite = TestUtil.TestSuite()
3506
process_suite.addTests(process_tests)
3507
c2pread, c2pwrite = os.pipe()
3510
workaround_zealous_crypto_random()
3513
# Leave stderr and stdout open so we can see test noise
3514
# Close stdin so that the child goes away if it decides to
3515
# read from stdin (otherwise its a roulette to see what
3516
# child actually gets keystrokes for pdb etc).
3519
stream = os.fdopen(c2pwrite, 'wb', 1)
3520
subunit_result = AutoTimingTestResultDecorator(
3521
TestProtocolClient(stream))
3522
process_suite.run(subunit_result)
3527
stream = os.fdopen(c2pread, 'rb', 1)
3528
test = TestInOtherProcess(stream, pid)
3533
def reinvoke_for_tests(suite):
3534
"""Take suite and start up one runner per CPU using subprocess().
3536
:return: An iterable of TestCase-like objects which can each have
3537
run(result) called on them to feed tests to result.
3539
concurrency = osutils.local_concurrency()
3541
from subunit import ProtocolTestCase
3542
class TestInSubprocess(ProtocolTestCase):
3543
def __init__(self, process, name):
3544
ProtocolTestCase.__init__(self, process.stdout)
3545
self.process = process
3546
self.process.stdin.close()
3549
def run(self, result):
3551
ProtocolTestCase.run(self, result)
3554
os.unlink(self.name)
3555
# print "pid %d finished" % finished_process
3556
test_blocks = partition_tests(suite, concurrency)
3557
for process_tests in test_blocks:
3558
# ugly; currently reimplement rather than reuses TestCase methods.
3559
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3560
if not os.path.isfile(bzr_path):
3561
# We are probably installed. Assume sys.argv is the right file
3562
bzr_path = sys.argv[0]
3563
bzr_path = [bzr_path]
3564
if sys.platform == "win32":
3565
# if we're on windows, we can't execute the bzr script directly
3566
bzr_path = [sys.executable] + bzr_path
3567
fd, test_list_file_name = tempfile.mkstemp()
3568
test_list_file = os.fdopen(fd, 'wb', 1)
3569
for test in process_tests:
3570
test_list_file.write(test.id() + '\n')
3571
test_list_file.close()
3573
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3575
if '--no-plugins' in sys.argv:
3576
argv.append('--no-plugins')
3577
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3578
# noise on stderr it can interrupt the subunit protocol.
3579
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3580
stdout=subprocess.PIPE,
3581
stderr=subprocess.PIPE,
3583
test = TestInSubprocess(process, test_list_file_name)
3586
os.unlink(test_list_file_name)
3591
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3592
"""Generate profiling data for all activity between start and success.
3594
The profile data is appended to the test's _benchcalls attribute and can
3595
be accessed by the forwarded-to TestResult.
3597
While it might be cleaner do accumulate this in stopTest, addSuccess is
3598
where our existing output support for lsprof is, and this class aims to
3599
fit in with that: while it could be moved it's not necessary to accomplish
3600
test profiling, nor would it be dramatically cleaner.
3603
def startTest(self, test):
3604
self.profiler = bzrlib.lsprof.BzrProfiler()
3605
# Prevent deadlocks in tests that use lsprof: those tests will
3607
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3608
self.profiler.start()
3609
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3611
def addSuccess(self, test):
3612
stats = self.profiler.stop()
3614
calls = test._benchcalls
3615
except AttributeError:
3616
test._benchcalls = []
3617
calls = test._benchcalls
3618
calls.append(((test.id(), "", ""), stats))
3619
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3621
def stopTest(self, test):
3622
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3623
self.profiler = None
3626
# Controlled by "bzr selftest -E=..." option
3627
# Currently supported:
3628
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3629
# preserves any flags supplied at the command line.
3630
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3631
# rather than failing tests. And no longer raise
3632
# LockContention when fctnl locks are not being used
3633
# with proper exclusion rules.
3634
# -Ethreads Will display thread ident at creation/join time to
3635
# help track thread leaks
3637
# -Econfig_stats Will collect statistics using addDetail
3638
selftest_debug_flags = set()
1725
3641
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
1727
3642
transport=None,
1728
3643
test_suite_factory=None,
1729
3644
lsprof_timed=None,
1730
3645
bench_history=None,
1731
matching_tests_first=None):
3646
matching_tests_first=None,
3649
exclude_pattern=None,
3655
suite_decorators=None,
1732
3659
"""Run the whole test suite under the enhanced runner"""
1733
3660
# XXX: Very ugly way to do this...
1734
3661
# Disable warning about old formats because we don't want it to disturb
1741
3668
transport = default_transport
1742
3669
old_transport = default_transport
1743
3670
default_transport = transport
3671
global selftest_debug_flags
3672
old_debug_flags = selftest_debug_flags
3673
if debug_flags is not None:
3674
selftest_debug_flags = set(debug_flags)
3676
if load_list is None:
3679
keep_only = load_test_id_list(load_list)
3681
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3682
for start in starting_with]
1745
3683
if test_suite_factory is None:
1746
suite = test_suite()
3684
# Reduce loading time by loading modules based on the starting_with
3686
suite = test_suite(keep_only, starting_with)
1748
3688
suite = test_suite_factory()
3690
# But always filter as requested.
3691
suite = filter_suite_by_id_startswith(suite, starting_with)
3692
result_decorators = []
3694
result_decorators.append(ProfileResult)
1749
3695
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
1750
stop_on_failure=stop_on_failure, keep_output=keep_output,
3696
stop_on_failure=stop_on_failure,
1751
3697
transport=transport,
1752
3698
lsprof_timed=lsprof_timed,
1753
3699
bench_history=bench_history,
1754
matching_tests_first=matching_tests_first)
3700
matching_tests_first=matching_tests_first,
3701
list_only=list_only,
3702
random_seed=random_seed,
3703
exclude_pattern=exclude_pattern,
3705
runner_class=runner_class,
3706
suite_decorators=suite_decorators,
3708
result_decorators=result_decorators,
1756
3711
default_transport = old_transport
3712
selftest_debug_flags = old_debug_flags
3715
def load_test_id_list(file_name):
3716
"""Load a test id list from a text file.
3718
The format is one test id by line. No special care is taken to impose
3719
strict rules, these test ids are used to filter the test suite so a test id
3720
that do not match an existing test will do no harm. This allows user to add
3721
comments, leave blank lines, etc.
3725
ftest = open(file_name, 'rt')
3727
if e.errno != errno.ENOENT:
3730
raise errors.NoSuchFile(file_name)
3732
for test_name in ftest.readlines():
3733
test_list.append(test_name.strip())
3738
def suite_matches_id_list(test_suite, id_list):
3739
"""Warns about tests not appearing or appearing more than once.
3741
:param test_suite: A TestSuite object.
3742
:param test_id_list: The list of test ids that should be found in
3745
:return: (absents, duplicates) absents is a list containing the test found
3746
in id_list but not in test_suite, duplicates is a list containing the
3747
test found multiple times in test_suite.
3749
When using a prefined test id list, it may occurs that some tests do not
3750
exist anymore or that some tests use the same id. This function warns the
3751
tester about potential problems in his workflow (test lists are volatile)
3752
or in the test suite itself (using the same id for several tests does not
3753
help to localize defects).
3755
# Build a dict counting id occurrences
3757
for test in iter_suite_tests(test_suite):
3759
tests[id] = tests.get(id, 0) + 1
3764
occurs = tests.get(id, 0)
3766
not_found.append(id)
3768
duplicates.append(id)
3770
return not_found, duplicates
3773
class TestIdList(object):
3774
"""Test id list to filter a test suite.
3776
Relying on the assumption that test ids are built as:
3777
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3778
notation, this class offers methods to :
3779
- avoid building a test suite for modules not refered to in the test list,
3780
- keep only the tests listed from the module test suite.
3783
def __init__(self, test_id_list):
3784
# When a test suite needs to be filtered against us we compare test ids
3785
# for equality, so a simple dict offers a quick and simple solution.
3786
self.tests = dict().fromkeys(test_id_list, True)
3788
# While unittest.TestCase have ids like:
3789
# <module>.<class>.<method>[(<param+)],
3790
# doctest.DocTestCase can have ids like:
3793
# <module>.<function>
3794
# <module>.<class>.<method>
3796
# Since we can't predict a test class from its name only, we settle on
3797
# a simple constraint: a test id always begins with its module name.
3800
for test_id in test_id_list:
3801
parts = test_id.split('.')
3802
mod_name = parts.pop(0)
3803
modules[mod_name] = True
3805
mod_name += '.' + part
3806
modules[mod_name] = True
3807
self.modules = modules
3809
def refers_to(self, module_name):
3810
"""Is there tests for the module or one of its sub modules."""
3811
return self.modules.has_key(module_name)
3813
def includes(self, test_id):
3814
return self.tests.has_key(test_id)
3817
class TestPrefixAliasRegistry(registry.Registry):
3818
"""A registry for test prefix aliases.
3820
This helps implement shorcuts for the --starting-with selftest
3821
option. Overriding existing prefixes is not allowed but not fatal (a
3822
warning will be emitted).
3825
def register(self, key, obj, help=None, info=None,
3826
override_existing=False):
3827
"""See Registry.register.
3829
Trying to override an existing alias causes a warning to be emitted,
3830
not a fatal execption.
3833
super(TestPrefixAliasRegistry, self).register(
3834
key, obj, help=help, info=info, override_existing=False)
3836
actual = self.get(key)
3838
'Test prefix alias %s is already used for %s, ignoring %s'
3839
% (key, actual, obj))
3841
def resolve_alias(self, id_start):
3842
"""Replace the alias by the prefix in the given string.
3844
Using an unknown prefix is an error to help catching typos.
3846
parts = id_start.split('.')
3848
parts[0] = self.get(parts[0])
3850
raise errors.BzrCommandError(
3851
'%s is not a known test prefix alias' % parts[0])
3852
return '.'.join(parts)
3855
test_prefix_alias_registry = TestPrefixAliasRegistry()
3856
"""Registry of test prefix aliases."""
3859
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3860
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3861
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3863
# Obvious highest levels prefixes, feel free to add your own via a plugin
3864
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3865
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3866
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3867
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3868
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3871
def _test_suite_testmod_names():
3872
"""Return the standard list of test module names to test."""
3875
'bzrlib.tests.blackbox',
3876
'bzrlib.tests.commands',
3877
'bzrlib.tests.doc_generate',
3878
'bzrlib.tests.per_branch',
3879
'bzrlib.tests.per_bzrdir',
3880
'bzrlib.tests.per_controldir',
3881
'bzrlib.tests.per_controldir_colo',
3882
'bzrlib.tests.per_foreign_vcs',
3883
'bzrlib.tests.per_interrepository',
3884
'bzrlib.tests.per_intertree',
3885
'bzrlib.tests.per_inventory',
3886
'bzrlib.tests.per_interbranch',
3887
'bzrlib.tests.per_lock',
3888
'bzrlib.tests.per_merger',
3889
'bzrlib.tests.per_transport',
3890
'bzrlib.tests.per_tree',
3891
'bzrlib.tests.per_pack_repository',
3892
'bzrlib.tests.per_repository',
3893
'bzrlib.tests.per_repository_chk',
3894
'bzrlib.tests.per_repository_reference',
3895
'bzrlib.tests.per_repository_vf',
3896
'bzrlib.tests.per_uifactory',
3897
'bzrlib.tests.per_versionedfile',
3898
'bzrlib.tests.per_workingtree',
3899
'bzrlib.tests.test__annotator',
3900
'bzrlib.tests.test__bencode',
3901
'bzrlib.tests.test__btree_serializer',
3902
'bzrlib.tests.test__chk_map',
3903
'bzrlib.tests.test__dirstate_helpers',
3904
'bzrlib.tests.test__groupcompress',
3905
'bzrlib.tests.test__known_graph',
3906
'bzrlib.tests.test__rio',
3907
'bzrlib.tests.test__simple_set',
3908
'bzrlib.tests.test__static_tuple',
3909
'bzrlib.tests.test__walkdirs_win32',
3910
'bzrlib.tests.test_ancestry',
3911
'bzrlib.tests.test_annotate',
3912
'bzrlib.tests.test_api',
3913
'bzrlib.tests.test_atomicfile',
3914
'bzrlib.tests.test_bad_files',
3915
'bzrlib.tests.test_bisect_multi',
3916
'bzrlib.tests.test_branch',
3917
'bzrlib.tests.test_branchbuilder',
3918
'bzrlib.tests.test_btree_index',
3919
'bzrlib.tests.test_bugtracker',
3920
'bzrlib.tests.test_bundle',
3921
'bzrlib.tests.test_bzrdir',
3922
'bzrlib.tests.test__chunks_to_lines',
3923
'bzrlib.tests.test_cache_utf8',
3924
'bzrlib.tests.test_chk_map',
3925
'bzrlib.tests.test_chk_serializer',
3926
'bzrlib.tests.test_chunk_writer',
3927
'bzrlib.tests.test_clean_tree',
3928
'bzrlib.tests.test_cleanup',
3929
'bzrlib.tests.test_cmdline',
3930
'bzrlib.tests.test_commands',
3931
'bzrlib.tests.test_commit',
3932
'bzrlib.tests.test_commit_merge',
3933
'bzrlib.tests.test_config',
3934
'bzrlib.tests.test_conflicts',
3935
'bzrlib.tests.test_controldir',
3936
'bzrlib.tests.test_counted_lock',
3937
'bzrlib.tests.test_crash',
3938
'bzrlib.tests.test_decorators',
3939
'bzrlib.tests.test_delta',
3940
'bzrlib.tests.test_debug',
3941
'bzrlib.tests.test_diff',
3942
'bzrlib.tests.test_directory_service',
3943
'bzrlib.tests.test_dirstate',
3944
'bzrlib.tests.test_email_message',
3945
'bzrlib.tests.test_eol_filters',
3946
'bzrlib.tests.test_errors',
3947
'bzrlib.tests.test_export',
3948
'bzrlib.tests.test_export_pot',
3949
'bzrlib.tests.test_extract',
3950
'bzrlib.tests.test_features',
3951
'bzrlib.tests.test_fetch',
3952
'bzrlib.tests.test_fixtures',
3953
'bzrlib.tests.test_fifo_cache',
3954
'bzrlib.tests.test_filters',
3955
'bzrlib.tests.test_filter_tree',
3956
'bzrlib.tests.test_ftp_transport',
3957
'bzrlib.tests.test_foreign',
3958
'bzrlib.tests.test_generate_docs',
3959
'bzrlib.tests.test_generate_ids',
3960
'bzrlib.tests.test_globbing',
3961
'bzrlib.tests.test_gpg',
3962
'bzrlib.tests.test_graph',
3963
'bzrlib.tests.test_groupcompress',
3964
'bzrlib.tests.test_hashcache',
3965
'bzrlib.tests.test_help',
3966
'bzrlib.tests.test_hooks',
3967
'bzrlib.tests.test_http',
3968
'bzrlib.tests.test_http_response',
3969
'bzrlib.tests.test_https_ca_bundle',
3970
'bzrlib.tests.test_i18n',
3971
'bzrlib.tests.test_identitymap',
3972
'bzrlib.tests.test_ignores',
3973
'bzrlib.tests.test_index',
3974
'bzrlib.tests.test_import_tariff',
3975
'bzrlib.tests.test_info',
3976
'bzrlib.tests.test_inv',
3977
'bzrlib.tests.test_inventory_delta',
3978
'bzrlib.tests.test_knit',
3979
'bzrlib.tests.test_lazy_import',
3980
'bzrlib.tests.test_lazy_regex',
3981
'bzrlib.tests.test_library_state',
3982
'bzrlib.tests.test_lock',
3983
'bzrlib.tests.test_lockable_files',
3984
'bzrlib.tests.test_lockdir',
3985
'bzrlib.tests.test_log',
3986
'bzrlib.tests.test_lru_cache',
3987
'bzrlib.tests.test_lsprof',
3988
'bzrlib.tests.test_mail_client',
3989
'bzrlib.tests.test_matchers',
3990
'bzrlib.tests.test_memorytree',
3991
'bzrlib.tests.test_merge',
3992
'bzrlib.tests.test_merge3',
3993
'bzrlib.tests.test_merge_core',
3994
'bzrlib.tests.test_merge_directive',
3995
'bzrlib.tests.test_mergetools',
3996
'bzrlib.tests.test_missing',
3997
'bzrlib.tests.test_msgeditor',
3998
'bzrlib.tests.test_multiparent',
3999
'bzrlib.tests.test_mutabletree',
4000
'bzrlib.tests.test_nonascii',
4001
'bzrlib.tests.test_options',
4002
'bzrlib.tests.test_osutils',
4003
'bzrlib.tests.test_osutils_encodings',
4004
'bzrlib.tests.test_pack',
4005
'bzrlib.tests.test_patch',
4006
'bzrlib.tests.test_patches',
4007
'bzrlib.tests.test_permissions',
4008
'bzrlib.tests.test_plugins',
4009
'bzrlib.tests.test_progress',
4010
'bzrlib.tests.test_pyutils',
4011
'bzrlib.tests.test_read_bundle',
4012
'bzrlib.tests.test_reconcile',
4013
'bzrlib.tests.test_reconfigure',
4014
'bzrlib.tests.test_registry',
4015
'bzrlib.tests.test_remote',
4016
'bzrlib.tests.test_rename_map',
4017
'bzrlib.tests.test_repository',
4018
'bzrlib.tests.test_revert',
4019
'bzrlib.tests.test_revision',
4020
'bzrlib.tests.test_revisionspec',
4021
'bzrlib.tests.test_revisiontree',
4022
'bzrlib.tests.test_rio',
4023
'bzrlib.tests.test_rules',
4024
'bzrlib.tests.test_sampler',
4025
'bzrlib.tests.test_scenarios',
4026
'bzrlib.tests.test_script',
4027
'bzrlib.tests.test_selftest',
4028
'bzrlib.tests.test_serializer',
4029
'bzrlib.tests.test_setup',
4030
'bzrlib.tests.test_sftp_transport',
4031
'bzrlib.tests.test_shelf',
4032
'bzrlib.tests.test_shelf_ui',
4033
'bzrlib.tests.test_smart',
4034
'bzrlib.tests.test_smart_add',
4035
'bzrlib.tests.test_smart_request',
4036
'bzrlib.tests.test_smart_transport',
4037
'bzrlib.tests.test_smtp_connection',
4038
'bzrlib.tests.test_source',
4039
'bzrlib.tests.test_ssh_transport',
4040
'bzrlib.tests.test_status',
4041
'bzrlib.tests.test_store',
4042
'bzrlib.tests.test_strace',
4043
'bzrlib.tests.test_subsume',
4044
'bzrlib.tests.test_switch',
4045
'bzrlib.tests.test_symbol_versioning',
4046
'bzrlib.tests.test_tag',
4047
'bzrlib.tests.test_test_server',
4048
'bzrlib.tests.test_testament',
4049
'bzrlib.tests.test_textfile',
4050
'bzrlib.tests.test_textmerge',
4051
'bzrlib.tests.test_cethread',
4052
'bzrlib.tests.test_timestamp',
4053
'bzrlib.tests.test_trace',
4054
'bzrlib.tests.test_transactions',
4055
'bzrlib.tests.test_transform',
4056
'bzrlib.tests.test_transport',
4057
'bzrlib.tests.test_transport_log',
4058
'bzrlib.tests.test_tree',
4059
'bzrlib.tests.test_treebuilder',
4060
'bzrlib.tests.test_treeshape',
4061
'bzrlib.tests.test_tsort',
4062
'bzrlib.tests.test_tuned_gzip',
4063
'bzrlib.tests.test_ui',
4064
'bzrlib.tests.test_uncommit',
4065
'bzrlib.tests.test_upgrade',
4066
'bzrlib.tests.test_upgrade_stacked',
4067
'bzrlib.tests.test_urlutils',
4068
'bzrlib.tests.test_utextwrap',
4069
'bzrlib.tests.test_version',
4070
'bzrlib.tests.test_version_info',
4071
'bzrlib.tests.test_versionedfile',
4072
'bzrlib.tests.test_weave',
4073
'bzrlib.tests.test_whitebox',
4074
'bzrlib.tests.test_win32utils',
4075
'bzrlib.tests.test_workingtree',
4076
'bzrlib.tests.test_workingtree_4',
4077
'bzrlib.tests.test_wsgi',
4078
'bzrlib.tests.test_xml',
4082
def _test_suite_modules_to_doctest():
4083
"""Return the list of modules to doctest."""
4085
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4089
'bzrlib.branchbuilder',
4090
'bzrlib.decorators',
4092
'bzrlib.iterablefile',
4097
'bzrlib.symbol_versioning',
4099
'bzrlib.tests.fixtures',
4101
'bzrlib.transport.http',
4102
'bzrlib.version_info_formats.format_custom',
4106
def test_suite(keep_only=None, starting_with=None):
1760
4107
"""Build and return TestSuite for the whole of bzrlib.
4109
:param keep_only: A list of test ids limiting the suite returned.
4111
:param starting_with: An id limiting the suite returned to the tests
1762
4114
This function can be replaced if you need to change the default test
1763
4115
suite on a global basis, but it is not encouraged.
1766
'bzrlib.tests.test_ancestry',
1767
'bzrlib.tests.test_annotate',
1768
'bzrlib.tests.test_api',
1769
'bzrlib.tests.test_atomicfile',
1770
'bzrlib.tests.test_bad_files',
1771
'bzrlib.tests.test_branch',
1772
'bzrlib.tests.test_bundle',
1773
'bzrlib.tests.test_bzrdir',
1774
'bzrlib.tests.test_cache_utf8',
1775
'bzrlib.tests.test_commands',
1776
'bzrlib.tests.test_commit',
1777
'bzrlib.tests.test_commit_merge',
1778
'bzrlib.tests.test_config',
1779
'bzrlib.tests.test_conflicts',
1780
'bzrlib.tests.test_decorators',
1781
'bzrlib.tests.test_delta',
1782
'bzrlib.tests.test_diff',
1783
'bzrlib.tests.test_dirstate',
1784
'bzrlib.tests.test_doc_generate',
1785
'bzrlib.tests.test_errors',
1786
'bzrlib.tests.test_escaped_store',
1787
'bzrlib.tests.test_fetch',
1788
'bzrlib.tests.test_ftp_transport',
1789
'bzrlib.tests.test_generate_docs',
1790
'bzrlib.tests.test_generate_ids',
1791
'bzrlib.tests.test_globbing',
1792
'bzrlib.tests.test_gpg',
1793
'bzrlib.tests.test_graph',
1794
'bzrlib.tests.test_hashcache',
1795
'bzrlib.tests.test_http',
1796
'bzrlib.tests.test_http_response',
1797
'bzrlib.tests.test_identitymap',
1798
'bzrlib.tests.test_ignores',
1799
'bzrlib.tests.test_inv',
1800
'bzrlib.tests.test_knit',
1801
'bzrlib.tests.test_lazy_import',
1802
'bzrlib.tests.test_lazy_regex',
1803
'bzrlib.tests.test_lockdir',
1804
'bzrlib.tests.test_lockable_files',
1805
'bzrlib.tests.test_log',
1806
'bzrlib.tests.test_memorytree',
1807
'bzrlib.tests.test_merge',
1808
'bzrlib.tests.test_merge3',
1809
'bzrlib.tests.test_merge_core',
1810
'bzrlib.tests.test_missing',
1811
'bzrlib.tests.test_msgeditor',
1812
'bzrlib.tests.test_nonascii',
1813
'bzrlib.tests.test_options',
1814
'bzrlib.tests.test_osutils',
1815
'bzrlib.tests.test_osutils_encodings',
1816
'bzrlib.tests.test_patch',
1817
'bzrlib.tests.test_patches',
1818
'bzrlib.tests.test_permissions',
1819
'bzrlib.tests.test_plugins',
1820
'bzrlib.tests.test_progress',
1821
'bzrlib.tests.test_reconcile',
1822
'bzrlib.tests.test_registry',
1823
'bzrlib.tests.test_repository',
1824
'bzrlib.tests.test_revert',
1825
'bzrlib.tests.test_revision',
1826
'bzrlib.tests.test_revisionnamespaces',
1827
'bzrlib.tests.test_revisiontree',
1828
'bzrlib.tests.test_rio',
1829
'bzrlib.tests.test_sampler',
1830
'bzrlib.tests.test_selftest',
1831
'bzrlib.tests.test_setup',
1832
'bzrlib.tests.test_sftp_transport',
1833
'bzrlib.tests.test_smart_add',
1834
'bzrlib.tests.test_smart_transport',
1835
'bzrlib.tests.test_source',
1836
'bzrlib.tests.test_status',
1837
'bzrlib.tests.test_store',
1838
'bzrlib.tests.test_symbol_versioning',
1839
'bzrlib.tests.test_testament',
1840
'bzrlib.tests.test_textfile',
1841
'bzrlib.tests.test_textmerge',
1842
'bzrlib.tests.test_trace',
1843
'bzrlib.tests.test_transactions',
1844
'bzrlib.tests.test_transform',
1845
'bzrlib.tests.test_transport',
1846
'bzrlib.tests.test_tree',
1847
'bzrlib.tests.test_treebuilder',
1848
'bzrlib.tests.test_tsort',
1849
'bzrlib.tests.test_tuned_gzip',
1850
'bzrlib.tests.test_ui',
1851
'bzrlib.tests.test_upgrade',
1852
'bzrlib.tests.test_urlutils',
1853
'bzrlib.tests.test_versionedfile',
1854
'bzrlib.tests.test_version',
1855
'bzrlib.tests.test_version_info',
1856
'bzrlib.tests.test_weave',
1857
'bzrlib.tests.test_whitebox',
1858
'bzrlib.tests.test_workingtree',
1859
'bzrlib.tests.test_wsgi',
1860
'bzrlib.tests.test_xml',
1862
test_transport_implementations = [
1863
'bzrlib.tests.test_transport_implementations',
1864
'bzrlib.tests.test_read_bundle',
1866
suite = TestUtil.TestSuite()
1867
4118
loader = TestUtil.TestLoader()
1868
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1869
from bzrlib.transport import TransportTestProviderAdapter
1870
adapter = TransportTestProviderAdapter()
1871
adapt_modules(test_transport_implementations, adapter, loader, suite)
1872
for package in packages_to_test():
1873
suite.addTest(package.test_suite())
1874
for m in MODULES_TO_TEST:
1875
suite.addTest(loader.loadTestsFromModule(m))
1876
for m in MODULES_TO_DOCTEST:
4120
if keep_only is not None:
4121
id_filter = TestIdList(keep_only)
4123
# We take precedence over keep_only because *at loading time* using
4124
# both options means we will load less tests for the same final result.
4125
def interesting_module(name):
4126
for start in starting_with:
4128
# Either the module name starts with the specified string
4129
name.startswith(start)
4130
# or it may contain tests starting with the specified string
4131
or start.startswith(name)
4135
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4137
elif keep_only is not None:
4138
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4139
def interesting_module(name):
4140
return id_filter.refers_to(name)
4143
loader = TestUtil.TestLoader()
4144
def interesting_module(name):
4145
# No filtering, all modules are interesting
4148
suite = loader.suiteClass()
4150
# modules building their suite with loadTestsFromModuleNames
4151
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4153
for mod in _test_suite_modules_to_doctest():
4154
if not interesting_module(mod):
4155
# No tests to keep here, move along
1878
suite.addTest(doctest.DocTestSuite(m))
4158
# note that this really does mean "report only" -- doctest
4159
# still runs the rest of the examples
4160
doc_suite = IsolatedDocTestSuite(
4161
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
1879
4162
except ValueError, e:
1880
print '**failed to get doctest for: %s\n%s' %(m,e)
4163
print '**failed to get doctest for: %s\n%s' % (mod, e)
1882
for name, plugin in bzrlib.plugin.all_plugins().items():
1883
if getattr(plugin, 'test_suite', None) is not None:
1884
default_encoding = sys.getdefaultencoding()
1886
plugin_suite = plugin.test_suite()
1887
except ImportError, e:
1888
bzrlib.trace.warning(
1889
'Unable to test plugin "%s": %s', name, e)
1891
suite.addTest(plugin_suite)
1892
if default_encoding != sys.getdefaultencoding():
1893
bzrlib.trace.warning(
1894
'Plugin "%s" tried to reset default encoding to: %s', name,
1895
sys.getdefaultencoding())
1897
sys.setdefaultencoding(default_encoding)
4165
if len(doc_suite._tests) == 0:
4166
raise errors.BzrError("no doctests found in %s" % (mod,))
4167
suite.addTest(doc_suite)
4169
default_encoding = sys.getdefaultencoding()
4170
for name, plugin in _mod_plugin.plugins().items():
4171
if not interesting_module(plugin.module.__name__):
4173
plugin_suite = plugin.test_suite()
4174
# We used to catch ImportError here and turn it into just a warning,
4175
# but really if you don't have --no-plugins this should be a failure.
4176
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4177
if plugin_suite is None:
4178
plugin_suite = plugin.load_plugin_tests(loader)
4179
if plugin_suite is not None:
4180
suite.addTest(plugin_suite)
4181
if default_encoding != sys.getdefaultencoding():
4183
'Plugin "%s" tried to reset default encoding to: %s', name,
4184
sys.getdefaultencoding())
4186
sys.setdefaultencoding(default_encoding)
4188
if keep_only is not None:
4189
# Now that the referred modules have loaded their tests, keep only the
4191
suite = filter_suite_by_id_list(suite, id_filter)
4192
# Do some sanity checks on the id_list filtering
4193
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4195
# The tester has used both keep_only and starting_with, so he is
4196
# already aware that some tests are excluded from the list, there
4197
# is no need to tell him which.
4200
# Some tests mentioned in the list are not in the test suite. The
4201
# list may be out of date, report to the tester.
4202
for id in not_found:
4203
trace.warning('"%s" not found in the test suite', id)
4204
for id in duplicates:
4205
trace.warning('"%s" is used as an id by several tests', id)
1901
def adapt_modules(mods_list, adapter, loader, suite):
1902
"""Adapt the modules in mods_list using adapter and add to suite."""
1903
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1904
suite.addTests(adapter.adapt(test))
1907
def clean_selftest_output(root=None, quiet=False):
1908
"""Remove all selftest output directories from root directory.
1910
:param root: root directory for clean
1911
(if ommitted or None then clean current directory).
1912
:param quiet: suppress report about deleting directories
1917
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
1920
for i in os.listdir(root):
1921
if os.path.isdir(i) and re_dir.match(i):
1923
print 'delete directory:', i
4210
def multiply_scenarios(*scenarios):
4211
"""Multiply two or more iterables of scenarios.
4213
It is safe to pass scenario generators or iterators.
4215
:returns: A list of compound scenarios: the cross-product of all
4216
scenarios, with the names concatenated and the parameters
4219
return reduce(_multiply_two_scenarios, map(list, scenarios))
4222
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4223
"""Multiply two sets of scenarios.
4225
:returns: the cartesian product of the two sets of scenarios, that is
4226
a scenario for every possible combination of a left scenario and a
4230
('%s,%s' % (left_name, right_name),
4231
dict(left_dict.items() + right_dict.items()))
4232
for left_name, left_dict in scenarios_left
4233
for right_name, right_dict in scenarios_right]
4236
def multiply_tests(tests, scenarios, result):
4237
"""Multiply tests_list by scenarios into result.
4239
This is the core workhorse for test parameterisation.
4241
Typically the load_tests() method for a per-implementation test suite will
4242
call multiply_tests and return the result.
4244
:param tests: The tests to parameterise.
4245
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4246
scenario_param_dict).
4247
:param result: A TestSuite to add created tests to.
4249
This returns the passed in result TestSuite with the cross product of all
4250
the tests repeated once for each scenario. Each test is adapted by adding
4251
the scenario name at the end of its id(), and updating the test object's
4252
__dict__ with the scenario_param_dict.
4254
>>> import bzrlib.tests.test_sampler
4255
>>> r = multiply_tests(
4256
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4257
... [('one', dict(param=1)),
4258
... ('two', dict(param=2))],
4259
... TestUtil.TestSuite())
4260
>>> tests = list(iter_suite_tests(r))
4264
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4270
for test in iter_suite_tests(tests):
4271
apply_scenarios(test, scenarios, result)
4275
def apply_scenarios(test, scenarios, result):
4276
"""Apply the scenarios in scenarios to test and add to result.
4278
:param test: The test to apply scenarios to.
4279
:param scenarios: An iterable of scenarios to apply to test.
4281
:seealso: apply_scenario
4283
for scenario in scenarios:
4284
result.addTest(apply_scenario(test, scenario))
4288
def apply_scenario(test, scenario):
4289
"""Copy test and apply scenario to it.
4291
:param test: A test to adapt.
4292
:param scenario: A tuple describing the scenarion.
4293
The first element of the tuple is the new test id.
4294
The second element is a dict containing attributes to set on the
4296
:return: The adapted test.
4298
new_id = "%s(%s)" % (test.id(), scenario[0])
4299
new_test = clone_test(test, new_id)
4300
for name, value in scenario[1].items():
4301
setattr(new_test, name, value)
4305
def clone_test(test, new_id):
4306
"""Clone a test giving it a new id.
4308
:param test: The test to clone.
4309
:param new_id: The id to assign to it.
4310
:return: The new test.
4312
new_test = copy.copy(test)
4313
new_test.id = lambda: new_id
4314
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4315
# causes cloned tests to share the 'details' dict. This makes it hard to
4316
# read the test output for parameterized tests, because tracebacks will be
4317
# associated with irrelevant tests.
4319
details = new_test._TestCase__details
4320
except AttributeError:
4321
# must be a different version of testtools than expected. Do nothing.
4324
# Reset the '__details' dict.
4325
new_test._TestCase__details = {}
4329
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4331
"""Helper for permutating tests against an extension module.
4333
This is meant to be used inside a modules 'load_tests()' function. It will
4334
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4335
against both implementations. Setting 'test.module' to the appropriate
4336
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4338
:param standard_tests: A test suite to permute
4339
:param loader: A TestLoader
4340
:param py_module_name: The python path to a python module that can always
4341
be loaded, and will be considered the 'python' implementation. (eg
4342
'bzrlib._chk_map_py')
4343
:param ext_module_name: The python path to an extension module. If the
4344
module cannot be loaded, a single test will be added, which notes that
4345
the module is not available. If it can be loaded, all standard_tests
4346
will be run against that module.
4347
:return: (suite, feature) suite is a test-suite that has all the permuted
4348
tests. feature is the Feature object that can be used to determine if
4349
the module is available.
4352
from bzrlib.tests.features import ModuleAvailableFeature
4353
py_module = pyutils.get_named_object(py_module_name)
4355
('python', {'module': py_module}),
4357
suite = loader.suiteClass()
4358
feature = ModuleAvailableFeature(ext_module_name)
4359
if feature.available():
4360
scenarios.append(('C', {'module': feature.module}))
4362
# the compiled module isn't available, so we add a failing test
4363
class FailWithoutFeature(TestCase):
4364
def test_fail(self):
4365
self.requireFeature(feature)
4366
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4367
result = multiply_tests(standard_tests, scenarios, suite)
4368
return result, feature
4371
def _rmtree_temp_dir(dirname, test_id=None):
4372
# If LANG=C we probably have created some bogus paths
4373
# which rmtree(unicode) will fail to delete
4374
# so make sure we are using rmtree(str) to delete everything
4375
# except on win32, where rmtree(str) will fail
4376
# since it doesn't have the property of byte-stream paths
4377
# (they are either ascii or mbcs)
4378
if sys.platform == 'win32':
4379
# make sure we are using the unicode win32 api
4380
dirname = unicode(dirname)
4382
dirname = dirname.encode(sys.getfilesystemencoding())
4384
osutils.rmtree(dirname)
4386
# We don't want to fail here because some useful display will be lost
4387
# otherwise. Polluting the tmp dir is bad, but not giving all the
4388
# possible info to the test runner is even worse.
4390
ui.ui_factory.clear_term()
4391
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4392
# Ugly, but the last thing we want here is fail, so bear with it.
4393
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4394
).encode('ascii', 'replace')
4395
sys.stderr.write('Unable to remove testing dir %s\n%s'
4396
% (os.path.basename(dirname), printable_e))
4399
def probe_unicode_in_user_encoding():
4400
"""Try to encode several unicode strings to use in unicode-aware tests.
4401
Return first successfull match.
4403
:return: (unicode value, encoded plain string value) or (None, None)
4405
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4406
for uni_val in possible_vals:
4408
str_val = uni_val.encode(osutils.get_user_encoding())
4409
except UnicodeEncodeError:
4410
# Try a different character
4413
return uni_val, str_val
4417
def probe_bad_non_ascii(encoding):
4418
"""Try to find [bad] character with code [128..255]
4419
that cannot be decoded to unicode in some encoding.
4420
Return None if all non-ascii characters is valid
4423
for i in xrange(128, 256):
4426
char.decode(encoding)
4427
except UnicodeDecodeError:
4432
# Only define SubUnitBzrRunner if subunit is available.
4434
from subunit import TestProtocolClient
4435
from subunit.test_results import AutoTimingTestResultDecorator
4436
class SubUnitBzrProtocolClient(TestProtocolClient):
4438
def addSuccess(self, test, details=None):
4439
# The subunit client always includes the details in the subunit
4440
# stream, but we don't want to include it in ours.
4441
if details is not None and 'log' in details:
4443
return super(SubUnitBzrProtocolClient, self).addSuccess(
4446
class SubUnitBzrRunner(TextTestRunner):
4447
def run(self, test):
4448
result = AutoTimingTestResultDecorator(
4449
SubUnitBzrProtocolClient(self.stream))
4456
@deprecated_function(deprecated_in((2, 5, 0)))
4457
def ModuleAvailableFeature(name):
4458
from bzrlib.tests import features
4459
return features.ModuleAvailableFeature(name)
added
removed
bzrlib/tests/__init__.py
