31
29
from cStringIO import StringIO
37
from pprint import pformat
42
from subprocess import Popen, PIPE
53
# nb: check this before importing anything else from within it
54
_testtools_version = getattr(testtools, '__version__', ())
55
if _testtools_version < (0, 9, 5):
56
raise ImportError("need at least testtools 0.9.5: %s is %r"
57
% (testtools.__file__, _testtools_version))
58
from testtools import content
50
61
from bzrlib import (
65
commands as _mod_commands,
75
plugin as _mod_plugin,
82
transport as _mod_transport,
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
69
86
import bzrlib.lsprof
70
87
except ImportError:
71
88
# lsprof not available
73
from bzrlib.merge import merge_inner
77
from bzrlib.revision import common_ancestor
79
from bzrlib import symbol_versioning
90
from bzrlib.smart import client, request
91
from bzrlib.transport import (
80
95
from bzrlib.symbol_versioning import (
85
from bzrlib.transport import get_transport
86
import bzrlib.transport
87
from bzrlib.transport.local import LocalURLServer
88
from bzrlib.transport.memory import MemoryServer
89
from bzrlib.transport.readonly import ReadonlyServer
90
from bzrlib.trace import mutter, note
91
from bzrlib.tests import TestUtil
92
from bzrlib.tests.HttpServer import HttpServer
93
from bzrlib.tests.TestUtil import (
97
from bzrlib.tests.treeshape import build_tree_contents
98
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
99
from bzrlib.tests import (
105
from bzrlib.ui import NullProgressView
106
from bzrlib.ui.text import TextUIFactory
107
from bzrlib.tests.features import _CompatabilityThunkFeature
100
109
# Mark this python module as being part of the implementation
101
110
# of unittest: this gives us better tracebacks where the last
102
111
# shown frame is the test code, not our assertXYZ.
105
default_transport = LocalURLServer
108
MODULES_TO_DOCTEST = [
121
def packages_to_test():
122
"""Return a list of packages to test.
124
The packages are not globally imported so that import failures are
125
triggered when running selftest, not when importing the command.
128
import bzrlib.tests.blackbox
129
import bzrlib.tests.branch_implementations
130
import bzrlib.tests.bzrdir_implementations
131
import bzrlib.tests.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):
114
default_transport = test_server.LocalURLServer
117
_unitialized_attr = object()
118
"""A sentinel needed to act as a default value in a method signature."""
121
# Subunit result codes, defined here to prevent a hard dependency on subunit.
125
# These are intentionally brought into this namespace. That way plugins, etc
126
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
127
TestSuite = TestUtil.TestSuite
128
TestLoader = TestUtil.TestLoader
130
# Tests should run in a clean and clearly defined environment. The goal is to
131
# keep them isolated from the running environment as mush as possible. The test
132
# framework ensures the variables defined below are set (or deleted if the
133
# value is None) before a test is run and reset to their original value after
134
# the test is run. Generally if some code depends on an environment variable,
135
# the tests should start without this variable in the environment. There are a
136
# few exceptions but you shouldn't violate this rule lightly.
140
'XDG_CONFIG_HOME': None,
141
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
142
# tests do check our impls match APPDATA
143
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
147
'BZREMAIL': None, # may still be present in the environment
148
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
149
'BZR_PROGRESS_BAR': None,
150
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
151
# as a base class instead of TestCaseInTempDir. Tests inheriting from
152
# TestCase should not use disk resources, BZR_LOG is one.
153
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
154
'BZR_PLUGIN_PATH': None,
155
'BZR_DISABLE_PLUGINS': None,
156
'BZR_PLUGINS_AT': None,
157
'BZR_CONCURRENCY': None,
158
# Make sure that any text ui tests are consistent regardless of
159
# the environment the test case is run in; you may want tests that
160
# test other combinations. 'dumb' is a reasonable guess for tests
161
# going to a pipe or a StringIO.
167
'SSH_AUTH_SOCK': None,
177
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
178
# least. If you do (care), please update this comment
182
'BZR_REMOTE_PATH': None,
183
# Generally speaking, we don't want apport reporting on crashes in
184
# the test envirnoment unless we're specifically testing apport,
185
# so that it doesn't leak into the real system environment. We
186
# use an env var so it propagates to subprocesses.
187
'APPORT_DISABLE': '1',
191
def override_os_environ(test, env=None):
192
"""Modify os.environ keeping a copy.
194
:param test: A test instance
196
:param env: A dict containing variable definitions to be installed
199
env = isolated_environ
200
test._original_os_environ = dict([(var, value)
201
for var, value in os.environ.iteritems()])
202
for var, value in env.iteritems():
203
osutils.set_or_unset_env(var, value)
204
if var not in test._original_os_environ:
205
# The var is new, add it with a value of None, so
206
# restore_os_environ will delete it
207
test._original_os_environ[var] = None
210
def restore_os_environ(test):
211
"""Restore os.environ to its original state.
213
:param test: A test instance previously passed to override_os_environ.
215
for var, value in test._original_os_environ.iteritems():
216
# Restore the original value (or delete it if the value has been set to
217
# None in override_os_environ).
218
osutils.set_or_unset_env(var, value)
221
def _clear__type_equality_funcs(test):
222
"""Cleanup bound methods stored on TestCase instances
224
Clear the dict breaking a few (mostly) harmless cycles in the affected
225
unittests released with Python 2.6 and initial Python 2.7 versions.
227
For a few revisions between Python 2.7.1 and Python 2.7.2 that annoyingly
228
shipped in Oneiric, an object with no clear method was used, hence the
229
extra complications, see bug 809048 for details.
231
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
232
if type_equality_funcs is not None:
233
tef_clear = getattr(type_equality_funcs, "clear", None)
234
if tef_clear is None:
235
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
236
if tef_instance_dict is not None:
237
tef_clear = tef_instance_dict.clear
238
if tef_clear is not None:
242
class ExtendedTestResult(testtools.TextTestResult):
156
243
"""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.
245
Compared to the unittest version this class adds support for
246
profiling, benchmarking, stopping as soon as a test fails, and
247
skipping tests. There are further-specialized subclasses for
248
different types of display.
250
When a test finishes, in whatever way, it calls one of the addSuccess,
251
addFailure or addError methods. These in turn may redirect to a more
252
specific case for the special test results supported by our extended
255
Note that just one of these objects is fed the results from many tests.
163
258
stop_early = False
165
260
def __init__(self, stream, descriptions, verbosity,
166
261
bench_history=None,
168
use_numbered_dirs=False,
170
264
"""Construct new TestResult.
172
266
:param bench_history: Optionally, a writable file object to accumulate
173
267
benchmark results.
175
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
269
testtools.TextTestResult.__init__(self, stream)
176
270
if bench_history is not None:
177
271
from bzrlib.version import _get_bzr_source_tree
178
272
src_tree = _get_bzr_source_tree()
224
380
def _shortened_test_description(self, test):
226
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
382
what = re.sub(r'^bzrlib\.tests\.', '', what)
385
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
386
# multiple times in a row, because the handler is added for
387
# each test but the container list is shared between cases.
388
# See lp:498869 lp:625574 and lp:637725 for background.
389
def _record_traceback_from_test(self, exc_info):
390
"""Store the traceback from passed exc_info tuple till"""
391
self._traceback_from_test = exc_info[2]
229
393
def startTest(self, test):
230
unittest.TestResult.startTest(self, test)
394
super(ExtendedTestResult, self).startTest(test)
231
398
self.report_test_start(test)
232
399
test.number = self.count
233
400
self._recordTestStartTime()
401
# Make testtools cases give us the real traceback on failure
402
addOnException = getattr(test, "addOnException", None)
403
if addOnException is not None:
404
addOnException(self._record_traceback_from_test)
405
# Only check for thread leaks on bzrlib derived test cases
406
if isinstance(test, TestCase):
407
test.addCleanup(self._check_leaked_threads, test)
409
def stopTest(self, test):
410
super(ExtendedTestResult, self).stopTest(test)
411
# Manually break cycles, means touching various private things but hey
412
getDetails = getattr(test, "getDetails", None)
413
if getDetails is not None:
415
_clear__type_equality_funcs(test)
416
self._traceback_from_test = None
418
def startTests(self):
419
self.report_tests_starting()
420
self._active_threads = threading.enumerate()
422
def _check_leaked_threads(self, test):
423
"""See if any threads have leaked since last call
425
A sample of live threads is stored in the _active_threads attribute,
426
when this method runs it compares the current live threads and any not
427
in the previous sample are treated as having leaked.
429
now_active_threads = set(threading.enumerate())
430
threads_leaked = now_active_threads.difference(self._active_threads)
432
self._report_thread_leak(test, threads_leaked, now_active_threads)
433
self._tests_leaking_threads_count += 1
434
if self._first_thread_leaker_id is None:
435
self._first_thread_leaker_id = test.id()
436
self._active_threads = now_active_threads
235
438
def _recordTestStartTime(self):
236
439
"""Record that a test has started."""
237
self._start_time = time.time()
239
def _cleanupLogFile(self, test):
240
# We can only do this if we have one of our TestCases, not if
242
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
243
if setKeepLogfile is not None:
440
self._start_datetime = self._now()
246
442
def addError(self, test, err):
247
self.extractBenchmarkTime(test)
248
self._cleanupLogFile(test)
249
if isinstance(err[1], TestSkipped):
250
return self.addSkipped(test, err)
251
elif isinstance(err[1], UnavailableFeature):
252
return self.addNotSupported(test, err[1].args[0])
253
unittest.TestResult.addError(self, test, err)
443
"""Tell result that test finished with an error.
445
Called from the TestCase run() method when the test
446
fails with an unexpected error.
448
self._post_mortem(self._traceback_from_test)
449
super(ExtendedTestResult, self).addError(test, err)
254
450
self.error_count += 1
255
451
self.report_error(test, err)
256
452
if self.stop_early:
259
455
def addFailure(self, test, err):
260
self._cleanupLogFile(test)
261
self.extractBenchmarkTime(test)
262
if isinstance(err[1], KnownFailure):
263
return self.addKnownFailure(test, err)
264
unittest.TestResult.addFailure(self, test, err)
456
"""Tell result that test failed.
458
Called from the TestCase run() method when the test
459
fails because e.g. an assert() method failed.
461
self._post_mortem(self._traceback_from_test)
462
super(ExtendedTestResult, self).addFailure(test, err)
265
463
self.failure_count += 1
266
464
self.report_failure(test, err)
267
465
if self.stop_early:
270
def addKnownFailure(self, test, err):
468
def addSuccess(self, test, details=None):
469
"""Tell result that test completed successfully.
471
Called from the TestCase run()
473
if self._bench_history is not None:
474
benchmark_time = self._extractBenchmarkTime(test, details)
475
if benchmark_time is not None:
476
self._bench_history.write("%s %s\n" % (
477
self._formatTime(benchmark_time),
479
self.report_success(test)
480
super(ExtendedTestResult, self).addSuccess(test)
481
test._log_contents = ''
483
def addExpectedFailure(self, test, err):
271
484
self.known_failure_count += 1
272
485
self.report_known_failure(test, err)
487
def addUnexpectedSuccess(self, test, details=None):
488
"""Tell result the test unexpectedly passed, counting as a failure
490
When the minimum version of testtools required becomes 0.9.8 this
491
can be updated to use the new handling there.
493
super(ExtendedTestResult, self).addFailure(test, details=details)
494
self.failure_count += 1
495
self.report_unexpected_success(test,
496
"".join(details["reason"].iter_text()))
274
500
def addNotSupported(self, test, feature):
501
"""The test will not be run because of a missing feature.
503
# this can be called in two different ways: it may be that the
504
# test started running, and then raised (through requireFeature)
505
# UnavailableFeature. Alternatively this method can be called
506
# while probing for features before running the test code proper; in
507
# that case we will see startTest and stopTest, but the test will
508
# never actually run.
275
509
self.unsupported.setdefault(str(feature), 0)
276
510
self.unsupported[str(feature)] += 1
277
511
self.report_unsupported(test, feature)
279
def addSuccess(self, test):
280
self.extractBenchmarkTime(test)
281
if self._bench_history is not None:
282
if self._benchmarkTime is not None:
283
self._bench_history.write("%s %s\n" % (
284
self._formatTime(self._benchmarkTime),
286
self.report_success(test)
287
unittest.TestResult.addSuccess(self, test)
289
def addSkipped(self, test, skip_excinfo):
290
self.report_skip(test, skip_excinfo)
291
# seems best to treat this as success from point-of-view of unittest
292
# -- it actually does nothing so it barely matters :)
295
except KeyboardInterrupt:
298
self.addError(test, test.__exc_info())
300
unittest.TestResult.addSuccess(self, test)
302
def printErrorList(self, flavour, errors):
303
for test, err in errors:
304
self.stream.writeln(self.separator1)
305
self.stream.write("%s: " % flavour)
306
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):
513
def addSkip(self, test, reason):
514
"""A test has not run for 'reason'."""
516
self.report_skip(test, reason)
518
def addNotApplicable(self, test, reason):
519
self.not_applicable_count += 1
520
self.report_not_applicable(test, reason)
522
def _count_stored_tests(self):
523
"""Count of tests instances kept alive due to not succeeding"""
524
return self.error_count + self.failure_count + self.known_failure_count
526
def _post_mortem(self, tb=None):
527
"""Start a PDB post mortem session."""
528
if os.environ.get('BZR_TEST_PDB', None):
532
def progress(self, offset, whence):
533
"""The test is adjusting the count of tests to run."""
534
if whence == SUBUNIT_SEEK_SET:
535
self.num_tests = offset
536
elif whence == SUBUNIT_SEEK_CUR:
537
self.num_tests += offset
539
raise errors.BzrError("Unknown whence %r" % whence)
541
def report_tests_starting(self):
542
"""Display information before the test run begins"""
543
if getattr(sys, 'frozen', None) is None:
544
bzr_path = osutils.realpath(sys.argv[0])
546
bzr_path = sys.executable
548
'bzr selftest: %s\n' % (bzr_path,))
551
bzrlib.__path__[0],))
553
' bzr-%s python-%s %s\n' % (
554
bzrlib.version_string,
555
bzrlib._format_version_tuple(sys.version_info),
556
platform.platform(aliased=1),
558
self.stream.write('\n')
560
def report_test_start(self, test):
561
"""Display information on the test just about to be run"""
563
def _report_thread_leak(self, test, leaked_threads, active_threads):
564
"""Display information on a test that leaked one or more threads"""
565
# GZ 2010-09-09: A leak summary reported separately from the general
566
# thread debugging would be nice. Tests under subunit
567
# need something not using stream, perhaps adding a
568
# testtools details object would be fitting.
569
if 'threads' in selftest_debug_flags:
570
self.stream.write('%s is leaking, active is now %d\n' %
571
(test.id(), len(active_threads)))
573
def startTestRun(self):
574
self.startTime = time.time()
325
576
def report_success(self, test):
579
def wasStrictlySuccessful(self):
580
if self.unsupported or self.known_failure_count:
582
return self.wasSuccessful()
329
585
class TextTestResult(ExtendedTestResult):
330
586
"""Displays progress and results of tests in text form"""
332
588
def __init__(self, stream, descriptions, verbosity,
333
589
bench_history=None,
336
use_numbered_dirs=False,
338
593
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
594
bench_history, strict)
595
# We no longer pass them around, but just rely on the UIFactory stack
598
warnings.warn("Passing pb to TextTestResult is deprecated")
599
self.pb = self.ui.nested_progress_bar()
346
600
self.pb.show_pct = False
347
601
self.pb.show_spinner = False
348
602
self.pb.show_eta = False,
349
603
self.pb.show_count = False
350
604
self.pb.show_bar = False
352
def report_starting(self):
353
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
605
self.pb.update_latency = 0
606
self.pb.show_transport_activity = False
608
def stopTestRun(self):
609
# called when the tests that are going to run have run
612
super(TextTestResult, self).stopTestRun()
614
def report_tests_starting(self):
615
super(TextTestResult, self).report_tests_starting()
616
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
355
618
def _progress_prefix_text(self):
356
a = '[%d' % self.count
357
if self.num_tests is not None:
619
# the longer this text, the less space we have to show the test
621
a = '[%d' % self.count # total that have been run
622
# tests skipped as known not to be relevant are not important enough
624
## if self.skip_count:
625
## a += ', %d skip' % self.skip_count
626
## if self.known_failure_count:
627
## a += '+%dX' % self.known_failure_count
358
629
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)
631
runtime = time.time() - self._overall_start_time
633
a += '%dm%ds' % (runtime / 60, runtime % 60)
636
total_fail_count = self.error_count + self.failure_count
638
a += ', %d failed' % total_fail_count
639
# if self.unsupported:
640
# a += ', %d missing' % len(self.unsupported)
373
644
def report_test_start(self, test):
376
646
self._progress_prefix_text()
378
648
+ self._shortened_test_description(test))
380
650
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)
651
return self._shortened_test_description(test)
387
653
def report_error(self, test, err):
388
self.pb.note('ERROR: %s\n %s\n',
654
self.stream.write('ERROR: %s\n %s\n' % (
389
655
self._test_description(test),
393
659
def report_failure(self, test, err):
394
self.pb.note('FAIL: %s\n %s\n',
660
self.stream.write('FAIL: %s\n %s\n' % (
395
661
self._test_description(test),
399
665
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])
668
def report_unexpected_success(self, test, reason):
669
self.stream.write('FAIL: %s\n %s: %s\n' % (
670
self._test_description(test),
671
"Unexpected success. Should have failed",
675
def report_skip(self, test, reason):
678
def report_not_applicable(self, test, reason):
419
681
def report_unsupported(self, test, feature):
420
682
"""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
685
class VerboseTestResult(ExtendedTestResult):
723
976
retrieved by _get_log(). We use a real OS file, not an in-memory object,
724
977
so that it can also capture file IO. When the test completes this file
725
978
is read into memory and removed from disk.
727
980
There are also convenience functions to invoke bzr's command-line
728
981
routine, and to build and check bzr trees.
730
983
In addition to the usual method of overriding tearDown(), this class also
731
allows subclasses to register functions into the _cleanups list, which is
984
allows subclasses to register cleanup functions via addCleanup, which are
732
985
run in order as the object is torn down. It's less likely this will be
733
986
accidentally overlooked.
736
_log_file_name = None
738
_keep_log_file = False
739
990
# record lsprof data when performing benchmark calls.
740
991
_gather_lsprof_in_benchmarks = False
742
993
def __init__(self, methodName='testMethod'):
743
994
super(TestCase, self).__init__(methodName)
995
self._directory_isolation = True
996
self.exception_handlers.insert(0,
997
(UnavailableFeature, self._do_unsupported_or_skip))
998
self.exception_handlers.insert(0,
999
(TestNotApplicable, self._do_not_applicable))
746
1001
def setUp(self):
747
unittest.TestCase.setUp(self)
1002
super(TestCase, self).setUp()
1004
timeout = config.GlobalStack().get('selftest.timeout')
1006
timeout_fixture = fixtures.TimeoutFixture(timeout)
1007
timeout_fixture.setUp()
1008
self.addCleanup(timeout_fixture.cleanUp)
1010
for feature in getattr(self, '_test_needs_features', []):
1011
self.requireFeature(feature)
748
1012
self._cleanEnvironment()
749
bzrlib.trace.disable_default_logging()
1014
if bzrlib.global_state is not None:
1015
self.overrideAttr(bzrlib.global_state, 'cmdline_overrides',
1016
config.CommandLineStore())
750
1018
self._silenceUI()
751
1019
self._startLogFile()
752
1020
self._benchcalls = []
753
1021
self._benchtime = None
754
1022
self._clear_hooks()
1023
self._track_transports()
755
1025
self._clear_debug_flags()
1026
# Isolate global verbosity level, to make sure it's reproducible
1027
# between tests. We should get rid of this altogether: bug 656694. --
1029
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
1030
self._log_files = set()
1031
# Each key in the ``_counters`` dict holds a value for a different
1032
# counter. When the test ends, addDetail() should be used to output the
1033
# counter values. This happens in install_counter_hook().
1035
if 'config_stats' in selftest_debug_flags:
1036
self._install_config_stats_hooks()
1037
# Do not use i18n for tests (unless the test reverses this)
1043
# The sys preserved stdin/stdout should allow blackbox tests debugging
1044
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
1045
).set_trace(sys._getframe().f_back)
1047
def discardDetail(self, name):
1048
"""Extend the addDetail, getDetails api so we can remove a detail.
1050
eg. bzr always adds the 'log' detail at startup, but we don't want to
1051
include it for skipped, xfail, etc tests.
1053
It is safe to call this for a detail that doesn't exist, in case this
1054
gets called multiple times.
1056
# We cheat. details is stored in __details which means we shouldn't
1057
# touch it. but getDetails() returns the dict directly, so we can
1059
details = self.getDetails()
1063
def install_counter_hook(self, hooks, name, counter_name=None):
1064
"""Install a counting hook.
1066
Any hook can be counted as long as it doesn't need to return a value.
1068
:param hooks: Where the hook should be installed.
1070
:param name: The hook name that will be counted.
1072
:param counter_name: The counter identifier in ``_counters``, defaults
1075
_counters = self._counters # Avoid closing over self
1076
if counter_name is None:
1078
if _counters.has_key(counter_name):
1079
raise AssertionError('%s is already used as a counter name'
1081
_counters[counter_name] = 0
1082
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1083
lambda: ['%d' % (_counters[counter_name],)]))
1084
def increment_counter(*args, **kwargs):
1085
_counters[counter_name] += 1
1086
label = 'count %s calls' % (counter_name,)
1087
hooks.install_named_hook(name, increment_counter, label)
1088
self.addCleanup(hooks.uninstall_named_hook, name, label)
1090
def _install_config_stats_hooks(self):
1091
"""Install config hooks to count hook calls.
1094
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1095
self.install_counter_hook(config.ConfigHooks, hook_name,
1096
'config.%s' % (hook_name,))
1098
# The OldConfigHooks are private and need special handling to protect
1099
# against recursive tests (tests that run other tests), so we just do
1100
# manually what registering them into _builtin_known_hooks will provide
1102
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1103
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1104
self.install_counter_hook(config.OldConfigHooks, hook_name,
1105
'old_config.%s' % (hook_name,))
757
1107
def _clear_debug_flags(self):
758
1108
"""Prevent externally set debug flags affecting tests.
760
1110
Tests that want to use debug flags can just set them in the
761
1111
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)
1113
# Start with a copy of the current debug flags we can safely modify.
1114
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1115
if 'allow_debug' not in selftest_debug_flags:
1116
debug.debug_flags.clear()
1117
if 'disable_lock_checks' not in selftest_debug_flags:
1118
debug.debug_flags.add('strict_locks')
767
1120
def _clear_hooks(self):
768
1121
# 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,
1122
known_hooks = hooks.known_hooks
1123
self._preserved_hooks = {}
1124
for key, (parent, name) in known_hooks.iter_parent_objects():
1125
current_hooks = getattr(parent, name)
1126
self._preserved_hooks[parent] = (name, current_hooks)
1127
self._preserved_lazy_hooks = hooks._lazy_hooks
1128
hooks._lazy_hooks = {}
775
1129
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()
1130
for key, (parent, name) in known_hooks.iter_parent_objects():
1131
factory = known_hooks.get(key)
1132
setattr(parent, name, factory())
1133
# this hook should always be installed
1134
request._install_hook()
1136
def disable_directory_isolation(self):
1137
"""Turn off directory isolation checks."""
1138
self._directory_isolation = False
1140
def enable_directory_isolation(self):
1141
"""Enable directory isolation checks."""
1142
self._directory_isolation = True
780
1144
def _silenceUI(self):
781
1145
"""Turn off UI for duration of test"""
782
1146
# 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)
1147
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1149
def _check_locks(self):
1150
"""Check that all lock take/release actions have been paired."""
1151
# We always check for mismatched locks. If a mismatch is found, we
1152
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1153
# case we just print a warning.
1155
acquired_locks = [lock for action, lock in self._lock_actions
1156
if action == 'acquired']
1157
released_locks = [lock for action, lock in self._lock_actions
1158
if action == 'released']
1159
broken_locks = [lock for action, lock in self._lock_actions
1160
if action == 'broken']
1161
# trivially, given the tests for lock acquistion and release, if we
1162
# have as many in each list, it should be ok. Some lock tests also
1163
# break some locks on purpose and should be taken into account by
1164
# considering that breaking a lock is just a dirty way of releasing it.
1165
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1167
'Different number of acquired and '
1168
'released or broken locks.\n'
1172
(acquired_locks, released_locks, broken_locks))
1173
if not self._lock_check_thorough:
1174
# Rather than fail, just warn
1175
print "Broken test %s: %s" % (self, message)
1179
def _track_locks(self):
1180
"""Track lock activity during tests."""
1181
self._lock_actions = []
1182
if 'disable_lock_checks' in selftest_debug_flags:
1183
self._lock_check_thorough = False
1185
self._lock_check_thorough = True
1187
self.addCleanup(self._check_locks)
1188
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1189
self._lock_acquired, None)
1190
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1191
self._lock_released, None)
1192
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1193
self._lock_broken, None)
1195
def _lock_acquired(self, result):
1196
self._lock_actions.append(('acquired', result))
1198
def _lock_released(self, result):
1199
self._lock_actions.append(('released', result))
1201
def _lock_broken(self, result):
1202
self._lock_actions.append(('broken', result))
1204
def permit_dir(self, name):
1205
"""Permit a directory to be used by this test. See permit_url."""
1206
name_transport = _mod_transport.get_transport_from_path(name)
1207
self.permit_url(name)
1208
self.permit_url(name_transport.base)
1210
def permit_url(self, url):
1211
"""Declare that url is an ok url to use in this test.
1213
Do this for memory transports, temporary test directory etc.
1215
Do not do this for the current working directory, /tmp, or any other
1216
preexisting non isolated url.
1218
if not url.endswith('/'):
1220
self._bzr_selftest_roots.append(url)
1222
def permit_source_tree_branch_repo(self):
1223
"""Permit the source tree bzr is running from to be opened.
1225
Some code such as bzrlib.version attempts to read from the bzr branch
1226
that bzr is executing from (if any). This method permits that directory
1227
to be used in the test suite.
1229
path = self.get_source_path()
1230
self.record_directory_isolation()
1233
workingtree.WorkingTree.open(path)
1234
except (errors.NotBranchError, errors.NoWorkingTree):
1235
raise TestSkipped('Needs a working tree of bzr sources')
1237
self.enable_directory_isolation()
1239
def _preopen_isolate_transport(self, transport):
1240
"""Check that all transport openings are done in the test work area."""
1241
while isinstance(transport, pathfilter.PathFilteringTransport):
1242
# Unwrap pathfiltered transports
1243
transport = transport.server.backing_transport.clone(
1244
transport._filter('.'))
1245
url = transport.base
1246
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1247
# urls it is given by prepending readonly+. This is appropriate as the
1248
# client shouldn't know that the server is readonly (or not readonly).
1249
# We could register all servers twice, with readonly+ prepending, but
1250
# that makes for a long list; this is about the same but easier to
1252
if url.startswith('readonly+'):
1253
url = url[len('readonly+'):]
1254
self._preopen_isolate_url(url)
1256
def _preopen_isolate_url(self, url):
1257
if not self._directory_isolation:
1259
if self._directory_isolation == 'record':
1260
self._bzr_selftest_roots.append(url)
1262
# This prevents all transports, including e.g. sftp ones backed on disk
1263
# from working unless they are explicitly granted permission. We then
1264
# depend on the code that sets up test transports to check that they are
1265
# appropriately isolated and enable their use by calling
1266
# self.permit_transport()
1267
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1268
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1269
% (url, self._bzr_selftest_roots))
1271
def record_directory_isolation(self):
1272
"""Gather accessed directories to permit later access.
1274
This is used for tests that access the branch bzr is running from.
1276
self._directory_isolation = "record"
1278
def start_server(self, transport_server, backing_server=None):
1279
"""Start transport_server for this test.
1281
This starts the server, registers a cleanup for it and permits the
1282
server's urls to be used.
1284
if backing_server is None:
1285
transport_server.start_server()
1287
transport_server.start_server(backing_server)
1288
self.addCleanup(transport_server.stop_server)
1289
# Obtain a real transport because if the server supplies a password, it
1290
# will be hidden from the base on the client side.
1291
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1292
# Some transport servers effectively chroot the backing transport;
1293
# others like SFTPServer don't - users of the transport can walk up the
1294
# transport to read the entire backing transport. This wouldn't matter
1295
# except that the workdir tests are given - and that they expect the
1296
# server's url to point at - is one directory under the safety net. So
1297
# Branch operations into the transport will attempt to walk up one
1298
# directory. Chrooting all servers would avoid this but also mean that
1299
# we wouldn't be testing directly against non-root urls. Alternatively
1300
# getting the test framework to start the server with a backing server
1301
# at the actual safety net directory would work too, but this then
1302
# means that the self.get_url/self.get_transport methods would need
1303
# to transform all their results. On balance its cleaner to handle it
1304
# here, and permit a higher url when we have one of these transports.
1305
if t.base.endswith('/work/'):
1306
# we have safety net/test root/work
1307
t = t.clone('../..')
1308
elif isinstance(transport_server,
1309
test_server.SmartTCPServer_for_testing):
1310
# The smart server adds a path similar to work, which is traversed
1311
# up from by the client. But the server is chrooted - the actual
1312
# backing transport is not escaped from, and VFS requests to the
1313
# root will error (because they try to escape the chroot).
1315
while t2.base != t.base:
1318
self.permit_url(t.base)
1320
def _track_transports(self):
1321
"""Install checks for transport usage."""
1322
# TestCase has no safe place it can write to.
1323
self._bzr_selftest_roots = []
1324
# Currently the easiest way to be sure that nothing is going on is to
1325
# hook into bzr dir opening. This leaves a small window of error for
1326
# transport tests, but they are well known, and we can improve on this
1328
controldir.ControlDir.hooks.install_named_hook("pre_open",
1329
self._preopen_isolate_transport, "Check bzr directories are safe.")
789
1331
def _ndiff_strings(self, a, b):
790
1332
"""Return ndiff between two strings containing lines.
792
1334
A trailing newline is added if missing to make the strings
793
1335
print properly."""
794
1336
if b and b[-1] != '\n':
1024
1675
self.assertEqual(expected_first_warning, call_warnings[0])
1678
def callCatchWarnings(self, fn, *args, **kw):
1679
"""Call a callable that raises python warnings.
1681
The caller's responsible for examining the returned warnings.
1683
If the callable raises an exception, the exception is not
1684
caught and propagates up to the caller. In that case, the list
1685
of warnings is not available.
1687
:returns: ([warning_object, ...], fn_result)
1689
# XXX: This is not perfect, because it completely overrides the
1690
# warnings filters, and some code may depend on suppressing particular
1691
# warnings. It's the easiest way to insulate ourselves from -Werror,
1692
# though. -- Andrew, 20071062
1694
def _catcher(message, category, filename, lineno, file=None, line=None):
1695
# despite the name, 'message' is normally(?) a Warning subclass
1697
wlist.append(message)
1698
saved_showwarning = warnings.showwarning
1699
saved_filters = warnings.filters
1701
warnings.showwarning = _catcher
1702
warnings.filters = []
1703
result = fn(*args, **kw)
1705
warnings.showwarning = saved_showwarning
1706
warnings.filters = saved_filters
1707
return wlist, result
1027
1709
def callDeprecated(self, expected, callable, *args, **kwargs):
1028
1710
"""Assert that a callable is deprecated in a particular way.
1030
This is a very precise test for unusual requirements. The
1712
This is a very precise test for unusual requirements. The
1031
1713
applyDeprecated helper function is probably more suited for most tests
1032
1714
as it allows you to simply specify the deprecation format being used
1033
1715
and will ensure that that is issued for the function being called.
1035
1717
Note that this only captures warnings raised by symbol_versioning.warn,
1036
not other callers that go direct to the warning module.
1718
not other callers that go direct to the warning module. To catch
1719
general warnings, use callCatchWarnings.
1038
1721
:param expected: a list of the deprecation warnings expected, in order
1039
1722
:param callable: The callable to call
1040
1723
:param args: The positional arguments for the callable
1041
1724
:param kwargs: The keyword arguments for the callable
1043
call_warnings, result = self._capture_warnings(callable,
1726
call_warnings, result = self._capture_deprecation_warnings(callable,
1044
1727
*args, **kwargs)
1045
1728
self.assertEqual(expected, call_warnings)
1048
1731
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
1732
"""Setup a in-memory target for bzr and testcase log messages"""
1733
pseudo_log_file = StringIO()
1734
def _get_log_contents_for_weird_testtools_api():
1735
return [pseudo_log_file.getvalue().decode(
1736
"utf-8", "replace").encode("utf-8")]
1737
self.addDetail("log", content.Content(content.ContentType("text",
1738
"plain", {"charset": "utf8"}),
1739
_get_log_contents_for_weird_testtools_api))
1740
self._log_file = pseudo_log_file
1741
self._log_memento = trace.push_log_file(self._log_file)
1057
1742
self.addCleanup(self._finishLogFile)
1059
1744
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)
1745
"""Flush and dereference the in-memory log for this testcase"""
1746
if trace._trace_file:
1747
# flush the log file, to get all content
1748
trace._trace_file.flush()
1749
trace.pop_log_file(self._log_memento)
1750
# The logging module now tracks references for cleanup so discard ours
1751
del self._log_memento
1753
def thisFailsStrictLockCheck(self):
1754
"""It is known that this test would fail with -Dstrict_locks.
1756
By default, all tests are run with strict lock checking unless
1757
-Edisable_lock_checks is supplied. However there are some tests which
1758
we know fail strict locks at this point that have not been fixed.
1759
They should call this function to disable the strict checking.
1761
This should be used sparingly, it is much better to fix the locking
1762
issues rather than papering over the problem by calling this function.
1764
debug.debug_flags.discard('strict_locks')
1766
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1767
"""Overrides an object attribute restoring it after the test.
1769
:note: This should be used with discretion; you should think about
1770
whether it's better to make the code testable without monkey-patching.
1772
:param obj: The object that will be mutated.
1774
:param attr_name: The attribute name we want to preserve/override in
1777
:param new: The optional value we want to set the attribute to.
1779
:returns: The actual attr value.
1781
value = getattr(obj, attr_name)
1782
# The actual value is captured by the call below
1783
self.addCleanup(setattr, obj, attr_name, value)
1784
if new is not _unitialized_attr:
1785
setattr(obj, attr_name, new)
1788
def overrideEnv(self, name, new):
1789
"""Set an environment variable, and reset it after the test.
1791
:param name: The environment variable name.
1793
:param new: The value to set the variable to. If None, the
1794
variable is deleted from the environment.
1796
:returns: The actual variable value.
1798
value = osutils.set_or_unset_env(name, new)
1799
self.addCleanup(osutils.set_or_unset_env, name, value)
1802
def recordCalls(self, obj, attr_name):
1803
"""Monkeypatch in a wrapper that will record calls.
1805
The monkeypatch is automatically removed when the test concludes.
1807
:param obj: The namespace holding the reference to be replaced;
1808
typically a module, class, or object.
1809
:param attr_name: A string for the name of the attribute to
1811
:returns: A list that will be extended with one item every time the
1812
function is called, with a tuple of (args, kwargs).
1816
def decorator(*args, **kwargs):
1817
calls.append((args, kwargs))
1818
return orig(*args, **kwargs)
1819
orig = self.overrideAttr(obj, attr_name, decorator)
1088
1822
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)
1823
for name, value in isolated_environ.iteritems():
1824
self.overrideEnv(name, value)
1130
1826
def _restoreHooks(self):
1131
for klass, hooks in self._preserved_hooks.items():
1132
setattr(klass, 'hooks', hooks)
1827
for klass, (name, hooks) in self._preserved_hooks.items():
1828
setattr(klass, name, hooks)
1829
self._preserved_hooks.clear()
1830
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1831
self._preserved_lazy_hooks.clear()
1134
1833
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)
1834
"""Declare that this test fails for a known reason
1836
Tests that are known to fail should generally be using expectedFailure
1837
with an appropriate reverse assertion if a change could cause the test
1838
to start passing. Conversely if the test has no immediate prospect of
1839
succeeding then using skip is more suitable.
1841
When this method is called while an exception is being handled, that
1842
traceback will be used, otherwise a new exception will be thrown to
1843
provide one but won't be reported.
1845
self._add_reason(reason)
1847
exc_info = sys.exc_info()
1848
if exc_info != (None, None, None):
1849
self._report_traceback(exc_info)
1852
raise self.failureException(reason)
1853
except self.failureException:
1854
exc_info = sys.exc_info()
1855
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1856
raise testtools.testcase._ExpectedFailure(exc_info)
1860
def _suppress_log(self):
1861
"""Remove the log info from details."""
1862
self.discardDetail('log')
1864
def _do_skip(self, result, reason):
1865
self._suppress_log()
1866
addSkip = getattr(result, 'addSkip', None)
1867
if not callable(addSkip):
1868
result.addSuccess(result)
1870
addSkip(self, reason)
1873
def _do_known_failure(self, result, e):
1874
self._suppress_log()
1875
err = sys.exc_info()
1876
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1877
if addExpectedFailure is not None:
1878
addExpectedFailure(self, err)
1880
result.addSuccess(self)
1883
def _do_not_applicable(self, result, e):
1885
reason = 'No reason given'
1888
self._suppress_log ()
1889
addNotApplicable = getattr(result, 'addNotApplicable', None)
1890
if addNotApplicable is not None:
1891
result.addNotApplicable(self, reason)
1893
self._do_skip(result, reason)
1896
def _report_skip(self, result, err):
1897
"""Override the default _report_skip.
1899
We want to strip the 'log' detail. If we waint until _do_skip, it has
1900
already been formatted into the 'reason' string, and we can't pull it
1903
self._suppress_log()
1904
super(TestCase, self)._report_skip(self, result, err)
1907
def _report_expected_failure(self, result, err):
1910
See _report_skip for motivation.
1912
self._suppress_log()
1913
super(TestCase, self)._report_expected_failure(self, result, err)
1916
def _do_unsupported_or_skip(self, result, e):
1918
self._suppress_log()
1919
addNotSupported = getattr(result, 'addNotSupported', None)
1920
if addNotSupported is not None:
1921
result.addNotSupported(self, reason)
1923
self._do_skip(result, reason)
1155
1925
def time(self, callable, *args, **kwargs):
1156
1926
"""Run callable and accrue the time it takes to the benchmark time.
1158
1928
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1159
1929
this will cause lsprofile statistics to be gathered and stored in
1160
1930
self._benchcalls.
1162
1932
if self._benchtime is None:
1933
self.addDetail('benchtime', content.Content(content.ContentType(
1934
"text", "plain"), lambda:[str(self._benchtime)]))
1163
1935
self._benchtime = 0
1164
1936
start = time.time()
1782
2588
base = self.get_vfs_only_server().get_url()
1783
2589
return self._adjust_url(base, relpath)
2591
def _create_safety_net(self):
2592
"""Make a fake bzr directory.
2594
This prevents any tests propagating up onto the TEST_ROOT directory's
2597
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 = controldir.ControlDir.create_standalone_workingtree(root)
2605
del os.environ['BZR_HOME']
2606
except Exception, e:
2607
self.fail("Fail to initialize the safety net: %r\n" % (e,))
2608
# Hack for speed: remember the raw bytes of the dirstate file so that
2609
# we don't need to re-open the wt to check it hasn't changed.
2610
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
2611
wt.control_transport.get_bytes('dirstate'))
2613
def _check_safety_net(self):
2614
"""Check that the safety .bzr directory have not been touched.
2616
_make_test_root have created a .bzr directory to prevent tests from
2617
propagating. This method ensures than a test did not leaked.
2619
root = TestCaseWithMemoryTransport.TEST_ROOT
2620
t = _mod_transport.get_transport_from_path(root)
2621
self.permit_url(t.base)
2622
if (t.get_bytes('.bzr/checkout/dirstate') !=
2623
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
2624
# The current test have modified the /bzr directory, we need to
2625
# recreate a new one or all the followng tests will fail.
2626
# If you need to inspect its content uncomment the following line
2627
# import pdb; pdb.set_trace()
2628
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2629
self._create_safety_net()
2630
raise AssertionError('%s/.bzr should not be modified' % root)
1785
2632
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)
2633
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2634
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2635
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2637
TestCaseWithMemoryTransport.TEST_ROOT = root
2639
self._create_safety_net()
2641
# The same directory is used by all tests, and we're not
2642
# specifically told when all tests are finished. This will do.
2643
atexit.register(_rmtree_temp_dir, root)
2645
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2646
self.addCleanup(self._check_safety_net)
1799
2648
def makeAndChdirToTestDir(self):
1800
2649
"""Create a temporary directories for this one test.
1802
2651
This must set self.test_home_dir and self.test_dir and chdir to
1805
2654
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1807
2656
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1808
2657
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1809
2658
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1811
def make_branch(self, relpath, format=None):
2659
self.permit_dir(self.test_dir)
2661
def make_branch(self, relpath, format=None, name=None):
1812
2662
"""Create a branch on the transport at relpath."""
1813
2663
repo = self.make_repository(relpath, format=format)
1814
return repo.bzrdir.create_branch()
2664
return repo.bzrdir.create_branch(append_revisions_only=False,
2667
def get_default_format(self):
2670
def resolve_format(self, format):
2671
"""Resolve an object to a ControlDir format object.
2673
The initial format object can either already be
2674
a ControlDirFormat, None (for the default format),
2675
or a string with the name of the control dir format.
2677
:param format: Object to resolve
2678
:return A ControlDirFormat instance
2681
format = self.get_default_format()
2682
if isinstance(format, basestring):
2683
format = controldir.format_registry.make_bzrdir(format)
1816
2686
def make_bzrdir(self, relpath, format=None):
1818
2688
# might be a relative or absolute path
1819
2689
maybe_a_url = self.get_url(relpath)
1820
2690
segments = maybe_a_url.rsplit('/', 1)
1821
t = get_transport(maybe_a_url)
2691
t = _mod_transport.get_transport(maybe_a_url)
1822
2692
if len(segments) > 1 and segments[-1] not in ('', '.'):
1823
2693
t.ensure_base()
1826
if isinstance(format, basestring):
1827
format = bzrdir.format_registry.make_bzrdir(format)
2694
format = self.resolve_format(format)
1828
2695
return format.initialize_on_transport(t)
1829
2696
except errors.UninitializableFormat:
1830
2697
raise TestSkipped("Format %s is not initializable." % format)
1832
def make_repository(self, relpath, shared=False, format=None):
2699
def make_repository(self, relpath, shared=None, format=None):
1833
2700
"""Create a repository on our default transport at relpath.
1835
2702
Note that relpath must be a relative path, not a full url.
1837
2704
# FIXME: If you create a remoterepository this returns the underlying
1838
# real format, which is incorrect. Actually we should make sure that
2705
# real format, which is incorrect. Actually we should make sure that
1839
2706
# RemoteBzrDir returns a RemoteRepository.
1840
2707
# maybe mbp 20070410
1841
2708
made_control = self.make_bzrdir(relpath, format=format)
1842
2709
return made_control.create_repository(shared=shared)
2711
def make_smart_server(self, path, backing_server=None):
2712
if backing_server is None:
2713
backing_server = self.get_server()
2714
smart_server = test_server.SmartTCPServer_for_testing()
2715
self.start_server(smart_server, backing_server)
2716
remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
2718
return remote_transport
1844
2720
def make_branch_and_memory_tree(self, relpath, format=None):
1845
2721
"""Create a branch on the default transport and a MemoryTree for it."""
1846
2722
b = self.make_branch(relpath, format=format)
1847
2723
return memorytree.MemoryTree.create_on_branch(b)
2725
def make_branch_builder(self, relpath, format=None):
2726
branch = self.make_branch(relpath, format=format)
2727
return branchbuilder.BranchBuilder(branch=branch)
1849
2729
def overrideEnvironmentForTesting(self):
1850
os.environ['HOME'] = self.test_home_dir
1851
os.environ['BZR_HOME'] = self.test_home_dir
2730
test_home_dir = self.test_home_dir
2731
if isinstance(test_home_dir, unicode):
2732
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2733
self.overrideEnv('HOME', test_home_dir)
2734
self.overrideEnv('BZR_HOME', test_home_dir)
1853
2736
def setUp(self):
1854
2737
super(TestCaseWithMemoryTransport, self).setUp()
2739
def _add_disconnect_cleanup(transport):
2740
"""Schedule disconnection of given transport at test cleanup
2742
This needs to happen for all connected transports or leaks occur.
2744
Note reconnections may mean we call disconnect multiple times per
2745
transport which is suboptimal but seems harmless.
2747
self.addCleanup(transport.disconnect)
2749
_mod_transport.Transport.hooks.install_named_hook('post_connect',
2750
_add_disconnect_cleanup, None)
1855
2752
self._make_test_root()
1856
_currentdir = os.getcwdu()
1857
def _leaveDirectory():
1858
os.chdir(_currentdir)
1859
self.addCleanup(_leaveDirectory)
2753
self.addCleanup(os.chdir, os.getcwdu())
1860
2754
self.makeAndChdirToTestDir()
1861
2755
self.overrideEnvironmentForTesting()
1862
2756
self.__readonly_server = None
1863
2757
self.__server = None
1864
2758
self.reduceLockdirTimeout()
2760
def setup_smart_server_with_call_log(self):
2761
"""Sets up a smart server as the transport server with a call log."""
2762
self.transport_server = test_server.SmartTCPServer_for_testing
2763
self.hpss_connections = []
2764
self.hpss_calls = []
2766
# Skip the current stack down to the caller of
2767
# setup_smart_server_with_call_log
2768
prefix_length = len(traceback.extract_stack()) - 2
2769
def capture_hpss_call(params):
2770
self.hpss_calls.append(
2771
CapturedCall(params, prefix_length))
2772
def capture_connect(transport):
2773
self.hpss_connections.append(transport)
2774
client._SmartClient.hooks.install_named_hook(
2775
'call', capture_hpss_call, None)
2776
_mod_transport.Transport.hooks.install_named_hook(
2777
'post_connect', capture_connect, None)
2779
def reset_smart_call_log(self):
2780
self.hpss_calls = []
2781
self.hpss_connections = []
1867
2784
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1868
2785
"""Derived class that runs a test within a temporary directory.
2103
3058
for readonly urls.
2105
3060
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2106
be used without needed to redo it when a different
3061
be used without needed to redo it when a different
2107
3062
subclass is in use ?
2110
3065
def setUp(self):
3066
from bzrlib.tests import http_server
2111
3067
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.
3068
if not self.vfs_transport_factory == memory.MemoryServer:
3069
self.transport_readonly_server = http_server.HttpServer
3072
def condition_id_re(pattern):
3073
"""Create a condition filter which performs a re check on a test's id.
3075
:param pattern: A regular expression string.
3076
:return: A callable that returns True if the re matches.
3078
filter_re = re.compile(pattern, 0)
3079
def condition(test):
3081
return filter_re.search(test_id)
3085
def condition_isinstance(klass_or_klass_list):
3086
"""Create a condition filter which returns isinstance(param, klass).
3088
:return: A callable which when called with one parameter obj return the
3089
result of isinstance(obj, klass_or_klass_list).
3092
return isinstance(obj, klass_or_klass_list)
3096
def condition_id_in_list(id_list):
3097
"""Create a condition filter which verify that test's id in a list.
3099
:param id_list: A TestIdList object.
3100
:return: A callable that returns True if the test's id appears in the list.
3102
def condition(test):
3103
return id_list.includes(test.id())
3107
def condition_id_startswith(starts):
3108
"""Create a condition filter verifying that test's id starts with a string.
3110
:param starts: A list of string.
3111
:return: A callable that returns True if the test's id starts with one of
3114
def condition(test):
3115
for start in starts:
3116
if test.id().startswith(start):
3122
def exclude_tests_by_condition(suite, condition):
3123
"""Create a test suite which excludes some tests from suite.
3125
:param suite: The suite to get tests from.
3126
:param condition: A callable whose result evaluates True when called with a
3127
test case which should be excluded from the result.
3128
:return: A suite which contains the tests found in suite that fail
3132
for test in iter_suite_tests(suite):
3133
if not condition(test):
3135
return TestUtil.TestSuite(result)
3138
def filter_suite_by_condition(suite, condition):
3139
"""Create a test suite by filtering another one.
3141
:param suite: The source suite.
3142
:param condition: A callable whose result evaluates True when called with a
3143
test case which should be included in the result.
3144
:return: A suite which contains the tests found in suite that pass
3148
for test in iter_suite_tests(suite):
3151
return TestUtil.TestSuite(result)
3154
def filter_suite_by_re(suite, pattern):
3155
"""Create a test suite by filtering another one.
2120
3157
:param suite: the source suite
2121
3158
: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)
3159
:returns: the newly created suite
3161
condition = condition_id_re(pattern)
3162
result_suite = filter_suite_by_condition(suite, condition)
3166
def filter_suite_by_id_list(suite, test_id_list):
3167
"""Create a test suite by filtering another one.
3169
:param suite: The source suite.
3170
:param test_id_list: A list of the test ids to keep as strings.
3171
:returns: the newly created suite
3173
condition = condition_id_in_list(test_id_list)
3174
result_suite = filter_suite_by_condition(suite, condition)
3178
def filter_suite_by_id_startswith(suite, start):
3179
"""Create a test suite by filtering another one.
3181
:param suite: The source suite.
3182
:param start: A list of string the test id must start with one of.
3183
:returns: the newly created suite
3185
condition = condition_id_startswith(start)
3186
result_suite = filter_suite_by_condition(suite, condition)
3190
def exclude_tests_by_re(suite, pattern):
3191
"""Create a test suite which excludes some tests from suite.
3193
:param suite: The suite to get tests from.
3194
:param pattern: A regular expression string. Test ids that match this
3195
pattern will be excluded from the result.
3196
:return: A TestSuite that contains all the tests from suite without the
3197
tests that matched pattern. The order of tests is the same as it was in
3200
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3203
def preserve_input(something):
3204
"""A helper for performing test suite transformation chains.
3206
:param something: Anything you want to preserve.
3212
def randomize_suite(suite):
3213
"""Return a new TestSuite with suite's tests in random order.
3215
The tests in the input suite are flattened into a single suite in order to
3216
accomplish this. Any nested TestSuites are removed to provide global
3219
tests = list(iter_suite_tests(suite))
3220
random.shuffle(tests)
3221
return TestUtil.TestSuite(tests)
3224
def split_suite_by_condition(suite, condition):
3225
"""Split a test suite into two by a condition.
3227
:param suite: The suite to split.
3228
:param condition: The condition to match on. Tests that match this
3229
condition are returned in the first test suite, ones that do not match
3230
are in the second suite.
3231
:return: A tuple of two test suites, where the first contains tests from
3232
suite matching the condition, and the second contains the remainder
3233
from suite. The order within each output suite is the same as it was in
2150
3238
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)
3240
matched.append(test)
3242
did_not_match.append(test)
3243
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3246
def split_suite_by_re(suite, pattern):
3247
"""Split a test suite into two by a regular expression.
3249
:param suite: The suite to split.
3250
:param pattern: A regular expression string. Test ids that match this
3251
pattern will be in the first test suite returned, and the others in the
3252
second test suite returned.
3253
:return: A tuple of two test suites, where the first contains tests from
3254
suite matching pattern, and the second contains the remainder from
3255
suite. The order within each output suite is the same as it was in
3258
return split_suite_by_condition(suite, condition_id_re(pattern))
2163
3261
def run_suite(suite, name='test', verbose=False, pattern=".*",
2164
3262
stop_on_failure=False,
2165
3263
transport=None, lsprof_timed=None, bench_history=None,
2166
3264
matching_tests_first=None,
2168
3265
list_only=False,
2169
3266
random_seed=None,
2170
3267
exclude_pattern=None,
3270
suite_decorators=None,
3272
result_decorators=None,
2172
use_numbered_dirs = bool(numbered_dirs)
3274
"""Run a test suite for bzr selftest.
3276
:param runner_class: The class of runner to use. Must support the
3277
constructor arguments passed by run_suite which are more than standard
3279
:return: A boolean indicating success.
2174
3281
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,
3286
if runner_class is None:
3287
runner_class = TextTestRunner
3290
runner = runner_class(stream=stream,
2182
3291
descriptions=0,
2183
3292
verbosity=verbosity,
2184
3293
bench_history=bench_history,
2185
use_numbered_dirs=use_numbered_dirs,
2186
list_only=list_only,
3295
result_decorators=result_decorators,
2188
3297
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())
3298
if isinstance(suite, unittest.TestSuite):
3299
# Empty out _tests list of passed suite and populate new TestSuite
3300
suite._tests[:], suite = [], TestSuite(suite)
3301
# built in decorator factories:
3303
random_order(random_seed, runner),
3304
exclude_tests(exclude_pattern),
3306
if matching_tests_first:
3307
decorators.append(tests_first(pattern))
3309
decorators.append(filter_tests(pattern))
3310
if suite_decorators:
3311
decorators.extend(suite_decorators)
3312
# tell the result object how many tests will be running: (except if
3313
# --parallel=fork is being used. Robert said he will provide a better
3314
# progress design later -- vila 20090817)
3315
if fork_decorator not in decorators:
3316
decorators.append(CountingDecorator)
3317
for decorator in decorators:
3318
suite = decorator(suite)
3320
# Done after test suite decoration to allow randomisation etc
3321
# to take effect, though that is of marginal benefit.
3323
stream.write("Listing tests only ...\n")
3324
for t in iter_suite_tests(suite):
3325
stream.write("%s\n" % (t.id()))
3327
result = runner.run(suite)
3329
return result.wasStrictlySuccessful()
3331
return result.wasSuccessful()
3334
# A registry where get() returns a suite decorator.
3335
parallel_registry = registry.Registry()
3338
def fork_decorator(suite):
3339
if getattr(os, "fork", None) is None:
3340
raise errors.BzrCommandError("platform does not support fork,"
3341
" try --parallel=subprocess instead.")
3342
concurrency = osutils.local_concurrency()
3343
if concurrency == 1:
3345
from testtools import ConcurrentTestSuite
3346
return ConcurrentTestSuite(suite, fork_for_tests)
3347
parallel_registry.register('fork', fork_decorator)
3350
def subprocess_decorator(suite):
3351
concurrency = osutils.local_concurrency()
3352
if concurrency == 1:
3354
from testtools import ConcurrentTestSuite
3355
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3356
parallel_registry.register('subprocess', subprocess_decorator)
3359
def exclude_tests(exclude_pattern):
3360
"""Return a test suite decorator that excludes tests."""
3361
if exclude_pattern is None:
3362
return identity_decorator
3363
def decorator(suite):
3364
return ExcludeDecorator(suite, exclude_pattern)
3368
def filter_tests(pattern):
3370
return identity_decorator
3371
def decorator(suite):
3372
return FilterTestsDecorator(suite, pattern)
3376
def random_order(random_seed, runner):
3377
"""Return a test suite decorator factory for randomising tests order.
3379
:param random_seed: now, a string which casts to a long, or a long.
3380
:param runner: A test runner with a stream attribute to report on.
3382
if random_seed is None:
3383
return identity_decorator
3384
def decorator(suite):
3385
return RandomDecorator(suite, random_seed, runner.stream)
3389
def tests_first(pattern):
3391
return identity_decorator
3392
def decorator(suite):
3393
return TestFirstDecorator(suite, pattern)
3397
def identity_decorator(suite):
3402
class TestDecorator(TestUtil.TestSuite):
3403
"""A decorator for TestCase/TestSuite objects.
3405
Contains rather than flattening suite passed on construction
3408
def __init__(self, suite=None):
3409
super(TestDecorator, self).__init__()
3410
if suite is not None:
3413
# Don't need subclass run method with suite emptying
3414
run = unittest.TestSuite.run
3417
class CountingDecorator(TestDecorator):
3418
"""A decorator which calls result.progress(self.countTestCases)."""
3420
def run(self, result):
3421
progress_method = getattr(result, 'progress', None)
3422
if callable(progress_method):
3423
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3424
return super(CountingDecorator, self).run(result)
3427
class ExcludeDecorator(TestDecorator):
3428
"""A decorator which excludes test matching an exclude pattern."""
3430
def __init__(self, suite, exclude_pattern):
3431
super(ExcludeDecorator, self).__init__(
3432
exclude_tests_by_re(suite, exclude_pattern))
3435
class FilterTestsDecorator(TestDecorator):
3436
"""A decorator which filters tests to those matching a pattern."""
3438
def __init__(self, suite, pattern):
3439
super(FilterTestsDecorator, self).__init__(
3440
filter_suite_by_re(suite, pattern))
3443
class RandomDecorator(TestDecorator):
3444
"""A decorator which randomises the order of its tests."""
3446
def __init__(self, suite, random_seed, stream):
3447
random_seed = self.actual_seed(random_seed)
3448
stream.write("Randomizing test order using seed %s\n\n" %
3450
# Initialise the random number generator.
3451
random.seed(random_seed)
3452
super(RandomDecorator, self).__init__(randomize_suite(suite))
3455
def actual_seed(seed):
3457
# We convert the seed to a long to make it reuseable across
3458
# invocations (because the user can reenter it).
3459
return long(time.time())
2197
3461
# Convert the seed to a long if we can
2199
random_seed = long(random_seed)
3464
except (TypeError, ValueError):
3469
class TestFirstDecorator(TestDecorator):
3470
"""A decorator which moves named tests to the front."""
3472
def __init__(self, suite, pattern):
3473
super(TestFirstDecorator, self).__init__()
3474
self.addTests(split_suite_by_re(suite, pattern))
3477
def partition_tests(suite, count):
3478
"""Partition suite into count lists of tests."""
3479
# This just assigns tests in a round-robin fashion. On one hand this
3480
# splits up blocks of related tests that might run faster if they shared
3481
# resources, but on the other it avoids assigning blocks of slow tests to
3482
# just one partition. So the slowest partition shouldn't be much slower
3484
partitions = [list() for i in range(count)]
3485
tests = iter_suite_tests(suite)
3486
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3487
partition.append(test)
3491
def workaround_zealous_crypto_random():
3492
"""Crypto.Random want to help us being secure, but we don't care here.
3494
This workaround some test failure related to the sftp server. Once paramiko
3495
stop using the controversial API in Crypto.Random, we may get rid of it.
3498
from Crypto.Random import atfork
3504
def fork_for_tests(suite):
3505
"""Take suite and start up one runner per CPU by forking()
3507
:return: An iterable of TestCase-like objects which can each have
3508
run(result) called on them to feed tests to result.
3510
concurrency = osutils.local_concurrency()
3512
from subunit import ProtocolTestCase
3513
from subunit.test_results import AutoTimingTestResultDecorator
3514
class TestInOtherProcess(ProtocolTestCase):
3515
# Should be in subunit, I think. RBC.
3516
def __init__(self, stream, pid):
3517
ProtocolTestCase.__init__(self, stream)
3520
def run(self, result):
3522
ProtocolTestCase.run(self, result)
3524
pid, status = os.waitpid(self.pid, 0)
3525
# GZ 2011-10-18: If status is nonzero, should report to the result
3526
# that something went wrong.
3528
test_blocks = partition_tests(suite, concurrency)
3529
# Clear the tests from the original suite so it doesn't keep them alive
3530
suite._tests[:] = []
3531
for process_tests in test_blocks:
3532
process_suite = TestUtil.TestSuite(process_tests)
3533
# Also clear each split list so new suite has only reference
3534
process_tests[:] = []
3535
c2pread, c2pwrite = os.pipe()
3539
stream = os.fdopen(c2pwrite, 'wb', 1)
3540
workaround_zealous_crypto_random()
3542
# Leave stderr and stdout open so we can see test noise
3543
# Close stdin so that the child goes away if it decides to
3544
# read from stdin (otherwise its a roulette to see what
3545
# child actually gets keystrokes for pdb etc).
3547
subunit_result = AutoTimingTestResultDecorator(
3548
SubUnitBzrProtocolClient(stream))
3549
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,
3551
# Try and report traceback on stream, but exit with error even
3552
# if stream couldn't be created or something else goes wrong.
3553
# The traceback is formatted to a string and written in one go
3554
# to avoid interleaving lines from multiple failing children.
3556
stream.write(traceback.format_exc())
2211
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2213
result = runner.run(suite)
2214
return result.wasSuccessful()
3562
stream = os.fdopen(c2pread, 'rb', 1)
3563
test = TestInOtherProcess(stream, pid)
3568
def reinvoke_for_tests(suite):
3569
"""Take suite and start up one runner per CPU using subprocess().
3571
:return: An iterable of TestCase-like objects which can each have
3572
run(result) called on them to feed tests to result.
3574
concurrency = osutils.local_concurrency()
3576
from subunit import ProtocolTestCase
3577
class TestInSubprocess(ProtocolTestCase):
3578
def __init__(self, process, name):
3579
ProtocolTestCase.__init__(self, process.stdout)
3580
self.process = process
3581
self.process.stdin.close()
3584
def run(self, result):
3586
ProtocolTestCase.run(self, result)
3589
os.unlink(self.name)
3590
# print "pid %d finished" % finished_process
3591
test_blocks = partition_tests(suite, concurrency)
3592
for process_tests in test_blocks:
3593
# ugly; currently reimplement rather than reuses TestCase methods.
3594
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3595
if not os.path.isfile(bzr_path):
3596
# We are probably installed. Assume sys.argv is the right file
3597
bzr_path = sys.argv[0]
3598
bzr_path = [bzr_path]
3599
if sys.platform == "win32":
3600
# if we're on windows, we can't execute the bzr script directly
3601
bzr_path = [sys.executable] + bzr_path
3602
fd, test_list_file_name = tempfile.mkstemp()
3603
test_list_file = os.fdopen(fd, 'wb', 1)
3604
for test in process_tests:
3605
test_list_file.write(test.id() + '\n')
3606
test_list_file.close()
3608
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3610
if '--no-plugins' in sys.argv:
3611
argv.append('--no-plugins')
3612
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3613
# noise on stderr it can interrupt the subunit protocol.
3614
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3615
stdout=subprocess.PIPE,
3616
stderr=subprocess.PIPE,
3618
test = TestInSubprocess(process, test_list_file_name)
3621
os.unlink(test_list_file_name)
3626
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3627
"""Generate profiling data for all activity between start and success.
3629
The profile data is appended to the test's _benchcalls attribute and can
3630
be accessed by the forwarded-to TestResult.
3632
While it might be cleaner do accumulate this in stopTest, addSuccess is
3633
where our existing output support for lsprof is, and this class aims to
3634
fit in with that: while it could be moved it's not necessary to accomplish
3635
test profiling, nor would it be dramatically cleaner.
3638
def startTest(self, test):
3639
self.profiler = bzrlib.lsprof.BzrProfiler()
3640
# Prevent deadlocks in tests that use lsprof: those tests will
3642
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3643
self.profiler.start()
3644
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3646
def addSuccess(self, test):
3647
stats = self.profiler.stop()
3649
calls = test._benchcalls
3650
except AttributeError:
3651
test._benchcalls = []
3652
calls = test._benchcalls
3653
calls.append(((test.id(), "", ""), stats))
3654
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3656
def stopTest(self, test):
3657
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3658
self.profiler = None
3661
# Controlled by "bzr selftest -E=..." option
3662
# Currently supported:
3663
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3664
# preserves any flags supplied at the command line.
3665
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3666
# rather than failing tests. And no longer raise
3667
# LockContention when fctnl locks are not being used
3668
# with proper exclusion rules.
3669
# -Ethreads Will display thread ident at creation/join time to
3670
# help track thread leaks
3671
# -Euncollected_cases Display the identity of any test cases that weren't
3672
# deallocated after being completed.
3673
# -Econfig_stats Will collect statistics using addDetail
3674
selftest_debug_flags = set()
2217
3677
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2236
3704
transport = default_transport
2237
3705
old_transport = default_transport
2238
3706
default_transport = transport
3707
global selftest_debug_flags
3708
old_debug_flags = selftest_debug_flags
3709
if debug_flags is not None:
3710
selftest_debug_flags = set(debug_flags)
3712
if load_list is None:
3715
keep_only = load_test_id_list(load_list)
3717
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3718
for start in starting_with]
2240
3719
if test_suite_factory is None:
2241
suite = test_suite()
3720
# Reduce loading time by loading modules based on the starting_with
3722
suite = test_suite(keep_only, starting_with)
2243
3724
suite = test_suite_factory()
3726
# But always filter as requested.
3727
suite = filter_suite_by_id_startswith(suite, starting_with)
3728
result_decorators = []
3730
result_decorators.append(ProfileResult)
2244
3731
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2245
3732
stop_on_failure=stop_on_failure,
2246
3733
transport=transport,
2247
3734
lsprof_timed=lsprof_timed,
2248
3735
bench_history=bench_history,
2249
3736
matching_tests_first=matching_tests_first,
2250
numbered_dirs=numbered_dirs,
2251
3737
list_only=list_only,
2252
3738
random_seed=random_seed,
2253
exclude_pattern=exclude_pattern)
3739
exclude_pattern=exclude_pattern,
3741
runner_class=runner_class,
3742
suite_decorators=suite_decorators,
3744
result_decorators=result_decorators,
2255
3747
default_transport = old_transport
3748
selftest_debug_flags = old_debug_flags
3751
def load_test_id_list(file_name):
3752
"""Load a test id list from a text file.
3754
The format is one test id by line. No special care is taken to impose
3755
strict rules, these test ids are used to filter the test suite so a test id
3756
that do not match an existing test will do no harm. This allows user to add
3757
comments, leave blank lines, etc.
3761
ftest = open(file_name, 'rt')
3763
if e.errno != errno.ENOENT:
3766
raise errors.NoSuchFile(file_name)
3768
for test_name in ftest.readlines():
3769
test_list.append(test_name.strip())
3774
def suite_matches_id_list(test_suite, id_list):
3775
"""Warns about tests not appearing or appearing more than once.
3777
:param test_suite: A TestSuite object.
3778
:param test_id_list: The list of test ids that should be found in
3781
:return: (absents, duplicates) absents is a list containing the test found
3782
in id_list but not in test_suite, duplicates is a list containing the
3783
test found multiple times in test_suite.
3785
When using a prefined test id list, it may occurs that some tests do not
3786
exist anymore or that some tests use the same id. This function warns the
3787
tester about potential problems in his workflow (test lists are volatile)
3788
or in the test suite itself (using the same id for several tests does not
3789
help to localize defects).
3791
# Build a dict counting id occurrences
3793
for test in iter_suite_tests(test_suite):
3795
tests[id] = tests.get(id, 0) + 1
3800
occurs = tests.get(id, 0)
3802
not_found.append(id)
3804
duplicates.append(id)
3806
return not_found, duplicates
3809
class TestIdList(object):
3810
"""Test id list to filter a test suite.
3812
Relying on the assumption that test ids are built as:
3813
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3814
notation, this class offers methods to :
3815
- avoid building a test suite for modules not refered to in the test list,
3816
- keep only the tests listed from the module test suite.
3819
def __init__(self, test_id_list):
3820
# When a test suite needs to be filtered against us we compare test ids
3821
# for equality, so a simple dict offers a quick and simple solution.
3822
self.tests = dict().fromkeys(test_id_list, True)
3824
# While unittest.TestCase have ids like:
3825
# <module>.<class>.<method>[(<param+)],
3826
# doctest.DocTestCase can have ids like:
3829
# <module>.<function>
3830
# <module>.<class>.<method>
3832
# Since we can't predict a test class from its name only, we settle on
3833
# a simple constraint: a test id always begins with its module name.
3836
for test_id in test_id_list:
3837
parts = test_id.split('.')
3838
mod_name = parts.pop(0)
3839
modules[mod_name] = True
3841
mod_name += '.' + part
3842
modules[mod_name] = True
3843
self.modules = modules
3845
def refers_to(self, module_name):
3846
"""Is there tests for the module or one of its sub modules."""
3847
return self.modules.has_key(module_name)
3849
def includes(self, test_id):
3850
return self.tests.has_key(test_id)
3853
class TestPrefixAliasRegistry(registry.Registry):
3854
"""A registry for test prefix aliases.
3856
This helps implement shorcuts for the --starting-with selftest
3857
option. Overriding existing prefixes is not allowed but not fatal (a
3858
warning will be emitted).
3861
def register(self, key, obj, help=None, info=None,
3862
override_existing=False):
3863
"""See Registry.register.
3865
Trying to override an existing alias causes a warning to be emitted,
3866
not a fatal execption.
3869
super(TestPrefixAliasRegistry, self).register(
3870
key, obj, help=help, info=info, override_existing=False)
3872
actual = self.get(key)
3874
'Test prefix alias %s is already used for %s, ignoring %s'
3875
% (key, actual, obj))
3877
def resolve_alias(self, id_start):
3878
"""Replace the alias by the prefix in the given string.
3880
Using an unknown prefix is an error to help catching typos.
3882
parts = id_start.split('.')
3884
parts[0] = self.get(parts[0])
3886
raise errors.BzrCommandError(
3887
'%s is not a known test prefix alias' % parts[0])
3888
return '.'.join(parts)
3891
test_prefix_alias_registry = TestPrefixAliasRegistry()
3892
"""Registry of test prefix aliases."""
3895
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3896
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3897
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3899
# Obvious highest levels prefixes, feel free to add your own via a plugin
3900
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3901
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3902
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3903
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3904
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3907
def _test_suite_testmod_names():
3908
"""Return the standard list of test module names to test."""
3911
'bzrlib.tests.blackbox',
3912
'bzrlib.tests.commands',
3913
'bzrlib.tests.per_branch',
3914
'bzrlib.tests.per_bzrdir',
3915
'bzrlib.tests.per_controldir',
3916
'bzrlib.tests.per_controldir_colo',
3917
'bzrlib.tests.per_foreign_vcs',
3918
'bzrlib.tests.per_interrepository',
3919
'bzrlib.tests.per_intertree',
3920
'bzrlib.tests.per_inventory',
3921
'bzrlib.tests.per_interbranch',
3922
'bzrlib.tests.per_lock',
3923
'bzrlib.tests.per_merger',
3924
'bzrlib.tests.per_transport',
3925
'bzrlib.tests.per_tree',
3926
'bzrlib.tests.per_pack_repository',
3927
'bzrlib.tests.per_repository',
3928
'bzrlib.tests.per_repository_chk',
3929
'bzrlib.tests.per_repository_reference',
3930
'bzrlib.tests.per_repository_vf',
3931
'bzrlib.tests.per_uifactory',
3932
'bzrlib.tests.per_versionedfile',
3933
'bzrlib.tests.per_workingtree',
3934
'bzrlib.tests.test__annotator',
3935
'bzrlib.tests.test__bencode',
3936
'bzrlib.tests.test__btree_serializer',
3937
'bzrlib.tests.test__chk_map',
3938
'bzrlib.tests.test__dirstate_helpers',
3939
'bzrlib.tests.test__groupcompress',
3940
'bzrlib.tests.test__known_graph',
3941
'bzrlib.tests.test__rio',
3942
'bzrlib.tests.test__simple_set',
3943
'bzrlib.tests.test__static_tuple',
3944
'bzrlib.tests.test__walkdirs_win32',
3945
'bzrlib.tests.test_ancestry',
3946
'bzrlib.tests.test_annotate',
3947
'bzrlib.tests.test_api',
3948
'bzrlib.tests.test_atomicfile',
3949
'bzrlib.tests.test_bad_files',
3950
'bzrlib.tests.test_bisect_multi',
3951
'bzrlib.tests.test_branch',
3952
'bzrlib.tests.test_branchbuilder',
3953
'bzrlib.tests.test_btree_index',
3954
'bzrlib.tests.test_bugtracker',
3955
'bzrlib.tests.test_bundle',
3956
'bzrlib.tests.test_bzrdir',
3957
'bzrlib.tests.test__chunks_to_lines',
3958
'bzrlib.tests.test_cache_utf8',
3959
'bzrlib.tests.test_chk_map',
3960
'bzrlib.tests.test_chk_serializer',
3961
'bzrlib.tests.test_chunk_writer',
3962
'bzrlib.tests.test_clean_tree',
3963
'bzrlib.tests.test_cleanup',
3964
'bzrlib.tests.test_cmdline',
3965
'bzrlib.tests.test_commands',
3966
'bzrlib.tests.test_commit',
3967
'bzrlib.tests.test_commit_merge',
3968
'bzrlib.tests.test_config',
3969
'bzrlib.tests.test_conflicts',
3970
'bzrlib.tests.test_controldir',
3971
'bzrlib.tests.test_counted_lock',
3972
'bzrlib.tests.test_crash',
3973
'bzrlib.tests.test_decorators',
3974
'bzrlib.tests.test_delta',
3975
'bzrlib.tests.test_debug',
3976
'bzrlib.tests.test_diff',
3977
'bzrlib.tests.test_directory_service',
3978
'bzrlib.tests.test_dirstate',
3979
'bzrlib.tests.test_email_message',
3980
'bzrlib.tests.test_eol_filters',
3981
'bzrlib.tests.test_errors',
3982
'bzrlib.tests.test_estimate_compressed_size',
3983
'bzrlib.tests.test_export',
3984
'bzrlib.tests.test_export_pot',
3985
'bzrlib.tests.test_extract',
3986
'bzrlib.tests.test_features',
3987
'bzrlib.tests.test_fetch',
3988
'bzrlib.tests.test_fixtures',
3989
'bzrlib.tests.test_fifo_cache',
3990
'bzrlib.tests.test_filters',
3991
'bzrlib.tests.test_filter_tree',
3992
'bzrlib.tests.test_ftp_transport',
3993
'bzrlib.tests.test_foreign',
3994
'bzrlib.tests.test_generate_docs',
3995
'bzrlib.tests.test_generate_ids',
3996
'bzrlib.tests.test_globbing',
3997
'bzrlib.tests.test_gpg',
3998
'bzrlib.tests.test_graph',
3999
'bzrlib.tests.test_groupcompress',
4000
'bzrlib.tests.test_hashcache',
4001
'bzrlib.tests.test_help',
4002
'bzrlib.tests.test_hooks',
4003
'bzrlib.tests.test_http',
4004
'bzrlib.tests.test_http_response',
4005
'bzrlib.tests.test_https_ca_bundle',
4006
'bzrlib.tests.test_https_urllib',
4007
'bzrlib.tests.test_i18n',
4008
'bzrlib.tests.test_identitymap',
4009
'bzrlib.tests.test_ignores',
4010
'bzrlib.tests.test_index',
4011
'bzrlib.tests.test_import_tariff',
4012
'bzrlib.tests.test_info',
4013
'bzrlib.tests.test_inv',
4014
'bzrlib.tests.test_inventory_delta',
4015
'bzrlib.tests.test_knit',
4016
'bzrlib.tests.test_lazy_import',
4017
'bzrlib.tests.test_lazy_regex',
4018
'bzrlib.tests.test_library_state',
4019
'bzrlib.tests.test_lock',
4020
'bzrlib.tests.test_lockable_files',
4021
'bzrlib.tests.test_lockdir',
4022
'bzrlib.tests.test_log',
4023
'bzrlib.tests.test_lru_cache',
4024
'bzrlib.tests.test_lsprof',
4025
'bzrlib.tests.test_mail_client',
4026
'bzrlib.tests.test_matchers',
4027
'bzrlib.tests.test_memorytree',
4028
'bzrlib.tests.test_merge',
4029
'bzrlib.tests.test_merge3',
4030
'bzrlib.tests.test_merge_core',
4031
'bzrlib.tests.test_merge_directive',
4032
'bzrlib.tests.test_mergetools',
4033
'bzrlib.tests.test_missing',
4034
'bzrlib.tests.test_msgeditor',
4035
'bzrlib.tests.test_multiparent',
4036
'bzrlib.tests.test_mutabletree',
4037
'bzrlib.tests.test_nonascii',
4038
'bzrlib.tests.test_options',
4039
'bzrlib.tests.test_osutils',
4040
'bzrlib.tests.test_osutils_encodings',
4041
'bzrlib.tests.test_pack',
4042
'bzrlib.tests.test_patch',
4043
'bzrlib.tests.test_patches',
4044
'bzrlib.tests.test_permissions',
4045
'bzrlib.tests.test_plugins',
4046
'bzrlib.tests.test_progress',
4047
'bzrlib.tests.test_pyutils',
4048
'bzrlib.tests.test_read_bundle',
4049
'bzrlib.tests.test_reconcile',
4050
'bzrlib.tests.test_reconfigure',
4051
'bzrlib.tests.test_registry',
4052
'bzrlib.tests.test_remote',
4053
'bzrlib.tests.test_rename_map',
4054
'bzrlib.tests.test_repository',
4055
'bzrlib.tests.test_revert',
4056
'bzrlib.tests.test_revision',
4057
'bzrlib.tests.test_revisionspec',
4058
'bzrlib.tests.test_revisiontree',
4059
'bzrlib.tests.test_rio',
4060
'bzrlib.tests.test_rules',
4061
'bzrlib.tests.test_url_policy_open',
4062
'bzrlib.tests.test_sampler',
4063
'bzrlib.tests.test_scenarios',
4064
'bzrlib.tests.test_script',
4065
'bzrlib.tests.test_selftest',
4066
'bzrlib.tests.test_serializer',
4067
'bzrlib.tests.test_setup',
4068
'bzrlib.tests.test_sftp_transport',
4069
'bzrlib.tests.test_shelf',
4070
'bzrlib.tests.test_shelf_ui',
4071
'bzrlib.tests.test_smart',
4072
'bzrlib.tests.test_smart_add',
4073
'bzrlib.tests.test_smart_request',
4074
'bzrlib.tests.test_smart_signals',
4075
'bzrlib.tests.test_smart_transport',
4076
'bzrlib.tests.test_smtp_connection',
4077
'bzrlib.tests.test_source',
4078
'bzrlib.tests.test_ssh_transport',
4079
'bzrlib.tests.test_status',
4080
'bzrlib.tests.test_store',
4081
'bzrlib.tests.test_strace',
4082
'bzrlib.tests.test_subsume',
4083
'bzrlib.tests.test_switch',
4084
'bzrlib.tests.test_symbol_versioning',
4085
'bzrlib.tests.test_tag',
4086
'bzrlib.tests.test_test_server',
4087
'bzrlib.tests.test_testament',
4088
'bzrlib.tests.test_textfile',
4089
'bzrlib.tests.test_textmerge',
4090
'bzrlib.tests.test_cethread',
4091
'bzrlib.tests.test_timestamp',
4092
'bzrlib.tests.test_trace',
4093
'bzrlib.tests.test_transactions',
4094
'bzrlib.tests.test_transform',
4095
'bzrlib.tests.test_transport',
4096
'bzrlib.tests.test_transport_log',
4097
'bzrlib.tests.test_tree',
4098
'bzrlib.tests.test_treebuilder',
4099
'bzrlib.tests.test_treeshape',
4100
'bzrlib.tests.test_tsort',
4101
'bzrlib.tests.test_tuned_gzip',
4102
'bzrlib.tests.test_ui',
4103
'bzrlib.tests.test_uncommit',
4104
'bzrlib.tests.test_upgrade',
4105
'bzrlib.tests.test_upgrade_stacked',
4106
'bzrlib.tests.test_urlutils',
4107
'bzrlib.tests.test_utextwrap',
4108
'bzrlib.tests.test_version',
4109
'bzrlib.tests.test_version_info',
4110
'bzrlib.tests.test_versionedfile',
4111
'bzrlib.tests.test_vf_search',
4112
'bzrlib.tests.test_weave',
4113
'bzrlib.tests.test_whitebox',
4114
'bzrlib.tests.test_win32utils',
4115
'bzrlib.tests.test_workingtree',
4116
'bzrlib.tests.test_workingtree_4',
4117
'bzrlib.tests.test_wsgi',
4118
'bzrlib.tests.test_xml',
4122
def _test_suite_modules_to_doctest():
4123
"""Return the list of modules to doctest."""
4125
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4129
'bzrlib.branchbuilder',
4130
'bzrlib.decorators',
4132
'bzrlib.iterablefile',
4137
'bzrlib.symbol_versioning',
4139
'bzrlib.tests.fixtures',
4141
'bzrlib.transport.http',
4142
'bzrlib.version_info_formats.format_custom',
4146
def test_suite(keep_only=None, starting_with=None):
2259
4147
"""Build and return TestSuite for the whole of bzrlib.
4149
:param keep_only: A list of test ids limiting the suite returned.
4151
:param starting_with: An id limiting the suite returned to the tests
2261
4154
This function can be replaced if you need to change the default test
2262
4155
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_pack',
2282
'bzrlib.tests.test_counted_lock',
2283
'bzrlib.tests.test_decorators',
2284
'bzrlib.tests.test_delta',
2285
'bzrlib.tests.test_deprecated_graph',
2286
'bzrlib.tests.test_diff',
2287
'bzrlib.tests.test_dirstate',
2288
'bzrlib.tests.test_errors',
2289
'bzrlib.tests.test_escaped_store',
2290
'bzrlib.tests.test_extract',
2291
'bzrlib.tests.test_fetch',
2292
'bzrlib.tests.test_ftp_transport',
2293
'bzrlib.tests.test_generate_docs',
2294
'bzrlib.tests.test_generate_ids',
2295
'bzrlib.tests.test_globbing',
2296
'bzrlib.tests.test_gpg',
2297
'bzrlib.tests.test_graph',
2298
'bzrlib.tests.test_hashcache',
2299
'bzrlib.tests.test_help',
2300
'bzrlib.tests.test_hooks',
2301
'bzrlib.tests.test_http',
2302
'bzrlib.tests.test_http_response',
2303
'bzrlib.tests.test_https_ca_bundle',
2304
'bzrlib.tests.test_identitymap',
2305
'bzrlib.tests.test_ignores',
2306
'bzrlib.tests.test_info',
2307
'bzrlib.tests.test_inv',
2308
'bzrlib.tests.test_knit',
2309
'bzrlib.tests.test_lazy_import',
2310
'bzrlib.tests.test_lazy_regex',
2311
'bzrlib.tests.test_lockdir',
2312
'bzrlib.tests.test_lockable_files',
2313
'bzrlib.tests.test_log',
2314
'bzrlib.tests.test_lsprof',
2315
'bzrlib.tests.test_memorytree',
2316
'bzrlib.tests.test_merge',
2317
'bzrlib.tests.test_merge3',
2318
'bzrlib.tests.test_merge_core',
2319
'bzrlib.tests.test_merge_directive',
2320
'bzrlib.tests.test_missing',
2321
'bzrlib.tests.test_msgeditor',
2322
'bzrlib.tests.test_nonascii',
2323
'bzrlib.tests.test_options',
2324
'bzrlib.tests.test_osutils',
2325
'bzrlib.tests.test_osutils_encodings',
2326
'bzrlib.tests.test_patch',
2327
'bzrlib.tests.test_patches',
2328
'bzrlib.tests.test_permissions',
2329
'bzrlib.tests.test_plugins',
2330
'bzrlib.tests.test_progress',
2331
'bzrlib.tests.test_reconcile',
2332
'bzrlib.tests.test_registry',
2333
'bzrlib.tests.test_remote',
2334
'bzrlib.tests.test_repository',
2335
'bzrlib.tests.test_revert',
2336
'bzrlib.tests.test_revision',
2337
'bzrlib.tests.test_revisionnamespaces',
2338
'bzrlib.tests.test_revisiontree',
2339
'bzrlib.tests.test_rio',
2340
'bzrlib.tests.test_sampler',
2341
'bzrlib.tests.test_selftest',
2342
'bzrlib.tests.test_setup',
2343
'bzrlib.tests.test_sftp_transport',
2344
'bzrlib.tests.test_smart',
2345
'bzrlib.tests.test_smart_add',
2346
'bzrlib.tests.test_smart_transport',
2347
'bzrlib.tests.test_smtp_connection',
2348
'bzrlib.tests.test_source',
2349
'bzrlib.tests.test_ssh_transport',
2350
'bzrlib.tests.test_status',
2351
'bzrlib.tests.test_store',
2352
'bzrlib.tests.test_strace',
2353
'bzrlib.tests.test_subsume',
2354
'bzrlib.tests.test_symbol_versioning',
2355
'bzrlib.tests.test_tag',
2356
'bzrlib.tests.test_testament',
2357
'bzrlib.tests.test_textfile',
2358
'bzrlib.tests.test_textmerge',
2359
'bzrlib.tests.test_timestamp',
2360
'bzrlib.tests.test_trace',
2361
'bzrlib.tests.test_transactions',
2362
'bzrlib.tests.test_transform',
2363
'bzrlib.tests.test_transport',
2364
'bzrlib.tests.test_tree',
2365
'bzrlib.tests.test_treebuilder',
2366
'bzrlib.tests.test_tsort',
2367
'bzrlib.tests.test_tuned_gzip',
2368
'bzrlib.tests.test_ui',
2369
'bzrlib.tests.test_upgrade',
2370
'bzrlib.tests.test_urlutils',
2371
'bzrlib.tests.test_versionedfile',
2372
'bzrlib.tests.test_version',
2373
'bzrlib.tests.test_version_info',
2374
'bzrlib.tests.test_weave',
2375
'bzrlib.tests.test_whitebox',
2376
'bzrlib.tests.test_workingtree',
2377
'bzrlib.tests.test_workingtree_4',
2378
'bzrlib.tests.test_wsgi',
2379
'bzrlib.tests.test_xml',
2381
test_transport_implementations = [
2382
'bzrlib.tests.test_transport_implementations',
2383
'bzrlib.tests.test_read_bundle',
2385
suite = TestUtil.TestSuite()
2386
4158
loader = TestUtil.TestLoader()
2387
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2388
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2389
adapter = TransportTestProviderAdapter()
2390
adapt_modules(test_transport_implementations, adapter, loader, suite)
2391
for package in packages_to_test():
2392
suite.addTest(package.test_suite())
2393
for m in MODULES_TO_TEST:
2394
suite.addTest(loader.loadTestsFromModule(m))
2395
for m in MODULES_TO_DOCTEST:
4160
if keep_only is not None:
4161
id_filter = TestIdList(keep_only)
4163
# We take precedence over keep_only because *at loading time* using
4164
# both options means we will load less tests for the same final result.
4165
def interesting_module(name):
4166
for start in starting_with:
4168
# Either the module name starts with the specified string
4169
name.startswith(start)
4170
# or it may contain tests starting with the specified string
4171
or start.startswith(name)
4175
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4177
elif keep_only is not None:
4178
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4179
def interesting_module(name):
4180
return id_filter.refers_to(name)
4183
loader = TestUtil.TestLoader()
4184
def interesting_module(name):
4185
# No filtering, all modules are interesting
4188
suite = loader.suiteClass()
4190
# modules building their suite with loadTestsFromModuleNames
4191
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4193
for mod in _test_suite_modules_to_doctest():
4194
if not interesting_module(mod):
4195
# No tests to keep here, move along
2397
suite.addTest(doctest.DocTestSuite(m))
4198
# note that this really does mean "report only" -- doctest
4199
# still runs the rest of the examples
4200
doc_suite = IsolatedDocTestSuite(
4201
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
2398
4202
except ValueError, e:
2399
print '**failed to get doctest for: %s\n%s' %(m,e)
4203
print '**failed to get doctest for: %s\n%s' % (mod, e)
2401
for name, plugin in bzrlib.plugin.all_plugins().items():
2402
if getattr(plugin, 'test_suite', None) is not None:
2403
default_encoding = sys.getdefaultencoding()
2405
plugin_suite = plugin.test_suite()
2406
except ImportError, e:
2407
bzrlib.trace.warning(
2408
'Unable to test plugin "%s": %s', name, e)
2410
suite.addTest(plugin_suite)
2411
if default_encoding != sys.getdefaultencoding():
2412
bzrlib.trace.warning(
2413
'Plugin "%s" tried to reset default encoding to: %s', name,
2414
sys.getdefaultencoding())
2416
sys.setdefaultencoding(default_encoding)
4205
if len(doc_suite._tests) == 0:
4206
raise errors.BzrError("no doctests found in %s" % (mod,))
4207
suite.addTest(doc_suite)
4209
default_encoding = sys.getdefaultencoding()
4210
for name, plugin in _mod_plugin.plugins().items():
4211
if not interesting_module(plugin.module.__name__):
4213
plugin_suite = plugin.test_suite()
4214
# We used to catch ImportError here and turn it into just a warning,
4215
# but really if you don't have --no-plugins this should be a failure.
4216
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4217
if plugin_suite is None:
4218
plugin_suite = plugin.load_plugin_tests(loader)
4219
if plugin_suite is not None:
4220
suite.addTest(plugin_suite)
4221
if default_encoding != sys.getdefaultencoding():
4223
'Plugin "%s" tried to reset default encoding to: %s', name,
4224
sys.getdefaultencoding())
4226
sys.setdefaultencoding(default_encoding)
4228
if keep_only is not None:
4229
# Now that the referred modules have loaded their tests, keep only the
4231
suite = filter_suite_by_id_list(suite, id_filter)
4232
# Do some sanity checks on the id_list filtering
4233
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4235
# The tester has used both keep_only and starting_with, so he is
4236
# already aware that some tests are excluded from the list, there
4237
# is no need to tell him which.
4240
# Some tests mentioned in the list are not in the test suite. The
4241
# list may be out of date, report to the tester.
4242
for id in not_found:
4243
trace.warning('"%s" not found in the test suite', id)
4244
for id in duplicates:
4245
trace.warning('"%s" is used as an id by several tests', id)
2420
def adapt_modules(mods_list, adapter, loader, suite):
2421
"""Adapt the modules in mods_list using adapter and add to suite."""
2422
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2423
suite.addTests(adapter.adapt(test))
2426
def _rmtree_temp_dir(dirname):
4250
def multiply_scenarios(*scenarios):
4251
"""Multiply two or more iterables of scenarios.
4253
It is safe to pass scenario generators or iterators.
4255
:returns: A list of compound scenarios: the cross-product of all
4256
scenarios, with the names concatenated and the parameters
4259
return reduce(_multiply_two_scenarios, map(list, scenarios))
4262
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4263
"""Multiply two sets of scenarios.
4265
:returns: the cartesian product of the two sets of scenarios, that is
4266
a scenario for every possible combination of a left scenario and a
4270
('%s,%s' % (left_name, right_name),
4271
dict(left_dict.items() + right_dict.items()))
4272
for left_name, left_dict in scenarios_left
4273
for right_name, right_dict in scenarios_right]
4276
def multiply_tests(tests, scenarios, result):
4277
"""Multiply tests_list by scenarios into result.
4279
This is the core workhorse for test parameterisation.
4281
Typically the load_tests() method for a per-implementation test suite will
4282
call multiply_tests and return the result.
4284
:param tests: The tests to parameterise.
4285
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4286
scenario_param_dict).
4287
:param result: A TestSuite to add created tests to.
4289
This returns the passed in result TestSuite with the cross product of all
4290
the tests repeated once for each scenario. Each test is adapted by adding
4291
the scenario name at the end of its id(), and updating the test object's
4292
__dict__ with the scenario_param_dict.
4294
>>> import bzrlib.tests.test_sampler
4295
>>> r = multiply_tests(
4296
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4297
... [('one', dict(param=1)),
4298
... ('two', dict(param=2))],
4299
... TestUtil.TestSuite())
4300
>>> tests = list(iter_suite_tests(r))
4304
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4310
for test in iter_suite_tests(tests):
4311
apply_scenarios(test, scenarios, result)
4315
def apply_scenarios(test, scenarios, result):
4316
"""Apply the scenarios in scenarios to test and add to result.
4318
:param test: The test to apply scenarios to.
4319
:param scenarios: An iterable of scenarios to apply to test.
4321
:seealso: apply_scenario
4323
for scenario in scenarios:
4324
result.addTest(apply_scenario(test, scenario))
4328
def apply_scenario(test, scenario):
4329
"""Copy test and apply scenario to it.
4331
:param test: A test to adapt.
4332
:param scenario: A tuple describing the scenarion.
4333
The first element of the tuple is the new test id.
4334
The second element is a dict containing attributes to set on the
4336
:return: The adapted test.
4338
new_id = "%s(%s)" % (test.id(), scenario[0])
4339
new_test = clone_test(test, new_id)
4340
for name, value in scenario[1].items():
4341
setattr(new_test, name, value)
4345
def clone_test(test, new_id):
4346
"""Clone a test giving it a new id.
4348
:param test: The test to clone.
4349
:param new_id: The id to assign to it.
4350
:return: The new test.
4352
new_test = copy.copy(test)
4353
new_test.id = lambda: new_id
4354
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4355
# causes cloned tests to share the 'details' dict. This makes it hard to
4356
# read the test output for parameterized tests, because tracebacks will be
4357
# associated with irrelevant tests.
4359
details = new_test._TestCase__details
4360
except AttributeError:
4361
# must be a different version of testtools than expected. Do nothing.
4364
# Reset the '__details' dict.
4365
new_test._TestCase__details = {}
4369
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4371
"""Helper for permutating tests against an extension module.
4373
This is meant to be used inside a modules 'load_tests()' function. It will
4374
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4375
against both implementations. Setting 'test.module' to the appropriate
4376
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4378
:param standard_tests: A test suite to permute
4379
:param loader: A TestLoader
4380
:param py_module_name: The python path to a python module that can always
4381
be loaded, and will be considered the 'python' implementation. (eg
4382
'bzrlib._chk_map_py')
4383
:param ext_module_name: The python path to an extension module. If the
4384
module cannot be loaded, a single test will be added, which notes that
4385
the module is not available. If it can be loaded, all standard_tests
4386
will be run against that module.
4387
:return: (suite, feature) suite is a test-suite that has all the permuted
4388
tests. feature is the Feature object that can be used to determine if
4389
the module is available.
4392
from bzrlib.tests.features import ModuleAvailableFeature
4393
py_module = pyutils.get_named_object(py_module_name)
4395
('python', {'module': py_module}),
4397
suite = loader.suiteClass()
4398
feature = ModuleAvailableFeature(ext_module_name)
4399
if feature.available():
4400
scenarios.append(('C', {'module': feature.module}))
4402
# the compiled module isn't available, so we add a failing test
4403
class FailWithoutFeature(TestCase):
4404
def test_fail(self):
4405
self.requireFeature(feature)
4406
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4407
result = multiply_tests(standard_tests, scenarios, suite)
4408
return result, feature
4411
def _rmtree_temp_dir(dirname, test_id=None):
2427
4412
# If LANG=C we probably have created some bogus paths
2428
4413
# which rmtree(unicode) will fail to delete
2429
4414
# so make sure we are using rmtree(str) to delete everything
added
removed
bzrlib/tests/__init__.py
