31
27
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
51
# nb: check this before importing anything else from within it
52
_testtools_version = getattr(testtools, '__version__', ())
53
if _testtools_version < (0, 9, 5):
54
raise ImportError("need at least testtools 0.9.5: %s is %r"
55
% (testtools.__file__, _testtools_version))
56
from testtools import content
50
59
from bzrlib import (
63
commands as _mod_commands,
73
plugin as _mod_plugin,
80
transport as _mod_transport,
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
69
84
import bzrlib.lsprof
70
85
except ImportError:
71
86
# lsprof not available
73
from bzrlib.merge import merge_inner
77
from bzrlib.revision import common_ancestor
79
from bzrlib import symbol_versioning
88
from bzrlib.smart import client, request
89
from bzrlib.transport import (
80
93
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
97
from bzrlib.tests import (
103
from bzrlib.ui import NullProgressView
104
from bzrlib.ui.text import TextUIFactory
105
from bzrlib.tests.features import _CompatabilityThunkFeature
100
107
# Mark this python module as being part of the implementation
101
108
# of unittest: this gives us better tracebacks where the last
102
109
# 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.interrepository_implementations
132
import bzrlib.tests.interversionedfile_implementations
133
import bzrlib.tests.intertree_implementations
134
import bzrlib.tests.per_lock
135
import bzrlib.tests.repository_implementations
136
import bzrlib.tests.revisionstore_implementations
137
import bzrlib.tests.tree_implementations
138
import bzrlib.tests.workingtree_implementations
141
bzrlib.tests.blackbox,
142
bzrlib.tests.branch_implementations,
143
bzrlib.tests.bzrdir_implementations,
144
bzrlib.tests.interrepository_implementations,
145
bzrlib.tests.interversionedfile_implementations,
146
bzrlib.tests.intertree_implementations,
147
bzrlib.tests.per_lock,
148
bzrlib.tests.repository_implementations,
149
bzrlib.tests.revisionstore_implementations,
150
bzrlib.tests.tree_implementations,
151
bzrlib.tests.workingtree_implementations,
155
class ExtendedTestResult(unittest._TextTestResult):
112
default_transport = test_server.LocalURLServer
115
_unitialized_attr = object()
116
"""A sentinel needed to act as a default value in a method signature."""
119
# Subunit result codes, defined here to prevent a hard dependency on subunit.
123
# These are intentionally brought into this namespace. That way plugins, etc
124
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
125
TestSuite = TestUtil.TestSuite
126
TestLoader = TestUtil.TestLoader
128
# Tests should run in a clean and clearly defined environment. The goal is to
129
# keep them isolated from the running environment as mush as possible. The test
130
# framework ensures the variables defined below are set (or deleted if the
131
# value is None) before a test is run and reset to their original value after
132
# the test is run. Generally if some code depends on an environment variable,
133
# the tests should start without this variable in the environment. There are a
134
# few exceptions but you shouldn't violate this rule lightly.
138
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
139
# tests do check our impls match APPDATA
140
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
144
'BZREMAIL': None, # may still be present in the environment
145
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
146
'BZR_PROGRESS_BAR': None,
147
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
148
# as a base class instead of TestCaseInTempDir. Tests inheriting from
149
# TestCase should not use disk resources, BZR_LOG is one.
150
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
151
'BZR_PLUGIN_PATH': None,
152
'BZR_DISABLE_PLUGINS': None,
153
'BZR_PLUGINS_AT': None,
154
'BZR_CONCURRENCY': None,
155
# Make sure that any text ui tests are consistent regardless of
156
# the environment the test case is run in; you may want tests that
157
# test other combinations. 'dumb' is a reasonable guess for tests
158
# going to a pipe or a StringIO.
164
'SSH_AUTH_SOCK': None,
174
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
175
# least. If you do (care), please update this comment
179
'BZR_REMOTE_PATH': None,
180
# Generally speaking, we don't want apport reporting on crashes in
181
# the test envirnoment unless we're specifically testing apport,
182
# so that it doesn't leak into the real system environment. We
183
# use an env var so it propagates to subprocesses.
184
'APPORT_DISABLE': '1',
188
def override_os_environ(test, env=None):
189
"""Modify os.environ keeping a copy.
191
:param test: A test instance
193
:param env: A dict containing variable definitions to be installed
196
env = isolated_environ
197
test._original_os_environ = dict([(var, value)
198
for var, value in os.environ.iteritems()])
199
for var, value in env.iteritems():
200
osutils.set_or_unset_env(var, value)
201
if var not in test._original_os_environ:
202
# The var is new, add it with a value of None, so
203
# restore_os_environ will delete it
204
test._original_os_environ[var] = None
207
def restore_os_environ(test):
208
"""Restore os.environ to its original state.
210
:param test: A test instance previously passed to override_os_environ.
212
for var, value in test._original_os_environ.iteritems():
213
# Restore the original value (or delete it if the value has been set to
214
# None in override_os_environ).
215
osutils.set_or_unset_env(var, value)
218
def _clear__type_equality_funcs(test):
219
"""Cleanup bound methods stored on TestCase instances
221
Clear the dict breaking a few (mostly) harmless cycles in the affected
222
unittests released with Python 2.6 and initial Python 2.7 versions.
224
For a few revisions between Python 2.7.1 and Python 2.7.2 that annoyingly
225
shipped in Oneiric, an object with no clear method was used, hence the
226
extra complications, see bug 809048 for details.
228
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
229
if type_equality_funcs is not None:
230
tef_clear = getattr(type_equality_funcs, "clear", None)
231
if tef_clear is None:
232
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
233
if tef_instance_dict is not None:
234
tef_clear = tef_instance_dict.clear
235
if tef_clear is not None:
239
class ExtendedTestResult(testtools.TextTestResult):
156
240
"""Accepts, reports and accumulates the results of running tests.
158
Compared to this unittest version this class adds support for profiling,
159
benchmarking, stopping as soon as a test fails, and skipping tests.
160
There are further-specialized subclasses for different types of display.
242
Compared to the unittest version this class adds support for
243
profiling, benchmarking, stopping as soon as a test fails, and
244
skipping tests. There are further-specialized subclasses for
245
different types of display.
247
When a test finishes, in whatever way, it calls one of the addSuccess,
248
addFailure or addError classes. These in turn may redirect to a more
249
specific case for the special test results supported by our extended
252
Note that just one of these objects is fed the results from many tests.
163
255
stop_early = False
165
257
def __init__(self, stream, descriptions, verbosity,
166
258
bench_history=None,
168
use_numbered_dirs=False,
170
261
"""Construct new TestResult.
172
263
:param bench_history: Optionally, a writable file object to accumulate
173
264
benchmark results.
175
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
266
testtools.TextTestResult.__init__(self, stream)
176
267
if bench_history is not None:
177
268
from bzrlib.version import _get_bzr_source_tree
178
269
src_tree = _get_bzr_source_tree()
224
377
def _shortened_test_description(self, test):
226
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
379
what = re.sub(r'^bzrlib\.tests\.', '', what)
382
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
383
# multiple times in a row, because the handler is added for
384
# each test but the container list is shared between cases.
385
# See lp:498869 lp:625574 and lp:637725 for background.
386
def _record_traceback_from_test(self, exc_info):
387
"""Store the traceback from passed exc_info tuple till"""
388
self._traceback_from_test = exc_info[2]
229
390
def startTest(self, test):
230
unittest.TestResult.startTest(self, test)
391
super(ExtendedTestResult, self).startTest(test)
231
395
self.report_test_start(test)
232
396
test.number = self.count
233
397
self._recordTestStartTime()
398
# Make testtools cases give us the real traceback on failure
399
addOnException = getattr(test, "addOnException", None)
400
if addOnException is not None:
401
addOnException(self._record_traceback_from_test)
402
# Only check for thread leaks on bzrlib derived test cases
403
if isinstance(test, TestCase):
404
test.addCleanup(self._check_leaked_threads, test)
406
def stopTest(self, test):
407
super(ExtendedTestResult, self).stopTest(test)
408
# Manually break cycles, means touching various private things but hey
409
getDetails = getattr(test, "getDetails", None)
410
if getDetails is not None:
412
_clear__type_equality_funcs(test)
413
self._traceback_from_test = None
415
def startTests(self):
416
self.report_tests_starting()
417
self._active_threads = threading.enumerate()
419
def _check_leaked_threads(self, test):
420
"""See if any threads have leaked since last call
422
A sample of live threads is stored in the _active_threads attribute,
423
when this method runs it compares the current live threads and any not
424
in the previous sample are treated as having leaked.
426
now_active_threads = set(threading.enumerate())
427
threads_leaked = now_active_threads.difference(self._active_threads)
429
self._report_thread_leak(test, threads_leaked, now_active_threads)
430
self._tests_leaking_threads_count += 1
431
if self._first_thread_leaker_id is None:
432
self._first_thread_leaker_id = test.id()
433
self._active_threads = now_active_threads
235
435
def _recordTestStartTime(self):
236
436
"""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:
437
self._start_datetime = self._now()
246
439
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)
440
"""Tell result that test finished with an error.
442
Called from the TestCase run() method when the test
443
fails with an unexpected error.
445
self._post_mortem(self._traceback_from_test)
446
super(ExtendedTestResult, self).addError(test, err)
254
447
self.error_count += 1
255
448
self.report_error(test, err)
256
449
if self.stop_early:
259
452
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)
453
"""Tell result that test failed.
455
Called from the TestCase run() method when the test
456
fails because e.g. an assert() method failed.
458
self._post_mortem(self._traceback_from_test)
459
super(ExtendedTestResult, self).addFailure(test, err)
265
460
self.failure_count += 1
266
461
self.report_failure(test, err)
267
462
if self.stop_early:
270
def addKnownFailure(self, test, err):
465
def addSuccess(self, test, details=None):
466
"""Tell result that test completed successfully.
468
Called from the TestCase run()
470
if self._bench_history is not None:
471
benchmark_time = self._extractBenchmarkTime(test, details)
472
if benchmark_time is not None:
473
self._bench_history.write("%s %s\n" % (
474
self._formatTime(benchmark_time),
476
self.report_success(test)
477
super(ExtendedTestResult, self).addSuccess(test)
478
test._log_contents = ''
480
def addExpectedFailure(self, test, err):
271
481
self.known_failure_count += 1
272
482
self.report_known_failure(test, err)
484
def addUnexpectedSuccess(self, test, details=None):
485
"""Tell result the test unexpectedly passed, counting as a failure
487
When the minimum version of testtools required becomes 0.9.8 this
488
can be updated to use the new handling there.
490
super(ExtendedTestResult, self).addFailure(test, details=details)
491
self.failure_count += 1
492
self.report_unexpected_success(test,
493
"".join(details["reason"].iter_text()))
274
497
def addNotSupported(self, test, feature):
498
"""The test will not be run because of a missing feature.
500
# this can be called in two different ways: it may be that the
501
# test started running, and then raised (through requireFeature)
502
# UnavailableFeature. Alternatively this method can be called
503
# while probing for features before running the test code proper; in
504
# that case we will see startTest and stopTest, but the test will
505
# never actually run.
275
506
self.unsupported.setdefault(str(feature), 0)
276
507
self.unsupported[str(feature)] += 1
277
508
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
if self.use_numbered_dirs:
307
self.stream.write('#%d ' % test.number)
308
self.stream.writeln(self.getDescription(test))
309
if getattr(test, '_get_log', None) is not None:
311
print >>self.stream, \
312
('vvvv[log from %s]' % test.id()).ljust(78,'-')
313
print >>self.stream, test._get_log()
314
print >>self.stream, \
315
('^^^^[log from %s]' % test.id()).ljust(78,'-')
316
self.stream.writeln(self.separator2)
317
self.stream.writeln("%s" % err)
322
def report_cleaning_up(self):
510
def addSkip(self, test, reason):
511
"""A test has not run for 'reason'."""
513
self.report_skip(test, reason)
515
def addNotApplicable(self, test, reason):
516
self.not_applicable_count += 1
517
self.report_not_applicable(test, reason)
519
def _count_stored_tests(self):
520
"""Count of tests instances kept alive due to not succeeding"""
521
return self.error_count + self.failure_count + self.known_failure_count
523
def _post_mortem(self, tb=None):
524
"""Start a PDB post mortem session."""
525
if os.environ.get('BZR_TEST_PDB', None):
529
def progress(self, offset, whence):
530
"""The test is adjusting the count of tests to run."""
531
if whence == SUBUNIT_SEEK_SET:
532
self.num_tests = offset
533
elif whence == SUBUNIT_SEEK_CUR:
534
self.num_tests += offset
536
raise errors.BzrError("Unknown whence %r" % whence)
538
def report_tests_starting(self):
539
"""Display information before the test run begins"""
540
if getattr(sys, 'frozen', None) is None:
541
bzr_path = osutils.realpath(sys.argv[0])
543
bzr_path = sys.executable
545
'bzr selftest: %s\n' % (bzr_path,))
548
bzrlib.__path__[0],))
550
' bzr-%s python-%s %s\n' % (
551
bzrlib.version_string,
552
bzrlib._format_version_tuple(sys.version_info),
553
platform.platform(aliased=1),
555
self.stream.write('\n')
557
def report_test_start(self, test):
558
"""Display information on the test just about to be run"""
560
def _report_thread_leak(self, test, leaked_threads, active_threads):
561
"""Display information on a test that leaked one or more threads"""
562
# GZ 2010-09-09: A leak summary reported separately from the general
563
# thread debugging would be nice. Tests under subunit
564
# need something not using stream, perhaps adding a
565
# testtools details object would be fitting.
566
if 'threads' in selftest_debug_flags:
567
self.stream.write('%s is leaking, active is now %d\n' %
568
(test.id(), len(active_threads)))
570
def startTestRun(self):
571
self.startTime = time.time()
325
573
def report_success(self, test):
576
def wasStrictlySuccessful(self):
577
if self.unsupported or self.known_failure_count:
579
return self.wasSuccessful()
329
582
class TextTestResult(ExtendedTestResult):
330
583
"""Displays progress and results of tests in text form"""
332
585
def __init__(self, stream, descriptions, verbosity,
333
586
bench_history=None,
336
use_numbered_dirs=False,
338
590
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
339
bench_history, num_tests, use_numbered_dirs)
341
self.pb = self.ui.nested_progress_bar()
342
self._supplied_pb = False
345
self._supplied_pb = True
591
bench_history, strict)
592
# We no longer pass them around, but just rely on the UIFactory stack
595
warnings.warn("Passing pb to TextTestResult is deprecated")
596
self.pb = self.ui.nested_progress_bar()
346
597
self.pb.show_pct = False
347
598
self.pb.show_spinner = False
348
599
self.pb.show_eta = False,
349
600
self.pb.show_count = False
350
601
self.pb.show_bar = False
352
def report_starting(self):
353
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
602
self.pb.update_latency = 0
603
self.pb.show_transport_activity = False
605
def stopTestRun(self):
606
# called when the tests that are going to run have run
609
super(TextTestResult, self).stopTestRun()
611
def report_tests_starting(self):
612
super(TextTestResult, self).report_tests_starting()
613
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
355
615
def _progress_prefix_text(self):
356
a = '[%d' % self.count
357
if self.num_tests is not None:
616
# the longer this text, the less space we have to show the test
618
a = '[%d' % self.count # total that have been run
619
# tests skipped as known not to be relevant are not important enough
621
## if self.skip_count:
622
## a += ', %d skip' % self.skip_count
623
## if self.known_failure_count:
624
## a += '+%dX' % self.known_failure_count
358
626
a +='/%d' % self.num_tests
359
a += ' in %ds' % (time.time() - self._overall_start_time)
361
a += ', %d errors' % self.error_count
362
if self.failure_count:
363
a += ', %d failed' % self.failure_count
364
if self.known_failure_count:
365
a += ', %d known failures' % self.known_failure_count
367
a += ', %d skipped' % self.skip_count
369
a += ', %d missing features' % len(self.unsupported)
628
runtime = time.time() - self._overall_start_time
630
a += '%dm%ds' % (runtime / 60, runtime % 60)
633
total_fail_count = self.error_count + self.failure_count
635
a += ', %d failed' % total_fail_count
636
# if self.unsupported:
637
# a += ', %d missing' % len(self.unsupported)
373
641
def report_test_start(self, test):
376
643
self._progress_prefix_text()
378
645
+ self._shortened_test_description(test))
380
647
def _test_description(self, test):
381
if self.use_numbered_dirs:
382
return '#%d %s' % (self.count,
383
self._shortened_test_description(test))
385
return self._shortened_test_description(test)
648
return self._shortened_test_description(test)
387
650
def report_error(self, test, err):
388
self.pb.note('ERROR: %s\n %s\n',
651
self.stream.write('ERROR: %s\n %s\n' % (
389
652
self._test_description(test),
393
656
def report_failure(self, test, err):
394
self.pb.note('FAIL: %s\n %s\n',
657
self.stream.write('FAIL: %s\n %s\n' % (
395
658
self._test_description(test),
399
662
def report_known_failure(self, test, err):
400
self.pb.note('XFAIL: %s\n%s\n',
401
self._test_description(test), err[1])
403
def report_skip(self, test, skip_excinfo):
406
# at the moment these are mostly not things we can fix
407
# and so they just produce stipple; use the verbose reporter
410
# show test and reason for skip
411
self.pb.note('SKIP: %s\n %s\n',
412
self._shortened_test_description(test),
415
# since the class name was left behind in the still-visible
417
self.pb.note('SKIP: %s', skip_excinfo[1])
665
def report_unexpected_success(self, test, reason):
666
self.stream.write('FAIL: %s\n %s: %s\n' % (
667
self._test_description(test),
668
"Unexpected success. Should have failed",
672
def report_skip(self, test, reason):
675
def report_not_applicable(self, test, reason):
419
678
def report_unsupported(self, test, feature):
420
679
"""test cannot be run because feature is missing."""
422
def report_cleaning_up(self):
423
self.pb.update('cleaning up...')
426
if not self._supplied_pb:
430
682
class VerboseTestResult(ExtendedTestResult):
723
973
retrieved by _get_log(). We use a real OS file, not an in-memory object,
724
974
so that it can also capture file IO. When the test completes this file
725
975
is read into memory and removed from disk.
727
977
There are also convenience functions to invoke bzr's command-line
728
978
routine, and to build and check bzr trees.
730
980
In addition to the usual method of overriding tearDown(), this class also
731
allows subclasses to register functions into the _cleanups list, which is
981
allows subclasses to register cleanup functions via addCleanup, which are
732
982
run in order as the object is torn down. It's less likely this will be
733
983
accidentally overlooked.
736
_log_file_name = None
738
_keep_log_file = False
739
987
# record lsprof data when performing benchmark calls.
740
988
_gather_lsprof_in_benchmarks = False
742
990
def __init__(self, methodName='testMethod'):
743
991
super(TestCase, self).__init__(methodName)
992
self._directory_isolation = True
993
self.exception_handlers.insert(0,
994
(UnavailableFeature, self._do_unsupported_or_skip))
995
self.exception_handlers.insert(0,
996
(TestNotApplicable, self._do_not_applicable))
747
unittest.TestCase.setUp(self)
999
super(TestCase, self).setUp()
1001
timeout = config.GlobalStack().get('selftest.timeout')
1003
timeout_fixture = fixtures.TimeoutFixture(timeout)
1004
timeout_fixture.setUp()
1005
self.addCleanup(timeout_fixture.cleanUp)
1007
for feature in getattr(self, '_test_needs_features', []):
1008
self.requireFeature(feature)
748
1009
self._cleanEnvironment()
749
bzrlib.trace.disable_default_logging()
1011
if bzrlib.global_state is not None:
1012
self.overrideAttr(bzrlib.global_state, 'cmdline_overrides',
1013
config.CommandLineStore())
750
1015
self._silenceUI()
751
1016
self._startLogFile()
752
1017
self._benchcalls = []
753
1018
self._benchtime = None
754
1019
self._clear_hooks()
1020
self._track_transports()
755
1022
self._clear_debug_flags()
1023
# Isolate global verbosity level, to make sure it's reproducible
1024
# between tests. We should get rid of this altogether: bug 656694. --
1026
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
1027
# Isolate config option expansion until its default value for bzrlib is
1028
# settled on or a the FIXME associated with _get_expand_default_value
1029
# is addressed -- vila 20110219
1030
self.overrideAttr(config, '_expand_default_value', None)
1031
self._log_files = set()
1032
# Each key in the ``_counters`` dict holds a value for a different
1033
# counter. When the test ends, addDetail() should be used to output the
1034
# counter values. This happens in install_counter_hook().
1036
if 'config_stats' in selftest_debug_flags:
1037
self._install_config_stats_hooks()
1038
# Do not use i18n for tests (unless the test reverses this)
1044
# The sys preserved stdin/stdout should allow blackbox tests debugging
1045
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
1046
).set_trace(sys._getframe().f_back)
1048
def discardDetail(self, name):
1049
"""Extend the addDetail, getDetails api so we can remove a detail.
1051
eg. bzr always adds the 'log' detail at startup, but we don't want to
1052
include it for skipped, xfail, etc tests.
1054
It is safe to call this for a detail that doesn't exist, in case this
1055
gets called multiple times.
1057
# We cheat. details is stored in __details which means we shouldn't
1058
# touch it. but getDetails() returns the dict directly, so we can
1060
details = self.getDetails()
1064
def install_counter_hook(self, hooks, name, counter_name=None):
1065
"""Install a counting hook.
1067
Any hook can be counted as long as it doesn't need to return a value.
1069
:param hooks: Where the hook should be installed.
1071
:param name: The hook name that will be counted.
1073
:param counter_name: The counter identifier in ``_counters``, defaults
1076
_counters = self._counters # Avoid closing over self
1077
if counter_name is None:
1079
if _counters.has_key(counter_name):
1080
raise AssertionError('%s is already used as a counter name'
1082
_counters[counter_name] = 0
1083
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1084
lambda: ['%d' % (_counters[counter_name],)]))
1085
def increment_counter(*args, **kwargs):
1086
_counters[counter_name] += 1
1087
label = 'count %s calls' % (counter_name,)
1088
hooks.install_named_hook(name, increment_counter, label)
1089
self.addCleanup(hooks.uninstall_named_hook, name, label)
1091
def _install_config_stats_hooks(self):
1092
"""Install config hooks to count hook calls.
1095
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1096
self.install_counter_hook(config.ConfigHooks, hook_name,
1097
'config.%s' % (hook_name,))
1099
# The OldConfigHooks are private and need special handling to protect
1100
# against recursive tests (tests that run other tests), so we just do
1101
# manually what registering them into _builtin_known_hooks will provide
1103
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1104
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1105
self.install_counter_hook(config.OldConfigHooks, hook_name,
1106
'old_config.%s' % (hook_name,))
757
1108
def _clear_debug_flags(self):
758
1109
"""Prevent externally set debug flags affecting tests.
760
1111
Tests that want to use debug flags can just set them in the
761
1112
debug_flags set during setup/teardown.
763
self._preserved_debug_flags = set(debug.debug_flags)
764
debug.debug_flags.clear()
765
self.addCleanup(self._restore_debug_flags)
1114
# Start with a copy of the current debug flags we can safely modify.
1115
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1116
if 'allow_debug' not in selftest_debug_flags:
1117
debug.debug_flags.clear()
1118
if 'disable_lock_checks' not in selftest_debug_flags:
1119
debug.debug_flags.add('strict_locks')
767
1121
def _clear_hooks(self):
768
1122
# prevent hooks affecting tests
770
import bzrlib.smart.server
771
self._preserved_hooks = {
772
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
773
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
1123
known_hooks = hooks.known_hooks
1124
self._preserved_hooks = {}
1125
for key, (parent, name) in known_hooks.iter_parent_objects():
1126
current_hooks = getattr(parent, name)
1127
self._preserved_hooks[parent] = (name, current_hooks)
1128
self._preserved_lazy_hooks = hooks._lazy_hooks
1129
hooks._lazy_hooks = {}
775
1130
self.addCleanup(self._restoreHooks)
776
# reset all hooks to an empty instance of the appropriate type
777
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
778
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
1131
for key, (parent, name) in known_hooks.iter_parent_objects():
1132
factory = known_hooks.get(key)
1133
setattr(parent, name, factory())
1134
# this hook should always be installed
1135
request._install_hook()
1137
def disable_directory_isolation(self):
1138
"""Turn off directory isolation checks."""
1139
self._directory_isolation = False
1141
def enable_directory_isolation(self):
1142
"""Enable directory isolation checks."""
1143
self._directory_isolation = True
780
1145
def _silenceUI(self):
781
1146
"""Turn off UI for duration of test"""
782
1147
# by default the UI is off; tests can turn it on if they want it.
783
saved = ui.ui_factory
785
ui.ui_factory = saved
786
ui.ui_factory = ui.SilentUIFactory()
787
self.addCleanup(_restore)
1148
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1150
def _check_locks(self):
1151
"""Check that all lock take/release actions have been paired."""
1152
# We always check for mismatched locks. If a mismatch is found, we
1153
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1154
# case we just print a warning.
1156
acquired_locks = [lock for action, lock in self._lock_actions
1157
if action == 'acquired']
1158
released_locks = [lock for action, lock in self._lock_actions
1159
if action == 'released']
1160
broken_locks = [lock for action, lock in self._lock_actions
1161
if action == 'broken']
1162
# trivially, given the tests for lock acquistion and release, if we
1163
# have as many in each list, it should be ok. Some lock tests also
1164
# break some locks on purpose and should be taken into account by
1165
# considering that breaking a lock is just a dirty way of releasing it.
1166
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1168
'Different number of acquired and '
1169
'released or broken locks.\n'
1173
(acquired_locks, released_locks, broken_locks))
1174
if not self._lock_check_thorough:
1175
# Rather than fail, just warn
1176
print "Broken test %s: %s" % (self, message)
1180
def _track_locks(self):
1181
"""Track lock activity during tests."""
1182
self._lock_actions = []
1183
if 'disable_lock_checks' in selftest_debug_flags:
1184
self._lock_check_thorough = False
1186
self._lock_check_thorough = True
1188
self.addCleanup(self._check_locks)
1189
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1190
self._lock_acquired, None)
1191
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1192
self._lock_released, None)
1193
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1194
self._lock_broken, None)
1196
def _lock_acquired(self, result):
1197
self._lock_actions.append(('acquired', result))
1199
def _lock_released(self, result):
1200
self._lock_actions.append(('released', result))
1202
def _lock_broken(self, result):
1203
self._lock_actions.append(('broken', result))
1205
def permit_dir(self, name):
1206
"""Permit a directory to be used by this test. See permit_url."""
1207
name_transport = _mod_transport.get_transport_from_path(name)
1208
self.permit_url(name)
1209
self.permit_url(name_transport.base)
1211
def permit_url(self, url):
1212
"""Declare that url is an ok url to use in this test.
1214
Do this for memory transports, temporary test directory etc.
1216
Do not do this for the current working directory, /tmp, or any other
1217
preexisting non isolated url.
1219
if not url.endswith('/'):
1221
self._bzr_selftest_roots.append(url)
1223
def permit_source_tree_branch_repo(self):
1224
"""Permit the source tree bzr is running from to be opened.
1226
Some code such as bzrlib.version attempts to read from the bzr branch
1227
that bzr is executing from (if any). This method permits that directory
1228
to be used in the test suite.
1230
path = self.get_source_path()
1231
self.record_directory_isolation()
1234
workingtree.WorkingTree.open(path)
1235
except (errors.NotBranchError, errors.NoWorkingTree):
1236
raise TestSkipped('Needs a working tree of bzr sources')
1238
self.enable_directory_isolation()
1240
def _preopen_isolate_transport(self, transport):
1241
"""Check that all transport openings are done in the test work area."""
1242
while isinstance(transport, pathfilter.PathFilteringTransport):
1243
# Unwrap pathfiltered transports
1244
transport = transport.server.backing_transport.clone(
1245
transport._filter('.'))
1246
url = transport.base
1247
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1248
# urls it is given by prepending readonly+. This is appropriate as the
1249
# client shouldn't know that the server is readonly (or not readonly).
1250
# We could register all servers twice, with readonly+ prepending, but
1251
# that makes for a long list; this is about the same but easier to
1253
if url.startswith('readonly+'):
1254
url = url[len('readonly+'):]
1255
self._preopen_isolate_url(url)
1257
def _preopen_isolate_url(self, url):
1258
if not self._directory_isolation:
1260
if self._directory_isolation == 'record':
1261
self._bzr_selftest_roots.append(url)
1263
# This prevents all transports, including e.g. sftp ones backed on disk
1264
# from working unless they are explicitly granted permission. We then
1265
# depend on the code that sets up test transports to check that they are
1266
# appropriately isolated and enable their use by calling
1267
# self.permit_transport()
1268
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1269
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1270
% (url, self._bzr_selftest_roots))
1272
def record_directory_isolation(self):
1273
"""Gather accessed directories to permit later access.
1275
This is used for tests that access the branch bzr is running from.
1277
self._directory_isolation = "record"
1279
def start_server(self, transport_server, backing_server=None):
1280
"""Start transport_server for this test.
1282
This starts the server, registers a cleanup for it and permits the
1283
server's urls to be used.
1285
if backing_server is None:
1286
transport_server.start_server()
1288
transport_server.start_server(backing_server)
1289
self.addCleanup(transport_server.stop_server)
1290
# Obtain a real transport because if the server supplies a password, it
1291
# will be hidden from the base on the client side.
1292
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1293
# Some transport servers effectively chroot the backing transport;
1294
# others like SFTPServer don't - users of the transport can walk up the
1295
# transport to read the entire backing transport. This wouldn't matter
1296
# except that the workdir tests are given - and that they expect the
1297
# server's url to point at - is one directory under the safety net. So
1298
# Branch operations into the transport will attempt to walk up one
1299
# directory. Chrooting all servers would avoid this but also mean that
1300
# we wouldn't be testing directly against non-root urls. Alternatively
1301
# getting the test framework to start the server with a backing server
1302
# at the actual safety net directory would work too, but this then
1303
# means that the self.get_url/self.get_transport methods would need
1304
# to transform all their results. On balance its cleaner to handle it
1305
# here, and permit a higher url when we have one of these transports.
1306
if t.base.endswith('/work/'):
1307
# we have safety net/test root/work
1308
t = t.clone('../..')
1309
elif isinstance(transport_server,
1310
test_server.SmartTCPServer_for_testing):
1311
# The smart server adds a path similar to work, which is traversed
1312
# up from by the client. But the server is chrooted - the actual
1313
# backing transport is not escaped from, and VFS requests to the
1314
# root will error (because they try to escape the chroot).
1316
while t2.base != t.base:
1319
self.permit_url(t.base)
1321
def _track_transports(self):
1322
"""Install checks for transport usage."""
1323
# TestCase has no safe place it can write to.
1324
self._bzr_selftest_roots = []
1325
# Currently the easiest way to be sure that nothing is going on is to
1326
# hook into bzr dir opening. This leaves a small window of error for
1327
# transport tests, but they are well known, and we can improve on this
1329
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1330
self._preopen_isolate_transport, "Check bzr directories are safe.")
789
1332
def _ndiff_strings(self, a, b):
790
1333
"""Return ndiff between two strings containing lines.
792
1335
A trailing newline is added if missing to make the strings
793
1336
print properly."""
794
1337
if b and b[-1] != '\n':
1024
1676
self.assertEqual(expected_first_warning, call_warnings[0])
1679
def callCatchWarnings(self, fn, *args, **kw):
1680
"""Call a callable that raises python warnings.
1682
The caller's responsible for examining the returned warnings.
1684
If the callable raises an exception, the exception is not
1685
caught and propagates up to the caller. In that case, the list
1686
of warnings is not available.
1688
:returns: ([warning_object, ...], fn_result)
1690
# XXX: This is not perfect, because it completely overrides the
1691
# warnings filters, and some code may depend on suppressing particular
1692
# warnings. It's the easiest way to insulate ourselves from -Werror,
1693
# though. -- Andrew, 20071062
1695
def _catcher(message, category, filename, lineno, file=None, line=None):
1696
# despite the name, 'message' is normally(?) a Warning subclass
1698
wlist.append(message)
1699
saved_showwarning = warnings.showwarning
1700
saved_filters = warnings.filters
1702
warnings.showwarning = _catcher
1703
warnings.filters = []
1704
result = fn(*args, **kw)
1706
warnings.showwarning = saved_showwarning
1707
warnings.filters = saved_filters
1708
return wlist, result
1027
1710
def callDeprecated(self, expected, callable, *args, **kwargs):
1028
1711
"""Assert that a callable is deprecated in a particular way.
1030
This is a very precise test for unusual requirements. The
1713
This is a very precise test for unusual requirements. The
1031
1714
applyDeprecated helper function is probably more suited for most tests
1032
1715
as it allows you to simply specify the deprecation format being used
1033
1716
and will ensure that that is issued for the function being called.
1035
1718
Note that this only captures warnings raised by symbol_versioning.warn,
1036
not other callers that go direct to the warning module.
1719
not other callers that go direct to the warning module. To catch
1720
general warnings, use callCatchWarnings.
1038
1722
:param expected: a list of the deprecation warnings expected, in order
1039
1723
:param callable: The callable to call
1040
1724
:param args: The positional arguments for the callable
1041
1725
:param kwargs: The keyword arguments for the callable
1043
call_warnings, result = self._capture_warnings(callable,
1727
call_warnings, result = self._capture_deprecation_warnings(callable,
1044
1728
*args, **kwargs)
1045
1729
self.assertEqual(expected, call_warnings)
1048
1732
def _startLogFile(self):
1049
"""Send bzr and test log messages to a temporary file.
1051
The file is removed as the test is torn down.
1053
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1054
self._log_file = os.fdopen(fileno, 'w+')
1055
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1056
self._log_file_name = name
1733
"""Setup a in-memory target for bzr and testcase log messages"""
1734
pseudo_log_file = StringIO()
1735
def _get_log_contents_for_weird_testtools_api():
1736
return [pseudo_log_file.getvalue().decode(
1737
"utf-8", "replace").encode("utf-8")]
1738
self.addDetail("log", content.Content(content.ContentType("text",
1739
"plain", {"charset": "utf8"}),
1740
_get_log_contents_for_weird_testtools_api))
1741
self._log_file = pseudo_log_file
1742
self._log_memento = trace.push_log_file(self._log_file)
1057
1743
self.addCleanup(self._finishLogFile)
1059
1745
def _finishLogFile(self):
1060
"""Finished with the log file.
1062
Close the file and delete it, unless setKeepLogfile was called.
1064
if self._log_file is None:
1066
bzrlib.trace.disable_test_log(self._log_nonce)
1067
self._log_file.close()
1068
self._log_file = None
1069
if not self._keep_log_file:
1070
os.remove(self._log_file_name)
1071
self._log_file_name = None
1073
def setKeepLogfile(self):
1074
"""Make the logfile not be deleted when _finishLogFile is called."""
1075
self._keep_log_file = True
1077
def addCleanup(self, callable):
1078
"""Arrange to run a callable when this case is torn down.
1080
Callables are run in the reverse of the order they are registered,
1081
ie last-in first-out.
1083
if callable in self._cleanups:
1084
raise ValueError("cleanup function %r already registered on %s"
1086
self._cleanups.append(callable)
1746
"""Flush and dereference the in-memory log for this testcase"""
1747
if trace._trace_file:
1748
# flush the log file, to get all content
1749
trace._trace_file.flush()
1750
trace.pop_log_file(self._log_memento)
1751
# The logging module now tracks references for cleanup so discard ours
1752
del self._log_memento
1754
def thisFailsStrictLockCheck(self):
1755
"""It is known that this test would fail with -Dstrict_locks.
1757
By default, all tests are run with strict lock checking unless
1758
-Edisable_lock_checks is supplied. However there are some tests which
1759
we know fail strict locks at this point that have not been fixed.
1760
They should call this function to disable the strict checking.
1762
This should be used sparingly, it is much better to fix the locking
1763
issues rather than papering over the problem by calling this function.
1765
debug.debug_flags.discard('strict_locks')
1767
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1768
"""Overrides an object attribute restoring it after the test.
1770
:note: This should be used with discretion; you should think about
1771
whether it's better to make the code testable without monkey-patching.
1773
:param obj: The object that will be mutated.
1775
:param attr_name: The attribute name we want to preserve/override in
1778
:param new: The optional value we want to set the attribute to.
1780
:returns: The actual attr value.
1782
value = getattr(obj, attr_name)
1783
# The actual value is captured by the call below
1784
self.addCleanup(setattr, obj, attr_name, value)
1785
if new is not _unitialized_attr:
1786
setattr(obj, attr_name, new)
1789
def overrideEnv(self, name, new):
1790
"""Set an environment variable, and reset it after the test.
1792
:param name: The environment variable name.
1794
:param new: The value to set the variable to. If None, the
1795
variable is deleted from the environment.
1797
:returns: The actual variable value.
1799
value = osutils.set_or_unset_env(name, new)
1800
self.addCleanup(osutils.set_or_unset_env, name, value)
1803
def recordCalls(self, obj, attr_name):
1804
"""Monkeypatch in a wrapper that will record calls.
1806
The monkeypatch is automatically removed when the test concludes.
1808
:param obj: The namespace holding the reference to be replaced;
1809
typically a module, class, or object.
1810
:param attr_name: A string for the name of the attribute to
1812
:returns: A list that will be extended with one item every time the
1813
function is called, with a tuple of (args, kwargs).
1817
def decorator(*args, **kwargs):
1818
calls.append((args, kwargs))
1819
return orig(*args, **kwargs)
1820
orig = self.overrideAttr(obj, attr_name, decorator)
1088
1823
def _cleanEnvironment(self):
1090
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1091
'HOME': os.getcwd(),
1092
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1094
'BZREMAIL': None, # may still be present in the environment
1096
'BZR_PROGRESS_BAR': None,
1100
'https_proxy': None,
1101
'HTTPS_PROXY': None,
1106
# Nobody cares about these ones AFAIK. So far at
1107
# least. If you do (care), please update this comment
1111
'BZR_REMOTE_PATH': None,
1114
self.addCleanup(self._restoreEnvironment)
1115
for name, value in new_env.iteritems():
1116
self._captureVar(name, value)
1118
def _captureVar(self, name, newvalue):
1119
"""Set an environment variable, and reset it when finished."""
1120
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1122
def _restore_debug_flags(self):
1123
debug.debug_flags.clear()
1124
debug.debug_flags.update(self._preserved_debug_flags)
1126
def _restoreEnvironment(self):
1127
for name, value in self.__old_env.iteritems():
1128
osutils.set_or_unset_env(name, value)
1824
for name, value in isolated_environ.iteritems():
1825
self.overrideEnv(name, value)
1130
1827
def _restoreHooks(self):
1131
for klass, hooks in self._preserved_hooks.items():
1132
setattr(klass, 'hooks', hooks)
1828
for klass, (name, hooks) in self._preserved_hooks.items():
1829
setattr(klass, name, hooks)
1830
self._preserved_hooks.clear()
1831
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1832
self._preserved_lazy_hooks.clear()
1134
1834
def knownFailure(self, reason):
1135
"""This test has failed for some known reason."""
1136
raise KnownFailure(reason)
1138
def run(self, result=None):
1139
if result is None: result = self.defaultTestResult()
1140
for feature in getattr(self, '_test_needs_features', []):
1141
if not feature.available():
1142
result.startTest(self)
1143
if getattr(result, 'addNotSupported', None):
1144
result.addNotSupported(self, feature)
1146
result.addSuccess(self)
1147
result.stopTest(self)
1149
return unittest.TestCase.run(self, result)
1153
unittest.TestCase.tearDown(self)
1835
"""Declare that this test fails for a known reason
1837
Tests that are known to fail should generally be using expectedFailure
1838
with an appropriate reverse assertion if a change could cause the test
1839
to start passing. Conversely if the test has no immediate prospect of
1840
succeeding then using skip is more suitable.
1842
When this method is called while an exception is being handled, that
1843
traceback will be used, otherwise a new exception will be thrown to
1844
provide one but won't be reported.
1846
self._add_reason(reason)
1848
exc_info = sys.exc_info()
1849
if exc_info != (None, None, None):
1850
self._report_traceback(exc_info)
1853
raise self.failureException(reason)
1854
except self.failureException:
1855
exc_info = sys.exc_info()
1856
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1857
raise testtools.testcase._ExpectedFailure(exc_info)
1861
def _suppress_log(self):
1862
"""Remove the log info from details."""
1863
self.discardDetail('log')
1865
def _do_skip(self, result, reason):
1866
self._suppress_log()
1867
addSkip = getattr(result, 'addSkip', None)
1868
if not callable(addSkip):
1869
result.addSuccess(result)
1871
addSkip(self, reason)
1874
def _do_known_failure(self, result, e):
1875
self._suppress_log()
1876
err = sys.exc_info()
1877
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1878
if addExpectedFailure is not None:
1879
addExpectedFailure(self, err)
1881
result.addSuccess(self)
1884
def _do_not_applicable(self, result, e):
1886
reason = 'No reason given'
1889
self._suppress_log ()
1890
addNotApplicable = getattr(result, 'addNotApplicable', None)
1891
if addNotApplicable is not None:
1892
result.addNotApplicable(self, reason)
1894
self._do_skip(result, reason)
1897
def _report_skip(self, result, err):
1898
"""Override the default _report_skip.
1900
We want to strip the 'log' detail. If we waint until _do_skip, it has
1901
already been formatted into the 'reason' string, and we can't pull it
1904
self._suppress_log()
1905
super(TestCase, self)._report_skip(self, result, err)
1908
def _report_expected_failure(self, result, err):
1911
See _report_skip for motivation.
1913
self._suppress_log()
1914
super(TestCase, self)._report_expected_failure(self, result, err)
1917
def _do_unsupported_or_skip(self, result, e):
1919
self._suppress_log()
1920
addNotSupported = getattr(result, 'addNotSupported', None)
1921
if addNotSupported is not None:
1922
result.addNotSupported(self, reason)
1924
self._do_skip(result, reason)
1155
1926
def time(self, callable, *args, **kwargs):
1156
1927
"""Run callable and accrue the time it takes to the benchmark time.
1158
1929
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1159
1930
this will cause lsprofile statistics to be gathered and stored in
1160
1931
self._benchcalls.
1162
1933
if self._benchtime is None:
1934
self.addDetail('benchtime', content.Content(content.ContentType(
1935
"text", "plain"), lambda:[str(self._benchtime)]))
1163
1936
self._benchtime = 0
1164
1937
start = time.time()
1782
2589
base = self.get_vfs_only_server().get_url()
1783
2590
return self._adjust_url(base, relpath)
2592
def _create_safety_net(self):
2593
"""Make a fake bzr directory.
2595
This prevents any tests propagating up onto the TEST_ROOT directory's
2598
root = TestCaseWithMemoryTransport.TEST_ROOT
2599
# Make sure we get a readable and accessible home for .bzr.log
2600
# and/or config files, and not fallback to weird defaults (see
2601
# http://pad.lv/825027).
2602
self.assertIs(None, os.environ.get('BZR_HOME', None))
2603
os.environ['BZR_HOME'] = root
2604
wt = bzrdir.BzrDir.create_standalone_workingtree(root)
2605
del os.environ['BZR_HOME']
2606
# Hack for speed: remember the raw bytes of the dirstate file so that
2607
# we don't need to re-open the wt to check it hasn't changed.
2608
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
2609
wt.control_transport.get_bytes('dirstate'))
2611
def _check_safety_net(self):
2612
"""Check that the safety .bzr directory have not been touched.
2614
_make_test_root have created a .bzr directory to prevent tests from
2615
propagating. This method ensures than a test did not leaked.
2617
root = TestCaseWithMemoryTransport.TEST_ROOT
2618
t = _mod_transport.get_transport_from_path(root)
2619
self.permit_url(t.base)
2620
if (t.get_bytes('.bzr/checkout/dirstate') !=
2621
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
2622
# The current test have modified the /bzr directory, we need to
2623
# recreate a new one or all the followng tests will fail.
2624
# If you need to inspect its content uncomment the following line
2625
# import pdb; pdb.set_trace()
2626
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2627
self._create_safety_net()
2628
raise AssertionError('%s/.bzr should not be modified' % root)
1785
2630
def _make_test_root(self):
1786
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1788
root = tempfile.mkdtemp(prefix='testbzr-', suffix='.tmp')
1789
TestCaseWithMemoryTransport.TEST_ROOT = root
1791
# make a fake bzr directory there to prevent any tests propagating
1792
# up onto the source directory's real branch
1793
bzrdir.BzrDir.create_standalone_workingtree(root)
1795
# The same directory is used by all tests, and we're not specifically
1796
# told when all tests are finished. This will do.
1797
atexit.register(_rmtree_temp_dir, root)
2631
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2632
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2633
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2635
TestCaseWithMemoryTransport.TEST_ROOT = root
2637
self._create_safety_net()
2639
# The same directory is used by all tests, and we're not
2640
# specifically told when all tests are finished. This will do.
2641
atexit.register(_rmtree_temp_dir, root)
2643
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2644
self.addCleanup(self._check_safety_net)
1799
2646
def makeAndChdirToTestDir(self):
1800
2647
"""Create a temporary directories for this one test.
1802
2649
This must set self.test_home_dir and self.test_dir and chdir to
1805
2652
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1807
2654
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1808
2655
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1809
2656
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2657
self.permit_dir(self.test_dir)
1811
2659
def make_branch(self, relpath, format=None):
1812
2660
"""Create a branch on the transport at relpath."""
1813
2661
repo = self.make_repository(relpath, format=format)
1814
return repo.bzrdir.create_branch()
2662
return repo.bzrdir.create_branch(append_revisions_only=False)
2664
def get_default_format(self):
2667
def resolve_format(self, format):
2668
"""Resolve an object to a ControlDir format object.
2670
The initial format object can either already be
2671
a ControlDirFormat, None (for the default format),
2672
or a string with the name of the control dir format.
2674
:param format: Object to resolve
2675
:return A ControlDirFormat instance
2678
format = self.get_default_format()
2679
if isinstance(format, basestring):
2680
format = bzrdir.format_registry.make_bzrdir(format)
1816
2683
def make_bzrdir(self, relpath, format=None):
1818
2685
# might be a relative or absolute path
1819
2686
maybe_a_url = self.get_url(relpath)
1820
2687
segments = maybe_a_url.rsplit('/', 1)
1821
t = get_transport(maybe_a_url)
2688
t = _mod_transport.get_transport(maybe_a_url)
1822
2689
if len(segments) > 1 and segments[-1] not in ('', '.'):
1823
2690
t.ensure_base()
1826
if isinstance(format, basestring):
1827
format = bzrdir.format_registry.make_bzrdir(format)
2691
format = self.resolve_format(format)
1828
2692
return format.initialize_on_transport(t)
1829
2693
except errors.UninitializableFormat:
1830
2694
raise TestSkipped("Format %s is not initializable." % format)
1832
def make_repository(self, relpath, shared=False, format=None):
2696
def make_repository(self, relpath, shared=None, format=None):
1833
2697
"""Create a repository on our default transport at relpath.
1835
2699
Note that relpath must be a relative path, not a full url.
1837
2701
# FIXME: If you create a remoterepository this returns the underlying
1838
# real format, which is incorrect. Actually we should make sure that
2702
# real format, which is incorrect. Actually we should make sure that
1839
2703
# RemoteBzrDir returns a RemoteRepository.
1840
2704
# maybe mbp 20070410
1841
2705
made_control = self.make_bzrdir(relpath, format=format)
1842
2706
return made_control.create_repository(shared=shared)
2708
def make_smart_server(self, path, backing_server=None):
2709
if backing_server is None:
2710
backing_server = self.get_server()
2711
smart_server = test_server.SmartTCPServer_for_testing()
2712
self.start_server(smart_server, backing_server)
2713
remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
2715
return remote_transport
1844
2717
def make_branch_and_memory_tree(self, relpath, format=None):
1845
2718
"""Create a branch on the default transport and a MemoryTree for it."""
1846
2719
b = self.make_branch(relpath, format=format)
1847
2720
return memorytree.MemoryTree.create_on_branch(b)
2722
def make_branch_builder(self, relpath, format=None):
2723
branch = self.make_branch(relpath, format=format)
2724
return branchbuilder.BranchBuilder(branch=branch)
1849
2726
def overrideEnvironmentForTesting(self):
1850
os.environ['HOME'] = self.test_home_dir
1851
os.environ['BZR_HOME'] = self.test_home_dir
2727
test_home_dir = self.test_home_dir
2728
if isinstance(test_home_dir, unicode):
2729
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2730
self.overrideEnv('HOME', test_home_dir)
2731
self.overrideEnv('BZR_HOME', test_home_dir)
1853
2733
def setUp(self):
1854
2734
super(TestCaseWithMemoryTransport, self).setUp()
2736
def _add_disconnect_cleanup(transport):
2737
"""Schedule disconnection of given transport at test cleanup
2739
This needs to happen for all connected transports or leaks occur.
2741
Note reconnections may mean we call disconnect multiple times per
2742
transport which is suboptimal but seems harmless.
2744
self.addCleanup(transport.disconnect)
2746
_mod_transport.Transport.hooks.install_named_hook('post_connect',
2747
_add_disconnect_cleanup, None)
1855
2749
self._make_test_root()
1856
_currentdir = os.getcwdu()
1857
def _leaveDirectory():
1858
os.chdir(_currentdir)
1859
self.addCleanup(_leaveDirectory)
2750
self.addCleanup(os.chdir, os.getcwdu())
1860
2751
self.makeAndChdirToTestDir()
1861
2752
self.overrideEnvironmentForTesting()
1862
2753
self.__readonly_server = None
1863
2754
self.__server = None
1864
2755
self.reduceLockdirTimeout()
2757
def setup_smart_server_with_call_log(self):
2758
"""Sets up a smart server as the transport server with a call log."""
2759
self.transport_server = test_server.SmartTCPServer_for_testing
2760
self.hpss_calls = []
2762
# Skip the current stack down to the caller of
2763
# setup_smart_server_with_call_log
2764
prefix_length = len(traceback.extract_stack()) - 2
2765
def capture_hpss_call(params):
2766
self.hpss_calls.append(
2767
CapturedCall(params, prefix_length))
2768
client._SmartClient.hooks.install_named_hook(
2769
'call', capture_hpss_call, None)
2771
def reset_smart_call_log(self):
2772
self.hpss_calls = []
1867
2775
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1868
2776
"""Derived class that runs a test within a temporary directory.
2103
3048
for readonly urls.
2105
3050
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2106
be used without needed to redo it when a different
3051
be used without needed to redo it when a different
2107
3052
subclass is in use ?
2110
3055
def setUp(self):
3056
from bzrlib.tests import http_server
2111
3057
super(ChrootedTestCase, self).setUp()
2112
if not self.vfs_transport_factory == MemoryServer:
2113
self.transport_readonly_server = HttpServer
2116
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2117
random_order=False):
2118
"""Create a test suite by filtering another one.
3058
if not self.vfs_transport_factory == memory.MemoryServer:
3059
self.transport_readonly_server = http_server.HttpServer
3062
def condition_id_re(pattern):
3063
"""Create a condition filter which performs a re check on a test's id.
3065
:param pattern: A regular expression string.
3066
:return: A callable that returns True if the re matches.
3068
filter_re = re.compile(pattern, 0)
3069
def condition(test):
3071
return filter_re.search(test_id)
3075
def condition_isinstance(klass_or_klass_list):
3076
"""Create a condition filter which returns isinstance(param, klass).
3078
:return: A callable which when called with one parameter obj return the
3079
result of isinstance(obj, klass_or_klass_list).
3082
return isinstance(obj, klass_or_klass_list)
3086
def condition_id_in_list(id_list):
3087
"""Create a condition filter which verify that test's id in a list.
3089
:param id_list: A TestIdList object.
3090
:return: A callable that returns True if the test's id appears in the list.
3092
def condition(test):
3093
return id_list.includes(test.id())
3097
def condition_id_startswith(starts):
3098
"""Create a condition filter verifying that test's id starts with a string.
3100
:param starts: A list of string.
3101
:return: A callable that returns True if the test's id starts with one of
3104
def condition(test):
3105
for start in starts:
3106
if test.id().startswith(start):
3112
def exclude_tests_by_condition(suite, condition):
3113
"""Create a test suite which excludes some tests from suite.
3115
:param suite: The suite to get tests from.
3116
:param condition: A callable whose result evaluates True when called with a
3117
test case which should be excluded from the result.
3118
:return: A suite which contains the tests found in suite that fail
3122
for test in iter_suite_tests(suite):
3123
if not condition(test):
3125
return TestUtil.TestSuite(result)
3128
def filter_suite_by_condition(suite, condition):
3129
"""Create a test suite by filtering another one.
3131
:param suite: The source suite.
3132
:param condition: A callable whose result evaluates True when called with a
3133
test case which should be included in the result.
3134
:return: A suite which contains the tests found in suite that pass
3138
for test in iter_suite_tests(suite):
3141
return TestUtil.TestSuite(result)
3144
def filter_suite_by_re(suite, pattern):
3145
"""Create a test suite by filtering another one.
2120
3147
:param suite: the source suite
2121
3148
:param pattern: pattern that names must match
2122
:param exclude_pattern: pattern that names must not match, if any
2123
:param random_order: if True, tests in the new suite will be put in
2125
:returns: the newly created suite
2127
return sort_suite_by_re(suite, pattern, exclude_pattern,
2128
random_order, False)
2131
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2132
random_order=False, append_rest=True):
2133
"""Create a test suite by sorting another one.
2135
:param suite: the source suite
2136
:param pattern: pattern that names must match in order to go
2137
first in the new suite
2138
:param exclude_pattern: pattern that names must not match, if any
2139
:param random_order: if True, tests in the new suite will be put in
2141
:param append_rest: if False, pattern is a strict filter and not
2142
just an ordering directive
2143
:returns: the newly created suite
2147
filter_re = re.compile(pattern)
2148
if exclude_pattern is not None:
2149
exclude_re = re.compile(exclude_pattern)
3149
:returns: the newly created suite
3151
condition = condition_id_re(pattern)
3152
result_suite = filter_suite_by_condition(suite, condition)
3156
def filter_suite_by_id_list(suite, test_id_list):
3157
"""Create a test suite by filtering another one.
3159
:param suite: The source suite.
3160
:param test_id_list: A list of the test ids to keep as strings.
3161
:returns: the newly created suite
3163
condition = condition_id_in_list(test_id_list)
3164
result_suite = filter_suite_by_condition(suite, condition)
3168
def filter_suite_by_id_startswith(suite, start):
3169
"""Create a test suite by filtering another one.
3171
:param suite: The source suite.
3172
:param start: A list of string the test id must start with one of.
3173
:returns: the newly created suite
3175
condition = condition_id_startswith(start)
3176
result_suite = filter_suite_by_condition(suite, condition)
3180
def exclude_tests_by_re(suite, pattern):
3181
"""Create a test suite which excludes some tests from suite.
3183
:param suite: The suite to get tests from.
3184
:param pattern: A regular expression string. Test ids that match this
3185
pattern will be excluded from the result.
3186
:return: A TestSuite that contains all the tests from suite without the
3187
tests that matched pattern. The order of tests is the same as it was in
3190
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3193
def preserve_input(something):
3194
"""A helper for performing test suite transformation chains.
3196
:param something: Anything you want to preserve.
3202
def randomize_suite(suite):
3203
"""Return a new TestSuite with suite's tests in random order.
3205
The tests in the input suite are flattened into a single suite in order to
3206
accomplish this. Any nested TestSuites are removed to provide global
3209
tests = list(iter_suite_tests(suite))
3210
random.shuffle(tests)
3211
return TestUtil.TestSuite(tests)
3214
def split_suite_by_condition(suite, condition):
3215
"""Split a test suite into two by a condition.
3217
:param suite: The suite to split.
3218
:param condition: The condition to match on. Tests that match this
3219
condition are returned in the first test suite, ones that do not match
3220
are in the second suite.
3221
:return: A tuple of two test suites, where the first contains tests from
3222
suite matching the condition, and the second contains the remainder
3223
from suite. The order within each output suite is the same as it was in
2150
3228
for test in iter_suite_tests(suite):
2152
if exclude_pattern is None or not exclude_re.search(test_id):
2153
if filter_re.search(test_id):
2158
random.shuffle(first)
2159
random.shuffle(second)
2160
return TestUtil.TestSuite(first + second)
3230
matched.append(test)
3232
did_not_match.append(test)
3233
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3236
def split_suite_by_re(suite, pattern):
3237
"""Split a test suite into two by a regular expression.
3239
:param suite: The suite to split.
3240
:param pattern: A regular expression string. Test ids that match this
3241
pattern will be in the first test suite returned, and the others in the
3242
second test suite returned.
3243
:return: A tuple of two test suites, where the first contains tests from
3244
suite matching pattern, and the second contains the remainder from
3245
suite. The order within each output suite is the same as it was in
3248
return split_suite_by_condition(suite, condition_id_re(pattern))
2163
3251
def run_suite(suite, name='test', verbose=False, pattern=".*",
2164
3252
stop_on_failure=False,
2165
3253
transport=None, lsprof_timed=None, bench_history=None,
2166
3254
matching_tests_first=None,
2168
3255
list_only=False,
2169
3256
random_seed=None,
2170
3257
exclude_pattern=None,
3260
suite_decorators=None,
3262
result_decorators=None,
2172
use_numbered_dirs = bool(numbered_dirs)
3264
"""Run a test suite for bzr selftest.
3266
:param runner_class: The class of runner to use. Must support the
3267
constructor arguments passed by run_suite which are more than standard
3269
:return: A boolean indicating success.
2174
3271
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2175
if numbered_dirs is not None:
2176
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2181
runner = TextTestRunner(stream=sys.stdout,
3276
if runner_class is None:
3277
runner_class = TextTestRunner
3280
runner = runner_class(stream=stream,
2182
3281
descriptions=0,
2183
3282
verbosity=verbosity,
2184
3283
bench_history=bench_history,
2185
use_numbered_dirs=use_numbered_dirs,
2186
list_only=list_only,
3285
result_decorators=result_decorators,
2188
3287
runner.stop_on_failure=stop_on_failure
2189
# Initialise the random number generator and display the seed used.
2190
# We convert the seed to a long to make it reuseable across invocations.
2191
random_order = False
2192
if random_seed is not None:
2194
if random_seed == "now":
2195
random_seed = long(time.time())
3288
if isinstance(suite, unittest.TestSuite):
3289
# Empty out _tests list of passed suite and populate new TestSuite
3290
suite._tests[:], suite = [], TestSuite(suite)
3291
# built in decorator factories:
3293
random_order(random_seed, runner),
3294
exclude_tests(exclude_pattern),
3296
if matching_tests_first:
3297
decorators.append(tests_first(pattern))
3299
decorators.append(filter_tests(pattern))
3300
if suite_decorators:
3301
decorators.extend(suite_decorators)
3302
# tell the result object how many tests will be running: (except if
3303
# --parallel=fork is being used. Robert said he will provide a better
3304
# progress design later -- vila 20090817)
3305
if fork_decorator not in decorators:
3306
decorators.append(CountingDecorator)
3307
for decorator in decorators:
3308
suite = decorator(suite)
3310
# Done after test suite decoration to allow randomisation etc
3311
# to take effect, though that is of marginal benefit.
3313
stream.write("Listing tests only ...\n")
3314
for t in iter_suite_tests(suite):
3315
stream.write("%s\n" % (t.id()))
3317
result = runner.run(suite)
3319
return result.wasStrictlySuccessful()
3321
return result.wasSuccessful()
3324
# A registry where get() returns a suite decorator.
3325
parallel_registry = registry.Registry()
3328
def fork_decorator(suite):
3329
if getattr(os, "fork", None) is None:
3330
raise errors.BzrCommandError("platform does not support fork,"
3331
" try --parallel=subprocess instead.")
3332
concurrency = osutils.local_concurrency()
3333
if concurrency == 1:
3335
from testtools import ConcurrentTestSuite
3336
return ConcurrentTestSuite(suite, fork_for_tests)
3337
parallel_registry.register('fork', fork_decorator)
3340
def subprocess_decorator(suite):
3341
concurrency = osutils.local_concurrency()
3342
if concurrency == 1:
3344
from testtools import ConcurrentTestSuite
3345
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3346
parallel_registry.register('subprocess', subprocess_decorator)
3349
def exclude_tests(exclude_pattern):
3350
"""Return a test suite decorator that excludes tests."""
3351
if exclude_pattern is None:
3352
return identity_decorator
3353
def decorator(suite):
3354
return ExcludeDecorator(suite, exclude_pattern)
3358
def filter_tests(pattern):
3360
return identity_decorator
3361
def decorator(suite):
3362
return FilterTestsDecorator(suite, pattern)
3366
def random_order(random_seed, runner):
3367
"""Return a test suite decorator factory for randomising tests order.
3369
:param random_seed: now, a string which casts to a long, or a long.
3370
:param runner: A test runner with a stream attribute to report on.
3372
if random_seed is None:
3373
return identity_decorator
3374
def decorator(suite):
3375
return RandomDecorator(suite, random_seed, runner.stream)
3379
def tests_first(pattern):
3381
return identity_decorator
3382
def decorator(suite):
3383
return TestFirstDecorator(suite, pattern)
3387
def identity_decorator(suite):
3392
class TestDecorator(TestUtil.TestSuite):
3393
"""A decorator for TestCase/TestSuite objects.
3395
Contains rather than flattening suite passed on construction
3398
def __init__(self, suite=None):
3399
super(TestDecorator, self).__init__()
3400
if suite is not None:
3403
# Don't need subclass run method with suite emptying
3404
run = unittest.TestSuite.run
3407
class CountingDecorator(TestDecorator):
3408
"""A decorator which calls result.progress(self.countTestCases)."""
3410
def run(self, result):
3411
progress_method = getattr(result, 'progress', None)
3412
if callable(progress_method):
3413
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3414
return super(CountingDecorator, self).run(result)
3417
class ExcludeDecorator(TestDecorator):
3418
"""A decorator which excludes test matching an exclude pattern."""
3420
def __init__(self, suite, exclude_pattern):
3421
super(ExcludeDecorator, self).__init__(
3422
exclude_tests_by_re(suite, exclude_pattern))
3425
class FilterTestsDecorator(TestDecorator):
3426
"""A decorator which filters tests to those matching a pattern."""
3428
def __init__(self, suite, pattern):
3429
super(FilterTestsDecorator, self).__init__(
3430
filter_suite_by_re(suite, pattern))
3433
class RandomDecorator(TestDecorator):
3434
"""A decorator which randomises the order of its tests."""
3436
def __init__(self, suite, random_seed, stream):
3437
random_seed = self.actual_seed(random_seed)
3438
stream.write("Randomizing test order using seed %s\n\n" %
3440
# Initialise the random number generator.
3441
random.seed(random_seed)
3442
super(RandomDecorator, self).__init__(randomize_suite(suite))
3445
def actual_seed(seed):
3447
# We convert the seed to a long to make it reuseable across
3448
# invocations (because the user can reenter it).
3449
return long(time.time())
2197
3451
# Convert the seed to a long if we can
2199
random_seed = long(random_seed)
3454
except (TypeError, ValueError):
3459
class TestFirstDecorator(TestDecorator):
3460
"""A decorator which moves named tests to the front."""
3462
def __init__(self, suite, pattern):
3463
super(TestFirstDecorator, self).__init__()
3464
self.addTests(split_suite_by_re(suite, pattern))
3467
def partition_tests(suite, count):
3468
"""Partition suite into count lists of tests."""
3469
# This just assigns tests in a round-robin fashion. On one hand this
3470
# splits up blocks of related tests that might run faster if they shared
3471
# resources, but on the other it avoids assigning blocks of slow tests to
3472
# just one partition. So the slowest partition shouldn't be much slower
3474
partitions = [list() for i in range(count)]
3475
tests = iter_suite_tests(suite)
3476
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3477
partition.append(test)
3481
def workaround_zealous_crypto_random():
3482
"""Crypto.Random want to help us being secure, but we don't care here.
3484
This workaround some test failure related to the sftp server. Once paramiko
3485
stop using the controversial API in Crypto.Random, we may get rid of it.
3488
from Crypto.Random import atfork
3494
def fork_for_tests(suite):
3495
"""Take suite and start up one runner per CPU by forking()
3497
:return: An iterable of TestCase-like objects which can each have
3498
run(result) called on them to feed tests to result.
3500
concurrency = osutils.local_concurrency()
3502
from subunit import ProtocolTestCase
3503
from subunit.test_results import AutoTimingTestResultDecorator
3504
class TestInOtherProcess(ProtocolTestCase):
3505
# Should be in subunit, I think. RBC.
3506
def __init__(self, stream, pid):
3507
ProtocolTestCase.__init__(self, stream)
3510
def run(self, result):
3512
ProtocolTestCase.run(self, result)
3514
pid, status = os.waitpid(self.pid, 0)
3515
# GZ 2011-10-18: If status is nonzero, should report to the result
3516
# that something went wrong.
3518
test_blocks = partition_tests(suite, concurrency)
3519
# Clear the tests from the original suite so it doesn't keep them alive
3520
suite._tests[:] = []
3521
for process_tests in test_blocks:
3522
process_suite = TestUtil.TestSuite(process_tests)
3523
# Also clear each split list so new suite has only reference
3524
process_tests[:] = []
3525
c2pread, c2pwrite = os.pipe()
3529
stream = os.fdopen(c2pwrite, 'wb', 1)
3530
workaround_zealous_crypto_random()
3532
# Leave stderr and stdout open so we can see test noise
3533
# Close stdin so that the child goes away if it decides to
3534
# read from stdin (otherwise its a roulette to see what
3535
# child actually gets keystrokes for pdb etc).
3537
subunit_result = AutoTimingTestResultDecorator(
3538
SubUnitBzrProtocolClient(stream))
3539
process_suite.run(subunit_result)
2202
runner.stream.writeln("Randomizing test order using seed %s\n" %
2204
random.seed(random_seed)
2205
# Customise the list of tests if requested
2206
if pattern != '.*' or exclude_pattern is not None or random_order:
2207
if matching_tests_first:
2208
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
3541
# Try and report traceback on stream, but exit with error even
3542
# if stream couldn't be created or something else goes wrong.
3543
# The traceback is formatted to a string and written in one go
3544
# to avoid interleaving lines from multiple failing children.
3546
stream.write(traceback.format_exc())
2211
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2213
result = runner.run(suite)
2214
return result.wasSuccessful()
3552
stream = os.fdopen(c2pread, 'rb', 1)
3553
test = TestInOtherProcess(stream, pid)
3558
def reinvoke_for_tests(suite):
3559
"""Take suite and start up one runner per CPU using subprocess().
3561
:return: An iterable of TestCase-like objects which can each have
3562
run(result) called on them to feed tests to result.
3564
concurrency = osutils.local_concurrency()
3566
from subunit import ProtocolTestCase
3567
class TestInSubprocess(ProtocolTestCase):
3568
def __init__(self, process, name):
3569
ProtocolTestCase.__init__(self, process.stdout)
3570
self.process = process
3571
self.process.stdin.close()
3574
def run(self, result):
3576
ProtocolTestCase.run(self, result)
3579
os.unlink(self.name)
3580
# print "pid %d finished" % finished_process
3581
test_blocks = partition_tests(suite, concurrency)
3582
for process_tests in test_blocks:
3583
# ugly; currently reimplement rather than reuses TestCase methods.
3584
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3585
if not os.path.isfile(bzr_path):
3586
# We are probably installed. Assume sys.argv is the right file
3587
bzr_path = sys.argv[0]
3588
bzr_path = [bzr_path]
3589
if sys.platform == "win32":
3590
# if we're on windows, we can't execute the bzr script directly
3591
bzr_path = [sys.executable] + bzr_path
3592
fd, test_list_file_name = tempfile.mkstemp()
3593
test_list_file = os.fdopen(fd, 'wb', 1)
3594
for test in process_tests:
3595
test_list_file.write(test.id() + '\n')
3596
test_list_file.close()
3598
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3600
if '--no-plugins' in sys.argv:
3601
argv.append('--no-plugins')
3602
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3603
# noise on stderr it can interrupt the subunit protocol.
3604
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3605
stdout=subprocess.PIPE,
3606
stderr=subprocess.PIPE,
3608
test = TestInSubprocess(process, test_list_file_name)
3611
os.unlink(test_list_file_name)
3616
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3617
"""Generate profiling data for all activity between start and success.
3619
The profile data is appended to the test's _benchcalls attribute and can
3620
be accessed by the forwarded-to TestResult.
3622
While it might be cleaner do accumulate this in stopTest, addSuccess is
3623
where our existing output support for lsprof is, and this class aims to
3624
fit in with that: while it could be moved it's not necessary to accomplish
3625
test profiling, nor would it be dramatically cleaner.
3628
def startTest(self, test):
3629
self.profiler = bzrlib.lsprof.BzrProfiler()
3630
# Prevent deadlocks in tests that use lsprof: those tests will
3632
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3633
self.profiler.start()
3634
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3636
def addSuccess(self, test):
3637
stats = self.profiler.stop()
3639
calls = test._benchcalls
3640
except AttributeError:
3641
test._benchcalls = []
3642
calls = test._benchcalls
3643
calls.append(((test.id(), "", ""), stats))
3644
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3646
def stopTest(self, test):
3647
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3648
self.profiler = None
3651
# Controlled by "bzr selftest -E=..." option
3652
# Currently supported:
3653
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3654
# preserves any flags supplied at the command line.
3655
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3656
# rather than failing tests. And no longer raise
3657
# LockContention when fctnl locks are not being used
3658
# with proper exclusion rules.
3659
# -Ethreads Will display thread ident at creation/join time to
3660
# help track thread leaks
3661
# -Euncollected_cases Display the identity of any test cases that weren't
3662
# deallocated after being completed.
3663
# -Econfig_stats Will collect statistics using addDetail
3664
selftest_debug_flags = set()
2217
3667
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2236
3694
transport = default_transport
2237
3695
old_transport = default_transport
2238
3696
default_transport = transport
3697
global selftest_debug_flags
3698
old_debug_flags = selftest_debug_flags
3699
if debug_flags is not None:
3700
selftest_debug_flags = set(debug_flags)
3702
if load_list is None:
3705
keep_only = load_test_id_list(load_list)
3707
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3708
for start in starting_with]
2240
3709
if test_suite_factory is None:
2241
suite = test_suite()
3710
# Reduce loading time by loading modules based on the starting_with
3712
suite = test_suite(keep_only, starting_with)
2243
3714
suite = test_suite_factory()
3716
# But always filter as requested.
3717
suite = filter_suite_by_id_startswith(suite, starting_with)
3718
result_decorators = []
3720
result_decorators.append(ProfileResult)
2244
3721
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2245
3722
stop_on_failure=stop_on_failure,
2246
3723
transport=transport,
2247
3724
lsprof_timed=lsprof_timed,
2248
3725
bench_history=bench_history,
2249
3726
matching_tests_first=matching_tests_first,
2250
numbered_dirs=numbered_dirs,
2251
3727
list_only=list_only,
2252
3728
random_seed=random_seed,
2253
exclude_pattern=exclude_pattern)
3729
exclude_pattern=exclude_pattern,
3731
runner_class=runner_class,
3732
suite_decorators=suite_decorators,
3734
result_decorators=result_decorators,
2255
3737
default_transport = old_transport
3738
selftest_debug_flags = old_debug_flags
3741
def load_test_id_list(file_name):
3742
"""Load a test id list from a text file.
3744
The format is one test id by line. No special care is taken to impose
3745
strict rules, these test ids are used to filter the test suite so a test id
3746
that do not match an existing test will do no harm. This allows user to add
3747
comments, leave blank lines, etc.
3751
ftest = open(file_name, 'rt')
3753
if e.errno != errno.ENOENT:
3756
raise errors.NoSuchFile(file_name)
3758
for test_name in ftest.readlines():
3759
test_list.append(test_name.strip())
3764
def suite_matches_id_list(test_suite, id_list):
3765
"""Warns about tests not appearing or appearing more than once.
3767
:param test_suite: A TestSuite object.
3768
:param test_id_list: The list of test ids that should be found in
3771
:return: (absents, duplicates) absents is a list containing the test found
3772
in id_list but not in test_suite, duplicates is a list containing the
3773
test found multiple times in test_suite.
3775
When using a prefined test id list, it may occurs that some tests do not
3776
exist anymore or that some tests use the same id. This function warns the
3777
tester about potential problems in his workflow (test lists are volatile)
3778
or in the test suite itself (using the same id for several tests does not
3779
help to localize defects).
3781
# Build a dict counting id occurrences
3783
for test in iter_suite_tests(test_suite):
3785
tests[id] = tests.get(id, 0) + 1
3790
occurs = tests.get(id, 0)
3792
not_found.append(id)
3794
duplicates.append(id)
3796
return not_found, duplicates
3799
class TestIdList(object):
3800
"""Test id list to filter a test suite.
3802
Relying on the assumption that test ids are built as:
3803
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3804
notation, this class offers methods to :
3805
- avoid building a test suite for modules not refered to in the test list,
3806
- keep only the tests listed from the module test suite.
3809
def __init__(self, test_id_list):
3810
# When a test suite needs to be filtered against us we compare test ids
3811
# for equality, so a simple dict offers a quick and simple solution.
3812
self.tests = dict().fromkeys(test_id_list, True)
3814
# While unittest.TestCase have ids like:
3815
# <module>.<class>.<method>[(<param+)],
3816
# doctest.DocTestCase can have ids like:
3819
# <module>.<function>
3820
# <module>.<class>.<method>
3822
# Since we can't predict a test class from its name only, we settle on
3823
# a simple constraint: a test id always begins with its module name.
3826
for test_id in test_id_list:
3827
parts = test_id.split('.')
3828
mod_name = parts.pop(0)
3829
modules[mod_name] = True
3831
mod_name += '.' + part
3832
modules[mod_name] = True
3833
self.modules = modules
3835
def refers_to(self, module_name):
3836
"""Is there tests for the module or one of its sub modules."""
3837
return self.modules.has_key(module_name)
3839
def includes(self, test_id):
3840
return self.tests.has_key(test_id)
3843
class TestPrefixAliasRegistry(registry.Registry):
3844
"""A registry for test prefix aliases.
3846
This helps implement shorcuts for the --starting-with selftest
3847
option. Overriding existing prefixes is not allowed but not fatal (a
3848
warning will be emitted).
3851
def register(self, key, obj, help=None, info=None,
3852
override_existing=False):
3853
"""See Registry.register.
3855
Trying to override an existing alias causes a warning to be emitted,
3856
not a fatal execption.
3859
super(TestPrefixAliasRegistry, self).register(
3860
key, obj, help=help, info=info, override_existing=False)
3862
actual = self.get(key)
3864
'Test prefix alias %s is already used for %s, ignoring %s'
3865
% (key, actual, obj))
3867
def resolve_alias(self, id_start):
3868
"""Replace the alias by the prefix in the given string.
3870
Using an unknown prefix is an error to help catching typos.
3872
parts = id_start.split('.')
3874
parts[0] = self.get(parts[0])
3876
raise errors.BzrCommandError(
3877
'%s is not a known test prefix alias' % parts[0])
3878
return '.'.join(parts)
3881
test_prefix_alias_registry = TestPrefixAliasRegistry()
3882
"""Registry of test prefix aliases."""
3885
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3886
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3887
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3889
# Obvious highest levels prefixes, feel free to add your own via a plugin
3890
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3891
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3892
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3893
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3894
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3897
def _test_suite_testmod_names():
3898
"""Return the standard list of test module names to test."""
3901
'bzrlib.tests.blackbox',
3902
'bzrlib.tests.commands',
3903
'bzrlib.tests.doc_generate',
3904
'bzrlib.tests.per_branch',
3905
'bzrlib.tests.per_bzrdir',
3906
'bzrlib.tests.per_controldir',
3907
'bzrlib.tests.per_controldir_colo',
3908
'bzrlib.tests.per_foreign_vcs',
3909
'bzrlib.tests.per_interrepository',
3910
'bzrlib.tests.per_intertree',
3911
'bzrlib.tests.per_inventory',
3912
'bzrlib.tests.per_interbranch',
3913
'bzrlib.tests.per_lock',
3914
'bzrlib.tests.per_merger',
3915
'bzrlib.tests.per_transport',
3916
'bzrlib.tests.per_tree',
3917
'bzrlib.tests.per_pack_repository',
3918
'bzrlib.tests.per_repository',
3919
'bzrlib.tests.per_repository_chk',
3920
'bzrlib.tests.per_repository_reference',
3921
'bzrlib.tests.per_repository_vf',
3922
'bzrlib.tests.per_uifactory',
3923
'bzrlib.tests.per_versionedfile',
3924
'bzrlib.tests.per_workingtree',
3925
'bzrlib.tests.test__annotator',
3926
'bzrlib.tests.test__bencode',
3927
'bzrlib.tests.test__btree_serializer',
3928
'bzrlib.tests.test__chk_map',
3929
'bzrlib.tests.test__dirstate_helpers',
3930
'bzrlib.tests.test__groupcompress',
3931
'bzrlib.tests.test__known_graph',
3932
'bzrlib.tests.test__rio',
3933
'bzrlib.tests.test__simple_set',
3934
'bzrlib.tests.test__static_tuple',
3935
'bzrlib.tests.test__walkdirs_win32',
3936
'bzrlib.tests.test_ancestry',
3937
'bzrlib.tests.test_annotate',
3938
'bzrlib.tests.test_api',
3939
'bzrlib.tests.test_atomicfile',
3940
'bzrlib.tests.test_bad_files',
3941
'bzrlib.tests.test_bisect_multi',
3942
'bzrlib.tests.test_branch',
3943
'bzrlib.tests.test_branchbuilder',
3944
'bzrlib.tests.test_btree_index',
3945
'bzrlib.tests.test_bugtracker',
3946
'bzrlib.tests.test_bundle',
3947
'bzrlib.tests.test_bzrdir',
3948
'bzrlib.tests.test__chunks_to_lines',
3949
'bzrlib.tests.test_cache_utf8',
3950
'bzrlib.tests.test_chk_map',
3951
'bzrlib.tests.test_chk_serializer',
3952
'bzrlib.tests.test_chunk_writer',
3953
'bzrlib.tests.test_clean_tree',
3954
'bzrlib.tests.test_cleanup',
3955
'bzrlib.tests.test_cmdline',
3956
'bzrlib.tests.test_commands',
3957
'bzrlib.tests.test_commit',
3958
'bzrlib.tests.test_commit_merge',
3959
'bzrlib.tests.test_config',
3960
'bzrlib.tests.test_conflicts',
3961
'bzrlib.tests.test_controldir',
3962
'bzrlib.tests.test_counted_lock',
3963
'bzrlib.tests.test_crash',
3964
'bzrlib.tests.test_decorators',
3965
'bzrlib.tests.test_delta',
3966
'bzrlib.tests.test_debug',
3967
'bzrlib.tests.test_diff',
3968
'bzrlib.tests.test_directory_service',
3969
'bzrlib.tests.test_dirstate',
3970
'bzrlib.tests.test_email_message',
3971
'bzrlib.tests.test_eol_filters',
3972
'bzrlib.tests.test_errors',
3973
'bzrlib.tests.test_estimate_compressed_size',
3974
'bzrlib.tests.test_export',
3975
'bzrlib.tests.test_export_pot',
3976
'bzrlib.tests.test_extract',
3977
'bzrlib.tests.test_features',
3978
'bzrlib.tests.test_fetch',
3979
'bzrlib.tests.test_fixtures',
3980
'bzrlib.tests.test_fifo_cache',
3981
'bzrlib.tests.test_filters',
3982
'bzrlib.tests.test_filter_tree',
3983
'bzrlib.tests.test_ftp_transport',
3984
'bzrlib.tests.test_foreign',
3985
'bzrlib.tests.test_generate_docs',
3986
'bzrlib.tests.test_generate_ids',
3987
'bzrlib.tests.test_globbing',
3988
'bzrlib.tests.test_gpg',
3989
'bzrlib.tests.test_graph',
3990
'bzrlib.tests.test_groupcompress',
3991
'bzrlib.tests.test_hashcache',
3992
'bzrlib.tests.test_help',
3993
'bzrlib.tests.test_hooks',
3994
'bzrlib.tests.test_http',
3995
'bzrlib.tests.test_http_response',
3996
'bzrlib.tests.test_https_ca_bundle',
3997
'bzrlib.tests.test_i18n',
3998
'bzrlib.tests.test_identitymap',
3999
'bzrlib.tests.test_ignores',
4000
'bzrlib.tests.test_index',
4001
'bzrlib.tests.test_import_tariff',
4002
'bzrlib.tests.test_info',
4003
'bzrlib.tests.test_inv',
4004
'bzrlib.tests.test_inventory_delta',
4005
'bzrlib.tests.test_knit',
4006
'bzrlib.tests.test_lazy_import',
4007
'bzrlib.tests.test_lazy_regex',
4008
'bzrlib.tests.test_library_state',
4009
'bzrlib.tests.test_lock',
4010
'bzrlib.tests.test_lockable_files',
4011
'bzrlib.tests.test_lockdir',
4012
'bzrlib.tests.test_log',
4013
'bzrlib.tests.test_lru_cache',
4014
'bzrlib.tests.test_lsprof',
4015
'bzrlib.tests.test_mail_client',
4016
'bzrlib.tests.test_matchers',
4017
'bzrlib.tests.test_memorytree',
4018
'bzrlib.tests.test_merge',
4019
'bzrlib.tests.test_merge3',
4020
'bzrlib.tests.test_merge_core',
4021
'bzrlib.tests.test_merge_directive',
4022
'bzrlib.tests.test_mergetools',
4023
'bzrlib.tests.test_missing',
4024
'bzrlib.tests.test_msgeditor',
4025
'bzrlib.tests.test_multiparent',
4026
'bzrlib.tests.test_mutabletree',
4027
'bzrlib.tests.test_nonascii',
4028
'bzrlib.tests.test_options',
4029
'bzrlib.tests.test_osutils',
4030
'bzrlib.tests.test_osutils_encodings',
4031
'bzrlib.tests.test_pack',
4032
'bzrlib.tests.test_patch',
4033
'bzrlib.tests.test_patches',
4034
'bzrlib.tests.test_permissions',
4035
'bzrlib.tests.test_plugins',
4036
'bzrlib.tests.test_progress',
4037
'bzrlib.tests.test_pyutils',
4038
'bzrlib.tests.test_read_bundle',
4039
'bzrlib.tests.test_reconcile',
4040
'bzrlib.tests.test_reconfigure',
4041
'bzrlib.tests.test_registry',
4042
'bzrlib.tests.test_remote',
4043
'bzrlib.tests.test_rename_map',
4044
'bzrlib.tests.test_repository',
4045
'bzrlib.tests.test_revert',
4046
'bzrlib.tests.test_revision',
4047
'bzrlib.tests.test_revisionspec',
4048
'bzrlib.tests.test_revisiontree',
4049
'bzrlib.tests.test_rio',
4050
'bzrlib.tests.test_rules',
4051
'bzrlib.tests.test_sampler',
4052
'bzrlib.tests.test_scenarios',
4053
'bzrlib.tests.test_script',
4054
'bzrlib.tests.test_selftest',
4055
'bzrlib.tests.test_serializer',
4056
'bzrlib.tests.test_setup',
4057
'bzrlib.tests.test_sftp_transport',
4058
'bzrlib.tests.test_shelf',
4059
'bzrlib.tests.test_shelf_ui',
4060
'bzrlib.tests.test_smart',
4061
'bzrlib.tests.test_smart_add',
4062
'bzrlib.tests.test_smart_request',
4063
'bzrlib.tests.test_smart_signals',
4064
'bzrlib.tests.test_smart_transport',
4065
'bzrlib.tests.test_smtp_connection',
4066
'bzrlib.tests.test_source',
4067
'bzrlib.tests.test_ssh_transport',
4068
'bzrlib.tests.test_status',
4069
'bzrlib.tests.test_store',
4070
'bzrlib.tests.test_strace',
4071
'bzrlib.tests.test_subsume',
4072
'bzrlib.tests.test_switch',
4073
'bzrlib.tests.test_symbol_versioning',
4074
'bzrlib.tests.test_tag',
4075
'bzrlib.tests.test_test_server',
4076
'bzrlib.tests.test_testament',
4077
'bzrlib.tests.test_textfile',
4078
'bzrlib.tests.test_textmerge',
4079
'bzrlib.tests.test_cethread',
4080
'bzrlib.tests.test_timestamp',
4081
'bzrlib.tests.test_trace',
4082
'bzrlib.tests.test_transactions',
4083
'bzrlib.tests.test_transform',
4084
'bzrlib.tests.test_transport',
4085
'bzrlib.tests.test_transport_log',
4086
'bzrlib.tests.test_tree',
4087
'bzrlib.tests.test_treebuilder',
4088
'bzrlib.tests.test_treeshape',
4089
'bzrlib.tests.test_tsort',
4090
'bzrlib.tests.test_tuned_gzip',
4091
'bzrlib.tests.test_ui',
4092
'bzrlib.tests.test_uncommit',
4093
'bzrlib.tests.test_upgrade',
4094
'bzrlib.tests.test_upgrade_stacked',
4095
'bzrlib.tests.test_urlutils',
4096
'bzrlib.tests.test_utextwrap',
4097
'bzrlib.tests.test_version',
4098
'bzrlib.tests.test_version_info',
4099
'bzrlib.tests.test_versionedfile',
4100
'bzrlib.tests.test_vf_search',
4101
'bzrlib.tests.test_weave',
4102
'bzrlib.tests.test_whitebox',
4103
'bzrlib.tests.test_win32utils',
4104
'bzrlib.tests.test_workingtree',
4105
'bzrlib.tests.test_workingtree_4',
4106
'bzrlib.tests.test_wsgi',
4107
'bzrlib.tests.test_xml',
4111
def _test_suite_modules_to_doctest():
4112
"""Return the list of modules to doctest."""
4114
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4118
'bzrlib.branchbuilder',
4119
'bzrlib.decorators',
4121
'bzrlib.iterablefile',
4126
'bzrlib.symbol_versioning',
4128
'bzrlib.tests.fixtures',
4130
'bzrlib.transport.http',
4131
'bzrlib.version_info_formats.format_custom',
4135
def test_suite(keep_only=None, starting_with=None):
2259
4136
"""Build and return TestSuite for the whole of bzrlib.
4138
:param keep_only: A list of test ids limiting the suite returned.
4140
:param starting_with: An id limiting the suite returned to the tests
2261
4143
This function can be replaced if you need to change the default test
2262
4144
suite on a global basis, but it is not encouraged.
2265
'bzrlib.tests.test_ancestry',
2266
'bzrlib.tests.test_annotate',
2267
'bzrlib.tests.test_api',
2268
'bzrlib.tests.test_atomicfile',
2269
'bzrlib.tests.test_bad_files',
2270
'bzrlib.tests.test_branch',
2271
'bzrlib.tests.test_branchbuilder',
2272
'bzrlib.tests.test_bugtracker',
2273
'bzrlib.tests.test_bundle',
2274
'bzrlib.tests.test_bzrdir',
2275
'bzrlib.tests.test_cache_utf8',
2276
'bzrlib.tests.test_commands',
2277
'bzrlib.tests.test_commit',
2278
'bzrlib.tests.test_commit_merge',
2279
'bzrlib.tests.test_config',
2280
'bzrlib.tests.test_conflicts',
2281
'bzrlib.tests.test_counted_lock',
2282
'bzrlib.tests.test_decorators',
2283
'bzrlib.tests.test_delta',
2284
'bzrlib.tests.test_deprecated_graph',
2285
'bzrlib.tests.test_diff',
2286
'bzrlib.tests.test_dirstate',
2287
'bzrlib.tests.test_errors',
2288
'bzrlib.tests.test_escaped_store',
2289
'bzrlib.tests.test_extract',
2290
'bzrlib.tests.test_fetch',
2291
'bzrlib.tests.test_ftp_transport',
2292
'bzrlib.tests.test_generate_docs',
2293
'bzrlib.tests.test_generate_ids',
2294
'bzrlib.tests.test_globbing',
2295
'bzrlib.tests.test_gpg',
2296
'bzrlib.tests.test_graph',
2297
'bzrlib.tests.test_hashcache',
2298
'bzrlib.tests.test_help',
2299
'bzrlib.tests.test_hooks',
2300
'bzrlib.tests.test_http',
2301
'bzrlib.tests.test_http_response',
2302
'bzrlib.tests.test_https_ca_bundle',
2303
'bzrlib.tests.test_identitymap',
2304
'bzrlib.tests.test_ignores',
2305
'bzrlib.tests.test_info',
2306
'bzrlib.tests.test_inv',
2307
'bzrlib.tests.test_knit',
2308
'bzrlib.tests.test_lazy_import',
2309
'bzrlib.tests.test_lazy_regex',
2310
'bzrlib.tests.test_lockdir',
2311
'bzrlib.tests.test_lockable_files',
2312
'bzrlib.tests.test_log',
2313
'bzrlib.tests.test_lsprof',
2314
'bzrlib.tests.test_memorytree',
2315
'bzrlib.tests.test_merge',
2316
'bzrlib.tests.test_merge3',
2317
'bzrlib.tests.test_merge_core',
2318
'bzrlib.tests.test_merge_directive',
2319
'bzrlib.tests.test_missing',
2320
'bzrlib.tests.test_msgeditor',
2321
'bzrlib.tests.test_nonascii',
2322
'bzrlib.tests.test_options',
2323
'bzrlib.tests.test_osutils',
2324
'bzrlib.tests.test_osutils_encodings',
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_workingtree',
2376
'bzrlib.tests.test_workingtree_4',
2377
'bzrlib.tests.test_wsgi',
2378
'bzrlib.tests.test_xml',
2380
test_transport_implementations = [
2381
'bzrlib.tests.test_transport_implementations',
2382
'bzrlib.tests.test_read_bundle',
2384
suite = TestUtil.TestSuite()
2385
4147
loader = TestUtil.TestLoader()
2386
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2387
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2388
adapter = TransportTestProviderAdapter()
2389
adapt_modules(test_transport_implementations, adapter, loader, suite)
2390
for package in packages_to_test():
2391
suite.addTest(package.test_suite())
2392
for m in MODULES_TO_TEST:
2393
suite.addTest(loader.loadTestsFromModule(m))
2394
for m in MODULES_TO_DOCTEST:
4149
if keep_only is not None:
4150
id_filter = TestIdList(keep_only)
4152
# We take precedence over keep_only because *at loading time* using
4153
# both options means we will load less tests for the same final result.
4154
def interesting_module(name):
4155
for start in starting_with:
4157
# Either the module name starts with the specified string
4158
name.startswith(start)
4159
# or it may contain tests starting with the specified string
4160
or start.startswith(name)
4164
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4166
elif keep_only is not None:
4167
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4168
def interesting_module(name):
4169
return id_filter.refers_to(name)
4172
loader = TestUtil.TestLoader()
4173
def interesting_module(name):
4174
# No filtering, all modules are interesting
4177
suite = loader.suiteClass()
4179
# modules building their suite with loadTestsFromModuleNames
4180
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4182
for mod in _test_suite_modules_to_doctest():
4183
if not interesting_module(mod):
4184
# No tests to keep here, move along
2396
suite.addTest(doctest.DocTestSuite(m))
4187
# note that this really does mean "report only" -- doctest
4188
# still runs the rest of the examples
4189
doc_suite = IsolatedDocTestSuite(
4190
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
2397
4191
except ValueError, e:
2398
print '**failed to get doctest for: %s\n%s' %(m,e)
4192
print '**failed to get doctest for: %s\n%s' % (mod, e)
2400
for name, plugin in bzrlib.plugin.all_plugins().items():
2401
if getattr(plugin, 'test_suite', None) is not None:
2402
default_encoding = sys.getdefaultencoding()
2404
plugin_suite = plugin.test_suite()
2405
except ImportError, e:
2406
bzrlib.trace.warning(
2407
'Unable to test plugin "%s": %s', name, e)
2409
suite.addTest(plugin_suite)
2410
if default_encoding != sys.getdefaultencoding():
2411
bzrlib.trace.warning(
2412
'Plugin "%s" tried to reset default encoding to: %s', name,
2413
sys.getdefaultencoding())
2415
sys.setdefaultencoding(default_encoding)
4194
if len(doc_suite._tests) == 0:
4195
raise errors.BzrError("no doctests found in %s" % (mod,))
4196
suite.addTest(doc_suite)
4198
default_encoding = sys.getdefaultencoding()
4199
for name, plugin in _mod_plugin.plugins().items():
4200
if not interesting_module(plugin.module.__name__):
4202
plugin_suite = plugin.test_suite()
4203
# We used to catch ImportError here and turn it into just a warning,
4204
# but really if you don't have --no-plugins this should be a failure.
4205
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4206
if plugin_suite is None:
4207
plugin_suite = plugin.load_plugin_tests(loader)
4208
if plugin_suite is not None:
4209
suite.addTest(plugin_suite)
4210
if default_encoding != sys.getdefaultencoding():
4212
'Plugin "%s" tried to reset default encoding to: %s', name,
4213
sys.getdefaultencoding())
4215
sys.setdefaultencoding(default_encoding)
4217
if keep_only is not None:
4218
# Now that the referred modules have loaded their tests, keep only the
4220
suite = filter_suite_by_id_list(suite, id_filter)
4221
# Do some sanity checks on the id_list filtering
4222
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4224
# The tester has used both keep_only and starting_with, so he is
4225
# already aware that some tests are excluded from the list, there
4226
# is no need to tell him which.
4229
# Some tests mentioned in the list are not in the test suite. The
4230
# list may be out of date, report to the tester.
4231
for id in not_found:
4232
trace.warning('"%s" not found in the test suite', id)
4233
for id in duplicates:
4234
trace.warning('"%s" is used as an id by several tests', id)
2419
def adapt_modules(mods_list, adapter, loader, suite):
2420
"""Adapt the modules in mods_list using adapter and add to suite."""
2421
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2422
suite.addTests(adapter.adapt(test))
2425
def _rmtree_temp_dir(dirname):
4239
def multiply_scenarios(*scenarios):
4240
"""Multiply two or more iterables of scenarios.
4242
It is safe to pass scenario generators or iterators.
4244
:returns: A list of compound scenarios: the cross-product of all
4245
scenarios, with the names concatenated and the parameters
4248
return reduce(_multiply_two_scenarios, map(list, scenarios))
4251
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4252
"""Multiply two sets of scenarios.
4254
:returns: the cartesian product of the two sets of scenarios, that is
4255
a scenario for every possible combination of a left scenario and a
4259
('%s,%s' % (left_name, right_name),
4260
dict(left_dict.items() + right_dict.items()))
4261
for left_name, left_dict in scenarios_left
4262
for right_name, right_dict in scenarios_right]
4265
def multiply_tests(tests, scenarios, result):
4266
"""Multiply tests_list by scenarios into result.
4268
This is the core workhorse for test parameterisation.
4270
Typically the load_tests() method for a per-implementation test suite will
4271
call multiply_tests and return the result.
4273
:param tests: The tests to parameterise.
4274
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4275
scenario_param_dict).
4276
:param result: A TestSuite to add created tests to.
4278
This returns the passed in result TestSuite with the cross product of all
4279
the tests repeated once for each scenario. Each test is adapted by adding
4280
the scenario name at the end of its id(), and updating the test object's
4281
__dict__ with the scenario_param_dict.
4283
>>> import bzrlib.tests.test_sampler
4284
>>> r = multiply_tests(
4285
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4286
... [('one', dict(param=1)),
4287
... ('two', dict(param=2))],
4288
... TestUtil.TestSuite())
4289
>>> tests = list(iter_suite_tests(r))
4293
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4299
for test in iter_suite_tests(tests):
4300
apply_scenarios(test, scenarios, result)
4304
def apply_scenarios(test, scenarios, result):
4305
"""Apply the scenarios in scenarios to test and add to result.
4307
:param test: The test to apply scenarios to.
4308
:param scenarios: An iterable of scenarios to apply to test.
4310
:seealso: apply_scenario
4312
for scenario in scenarios:
4313
result.addTest(apply_scenario(test, scenario))
4317
def apply_scenario(test, scenario):
4318
"""Copy test and apply scenario to it.
4320
:param test: A test to adapt.
4321
:param scenario: A tuple describing the scenarion.
4322
The first element of the tuple is the new test id.
4323
The second element is a dict containing attributes to set on the
4325
:return: The adapted test.
4327
new_id = "%s(%s)" % (test.id(), scenario[0])
4328
new_test = clone_test(test, new_id)
4329
for name, value in scenario[1].items():
4330
setattr(new_test, name, value)
4334
def clone_test(test, new_id):
4335
"""Clone a test giving it a new id.
4337
:param test: The test to clone.
4338
:param new_id: The id to assign to it.
4339
:return: The new test.
4341
new_test = copy.copy(test)
4342
new_test.id = lambda: new_id
4343
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4344
# causes cloned tests to share the 'details' dict. This makes it hard to
4345
# read the test output for parameterized tests, because tracebacks will be
4346
# associated with irrelevant tests.
4348
details = new_test._TestCase__details
4349
except AttributeError:
4350
# must be a different version of testtools than expected. Do nothing.
4353
# Reset the '__details' dict.
4354
new_test._TestCase__details = {}
4358
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4360
"""Helper for permutating tests against an extension module.
4362
This is meant to be used inside a modules 'load_tests()' function. It will
4363
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4364
against both implementations. Setting 'test.module' to the appropriate
4365
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4367
:param standard_tests: A test suite to permute
4368
:param loader: A TestLoader
4369
:param py_module_name: The python path to a python module that can always
4370
be loaded, and will be considered the 'python' implementation. (eg
4371
'bzrlib._chk_map_py')
4372
:param ext_module_name: The python path to an extension module. If the
4373
module cannot be loaded, a single test will be added, which notes that
4374
the module is not available. If it can be loaded, all standard_tests
4375
will be run against that module.
4376
:return: (suite, feature) suite is a test-suite that has all the permuted
4377
tests. feature is the Feature object that can be used to determine if
4378
the module is available.
4381
from bzrlib.tests.features import ModuleAvailableFeature
4382
py_module = pyutils.get_named_object(py_module_name)
4384
('python', {'module': py_module}),
4386
suite = loader.suiteClass()
4387
feature = ModuleAvailableFeature(ext_module_name)
4388
if feature.available():
4389
scenarios.append(('C', {'module': feature.module}))
4391
# the compiled module isn't available, so we add a failing test
4392
class FailWithoutFeature(TestCase):
4393
def test_fail(self):
4394
self.requireFeature(feature)
4395
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4396
result = multiply_tests(standard_tests, scenarios, suite)
4397
return result, feature
4400
def _rmtree_temp_dir(dirname, test_id=None):
2426
4401
# If LANG=C we probably have created some bogus paths
2427
4402
# which rmtree(unicode) will fail to delete
2428
4403
# so make sure we are using rmtree(str) to delete everything
added
removed
bzrlib/tests/__init__.py
