27
26
# general style of bzrlib. Please continue that consistency when adding e.g.
28
27
# new assertFoo() methods.
33
30
from cStringIO import StringIO
36
from pprint import pformat
40
from subprocess import Popen, PIPE
56
# nb: check this before importing anything else from within it
57
_testtools_version = getattr(testtools, '__version__', ())
58
if _testtools_version < (0, 9, 5):
59
raise ImportError("need at least testtools 0.9.5: %s is %r"
60
% (testtools.__file__, _testtools_version))
61
from testtools import content
64
47
from bzrlib import (
68
commands as _mod_commands,
77
plugin as _mod_plugin,
84
transport as _mod_transport,
58
import bzrlib.commands
59
import bzrlib.timestamp
61
import bzrlib.inventory
62
import bzrlib.iterablefile
88
65
import bzrlib.lsprof
89
66
except ImportError:
90
67
# lsprof not available
92
from bzrlib.smart import client, request
93
from bzrlib.transport import (
97
from bzrlib.tests import (
102
from bzrlib.ui import NullProgressView
103
from bzrlib.ui.text import TextUIFactory
105
# Mark this python module as being part of the implementation
106
# of unittest: this gives us better tracebacks where the last
107
# shown frame is the test code, not our assertXYZ.
110
default_transport = test_server.LocalURLServer
113
_unitialized_attr = object()
114
"""A sentinel needed to act as a default value in a method signature."""
117
# Subunit result codes, defined here to prevent a hard dependency on subunit.
121
# These are intentionally brought into this namespace. That way plugins, etc
122
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
123
TestSuite = TestUtil.TestSuite
124
TestLoader = TestUtil.TestLoader
126
# Tests should run in a clean and clearly defined environment. The goal is to
127
# keep them isolated from the running environment as mush as possible. The test
128
# framework ensures the variables defined below are set (or deleted if the
129
# value is None) before a test is run and reset to their original value after
130
# the test is run. Generally if some code depends on an environment variable,
131
# the tests should start without this variable in the environment. There are a
132
# few exceptions but you shouldn't violate this rule lightly.
136
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
137
# tests do check our impls match APPDATA
138
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
142
'BZREMAIL': None, # may still be present in the environment
143
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
144
'BZR_PROGRESS_BAR': None,
146
'BZR_PLUGIN_PATH': None,
147
'BZR_DISABLE_PLUGINS': None,
148
'BZR_PLUGINS_AT': None,
149
'BZR_CONCURRENCY': None,
150
# Make sure that any text ui tests are consistent regardless of
151
# the environment the test case is run in; you may want tests that
152
# test other combinations. 'dumb' is a reasonable guess for tests
153
# going to a pipe or a StringIO.
159
'SSH_AUTH_SOCK': None,
169
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
170
# least. If you do (care), please update this comment
174
'BZR_REMOTE_PATH': None,
175
# Generally speaking, we don't want apport reporting on crashes in
176
# the test envirnoment unless we're specifically testing apport,
177
# so that it doesn't leak into the real system environment. We
178
# use an env var so it propagates to subprocesses.
179
'APPORT_DISABLE': '1',
183
def override_os_environ(test, env=None):
184
"""Modify os.environ keeping a copy.
186
:param test: A test instance
188
:param env: A dict containing variable definitions to be installed
191
env = isolated_environ
192
test._original_os_environ = dict([(var, value)
193
for var, value in os.environ.iteritems()])
194
for var, value in env.iteritems():
195
osutils.set_or_unset_env(var, value)
196
if var not in test._original_os_environ:
197
# The var is new, add it with a value of None, so
198
# restore_os_environ will delete it
199
test._original_os_environ[var] = None
202
def restore_os_environ(test):
203
"""Restore os.environ to its original state.
205
:param test: A test instance previously passed to override_os_environ.
207
for var, value in test._original_os_environ.iteritems():
208
# Restore the original value (or delete it if the value has been set to
209
# None in override_os_environ).
210
osutils.set_or_unset_env(var, value)
213
class ExtendedTestResult(testtools.TextTestResult):
69
from bzrlib.merge import merge_inner
73
from bzrlib.revision import common_ancestor
75
from bzrlib import symbol_versioning
77
from bzrlib.transport import get_transport
78
import bzrlib.transport
79
from bzrlib.transport.local import LocalURLServer
80
from bzrlib.transport.memory import MemoryServer
81
from bzrlib.transport.readonly import ReadonlyServer
82
from bzrlib.trace import mutter, note
83
from bzrlib.tests import TestUtil
84
from bzrlib.tests.HttpServer import HttpServer
85
from bzrlib.tests.TestUtil import (
89
from bzrlib.tests.treeshape import build_tree_contents
90
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
92
default_transport = LocalURLServer
95
MODULES_TO_DOCTEST = [
108
def packages_to_test():
109
"""Return a list of packages to test.
111
The packages are not globally imported so that import failures are
112
triggered when running selftest, not when importing the command.
115
import bzrlib.tests.blackbox
116
import bzrlib.tests.branch_implementations
117
import bzrlib.tests.bzrdir_implementations
118
import bzrlib.tests.interrepository_implementations
119
import bzrlib.tests.interversionedfile_implementations
120
import bzrlib.tests.intertree_implementations
121
import bzrlib.tests.per_lock
122
import bzrlib.tests.repository_implementations
123
import bzrlib.tests.revisionstore_implementations
124
import bzrlib.tests.tree_implementations
125
import bzrlib.tests.workingtree_implementations
128
bzrlib.tests.blackbox,
129
bzrlib.tests.branch_implementations,
130
bzrlib.tests.bzrdir_implementations,
131
bzrlib.tests.interrepository_implementations,
132
bzrlib.tests.interversionedfile_implementations,
133
bzrlib.tests.intertree_implementations,
134
bzrlib.tests.per_lock,
135
bzrlib.tests.repository_implementations,
136
bzrlib.tests.revisionstore_implementations,
137
bzrlib.tests.tree_implementations,
138
bzrlib.tests.workingtree_implementations,
142
class ExtendedTestResult(unittest._TextTestResult):
214
143
"""Accepts, reports and accumulates the results of running tests.
216
Compared to the unittest version this class adds support for
217
profiling, benchmarking, stopping as soon as a test fails, and
218
skipping tests. There are further-specialized subclasses for
219
different types of display.
221
When a test finishes, in whatever way, it calls one of the addSuccess,
222
addFailure or addError classes. These in turn may redirect to a more
223
specific case for the special test results supported by our extended
226
Note that just one of these objects is fed the results from many tests.
145
Compared to this unittest version this class adds support for profiling,
146
benchmarking, stopping as soon as a test fails, and skipping tests.
147
There are further-specialized subclasses for different types of display.
229
150
stop_early = False
231
152
def __init__(self, stream, descriptions, verbosity,
232
153
bench_history=None,
155
use_numbered_dirs=False,
235
157
"""Construct new TestResult.
237
159
:param bench_history: Optionally, a writable file object to accumulate
238
160
benchmark results.
240
testtools.TextTestResult.__init__(self, stream)
162
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
241
163
if bench_history is not None:
242
164
from bzrlib.version import _get_bzr_source_tree
243
165
src_tree = _get_bzr_source_tree()
351
211
def _shortened_test_description(self, test):
353
what = re.sub(r'^bzrlib\.tests\.', '', what)
213
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
356
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
357
# multiple times in a row, because the handler is added for
358
# each test but the container list is shared between cases.
359
# See lp:498869 lp:625574 and lp:637725 for background.
360
def _record_traceback_from_test(self, exc_info):
361
"""Store the traceback from passed exc_info tuple till"""
362
self._traceback_from_test = exc_info[2]
364
216
def startTest(self, test):
365
super(ExtendedTestResult, self).startTest(test)
217
unittest.TestResult.startTest(self, test)
369
218
self.report_test_start(test)
370
219
test.number = self.count
371
220
self._recordTestStartTime()
372
# Make testtools cases give us the real traceback on failure
373
addOnException = getattr(test, "addOnException", None)
374
if addOnException is not None:
375
addOnException(self._record_traceback_from_test)
376
# Only check for thread leaks on bzrlib derived test cases
377
if isinstance(test, TestCase):
378
test.addCleanup(self._check_leaked_threads, test)
380
def startTests(self):
381
self.report_tests_starting()
382
self._active_threads = threading.enumerate()
384
def stopTest(self, test):
385
self._traceback_from_test = None
387
def _check_leaked_threads(self, test):
388
"""See if any threads have leaked since last call
390
A sample of live threads is stored in the _active_threads attribute,
391
when this method runs it compares the current live threads and any not
392
in the previous sample are treated as having leaked.
394
now_active_threads = set(threading.enumerate())
395
threads_leaked = now_active_threads.difference(self._active_threads)
397
self._report_thread_leak(test, threads_leaked, now_active_threads)
398
self._tests_leaking_threads_count += 1
399
if self._first_thread_leaker_id is None:
400
self._first_thread_leaker_id = test.id()
401
self._active_threads = now_active_threads
403
222
def _recordTestStartTime(self):
404
223
"""Record that a test has started."""
405
self._start_datetime = self._now()
224
self._start_time = time.time()
226
def _cleanupLogFile(self, test):
227
# We can only do this if we have one of our TestCases, not if
229
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
230
if setKeepLogfile is not None:
407
233
def addError(self, test, err):
408
"""Tell result that test finished with an error.
410
Called from the TestCase run() method when the test
411
fails with an unexpected error.
413
self._post_mortem(self._traceback_from_test)
414
super(ExtendedTestResult, self).addError(test, err)
234
self.extractBenchmarkTime(test)
235
self._cleanupLogFile(test)
236
if isinstance(err[1], TestSkipped):
237
return self.addSkipped(test, err)
238
elif isinstance(err[1], UnavailableFeature):
239
return self.addNotSupported(test, err[1].args[0])
240
unittest.TestResult.addError(self, test, err)
415
241
self.error_count += 1
416
242
self.report_error(test, err)
417
243
if self.stop_early:
420
246
def addFailure(self, test, err):
421
"""Tell result that test failed.
423
Called from the TestCase run() method when the test
424
fails because e.g. an assert() method failed.
426
self._post_mortem(self._traceback_from_test)
427
super(ExtendedTestResult, self).addFailure(test, err)
247
self._cleanupLogFile(test)
248
self.extractBenchmarkTime(test)
249
if isinstance(err[1], KnownFailure):
250
return self.addKnownFailure(test, err)
251
unittest.TestResult.addFailure(self, test, err)
428
252
self.failure_count += 1
429
253
self.report_failure(test, err)
430
254
if self.stop_early:
433
def addSuccess(self, test, details=None):
434
"""Tell result that test completed successfully.
436
Called from the TestCase run()
438
if self._bench_history is not None:
439
benchmark_time = self._extractBenchmarkTime(test, details)
440
if benchmark_time is not None:
441
self._bench_history.write("%s %s\n" % (
442
self._formatTime(benchmark_time),
444
self.report_success(test)
445
super(ExtendedTestResult, self).addSuccess(test)
446
test._log_contents = ''
448
def addExpectedFailure(self, test, err):
257
def addKnownFailure(self, test, err):
449
258
self.known_failure_count += 1
450
259
self.report_known_failure(test, err)
452
261
def addNotSupported(self, test, feature):
453
"""The test will not be run because of a missing feature.
455
# this can be called in two different ways: it may be that the
456
# test started running, and then raised (through requireFeature)
457
# UnavailableFeature. Alternatively this method can be called
458
# while probing for features before running the test code proper; in
459
# that case we will see startTest and stopTest, but the test will
460
# never actually run.
461
262
self.unsupported.setdefault(str(feature), 0)
462
263
self.unsupported[str(feature)] += 1
463
264
self.report_unsupported(test, feature)
465
def addSkip(self, test, reason):
466
"""A test has not run for 'reason'."""
468
self.report_skip(test, reason)
470
def addNotApplicable(self, test, reason):
471
self.not_applicable_count += 1
472
self.report_not_applicable(test, reason)
474
def _post_mortem(self, tb=None):
475
"""Start a PDB post mortem session."""
476
if os.environ.get('BZR_TEST_PDB', None):
480
def progress(self, offset, whence):
481
"""The test is adjusting the count of tests to run."""
482
if whence == SUBUNIT_SEEK_SET:
483
self.num_tests = offset
484
elif whence == SUBUNIT_SEEK_CUR:
485
self.num_tests += offset
487
raise errors.BzrError("Unknown whence %r" % whence)
489
def report_tests_starting(self):
490
"""Display information before the test run begins"""
491
if getattr(sys, 'frozen', None) is None:
492
bzr_path = osutils.realpath(sys.argv[0])
494
bzr_path = sys.executable
496
'bzr selftest: %s\n' % (bzr_path,))
499
bzrlib.__path__[0],))
501
' bzr-%s python-%s %s\n' % (
502
bzrlib.version_string,
503
bzrlib._format_version_tuple(sys.version_info),
504
platform.platform(aliased=1),
506
self.stream.write('\n')
508
def report_test_start(self, test):
509
"""Display information on the test just about to be run"""
511
def _report_thread_leak(self, test, leaked_threads, active_threads):
512
"""Display information on a test that leaked one or more threads"""
513
# GZ 2010-09-09: A leak summary reported separately from the general
514
# thread debugging would be nice. Tests under subunit
515
# need something not using stream, perhaps adding a
516
# testtools details object would be fitting.
517
if 'threads' in selftest_debug_flags:
518
self.stream.write('%s is leaking, active is now %d\n' %
519
(test.id(), len(active_threads)))
521
def startTestRun(self):
522
self.startTime = time.time()
266
def addSuccess(self, test):
267
self.extractBenchmarkTime(test)
268
if self._bench_history is not None:
269
if self._benchmarkTime is not None:
270
self._bench_history.write("%s %s\n" % (
271
self._formatTime(self._benchmarkTime),
273
self.report_success(test)
274
unittest.TestResult.addSuccess(self, test)
276
def addSkipped(self, test, skip_excinfo):
277
self.report_skip(test, skip_excinfo)
278
# seems best to treat this as success from point-of-view of unittest
279
# -- it actually does nothing so it barely matters :)
282
except KeyboardInterrupt:
285
self.addError(test, test.__exc_info())
287
unittest.TestResult.addSuccess(self, test)
289
def printErrorList(self, flavour, errors):
290
for test, err in errors:
291
self.stream.writeln(self.separator1)
292
self.stream.write("%s: " % flavour)
293
if self.use_numbered_dirs:
294
self.stream.write('#%d ' % test.number)
295
self.stream.writeln(self.getDescription(test))
296
if getattr(test, '_get_log', None) is not None:
298
print >>self.stream, \
299
('vvvv[log from %s]' % test.id()).ljust(78,'-')
300
print >>self.stream, test._get_log()
301
print >>self.stream, \
302
('^^^^[log from %s]' % test.id()).ljust(78,'-')
303
self.stream.writeln(self.separator2)
304
self.stream.writeln("%s" % err)
309
def report_cleaning_up(self):
524
312
def report_success(self, test):
527
def wasStrictlySuccessful(self):
528
if self.unsupported or self.known_failure_count:
530
return self.wasSuccessful()
533
316
class TextTestResult(ExtendedTestResult):
534
317
"""Displays progress and results of tests in text form"""
536
319
def __init__(self, stream, descriptions, verbosity,
537
320
bench_history=None,
323
use_numbered_dirs=False,
541
325
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
542
bench_history, strict)
543
# We no longer pass them around, but just rely on the UIFactory stack
546
warnings.warn("Passing pb to TextTestResult is deprecated")
547
self.pb = self.ui.nested_progress_bar()
326
bench_history, num_tests, use_numbered_dirs)
328
self.pb = self.ui.nested_progress_bar()
329
self._supplied_pb = False
332
self._supplied_pb = True
548
333
self.pb.show_pct = False
549
334
self.pb.show_spinner = False
550
335
self.pb.show_eta = False,
551
336
self.pb.show_count = False
552
337
self.pb.show_bar = False
553
self.pb.update_latency = 0
554
self.pb.show_transport_activity = False
556
def stopTestRun(self):
557
# called when the tests that are going to run have run
560
super(TextTestResult, self).stopTestRun()
562
def report_tests_starting(self):
563
super(TextTestResult, self).report_tests_starting()
564
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
339
def report_starting(self):
340
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
566
342
def _progress_prefix_text(self):
567
# the longer this text, the less space we have to show the test
569
a = '[%d' % self.count # total that have been run
570
# tests skipped as known not to be relevant are not important enough
572
## if self.skip_count:
573
## a += ', %d skip' % self.skip_count
574
## if self.known_failure_count:
575
## a += '+%dX' % self.known_failure_count
343
a = '[%d' % self.count
344
if self.num_tests is not None:
577
345
a +='/%d' % self.num_tests
579
runtime = time.time() - self._overall_start_time
581
a += '%dm%ds' % (runtime / 60, runtime % 60)
584
total_fail_count = self.error_count + self.failure_count
586
a += ', %d failed' % total_fail_count
587
# if self.unsupported:
588
# a += ', %d missing' % len(self.unsupported)
346
a += ' in %ds' % (time.time() - self._overall_start_time)
348
a += ', %d errors' % self.error_count
349
if self.failure_count:
350
a += ', %d failed' % self.failure_count
351
if self.known_failure_count:
352
a += ', %d known failures' % self.known_failure_count
354
a += ', %d skipped' % self.skip_count
356
a += ', %d missing features' % len(self.unsupported)
592
360
def report_test_start(self, test):
594
363
self._progress_prefix_text()
596
365
+ self._shortened_test_description(test))
598
367
def _test_description(self, test):
599
return self._shortened_test_description(test)
368
if self.use_numbered_dirs:
369
return '#%d %s' % (self.count,
370
self._shortened_test_description(test))
372
return self._shortened_test_description(test)
601
374
def report_error(self, test, err):
602
self.stream.write('ERROR: %s\n %s\n' % (
375
self.pb.note('ERROR: %s\n %s\n',
603
376
self._test_description(test),
607
380
def report_failure(self, test, err):
608
self.stream.write('FAIL: %s\n %s\n' % (
381
self.pb.note('FAIL: %s\n %s\n',
609
382
self._test_description(test),
613
386
def report_known_failure(self, test, err):
616
def report_skip(self, test, reason):
619
def report_not_applicable(self, test, reason):
387
self.pb.note('XFAIL: %s\n%s\n',
388
self._test_description(test), err[1])
390
def report_skip(self, test, skip_excinfo):
393
# at the moment these are mostly not things we can fix
394
# and so they just produce stipple; use the verbose reporter
397
# show test and reason for skip
398
self.pb.note('SKIP: %s\n %s\n',
399
self._shortened_test_description(test),
402
# since the class name was left behind in the still-visible
404
self.pb.note('SKIP: %s', skip_excinfo[1])
622
406
def report_unsupported(self, test, feature):
623
407
"""test cannot be run because feature is missing."""
409
def report_cleaning_up(self):
410
self.pb.update('cleaning up...')
413
if not self._supplied_pb:
626
417
class VerboseTestResult(ExtendedTestResult):
911
723
retrieved by _get_log(). We use a real OS file, not an in-memory object,
912
724
so that it can also capture file IO. When the test completes this file
913
725
is read into memory and removed from disk.
915
727
There are also convenience functions to invoke bzr's command-line
916
728
routine, and to build and check bzr trees.
918
730
In addition to the usual method of overriding tearDown(), this class also
919
allows subclasses to register cleanup functions via addCleanup, which are
731
allows subclasses to register functions into the _cleanups list, which is
920
732
run in order as the object is torn down. It's less likely this will be
921
733
accidentally overlooked.
736
_log_file_name = None
738
_keep_log_file = False
925
739
# record lsprof data when performing benchmark calls.
926
740
_gather_lsprof_in_benchmarks = False
928
742
def __init__(self, methodName='testMethod'):
929
743
super(TestCase, self).__init__(methodName)
930
self._directory_isolation = True
931
self.exception_handlers.insert(0,
932
(UnavailableFeature, self._do_unsupported_or_skip))
933
self.exception_handlers.insert(0,
934
(TestNotApplicable, self._do_not_applicable))
937
super(TestCase, self).setUp()
938
for feature in getattr(self, '_test_needs_features', []):
939
self.requireFeature(feature)
940
self._log_contents = None
941
self.addDetail("log", content.Content(content.ContentType("text",
942
"plain", {"charset": "utf8"}),
943
lambda:[self._get_log(keep_log_file=True)]))
747
unittest.TestCase.setUp(self)
944
748
self._cleanEnvironment()
749
bzrlib.trace.disable_default_logging()
945
750
self._silenceUI()
946
751
self._startLogFile()
947
752
self._benchcalls = []
948
753
self._benchtime = None
949
754
self._clear_hooks()
950
self._track_transports()
952
self._clear_debug_flags()
953
# Isolate global verbosity level, to make sure it's reproducible
954
# between tests. We should get rid of this altogether: bug 656694. --
956
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
957
# Isolate config option expansion until its default value for bzrlib is
958
# settled on or a the FIXME associated with _get_expand_default_value
959
# is addressed -- vila 20110219
960
self.overrideAttr(config, '_expand_default_value', None)
965
pdb.Pdb().set_trace(sys._getframe().f_back)
967
def discardDetail(self, name):
968
"""Extend the addDetail, getDetails api so we can remove a detail.
970
eg. bzr always adds the 'log' detail at startup, but we don't want to
971
include it for skipped, xfail, etc tests.
973
It is safe to call this for a detail that doesn't exist, in case this
974
gets called multiple times.
976
# We cheat. details is stored in __details which means we shouldn't
977
# touch it. but getDetails() returns the dict directly, so we can
979
details = self.getDetails()
983
def _clear_debug_flags(self):
984
"""Prevent externally set debug flags affecting tests.
986
Tests that want to use debug flags can just set them in the
987
debug_flags set during setup/teardown.
989
# Start with a copy of the current debug flags we can safely modify.
990
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
991
if 'allow_debug' not in selftest_debug_flags:
992
debug.debug_flags.clear()
993
if 'disable_lock_checks' not in selftest_debug_flags:
994
debug.debug_flags.add('strict_locks')
996
756
def _clear_hooks(self):
997
757
# prevent hooks affecting tests
998
known_hooks = hooks.known_hooks
999
self._preserved_hooks = {}
1000
for key, (parent, name) in known_hooks.iter_parent_objects():
1001
current_hooks = getattr(parent, name)
1002
self._preserved_hooks[parent] = (name, current_hooks)
1003
self._preserved_lazy_hooks = hooks._lazy_hooks
1004
hooks._lazy_hooks = {}
759
import bzrlib.smart.server
760
self._preserved_hooks = {
761
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
762
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
1005
764
self.addCleanup(self._restoreHooks)
1006
for key, (parent, name) in known_hooks.iter_parent_objects():
1007
factory = known_hooks.get(key)
1008
setattr(parent, name, factory())
1009
# this hook should always be installed
1010
request._install_hook()
1012
def disable_directory_isolation(self):
1013
"""Turn off directory isolation checks."""
1014
self._directory_isolation = False
1016
def enable_directory_isolation(self):
1017
"""Enable directory isolation checks."""
1018
self._directory_isolation = True
765
# this list of hooks must be kept in sync with the defaults
767
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
768
bzrlib.smart.server.SmartTCPServer.hooks = \
769
bzrlib.smart.server.SmartServerHooks()
1020
771
def _silenceUI(self):
1021
772
"""Turn off UI for duration of test"""
1022
773
# by default the UI is off; tests can turn it on if they want it.
1023
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1025
def _check_locks(self):
1026
"""Check that all lock take/release actions have been paired."""
1027
# We always check for mismatched locks. If a mismatch is found, we
1028
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1029
# case we just print a warning.
1031
acquired_locks = [lock for action, lock in self._lock_actions
1032
if action == 'acquired']
1033
released_locks = [lock for action, lock in self._lock_actions
1034
if action == 'released']
1035
broken_locks = [lock for action, lock in self._lock_actions
1036
if action == 'broken']
1037
# trivially, given the tests for lock acquistion and release, if we
1038
# have as many in each list, it should be ok. Some lock tests also
1039
# break some locks on purpose and should be taken into account by
1040
# considering that breaking a lock is just a dirty way of releasing it.
1041
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1042
message = ('Different number of acquired and '
1043
'released or broken locks. (%s, %s + %s)' %
1044
(acquired_locks, released_locks, broken_locks))
1045
if not self._lock_check_thorough:
1046
# Rather than fail, just warn
1047
print "Broken test %s: %s" % (self, message)
1051
def _track_locks(self):
1052
"""Track lock activity during tests."""
1053
self._lock_actions = []
1054
if 'disable_lock_checks' in selftest_debug_flags:
1055
self._lock_check_thorough = False
1057
self._lock_check_thorough = True
1059
self.addCleanup(self._check_locks)
1060
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1061
self._lock_acquired, None)
1062
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1063
self._lock_released, None)
1064
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1065
self._lock_broken, None)
1067
def _lock_acquired(self, result):
1068
self._lock_actions.append(('acquired', result))
1070
def _lock_released(self, result):
1071
self._lock_actions.append(('released', result))
1073
def _lock_broken(self, result):
1074
self._lock_actions.append(('broken', result))
1076
def permit_dir(self, name):
1077
"""Permit a directory to be used by this test. See permit_url."""
1078
name_transport = _mod_transport.get_transport(name)
1079
self.permit_url(name)
1080
self.permit_url(name_transport.base)
1082
def permit_url(self, url):
1083
"""Declare that url is an ok url to use in this test.
1085
Do this for memory transports, temporary test directory etc.
1087
Do not do this for the current working directory, /tmp, or any other
1088
preexisting non isolated url.
1090
if not url.endswith('/'):
1092
self._bzr_selftest_roots.append(url)
1094
def permit_source_tree_branch_repo(self):
1095
"""Permit the source tree bzr is running from to be opened.
1097
Some code such as bzrlib.version attempts to read from the bzr branch
1098
that bzr is executing from (if any). This method permits that directory
1099
to be used in the test suite.
1101
path = self.get_source_path()
1102
self.record_directory_isolation()
1105
workingtree.WorkingTree.open(path)
1106
except (errors.NotBranchError, errors.NoWorkingTree):
1107
raise TestSkipped('Needs a working tree of bzr sources')
1109
self.enable_directory_isolation()
1111
def _preopen_isolate_transport(self, transport):
1112
"""Check that all transport openings are done in the test work area."""
1113
while isinstance(transport, pathfilter.PathFilteringTransport):
1114
# Unwrap pathfiltered transports
1115
transport = transport.server.backing_transport.clone(
1116
transport._filter('.'))
1117
url = transport.base
1118
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1119
# urls it is given by prepending readonly+. This is appropriate as the
1120
# client shouldn't know that the server is readonly (or not readonly).
1121
# We could register all servers twice, with readonly+ prepending, but
1122
# that makes for a long list; this is about the same but easier to
1124
if url.startswith('readonly+'):
1125
url = url[len('readonly+'):]
1126
self._preopen_isolate_url(url)
1128
def _preopen_isolate_url(self, url):
1129
if not self._directory_isolation:
1131
if self._directory_isolation == 'record':
1132
self._bzr_selftest_roots.append(url)
1134
# This prevents all transports, including e.g. sftp ones backed on disk
1135
# from working unless they are explicitly granted permission. We then
1136
# depend on the code that sets up test transports to check that they are
1137
# appropriately isolated and enable their use by calling
1138
# self.permit_transport()
1139
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1140
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1141
% (url, self._bzr_selftest_roots))
1143
def record_directory_isolation(self):
1144
"""Gather accessed directories to permit later access.
1146
This is used for tests that access the branch bzr is running from.
1148
self._directory_isolation = "record"
1150
def start_server(self, transport_server, backing_server=None):
1151
"""Start transport_server for this test.
1153
This starts the server, registers a cleanup for it and permits the
1154
server's urls to be used.
1156
if backing_server is None:
1157
transport_server.start_server()
1159
transport_server.start_server(backing_server)
1160
self.addCleanup(transport_server.stop_server)
1161
# Obtain a real transport because if the server supplies a password, it
1162
# will be hidden from the base on the client side.
1163
t = _mod_transport.get_transport(transport_server.get_url())
1164
# Some transport servers effectively chroot the backing transport;
1165
# others like SFTPServer don't - users of the transport can walk up the
1166
# transport to read the entire backing transport. This wouldn't matter
1167
# except that the workdir tests are given - and that they expect the
1168
# server's url to point at - is one directory under the safety net. So
1169
# Branch operations into the transport will attempt to walk up one
1170
# directory. Chrooting all servers would avoid this but also mean that
1171
# we wouldn't be testing directly against non-root urls. Alternatively
1172
# getting the test framework to start the server with a backing server
1173
# at the actual safety net directory would work too, but this then
1174
# means that the self.get_url/self.get_transport methods would need
1175
# to transform all their results. On balance its cleaner to handle it
1176
# here, and permit a higher url when we have one of these transports.
1177
if t.base.endswith('/work/'):
1178
# we have safety net/test root/work
1179
t = t.clone('../..')
1180
elif isinstance(transport_server,
1181
test_server.SmartTCPServer_for_testing):
1182
# The smart server adds a path similar to work, which is traversed
1183
# up from by the client. But the server is chrooted - the actual
1184
# backing transport is not escaped from, and VFS requests to the
1185
# root will error (because they try to escape the chroot).
1187
while t2.base != t.base:
1190
self.permit_url(t.base)
1192
def _track_transports(self):
1193
"""Install checks for transport usage."""
1194
# TestCase has no safe place it can write to.
1195
self._bzr_selftest_roots = []
1196
# Currently the easiest way to be sure that nothing is going on is to
1197
# hook into bzr dir opening. This leaves a small window of error for
1198
# transport tests, but they are well known, and we can improve on this
1200
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1201
self._preopen_isolate_transport, "Check bzr directories are safe.")
774
saved = ui.ui_factory
776
ui.ui_factory = saved
777
ui.ui_factory = ui.SilentUIFactory()
778
self.addCleanup(_restore)
1203
780
def _ndiff_strings(self, a, b):
1204
781
"""Return ndiff between two strings containing lines.
1206
783
A trailing newline is added if missing to make the strings
1207
784
print properly."""
1208
785
if b and b[-1] != '\n':
2821
2038
for readonly urls.
2823
2040
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2824
be used without needed to redo it when a different
2041
be used without needed to redo it when a different
2825
2042
subclass is in use ?
2828
2045
def setUp(self):
2829
from bzrlib.tests import http_server
2830
2046
super(ChrootedTestCase, self).setUp()
2831
if not self.vfs_transport_factory == memory.MemoryServer:
2832
self.transport_readonly_server = http_server.HttpServer
2835
def condition_id_re(pattern):
2836
"""Create a condition filter which performs a re check on a test's id.
2838
:param pattern: A regular expression string.
2839
:return: A callable that returns True if the re matches.
2841
filter_re = re.compile(pattern, 0)
2842
def condition(test):
2844
return filter_re.search(test_id)
2848
def condition_isinstance(klass_or_klass_list):
2849
"""Create a condition filter which returns isinstance(param, klass).
2851
:return: A callable which when called with one parameter obj return the
2852
result of isinstance(obj, klass_or_klass_list).
2855
return isinstance(obj, klass_or_klass_list)
2859
def condition_id_in_list(id_list):
2860
"""Create a condition filter which verify that test's id in a list.
2862
:param id_list: A TestIdList object.
2863
:return: A callable that returns True if the test's id appears in the list.
2865
def condition(test):
2866
return id_list.includes(test.id())
2870
def condition_id_startswith(starts):
2871
"""Create a condition filter verifying that test's id starts with a string.
2873
:param starts: A list of string.
2874
:return: A callable that returns True if the test's id starts with one of
2877
def condition(test):
2878
for start in starts:
2879
if test.id().startswith(start):
2885
def exclude_tests_by_condition(suite, condition):
2886
"""Create a test suite which excludes some tests from suite.
2888
:param suite: The suite to get tests from.
2889
:param condition: A callable whose result evaluates True when called with a
2890
test case which should be excluded from the result.
2891
:return: A suite which contains the tests found in suite that fail
2895
for test in iter_suite_tests(suite):
2896
if not condition(test):
2898
return TestUtil.TestSuite(result)
2901
def filter_suite_by_condition(suite, condition):
2902
"""Create a test suite by filtering another one.
2904
:param suite: The source suite.
2905
:param condition: A callable whose result evaluates True when called with a
2906
test case which should be included in the result.
2907
:return: A suite which contains the tests found in suite that pass
2911
for test in iter_suite_tests(suite):
2914
return TestUtil.TestSuite(result)
2047
if not self.vfs_transport_factory == MemoryServer:
2048
self.transport_readonly_server = HttpServer
2917
2051
def filter_suite_by_re(suite, pattern):
2918
"""Create a test suite by filtering another one.
2920
:param suite: the source suite
2921
:param pattern: pattern that names must match
2922
:returns: the newly created suite
2924
condition = condition_id_re(pattern)
2925
result_suite = filter_suite_by_condition(suite, condition)
2929
def filter_suite_by_id_list(suite, test_id_list):
2930
"""Create a test suite by filtering another one.
2932
:param suite: The source suite.
2933
:param test_id_list: A list of the test ids to keep as strings.
2934
:returns: the newly created suite
2936
condition = condition_id_in_list(test_id_list)
2937
result_suite = filter_suite_by_condition(suite, condition)
2941
def filter_suite_by_id_startswith(suite, start):
2942
"""Create a test suite by filtering another one.
2944
:param suite: The source suite.
2945
:param start: A list of string the test id must start with one of.
2946
:returns: the newly created suite
2948
condition = condition_id_startswith(start)
2949
result_suite = filter_suite_by_condition(suite, condition)
2953
def exclude_tests_by_re(suite, pattern):
2954
"""Create a test suite which excludes some tests from suite.
2956
:param suite: The suite to get tests from.
2957
:param pattern: A regular expression string. Test ids that match this
2958
pattern will be excluded from the result.
2959
:return: A TestSuite that contains all the tests from suite without the
2960
tests that matched pattern. The order of tests is the same as it was in
2963
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2966
def preserve_input(something):
2967
"""A helper for performing test suite transformation chains.
2969
:param something: Anything you want to preserve.
2975
def randomize_suite(suite):
2976
"""Return a new TestSuite with suite's tests in random order.
2978
The tests in the input suite are flattened into a single suite in order to
2979
accomplish this. Any nested TestSuites are removed to provide global
2982
tests = list(iter_suite_tests(suite))
2983
random.shuffle(tests)
2984
return TestUtil.TestSuite(tests)
2987
def split_suite_by_condition(suite, condition):
2988
"""Split a test suite into two by a condition.
2990
:param suite: The suite to split.
2991
:param condition: The condition to match on. Tests that match this
2992
condition are returned in the first test suite, ones that do not match
2993
are in the second suite.
2994
:return: A tuple of two test suites, where the first contains tests from
2995
suite matching the condition, and the second contains the remainder
2996
from suite. The order within each output suite is the same as it was in
3001
for test in iter_suite_tests(suite):
3003
matched.append(test)
2052
result = TestUtil.TestSuite()
2053
filter_re = re.compile(pattern)
2054
for test in iter_suite_tests(suite):
2055
if filter_re.search(test.id()):
2056
result.addTest(test)
2060
def sort_suite_by_re(suite, pattern):
2063
filter_re = re.compile(pattern)
2064
for test in iter_suite_tests(suite):
2065
if filter_re.search(test.id()):
3005
did_not_match.append(test)
3006
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3009
def split_suite_by_re(suite, pattern):
3010
"""Split a test suite into two by a regular expression.
3012
:param suite: The suite to split.
3013
:param pattern: A regular expression string. Test ids that match this
3014
pattern will be in the first test suite returned, and the others in the
3015
second test suite returned.
3016
:return: A tuple of two test suites, where the first contains tests from
3017
suite matching pattern, and the second contains the remainder from
3018
suite. The order within each output suite is the same as it was in
3021
return split_suite_by_condition(suite, condition_id_re(pattern))
2069
return TestUtil.TestSuite(first + second)
3024
2072
def run_suite(suite, name='test', verbose=False, pattern=".*",
3025
stop_on_failure=False,
2073
stop_on_failure=False, keep_output=False,
3026
2074
transport=None, lsprof_timed=None, bench_history=None,
3027
2075
matching_tests_first=None,
3030
exclude_pattern=None,
3033
suite_decorators=None,
3035
result_decorators=None,
3037
"""Run a test suite for bzr selftest.
2076
numbered_dirs=None):
2077
use_numbered_dirs = bool(numbered_dirs)
3039
:param runner_class: The class of runner to use. Must support the
3040
constructor arguments passed by run_suite which are more than standard
3042
:return: A boolean indicating success.
3044
2079
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2080
if numbered_dirs is not None:
2081
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
3049
if runner_class is None:
3050
runner_class = TextTestRunner
3053
runner = runner_class(stream=stream,
2086
runner = TextTestRunner(stream=sys.stdout,
3054
2087
descriptions=0,
3055
2088
verbosity=verbosity,
2089
keep_output=keep_output,
3056
2090
bench_history=bench_history,
3058
result_decorators=result_decorators,
2091
use_numbered_dirs=use_numbered_dirs,
3060
2093
runner.stop_on_failure=stop_on_failure
3061
# built in decorator factories:
3063
random_order(random_seed, runner),
3064
exclude_tests(exclude_pattern),
3066
if matching_tests_first:
3067
decorators.append(tests_first(pattern))
3069
decorators.append(filter_tests(pattern))
3070
if suite_decorators:
3071
decorators.extend(suite_decorators)
3072
# tell the result object how many tests will be running: (except if
3073
# --parallel=fork is being used. Robert said he will provide a better
3074
# progress design later -- vila 20090817)
3075
if fork_decorator not in decorators:
3076
decorators.append(CountingDecorator)
3077
for decorator in decorators:
3078
suite = decorator(suite)
3080
# Done after test suite decoration to allow randomisation etc
3081
# to take effect, though that is of marginal benefit.
3083
stream.write("Listing tests only ...\n")
3084
for t in iter_suite_tests(suite):
3085
stream.write("%s\n" % (t.id()))
2095
if matching_tests_first:
2096
suite = sort_suite_by_re(suite, pattern)
2098
suite = filter_suite_by_re(suite, pattern)
3087
2099
result = runner.run(suite)
3089
return result.wasStrictlySuccessful()
3091
return result.wasSuccessful()
3094
# A registry where get() returns a suite decorator.
3095
parallel_registry = registry.Registry()
3098
def fork_decorator(suite):
3099
if getattr(os, "fork", None) is None:
3100
raise errors.BzrCommandError("platform does not support fork,"
3101
" try --parallel=subprocess instead.")
3102
concurrency = osutils.local_concurrency()
3103
if concurrency == 1:
3105
from testtools import ConcurrentTestSuite
3106
return ConcurrentTestSuite(suite, fork_for_tests)
3107
parallel_registry.register('fork', fork_decorator)
3110
def subprocess_decorator(suite):
3111
concurrency = osutils.local_concurrency()
3112
if concurrency == 1:
3114
from testtools import ConcurrentTestSuite
3115
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3116
parallel_registry.register('subprocess', subprocess_decorator)
3119
def exclude_tests(exclude_pattern):
3120
"""Return a test suite decorator that excludes tests."""
3121
if exclude_pattern is None:
3122
return identity_decorator
3123
def decorator(suite):
3124
return ExcludeDecorator(suite, exclude_pattern)
3128
def filter_tests(pattern):
3130
return identity_decorator
3131
def decorator(suite):
3132
return FilterTestsDecorator(suite, pattern)
3136
def random_order(random_seed, runner):
3137
"""Return a test suite decorator factory for randomising tests order.
3139
:param random_seed: now, a string which casts to a long, or a long.
3140
:param runner: A test runner with a stream attribute to report on.
3142
if random_seed is None:
3143
return identity_decorator
3144
def decorator(suite):
3145
return RandomDecorator(suite, random_seed, runner.stream)
3149
def tests_first(pattern):
3151
return identity_decorator
3152
def decorator(suite):
3153
return TestFirstDecorator(suite, pattern)
3157
def identity_decorator(suite):
3162
class TestDecorator(TestUtil.TestSuite):
3163
"""A decorator for TestCase/TestSuite objects.
3165
Usually, subclasses should override __iter__(used when flattening test
3166
suites), which we do to filter, reorder, parallelise and so on, run() and
3170
def __init__(self, suite):
3171
TestUtil.TestSuite.__init__(self)
3174
def countTestCases(self):
3177
cases += test.countTestCases()
3184
def run(self, result):
3185
# Use iteration on self, not self._tests, to allow subclasses to hook
3188
if result.shouldStop:
3194
class CountingDecorator(TestDecorator):
3195
"""A decorator which calls result.progress(self.countTestCases)."""
3197
def run(self, result):
3198
progress_method = getattr(result, 'progress', None)
3199
if callable(progress_method):
3200
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3201
return super(CountingDecorator, self).run(result)
3204
class ExcludeDecorator(TestDecorator):
3205
"""A decorator which excludes test matching an exclude pattern."""
3207
def __init__(self, suite, exclude_pattern):
3208
TestDecorator.__init__(self, suite)
3209
self.exclude_pattern = exclude_pattern
3210
self.excluded = False
3214
return iter(self._tests)
3215
self.excluded = True
3216
suite = exclude_tests_by_re(self, self.exclude_pattern)
3218
self.addTests(suite)
3219
return iter(self._tests)
3222
class FilterTestsDecorator(TestDecorator):
3223
"""A decorator which filters tests to those matching a pattern."""
3225
def __init__(self, suite, pattern):
3226
TestDecorator.__init__(self, suite)
3227
self.pattern = pattern
3228
self.filtered = False
3232
return iter(self._tests)
3233
self.filtered = True
3234
suite = filter_suite_by_re(self, self.pattern)
3236
self.addTests(suite)
3237
return iter(self._tests)
3240
class RandomDecorator(TestDecorator):
3241
"""A decorator which randomises the order of its tests."""
3243
def __init__(self, suite, random_seed, stream):
3244
TestDecorator.__init__(self, suite)
3245
self.random_seed = random_seed
3246
self.randomised = False
3247
self.stream = stream
3251
return iter(self._tests)
3252
self.randomised = True
3253
self.stream.write("Randomizing test order using seed %s\n\n" %
3254
(self.actual_seed()))
3255
# Initialise the random number generator.
3256
random.seed(self.actual_seed())
3257
suite = randomize_suite(self)
3259
self.addTests(suite)
3260
return iter(self._tests)
3262
def actual_seed(self):
3263
if self.random_seed == "now":
3264
# We convert the seed to a long to make it reuseable across
3265
# invocations (because the user can reenter it).
3266
self.random_seed = long(time.time())
3268
# Convert the seed to a long if we can
3270
self.random_seed = long(self.random_seed)
3273
return self.random_seed
3276
class TestFirstDecorator(TestDecorator):
3277
"""A decorator which moves named tests to the front."""
3279
def __init__(self, suite, pattern):
3280
TestDecorator.__init__(self, suite)
3281
self.pattern = pattern
3282
self.filtered = False
3286
return iter(self._tests)
3287
self.filtered = True
3288
suites = split_suite_by_re(self, self.pattern)
3290
self.addTests(suites)
3291
return iter(self._tests)
3294
def partition_tests(suite, count):
3295
"""Partition suite into count lists of tests."""
3296
# This just assigns tests in a round-robin fashion. On one hand this
3297
# splits up blocks of related tests that might run faster if they shared
3298
# resources, but on the other it avoids assigning blocks of slow tests to
3299
# just one partition. So the slowest partition shouldn't be much slower
3301
partitions = [list() for i in range(count)]
3302
tests = iter_suite_tests(suite)
3303
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3304
partition.append(test)
3308
def workaround_zealous_crypto_random():
3309
"""Crypto.Random want to help us being secure, but we don't care here.
3311
This workaround some test failure related to the sftp server. Once paramiko
3312
stop using the controversial API in Crypto.Random, we may get rid of it.
3315
from Crypto.Random import atfork
3321
def fork_for_tests(suite):
3322
"""Take suite and start up one runner per CPU by forking()
3324
:return: An iterable of TestCase-like objects which can each have
3325
run(result) called on them to feed tests to result.
3327
concurrency = osutils.local_concurrency()
3329
from subunit import TestProtocolClient, ProtocolTestCase
3330
from subunit.test_results import AutoTimingTestResultDecorator
3331
class TestInOtherProcess(ProtocolTestCase):
3332
# Should be in subunit, I think. RBC.
3333
def __init__(self, stream, pid):
3334
ProtocolTestCase.__init__(self, stream)
3337
def run(self, result):
3339
ProtocolTestCase.run(self, result)
3341
os.waitpid(self.pid, 0)
3343
test_blocks = partition_tests(suite, concurrency)
3344
for process_tests in test_blocks:
3345
process_suite = TestUtil.TestSuite()
3346
process_suite.addTests(process_tests)
3347
c2pread, c2pwrite = os.pipe()
3350
workaround_zealous_crypto_random()
3353
# Leave stderr and stdout open so we can see test noise
3354
# Close stdin so that the child goes away if it decides to
3355
# read from stdin (otherwise its a roulette to see what
3356
# child actually gets keystrokes for pdb etc).
3359
stream = os.fdopen(c2pwrite, 'wb', 1)
3360
subunit_result = AutoTimingTestResultDecorator(
3361
TestProtocolClient(stream))
3362
process_suite.run(subunit_result)
3367
stream = os.fdopen(c2pread, 'rb', 1)
3368
test = TestInOtherProcess(stream, pid)
3373
def reinvoke_for_tests(suite):
3374
"""Take suite and start up one runner per CPU using subprocess().
3376
:return: An iterable of TestCase-like objects which can each have
3377
run(result) called on them to feed tests to result.
3379
concurrency = osutils.local_concurrency()
3381
from subunit import ProtocolTestCase
3382
class TestInSubprocess(ProtocolTestCase):
3383
def __init__(self, process, name):
3384
ProtocolTestCase.__init__(self, process.stdout)
3385
self.process = process
3386
self.process.stdin.close()
3389
def run(self, result):
3391
ProtocolTestCase.run(self, result)
3394
os.unlink(self.name)
3395
# print "pid %d finished" % finished_process
3396
test_blocks = partition_tests(suite, concurrency)
3397
for process_tests in test_blocks:
3398
# ugly; currently reimplement rather than reuses TestCase methods.
3399
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3400
if not os.path.isfile(bzr_path):
3401
# We are probably installed. Assume sys.argv is the right file
3402
bzr_path = sys.argv[0]
3403
bzr_path = [bzr_path]
3404
if sys.platform == "win32":
3405
# if we're on windows, we can't execute the bzr script directly
3406
bzr_path = [sys.executable] + bzr_path
3407
fd, test_list_file_name = tempfile.mkstemp()
3408
test_list_file = os.fdopen(fd, 'wb', 1)
3409
for test in process_tests:
3410
test_list_file.write(test.id() + '\n')
3411
test_list_file.close()
3413
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3415
if '--no-plugins' in sys.argv:
3416
argv.append('--no-plugins')
3417
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3418
# noise on stderr it can interrupt the subunit protocol.
3419
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3420
stdout=subprocess.PIPE,
3421
stderr=subprocess.PIPE,
3423
test = TestInSubprocess(process, test_list_file_name)
3426
os.unlink(test_list_file_name)
3431
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3432
"""Generate profiling data for all activity between start and success.
3434
The profile data is appended to the test's _benchcalls attribute and can
3435
be accessed by the forwarded-to TestResult.
3437
While it might be cleaner do accumulate this in stopTest, addSuccess is
3438
where our existing output support for lsprof is, and this class aims to
3439
fit in with that: while it could be moved it's not necessary to accomplish
3440
test profiling, nor would it be dramatically cleaner.
3443
def startTest(self, test):
3444
self.profiler = bzrlib.lsprof.BzrProfiler()
3445
# Prevent deadlocks in tests that use lsprof: those tests will
3447
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3448
self.profiler.start()
3449
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3451
def addSuccess(self, test):
3452
stats = self.profiler.stop()
3454
calls = test._benchcalls
3455
except AttributeError:
3456
test._benchcalls = []
3457
calls = test._benchcalls
3458
calls.append(((test.id(), "", ""), stats))
3459
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3461
def stopTest(self, test):
3462
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3463
self.profiler = None
3466
# Controlled by "bzr selftest -E=..." option
3467
# Currently supported:
3468
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3469
# preserves any flags supplied at the command line.
3470
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3471
# rather than failing tests. And no longer raise
3472
# LockContention when fctnl locks are not being used
3473
# with proper exclusion rules.
3474
# -Ethreads Will display thread ident at creation/join time to
3475
# help track thread leaks
3476
selftest_debug_flags = set()
2100
return result.wasSuccessful()
3479
2103
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3480
2105
transport=None,
3481
2106
test_suite_factory=None,
3482
2107
lsprof_timed=None,
3483
2108
bench_history=None,
3484
2109
matching_tests_first=None,
3487
exclude_pattern=None,
3493
suite_decorators=None,
2110
numbered_dirs=None):
3497
2111
"""Run the whole test suite under the enhanced runner"""
3498
2112
# XXX: Very ugly way to do this...
3499
2113
# Disable warning about old formats because we don't want it to disturb
3506
2120
transport = default_transport
3507
2121
old_transport = default_transport
3508
2122
default_transport = transport
3509
global selftest_debug_flags
3510
old_debug_flags = selftest_debug_flags
3511
if debug_flags is not None:
3512
selftest_debug_flags = set(debug_flags)
3514
if load_list is None:
3517
keep_only = load_test_id_list(load_list)
3519
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3520
for start in starting_with]
3521
2124
if test_suite_factory is None:
3522
# Reduce loading time by loading modules based on the starting_with
3524
suite = test_suite(keep_only, starting_with)
2125
suite = test_suite()
3526
2127
suite = test_suite_factory()
3528
# But always filter as requested.
3529
suite = filter_suite_by_id_startswith(suite, starting_with)
3530
result_decorators = []
3532
result_decorators.append(ProfileResult)
3533
2128
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3534
stop_on_failure=stop_on_failure,
2129
stop_on_failure=stop_on_failure, keep_output=keep_output,
3535
2130
transport=transport,
3536
2131
lsprof_timed=lsprof_timed,
3537
2132
bench_history=bench_history,
3538
2133
matching_tests_first=matching_tests_first,
3539
list_only=list_only,
3540
random_seed=random_seed,
3541
exclude_pattern=exclude_pattern,
3543
runner_class=runner_class,
3544
suite_decorators=suite_decorators,
3546
result_decorators=result_decorators,
2134
numbered_dirs=numbered_dirs)
3549
2136
default_transport = old_transport
3550
selftest_debug_flags = old_debug_flags
3553
def load_test_id_list(file_name):
3554
"""Load a test id list from a text file.
3556
The format is one test id by line. No special care is taken to impose
3557
strict rules, these test ids are used to filter the test suite so a test id
3558
that do not match an existing test will do no harm. This allows user to add
3559
comments, leave blank lines, etc.
3563
ftest = open(file_name, 'rt')
3565
if e.errno != errno.ENOENT:
3568
raise errors.NoSuchFile(file_name)
3570
for test_name in ftest.readlines():
3571
test_list.append(test_name.strip())
3576
def suite_matches_id_list(test_suite, id_list):
3577
"""Warns about tests not appearing or appearing more than once.
3579
:param test_suite: A TestSuite object.
3580
:param test_id_list: The list of test ids that should be found in
3583
:return: (absents, duplicates) absents is a list containing the test found
3584
in id_list but not in test_suite, duplicates is a list containing the
3585
test found multiple times in test_suite.
3587
When using a prefined test id list, it may occurs that some tests do not
3588
exist anymore or that some tests use the same id. This function warns the
3589
tester about potential problems in his workflow (test lists are volatile)
3590
or in the test suite itself (using the same id for several tests does not
3591
help to localize defects).
3593
# Build a dict counting id occurrences
3595
for test in iter_suite_tests(test_suite):
3597
tests[id] = tests.get(id, 0) + 1
3602
occurs = tests.get(id, 0)
3604
not_found.append(id)
3606
duplicates.append(id)
3608
return not_found, duplicates
3611
class TestIdList(object):
3612
"""Test id list to filter a test suite.
3614
Relying on the assumption that test ids are built as:
3615
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3616
notation, this class offers methods to :
3617
- avoid building a test suite for modules not refered to in the test list,
3618
- keep only the tests listed from the module test suite.
3621
def __init__(self, test_id_list):
3622
# When a test suite needs to be filtered against us we compare test ids
3623
# for equality, so a simple dict offers a quick and simple solution.
3624
self.tests = dict().fromkeys(test_id_list, True)
3626
# While unittest.TestCase have ids like:
3627
# <module>.<class>.<method>[(<param+)],
3628
# doctest.DocTestCase can have ids like:
3631
# <module>.<function>
3632
# <module>.<class>.<method>
3634
# Since we can't predict a test class from its name only, we settle on
3635
# a simple constraint: a test id always begins with its module name.
3638
for test_id in test_id_list:
3639
parts = test_id.split('.')
3640
mod_name = parts.pop(0)
3641
modules[mod_name] = True
3643
mod_name += '.' + part
3644
modules[mod_name] = True
3645
self.modules = modules
3647
def refers_to(self, module_name):
3648
"""Is there tests for the module or one of its sub modules."""
3649
return self.modules.has_key(module_name)
3651
def includes(self, test_id):
3652
return self.tests.has_key(test_id)
3655
class TestPrefixAliasRegistry(registry.Registry):
3656
"""A registry for test prefix aliases.
3658
This helps implement shorcuts for the --starting-with selftest
3659
option. Overriding existing prefixes is not allowed but not fatal (a
3660
warning will be emitted).
3663
def register(self, key, obj, help=None, info=None,
3664
override_existing=False):
3665
"""See Registry.register.
3667
Trying to override an existing alias causes a warning to be emitted,
3668
not a fatal execption.
3671
super(TestPrefixAliasRegistry, self).register(
3672
key, obj, help=help, info=info, override_existing=False)
3674
actual = self.get(key)
3676
'Test prefix alias %s is already used for %s, ignoring %s'
3677
% (key, actual, obj))
3679
def resolve_alias(self, id_start):
3680
"""Replace the alias by the prefix in the given string.
3682
Using an unknown prefix is an error to help catching typos.
3684
parts = id_start.split('.')
3686
parts[0] = self.get(parts[0])
3688
raise errors.BzrCommandError(
3689
'%s is not a known test prefix alias' % parts[0])
3690
return '.'.join(parts)
3693
test_prefix_alias_registry = TestPrefixAliasRegistry()
3694
"""Registry of test prefix aliases."""
3697
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3698
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3699
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3701
# Obvious highest levels prefixes, feel free to add your own via a plugin
3702
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3703
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3704
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3705
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3706
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3709
def _test_suite_testmod_names():
3710
"""Return the standard list of test module names to test."""
3713
'bzrlib.tests.blackbox',
3714
'bzrlib.tests.commands',
3715
'bzrlib.tests.doc_generate',
3716
'bzrlib.tests.per_branch',
3717
'bzrlib.tests.per_bzrdir',
3718
'bzrlib.tests.per_controldir',
3719
'bzrlib.tests.per_controldir_colo',
3720
'bzrlib.tests.per_foreign_vcs',
3721
'bzrlib.tests.per_interrepository',
3722
'bzrlib.tests.per_intertree',
3723
'bzrlib.tests.per_inventory',
3724
'bzrlib.tests.per_interbranch',
3725
'bzrlib.tests.per_lock',
3726
'bzrlib.tests.per_merger',
3727
'bzrlib.tests.per_transport',
3728
'bzrlib.tests.per_tree',
3729
'bzrlib.tests.per_pack_repository',
3730
'bzrlib.tests.per_repository',
3731
'bzrlib.tests.per_repository_chk',
3732
'bzrlib.tests.per_repository_reference',
3733
'bzrlib.tests.per_repository_vf',
3734
'bzrlib.tests.per_uifactory',
3735
'bzrlib.tests.per_versionedfile',
3736
'bzrlib.tests.per_workingtree',
3737
'bzrlib.tests.test__annotator',
3738
'bzrlib.tests.test__bencode',
3739
'bzrlib.tests.test__btree_serializer',
3740
'bzrlib.tests.test__chk_map',
3741
'bzrlib.tests.test__dirstate_helpers',
3742
'bzrlib.tests.test__groupcompress',
3743
'bzrlib.tests.test__known_graph',
3744
'bzrlib.tests.test__rio',
3745
'bzrlib.tests.test__simple_set',
3746
'bzrlib.tests.test__static_tuple',
3747
'bzrlib.tests.test__walkdirs_win32',
3748
'bzrlib.tests.test_ancestry',
3749
'bzrlib.tests.test_annotate',
3750
'bzrlib.tests.test_api',
3751
'bzrlib.tests.test_atomicfile',
3752
'bzrlib.tests.test_bad_files',
3753
'bzrlib.tests.test_bisect_multi',
3754
'bzrlib.tests.test_branch',
3755
'bzrlib.tests.test_branchbuilder',
3756
'bzrlib.tests.test_btree_index',
3757
'bzrlib.tests.test_bugtracker',
3758
'bzrlib.tests.test_bundle',
3759
'bzrlib.tests.test_bzrdir',
3760
'bzrlib.tests.test__chunks_to_lines',
3761
'bzrlib.tests.test_cache_utf8',
3762
'bzrlib.tests.test_chk_map',
3763
'bzrlib.tests.test_chk_serializer',
3764
'bzrlib.tests.test_chunk_writer',
3765
'bzrlib.tests.test_clean_tree',
3766
'bzrlib.tests.test_cleanup',
3767
'bzrlib.tests.test_cmdline',
3768
'bzrlib.tests.test_commands',
3769
'bzrlib.tests.test_commit',
3770
'bzrlib.tests.test_commit_merge',
3771
'bzrlib.tests.test_config',
3772
'bzrlib.tests.test_conflicts',
3773
'bzrlib.tests.test_controldir',
3774
'bzrlib.tests.test_counted_lock',
3775
'bzrlib.tests.test_crash',
3776
'bzrlib.tests.test_decorators',
3777
'bzrlib.tests.test_delta',
3778
'bzrlib.tests.test_debug',
3779
'bzrlib.tests.test_deprecated_graph',
3780
'bzrlib.tests.test_diff',
3781
'bzrlib.tests.test_directory_service',
3782
'bzrlib.tests.test_dirstate',
3783
'bzrlib.tests.test_email_message',
3784
'bzrlib.tests.test_eol_filters',
3785
'bzrlib.tests.test_errors',
3786
'bzrlib.tests.test_export',
3787
'bzrlib.tests.test_extract',
3788
'bzrlib.tests.test_fetch',
3789
'bzrlib.tests.test_fixtures',
3790
'bzrlib.tests.test_fifo_cache',
3791
'bzrlib.tests.test_filters',
3792
'bzrlib.tests.test_ftp_transport',
3793
'bzrlib.tests.test_foreign',
3794
'bzrlib.tests.test_generate_docs',
3795
'bzrlib.tests.test_generate_ids',
3796
'bzrlib.tests.test_globbing',
3797
'bzrlib.tests.test_gpg',
3798
'bzrlib.tests.test_graph',
3799
'bzrlib.tests.test_groupcompress',
3800
'bzrlib.tests.test_hashcache',
3801
'bzrlib.tests.test_help',
3802
'bzrlib.tests.test_hooks',
3803
'bzrlib.tests.test_http',
3804
'bzrlib.tests.test_http_response',
3805
'bzrlib.tests.test_https_ca_bundle',
3806
'bzrlib.tests.test_identitymap',
3807
'bzrlib.tests.test_ignores',
3808
'bzrlib.tests.test_index',
3809
'bzrlib.tests.test_import_tariff',
3810
'bzrlib.tests.test_info',
3811
'bzrlib.tests.test_inv',
3812
'bzrlib.tests.test_inventory_delta',
3813
'bzrlib.tests.test_knit',
3814
'bzrlib.tests.test_lazy_import',
3815
'bzrlib.tests.test_lazy_regex',
3816
'bzrlib.tests.test_library_state',
3817
'bzrlib.tests.test_lock',
3818
'bzrlib.tests.test_lockable_files',
3819
'bzrlib.tests.test_lockdir',
3820
'bzrlib.tests.test_log',
3821
'bzrlib.tests.test_lru_cache',
3822
'bzrlib.tests.test_lsprof',
3823
'bzrlib.tests.test_mail_client',
3824
'bzrlib.tests.test_matchers',
3825
'bzrlib.tests.test_memorytree',
3826
'bzrlib.tests.test_merge',
3827
'bzrlib.tests.test_merge3',
3828
'bzrlib.tests.test_merge_core',
3829
'bzrlib.tests.test_merge_directive',
3830
'bzrlib.tests.test_mergetools',
3831
'bzrlib.tests.test_missing',
3832
'bzrlib.tests.test_msgeditor',
3833
'bzrlib.tests.test_multiparent',
3834
'bzrlib.tests.test_mutabletree',
3835
'bzrlib.tests.test_nonascii',
3836
'bzrlib.tests.test_options',
3837
'bzrlib.tests.test_osutils',
3838
'bzrlib.tests.test_osutils_encodings',
3839
'bzrlib.tests.test_pack',
3840
'bzrlib.tests.test_patch',
3841
'bzrlib.tests.test_patches',
3842
'bzrlib.tests.test_permissions',
3843
'bzrlib.tests.test_plugins',
3844
'bzrlib.tests.test_progress',
3845
'bzrlib.tests.test_pyutils',
3846
'bzrlib.tests.test_read_bundle',
3847
'bzrlib.tests.test_reconcile',
3848
'bzrlib.tests.test_reconfigure',
3849
'bzrlib.tests.test_registry',
3850
'bzrlib.tests.test_remote',
3851
'bzrlib.tests.test_rename_map',
3852
'bzrlib.tests.test_repository',
3853
'bzrlib.tests.test_revert',
3854
'bzrlib.tests.test_revision',
3855
'bzrlib.tests.test_revisionspec',
3856
'bzrlib.tests.test_revisiontree',
3857
'bzrlib.tests.test_rio',
3858
'bzrlib.tests.test_rules',
3859
'bzrlib.tests.test_sampler',
3860
'bzrlib.tests.test_scenarios',
3861
'bzrlib.tests.test_script',
3862
'bzrlib.tests.test_selftest',
3863
'bzrlib.tests.test_serializer',
3864
'bzrlib.tests.test_setup',
3865
'bzrlib.tests.test_sftp_transport',
3866
'bzrlib.tests.test_shelf',
3867
'bzrlib.tests.test_shelf_ui',
3868
'bzrlib.tests.test_smart',
3869
'bzrlib.tests.test_smart_add',
3870
'bzrlib.tests.test_smart_request',
3871
'bzrlib.tests.test_smart_transport',
3872
'bzrlib.tests.test_smtp_connection',
3873
'bzrlib.tests.test_source',
3874
'bzrlib.tests.test_ssh_transport',
3875
'bzrlib.tests.test_status',
3876
'bzrlib.tests.test_store',
3877
'bzrlib.tests.test_strace',
3878
'bzrlib.tests.test_subsume',
3879
'bzrlib.tests.test_switch',
3880
'bzrlib.tests.test_symbol_versioning',
3881
'bzrlib.tests.test_tag',
3882
'bzrlib.tests.test_test_server',
3883
'bzrlib.tests.test_testament',
3884
'bzrlib.tests.test_textfile',
3885
'bzrlib.tests.test_textmerge',
3886
'bzrlib.tests.test_cethread',
3887
'bzrlib.tests.test_timestamp',
3888
'bzrlib.tests.test_trace',
3889
'bzrlib.tests.test_transactions',
3890
'bzrlib.tests.test_transform',
3891
'bzrlib.tests.test_transport',
3892
'bzrlib.tests.test_transport_log',
3893
'bzrlib.tests.test_tree',
3894
'bzrlib.tests.test_treebuilder',
3895
'bzrlib.tests.test_treeshape',
3896
'bzrlib.tests.test_tsort',
3897
'bzrlib.tests.test_tuned_gzip',
3898
'bzrlib.tests.test_ui',
3899
'bzrlib.tests.test_uncommit',
3900
'bzrlib.tests.test_upgrade',
3901
'bzrlib.tests.test_upgrade_stacked',
3902
'bzrlib.tests.test_urlutils',
3903
'bzrlib.tests.test_version',
3904
'bzrlib.tests.test_version_info',
3905
'bzrlib.tests.test_versionedfile',
3906
'bzrlib.tests.test_weave',
3907
'bzrlib.tests.test_whitebox',
3908
'bzrlib.tests.test_win32utils',
3909
'bzrlib.tests.test_workingtree',
3910
'bzrlib.tests.test_workingtree_4',
3911
'bzrlib.tests.test_wsgi',
3912
'bzrlib.tests.test_xml',
3916
def _test_suite_modules_to_doctest():
3917
"""Return the list of modules to doctest."""
3919
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3923
'bzrlib.branchbuilder',
3924
'bzrlib.decorators',
3926
'bzrlib.iterablefile',
3931
'bzrlib.symbol_versioning',
3933
'bzrlib.tests.fixtures',
3935
'bzrlib.transport.http',
3936
'bzrlib.version_info_formats.format_custom',
3940
def test_suite(keep_only=None, starting_with=None):
3941
2140
"""Build and return TestSuite for the whole of bzrlib.
3943
:param keep_only: A list of test ids limiting the suite returned.
3945
:param starting_with: An id limiting the suite returned to the tests
3948
2142
This function can be replaced if you need to change the default test
3949
2143
suite on a global basis, but it is not encouraged.
2146
'bzrlib.tests.test_ancestry',
2147
'bzrlib.tests.test_annotate',
2148
'bzrlib.tests.test_api',
2149
'bzrlib.tests.test_atomicfile',
2150
'bzrlib.tests.test_bad_files',
2151
'bzrlib.tests.test_branch',
2152
'bzrlib.tests.test_bundle',
2153
'bzrlib.tests.test_bzrdir',
2154
'bzrlib.tests.test_cache_utf8',
2155
'bzrlib.tests.test_commands',
2156
'bzrlib.tests.test_commit',
2157
'bzrlib.tests.test_commit_merge',
2158
'bzrlib.tests.test_config',
2159
'bzrlib.tests.test_conflicts',
2160
'bzrlib.tests.test_decorators',
2161
'bzrlib.tests.test_delta',
2162
'bzrlib.tests.test_diff',
2163
'bzrlib.tests.test_dirstate',
2164
'bzrlib.tests.test_doc_generate',
2165
'bzrlib.tests.test_errors',
2166
'bzrlib.tests.test_escaped_store',
2167
'bzrlib.tests.test_extract',
2168
'bzrlib.tests.test_fetch',
2169
'bzrlib.tests.test_ftp_transport',
2170
'bzrlib.tests.test_generate_docs',
2171
'bzrlib.tests.test_generate_ids',
2172
'bzrlib.tests.test_globbing',
2173
'bzrlib.tests.test_gpg',
2174
'bzrlib.tests.test_graph',
2175
'bzrlib.tests.test_hashcache',
2176
'bzrlib.tests.test_http',
2177
'bzrlib.tests.test_http_response',
2178
'bzrlib.tests.test_https_ca_bundle',
2179
'bzrlib.tests.test_identitymap',
2180
'bzrlib.tests.test_ignores',
2181
'bzrlib.tests.test_inv',
2182
'bzrlib.tests.test_knit',
2183
'bzrlib.tests.test_lazy_import',
2184
'bzrlib.tests.test_lazy_regex',
2185
'bzrlib.tests.test_lockdir',
2186
'bzrlib.tests.test_lockable_files',
2187
'bzrlib.tests.test_log',
2188
'bzrlib.tests.test_memorytree',
2189
'bzrlib.tests.test_merge',
2190
'bzrlib.tests.test_merge3',
2191
'bzrlib.tests.test_merge_core',
2192
'bzrlib.tests.test_merge_directive',
2193
'bzrlib.tests.test_missing',
2194
'bzrlib.tests.test_msgeditor',
2195
'bzrlib.tests.test_nonascii',
2196
'bzrlib.tests.test_options',
2197
'bzrlib.tests.test_osutils',
2198
'bzrlib.tests.test_osutils_encodings',
2199
'bzrlib.tests.test_patch',
2200
'bzrlib.tests.test_patches',
2201
'bzrlib.tests.test_permissions',
2202
'bzrlib.tests.test_plugins',
2203
'bzrlib.tests.test_progress',
2204
'bzrlib.tests.test_reconcile',
2205
'bzrlib.tests.test_registry',
2206
'bzrlib.tests.test_repository',
2207
'bzrlib.tests.test_revert',
2208
'bzrlib.tests.test_revision',
2209
'bzrlib.tests.test_revisionnamespaces',
2210
'bzrlib.tests.test_revisiontree',
2211
'bzrlib.tests.test_rio',
2212
'bzrlib.tests.test_sampler',
2213
'bzrlib.tests.test_selftest',
2214
'bzrlib.tests.test_setup',
2215
'bzrlib.tests.test_sftp_transport',
2216
'bzrlib.tests.test_smart_add',
2217
'bzrlib.tests.test_smart_transport',
2218
'bzrlib.tests.test_source',
2219
'bzrlib.tests.test_ssh_transport',
2220
'bzrlib.tests.test_status',
2221
'bzrlib.tests.test_store',
2222
'bzrlib.tests.test_strace',
2223
'bzrlib.tests.test_subsume',
2224
'bzrlib.tests.test_symbol_versioning',
2225
'bzrlib.tests.test_tag',
2226
'bzrlib.tests.test_testament',
2227
'bzrlib.tests.test_textfile',
2228
'bzrlib.tests.test_textmerge',
2229
'bzrlib.tests.test_timestamp',
2230
'bzrlib.tests.test_trace',
2231
'bzrlib.tests.test_transactions',
2232
'bzrlib.tests.test_transform',
2233
'bzrlib.tests.test_transport',
2234
'bzrlib.tests.test_tree',
2235
'bzrlib.tests.test_treebuilder',
2236
'bzrlib.tests.test_tsort',
2237
'bzrlib.tests.test_tuned_gzip',
2238
'bzrlib.tests.test_ui',
2239
'bzrlib.tests.test_upgrade',
2240
'bzrlib.tests.test_urlutils',
2241
'bzrlib.tests.test_versionedfile',
2242
'bzrlib.tests.test_version',
2243
'bzrlib.tests.test_version_info',
2244
'bzrlib.tests.test_weave',
2245
'bzrlib.tests.test_whitebox',
2246
'bzrlib.tests.test_workingtree',
2247
'bzrlib.tests.test_workingtree_4',
2248
'bzrlib.tests.test_wsgi',
2249
'bzrlib.tests.test_xml',
2251
test_transport_implementations = [
2252
'bzrlib.tests.test_transport_implementations',
2253
'bzrlib.tests.test_read_bundle',
2255
suite = TestUtil.TestSuite()
3952
2256
loader = TestUtil.TestLoader()
3954
if keep_only is not None:
3955
id_filter = TestIdList(keep_only)
3957
# We take precedence over keep_only because *at loading time* using
3958
# both options means we will load less tests for the same final result.
3959
def interesting_module(name):
3960
for start in starting_with:
3962
# Either the module name starts with the specified string
3963
name.startswith(start)
3964
# or it may contain tests starting with the specified string
3965
or start.startswith(name)
3969
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3971
elif keep_only is not None:
3972
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3973
def interesting_module(name):
3974
return id_filter.refers_to(name)
3977
loader = TestUtil.TestLoader()
3978
def interesting_module(name):
3979
# No filtering, all modules are interesting
3982
suite = loader.suiteClass()
3984
# modules building their suite with loadTestsFromModuleNames
3985
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3987
for mod in _test_suite_modules_to_doctest():
3988
if not interesting_module(mod):
3989
# No tests to keep here, move along
2257
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2258
from bzrlib.transport import TransportTestProviderAdapter
2259
adapter = TransportTestProviderAdapter()
2260
adapt_modules(test_transport_implementations, adapter, loader, suite)
2261
for package in packages_to_test():
2262
suite.addTest(package.test_suite())
2263
for m in MODULES_TO_TEST:
2264
suite.addTest(loader.loadTestsFromModule(m))
2265
for m in MODULES_TO_DOCTEST:
3992
# note that this really does mean "report only" -- doctest
3993
# still runs the rest of the examples
3994
doc_suite = IsolatedDocTestSuite(
3995
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
2267
suite.addTest(doctest.DocTestSuite(m))
3996
2268
except ValueError, e:
3997
print '**failed to get doctest for: %s\n%s' % (mod, e)
2269
print '**failed to get doctest for: %s\n%s' %(m,e)
3999
if len(doc_suite._tests) == 0:
4000
raise errors.BzrError("no doctests found in %s" % (mod,))
4001
suite.addTest(doc_suite)
4003
default_encoding = sys.getdefaultencoding()
4004
for name, plugin in _mod_plugin.plugins().items():
4005
if not interesting_module(plugin.module.__name__):
4007
plugin_suite = plugin.test_suite()
4008
# We used to catch ImportError here and turn it into just a warning,
4009
# but really if you don't have --no-plugins this should be a failure.
4010
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4011
if plugin_suite is None:
4012
plugin_suite = plugin.load_plugin_tests(loader)
4013
if plugin_suite is not None:
4014
suite.addTest(plugin_suite)
4015
if default_encoding != sys.getdefaultencoding():
4017
'Plugin "%s" tried to reset default encoding to: %s', name,
4018
sys.getdefaultencoding())
4020
sys.setdefaultencoding(default_encoding)
4022
if keep_only is not None:
4023
# Now that the referred modules have loaded their tests, keep only the
4025
suite = filter_suite_by_id_list(suite, id_filter)
4026
# Do some sanity checks on the id_list filtering
4027
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4029
# The tester has used both keep_only and starting_with, so he is
4030
# already aware that some tests are excluded from the list, there
4031
# is no need to tell him which.
4034
# Some tests mentioned in the list are not in the test suite. The
4035
# list may be out of date, report to the tester.
4036
for id in not_found:
4037
trace.warning('"%s" not found in the test suite', id)
4038
for id in duplicates:
4039
trace.warning('"%s" is used as an id by several tests', id)
2271
for name, plugin in bzrlib.plugin.all_plugins().items():
2272
if getattr(plugin, 'test_suite', None) is not None:
2273
default_encoding = sys.getdefaultencoding()
2275
plugin_suite = plugin.test_suite()
2276
except ImportError, e:
2277
bzrlib.trace.warning(
2278
'Unable to test plugin "%s": %s', name, e)
2280
suite.addTest(plugin_suite)
2281
if default_encoding != sys.getdefaultencoding():
2282
bzrlib.trace.warning(
2283
'Plugin "%s" tried to reset default encoding to: %s', name,
2284
sys.getdefaultencoding())
2286
sys.setdefaultencoding(default_encoding)
4044
def multiply_scenarios(*scenarios):
4045
"""Multiply two or more iterables of scenarios.
4047
It is safe to pass scenario generators or iterators.
4049
:returns: A list of compound scenarios: the cross-product of all
4050
scenarios, with the names concatenated and the parameters
4053
return reduce(_multiply_two_scenarios, map(list, scenarios))
4056
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4057
"""Multiply two sets of scenarios.
4059
:returns: the cartesian product of the two sets of scenarios, that is
4060
a scenario for every possible combination of a left scenario and a
4064
('%s,%s' % (left_name, right_name),
4065
dict(left_dict.items() + right_dict.items()))
4066
for left_name, left_dict in scenarios_left
4067
for right_name, right_dict in scenarios_right]
4070
def multiply_tests(tests, scenarios, result):
4071
"""Multiply tests_list by scenarios into result.
4073
This is the core workhorse for test parameterisation.
4075
Typically the load_tests() method for a per-implementation test suite will
4076
call multiply_tests and return the result.
4078
:param tests: The tests to parameterise.
4079
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4080
scenario_param_dict).
4081
:param result: A TestSuite to add created tests to.
4083
This returns the passed in result TestSuite with the cross product of all
4084
the tests repeated once for each scenario. Each test is adapted by adding
4085
the scenario name at the end of its id(), and updating the test object's
4086
__dict__ with the scenario_param_dict.
4088
>>> import bzrlib.tests.test_sampler
4089
>>> r = multiply_tests(
4090
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4091
... [('one', dict(param=1)),
4092
... ('two', dict(param=2))],
4093
... TestUtil.TestSuite())
4094
>>> tests = list(iter_suite_tests(r))
4098
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4104
for test in iter_suite_tests(tests):
4105
apply_scenarios(test, scenarios, result)
4109
def apply_scenarios(test, scenarios, result):
4110
"""Apply the scenarios in scenarios to test and add to result.
4112
:param test: The test to apply scenarios to.
4113
:param scenarios: An iterable of scenarios to apply to test.
4115
:seealso: apply_scenario
4117
for scenario in scenarios:
4118
result.addTest(apply_scenario(test, scenario))
4122
def apply_scenario(test, scenario):
4123
"""Copy test and apply scenario to it.
4125
:param test: A test to adapt.
4126
:param scenario: A tuple describing the scenarion.
4127
The first element of the tuple is the new test id.
4128
The second element is a dict containing attributes to set on the
4130
:return: The adapted test.
4132
new_id = "%s(%s)" % (test.id(), scenario[0])
4133
new_test = clone_test(test, new_id)
4134
for name, value in scenario[1].items():
4135
setattr(new_test, name, value)
4139
def clone_test(test, new_id):
4140
"""Clone a test giving it a new id.
4142
:param test: The test to clone.
4143
:param new_id: The id to assign to it.
4144
:return: The new test.
4146
new_test = copy.copy(test)
4147
new_test.id = lambda: new_id
4148
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4149
# causes cloned tests to share the 'details' dict. This makes it hard to
4150
# read the test output for parameterized tests, because tracebacks will be
4151
# associated with irrelevant tests.
4153
details = new_test._TestCase__details
4154
except AttributeError:
4155
# must be a different version of testtools than expected. Do nothing.
4158
# Reset the '__details' dict.
4159
new_test._TestCase__details = {}
4163
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4165
"""Helper for permutating tests against an extension module.
4167
This is meant to be used inside a modules 'load_tests()' function. It will
4168
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4169
against both implementations. Setting 'test.module' to the appropriate
4170
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4172
:param standard_tests: A test suite to permute
4173
:param loader: A TestLoader
4174
:param py_module_name: The python path to a python module that can always
4175
be loaded, and will be considered the 'python' implementation. (eg
4176
'bzrlib._chk_map_py')
4177
:param ext_module_name: The python path to an extension module. If the
4178
module cannot be loaded, a single test will be added, which notes that
4179
the module is not available. If it can be loaded, all standard_tests
4180
will be run against that module.
4181
:return: (suite, feature) suite is a test-suite that has all the permuted
4182
tests. feature is the Feature object that can be used to determine if
4183
the module is available.
4186
py_module = pyutils.get_named_object(py_module_name)
4188
('python', {'module': py_module}),
4190
suite = loader.suiteClass()
4191
feature = ModuleAvailableFeature(ext_module_name)
4192
if feature.available():
4193
scenarios.append(('C', {'module': feature.module}))
4195
# the compiled module isn't available, so we add a failing test
4196
class FailWithoutFeature(TestCase):
4197
def test_fail(self):
4198
self.requireFeature(feature)
4199
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4200
result = multiply_tests(standard_tests, scenarios, suite)
4201
return result, feature
4204
def _rmtree_temp_dir(dirname, test_id=None):
4205
# If LANG=C we probably have created some bogus paths
4206
# which rmtree(unicode) will fail to delete
4207
# so make sure we are using rmtree(str) to delete everything
4208
# except on win32, where rmtree(str) will fail
4209
# since it doesn't have the property of byte-stream paths
4210
# (they are either ascii or mbcs)
4211
if sys.platform == 'win32':
4212
# make sure we are using the unicode win32 api
4213
dirname = unicode(dirname)
4215
dirname = dirname.encode(sys.getfilesystemencoding())
2290
def adapt_modules(mods_list, adapter, loader, suite):
2291
"""Adapt the modules in mods_list using adapter and add to suite."""
2292
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2293
suite.addTests(adapter.adapt(test))
2296
def _rmtree_temp_dir(dirname):
4217
2298
osutils.rmtree(dirname)
4218
2299
except OSError, e:
4219
# We don't want to fail here because some useful display will be lost
4220
# otherwise. Polluting the tmp dir is bad, but not giving all the
4221
# possible info to the test runner is even worse.
4223
ui.ui_factory.clear_term()
4224
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4225
# Ugly, but the last thing we want here is fail, so bear with it.
4226
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4227
).encode('ascii', 'replace')
4228
sys.stderr.write('Unable to remove testing dir %s\n%s'
4229
% (os.path.basename(dirname), printable_e))
2300
if sys.platform == 'win32' and e.errno == errno.EACCES:
2301
print >>sys.stderr, ('Permission denied: '
2302
'unable to remove testing dir '
2303
'%s' % os.path.basename(dirname))
2308
def clean_selftest_output(root=None, quiet=False):
2309
"""Remove all selftest output directories from root directory.
2311
:param root: root directory for clean
2312
(if ommitted or None then clean current directory).
2313
:param quiet: suppress report about deleting directories
2318
re_dir = re.compile(r'''test\d\d\d\d\.tmp''')
2321
for i in os.listdir(root):
2322
if os.path.isdir(i) and re_dir.match(i):
2324
print 'delete directory:', i
4232
2328
class Feature(object):
4255
2351
if getattr(self, 'feature_name', None):
4256
2352
return self.feature_name()
4257
2353
return self.__class__.__name__
4260
class _SymlinkFeature(Feature):
4263
return osutils.has_symlinks()
4265
def feature_name(self):
4268
SymlinkFeature = _SymlinkFeature()
4271
class _HardlinkFeature(Feature):
4274
return osutils.has_hardlinks()
4276
def feature_name(self):
4279
HardlinkFeature = _HardlinkFeature()
4282
class _OsFifoFeature(Feature):
4285
return getattr(os, 'mkfifo', None)
4287
def feature_name(self):
4288
return 'filesystem fifos'
4290
OsFifoFeature = _OsFifoFeature()
4293
class _UnicodeFilenameFeature(Feature):
4294
"""Does the filesystem support Unicode filenames?"""
4298
# Check for character combinations unlikely to be covered by any
4299
# single non-unicode encoding. We use the characters
4300
# - greek small letter alpha (U+03B1) and
4301
# - braille pattern dots-123456 (U+283F).
4302
os.stat(u'\u03b1\u283f')
4303
except UnicodeEncodeError:
4305
except (IOError, OSError):
4306
# The filesystem allows the Unicode filename but the file doesn't
4310
# The filesystem allows the Unicode filename and the file exists,
4314
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4317
class _CompatabilityThunkFeature(Feature):
4318
"""This feature is just a thunk to another feature.
4320
It issues a deprecation warning if it is accessed, to let you know that you
4321
should really use a different feature.
4324
def __init__(self, dep_version, module, name,
4325
replacement_name, replacement_module=None):
4326
super(_CompatabilityThunkFeature, self).__init__()
4327
self._module = module
4328
if replacement_module is None:
4329
replacement_module = module
4330
self._replacement_module = replacement_module
4332
self._replacement_name = replacement_name
4333
self._dep_version = dep_version
4334
self._feature = None
4337
if self._feature is None:
4338
depr_msg = self._dep_version % ('%s.%s'
4339
% (self._module, self._name))
4340
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4341
self._replacement_name)
4342
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4343
# Import the new feature and use it as a replacement for the
4345
self._feature = pyutils.get_named_object(
4346
self._replacement_module, self._replacement_name)
4350
return self._feature._probe()
4353
class ModuleAvailableFeature(Feature):
4354
"""This is a feature than describes a module we want to be available.
4356
Declare the name of the module in __init__(), and then after probing, the
4357
module will be available as 'self.module'.
4359
:ivar module: The module if it is available, else None.
4362
def __init__(self, module_name):
4363
super(ModuleAvailableFeature, self).__init__()
4364
self.module_name = module_name
4368
self._module = __import__(self.module_name, {}, {}, [''])
4375
if self.available(): # Make sure the probe has been done
4379
def feature_name(self):
4380
return self.module_name
4383
def probe_unicode_in_user_encoding():
4384
"""Try to encode several unicode strings to use in unicode-aware tests.
4385
Return first successfull match.
4387
:return: (unicode value, encoded plain string value) or (None, None)
4389
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4390
for uni_val in possible_vals:
4392
str_val = uni_val.encode(osutils.get_user_encoding())
4393
except UnicodeEncodeError:
4394
# Try a different character
4397
return uni_val, str_val
4401
def probe_bad_non_ascii(encoding):
4402
"""Try to find [bad] character with code [128..255]
4403
that cannot be decoded to unicode in some encoding.
4404
Return None if all non-ascii characters is valid
4407
for i in xrange(128, 256):
4410
char.decode(encoding)
4411
except UnicodeDecodeError:
4416
class _HTTPSServerFeature(Feature):
4417
"""Some tests want an https Server, check if one is available.
4419
Right now, the only way this is available is under python2.6 which provides
4430
def feature_name(self):
4431
return 'HTTPSServer'
4434
HTTPSServerFeature = _HTTPSServerFeature()
4437
class _UnicodeFilename(Feature):
4438
"""Does the filesystem support Unicode filenames?"""
4443
except UnicodeEncodeError:
4445
except (IOError, OSError):
4446
# The filesystem allows the Unicode filename but the file doesn't
4450
# The filesystem allows the Unicode filename and the file exists,
4454
UnicodeFilename = _UnicodeFilename()
4457
class _ByteStringNamedFilesystem(Feature):
4458
"""Is the filesystem based on bytes?"""
4461
if os.name == "posix":
4465
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
4468
class _UTF8Filesystem(Feature):
4469
"""Is the filesystem UTF-8?"""
4472
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4476
UTF8Filesystem = _UTF8Filesystem()
4479
class _BreakinFeature(Feature):
4480
"""Does this platform support the breakin feature?"""
4483
from bzrlib import breakin
4484
if breakin.determine_signal() is None:
4486
if sys.platform == 'win32':
4487
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4488
# We trigger SIGBREAK via a Console api so we need ctypes to
4489
# access the function
4496
def feature_name(self):
4497
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4500
BreakinFeature = _BreakinFeature()
4503
class _CaseInsCasePresFilenameFeature(Feature):
4504
"""Is the file-system case insensitive, but case-preserving?"""
4507
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4509
# first check truly case-preserving for created files, then check
4510
# case insensitive when opening existing files.
4511
name = osutils.normpath(name)
4512
base, rel = osutils.split(name)
4513
found_rel = osutils.canonical_relpath(base, name)
4514
return (found_rel == rel
4515
and os.path.isfile(name.upper())
4516
and os.path.isfile(name.lower()))
4521
def feature_name(self):
4522
return "case-insensitive case-preserving filesystem"
4524
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4527
class _CaseInsensitiveFilesystemFeature(Feature):
4528
"""Check if underlying filesystem is case-insensitive but *not* case
4531
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4532
# more likely to be case preserving, so this case is rare.
4535
if CaseInsCasePresFilenameFeature.available():
4538
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4539
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4540
TestCaseWithMemoryTransport.TEST_ROOT = root
4542
root = TestCaseWithMemoryTransport.TEST_ROOT
4543
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4545
name_a = osutils.pathjoin(tdir, 'a')
4546
name_A = osutils.pathjoin(tdir, 'A')
4548
result = osutils.isdir(name_A)
4549
_rmtree_temp_dir(tdir)
4552
def feature_name(self):
4553
return 'case-insensitive filesystem'
4555
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4558
class _CaseSensitiveFilesystemFeature(Feature):
4561
if CaseInsCasePresFilenameFeature.available():
4563
elif CaseInsensitiveFilesystemFeature.available():
4568
def feature_name(self):
4569
return 'case-sensitive filesystem'
4571
# new coding style is for feature instances to be lowercase
4572
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4575
# Only define SubUnitBzrRunner if subunit is available.
4577
from subunit import TestProtocolClient
4578
from subunit.test_results import AutoTimingTestResultDecorator
4579
class SubUnitBzrProtocolClient(TestProtocolClient):
4581
def addSuccess(self, test, details=None):
4582
# The subunit client always includes the details in the subunit
4583
# stream, but we don't want to include it in ours.
4584
if details is not None and 'log' in details:
4586
return super(SubUnitBzrProtocolClient, self).addSuccess(
4589
class SubUnitBzrRunner(TextTestRunner):
4590
def run(self, test):
4591
result = AutoTimingTestResultDecorator(
4592
SubUnitBzrProtocolClient(self.stream))
4598
class _PosixPermissionsFeature(Feature):
4602
# create temporary file and check if specified perms are maintained.
4605
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4606
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4609
os.chmod(name, write_perms)
4611
read_perms = os.stat(name).st_mode & 0777
4613
return (write_perms == read_perms)
4615
return (os.name == 'posix') and has_perms()
4617
def feature_name(self):
4618
return 'POSIX permissions support'
4620
posix_permissions_feature = _PosixPermissionsFeature()
added
removed
bzrlib/tests/__init__.py
