31
29
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
53
# nb: check this before importing anything else from within it
54
_testtools_version = getattr(testtools, '__version__', ())
55
if _testtools_version < (0, 9, 5):
56
raise ImportError("need at least testtools 0.9.5: %s is %r"
57
% (testtools.__file__, _testtools_version))
58
from testtools import content
50
61
from bzrlib import (
65
commands as _mod_commands,
75
plugin as _mod_plugin,
82
transport as _mod_transport,
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
69
86
import bzrlib.lsprof
70
87
except ImportError:
71
88
# lsprof not available
73
from bzrlib.merge import merge_inner
77
from bzrlib.revision import common_ancestor
79
from bzrlib import symbol_versioning
90
from bzrlib.smart import client, request
91
from bzrlib.transport import (
80
95
from bzrlib.symbol_versioning import (
85
from bzrlib.transport import get_transport
86
import bzrlib.transport
87
from bzrlib.transport.local import LocalURLServer
88
from bzrlib.transport.memory import MemoryServer
89
from bzrlib.transport.readonly import ReadonlyServer
90
from bzrlib.trace import mutter, note
91
from bzrlib.tests import TestUtil
92
from bzrlib.tests.HttpServer import HttpServer
93
from bzrlib.tests.TestUtil import (
97
from bzrlib.tests.treeshape import build_tree_contents
98
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
99
from bzrlib.tests import (
105
from bzrlib.ui import NullProgressView
106
from bzrlib.ui.text import TextUIFactory
107
from bzrlib.tests.features import _CompatabilityThunkFeature
100
109
# Mark this python module as being part of the implementation
101
110
# of unittest: this gives us better tracebacks where the last
102
111
# shown frame is the test code, not our assertXYZ.
105
default_transport = LocalURLServer
108
MODULES_TO_DOCTEST = [
121
def packages_to_test():
122
"""Return a list of packages to test.
124
The packages are not globally imported so that import failures are
125
triggered when running selftest, not when importing the command.
128
import bzrlib.tests.blackbox
129
import bzrlib.tests.branch_implementations
130
import bzrlib.tests.bzrdir_implementations
131
import bzrlib.tests.commands
132
import bzrlib.tests.interrepository_implementations
133
import bzrlib.tests.interversionedfile_implementations
134
import bzrlib.tests.intertree_implementations
135
import bzrlib.tests.per_lock
136
import bzrlib.tests.repository_implementations
137
import bzrlib.tests.revisionstore_implementations
138
import bzrlib.tests.tree_implementations
139
import bzrlib.tests.workingtree_implementations
142
bzrlib.tests.blackbox,
143
bzrlib.tests.branch_implementations,
144
bzrlib.tests.bzrdir_implementations,
145
bzrlib.tests.commands,
146
bzrlib.tests.interrepository_implementations,
147
bzrlib.tests.interversionedfile_implementations,
148
bzrlib.tests.intertree_implementations,
149
bzrlib.tests.per_lock,
150
bzrlib.tests.repository_implementations,
151
bzrlib.tests.revisionstore_implementations,
152
bzrlib.tests.tree_implementations,
153
bzrlib.tests.workingtree_implementations,
157
class ExtendedTestResult(unittest._TextTestResult):
114
default_transport = test_server.LocalURLServer
117
_unitialized_attr = object()
118
"""A sentinel needed to act as a default value in a method signature."""
121
# Subunit result codes, defined here to prevent a hard dependency on subunit.
125
# These are intentionally brought into this namespace. That way plugins, etc
126
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
127
TestSuite = TestUtil.TestSuite
128
TestLoader = TestUtil.TestLoader
130
# Tests should run in a clean and clearly defined environment. The goal is to
131
# keep them isolated from the running environment as mush as possible. The test
132
# framework ensures the variables defined below are set (or deleted if the
133
# value is None) before a test is run and reset to their original value after
134
# the test is run. Generally if some code depends on an environment variable,
135
# the tests should start without this variable in the environment. There are a
136
# few exceptions but you shouldn't violate this rule lightly.
140
'XDG_CONFIG_HOME': None,
141
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
142
# tests do check our impls match APPDATA
143
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
147
'BZREMAIL': None, # may still be present in the environment
148
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
149
'BZR_PROGRESS_BAR': None,
150
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
151
# as a base class instead of TestCaseInTempDir. Tests inheriting from
152
# TestCase should not use disk resources, BZR_LOG is one.
153
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
154
'BZR_PLUGIN_PATH': None,
155
'BZR_DISABLE_PLUGINS': None,
156
'BZR_PLUGINS_AT': None,
157
'BZR_CONCURRENCY': None,
158
# Make sure that any text ui tests are consistent regardless of
159
# the environment the test case is run in; you may want tests that
160
# test other combinations. 'dumb' is a reasonable guess for tests
161
# going to a pipe or a StringIO.
167
'SSH_AUTH_SOCK': None,
177
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
178
# least. If you do (care), please update this comment
182
'BZR_REMOTE_PATH': None,
183
# Generally speaking, we don't want apport reporting on crashes in
184
# the test envirnoment unless we're specifically testing apport,
185
# so that it doesn't leak into the real system environment. We
186
# use an env var so it propagates to subprocesses.
187
'APPORT_DISABLE': '1',
191
def override_os_environ(test, env=None):
192
"""Modify os.environ keeping a copy.
194
:param test: A test instance
196
:param env: A dict containing variable definitions to be installed
199
env = isolated_environ
200
test._original_os_environ = dict([(var, value)
201
for var, value in os.environ.iteritems()])
202
for var, value in env.iteritems():
203
osutils.set_or_unset_env(var, value)
204
if var not in test._original_os_environ:
205
# The var is new, add it with a value of None, so
206
# restore_os_environ will delete it
207
test._original_os_environ[var] = None
210
def restore_os_environ(test):
211
"""Restore os.environ to its original state.
213
:param test: A test instance previously passed to override_os_environ.
215
for var, value in test._original_os_environ.iteritems():
216
# Restore the original value (or delete it if the value has been set to
217
# None in override_os_environ).
218
osutils.set_or_unset_env(var, value)
221
def _clear__type_equality_funcs(test):
222
"""Cleanup bound methods stored on TestCase instances
224
Clear the dict breaking a few (mostly) harmless cycles in the affected
225
unittests released with Python 2.6 and initial Python 2.7 versions.
227
For a few revisions between Python 2.7.1 and Python 2.7.2 that annoyingly
228
shipped in Oneiric, an object with no clear method was used, hence the
229
extra complications, see bug 809048 for details.
231
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
232
if type_equality_funcs is not None:
233
tef_clear = getattr(type_equality_funcs, "clear", None)
234
if tef_clear is None:
235
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
236
if tef_instance_dict is not None:
237
tef_clear = tef_instance_dict.clear
238
if tef_clear is not None:
242
class ExtendedTestResult(testtools.TextTestResult):
158
243
"""Accepts, reports and accumulates the results of running tests.
160
Compared to this unittest version this class adds support for profiling,
161
benchmarking, stopping as soon as a test fails, and skipping tests.
162
There are further-specialized subclasses for different types of display.
245
Compared to the unittest version this class adds support for
246
profiling, benchmarking, stopping as soon as a test fails, and
247
skipping tests. There are further-specialized subclasses for
248
different types of display.
250
When a test finishes, in whatever way, it calls one of the addSuccess,
251
addFailure or addError methods. These in turn may redirect to a more
252
specific case for the special test results supported by our extended
255
Note that just one of these objects is fed the results from many tests.
165
258
stop_early = False
167
260
def __init__(self, stream, descriptions, verbosity,
168
261
bench_history=None,
171
264
"""Construct new TestResult.
173
266
:param bench_history: Optionally, a writable file object to accumulate
174
267
benchmark results.
176
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
269
testtools.TextTestResult.__init__(self, stream)
177
270
if bench_history is not None:
178
271
from bzrlib.version import _get_bzr_source_tree
179
272
src_tree = _get_bzr_source_tree()
224
380
def _shortened_test_description(self, test):
226
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
382
what = re.sub(r'^bzrlib\.tests\.', '', what)
385
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
386
# multiple times in a row, because the handler is added for
387
# each test but the container list is shared between cases.
388
# See lp:498869 lp:625574 and lp:637725 for background.
389
def _record_traceback_from_test(self, exc_info):
390
"""Store the traceback from passed exc_info tuple till"""
391
self._traceback_from_test = exc_info[2]
229
393
def startTest(self, test):
230
unittest.TestResult.startTest(self, test)
394
super(ExtendedTestResult, self).startTest(test)
231
398
self.report_test_start(test)
232
399
test.number = self.count
233
400
self._recordTestStartTime()
401
# Make testtools cases give us the real traceback on failure
402
addOnException = getattr(test, "addOnException", None)
403
if addOnException is not None:
404
addOnException(self._record_traceback_from_test)
405
# Only check for thread leaks on bzrlib derived test cases
406
if isinstance(test, TestCase):
407
test.addCleanup(self._check_leaked_threads, test)
409
def stopTest(self, test):
410
super(ExtendedTestResult, self).stopTest(test)
411
# Manually break cycles, means touching various private things but hey
412
getDetails = getattr(test, "getDetails", None)
413
if getDetails is not None:
415
_clear__type_equality_funcs(test)
416
self._traceback_from_test = None
418
def startTests(self):
419
self.report_tests_starting()
420
self._active_threads = threading.enumerate()
422
def _check_leaked_threads(self, test):
423
"""See if any threads have leaked since last call
425
A sample of live threads is stored in the _active_threads attribute,
426
when this method runs it compares the current live threads and any not
427
in the previous sample are treated as having leaked.
429
now_active_threads = set(threading.enumerate())
430
threads_leaked = now_active_threads.difference(self._active_threads)
432
self._report_thread_leak(test, threads_leaked, now_active_threads)
433
self._tests_leaking_threads_count += 1
434
if self._first_thread_leaker_id is None:
435
self._first_thread_leaker_id = test.id()
436
self._active_threads = now_active_threads
235
438
def _recordTestStartTime(self):
236
439
"""Record that a test has started."""
237
self._start_time = time.time()
239
def _cleanupLogFile(self, test):
240
# We can only do this if we have one of our TestCases, not if
242
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
243
if setKeepLogfile is not None:
440
self._start_datetime = self._now()
246
442
def addError(self, test, err):
247
self.extractBenchmarkTime(test)
248
self._cleanupLogFile(test)
249
if isinstance(err[1], TestSkipped):
250
return self.addSkipped(test, err)
251
elif isinstance(err[1], UnavailableFeature):
252
return self.addNotSupported(test, err[1].args[0])
253
unittest.TestResult.addError(self, test, err)
443
"""Tell result that test finished with an error.
445
Called from the TestCase run() method when the test
446
fails with an unexpected error.
448
self._post_mortem(self._traceback_from_test)
449
super(ExtendedTestResult, self).addError(test, err)
254
450
self.error_count += 1
255
451
self.report_error(test, err)
256
452
if self.stop_early:
259
455
def addFailure(self, test, err):
260
self._cleanupLogFile(test)
261
self.extractBenchmarkTime(test)
262
if isinstance(err[1], KnownFailure):
263
return self.addKnownFailure(test, err)
264
unittest.TestResult.addFailure(self, test, err)
456
"""Tell result that test failed.
458
Called from the TestCase run() method when the test
459
fails because e.g. an assert() method failed.
461
self._post_mortem(self._traceback_from_test)
462
super(ExtendedTestResult, self).addFailure(test, err)
265
463
self.failure_count += 1
266
464
self.report_failure(test, err)
267
465
if self.stop_early:
270
def addKnownFailure(self, test, err):
468
def addSuccess(self, test, details=None):
469
"""Tell result that test completed successfully.
471
Called from the TestCase run()
473
if self._bench_history is not None:
474
benchmark_time = self._extractBenchmarkTime(test, details)
475
if benchmark_time is not None:
476
self._bench_history.write("%s %s\n" % (
477
self._formatTime(benchmark_time),
479
self.report_success(test)
480
super(ExtendedTestResult, self).addSuccess(test)
481
test._log_contents = ''
483
def addExpectedFailure(self, test, err):
271
484
self.known_failure_count += 1
272
485
self.report_known_failure(test, err)
487
def addUnexpectedSuccess(self, test, details=None):
488
"""Tell result the test unexpectedly passed, counting as a failure
490
When the minimum version of testtools required becomes 0.9.8 this
491
can be updated to use the new handling there.
493
super(ExtendedTestResult, self).addFailure(test, details=details)
494
self.failure_count += 1
495
self.report_unexpected_success(test,
496
"".join(details["reason"].iter_text()))
274
500
def addNotSupported(self, test, feature):
501
"""The test will not be run because of a missing feature.
503
# this can be called in two different ways: it may be that the
504
# test started running, and then raised (through requireFeature)
505
# UnavailableFeature. Alternatively this method can be called
506
# while probing for features before running the test code proper; in
507
# that case we will see startTest and stopTest, but the test will
508
# never actually run.
275
509
self.unsupported.setdefault(str(feature), 0)
276
510
self.unsupported[str(feature)] += 1
277
511
self.report_unsupported(test, feature)
279
def addSuccess(self, test):
280
self.extractBenchmarkTime(test)
281
if self._bench_history is not None:
282
if self._benchmarkTime is not None:
283
self._bench_history.write("%s %s\n" % (
284
self._formatTime(self._benchmarkTime),
286
self.report_success(test)
287
unittest.TestResult.addSuccess(self, test)
289
def addSkipped(self, test, skip_excinfo):
290
self.report_skip(test, skip_excinfo)
291
# seems best to treat this as success from point-of-view of unittest
292
# -- it actually does nothing so it barely matters :)
295
except KeyboardInterrupt:
298
self.addError(test, test.__exc_info())
300
unittest.TestResult.addSuccess(self, test)
302
def printErrorList(self, flavour, errors):
303
for test, err in errors:
304
self.stream.writeln(self.separator1)
305
self.stream.write("%s: " % flavour)
306
self.stream.writeln(self.getDescription(test))
307
if getattr(test, '_get_log', None) is not None:
309
print >>self.stream, \
310
('vvvv[log from %s]' % test.id()).ljust(78,'-')
311
print >>self.stream, test._get_log()
312
print >>self.stream, \
313
('^^^^[log from %s]' % test.id()).ljust(78,'-')
314
self.stream.writeln(self.separator2)
315
self.stream.writeln("%s" % err)
320
def report_cleaning_up(self):
513
def addSkip(self, test, reason):
514
"""A test has not run for 'reason'."""
516
self.report_skip(test, reason)
518
def addNotApplicable(self, test, reason):
519
self.not_applicable_count += 1
520
self.report_not_applicable(test, reason)
522
def _count_stored_tests(self):
523
"""Count of tests instances kept alive due to not succeeding"""
524
return self.error_count + self.failure_count + self.known_failure_count
526
def _post_mortem(self, tb=None):
527
"""Start a PDB post mortem session."""
528
if os.environ.get('BZR_TEST_PDB', None):
532
def progress(self, offset, whence):
533
"""The test is adjusting the count of tests to run."""
534
if whence == SUBUNIT_SEEK_SET:
535
self.num_tests = offset
536
elif whence == SUBUNIT_SEEK_CUR:
537
self.num_tests += offset
539
raise errors.BzrError("Unknown whence %r" % whence)
541
def report_tests_starting(self):
542
"""Display information before the test run begins"""
543
if getattr(sys, 'frozen', None) is None:
544
bzr_path = osutils.realpath(sys.argv[0])
546
bzr_path = sys.executable
548
'bzr selftest: %s\n' % (bzr_path,))
551
bzrlib.__path__[0],))
553
' bzr-%s python-%s %s\n' % (
554
bzrlib.version_string,
555
bzrlib._format_version_tuple(sys.version_info),
556
platform.platform(aliased=1),
558
self.stream.write('\n')
560
def report_test_start(self, test):
561
"""Display information on the test just about to be run"""
563
def _report_thread_leak(self, test, leaked_threads, active_threads):
564
"""Display information on a test that leaked one or more threads"""
565
# GZ 2010-09-09: A leak summary reported separately from the general
566
# thread debugging would be nice. Tests under subunit
567
# need something not using stream, perhaps adding a
568
# testtools details object would be fitting.
569
if 'threads' in selftest_debug_flags:
570
self.stream.write('%s is leaking, active is now %d\n' %
571
(test.id(), len(active_threads)))
573
def startTestRun(self):
574
self.startTime = time.time()
323
576
def report_success(self, test):
579
def wasStrictlySuccessful(self):
580
if self.unsupported or self.known_failure_count:
582
return self.wasSuccessful()
327
585
class TextTestResult(ExtendedTestResult):
328
586
"""Displays progress and results of tests in text form"""
330
588
def __init__(self, stream, descriptions, verbosity,
331
589
bench_history=None,
335
593
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
336
bench_history, num_tests)
338
self.pb = self.ui.nested_progress_bar()
339
self._supplied_pb = False
342
self._supplied_pb = True
594
bench_history, strict)
595
# We no longer pass them around, but just rely on the UIFactory stack
598
warnings.warn("Passing pb to TextTestResult is deprecated")
599
self.pb = self.ui.nested_progress_bar()
343
600
self.pb.show_pct = False
344
601
self.pb.show_spinner = False
345
602
self.pb.show_eta = False,
346
603
self.pb.show_count = False
347
604
self.pb.show_bar = False
349
def report_starting(self):
350
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
605
self.pb.update_latency = 0
606
self.pb.show_transport_activity = False
608
def stopTestRun(self):
609
# called when the tests that are going to run have run
612
super(TextTestResult, self).stopTestRun()
614
def report_tests_starting(self):
615
super(TextTestResult, self).report_tests_starting()
616
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
352
618
def _progress_prefix_text(self):
353
a = '[%d' % self.count
354
if self.num_tests is not None:
619
# the longer this text, the less space we have to show the test
621
a = '[%d' % self.count # total that have been run
622
# tests skipped as known not to be relevant are not important enough
624
## if self.skip_count:
625
## a += ', %d skip' % self.skip_count
626
## if self.known_failure_count:
627
## a += '+%dX' % self.known_failure_count
355
629
a +='/%d' % self.num_tests
356
a += ' in %ds' % (time.time() - self._overall_start_time)
358
a += ', %d errors' % self.error_count
359
if self.failure_count:
360
a += ', %d failed' % self.failure_count
361
if self.known_failure_count:
362
a += ', %d known failures' % self.known_failure_count
364
a += ', %d skipped' % self.skip_count
366
a += ', %d missing features' % len(self.unsupported)
631
runtime = time.time() - self._overall_start_time
633
a += '%dm%ds' % (runtime / 60, runtime % 60)
636
total_fail_count = self.error_count + self.failure_count
638
a += ', %d failed' % total_fail_count
639
# if self.unsupported:
640
# a += ', %d missing' % len(self.unsupported)
370
644
def report_test_start(self, test):
373
646
self._progress_prefix_text()
375
648
+ self._shortened_test_description(test))
377
650
def _test_description(self, test):
378
651
return self._shortened_test_description(test)
380
653
def report_error(self, test, err):
381
self.pb.note('ERROR: %s\n %s\n',
654
self.stream.write('ERROR: %s\n %s\n' % (
382
655
self._test_description(test),
386
659
def report_failure(self, test, err):
387
self.pb.note('FAIL: %s\n %s\n',
660
self.stream.write('FAIL: %s\n %s\n' % (
388
661
self._test_description(test),
392
665
def report_known_failure(self, test, err):
393
self.pb.note('XFAIL: %s\n%s\n',
394
self._test_description(test), err[1])
396
def report_skip(self, test, skip_excinfo):
399
# at the moment these are mostly not things we can fix
400
# and so they just produce stipple; use the verbose reporter
403
# show test and reason for skip
404
self.pb.note('SKIP: %s\n %s\n',
405
self._shortened_test_description(test),
408
# since the class name was left behind in the still-visible
410
self.pb.note('SKIP: %s', skip_excinfo[1])
668
def report_unexpected_success(self, test, reason):
669
self.stream.write('FAIL: %s\n %s: %s\n' % (
670
self._test_description(test),
671
"Unexpected success. Should have failed",
675
def report_skip(self, test, reason):
678
def report_not_applicable(self, test, reason):
412
681
def report_unsupported(self, test, feature):
413
682
"""test cannot be run because feature is missing."""
415
def report_cleaning_up(self):
416
self.pb.update('cleaning up...')
419
if not self._supplied_pb:
423
685
class VerboseTestResult(ExtendedTestResult):
706
976
retrieved by _get_log(). We use a real OS file, not an in-memory object,
707
977
so that it can also capture file IO. When the test completes this file
708
978
is read into memory and removed from disk.
710
980
There are also convenience functions to invoke bzr's command-line
711
981
routine, and to build and check bzr trees.
713
983
In addition to the usual method of overriding tearDown(), this class also
714
allows subclasses to register functions into the _cleanups list, which is
984
allows subclasses to register cleanup functions via addCleanup, which are
715
985
run in order as the object is torn down. It's less likely this will be
716
986
accidentally overlooked.
719
_log_file_name = None
721
_keep_log_file = False
722
990
# record lsprof data when performing benchmark calls.
723
991
_gather_lsprof_in_benchmarks = False
725
993
def __init__(self, methodName='testMethod'):
726
994
super(TestCase, self).__init__(methodName)
995
self._directory_isolation = True
996
self.exception_handlers.insert(0,
997
(UnavailableFeature, self._do_unsupported_or_skip))
998
self.exception_handlers.insert(0,
999
(TestNotApplicable, self._do_not_applicable))
729
1001
def setUp(self):
730
unittest.TestCase.setUp(self)
1002
super(TestCase, self).setUp()
1004
# At this point we're still accessing the config files in $BZR_HOME (as
1005
# set by the user running selftest).
1006
timeout = config.GlobalStack().get('selftest.timeout')
1008
timeout_fixture = fixtures.TimeoutFixture(timeout)
1009
timeout_fixture.setUp()
1010
self.addCleanup(timeout_fixture.cleanUp)
1012
for feature in getattr(self, '_test_needs_features', []):
1013
self.requireFeature(feature)
731
1014
self._cleanEnvironment()
732
bzrlib.trace.disable_default_logging()
1016
if bzrlib.global_state is not None:
1017
self.overrideAttr(bzrlib.global_state, 'cmdline_overrides',
1018
config.CommandLineStore())
733
1020
self._silenceUI()
734
1021
self._startLogFile()
735
1022
self._benchcalls = []
736
1023
self._benchtime = None
737
1024
self._clear_hooks()
1025
self._track_transports()
738
1027
self._clear_debug_flags()
1028
# Isolate global verbosity level, to make sure it's reproducible
1029
# between tests. We should get rid of this altogether: bug 656694. --
1031
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
1032
self._log_files = set()
1033
# Each key in the ``_counters`` dict holds a value for a different
1034
# counter. When the test ends, addDetail() should be used to output the
1035
# counter values. This happens in install_counter_hook().
1037
if 'config_stats' in selftest_debug_flags:
1038
self._install_config_stats_hooks()
1039
# Do not use i18n for tests (unless the test reverses this)
1045
# The sys preserved stdin/stdout should allow blackbox tests debugging
1046
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
1047
).set_trace(sys._getframe().f_back)
1049
def discardDetail(self, name):
1050
"""Extend the addDetail, getDetails api so we can remove a detail.
1052
eg. bzr always adds the 'log' detail at startup, but we don't want to
1053
include it for skipped, xfail, etc tests.
1055
It is safe to call this for a detail that doesn't exist, in case this
1056
gets called multiple times.
1058
# We cheat. details is stored in __details which means we shouldn't
1059
# touch it. but getDetails() returns the dict directly, so we can
1061
details = self.getDetails()
1065
def install_counter_hook(self, hooks, name, counter_name=None):
1066
"""Install a counting hook.
1068
Any hook can be counted as long as it doesn't need to return a value.
1070
:param hooks: Where the hook should be installed.
1072
:param name: The hook name that will be counted.
1074
:param counter_name: The counter identifier in ``_counters``, defaults
1077
_counters = self._counters # Avoid closing over self
1078
if counter_name is None:
1080
if _counters.has_key(counter_name):
1081
raise AssertionError('%s is already used as a counter name'
1083
_counters[counter_name] = 0
1084
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1085
lambda: ['%d' % (_counters[counter_name],)]))
1086
def increment_counter(*args, **kwargs):
1087
_counters[counter_name] += 1
1088
label = 'count %s calls' % (counter_name,)
1089
hooks.install_named_hook(name, increment_counter, label)
1090
self.addCleanup(hooks.uninstall_named_hook, name, label)
1092
def _install_config_stats_hooks(self):
1093
"""Install config hooks to count hook calls.
1096
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1097
self.install_counter_hook(config.ConfigHooks, hook_name,
1098
'config.%s' % (hook_name,))
1100
# The OldConfigHooks are private and need special handling to protect
1101
# against recursive tests (tests that run other tests), so we just do
1102
# manually what registering them into _builtin_known_hooks will provide
1104
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1105
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1106
self.install_counter_hook(config.OldConfigHooks, hook_name,
1107
'old_config.%s' % (hook_name,))
740
1109
def _clear_debug_flags(self):
741
1110
"""Prevent externally set debug flags affecting tests.
743
1112
Tests that want to use debug flags can just set them in the
744
1113
debug_flags set during setup/teardown.
746
self._preserved_debug_flags = set(debug.debug_flags)
747
debug.debug_flags.clear()
748
self.addCleanup(self._restore_debug_flags)
1115
# Start with a copy of the current debug flags we can safely modify.
1116
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1117
if 'allow_debug' not in selftest_debug_flags:
1118
debug.debug_flags.clear()
1119
if 'disable_lock_checks' not in selftest_debug_flags:
1120
debug.debug_flags.add('strict_locks')
750
1122
def _clear_hooks(self):
751
1123
# prevent hooks affecting tests
753
import bzrlib.smart.server
754
self._preserved_hooks = {
755
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
756
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
1124
known_hooks = hooks.known_hooks
1125
self._preserved_hooks = {}
1126
for key, (parent, name) in known_hooks.iter_parent_objects():
1127
current_hooks = getattr(parent, name)
1128
self._preserved_hooks[parent] = (name, current_hooks)
1129
self._preserved_lazy_hooks = hooks._lazy_hooks
1130
hooks._lazy_hooks = {}
758
1131
self.addCleanup(self._restoreHooks)
759
# reset all hooks to an empty instance of the appropriate type
760
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
761
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
1132
for key, (parent, name) in known_hooks.iter_parent_objects():
1133
factory = known_hooks.get(key)
1134
setattr(parent, name, factory())
1135
# this hook should always be installed
1136
request._install_hook()
1138
def disable_directory_isolation(self):
1139
"""Turn off directory isolation checks."""
1140
self._directory_isolation = False
1142
def enable_directory_isolation(self):
1143
"""Enable directory isolation checks."""
1144
self._directory_isolation = True
763
1146
def _silenceUI(self):
764
1147
"""Turn off UI for duration of test"""
765
1148
# by default the UI is off; tests can turn it on if they want it.
766
saved = ui.ui_factory
768
ui.ui_factory = saved
769
ui.ui_factory = ui.SilentUIFactory()
770
self.addCleanup(_restore)
1149
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1151
def _check_locks(self):
1152
"""Check that all lock take/release actions have been paired."""
1153
# We always check for mismatched locks. If a mismatch is found, we
1154
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1155
# case we just print a warning.
1157
acquired_locks = [lock for action, lock in self._lock_actions
1158
if action == 'acquired']
1159
released_locks = [lock for action, lock in self._lock_actions
1160
if action == 'released']
1161
broken_locks = [lock for action, lock in self._lock_actions
1162
if action == 'broken']
1163
# trivially, given the tests for lock acquistion and release, if we
1164
# have as many in each list, it should be ok. Some lock tests also
1165
# break some locks on purpose and should be taken into account by
1166
# considering that breaking a lock is just a dirty way of releasing it.
1167
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1169
'Different number of acquired and '
1170
'released or broken locks.\n'
1174
(acquired_locks, released_locks, broken_locks))
1175
if not self._lock_check_thorough:
1176
# Rather than fail, just warn
1177
print "Broken test %s: %s" % (self, message)
1181
def _track_locks(self):
1182
"""Track lock activity during tests."""
1183
self._lock_actions = []
1184
if 'disable_lock_checks' in selftest_debug_flags:
1185
self._lock_check_thorough = False
1187
self._lock_check_thorough = True
1189
self.addCleanup(self._check_locks)
1190
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1191
self._lock_acquired, None)
1192
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1193
self._lock_released, None)
1194
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1195
self._lock_broken, None)
1197
def _lock_acquired(self, result):
1198
self._lock_actions.append(('acquired', result))
1200
def _lock_released(self, result):
1201
self._lock_actions.append(('released', result))
1203
def _lock_broken(self, result):
1204
self._lock_actions.append(('broken', result))
1206
def permit_dir(self, name):
1207
"""Permit a directory to be used by this test. See permit_url."""
1208
name_transport = _mod_transport.get_transport_from_path(name)
1209
self.permit_url(name)
1210
self.permit_url(name_transport.base)
1212
def permit_url(self, url):
1213
"""Declare that url is an ok url to use in this test.
1215
Do this for memory transports, temporary test directory etc.
1217
Do not do this for the current working directory, /tmp, or any other
1218
preexisting non isolated url.
1220
if not url.endswith('/'):
1222
self._bzr_selftest_roots.append(url)
1224
def permit_source_tree_branch_repo(self):
1225
"""Permit the source tree bzr is running from to be opened.
1227
Some code such as bzrlib.version attempts to read from the bzr branch
1228
that bzr is executing from (if any). This method permits that directory
1229
to be used in the test suite.
1231
path = self.get_source_path()
1232
self.record_directory_isolation()
1235
workingtree.WorkingTree.open(path)
1236
except (errors.NotBranchError, errors.NoWorkingTree):
1237
raise TestSkipped('Needs a working tree of bzr sources')
1239
self.enable_directory_isolation()
1241
def _preopen_isolate_transport(self, transport):
1242
"""Check that all transport openings are done in the test work area."""
1243
while isinstance(transport, pathfilter.PathFilteringTransport):
1244
# Unwrap pathfiltered transports
1245
transport = transport.server.backing_transport.clone(
1246
transport._filter('.'))
1247
url = transport.base
1248
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1249
# urls it is given by prepending readonly+. This is appropriate as the
1250
# client shouldn't know that the server is readonly (or not readonly).
1251
# We could register all servers twice, with readonly+ prepending, but
1252
# that makes for a long list; this is about the same but easier to
1254
if url.startswith('readonly+'):
1255
url = url[len('readonly+'):]
1256
self._preopen_isolate_url(url)
1258
def _preopen_isolate_url(self, url):
1259
if not self._directory_isolation:
1261
if self._directory_isolation == 'record':
1262
self._bzr_selftest_roots.append(url)
1264
# This prevents all transports, including e.g. sftp ones backed on disk
1265
# from working unless they are explicitly granted permission. We then
1266
# depend on the code that sets up test transports to check that they are
1267
# appropriately isolated and enable their use by calling
1268
# self.permit_transport()
1269
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1270
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1271
% (url, self._bzr_selftest_roots))
1273
def record_directory_isolation(self):
1274
"""Gather accessed directories to permit later access.
1276
This is used for tests that access the branch bzr is running from.
1278
self._directory_isolation = "record"
1280
def start_server(self, transport_server, backing_server=None):
1281
"""Start transport_server for this test.
1283
This starts the server, registers a cleanup for it and permits the
1284
server's urls to be used.
1286
if backing_server is None:
1287
transport_server.start_server()
1289
transport_server.start_server(backing_server)
1290
self.addCleanup(transport_server.stop_server)
1291
# Obtain a real transport because if the server supplies a password, it
1292
# will be hidden from the base on the client side.
1293
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1294
# Some transport servers effectively chroot the backing transport;
1295
# others like SFTPServer don't - users of the transport can walk up the
1296
# transport to read the entire backing transport. This wouldn't matter
1297
# except that the workdir tests are given - and that they expect the
1298
# server's url to point at - is one directory under the safety net. So
1299
# Branch operations into the transport will attempt to walk up one
1300
# directory. Chrooting all servers would avoid this but also mean that
1301
# we wouldn't be testing directly against non-root urls. Alternatively
1302
# getting the test framework to start the server with a backing server
1303
# at the actual safety net directory would work too, but this then
1304
# means that the self.get_url/self.get_transport methods would need
1305
# to transform all their results. On balance its cleaner to handle it
1306
# here, and permit a higher url when we have one of these transports.
1307
if t.base.endswith('/work/'):
1308
# we have safety net/test root/work
1309
t = t.clone('../..')
1310
elif isinstance(transport_server,
1311
test_server.SmartTCPServer_for_testing):
1312
# The smart server adds a path similar to work, which is traversed
1313
# up from by the client. But the server is chrooted - the actual
1314
# backing transport is not escaped from, and VFS requests to the
1315
# root will error (because they try to escape the chroot).
1317
while t2.base != t.base:
1320
self.permit_url(t.base)
1322
def _track_transports(self):
1323
"""Install checks for transport usage."""
1324
# TestCase has no safe place it can write to.
1325
self._bzr_selftest_roots = []
1326
# Currently the easiest way to be sure that nothing is going on is to
1327
# hook into bzr dir opening. This leaves a small window of error for
1328
# transport tests, but they are well known, and we can improve on this
1330
controldir.ControlDir.hooks.install_named_hook("pre_open",
1331
self._preopen_isolate_transport, "Check bzr directories are safe.")
772
1333
def _ndiff_strings(self, a, b):
773
1334
"""Return ndiff between two strings containing lines.
775
1336
A trailing newline is added if missing to make the strings
776
1337
print properly."""
777
1338
if b and b[-1] != '\n':
1021
1677
self.assertEqual(expected_first_warning, call_warnings[0])
1680
def callCatchWarnings(self, fn, *args, **kw):
1681
"""Call a callable that raises python warnings.
1683
The caller's responsible for examining the returned warnings.
1685
If the callable raises an exception, the exception is not
1686
caught and propagates up to the caller. In that case, the list
1687
of warnings is not available.
1689
:returns: ([warning_object, ...], fn_result)
1691
# XXX: This is not perfect, because it completely overrides the
1692
# warnings filters, and some code may depend on suppressing particular
1693
# warnings. It's the easiest way to insulate ourselves from -Werror,
1694
# though. -- Andrew, 20071062
1696
def _catcher(message, category, filename, lineno, file=None, line=None):
1697
# despite the name, 'message' is normally(?) a Warning subclass
1699
wlist.append(message)
1700
saved_showwarning = warnings.showwarning
1701
saved_filters = warnings.filters
1703
warnings.showwarning = _catcher
1704
warnings.filters = []
1705
result = fn(*args, **kw)
1707
warnings.showwarning = saved_showwarning
1708
warnings.filters = saved_filters
1709
return wlist, result
1024
1711
def callDeprecated(self, expected, callable, *args, **kwargs):
1025
1712
"""Assert that a callable is deprecated in a particular way.
1027
This is a very precise test for unusual requirements. The
1714
This is a very precise test for unusual requirements. The
1028
1715
applyDeprecated helper function is probably more suited for most tests
1029
1716
as it allows you to simply specify the deprecation format being used
1030
1717
and will ensure that that is issued for the function being called.
1032
1719
Note that this only captures warnings raised by symbol_versioning.warn,
1033
not other callers that go direct to the warning module.
1720
not other callers that go direct to the warning module. To catch
1721
general warnings, use callCatchWarnings.
1035
1723
:param expected: a list of the deprecation warnings expected, in order
1036
1724
:param callable: The callable to call
1037
1725
:param args: The positional arguments for the callable
1038
1726
:param kwargs: The keyword arguments for the callable
1040
call_warnings, result = self._capture_warnings(callable,
1728
call_warnings, result = self._capture_deprecation_warnings(callable,
1041
1729
*args, **kwargs)
1042
1730
self.assertEqual(expected, call_warnings)
1045
1733
def _startLogFile(self):
1046
"""Send bzr and test log messages to a temporary file.
1048
The file is removed as the test is torn down.
1050
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1051
self._log_file = os.fdopen(fileno, 'w+')
1052
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1053
self._log_file_name = name
1734
"""Setup a in-memory target for bzr and testcase log messages"""
1735
pseudo_log_file = StringIO()
1736
def _get_log_contents_for_weird_testtools_api():
1737
return [pseudo_log_file.getvalue().decode(
1738
"utf-8", "replace").encode("utf-8")]
1739
self.addDetail("log", content.Content(content.ContentType("text",
1740
"plain", {"charset": "utf8"}),
1741
_get_log_contents_for_weird_testtools_api))
1742
self._log_file = pseudo_log_file
1743
self._log_memento = trace.push_log_file(self._log_file)
1054
1744
self.addCleanup(self._finishLogFile)
1056
1746
def _finishLogFile(self):
1057
"""Finished with the log file.
1059
Close the file and delete it, unless setKeepLogfile was called.
1061
if self._log_file is None:
1063
bzrlib.trace.disable_test_log(self._log_nonce)
1064
self._log_file.close()
1065
self._log_file = None
1066
if not self._keep_log_file:
1067
os.remove(self._log_file_name)
1068
self._log_file_name = None
1070
def setKeepLogfile(self):
1071
"""Make the logfile not be deleted when _finishLogFile is called."""
1072
self._keep_log_file = True
1074
def addCleanup(self, callable):
1075
"""Arrange to run a callable when this case is torn down.
1077
Callables are run in the reverse of the order they are registered,
1078
ie last-in first-out.
1080
if callable in self._cleanups:
1081
raise ValueError("cleanup function %r already registered on %s"
1083
self._cleanups.append(callable)
1747
"""Flush and dereference the in-memory log for this testcase"""
1748
if trace._trace_file:
1749
# flush the log file, to get all content
1750
trace._trace_file.flush()
1751
trace.pop_log_file(self._log_memento)
1752
# The logging module now tracks references for cleanup so discard ours
1753
del self._log_memento
1755
def thisFailsStrictLockCheck(self):
1756
"""It is known that this test would fail with -Dstrict_locks.
1758
By default, all tests are run with strict lock checking unless
1759
-Edisable_lock_checks is supplied. However there are some tests which
1760
we know fail strict locks at this point that have not been fixed.
1761
They should call this function to disable the strict checking.
1763
This should be used sparingly, it is much better to fix the locking
1764
issues rather than papering over the problem by calling this function.
1766
debug.debug_flags.discard('strict_locks')
1768
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1769
"""Overrides an object attribute restoring it after the test.
1771
:note: This should be used with discretion; you should think about
1772
whether it's better to make the code testable without monkey-patching.
1774
:param obj: The object that will be mutated.
1776
:param attr_name: The attribute name we want to preserve/override in
1779
:param new: The optional value we want to set the attribute to.
1781
:returns: The actual attr value.
1783
# The actual value is captured by the call below
1784
value = getattr(obj, attr_name, _unitialized_attr)
1785
if value is _unitialized_attr:
1786
# When the test completes, the attribute should not exist, but if
1787
# we aren't setting a value, we don't need to do anything.
1788
if new is not _unitialized_attr:
1789
self.addCleanup(delattr, obj, attr_name)
1791
self.addCleanup(setattr, obj, attr_name, value)
1792
if new is not _unitialized_attr:
1793
setattr(obj, attr_name, new)
1796
def overrideEnv(self, name, new):
1797
"""Set an environment variable, and reset it after the test.
1799
:param name: The environment variable name.
1801
:param new: The value to set the variable to. If None, the
1802
variable is deleted from the environment.
1804
:returns: The actual variable value.
1806
value = osutils.set_or_unset_env(name, new)
1807
self.addCleanup(osutils.set_or_unset_env, name, value)
1810
def recordCalls(self, obj, attr_name):
1811
"""Monkeypatch in a wrapper that will record calls.
1813
The monkeypatch is automatically removed when the test concludes.
1815
:param obj: The namespace holding the reference to be replaced;
1816
typically a module, class, or object.
1817
:param attr_name: A string for the name of the attribute to
1819
:returns: A list that will be extended with one item every time the
1820
function is called, with a tuple of (args, kwargs).
1824
def decorator(*args, **kwargs):
1825
calls.append((args, kwargs))
1826
return orig(*args, **kwargs)
1827
orig = self.overrideAttr(obj, attr_name, decorator)
1085
1830
def _cleanEnvironment(self):
1087
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1088
'HOME': os.getcwd(),
1089
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1091
'BZREMAIL': None, # may still be present in the environment
1093
'BZR_PROGRESS_BAR': None,
1095
'SSH_AUTH_SOCK': None,
1099
'https_proxy': None,
1100
'HTTPS_PROXY': None,
1105
# Nobody cares about these ones AFAIK. So far at
1106
# least. If you do (care), please update this comment
1110
'BZR_REMOTE_PATH': None,
1113
self.addCleanup(self._restoreEnvironment)
1114
for name, value in new_env.iteritems():
1115
self._captureVar(name, value)
1117
def _captureVar(self, name, newvalue):
1118
"""Set an environment variable, and reset it when finished."""
1119
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1121
def _restore_debug_flags(self):
1122
debug.debug_flags.clear()
1123
debug.debug_flags.update(self._preserved_debug_flags)
1125
def _restoreEnvironment(self):
1126
for name, value in self.__old_env.iteritems():
1127
osutils.set_or_unset_env(name, value)
1831
for name, value in isolated_environ.iteritems():
1832
self.overrideEnv(name, value)
1129
1834
def _restoreHooks(self):
1130
for klass, hooks in self._preserved_hooks.items():
1131
setattr(klass, 'hooks', hooks)
1835
for klass, (name, hooks) in self._preserved_hooks.items():
1836
setattr(klass, name, hooks)
1837
self._preserved_hooks.clear()
1838
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1839
self._preserved_lazy_hooks.clear()
1133
1841
def knownFailure(self, reason):
1134
"""This test has failed for some known reason."""
1135
raise KnownFailure(reason)
1137
def run(self, result=None):
1138
if result is None: result = self.defaultTestResult()
1139
for feature in getattr(self, '_test_needs_features', []):
1140
if not feature.available():
1141
result.startTest(self)
1142
if getattr(result, 'addNotSupported', None):
1143
result.addNotSupported(self, feature)
1145
result.addSuccess(self)
1146
result.stopTest(self)
1148
return unittest.TestCase.run(self, result)
1152
unittest.TestCase.tearDown(self)
1842
"""Declare that this test fails for a known reason
1844
Tests that are known to fail should generally be using expectedFailure
1845
with an appropriate reverse assertion if a change could cause the test
1846
to start passing. Conversely if the test has no immediate prospect of
1847
succeeding then using skip is more suitable.
1849
When this method is called while an exception is being handled, that
1850
traceback will be used, otherwise a new exception will be thrown to
1851
provide one but won't be reported.
1853
self._add_reason(reason)
1855
exc_info = sys.exc_info()
1856
if exc_info != (None, None, None):
1857
self._report_traceback(exc_info)
1860
raise self.failureException(reason)
1861
except self.failureException:
1862
exc_info = sys.exc_info()
1863
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1864
raise testtools.testcase._ExpectedFailure(exc_info)
1868
def _suppress_log(self):
1869
"""Remove the log info from details."""
1870
self.discardDetail('log')
1872
def _do_skip(self, result, reason):
1873
self._suppress_log()
1874
addSkip = getattr(result, 'addSkip', None)
1875
if not callable(addSkip):
1876
result.addSuccess(result)
1878
addSkip(self, reason)
1881
def _do_known_failure(self, result, e):
1882
self._suppress_log()
1883
err = sys.exc_info()
1884
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1885
if addExpectedFailure is not None:
1886
addExpectedFailure(self, err)
1888
result.addSuccess(self)
1891
def _do_not_applicable(self, result, e):
1893
reason = 'No reason given'
1896
self._suppress_log ()
1897
addNotApplicable = getattr(result, 'addNotApplicable', None)
1898
if addNotApplicable is not None:
1899
result.addNotApplicable(self, reason)
1901
self._do_skip(result, reason)
1904
def _report_skip(self, result, err):
1905
"""Override the default _report_skip.
1907
We want to strip the 'log' detail. If we waint until _do_skip, it has
1908
already been formatted into the 'reason' string, and we can't pull it
1911
self._suppress_log()
1912
super(TestCase, self)._report_skip(self, result, err)
1915
def _report_expected_failure(self, result, err):
1918
See _report_skip for motivation.
1920
self._suppress_log()
1921
super(TestCase, self)._report_expected_failure(self, result, err)
1924
def _do_unsupported_or_skip(self, result, e):
1926
self._suppress_log()
1927
addNotSupported = getattr(result, 'addNotSupported', None)
1928
if addNotSupported is not None:
1929
result.addNotSupported(self, reason)
1931
self._do_skip(result, reason)
1154
1933
def time(self, callable, *args, **kwargs):
1155
1934
"""Run callable and accrue the time it takes to the benchmark time.
1157
1936
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1158
1937
this will cause lsprofile statistics to be gathered and stored in
1159
1938
self._benchcalls.
1161
1940
if self._benchtime is None:
1941
self.addDetail('benchtime', content.Content(content.ContentType(
1942
"text", "plain"), lambda:[str(self._benchtime)]))
1162
1943
self._benchtime = 0
1163
1944
start = time.time()
1784
2624
base = self.get_vfs_only_server().get_url()
1785
2625
return self._adjust_url(base, relpath)
2627
def _create_safety_net(self):
2628
"""Make a fake bzr directory.
2630
This prevents any tests propagating up onto the TEST_ROOT directory's
2633
root = TestCaseWithMemoryTransport.TEST_ROOT
2635
# Make sure we get a readable and accessible home for .bzr.log
2636
# and/or config files, and not fallback to weird defaults (see
2637
# http://pad.lv/825027).
2638
self.assertIs(None, os.environ.get('BZR_HOME', None))
2639
os.environ['BZR_HOME'] = root
2640
wt = controldir.ControlDir.create_standalone_workingtree(root)
2641
del os.environ['BZR_HOME']
2642
except Exception, e:
2643
self.fail("Fail to initialize the safety net: %r\n" % (e,))
2644
# Hack for speed: remember the raw bytes of the dirstate file so that
2645
# we don't need to re-open the wt to check it hasn't changed.
2646
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
2647
wt.control_transport.get_bytes('dirstate'))
2649
def _check_safety_net(self):
2650
"""Check that the safety .bzr directory have not been touched.
2652
_make_test_root have created a .bzr directory to prevent tests from
2653
propagating. This method ensures than a test did not leaked.
2655
root = TestCaseWithMemoryTransport.TEST_ROOT
2656
t = _mod_transport.get_transport_from_path(root)
2657
self.permit_url(t.base)
2658
if (t.get_bytes('.bzr/checkout/dirstate') !=
2659
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
2660
# The current test have modified the /bzr directory, we need to
2661
# recreate a new one or all the followng tests will fail.
2662
# If you need to inspect its content uncomment the following line
2663
# import pdb; pdb.set_trace()
2664
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2665
self._create_safety_net()
2666
raise AssertionError('%s/.bzr should not be modified' % root)
1787
2668
def _make_test_root(self):
1788
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1790
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1791
TestCaseWithMemoryTransport.TEST_ROOT = root
1793
# make a fake bzr directory there to prevent any tests propagating
1794
# up onto the source directory's real branch
1795
bzrdir.BzrDir.create_standalone_workingtree(root)
1797
# The same directory is used by all tests, and we're not specifically
1798
# told when all tests are finished. This will do.
1799
atexit.register(_rmtree_temp_dir, root)
2669
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2670
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2671
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2673
TestCaseWithMemoryTransport.TEST_ROOT = root
2675
self._create_safety_net()
2677
# The same directory is used by all tests, and we're not
2678
# specifically told when all tests are finished. This will do.
2679
atexit.register(_rmtree_temp_dir, root)
2681
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2682
self.addCleanup(self._check_safety_net)
1801
2684
def makeAndChdirToTestDir(self):
1802
2685
"""Create a temporary directories for this one test.
1804
2687
This must set self.test_home_dir and self.test_dir and chdir to
1807
2690
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1809
2692
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1810
2693
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1811
2694
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1813
def make_branch(self, relpath, format=None):
2695
self.permit_dir(self.test_dir)
2697
def make_branch(self, relpath, format=None, name=None):
1814
2698
"""Create a branch on the transport at relpath."""
1815
2699
repo = self.make_repository(relpath, format=format)
1816
return repo.bzrdir.create_branch()
2700
return repo.bzrdir.create_branch(append_revisions_only=False,
2703
def get_default_format(self):
2706
def resolve_format(self, format):
2707
"""Resolve an object to a ControlDir format object.
2709
The initial format object can either already be
2710
a ControlDirFormat, None (for the default format),
2711
or a string with the name of the control dir format.
2713
:param format: Object to resolve
2714
:return A ControlDirFormat instance
2717
format = self.get_default_format()
2718
if isinstance(format, basestring):
2719
format = controldir.format_registry.make_bzrdir(format)
1818
2722
def make_bzrdir(self, relpath, format=None):
1820
2724
# might be a relative or absolute path
1821
2725
maybe_a_url = self.get_url(relpath)
1822
2726
segments = maybe_a_url.rsplit('/', 1)
1823
t = get_transport(maybe_a_url)
2727
t = _mod_transport.get_transport(maybe_a_url)
1824
2728
if len(segments) > 1 and segments[-1] not in ('', '.'):
1825
2729
t.ensure_base()
1828
if isinstance(format, basestring):
1829
format = bzrdir.format_registry.make_bzrdir(format)
2730
format = self.resolve_format(format)
1830
2731
return format.initialize_on_transport(t)
1831
2732
except errors.UninitializableFormat:
1832
2733
raise TestSkipped("Format %s is not initializable." % format)
1834
def make_repository(self, relpath, shared=False, format=None):
2735
def make_repository(self, relpath, shared=None, format=None):
1835
2736
"""Create a repository on our default transport at relpath.
1837
2738
Note that relpath must be a relative path, not a full url.
1839
2740
# FIXME: If you create a remoterepository this returns the underlying
1840
# real format, which is incorrect. Actually we should make sure that
2741
# real format, which is incorrect. Actually we should make sure that
1841
2742
# RemoteBzrDir returns a RemoteRepository.
1842
2743
# maybe mbp 20070410
1843
2744
made_control = self.make_bzrdir(relpath, format=format)
1844
2745
return made_control.create_repository(shared=shared)
2747
def make_smart_server(self, path, backing_server=None):
2748
if backing_server is None:
2749
backing_server = self.get_server()
2750
smart_server = test_server.SmartTCPServer_for_testing()
2751
self.start_server(smart_server, backing_server)
2752
remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
2754
return remote_transport
1846
2756
def make_branch_and_memory_tree(self, relpath, format=None):
1847
2757
"""Create a branch on the default transport and a MemoryTree for it."""
1848
2758
b = self.make_branch(relpath, format=format)
1849
2759
return memorytree.MemoryTree.create_on_branch(b)
2761
def make_branch_builder(self, relpath, format=None):
2762
branch = self.make_branch(relpath, format=format)
2763
return branchbuilder.BranchBuilder(branch=branch)
1851
2765
def overrideEnvironmentForTesting(self):
1852
os.environ['HOME'] = self.test_home_dir
1853
os.environ['BZR_HOME'] = self.test_home_dir
1856
super(TestCaseWithMemoryTransport, self).setUp()
1857
self._make_test_root()
1858
_currentdir = os.getcwdu()
1859
def _leaveDirectory():
1860
os.chdir(_currentdir)
1861
self.addCleanup(_leaveDirectory)
1862
self.makeAndChdirToTestDir()
1863
self.overrideEnvironmentForTesting()
1864
self.__readonly_server = None
1865
self.__server = None
1866
self.reduceLockdirTimeout()
2766
test_home_dir = self.test_home_dir
2767
if isinstance(test_home_dir, unicode):
2768
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2769
self.overrideEnv('HOME', test_home_dir)
2770
self.overrideEnv('BZR_HOME', test_home_dir)
2772
def setup_smart_server_with_call_log(self):
2773
"""Sets up a smart server as the transport server with a call log."""
2774
self.transport_server = test_server.SmartTCPServer_for_testing
2775
self.hpss_connections = []
2776
self.hpss_calls = []
2778
# Skip the current stack down to the caller of
2779
# setup_smart_server_with_call_log
2780
prefix_length = len(traceback.extract_stack()) - 2
2781
def capture_hpss_call(params):
2782
self.hpss_calls.append(
2783
CapturedCall(params, prefix_length))
2784
def capture_connect(transport):
2785
self.hpss_connections.append(transport)
2786
client._SmartClient.hooks.install_named_hook(
2787
'call', capture_hpss_call, None)
2788
_mod_transport.Transport.hooks.install_named_hook(
2789
'post_connect', capture_connect, None)
2791
def reset_smart_call_log(self):
2792
self.hpss_calls = []
2793
self.hpss_connections = []
1869
2796
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1870
2797
"""Derived class that runs a test within a temporary directory.
2168
3277
list_only=False,
2169
3278
random_seed=None,
2170
3279
exclude_pattern=None,
3282
suite_decorators=None,
3284
result_decorators=None,
3286
"""Run a test suite for bzr selftest.
3288
:param runner_class: The class of runner to use. Must support the
3289
constructor arguments passed by run_suite which are more than standard
3291
:return: A boolean indicating success.
2172
3293
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2177
runner = TextTestRunner(stream=sys.stdout,
3298
if runner_class is None:
3299
runner_class = TextTestRunner
3302
runner = runner_class(stream=stream,
2178
3303
descriptions=0,
2179
3304
verbosity=verbosity,
2180
3305
bench_history=bench_history,
2181
list_only=list_only,
3307
result_decorators=result_decorators,
2183
3309
runner.stop_on_failure=stop_on_failure
2184
# Initialise the random number generator and display the seed used.
2185
# We convert the seed to a long to make it reuseable across invocations.
2186
random_order = False
2187
if random_seed is not None:
2189
if random_seed == "now":
2190
random_seed = long(time.time())
3310
if isinstance(suite, unittest.TestSuite):
3311
# Empty out _tests list of passed suite and populate new TestSuite
3312
suite._tests[:], suite = [], TestSuite(suite)
3313
# built in decorator factories:
3315
random_order(random_seed, runner),
3316
exclude_tests(exclude_pattern),
3318
if matching_tests_first:
3319
decorators.append(tests_first(pattern))
3321
decorators.append(filter_tests(pattern))
3322
if suite_decorators:
3323
decorators.extend(suite_decorators)
3324
# tell the result object how many tests will be running: (except if
3325
# --parallel=fork is being used. Robert said he will provide a better
3326
# progress design later -- vila 20090817)
3327
if fork_decorator not in decorators:
3328
decorators.append(CountingDecorator)
3329
for decorator in decorators:
3330
suite = decorator(suite)
3332
# Done after test suite decoration to allow randomisation etc
3333
# to take effect, though that is of marginal benefit.
3335
stream.write("Listing tests only ...\n")
3336
for t in iter_suite_tests(suite):
3337
stream.write("%s\n" % (t.id()))
3339
result = runner.run(suite)
3341
return result.wasStrictlySuccessful()
3343
return result.wasSuccessful()
3346
# A registry where get() returns a suite decorator.
3347
parallel_registry = registry.Registry()
3350
def fork_decorator(suite):
3351
if getattr(os, "fork", None) is None:
3352
raise errors.BzrCommandError("platform does not support fork,"
3353
" try --parallel=subprocess instead.")
3354
concurrency = osutils.local_concurrency()
3355
if concurrency == 1:
3357
from testtools import ConcurrentTestSuite
3358
return ConcurrentTestSuite(suite, fork_for_tests)
3359
parallel_registry.register('fork', fork_decorator)
3362
def subprocess_decorator(suite):
3363
concurrency = osutils.local_concurrency()
3364
if concurrency == 1:
3366
from testtools import ConcurrentTestSuite
3367
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3368
parallel_registry.register('subprocess', subprocess_decorator)
3371
def exclude_tests(exclude_pattern):
3372
"""Return a test suite decorator that excludes tests."""
3373
if exclude_pattern is None:
3374
return identity_decorator
3375
def decorator(suite):
3376
return ExcludeDecorator(suite, exclude_pattern)
3380
def filter_tests(pattern):
3382
return identity_decorator
3383
def decorator(suite):
3384
return FilterTestsDecorator(suite, pattern)
3388
def random_order(random_seed, runner):
3389
"""Return a test suite decorator factory for randomising tests order.
3391
:param random_seed: now, a string which casts to a long, or a long.
3392
:param runner: A test runner with a stream attribute to report on.
3394
if random_seed is None:
3395
return identity_decorator
3396
def decorator(suite):
3397
return RandomDecorator(suite, random_seed, runner.stream)
3401
def tests_first(pattern):
3403
return identity_decorator
3404
def decorator(suite):
3405
return TestFirstDecorator(suite, pattern)
3409
def identity_decorator(suite):
3414
class TestDecorator(TestUtil.TestSuite):
3415
"""A decorator for TestCase/TestSuite objects.
3417
Contains rather than flattening suite passed on construction
3420
def __init__(self, suite=None):
3421
super(TestDecorator, self).__init__()
3422
if suite is not None:
3425
# Don't need subclass run method with suite emptying
3426
run = unittest.TestSuite.run
3429
class CountingDecorator(TestDecorator):
3430
"""A decorator which calls result.progress(self.countTestCases)."""
3432
def run(self, result):
3433
progress_method = getattr(result, 'progress', None)
3434
if callable(progress_method):
3435
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3436
return super(CountingDecorator, self).run(result)
3439
class ExcludeDecorator(TestDecorator):
3440
"""A decorator which excludes test matching an exclude pattern."""
3442
def __init__(self, suite, exclude_pattern):
3443
super(ExcludeDecorator, self).__init__(
3444
exclude_tests_by_re(suite, exclude_pattern))
3447
class FilterTestsDecorator(TestDecorator):
3448
"""A decorator which filters tests to those matching a pattern."""
3450
def __init__(self, suite, pattern):
3451
super(FilterTestsDecorator, self).__init__(
3452
filter_suite_by_re(suite, pattern))
3455
class RandomDecorator(TestDecorator):
3456
"""A decorator which randomises the order of its tests."""
3458
def __init__(self, suite, random_seed, stream):
3459
random_seed = self.actual_seed(random_seed)
3460
stream.write("Randomizing test order using seed %s\n\n" %
3462
# Initialise the random number generator.
3463
random.seed(random_seed)
3464
super(RandomDecorator, self).__init__(randomize_suite(suite))
3467
def actual_seed(seed):
3469
# We convert the seed to a long to make it reuseable across
3470
# invocations (because the user can reenter it).
3471
return long(time.time())
2192
3473
# Convert the seed to a long if we can
2194
random_seed = long(random_seed)
3476
except (TypeError, ValueError):
3481
class TestFirstDecorator(TestDecorator):
3482
"""A decorator which moves named tests to the front."""
3484
def __init__(self, suite, pattern):
3485
super(TestFirstDecorator, self).__init__()
3486
self.addTests(split_suite_by_re(suite, pattern))
3489
def partition_tests(suite, count):
3490
"""Partition suite into count lists of tests."""
3491
# This just assigns tests in a round-robin fashion. On one hand this
3492
# splits up blocks of related tests that might run faster if they shared
3493
# resources, but on the other it avoids assigning blocks of slow tests to
3494
# just one partition. So the slowest partition shouldn't be much slower
3496
partitions = [list() for i in range(count)]
3497
tests = iter_suite_tests(suite)
3498
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3499
partition.append(test)
3503
def workaround_zealous_crypto_random():
3504
"""Crypto.Random want to help us being secure, but we don't care here.
3506
This workaround some test failure related to the sftp server. Once paramiko
3507
stop using the controversial API in Crypto.Random, we may get rid of it.
3510
from Crypto.Random import atfork
3516
def fork_for_tests(suite):
3517
"""Take suite and start up one runner per CPU by forking()
3519
:return: An iterable of TestCase-like objects which can each have
3520
run(result) called on them to feed tests to result.
3522
concurrency = osutils.local_concurrency()
3524
from subunit import ProtocolTestCase
3525
from subunit.test_results import AutoTimingTestResultDecorator
3526
class TestInOtherProcess(ProtocolTestCase):
3527
# Should be in subunit, I think. RBC.
3528
def __init__(self, stream, pid):
3529
ProtocolTestCase.__init__(self, stream)
3532
def run(self, result):
3534
ProtocolTestCase.run(self, result)
3536
pid, status = os.waitpid(self.pid, 0)
3537
# GZ 2011-10-18: If status is nonzero, should report to the result
3538
# that something went wrong.
3540
test_blocks = partition_tests(suite, concurrency)
3541
# Clear the tests from the original suite so it doesn't keep them alive
3542
suite._tests[:] = []
3543
for process_tests in test_blocks:
3544
process_suite = TestUtil.TestSuite(process_tests)
3545
# Also clear each split list so new suite has only reference
3546
process_tests[:] = []
3547
c2pread, c2pwrite = os.pipe()
3551
stream = os.fdopen(c2pwrite, 'wb', 1)
3552
workaround_zealous_crypto_random()
3554
# Leave stderr and stdout open so we can see test noise
3555
# Close stdin so that the child goes away if it decides to
3556
# read from stdin (otherwise its a roulette to see what
3557
# child actually gets keystrokes for pdb etc).
3559
subunit_result = AutoTimingTestResultDecorator(
3560
SubUnitBzrProtocolClient(stream))
3561
process_suite.run(subunit_result)
2197
runner.stream.writeln("Randomizing test order using seed %s\n" %
2199
random.seed(random_seed)
2200
# Customise the list of tests if requested
2201
if pattern != '.*' or exclude_pattern is not None or random_order:
2202
if matching_tests_first:
2203
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
3563
# Try and report traceback on stream, but exit with error even
3564
# if stream couldn't be created or something else goes wrong.
3565
# The traceback is formatted to a string and written in one go
3566
# to avoid interleaving lines from multiple failing children.
3568
stream.write(traceback.format_exc())
2206
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2208
result = runner.run(suite)
2209
return result.wasSuccessful()
3574
stream = os.fdopen(c2pread, 'rb', 1)
3575
test = TestInOtherProcess(stream, pid)
3580
def reinvoke_for_tests(suite):
3581
"""Take suite and start up one runner per CPU using subprocess().
3583
:return: An iterable of TestCase-like objects which can each have
3584
run(result) called on them to feed tests to result.
3586
concurrency = osutils.local_concurrency()
3588
from subunit import ProtocolTestCase
3589
class TestInSubprocess(ProtocolTestCase):
3590
def __init__(self, process, name):
3591
ProtocolTestCase.__init__(self, process.stdout)
3592
self.process = process
3593
self.process.stdin.close()
3596
def run(self, result):
3598
ProtocolTestCase.run(self, result)
3601
os.unlink(self.name)
3602
# print "pid %d finished" % finished_process
3603
test_blocks = partition_tests(suite, concurrency)
3604
for process_tests in test_blocks:
3605
# ugly; currently reimplement rather than reuses TestCase methods.
3606
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3607
if not os.path.isfile(bzr_path):
3608
# We are probably installed. Assume sys.argv is the right file
3609
bzr_path = sys.argv[0]
3610
bzr_path = [bzr_path]
3611
if sys.platform == "win32":
3612
# if we're on windows, we can't execute the bzr script directly
3613
bzr_path = [sys.executable] + bzr_path
3614
fd, test_list_file_name = tempfile.mkstemp()
3615
test_list_file = os.fdopen(fd, 'wb', 1)
3616
for test in process_tests:
3617
test_list_file.write(test.id() + '\n')
3618
test_list_file.close()
3620
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3622
if '--no-plugins' in sys.argv:
3623
argv.append('--no-plugins')
3624
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3625
# noise on stderr it can interrupt the subunit protocol.
3626
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3627
stdout=subprocess.PIPE,
3628
stderr=subprocess.PIPE,
3630
test = TestInSubprocess(process, test_list_file_name)
3633
os.unlink(test_list_file_name)
3638
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3639
"""Generate profiling data for all activity between start and success.
3641
The profile data is appended to the test's _benchcalls attribute and can
3642
be accessed by the forwarded-to TestResult.
3644
While it might be cleaner do accumulate this in stopTest, addSuccess is
3645
where our existing output support for lsprof is, and this class aims to
3646
fit in with that: while it could be moved it's not necessary to accomplish
3647
test profiling, nor would it be dramatically cleaner.
3650
def startTest(self, test):
3651
self.profiler = bzrlib.lsprof.BzrProfiler()
3652
# Prevent deadlocks in tests that use lsprof: those tests will
3654
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3655
self.profiler.start()
3656
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3658
def addSuccess(self, test):
3659
stats = self.profiler.stop()
3661
calls = test._benchcalls
3662
except AttributeError:
3663
test._benchcalls = []
3664
calls = test._benchcalls
3665
calls.append(((test.id(), "", ""), stats))
3666
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3668
def stopTest(self, test):
3669
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3670
self.profiler = None
3673
# Controlled by "bzr selftest -E=..." option
3674
# Currently supported:
3675
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3676
# preserves any flags supplied at the command line.
3677
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3678
# rather than failing tests. And no longer raise
3679
# LockContention when fctnl locks are not being used
3680
# with proper exclusion rules.
3681
# -Ethreads Will display thread ident at creation/join time to
3682
# help track thread leaks
3683
# -Euncollected_cases Display the identity of any test cases that weren't
3684
# deallocated after being completed.
3685
# -Econfig_stats Will collect statistics using addDetail
3686
selftest_debug_flags = set()
2212
3689
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2243
3748
matching_tests_first=matching_tests_first,
2244
3749
list_only=list_only,
2245
3750
random_seed=random_seed,
2246
exclude_pattern=exclude_pattern)
3751
exclude_pattern=exclude_pattern,
3753
runner_class=runner_class,
3754
suite_decorators=suite_decorators,
3756
result_decorators=result_decorators,
2248
3759
default_transport = old_transport
3760
selftest_debug_flags = old_debug_flags
3763
def load_test_id_list(file_name):
3764
"""Load a test id list from a text file.
3766
The format is one test id by line. No special care is taken to impose
3767
strict rules, these test ids are used to filter the test suite so a test id
3768
that do not match an existing test will do no harm. This allows user to add
3769
comments, leave blank lines, etc.
3773
ftest = open(file_name, 'rt')
3775
if e.errno != errno.ENOENT:
3778
raise errors.NoSuchFile(file_name)
3780
for test_name in ftest.readlines():
3781
test_list.append(test_name.strip())
3786
def suite_matches_id_list(test_suite, id_list):
3787
"""Warns about tests not appearing or appearing more than once.
3789
:param test_suite: A TestSuite object.
3790
:param test_id_list: The list of test ids that should be found in
3793
:return: (absents, duplicates) absents is a list containing the test found
3794
in id_list but not in test_suite, duplicates is a list containing the
3795
tests found multiple times in test_suite.
3797
When using a prefined test id list, it may occurs that some tests do not
3798
exist anymore or that some tests use the same id. This function warns the
3799
tester about potential problems in his workflow (test lists are volatile)
3800
or in the test suite itself (using the same id for several tests does not
3801
help to localize defects).
3803
# Build a dict counting id occurrences
3805
for test in iter_suite_tests(test_suite):
3807
tests[id] = tests.get(id, 0) + 1
3812
occurs = tests.get(id, 0)
3814
not_found.append(id)
3816
duplicates.append(id)
3818
return not_found, duplicates
3821
class TestIdList(object):
3822
"""Test id list to filter a test suite.
3824
Relying on the assumption that test ids are built as:
3825
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3826
notation, this class offers methods to :
3827
- avoid building a test suite for modules not refered to in the test list,
3828
- keep only the tests listed from the module test suite.
3831
def __init__(self, test_id_list):
3832
# When a test suite needs to be filtered against us we compare test ids
3833
# for equality, so a simple dict offers a quick and simple solution.
3834
self.tests = dict().fromkeys(test_id_list, True)
3836
# While unittest.TestCase have ids like:
3837
# <module>.<class>.<method>[(<param+)],
3838
# doctest.DocTestCase can have ids like:
3841
# <module>.<function>
3842
# <module>.<class>.<method>
3844
# Since we can't predict a test class from its name only, we settle on
3845
# a simple constraint: a test id always begins with its module name.
3848
for test_id in test_id_list:
3849
parts = test_id.split('.')
3850
mod_name = parts.pop(0)
3851
modules[mod_name] = True
3853
mod_name += '.' + part
3854
modules[mod_name] = True
3855
self.modules = modules
3857
def refers_to(self, module_name):
3858
"""Is there tests for the module or one of its sub modules."""
3859
return self.modules.has_key(module_name)
3861
def includes(self, test_id):
3862
return self.tests.has_key(test_id)
3865
class TestPrefixAliasRegistry(registry.Registry):
3866
"""A registry for test prefix aliases.
3868
This helps implement shorcuts for the --starting-with selftest
3869
option. Overriding existing prefixes is not allowed but not fatal (a
3870
warning will be emitted).
3873
def register(self, key, obj, help=None, info=None,
3874
override_existing=False):
3875
"""See Registry.register.
3877
Trying to override an existing alias causes a warning to be emitted,
3878
not a fatal execption.
3881
super(TestPrefixAliasRegistry, self).register(
3882
key, obj, help=help, info=info, override_existing=False)
3884
actual = self.get(key)
3886
'Test prefix alias %s is already used for %s, ignoring %s'
3887
% (key, actual, obj))
3889
def resolve_alias(self, id_start):
3890
"""Replace the alias by the prefix in the given string.
3892
Using an unknown prefix is an error to help catching typos.
3894
parts = id_start.split('.')
3896
parts[0] = self.get(parts[0])
3898
raise errors.BzrCommandError(
3899
'%s is not a known test prefix alias' % parts[0])
3900
return '.'.join(parts)
3903
test_prefix_alias_registry = TestPrefixAliasRegistry()
3904
"""Registry of test prefix aliases."""
3907
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3908
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3909
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3911
# Obvious highest levels prefixes, feel free to add your own via a plugin
3912
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3913
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3914
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3915
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3916
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3919
def _test_suite_testmod_names():
3920
"""Return the standard list of test module names to test."""
3923
'bzrlib.tests.blackbox',
3924
'bzrlib.tests.commands',
3925
'bzrlib.tests.per_branch',
3926
'bzrlib.tests.per_bzrdir',
3927
'bzrlib.tests.per_controldir',
3928
'bzrlib.tests.per_controldir_colo',
3929
'bzrlib.tests.per_foreign_vcs',
3930
'bzrlib.tests.per_interrepository',
3931
'bzrlib.tests.per_intertree',
3932
'bzrlib.tests.per_inventory',
3933
'bzrlib.tests.per_interbranch',
3934
'bzrlib.tests.per_lock',
3935
'bzrlib.tests.per_merger',
3936
'bzrlib.tests.per_transport',
3937
'bzrlib.tests.per_tree',
3938
'bzrlib.tests.per_pack_repository',
3939
'bzrlib.tests.per_repository',
3940
'bzrlib.tests.per_repository_chk',
3941
'bzrlib.tests.per_repository_reference',
3942
'bzrlib.tests.per_repository_vf',
3943
'bzrlib.tests.per_uifactory',
3944
'bzrlib.tests.per_versionedfile',
3945
'bzrlib.tests.per_workingtree',
3946
'bzrlib.tests.test__annotator',
3947
'bzrlib.tests.test__bencode',
3948
'bzrlib.tests.test__btree_serializer',
3949
'bzrlib.tests.test__chk_map',
3950
'bzrlib.tests.test__dirstate_helpers',
3951
'bzrlib.tests.test__groupcompress',
3952
'bzrlib.tests.test__known_graph',
3953
'bzrlib.tests.test__rio',
3954
'bzrlib.tests.test__simple_set',
3955
'bzrlib.tests.test__static_tuple',
3956
'bzrlib.tests.test__walkdirs_win32',
3957
'bzrlib.tests.test_ancestry',
3958
'bzrlib.tests.test_annotate',
3959
'bzrlib.tests.test_api',
3960
'bzrlib.tests.test_atomicfile',
3961
'bzrlib.tests.test_bad_files',
3962
'bzrlib.tests.test_bisect_multi',
3963
'bzrlib.tests.test_branch',
3964
'bzrlib.tests.test_branchbuilder',
3965
'bzrlib.tests.test_btree_index',
3966
'bzrlib.tests.test_bugtracker',
3967
'bzrlib.tests.test_bundle',
3968
'bzrlib.tests.test_bzrdir',
3969
'bzrlib.tests.test__chunks_to_lines',
3970
'bzrlib.tests.test_cache_utf8',
3971
'bzrlib.tests.test_chk_map',
3972
'bzrlib.tests.test_chk_serializer',
3973
'bzrlib.tests.test_chunk_writer',
3974
'bzrlib.tests.test_clean_tree',
3975
'bzrlib.tests.test_cleanup',
3976
'bzrlib.tests.test_cmdline',
3977
'bzrlib.tests.test_commands',
3978
'bzrlib.tests.test_commit',
3979
'bzrlib.tests.test_commit_merge',
3980
'bzrlib.tests.test_config',
3981
'bzrlib.tests.test_conflicts',
3982
'bzrlib.tests.test_controldir',
3983
'bzrlib.tests.test_counted_lock',
3984
'bzrlib.tests.test_crash',
3985
'bzrlib.tests.test_decorators',
3986
'bzrlib.tests.test_delta',
3987
'bzrlib.tests.test_debug',
3988
'bzrlib.tests.test_diff',
3989
'bzrlib.tests.test_directory_service',
3990
'bzrlib.tests.test_dirstate',
3991
'bzrlib.tests.test_email_message',
3992
'bzrlib.tests.test_eol_filters',
3993
'bzrlib.tests.test_errors',
3994
'bzrlib.tests.test_estimate_compressed_size',
3995
'bzrlib.tests.test_export',
3996
'bzrlib.tests.test_export_pot',
3997
'bzrlib.tests.test_extract',
3998
'bzrlib.tests.test_features',
3999
'bzrlib.tests.test_fetch',
4000
'bzrlib.tests.test_fixtures',
4001
'bzrlib.tests.test_fifo_cache',
4002
'bzrlib.tests.test_filters',
4003
'bzrlib.tests.test_filter_tree',
4004
'bzrlib.tests.test_ftp_transport',
4005
'bzrlib.tests.test_foreign',
4006
'bzrlib.tests.test_generate_docs',
4007
'bzrlib.tests.test_generate_ids',
4008
'bzrlib.tests.test_globbing',
4009
'bzrlib.tests.test_gpg',
4010
'bzrlib.tests.test_graph',
4011
'bzrlib.tests.test_groupcompress',
4012
'bzrlib.tests.test_hashcache',
4013
'bzrlib.tests.test_help',
4014
'bzrlib.tests.test_hooks',
4015
'bzrlib.tests.test_http',
4016
'bzrlib.tests.test_http_response',
4017
'bzrlib.tests.test_https_ca_bundle',
4018
'bzrlib.tests.test_https_urllib',
4019
'bzrlib.tests.test_i18n',
4020
'bzrlib.tests.test_identitymap',
4021
'bzrlib.tests.test_ignores',
4022
'bzrlib.tests.test_index',
4023
'bzrlib.tests.test_import_tariff',
4024
'bzrlib.tests.test_info',
4025
'bzrlib.tests.test_inv',
4026
'bzrlib.tests.test_inventory_delta',
4027
'bzrlib.tests.test_knit',
4028
'bzrlib.tests.test_lazy_import',
4029
'bzrlib.tests.test_lazy_regex',
4030
'bzrlib.tests.test_library_state',
4031
'bzrlib.tests.test_lock',
4032
'bzrlib.tests.test_lockable_files',
4033
'bzrlib.tests.test_lockdir',
4034
'bzrlib.tests.test_log',
4035
'bzrlib.tests.test_lru_cache',
4036
'bzrlib.tests.test_lsprof',
4037
'bzrlib.tests.test_mail_client',
4038
'bzrlib.tests.test_matchers',
4039
'bzrlib.tests.test_memorytree',
4040
'bzrlib.tests.test_merge',
4041
'bzrlib.tests.test_merge3',
4042
'bzrlib.tests.test_merge_core',
4043
'bzrlib.tests.test_merge_directive',
4044
'bzrlib.tests.test_mergetools',
4045
'bzrlib.tests.test_missing',
4046
'bzrlib.tests.test_msgeditor',
4047
'bzrlib.tests.test_multiparent',
4048
'bzrlib.tests.test_mutabletree',
4049
'bzrlib.tests.test_nonascii',
4050
'bzrlib.tests.test_options',
4051
'bzrlib.tests.test_osutils',
4052
'bzrlib.tests.test_osutils_encodings',
4053
'bzrlib.tests.test_pack',
4054
'bzrlib.tests.test_patch',
4055
'bzrlib.tests.test_patches',
4056
'bzrlib.tests.test_permissions',
4057
'bzrlib.tests.test_plugins',
4058
'bzrlib.tests.test_progress',
4059
'bzrlib.tests.test_pyutils',
4060
'bzrlib.tests.test_read_bundle',
4061
'bzrlib.tests.test_reconcile',
4062
'bzrlib.tests.test_reconfigure',
4063
'bzrlib.tests.test_registry',
4064
'bzrlib.tests.test_remote',
4065
'bzrlib.tests.test_rename_map',
4066
'bzrlib.tests.test_repository',
4067
'bzrlib.tests.test_revert',
4068
'bzrlib.tests.test_revision',
4069
'bzrlib.tests.test_revisionspec',
4070
'bzrlib.tests.test_revisiontree',
4071
'bzrlib.tests.test_rio',
4072
'bzrlib.tests.test_rules',
4073
'bzrlib.tests.test_url_policy_open',
4074
'bzrlib.tests.test_sampler',
4075
'bzrlib.tests.test_scenarios',
4076
'bzrlib.tests.test_script',
4077
'bzrlib.tests.test_selftest',
4078
'bzrlib.tests.test_serializer',
4079
'bzrlib.tests.test_setup',
4080
'bzrlib.tests.test_sftp_transport',
4081
'bzrlib.tests.test_shelf',
4082
'bzrlib.tests.test_shelf_ui',
4083
'bzrlib.tests.test_smart',
4084
'bzrlib.tests.test_smart_add',
4085
'bzrlib.tests.test_smart_request',
4086
'bzrlib.tests.test_smart_signals',
4087
'bzrlib.tests.test_smart_transport',
4088
'bzrlib.tests.test_smtp_connection',
4089
'bzrlib.tests.test_source',
4090
'bzrlib.tests.test_ssh_transport',
4091
'bzrlib.tests.test_status',
4092
'bzrlib.tests.test_store',
4093
'bzrlib.tests.test_strace',
4094
'bzrlib.tests.test_subsume',
4095
'bzrlib.tests.test_switch',
4096
'bzrlib.tests.test_symbol_versioning',
4097
'bzrlib.tests.test_tag',
4098
'bzrlib.tests.test_test_server',
4099
'bzrlib.tests.test_testament',
4100
'bzrlib.tests.test_textfile',
4101
'bzrlib.tests.test_textmerge',
4102
'bzrlib.tests.test_cethread',
4103
'bzrlib.tests.test_timestamp',
4104
'bzrlib.tests.test_trace',
4105
'bzrlib.tests.test_transactions',
4106
'bzrlib.tests.test_transform',
4107
'bzrlib.tests.test_transport',
4108
'bzrlib.tests.test_transport_log',
4109
'bzrlib.tests.test_tree',
4110
'bzrlib.tests.test_treebuilder',
4111
'bzrlib.tests.test_treeshape',
4112
'bzrlib.tests.test_tsort',
4113
'bzrlib.tests.test_tuned_gzip',
4114
'bzrlib.tests.test_ui',
4115
'bzrlib.tests.test_uncommit',
4116
'bzrlib.tests.test_upgrade',
4117
'bzrlib.tests.test_upgrade_stacked',
4118
'bzrlib.tests.test_urlutils',
4119
'bzrlib.tests.test_utextwrap',
4120
'bzrlib.tests.test_version',
4121
'bzrlib.tests.test_version_info',
4122
'bzrlib.tests.test_versionedfile',
4123
'bzrlib.tests.test_vf_search',
4124
'bzrlib.tests.test_weave',
4125
'bzrlib.tests.test_whitebox',
4126
'bzrlib.tests.test_win32utils',
4127
'bzrlib.tests.test_workingtree',
4128
'bzrlib.tests.test_workingtree_4',
4129
'bzrlib.tests.test_wsgi',
4130
'bzrlib.tests.test_xml',
4134
def _test_suite_modules_to_doctest():
4135
"""Return the list of modules to doctest."""
4137
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4141
'bzrlib.branchbuilder',
4142
'bzrlib.decorators',
4144
'bzrlib.iterablefile',
4149
'bzrlib.symbol_versioning',
4151
'bzrlib.tests.fixtures',
4153
'bzrlib.transport.http',
4154
'bzrlib.version_info_formats.format_custom',
4158
def test_suite(keep_only=None, starting_with=None):
2252
4159
"""Build and return TestSuite for the whole of bzrlib.
4161
:param keep_only: A list of test ids limiting the suite returned.
4163
:param starting_with: An id limiting the suite returned to the tests
2254
4166
This function can be replaced if you need to change the default test
2255
4167
suite on a global basis, but it is not encouraged.
2258
'bzrlib.util.tests.test_bencode',
2259
'bzrlib.tests.test__dirstate_helpers',
2260
'bzrlib.tests.test_ancestry',
2261
'bzrlib.tests.test_annotate',
2262
'bzrlib.tests.test_api',
2263
'bzrlib.tests.test_atomicfile',
2264
'bzrlib.tests.test_bad_files',
2265
'bzrlib.tests.test_branch',
2266
'bzrlib.tests.test_branchbuilder',
2267
'bzrlib.tests.test_bugtracker',
2268
'bzrlib.tests.test_bundle',
2269
'bzrlib.tests.test_bzrdir',
2270
'bzrlib.tests.test_cache_utf8',
2271
'bzrlib.tests.test_commands',
2272
'bzrlib.tests.test_commit',
2273
'bzrlib.tests.test_commit_merge',
2274
'bzrlib.tests.test_config',
2275
'bzrlib.tests.test_conflicts',
2276
'bzrlib.tests.test_counted_lock',
2277
'bzrlib.tests.test_decorators',
2278
'bzrlib.tests.test_delta',
2279
'bzrlib.tests.test_deprecated_graph',
2280
'bzrlib.tests.test_diff',
2281
'bzrlib.tests.test_dirstate',
2282
'bzrlib.tests.test_email_message',
2283
'bzrlib.tests.test_errors',
2284
'bzrlib.tests.test_escaped_store',
2285
'bzrlib.tests.test_extract',
2286
'bzrlib.tests.test_fetch',
2287
'bzrlib.tests.test_file_names',
2288
'bzrlib.tests.test_ftp_transport',
2289
'bzrlib.tests.test_generate_docs',
2290
'bzrlib.tests.test_generate_ids',
2291
'bzrlib.tests.test_globbing',
2292
'bzrlib.tests.test_gpg',
2293
'bzrlib.tests.test_graph',
2294
'bzrlib.tests.test_hashcache',
2295
'bzrlib.tests.test_help',
2296
'bzrlib.tests.test_hooks',
2297
'bzrlib.tests.test_http',
2298
'bzrlib.tests.test_http_response',
2299
'bzrlib.tests.test_https_ca_bundle',
2300
'bzrlib.tests.test_identitymap',
2301
'bzrlib.tests.test_ignores',
2302
'bzrlib.tests.test_index',
2303
'bzrlib.tests.test_info',
2304
'bzrlib.tests.test_inv',
2305
'bzrlib.tests.test_knit',
2306
'bzrlib.tests.test_lazy_import',
2307
'bzrlib.tests.test_lazy_regex',
2308
'bzrlib.tests.test_lockdir',
2309
'bzrlib.tests.test_lockable_files',
2310
'bzrlib.tests.test_log',
2311
'bzrlib.tests.test_lsprof',
2312
'bzrlib.tests.test_memorytree',
2313
'bzrlib.tests.test_merge',
2314
'bzrlib.tests.test_merge3',
2315
'bzrlib.tests.test_merge_core',
2316
'bzrlib.tests.test_merge_directive',
2317
'bzrlib.tests.test_missing',
2318
'bzrlib.tests.test_msgeditor',
2319
'bzrlib.tests.test_multiparent',
2320
'bzrlib.tests.test_nonascii',
2321
'bzrlib.tests.test_options',
2322
'bzrlib.tests.test_osutils',
2323
'bzrlib.tests.test_osutils_encodings',
2324
'bzrlib.tests.test_pack',
2325
'bzrlib.tests.test_patch',
2326
'bzrlib.tests.test_patches',
2327
'bzrlib.tests.test_permissions',
2328
'bzrlib.tests.test_plugins',
2329
'bzrlib.tests.test_progress',
2330
'bzrlib.tests.test_reconcile',
2331
'bzrlib.tests.test_registry',
2332
'bzrlib.tests.test_remote',
2333
'bzrlib.tests.test_repository',
2334
'bzrlib.tests.test_revert',
2335
'bzrlib.tests.test_revision',
2336
'bzrlib.tests.test_revisionnamespaces',
2337
'bzrlib.tests.test_revisiontree',
2338
'bzrlib.tests.test_rio',
2339
'bzrlib.tests.test_sampler',
2340
'bzrlib.tests.test_selftest',
2341
'bzrlib.tests.test_setup',
2342
'bzrlib.tests.test_sftp_transport',
2343
'bzrlib.tests.test_smart',
2344
'bzrlib.tests.test_smart_add',
2345
'bzrlib.tests.test_smart_transport',
2346
'bzrlib.tests.test_smtp_connection',
2347
'bzrlib.tests.test_source',
2348
'bzrlib.tests.test_ssh_transport',
2349
'bzrlib.tests.test_status',
2350
'bzrlib.tests.test_store',
2351
'bzrlib.tests.test_strace',
2352
'bzrlib.tests.test_subsume',
2353
'bzrlib.tests.test_symbol_versioning',
2354
'bzrlib.tests.test_tag',
2355
'bzrlib.tests.test_testament',
2356
'bzrlib.tests.test_textfile',
2357
'bzrlib.tests.test_textmerge',
2358
'bzrlib.tests.test_timestamp',
2359
'bzrlib.tests.test_trace',
2360
'bzrlib.tests.test_transactions',
2361
'bzrlib.tests.test_transform',
2362
'bzrlib.tests.test_transport',
2363
'bzrlib.tests.test_tree',
2364
'bzrlib.tests.test_treebuilder',
2365
'bzrlib.tests.test_tsort',
2366
'bzrlib.tests.test_tuned_gzip',
2367
'bzrlib.tests.test_ui',
2368
'bzrlib.tests.test_upgrade',
2369
'bzrlib.tests.test_urlutils',
2370
'bzrlib.tests.test_versionedfile',
2371
'bzrlib.tests.test_version',
2372
'bzrlib.tests.test_version_info',
2373
'bzrlib.tests.test_weave',
2374
'bzrlib.tests.test_whitebox',
2375
'bzrlib.tests.test_win32utils',
2376
'bzrlib.tests.test_workingtree',
2377
'bzrlib.tests.test_workingtree_4',
2378
'bzrlib.tests.test_wsgi',
2379
'bzrlib.tests.test_xml',
2381
test_transport_implementations = [
2382
'bzrlib.tests.test_transport_implementations',
2383
'bzrlib.tests.test_read_bundle',
2385
suite = TestUtil.TestSuite()
2386
4170
loader = TestUtil.TestLoader()
2387
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2388
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2389
adapter = TransportTestProviderAdapter()
2390
adapt_modules(test_transport_implementations, adapter, loader, suite)
2391
for package in packages_to_test():
2392
suite.addTest(package.test_suite())
2393
for m in MODULES_TO_TEST:
2394
suite.addTest(loader.loadTestsFromModule(m))
2395
for m in MODULES_TO_DOCTEST:
4172
if keep_only is not None:
4173
id_filter = TestIdList(keep_only)
4175
# We take precedence over keep_only because *at loading time* using
4176
# both options means we will load less tests for the same final result.
4177
def interesting_module(name):
4178
for start in starting_with:
4180
# Either the module name starts with the specified string
4181
name.startswith(start)
4182
# or it may contain tests starting with the specified string
4183
or start.startswith(name)
4187
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4189
elif keep_only is not None:
4190
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4191
def interesting_module(name):
4192
return id_filter.refers_to(name)
4195
loader = TestUtil.TestLoader()
4196
def interesting_module(name):
4197
# No filtering, all modules are interesting
4200
suite = loader.suiteClass()
4202
# modules building their suite with loadTestsFromModuleNames
4203
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4205
for mod in _test_suite_modules_to_doctest():
4206
if not interesting_module(mod):
4207
# No tests to keep here, move along
2397
suite.addTest(doctest.DocTestSuite(m))
4210
# note that this really does mean "report only" -- doctest
4211
# still runs the rest of the examples
4212
doc_suite = IsolatedDocTestSuite(
4213
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
2398
4214
except ValueError, e:
2399
print '**failed to get doctest for: %s\n%s' %(m,e)
4215
print '**failed to get doctest for: %s\n%s' % (mod, e)
2401
for name, plugin in bzrlib.plugin.all_plugins().items():
2402
if getattr(plugin, 'test_suite', None) is not None:
2403
default_encoding = sys.getdefaultencoding()
2405
plugin_suite = plugin.test_suite()
2406
except ImportError, e:
2407
bzrlib.trace.warning(
2408
'Unable to test plugin "%s": %s', name, e)
2410
suite.addTest(plugin_suite)
2411
if default_encoding != sys.getdefaultencoding():
2412
bzrlib.trace.warning(
2413
'Plugin "%s" tried to reset default encoding to: %s', name,
2414
sys.getdefaultencoding())
2416
sys.setdefaultencoding(default_encoding)
4217
if len(doc_suite._tests) == 0:
4218
raise errors.BzrError("no doctests found in %s" % (mod,))
4219
suite.addTest(doc_suite)
4221
default_encoding = sys.getdefaultencoding()
4222
for name, plugin in _mod_plugin.plugins().items():
4223
if not interesting_module(plugin.module.__name__):
4225
plugin_suite = plugin.test_suite()
4226
# We used to catch ImportError here and turn it into just a warning,
4227
# but really if you don't have --no-plugins this should be a failure.
4228
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4229
if plugin_suite is None:
4230
plugin_suite = plugin.load_plugin_tests(loader)
4231
if plugin_suite is not None:
4232
suite.addTest(plugin_suite)
4233
if default_encoding != sys.getdefaultencoding():
4235
'Plugin "%s" tried to reset default encoding to: %s', name,
4236
sys.getdefaultencoding())
4238
sys.setdefaultencoding(default_encoding)
4240
if keep_only is not None:
4241
# Now that the referred modules have loaded their tests, keep only the
4243
suite = filter_suite_by_id_list(suite, id_filter)
4244
# Do some sanity checks on the id_list filtering
4245
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4247
# The tester has used both keep_only and starting_with, so he is
4248
# already aware that some tests are excluded from the list, there
4249
# is no need to tell him which.
4252
# Some tests mentioned in the list are not in the test suite. The
4253
# list may be out of date, report to the tester.
4254
for id in not_found:
4255
trace.warning('"%s" not found in the test suite', id)
4256
for id in duplicates:
4257
trace.warning('"%s" is used as an id by several tests', id)
2420
def adapt_modules(mods_list, adapter, loader, suite):
2421
"""Adapt the modules in mods_list using adapter and add to suite."""
2422
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2423
suite.addTests(adapter.adapt(test))
2426
def _rmtree_temp_dir(dirname):
4262
def multiply_scenarios(*scenarios):
4263
"""Multiply two or more iterables of scenarios.
4265
It is safe to pass scenario generators or iterators.
4267
:returns: A list of compound scenarios: the cross-product of all
4268
scenarios, with the names concatenated and the parameters
4271
return reduce(_multiply_two_scenarios, map(list, scenarios))
4274
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4275
"""Multiply two sets of scenarios.
4277
:returns: the cartesian product of the two sets of scenarios, that is
4278
a scenario for every possible combination of a left scenario and a
4282
('%s,%s' % (left_name, right_name),
4283
dict(left_dict.items() + right_dict.items()))
4284
for left_name, left_dict in scenarios_left
4285
for right_name, right_dict in scenarios_right]
4288
def multiply_tests(tests, scenarios, result):
4289
"""Multiply tests_list by scenarios into result.
4291
This is the core workhorse for test parameterisation.
4293
Typically the load_tests() method for a per-implementation test suite will
4294
call multiply_tests and return the result.
4296
:param tests: The tests to parameterise.
4297
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4298
scenario_param_dict).
4299
:param result: A TestSuite to add created tests to.
4301
This returns the passed in result TestSuite with the cross product of all
4302
the tests repeated once for each scenario. Each test is adapted by adding
4303
the scenario name at the end of its id(), and updating the test object's
4304
__dict__ with the scenario_param_dict.
4306
>>> import bzrlib.tests.test_sampler
4307
>>> r = multiply_tests(
4308
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4309
... [('one', dict(param=1)),
4310
... ('two', dict(param=2))],
4311
... TestUtil.TestSuite())
4312
>>> tests = list(iter_suite_tests(r))
4316
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4322
for test in iter_suite_tests(tests):
4323
apply_scenarios(test, scenarios, result)
4327
def apply_scenarios(test, scenarios, result):
4328
"""Apply the scenarios in scenarios to test and add to result.
4330
:param test: The test to apply scenarios to.
4331
:param scenarios: An iterable of scenarios to apply to test.
4333
:seealso: apply_scenario
4335
for scenario in scenarios:
4336
result.addTest(apply_scenario(test, scenario))
4340
def apply_scenario(test, scenario):
4341
"""Copy test and apply scenario to it.
4343
:param test: A test to adapt.
4344
:param scenario: A tuple describing the scenario.
4345
The first element of the tuple is the new test id.
4346
The second element is a dict containing attributes to set on the
4348
:return: The adapted test.
4350
new_id = "%s(%s)" % (test.id(), scenario[0])
4351
new_test = clone_test(test, new_id)
4352
for name, value in scenario[1].items():
4353
setattr(new_test, name, value)
4357
def clone_test(test, new_id):
4358
"""Clone a test giving it a new id.
4360
:param test: The test to clone.
4361
:param new_id: The id to assign to it.
4362
:return: The new test.
4364
new_test = copy.copy(test)
4365
new_test.id = lambda: new_id
4366
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4367
# causes cloned tests to share the 'details' dict. This makes it hard to
4368
# read the test output for parameterized tests, because tracebacks will be
4369
# associated with irrelevant tests.
4371
details = new_test._TestCase__details
4372
except AttributeError:
4373
# must be a different version of testtools than expected. Do nothing.
4376
# Reset the '__details' dict.
4377
new_test._TestCase__details = {}
4381
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4383
"""Helper for permutating tests against an extension module.
4385
This is meant to be used inside a modules 'load_tests()' function. It will
4386
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4387
against both implementations. Setting 'test.module' to the appropriate
4388
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4390
:param standard_tests: A test suite to permute
4391
:param loader: A TestLoader
4392
:param py_module_name: The python path to a python module that can always
4393
be loaded, and will be considered the 'python' implementation. (eg
4394
'bzrlib._chk_map_py')
4395
:param ext_module_name: The python path to an extension module. If the
4396
module cannot be loaded, a single test will be added, which notes that
4397
the module is not available. If it can be loaded, all standard_tests
4398
will be run against that module.
4399
:return: (suite, feature) suite is a test-suite that has all the permuted
4400
tests. feature is the Feature object that can be used to determine if
4401
the module is available.
4404
from bzrlib.tests.features import ModuleAvailableFeature
4405
py_module = pyutils.get_named_object(py_module_name)
4407
('python', {'module': py_module}),
4409
suite = loader.suiteClass()
4410
feature = ModuleAvailableFeature(ext_module_name)
4411
if feature.available():
4412
scenarios.append(('C', {'module': feature.module}))
4414
# the compiled module isn't available, so we add a failing test
4415
class FailWithoutFeature(TestCase):
4416
def test_fail(self):
4417
self.requireFeature(feature)
4418
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4419
result = multiply_tests(standard_tests, scenarios, suite)
4420
return result, feature
4423
def _rmtree_temp_dir(dirname, test_id=None):
2427
4424
# If LANG=C we probably have created some bogus paths
2428
4425
# which rmtree(unicode) will fail to delete
2429
4426
# so make sure we are using rmtree(str) to delete everything
added
removed
bzrlib/tests/__init__.py
