27
26
# general style of bzrlib. Please continue that consistency when adding e.g.
28
27
# new assertFoo() methods.
33
30
from cStringIO import StringIO
56
# nb: check this before importing anything else from within it
57
_testtools_version = getattr(testtools, '__version__', ())
58
if _testtools_version < (0, 9, 5):
59
raise ImportError("need at least testtools 0.9.5: %s is %r"
60
% (testtools.__file__, _testtools_version))
61
from testtools import content
68
commands as _mod_commands,
77
plugin as _mod_plugin,
84
transport as _mod_transport,
44
import bzrlib.bzrdir as bzrdir
45
import bzrlib.commands
46
import bzrlib.errors as errors
47
import bzrlib.inventory
48
import bzrlib.iterablefile
88
51
import bzrlib.lsprof
89
52
except ImportError:
90
53
# lsprof not available
92
from bzrlib.smart import client, request
93
from bzrlib.transport import (
97
from bzrlib.tests import (
102
from bzrlib.ui import NullProgressView
103
from bzrlib.ui.text import TextUIFactory
105
# Mark this python module as being part of the implementation
106
# of unittest: this gives us better tracebacks where the last
107
# shown frame is the test code, not our assertXYZ.
110
default_transport = test_server.LocalURLServer
113
_unitialized_attr = object()
114
"""A sentinel needed to act as a default value in a method signature."""
117
# Subunit result codes, defined here to prevent a hard dependency on subunit.
121
# These are intentionally brought into this namespace. That way plugins, etc
122
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
123
TestSuite = TestUtil.TestSuite
124
TestLoader = TestUtil.TestLoader
126
# Tests should run in a clean and clearly defined environment. The goal is to
127
# keep them isolated from the running environment as mush as possible. The test
128
# framework ensures the variables defined below are set (or deleted if the
129
# value is None) before a test is run and reset to their original value after
130
# the test is run. Generally if some code depends on an environment variable,
131
# the tests should start without this variable in the environment. There are a
132
# few exceptions but you shouldn't violate this rule lightly.
136
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
137
# tests do check our impls match APPDATA
138
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
142
'BZREMAIL': None, # may still be present in the environment
143
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
144
'BZR_PROGRESS_BAR': None,
146
'BZR_PLUGIN_PATH': None,
147
'BZR_DISABLE_PLUGINS': None,
148
'BZR_PLUGINS_AT': None,
149
'BZR_CONCURRENCY': None,
150
# Make sure that any text ui tests are consistent regardless of
151
# the environment the test case is run in; you may want tests that
152
# test other combinations. 'dumb' is a reasonable guess for tests
153
# going to a pipe or a StringIO.
159
'SSH_AUTH_SOCK': None,
169
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
170
# least. If you do (care), please update this comment
174
'BZR_REMOTE_PATH': None,
175
# Generally speaking, we don't want apport reporting on crashes in
176
# the test envirnoment unless we're specifically testing apport,
177
# so that it doesn't leak into the real system environment. We
178
# use an env var so it propagates to subprocesses.
179
'APPORT_DISABLE': '1',
183
def override_os_environ(test, env=None):
184
"""Modify os.environ keeping a copy.
186
:param test: A test instance
188
:param env: A dict containing variable definitions to be installed
191
env = isolated_environ
192
test._original_os_environ = dict([(var, value)
193
for var, value in os.environ.iteritems()])
194
for var, value in env.iteritems():
195
osutils.set_or_unset_env(var, value)
196
if var not in test._original_os_environ:
197
# The var is new, add it with a value of None, so
198
# restore_os_environ will delete it
199
test._original_os_environ[var] = None
202
def restore_os_environ(test):
203
"""Restore os.environ to its original state.
205
:param test: A test instance previously passed to override_os_environ.
207
for var, value in test._original_os_environ.iteritems():
208
# Restore the original value (or delete it if the value has been set to
209
# None in override_os_environ).
210
osutils.set_or_unset_env(var, value)
213
class ExtendedTestResult(testtools.TextTestResult):
214
"""Accepts, reports and accumulates the results of running tests.
216
Compared to the unittest version this class adds support for
217
profiling, benchmarking, stopping as soon as a test fails, and
218
skipping tests. There are further-specialized subclasses for
219
different types of display.
221
When a test finishes, in whatever way, it calls one of the addSuccess,
222
addFailure or addError classes. These in turn may redirect to a more
223
specific case for the special test results supported by our extended
226
Note that just one of these objects is fed the results from many tests.
55
from bzrlib.merge import merge_inner
58
import bzrlib.osutils as osutils
60
import bzrlib.progress as progress
61
from bzrlib.revision import common_ancestor
64
from bzrlib.transport import urlescape, get_transport
65
import bzrlib.transport
66
from bzrlib.transport.local import LocalRelpathServer
67
from bzrlib.transport.readonly import ReadonlyServer
68
from bzrlib.trace import mutter
69
from bzrlib.tests.TestUtil import TestLoader, TestSuite
70
from bzrlib.tests.treeshape import build_tree_contents
71
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
73
default_transport = LocalRelpathServer
76
MODULES_TO_DOCTEST = [
88
def packages_to_test():
89
"""Return a list of packages to test.
91
The packages are not globally imported so that import failures are
92
triggered when running selftest, not when importing the command.
95
import bzrlib.tests.blackbox
96
import bzrlib.tests.branch_implementations
97
import bzrlib.tests.bzrdir_implementations
98
import bzrlib.tests.interrepository_implementations
99
import bzrlib.tests.interversionedfile_implementations
100
import bzrlib.tests.repository_implementations
101
import bzrlib.tests.revisionstore_implementations
102
import bzrlib.tests.workingtree_implementations
105
bzrlib.tests.blackbox,
106
bzrlib.tests.branch_implementations,
107
bzrlib.tests.bzrdir_implementations,
108
bzrlib.tests.interrepository_implementations,
109
bzrlib.tests.interversionedfile_implementations,
110
bzrlib.tests.repository_implementations,
111
bzrlib.tests.revisionstore_implementations,
112
bzrlib.tests.workingtree_implementations,
116
class _MyResult(unittest._TextTestResult):
117
"""Custom TestResult.
119
Shows output in a different format, including displaying runtime for tests.
229
121
stop_early = False
231
def __init__(self, stream, descriptions, verbosity,
235
"""Construct new TestResult.
237
:param bench_history: Optionally, a writable file object to accumulate
240
testtools.TextTestResult.__init__(self, stream)
241
if bench_history is not None:
242
from bzrlib.version import _get_bzr_source_tree
243
src_tree = _get_bzr_source_tree()
246
revision_id = src_tree.get_parent_ids()[0]
248
# XXX: if this is a brand new tree, do the same as if there
252
# XXX: If there's no branch, what should we do?
254
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
255
self._bench_history = bench_history
256
self.ui = ui.ui_factory
259
self.failure_count = 0
260
self.known_failure_count = 0
262
self.not_applicable_count = 0
263
self.unsupported = {}
265
self._overall_start_time = time.time()
266
self._strict = strict
267
self._first_thread_leaker_id = None
268
self._tests_leaking_threads_count = 0
269
self._traceback_from_test = None
271
def stopTestRun(self):
274
stopTime = time.time()
275
timeTaken = stopTime - self.startTime
276
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
277
# the parent class method is similar have to duplicate
278
self._show_list('ERROR', self.errors)
279
self._show_list('FAIL', self.failures)
280
self.stream.write(self.sep2)
281
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
282
run, run != 1 and "s" or "", timeTaken))
283
if not self.wasSuccessful():
284
self.stream.write("FAILED (")
285
failed, errored = map(len, (self.failures, self.errors))
287
self.stream.write("failures=%d" % failed)
289
if failed: self.stream.write(", ")
290
self.stream.write("errors=%d" % errored)
291
if self.known_failure_count:
292
if failed or errored: self.stream.write(", ")
293
self.stream.write("known_failure_count=%d" %
294
self.known_failure_count)
295
self.stream.write(")\n")
297
if self.known_failure_count:
298
self.stream.write("OK (known_failures=%d)\n" %
299
self.known_failure_count)
301
self.stream.write("OK\n")
302
if self.skip_count > 0:
303
skipped = self.skip_count
304
self.stream.write('%d test%s skipped\n' %
305
(skipped, skipped != 1 and "s" or ""))
307
for feature, count in sorted(self.unsupported.items()):
308
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
311
ok = self.wasStrictlySuccessful()
313
ok = self.wasSuccessful()
314
if self._first_thread_leaker_id:
316
'%s is leaking threads among %d leaking tests.\n' % (
317
self._first_thread_leaker_id,
318
self._tests_leaking_threads_count))
319
# We don't report the main thread as an active one.
321
'%d non-main threads were left active in the end.\n'
322
% (len(self._active_threads) - 1))
324
def getDescription(self, test):
327
def _extractBenchmarkTime(self, testCase, details=None):
123
def __init__(self, stream, descriptions, verbosity, pb=None):
124
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
127
def extractBenchmarkTime(self, testCase):
328
128
"""Add a benchmark time for the current test case."""
329
if details and 'benchtime' in details:
330
return float(''.join(details['benchtime'].iter_bytes()))
331
return getattr(testCase, "_benchtime", None)
129
self._benchmarkTime = getattr(testCase, "_benchtime", None)
333
131
def _elapsedTestTimeString(self):
334
132
"""Return a time string for the overall time the current test has taken."""
335
return self._formatTime(self._delta_to_float(
336
self._now() - self._start_datetime))
133
return self._formatTime(time.time() - self._start_time)
338
def _testTimeString(self, testCase):
339
benchmark_time = self._extractBenchmarkTime(testCase)
340
if benchmark_time is not None:
341
return self._formatTime(benchmark_time) + "*"
135
def _testTimeString(self):
136
if self._benchmarkTime is not None:
138
self._formatTime(self._benchmarkTime),
139
self._elapsedTestTimeString())
343
return self._elapsedTestTimeString()
141
return " %s" % self._elapsedTestTimeString()
345
143
def _formatTime(self, seconds):
346
144
"""Format seconds as milliseconds with leading spaces."""
347
# some benchmarks can take thousands of seconds to run, so we need 8
349
return "%8dms" % (1000 * seconds)
351
def _shortened_test_description(self, test):
353
what = re.sub(r'^bzrlib\.tests\.', '', what)
356
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
357
# multiple times in a row, because the handler is added for
358
# each test but the container list is shared between cases.
359
# See lp:498869 lp:625574 and lp:637725 for background.
360
def _record_traceback_from_test(self, exc_info):
361
"""Store the traceback from passed exc_info tuple till"""
362
self._traceback_from_test = exc_info[2]
145
return "%5dms" % (1000 * seconds)
147
def _ellipsise_unimportant_words(self, a_string, final_width,
149
"""Add ellipses (sp?) for overly long strings.
151
:param keep_start: If true preserve the start of a_string rather
155
if len(a_string) > final_width:
156
result = a_string[:final_width-3] + '...'
160
if len(a_string) > final_width:
161
result = '...' + a_string[3-final_width:]
164
return result.ljust(final_width)
364
166
def startTest(self, test):
365
super(ExtendedTestResult, self).startTest(test)
369
self.report_test_start(test)
370
test.number = self.count
167
unittest.TestResult.startTest(self, test)
168
# In a short description, the important words are in
169
# the beginning, but in an id, the important words are
171
SHOW_DESCRIPTIONS = False
173
if not self.showAll and self.dots and self.pb is not None:
176
final_width = osutils.terminal_width()
177
final_width = final_width - 15 - 8
179
if SHOW_DESCRIPTIONS:
180
what = test.shortDescription()
182
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
185
if what.startswith('bzrlib.tests.'):
187
what = self._ellipsise_unimportant_words(what, final_width)
189
self.stream.write(what)
190
elif self.dots and self.pb is not None:
191
self.pb.update(what, self.testsRun - 1, None)
371
193
self._recordTestStartTime()
372
# Make testtools cases give us the real traceback on failure
373
addOnException = getattr(test, "addOnException", None)
374
if addOnException is not None:
375
addOnException(self._record_traceback_from_test)
376
# Only check for thread leaks on bzrlib derived test cases
377
if isinstance(test, TestCase):
378
test.addCleanup(self._check_leaked_threads, test)
380
def stopTest(self, test):
381
super(ExtendedTestResult, self).stopTest(test)
382
# Manually break cycles, means touching various private things but hey
383
getDetails = getattr(test, "getDetails", None)
384
if getDetails is not None:
386
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
387
if type_equality_funcs is not None:
388
type_equality_funcs.clear()
389
self._traceback_from_test = None
391
def startTests(self):
392
self.report_tests_starting()
393
self._active_threads = threading.enumerate()
395
def _check_leaked_threads(self, test):
396
"""See if any threads have leaked since last call
398
A sample of live threads is stored in the _active_threads attribute,
399
when this method runs it compares the current live threads and any not
400
in the previous sample are treated as having leaked.
402
now_active_threads = set(threading.enumerate())
403
threads_leaked = now_active_threads.difference(self._active_threads)
405
self._report_thread_leak(test, threads_leaked, now_active_threads)
406
self._tests_leaking_threads_count += 1
407
if self._first_thread_leaker_id is None:
408
self._first_thread_leaker_id = test.id()
409
self._active_threads = now_active_threads
411
195
def _recordTestStartTime(self):
412
196
"""Record that a test has started."""
413
self._start_datetime = self._now()
197
self._start_time = time.time()
415
199
def addError(self, test, err):
416
"""Tell result that test finished with an error.
418
Called from the TestCase run() method when the test
419
fails with an unexpected error.
421
self._post_mortem(self._traceback_from_test)
422
super(ExtendedTestResult, self).addError(test, err)
423
self.error_count += 1
424
self.report_error(test, err)
200
if isinstance(err[1], TestSkipped):
201
return self.addSkipped(test, err)
202
unittest.TestResult.addError(self, test, err)
203
self.extractBenchmarkTime(test)
205
self.stream.writeln("ERROR %s" % self._testTimeString())
206
elif self.dots and self.pb is None:
207
self.stream.write('E')
209
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
425
211
if self.stop_early:
428
214
def addFailure(self, test, err):
429
"""Tell result that test failed.
431
Called from the TestCase run() method when the test
432
fails because e.g. an assert() method failed.
434
self._post_mortem(self._traceback_from_test)
435
super(ExtendedTestResult, self).addFailure(test, err)
436
self.failure_count += 1
437
self.report_failure(test, err)
441
def addSuccess(self, test, details=None):
442
"""Tell result that test completed successfully.
444
Called from the TestCase run()
446
if self._bench_history is not None:
447
benchmark_time = self._extractBenchmarkTime(test, details)
448
if benchmark_time is not None:
449
self._bench_history.write("%s %s\n" % (
450
self._formatTime(benchmark_time),
452
self.report_success(test)
453
super(ExtendedTestResult, self).addSuccess(test)
454
test._log_contents = ''
456
def addExpectedFailure(self, test, err):
457
self.known_failure_count += 1
458
self.report_known_failure(test, err)
460
def addUnexpectedSuccess(self, test, details=None):
461
"""Tell result the test unexpectedly passed, counting as a failure
463
When the minimum version of testtools required becomes 0.9.8 this
464
can be updated to use the new handling there.
466
super(ExtendedTestResult, self).addFailure(test, details=details)
467
self.failure_count += 1
468
self.report_unexpected_success(test,
469
"".join(details["reason"].iter_text()))
473
def addNotSupported(self, test, feature):
474
"""The test will not be run because of a missing feature.
476
# this can be called in two different ways: it may be that the
477
# test started running, and then raised (through requireFeature)
478
# UnavailableFeature. Alternatively this method can be called
479
# while probing for features before running the test code proper; in
480
# that case we will see startTest and stopTest, but the test will
481
# never actually run.
482
self.unsupported.setdefault(str(feature), 0)
483
self.unsupported[str(feature)] += 1
484
self.report_unsupported(test, feature)
486
def addSkip(self, test, reason):
487
"""A test has not run for 'reason'."""
489
self.report_skip(test, reason)
491
def addNotApplicable(self, test, reason):
492
self.not_applicable_count += 1
493
self.report_not_applicable(test, reason)
495
def _post_mortem(self, tb=None):
496
"""Start a PDB post mortem session."""
497
if os.environ.get('BZR_TEST_PDB', None):
501
def progress(self, offset, whence):
502
"""The test is adjusting the count of tests to run."""
503
if whence == SUBUNIT_SEEK_SET:
504
self.num_tests = offset
505
elif whence == SUBUNIT_SEEK_CUR:
506
self.num_tests += offset
508
raise errors.BzrError("Unknown whence %r" % whence)
510
def report_tests_starting(self):
511
"""Display information before the test run begins"""
512
if getattr(sys, 'frozen', None) is None:
513
bzr_path = osutils.realpath(sys.argv[0])
515
bzr_path = sys.executable
517
'bzr selftest: %s\n' % (bzr_path,))
520
bzrlib.__path__[0],))
522
' bzr-%s python-%s %s\n' % (
523
bzrlib.version_string,
524
bzrlib._format_version_tuple(sys.version_info),
525
platform.platform(aliased=1),
527
self.stream.write('\n')
529
def report_test_start(self, test):
530
"""Display information on the test just about to be run"""
532
def _report_thread_leak(self, test, leaked_threads, active_threads):
533
"""Display information on a test that leaked one or more threads"""
534
# GZ 2010-09-09: A leak summary reported separately from the general
535
# thread debugging would be nice. Tests under subunit
536
# need something not using stream, perhaps adding a
537
# testtools details object would be fitting.
538
if 'threads' in selftest_debug_flags:
539
self.stream.write('%s is leaking, active is now %d\n' %
540
(test.id(), len(active_threads)))
542
def startTestRun(self):
543
self.startTime = time.time()
545
def report_success(self, test):
548
def wasStrictlySuccessful(self):
549
if self.unsupported or self.known_failure_count:
551
return self.wasSuccessful()
554
class TextTestResult(ExtendedTestResult):
555
"""Displays progress and results of tests in text form"""
557
def __init__(self, stream, descriptions, verbosity,
562
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
563
bench_history, strict)
564
# We no longer pass them around, but just rely on the UIFactory stack
567
warnings.warn("Passing pb to TextTestResult is deprecated")
568
self.pb = self.ui.nested_progress_bar()
569
self.pb.show_pct = False
570
self.pb.show_spinner = False
571
self.pb.show_eta = False,
572
self.pb.show_count = False
573
self.pb.show_bar = False
574
self.pb.update_latency = 0
575
self.pb.show_transport_activity = False
577
def stopTestRun(self):
578
# called when the tests that are going to run have run
581
super(TextTestResult, self).stopTestRun()
583
def report_tests_starting(self):
584
super(TextTestResult, self).report_tests_starting()
585
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
587
def _progress_prefix_text(self):
588
# the longer this text, the less space we have to show the test
590
a = '[%d' % self.count # total that have been run
591
# tests skipped as known not to be relevant are not important enough
593
## if self.skip_count:
594
## a += ', %d skip' % self.skip_count
595
## if self.known_failure_count:
596
## a += '+%dX' % self.known_failure_count
598
a +='/%d' % self.num_tests
600
runtime = time.time() - self._overall_start_time
602
a += '%dm%ds' % (runtime / 60, runtime % 60)
605
total_fail_count = self.error_count + self.failure_count
607
a += ', %d failed' % total_fail_count
608
# if self.unsupported:
609
# a += ', %d missing' % len(self.unsupported)
613
def report_test_start(self, test):
615
self._progress_prefix_text()
617
+ self._shortened_test_description(test))
619
def _test_description(self, test):
620
return self._shortened_test_description(test)
622
def report_error(self, test, err):
623
self.stream.write('ERROR: %s\n %s\n' % (
624
self._test_description(test),
628
def report_failure(self, test, err):
629
self.stream.write('FAIL: %s\n %s\n' % (
630
self._test_description(test),
634
def report_known_failure(self, test, err):
637
def report_unexpected_success(self, test, reason):
638
self.stream.write('FAIL: %s\n %s: %s\n' % (
639
self._test_description(test),
640
"Unexpected success. Should have failed",
644
def report_skip(self, test, reason):
647
def report_not_applicable(self, test, reason):
650
def report_unsupported(self, test, feature):
651
"""test cannot be run because feature is missing."""
654
class VerboseTestResult(ExtendedTestResult):
655
"""Produce long output, with one line per test run plus times"""
657
def _ellipsize_to_right(self, a_string, final_width):
658
"""Truncate and pad a string, keeping the right hand side"""
659
if len(a_string) > final_width:
660
result = '...' + a_string[3-final_width:]
663
return result.ljust(final_width)
665
def report_tests_starting(self):
666
self.stream.write('running %d tests...\n' % self.num_tests)
667
super(VerboseTestResult, self).report_tests_starting()
669
def report_test_start(self, test):
670
name = self._shortened_test_description(test)
671
width = osutils.terminal_width()
672
if width is not None:
673
# width needs space for 6 char status, plus 1 for slash, plus an
674
# 11-char time string, plus a trailing blank
675
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
677
self.stream.write(self._ellipsize_to_right(name, width-18))
679
self.stream.write(name)
682
def _error_summary(self, err):
684
return '%s%s' % (indent, err[1])
686
def report_error(self, test, err):
687
self.stream.write('ERROR %s\n%s\n'
688
% (self._testTimeString(test),
689
self._error_summary(err)))
691
def report_failure(self, test, err):
692
self.stream.write(' FAIL %s\n%s\n'
693
% (self._testTimeString(test),
694
self._error_summary(err)))
696
def report_known_failure(self, test, err):
697
self.stream.write('XFAIL %s\n%s\n'
698
% (self._testTimeString(test),
699
self._error_summary(err)))
701
def report_unexpected_success(self, test, reason):
702
self.stream.write(' FAIL %s\n%s: %s\n'
703
% (self._testTimeString(test),
704
"Unexpected success. Should have failed",
707
def report_success(self, test):
708
self.stream.write(' OK %s\n' % self._testTimeString(test))
709
for bench_called, stats in getattr(test, '_benchcalls', []):
710
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
711
stats.pprint(file=self.stream)
712
# flush the stream so that we get smooth output. This verbose mode is
713
# used to show the output in PQM.
716
def report_skip(self, test, reason):
717
self.stream.write(' SKIP %s\n%s\n'
718
% (self._testTimeString(test), reason))
720
def report_not_applicable(self, test, reason):
721
self.stream.write(' N/A %s\n %s\n'
722
% (self._testTimeString(test), reason))
724
def report_unsupported(self, test, feature):
725
"""test cannot be run because feature is missing."""
726
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
727
%(self._testTimeString(test), feature))
215
unittest.TestResult.addFailure(self, test, err)
216
self.extractBenchmarkTime(test)
218
self.stream.writeln(" FAIL %s" % self._testTimeString())
219
elif self.dots and self.pb is None:
220
self.stream.write('F')
222
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
227
def addSuccess(self, test):
228
self.extractBenchmarkTime(test)
230
self.stream.writeln(' OK %s' % self._testTimeString())
231
for bench_called, stats in getattr(test, '_benchcalls', []):
232
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
233
stats.pprint(file=self.stream)
234
elif self.dots and self.pb is None:
235
self.stream.write('~')
237
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
239
unittest.TestResult.addSuccess(self, test)
241
def addSkipped(self, test, skip_excinfo):
242
self.extractBenchmarkTime(test)
244
print >>self.stream, ' SKIP %s' % self._testTimeString()
245
print >>self.stream, ' %s' % skip_excinfo[1]
246
elif self.dots and self.pb is None:
247
self.stream.write('S')
249
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
251
# seems best to treat this as success from point-of-view of unittest
252
# -- it actually does nothing so it barely matters :)
253
unittest.TestResult.addSuccess(self, test)
255
def printErrorList(self, flavour, errors):
256
for test, err in errors:
257
self.stream.writeln(self.separator1)
258
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
259
if getattr(test, '_get_log', None) is not None:
261
print >>self.stream, \
262
('vvvv[log from %s]' % test.id()).ljust(78,'-')
263
print >>self.stream, test._get_log()
264
print >>self.stream, \
265
('^^^^[log from %s]' % test.id()).ljust(78,'-')
266
self.stream.writeln(self.separator2)
267
self.stream.writeln("%s" % err)
730
270
class TextTestRunner(object):
1452
470
path_stat = transport.stat(path)
1453
471
actual_mode = stat.S_IMODE(path_stat.st_mode)
1454
472
self.assertEqual(mode, actual_mode,
1455
'mode of %r incorrect (%s != %s)'
1456
% (path, oct(mode), oct(actual_mode)))
1458
def assertIsSameRealPath(self, path1, path2):
1459
"""Fail if path1 and path2 points to different files"""
1460
self.assertEqual(osutils.realpath(path1),
1461
osutils.realpath(path2),
1462
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1464
def assertIsInstance(self, obj, kls, msg=None):
1465
"""Fail if obj is not an instance of kls
1467
:param msg: Supplementary message to show if the assertion fails.
473
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
475
def assertIsInstance(self, obj, kls):
476
"""Fail if obj is not an instance of kls"""
1469
477
if not isinstance(obj, kls):
1470
m = "%r is an instance of %s rather than %s" % (
1471
obj, obj.__class__, kls)
1476
def assertFileEqual(self, content, path):
1477
"""Fail if path does not contain 'content'."""
1478
self.assertPathExists(path)
1479
f = file(path, 'rb')
1484
self.assertEqualDiff(content, s)
1486
def assertDocstring(self, expected_docstring, obj):
1487
"""Fail if obj does not have expected_docstring"""
1489
# With -OO the docstring should be None instead
1490
self.assertIs(obj.__doc__, None)
1492
self.assertEqual(expected_docstring, obj.__doc__)
1494
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1495
def failUnlessExists(self, path):
1496
return self.assertPathExists(path)
1498
def assertPathExists(self, path):
1499
"""Fail unless path or paths, which may be abs or relative, exist."""
1500
if not isinstance(path, basestring):
1502
self.assertPathExists(p)
1504
self.assertTrue(osutils.lexists(path),
1505
path + " does not exist")
1507
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1508
def failIfExists(self, path):
1509
return self.assertPathDoesNotExist(path)
1511
def assertPathDoesNotExist(self, path):
1512
"""Fail if path or paths, which may be abs or relative, exist."""
1513
if not isinstance(path, basestring):
1515
self.assertPathDoesNotExist(p)
1517
self.assertFalse(osutils.lexists(path),
1520
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1521
"""A helper for callDeprecated and applyDeprecated.
1523
:param a_callable: A callable to call.
1524
:param args: The positional arguments for the callable
1525
:param kwargs: The keyword arguments for the callable
1526
:return: A tuple (warnings, result). result is the result of calling
1527
a_callable(``*args``, ``**kwargs``).
1530
def capture_warnings(msg, cls=None, stacklevel=None):
1531
# we've hooked into a deprecation specific callpath,
1532
# only deprecations should getting sent via it.
1533
self.assertEqual(cls, DeprecationWarning)
1534
local_warnings.append(msg)
1535
original_warning_method = symbol_versioning.warn
1536
symbol_versioning.set_warning_method(capture_warnings)
1538
result = a_callable(*args, **kwargs)
1540
symbol_versioning.set_warning_method(original_warning_method)
1541
return (local_warnings, result)
1543
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1544
"""Call a deprecated callable without warning the user.
1546
Note that this only captures warnings raised by symbol_versioning.warn,
1547
not other callers that go direct to the warning module.
1549
To test that a deprecated method raises an error, do something like
1550
this (remember that both assertRaises and applyDeprecated delays *args
1551
and **kwargs passing)::
1553
self.assertRaises(errors.ReservedId,
1554
self.applyDeprecated,
1555
deprecated_in((1, 5, 0)),
1559
:param deprecation_format: The deprecation format that the callable
1560
should have been deprecated with. This is the same type as the
1561
parameter to deprecated_method/deprecated_function. If the
1562
callable is not deprecated with this format, an assertion error
1564
:param a_callable: A callable to call. This may be a bound method or
1565
a regular function. It will be called with ``*args`` and
1567
:param args: The positional arguments for the callable
1568
:param kwargs: The keyword arguments for the callable
1569
:return: The result of a_callable(``*args``, ``**kwargs``)
1571
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1573
expected_first_warning = symbol_versioning.deprecation_string(
1574
a_callable, deprecation_format)
1575
if len(call_warnings) == 0:
1576
self.fail("No deprecation warning generated by call to %s" %
1578
self.assertEqual(expected_first_warning, call_warnings[0])
1581
def callCatchWarnings(self, fn, *args, **kw):
1582
"""Call a callable that raises python warnings.
1584
The caller's responsible for examining the returned warnings.
1586
If the callable raises an exception, the exception is not
1587
caught and propagates up to the caller. In that case, the list
1588
of warnings is not available.
1590
:returns: ([warning_object, ...], fn_result)
1592
# XXX: This is not perfect, because it completely overrides the
1593
# warnings filters, and some code may depend on suppressing particular
1594
# warnings. It's the easiest way to insulate ourselves from -Werror,
1595
# though. -- Andrew, 20071062
1597
def _catcher(message, category, filename, lineno, file=None, line=None):
1598
# despite the name, 'message' is normally(?) a Warning subclass
1600
wlist.append(message)
1601
saved_showwarning = warnings.showwarning
1602
saved_filters = warnings.filters
1604
warnings.showwarning = _catcher
1605
warnings.filters = []
1606
result = fn(*args, **kw)
1608
warnings.showwarning = saved_showwarning
1609
warnings.filters = saved_filters
1610
return wlist, result
1612
def callDeprecated(self, expected, callable, *args, **kwargs):
1613
"""Assert that a callable is deprecated in a particular way.
1615
This is a very precise test for unusual requirements. The
1616
applyDeprecated helper function is probably more suited for most tests
1617
as it allows you to simply specify the deprecation format being used
1618
and will ensure that that is issued for the function being called.
1620
Note that this only captures warnings raised by symbol_versioning.warn,
1621
not other callers that go direct to the warning module. To catch
1622
general warnings, use callCatchWarnings.
1624
:param expected: a list of the deprecation warnings expected, in order
1625
:param callable: The callable to call
1626
:param args: The positional arguments for the callable
1627
:param kwargs: The keyword arguments for the callable
1629
call_warnings, result = self._capture_deprecation_warnings(callable,
1631
self.assertEqual(expected, call_warnings)
478
self.fail("%r is an instance of %s rather than %s" % (
479
obj, obj.__class__, kls))
1634
481
def _startLogFile(self):
1635
482
"""Send bzr and test log messages to a temporary file.
1637
484
The file is removed as the test is torn down.
1639
pseudo_log_file = StringIO()
1640
def _get_log_contents_for_weird_testtools_api():
1641
return [pseudo_log_file.getvalue().decode(
1642
"utf-8", "replace").encode("utf-8")]
1643
self.addDetail("log", content.Content(content.ContentType("text",
1644
"plain", {"charset": "utf8"}),
1645
_get_log_contents_for_weird_testtools_api))
1646
self._log_file = pseudo_log_file
1647
self._log_memento = trace.push_log_file(self._log_file)
486
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
487
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
488
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
489
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
490
self._log_file_name = name
1648
491
self.addCleanup(self._finishLogFile)
1650
493
def _finishLogFile(self):
1651
494
"""Finished with the log file.
1653
Close the file and delete it, unless setKeepLogfile was called.
1655
if trace._trace_file:
1656
# flush the log file, to get all content
1657
trace._trace_file.flush()
1658
trace.pop_log_file(self._log_memento)
1660
def thisFailsStrictLockCheck(self):
1661
"""It is known that this test would fail with -Dstrict_locks.
1663
By default, all tests are run with strict lock checking unless
1664
-Edisable_lock_checks is supplied. However there are some tests which
1665
we know fail strict locks at this point that have not been fixed.
1666
They should call this function to disable the strict checking.
1668
This should be used sparingly, it is much better to fix the locking
1669
issues rather than papering over the problem by calling this function.
1671
debug.debug_flags.discard('strict_locks')
1673
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1674
"""Overrides an object attribute restoring it after the test.
1676
:param obj: The object that will be mutated.
1678
:param attr_name: The attribute name we want to preserve/override in
1681
:param new: The optional value we want to set the attribute to.
1683
:returns: The actual attr value.
1685
value = getattr(obj, attr_name)
1686
# The actual value is captured by the call below
1687
self.addCleanup(setattr, obj, attr_name, value)
1688
if new is not _unitialized_attr:
1689
setattr(obj, attr_name, new)
1692
def overrideEnv(self, name, new):
1693
"""Set an environment variable, and reset it after the test.
1695
:param name: The environment variable name.
1697
:param new: The value to set the variable to. If None, the
1698
variable is deleted from the environment.
1700
:returns: The actual variable value.
1702
value = osutils.set_or_unset_env(name, new)
1703
self.addCleanup(osutils.set_or_unset_env, name, value)
496
Read contents into memory, close, and delete.
498
bzrlib.trace.disable_test_log(self._log_nonce)
499
self._log_file.seek(0)
500
self._log_contents = self._log_file.read()
501
self._log_file.close()
502
os.remove(self._log_file_name)
503
self._log_file = self._log_file_name = None
505
def addCleanup(self, callable):
506
"""Arrange to run a callable when this case is torn down.
508
Callables are run in the reverse of the order they are registered,
509
ie last-in first-out.
511
if callable in self._cleanups:
512
raise ValueError("cleanup function %r already registered on %s"
514
self._cleanups.append(callable)
1706
516
def _cleanEnvironment(self):
1707
for name, value in isolated_environ.iteritems():
1708
self.overrideEnv(name, value)
1710
def _restoreHooks(self):
1711
for klass, (name, hooks) in self._preserved_hooks.items():
1712
setattr(klass, name, hooks)
1713
self._preserved_hooks.clear()
1714
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1715
self._preserved_lazy_hooks.clear()
1717
def knownFailure(self, reason):
1718
"""This test has failed for some known reason."""
1719
raise KnownFailure(reason)
1721
def _suppress_log(self):
1722
"""Remove the log info from details."""
1723
self.discardDetail('log')
1725
def _do_skip(self, result, reason):
1726
self._suppress_log()
1727
addSkip = getattr(result, 'addSkip', None)
1728
if not callable(addSkip):
1729
result.addSuccess(result)
1731
addSkip(self, reason)
1734
def _do_known_failure(self, result, e):
1735
self._suppress_log()
1736
err = sys.exc_info()
1737
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1738
if addExpectedFailure is not None:
1739
addExpectedFailure(self, err)
1741
result.addSuccess(self)
1744
def _do_not_applicable(self, result, e):
1746
reason = 'No reason given'
1749
self._suppress_log ()
1750
addNotApplicable = getattr(result, 'addNotApplicable', None)
1751
if addNotApplicable is not None:
1752
result.addNotApplicable(self, reason)
1754
self._do_skip(result, reason)
1757
def _report_skip(self, result, err):
1758
"""Override the default _report_skip.
1760
We want to strip the 'log' detail. If we waint until _do_skip, it has
1761
already been formatted into the 'reason' string, and we can't pull it
1764
self._suppress_log()
1765
super(TestCase, self)._report_skip(self, result, err)
1768
def _report_expected_failure(self, result, err):
1771
See _report_skip for motivation.
1773
self._suppress_log()
1774
super(TestCase, self)._report_expected_failure(self, result, err)
1777
def _do_unsupported_or_skip(self, result, e):
1779
self._suppress_log()
1780
addNotSupported = getattr(result, 'addNotSupported', None)
1781
if addNotSupported is not None:
1782
result.addNotSupported(self, reason)
1784
self._do_skip(result, reason)
519
'APPDATA': os.getcwd(),
524
self.addCleanup(self._restoreEnvironment)
525
for name, value in new_env.iteritems():
526
self._captureVar(name, value)
529
def _captureVar(self, name, newvalue):
530
"""Set an environment variable, preparing it to be reset when finished."""
531
self.__old_env[name] = os.environ.get(name, None)
533
if name in os.environ:
536
os.environ[name] = newvalue
539
def _restoreVar(name, value):
541
if name in os.environ:
544
os.environ[name] = value
546
def _restoreEnvironment(self):
547
for name, value in self.__old_env.iteritems():
548
self._restoreVar(name, value)
552
unittest.TestCase.tearDown(self)
1786
554
def time(self, callable, *args, **kwargs):
1787
555
"""Run callable and accrue the time it takes to the benchmark time.
1789
557
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1790
558
this will cause lsprofile statistics to be gathered and stored in
1791
559
self._benchcalls.
1793
561
if self._benchtime is None:
1794
self.addDetail('benchtime', content.Content(content.ContentType(
1795
"text", "plain"), lambda:[str(self._benchtime)]))
1796
562
self._benchtime = 0
1797
563
start = time.time()
2216
720
sys.stderr = real_stderr
2217
721
sys.stdin = real_stdin
2219
def reduceLockdirTimeout(self):
2220
"""Reduce the default lock timeout for the duration of the test, so that
2221
if LockContention occurs during a test, it does so quickly.
2223
Tests that expect to provoke LockContention errors should call this.
2225
self.overrideAttr(lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2227
def make_utf8_encoded_stringio(self, encoding_type=None):
2228
"""Return a StringIOWrapper instance, that will encode Unicode
2231
if encoding_type is None:
2232
encoding_type = 'strict'
2234
output_encoding = 'utf-8'
2235
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2236
sio.encoding = output_encoding
2239
def disable_verb(self, verb):
2240
"""Disable a smart server verb for one test."""
2241
from bzrlib.smart import request
2242
request_handlers = request.request_handlers
2243
orig_method = request_handlers.get(verb)
2244
request_handlers.remove(verb)
2245
self.addCleanup(request_handlers.register, verb, orig_method)
2248
class CapturedCall(object):
2249
"""A helper for capturing smart server calls for easy debug analysis."""
2251
def __init__(self, params, prefix_length):
2252
"""Capture the call with params and skip prefix_length stack frames."""
2255
# The last 5 frames are the __init__, the hook frame, and 3 smart
2256
# client frames. Beyond this we could get more clever, but this is good
2258
stack = traceback.extract_stack()[prefix_length:-5]
2259
self.stack = ''.join(traceback.format_list(stack))
2262
return self.call.method
2265
return self.call.method
2271
class TestCaseWithMemoryTransport(TestCase):
2272
"""Common test class for tests that do not need disk resources.
2274
Tests that need disk resources should derive from TestCaseWithTransport.
2276
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2278
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2279
a directory which does not exist. This serves to help ensure test isolation
2280
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2281
must exist. However, TestCaseWithMemoryTransport does not offer local
2282
file defaults for the transport in tests, nor does it obey the command line
2283
override, so tests that accidentally write to the common directory should
2286
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2287
a .bzr directory that stops us ascending higher into the filesystem.
2293
def __init__(self, methodName='runTest'):
2294
# allow test parameterization after test construction and before test
2295
# execution. Variables that the parameterizer sets need to be
2296
# ones that are not set by setUp, or setUp will trash them.
2297
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2298
self.vfs_transport_factory = default_transport
2299
self.transport_server = None
2300
self.transport_readonly_server = None
2301
self.__vfs_server = None
2303
def get_transport(self, relpath=None):
2304
"""Return a writeable transport.
2306
This transport is for the test scratch space relative to
2309
:param relpath: a path relative to the base url.
2311
t = _mod_transport.get_transport(self.get_url(relpath))
2312
self.assertFalse(t.is_readonly())
2315
def get_readonly_transport(self, relpath=None):
2316
"""Return a readonly transport for the test scratch space
2318
This can be used to test that operations which should only need
2319
readonly access in fact do not try to write.
2321
:param relpath: a path relative to the base url.
2323
t = _mod_transport.get_transport(self.get_readonly_url(relpath))
2324
self.assertTrue(t.is_readonly())
2327
def create_transport_readonly_server(self):
2328
"""Create a transport server from class defined at init.
2330
This is mostly a hook for daughter classes.
2332
return self.transport_readonly_server()
2334
def get_readonly_server(self):
2335
"""Get the server instance for the readonly transport
2337
This is useful for some tests with specific servers to do diagnostics.
2339
if self.__readonly_server is None:
2340
if self.transport_readonly_server is None:
2341
# readonly decorator requested
2342
self.__readonly_server = test_server.ReadonlyServer()
2344
# explicit readonly transport.
2345
self.__readonly_server = self.create_transport_readonly_server()
2346
self.start_server(self.__readonly_server,
2347
self.get_vfs_only_server())
2348
return self.__readonly_server
2350
def get_readonly_url(self, relpath=None):
2351
"""Get a URL for the readonly transport.
2353
This will either be backed by '.' or a decorator to the transport
2354
used by self.get_url()
2355
relpath provides for clients to get a path relative to the base url.
2356
These should only be downwards relative, not upwards.
2358
base = self.get_readonly_server().get_url()
2359
return self._adjust_url(base, relpath)
2361
def get_vfs_only_server(self):
2362
"""Get the vfs only read/write server instance.
2364
This is useful for some tests with specific servers that need
2367
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2368
is no means to override it.
2370
if self.__vfs_server is None:
2371
self.__vfs_server = memory.MemoryServer()
2372
self.start_server(self.__vfs_server)
2373
return self.__vfs_server
2375
def get_server(self):
2376
"""Get the read/write server instance.
2378
This is useful for some tests with specific servers that need
2381
This is built from the self.transport_server factory. If that is None,
2382
then the self.get_vfs_server is returned.
2384
if self.__server is None:
2385
if (self.transport_server is None or self.transport_server is
2386
self.vfs_transport_factory):
2387
self.__server = self.get_vfs_only_server()
2389
# bring up a decorated means of access to the vfs only server.
2390
self.__server = self.transport_server()
2391
self.start_server(self.__server, self.get_vfs_only_server())
2392
return self.__server
2394
def _adjust_url(self, base, relpath):
2395
"""Get a URL (or maybe a path) for the readwrite transport.
2397
This will either be backed by '.' or to an equivalent non-file based
2399
relpath provides for clients to get a path relative to the base url.
2400
These should only be downwards relative, not upwards.
2402
if relpath is not None and relpath != '.':
2403
if not base.endswith('/'):
2405
# XXX: Really base should be a url; we did after all call
2406
# get_url()! But sometimes it's just a path (from
2407
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2408
# to a non-escaped local path.
2409
if base.startswith('./') or base.startswith('/'):
2412
base += urlutils.escape(relpath)
2415
def get_url(self, relpath=None):
2416
"""Get a URL (or maybe a path) for the readwrite transport.
2418
This will either be backed by '.' or to an equivalent non-file based
2420
relpath provides for clients to get a path relative to the base url.
2421
These should only be downwards relative, not upwards.
2423
base = self.get_server().get_url()
2424
return self._adjust_url(base, relpath)
2426
def get_vfs_only_url(self, relpath=None):
2427
"""Get a URL (or maybe a path for the plain old vfs transport.
2429
This will never be a smart protocol. It always has all the
2430
capabilities of the local filesystem, but it might actually be a
2431
MemoryTransport or some other similar virtual filesystem.
2433
This is the backing transport (if any) of the server returned by
2434
get_url and get_readonly_url.
2436
:param relpath: provides for clients to get a path relative to the base
2437
url. These should only be downwards relative, not upwards.
2440
base = self.get_vfs_only_server().get_url()
2441
return self._adjust_url(base, relpath)
2443
def _create_safety_net(self):
2444
"""Make a fake bzr directory.
2446
This prevents any tests propagating up onto the TEST_ROOT directory's
2449
root = TestCaseWithMemoryTransport.TEST_ROOT
2450
bzrdir.BzrDir.create_standalone_workingtree(root)
2452
def _check_safety_net(self):
2453
"""Check that the safety .bzr directory have not been touched.
2455
_make_test_root have created a .bzr directory to prevent tests from
2456
propagating. This method ensures than a test did not leaked.
2458
root = TestCaseWithMemoryTransport.TEST_ROOT
2459
self.permit_url(_mod_transport.get_transport(root).base)
2460
wt = workingtree.WorkingTree.open(root)
2461
last_rev = wt.last_revision()
2462
if last_rev != 'null:':
2463
# The current test have modified the /bzr directory, we need to
2464
# recreate a new one or all the followng tests will fail.
2465
# If you need to inspect its content uncomment the following line
2466
# import pdb; pdb.set_trace()
2467
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2468
self._create_safety_net()
2469
raise AssertionError('%s/.bzr should not be modified' % root)
2471
def _make_test_root(self):
2472
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2473
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2474
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2476
TestCaseWithMemoryTransport.TEST_ROOT = root
2478
self._create_safety_net()
2480
# The same directory is used by all tests, and we're not
2481
# specifically told when all tests are finished. This will do.
2482
atexit.register(_rmtree_temp_dir, root)
2484
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2485
self.addCleanup(self._check_safety_net)
2487
def makeAndChdirToTestDir(self):
2488
"""Create a temporary directories for this one test.
2490
This must set self.test_home_dir and self.test_dir and chdir to
2493
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2495
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2496
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2497
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2498
self.permit_dir(self.test_dir)
2500
def make_branch(self, relpath, format=None):
2501
"""Create a branch on the transport at relpath."""
2502
repo = self.make_repository(relpath, format=format)
2503
return repo.bzrdir.create_branch()
2505
def make_bzrdir(self, relpath, format=None):
2507
# might be a relative or absolute path
2508
maybe_a_url = self.get_url(relpath)
2509
segments = maybe_a_url.rsplit('/', 1)
2510
t = _mod_transport.get_transport(maybe_a_url)
2511
if len(segments) > 1 and segments[-1] not in ('', '.'):
2515
if isinstance(format, basestring):
2516
format = bzrdir.format_registry.make_bzrdir(format)
2517
return format.initialize_on_transport(t)
2518
except errors.UninitializableFormat:
2519
raise TestSkipped("Format %s is not initializable." % format)
2521
def make_repository(self, relpath, shared=False, format=None):
2522
"""Create a repository on our default transport at relpath.
2524
Note that relpath must be a relative path, not a full url.
2526
# FIXME: If you create a remoterepository this returns the underlying
2527
# real format, which is incorrect. Actually we should make sure that
2528
# RemoteBzrDir returns a RemoteRepository.
2529
# maybe mbp 20070410
2530
made_control = self.make_bzrdir(relpath, format=format)
2531
return made_control.create_repository(shared=shared)
2533
def make_smart_server(self, path, backing_server=None):
2534
if backing_server is None:
2535
backing_server = self.get_server()
2536
smart_server = test_server.SmartTCPServer_for_testing()
2537
self.start_server(smart_server, backing_server)
2538
remote_transport = _mod_transport.get_transport(smart_server.get_url()
2540
return remote_transport
2542
def make_branch_and_memory_tree(self, relpath, format=None):
2543
"""Create a branch on the default transport and a MemoryTree for it."""
2544
b = self.make_branch(relpath, format=format)
2545
return memorytree.MemoryTree.create_on_branch(b)
2547
def make_branch_builder(self, relpath, format=None):
2548
branch = self.make_branch(relpath, format=format)
2549
return branchbuilder.BranchBuilder(branch=branch)
2551
def overrideEnvironmentForTesting(self):
2552
test_home_dir = self.test_home_dir
2553
if isinstance(test_home_dir, unicode):
2554
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2555
self.overrideEnv('HOME', test_home_dir)
2556
self.overrideEnv('BZR_HOME', test_home_dir)
2559
super(TestCaseWithMemoryTransport, self).setUp()
2560
# Ensure that ConnectedTransport doesn't leak sockets
2561
def get_transport_with_cleanup(*args, **kwargs):
2562
t = orig_get_transport(*args, **kwargs)
2563
if isinstance(t, _mod_transport.ConnectedTransport):
2564
self.addCleanup(t.disconnect)
2567
orig_get_transport = self.overrideAttr(_mod_transport, 'get_transport',
2568
get_transport_with_cleanup)
2569
self._make_test_root()
2570
self.addCleanup(os.chdir, os.getcwdu())
2571
self.makeAndChdirToTestDir()
2572
self.overrideEnvironmentForTesting()
2573
self.__readonly_server = None
2574
self.__server = None
2575
self.reduceLockdirTimeout()
2577
def setup_smart_server_with_call_log(self):
2578
"""Sets up a smart server as the transport server with a call log."""
2579
self.transport_server = test_server.SmartTCPServer_for_testing
2580
self.hpss_calls = []
2582
# Skip the current stack down to the caller of
2583
# setup_smart_server_with_call_log
2584
prefix_length = len(traceback.extract_stack()) - 2
2585
def capture_hpss_call(params):
2586
self.hpss_calls.append(
2587
CapturedCall(params, prefix_length))
2588
client._SmartClient.hooks.install_named_hook(
2589
'call', capture_hpss_call, None)
2591
def reset_smart_call_log(self):
2592
self.hpss_calls = []
2595
class TestCaseInTempDir(TestCaseWithMemoryTransport):
723
def merge(self, branch_from, wt_to):
724
"""A helper for tests to do a ui-less merge.
726
This should move to the main library when someone has time to integrate
729
# minimal ui-less merge.
730
wt_to.branch.fetch(branch_from)
731
base_rev = common_ancestor(branch_from.last_revision(),
732
wt_to.branch.last_revision(),
733
wt_to.branch.repository)
734
merge_inner(wt_to.branch, branch_from.basis_tree(),
735
wt_to.branch.repository.revision_tree(base_rev),
737
wt_to.add_pending_merge(branch_from.last_revision())
740
BzrTestBase = TestCase
743
class TestCaseInTempDir(TestCase):
2596
744
"""Derived class that runs a test within a temporary directory.
2598
746
This is useful for tests that need to create a branch, etc.
2858
1033
for readonly urls.
2860
1035
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2861
be used without needed to redo it when a different
1036
be used without needed to redo it when a different
2862
1037
subclass is in use ?
2865
1040
def setUp(self):
2866
from bzrlib.tests import http_server
2867
1041
super(ChrootedTestCase, self).setUp()
2868
if not self.vfs_transport_factory == memory.MemoryServer:
2869
self.transport_readonly_server = http_server.HttpServer
2872
def condition_id_re(pattern):
2873
"""Create a condition filter which performs a re check on a test's id.
2875
:param pattern: A regular expression string.
2876
:return: A callable that returns True if the re matches.
2878
filter_re = re.compile(pattern, 0)
2879
def condition(test):
2881
return filter_re.search(test_id)
2885
def condition_isinstance(klass_or_klass_list):
2886
"""Create a condition filter which returns isinstance(param, klass).
2888
:return: A callable which when called with one parameter obj return the
2889
result of isinstance(obj, klass_or_klass_list).
2892
return isinstance(obj, klass_or_klass_list)
2896
def condition_id_in_list(id_list):
2897
"""Create a condition filter which verify that test's id in a list.
2899
:param id_list: A TestIdList object.
2900
:return: A callable that returns True if the test's id appears in the list.
2902
def condition(test):
2903
return id_list.includes(test.id())
2907
def condition_id_startswith(starts):
2908
"""Create a condition filter verifying that test's id starts with a string.
2910
:param starts: A list of string.
2911
:return: A callable that returns True if the test's id starts with one of
2914
def condition(test):
2915
for start in starts:
2916
if test.id().startswith(start):
2922
def exclude_tests_by_condition(suite, condition):
2923
"""Create a test suite which excludes some tests from suite.
2925
:param suite: The suite to get tests from.
2926
:param condition: A callable whose result evaluates True when called with a
2927
test case which should be excluded from the result.
2928
:return: A suite which contains the tests found in suite that fail
2932
for test in iter_suite_tests(suite):
2933
if not condition(test):
2935
return TestUtil.TestSuite(result)
2938
def filter_suite_by_condition(suite, condition):
2939
"""Create a test suite by filtering another one.
2941
:param suite: The source suite.
2942
:param condition: A callable whose result evaluates True when called with a
2943
test case which should be included in the result.
2944
:return: A suite which contains the tests found in suite that pass
2948
for test in iter_suite_tests(suite):
2951
return TestUtil.TestSuite(result)
1042
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1043
self.transport_readonly_server = bzrlib.transport.http.HttpServer
2954
1046
def filter_suite_by_re(suite, pattern):
2955
"""Create a test suite by filtering another one.
2957
:param suite: the source suite
2958
:param pattern: pattern that names must match
2959
:returns: the newly created suite
2961
condition = condition_id_re(pattern)
2962
result_suite = filter_suite_by_condition(suite, condition)
2966
def filter_suite_by_id_list(suite, test_id_list):
2967
"""Create a test suite by filtering another one.
2969
:param suite: The source suite.
2970
:param test_id_list: A list of the test ids to keep as strings.
2971
:returns: the newly created suite
2973
condition = condition_id_in_list(test_id_list)
2974
result_suite = filter_suite_by_condition(suite, condition)
2978
def filter_suite_by_id_startswith(suite, start):
2979
"""Create a test suite by filtering another one.
2981
:param suite: The source suite.
2982
:param start: A list of string the test id must start with one of.
2983
:returns: the newly created suite
2985
condition = condition_id_startswith(start)
2986
result_suite = filter_suite_by_condition(suite, condition)
2990
def exclude_tests_by_re(suite, pattern):
2991
"""Create a test suite which excludes some tests from suite.
2993
:param suite: The suite to get tests from.
2994
:param pattern: A regular expression string. Test ids that match this
2995
pattern will be excluded from the result.
2996
:return: A TestSuite that contains all the tests from suite without the
2997
tests that matched pattern. The order of tests is the same as it was in
3000
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3003
def preserve_input(something):
3004
"""A helper for performing test suite transformation chains.
3006
:param something: Anything you want to preserve.
3012
def randomize_suite(suite):
3013
"""Return a new TestSuite with suite's tests in random order.
3015
The tests in the input suite are flattened into a single suite in order to
3016
accomplish this. Any nested TestSuites are removed to provide global
3019
tests = list(iter_suite_tests(suite))
3020
random.shuffle(tests)
3021
return TestUtil.TestSuite(tests)
3024
def split_suite_by_condition(suite, condition):
3025
"""Split a test suite into two by a condition.
3027
:param suite: The suite to split.
3028
:param condition: The condition to match on. Tests that match this
3029
condition are returned in the first test suite, ones that do not match
3030
are in the second suite.
3031
:return: A tuple of two test suites, where the first contains tests from
3032
suite matching the condition, and the second contains the remainder
3033
from suite. The order within each output suite is the same as it was in
1047
result = TestSuite()
1048
filter_re = re.compile(pattern)
3038
1049
for test in iter_suite_tests(suite):
3040
matched.append(test)
3042
did_not_match.append(test)
3043
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3046
def split_suite_by_re(suite, pattern):
3047
"""Split a test suite into two by a regular expression.
3049
:param suite: The suite to split.
3050
:param pattern: A regular expression string. Test ids that match this
3051
pattern will be in the first test suite returned, and the others in the
3052
second test suite returned.
3053
:return: A tuple of two test suites, where the first contains tests from
3054
suite matching pattern, and the second contains the remainder from
3055
suite. The order within each output suite is the same as it was in
3058
return split_suite_by_condition(suite, condition_id_re(pattern))
1050
if filter_re.search(test.id()):
1051
result.addTest(test)
3061
1055
def run_suite(suite, name='test', verbose=False, pattern=".*",
3062
stop_on_failure=False,
3063
transport=None, lsprof_timed=None, bench_history=None,
3064
matching_tests_first=None,
3067
exclude_pattern=None,
3070
suite_decorators=None,
3072
result_decorators=None,
3074
"""Run a test suite for bzr selftest.
3076
:param runner_class: The class of runner to use. Must support the
3077
constructor arguments passed by run_suite which are more than standard
3079
:return: A boolean indicating success.
1056
stop_on_failure=False, keep_output=False,
1057
transport=None, lsprof_timed=None):
1058
TestCaseInTempDir._TEST_NAME = name
3081
1059
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3086
if runner_class is None:
3087
runner_class = TextTestRunner
3090
runner = runner_class(stream=stream,
1065
pb = progress.ProgressBar()
1066
runner = TextTestRunner(stream=sys.stdout,
3091
1067
descriptions=0,
3092
1068
verbosity=verbosity,
3093
bench_history=bench_history,
3095
result_decorators=result_decorators,
1069
keep_output=keep_output,
3097
1071
runner.stop_on_failure=stop_on_failure
3098
# built in decorator factories:
3100
random_order(random_seed, runner),
3101
exclude_tests(exclude_pattern),
3103
if matching_tests_first:
3104
decorators.append(tests_first(pattern))
3106
decorators.append(filter_tests(pattern))
3107
if suite_decorators:
3108
decorators.extend(suite_decorators)
3109
# tell the result object how many tests will be running: (except if
3110
# --parallel=fork is being used. Robert said he will provide a better
3111
# progress design later -- vila 20090817)
3112
if fork_decorator not in decorators:
3113
decorators.append(CountingDecorator)
3114
for decorator in decorators:
3115
suite = decorator(suite)
3117
# Done after test suite decoration to allow randomisation etc
3118
# to take effect, though that is of marginal benefit.
3120
stream.write("Listing tests only ...\n")
3121
for t in iter_suite_tests(suite):
3122
stream.write("%s\n" % (t.id()))
1073
suite = filter_suite_by_re(suite, pattern)
3124
1074
result = runner.run(suite)
3126
return result.wasStrictlySuccessful()
3128
return result.wasSuccessful()
3131
# A registry where get() returns a suite decorator.
3132
parallel_registry = registry.Registry()
3135
def fork_decorator(suite):
3136
if getattr(os, "fork", None) is None:
3137
raise errors.BzrCommandError("platform does not support fork,"
3138
" try --parallel=subprocess instead.")
3139
concurrency = osutils.local_concurrency()
3140
if concurrency == 1:
3142
from testtools import ConcurrentTestSuite
3143
return ConcurrentTestSuite(suite, fork_for_tests)
3144
parallel_registry.register('fork', fork_decorator)
3147
def subprocess_decorator(suite):
3148
concurrency = osutils.local_concurrency()
3149
if concurrency == 1:
3151
from testtools import ConcurrentTestSuite
3152
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3153
parallel_registry.register('subprocess', subprocess_decorator)
3156
def exclude_tests(exclude_pattern):
3157
"""Return a test suite decorator that excludes tests."""
3158
if exclude_pattern is None:
3159
return identity_decorator
3160
def decorator(suite):
3161
return ExcludeDecorator(suite, exclude_pattern)
3165
def filter_tests(pattern):
3167
return identity_decorator
3168
def decorator(suite):
3169
return FilterTestsDecorator(suite, pattern)
3173
def random_order(random_seed, runner):
3174
"""Return a test suite decorator factory for randomising tests order.
3176
:param random_seed: now, a string which casts to a long, or a long.
3177
:param runner: A test runner with a stream attribute to report on.
3179
if random_seed is None:
3180
return identity_decorator
3181
def decorator(suite):
3182
return RandomDecorator(suite, random_seed, runner.stream)
3186
def tests_first(pattern):
3188
return identity_decorator
3189
def decorator(suite):
3190
return TestFirstDecorator(suite, pattern)
3194
def identity_decorator(suite):
3199
class TestDecorator(TestUtil.TestSuite):
3200
"""A decorator for TestCase/TestSuite objects.
3202
Usually, subclasses should override __iter__(used when flattening test
3203
suites), which we do to filter, reorder, parallelise and so on, run() and
3207
def __init__(self, suite):
3208
TestUtil.TestSuite.__init__(self)
3211
def countTestCases(self):
3214
cases += test.countTestCases()
3221
def run(self, result):
3222
# Use iteration on self, not self._tests, to allow subclasses to hook
3225
if result.shouldStop:
3231
class CountingDecorator(TestDecorator):
3232
"""A decorator which calls result.progress(self.countTestCases)."""
3234
def run(self, result):
3235
progress_method = getattr(result, 'progress', None)
3236
if callable(progress_method):
3237
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3238
return super(CountingDecorator, self).run(result)
3241
class ExcludeDecorator(TestDecorator):
3242
"""A decorator which excludes test matching an exclude pattern."""
3244
def __init__(self, suite, exclude_pattern):
3245
TestDecorator.__init__(self, suite)
3246
self.exclude_pattern = exclude_pattern
3247
self.excluded = False
3251
return iter(self._tests)
3252
self.excluded = True
3253
suite = exclude_tests_by_re(self, self.exclude_pattern)
3255
self.addTests(suite)
3256
return iter(self._tests)
3259
class FilterTestsDecorator(TestDecorator):
3260
"""A decorator which filters tests to those matching a pattern."""
3262
def __init__(self, suite, pattern):
3263
TestDecorator.__init__(self, suite)
3264
self.pattern = pattern
3265
self.filtered = False
3269
return iter(self._tests)
3270
self.filtered = True
3271
suite = filter_suite_by_re(self, self.pattern)
3273
self.addTests(suite)
3274
return iter(self._tests)
3277
class RandomDecorator(TestDecorator):
3278
"""A decorator which randomises the order of its tests."""
3280
def __init__(self, suite, random_seed, stream):
3281
TestDecorator.__init__(self, suite)
3282
self.random_seed = random_seed
3283
self.randomised = False
3284
self.stream = stream
3288
return iter(self._tests)
3289
self.randomised = True
3290
self.stream.write("Randomizing test order using seed %s\n\n" %
3291
(self.actual_seed()))
3292
# Initialise the random number generator.
3293
random.seed(self.actual_seed())
3294
suite = randomize_suite(self)
3296
self.addTests(suite)
3297
return iter(self._tests)
3299
def actual_seed(self):
3300
if self.random_seed == "now":
3301
# We convert the seed to a long to make it reuseable across
3302
# invocations (because the user can reenter it).
3303
self.random_seed = long(time.time())
3305
# Convert the seed to a long if we can
3307
self.random_seed = long(self.random_seed)
3310
return self.random_seed
3313
class TestFirstDecorator(TestDecorator):
3314
"""A decorator which moves named tests to the front."""
3316
def __init__(self, suite, pattern):
3317
TestDecorator.__init__(self, suite)
3318
self.pattern = pattern
3319
self.filtered = False
3323
return iter(self._tests)
3324
self.filtered = True
3325
suites = split_suite_by_re(self, self.pattern)
3327
self.addTests(suites)
3328
return iter(self._tests)
3331
def partition_tests(suite, count):
3332
"""Partition suite into count lists of tests."""
3333
# This just assigns tests in a round-robin fashion. On one hand this
3334
# splits up blocks of related tests that might run faster if they shared
3335
# resources, but on the other it avoids assigning blocks of slow tests to
3336
# just one partition. So the slowest partition shouldn't be much slower
3338
partitions = [list() for i in range(count)]
3339
tests = iter_suite_tests(suite)
3340
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3341
partition.append(test)
3345
def workaround_zealous_crypto_random():
3346
"""Crypto.Random want to help us being secure, but we don't care here.
3348
This workaround some test failure related to the sftp server. Once paramiko
3349
stop using the controversial API in Crypto.Random, we may get rid of it.
3352
from Crypto.Random import atfork
3358
def fork_for_tests(suite):
3359
"""Take suite and start up one runner per CPU by forking()
3361
:return: An iterable of TestCase-like objects which can each have
3362
run(result) called on them to feed tests to result.
3364
concurrency = osutils.local_concurrency()
3366
from subunit import TestProtocolClient, ProtocolTestCase
3367
from subunit.test_results import AutoTimingTestResultDecorator
3368
class TestInOtherProcess(ProtocolTestCase):
3369
# Should be in subunit, I think. RBC.
3370
def __init__(self, stream, pid):
3371
ProtocolTestCase.__init__(self, stream)
3374
def run(self, result):
3376
ProtocolTestCase.run(self, result)
3378
os.waitpid(self.pid, 0)
3380
test_blocks = partition_tests(suite, concurrency)
3381
for process_tests in test_blocks:
3382
process_suite = TestUtil.TestSuite()
3383
process_suite.addTests(process_tests)
3384
c2pread, c2pwrite = os.pipe()
3387
workaround_zealous_crypto_random()
3390
# Leave stderr and stdout open so we can see test noise
3391
# Close stdin so that the child goes away if it decides to
3392
# read from stdin (otherwise its a roulette to see what
3393
# child actually gets keystrokes for pdb etc).
3396
stream = os.fdopen(c2pwrite, 'wb', 1)
3397
subunit_result = AutoTimingTestResultDecorator(
3398
TestProtocolClient(stream))
3399
process_suite.run(subunit_result)
3404
stream = os.fdopen(c2pread, 'rb', 1)
3405
test = TestInOtherProcess(stream, pid)
3410
def reinvoke_for_tests(suite):
3411
"""Take suite and start up one runner per CPU using subprocess().
3413
:return: An iterable of TestCase-like objects which can each have
3414
run(result) called on them to feed tests to result.
3416
concurrency = osutils.local_concurrency()
3418
from subunit import ProtocolTestCase
3419
class TestInSubprocess(ProtocolTestCase):
3420
def __init__(self, process, name):
3421
ProtocolTestCase.__init__(self, process.stdout)
3422
self.process = process
3423
self.process.stdin.close()
3426
def run(self, result):
3428
ProtocolTestCase.run(self, result)
3431
os.unlink(self.name)
3432
# print "pid %d finished" % finished_process
3433
test_blocks = partition_tests(suite, concurrency)
3434
for process_tests in test_blocks:
3435
# ugly; currently reimplement rather than reuses TestCase methods.
3436
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3437
if not os.path.isfile(bzr_path):
3438
# We are probably installed. Assume sys.argv is the right file
3439
bzr_path = sys.argv[0]
3440
bzr_path = [bzr_path]
3441
if sys.platform == "win32":
3442
# if we're on windows, we can't execute the bzr script directly
3443
bzr_path = [sys.executable] + bzr_path
3444
fd, test_list_file_name = tempfile.mkstemp()
3445
test_list_file = os.fdopen(fd, 'wb', 1)
3446
for test in process_tests:
3447
test_list_file.write(test.id() + '\n')
3448
test_list_file.close()
3450
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3452
if '--no-plugins' in sys.argv:
3453
argv.append('--no-plugins')
3454
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3455
# noise on stderr it can interrupt the subunit protocol.
3456
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3457
stdout=subprocess.PIPE,
3458
stderr=subprocess.PIPE,
3460
test = TestInSubprocess(process, test_list_file_name)
3463
os.unlink(test_list_file_name)
3468
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3469
"""Generate profiling data for all activity between start and success.
3471
The profile data is appended to the test's _benchcalls attribute and can
3472
be accessed by the forwarded-to TestResult.
3474
While it might be cleaner do accumulate this in stopTest, addSuccess is
3475
where our existing output support for lsprof is, and this class aims to
3476
fit in with that: while it could be moved it's not necessary to accomplish
3477
test profiling, nor would it be dramatically cleaner.
3480
def startTest(self, test):
3481
self.profiler = bzrlib.lsprof.BzrProfiler()
3482
# Prevent deadlocks in tests that use lsprof: those tests will
3484
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3485
self.profiler.start()
3486
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3488
def addSuccess(self, test):
3489
stats = self.profiler.stop()
3491
calls = test._benchcalls
3492
except AttributeError:
3493
test._benchcalls = []
3494
calls = test._benchcalls
3495
calls.append(((test.id(), "", ""), stats))
3496
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3498
def stopTest(self, test):
3499
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3500
self.profiler = None
3503
# Controlled by "bzr selftest -E=..." option
3504
# Currently supported:
3505
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3506
# preserves any flags supplied at the command line.
3507
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3508
# rather than failing tests. And no longer raise
3509
# LockContention when fctnl locks are not being used
3510
# with proper exclusion rules.
3511
# -Ethreads Will display thread ident at creation/join time to
3512
# help track thread leaks
3513
selftest_debug_flags = set()
1075
return result.wasSuccessful()
3516
1078
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3517
1080
transport=None,
3518
1081
test_suite_factory=None,
3521
matching_tests_first=None,
3524
exclude_pattern=None,
3530
suite_decorators=None,
3534
1083
"""Run the whole test suite under the enhanced runner"""
3535
# XXX: Very ugly way to do this...
3536
# Disable warning about old formats because we don't want it to disturb
3537
# any blackbox tests.
3538
from bzrlib import repository
3539
repository._deprecation_warning_done = True
3541
1084
global default_transport
3542
1085
if transport is None:
3543
1086
transport = default_transport
3544
1087
old_transport = default_transport
3545
1088
default_transport = transport
3546
global selftest_debug_flags
3547
old_debug_flags = selftest_debug_flags
3548
if debug_flags is not None:
3549
selftest_debug_flags = set(debug_flags)
3551
if load_list is None:
3554
keep_only = load_test_id_list(load_list)
3556
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3557
for start in starting_with]
3558
1090
if test_suite_factory is None:
3559
# Reduce loading time by loading modules based on the starting_with
3561
suite = test_suite(keep_only, starting_with)
1091
suite = test_suite()
3563
1093
suite = test_suite_factory()
3565
# But always filter as requested.
3566
suite = filter_suite_by_id_startswith(suite, starting_with)
3567
result_decorators = []
3569
result_decorators.append(ProfileResult)
3570
1094
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3571
stop_on_failure=stop_on_failure,
1095
stop_on_failure=stop_on_failure, keep_output=keep_output,
3572
1096
transport=transport,
3573
lsprof_timed=lsprof_timed,
3574
bench_history=bench_history,
3575
matching_tests_first=matching_tests_first,
3576
list_only=list_only,
3577
random_seed=random_seed,
3578
exclude_pattern=exclude_pattern,
3580
runner_class=runner_class,
3581
suite_decorators=suite_decorators,
3583
result_decorators=result_decorators,
1097
lsprof_timed=lsprof_timed)
3586
1099
default_transport = old_transport
3587
selftest_debug_flags = old_debug_flags
3590
def load_test_id_list(file_name):
3591
"""Load a test id list from a text file.
3593
The format is one test id by line. No special care is taken to impose
3594
strict rules, these test ids are used to filter the test suite so a test id
3595
that do not match an existing test will do no harm. This allows user to add
3596
comments, leave blank lines, etc.
3600
ftest = open(file_name, 'rt')
3602
if e.errno != errno.ENOENT:
3605
raise errors.NoSuchFile(file_name)
3607
for test_name in ftest.readlines():
3608
test_list.append(test_name.strip())
3613
def suite_matches_id_list(test_suite, id_list):
3614
"""Warns about tests not appearing or appearing more than once.
3616
:param test_suite: A TestSuite object.
3617
:param test_id_list: The list of test ids that should be found in
3620
:return: (absents, duplicates) absents is a list containing the test found
3621
in id_list but not in test_suite, duplicates is a list containing the
3622
test found multiple times in test_suite.
3624
When using a prefined test id list, it may occurs that some tests do not
3625
exist anymore or that some tests use the same id. This function warns the
3626
tester about potential problems in his workflow (test lists are volatile)
3627
or in the test suite itself (using the same id for several tests does not
3628
help to localize defects).
3630
# Build a dict counting id occurrences
3632
for test in iter_suite_tests(test_suite):
3634
tests[id] = tests.get(id, 0) + 1
3639
occurs = tests.get(id, 0)
3641
not_found.append(id)
3643
duplicates.append(id)
3645
return not_found, duplicates
3648
class TestIdList(object):
3649
"""Test id list to filter a test suite.
3651
Relying on the assumption that test ids are built as:
3652
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3653
notation, this class offers methods to :
3654
- avoid building a test suite for modules not refered to in the test list,
3655
- keep only the tests listed from the module test suite.
3658
def __init__(self, test_id_list):
3659
# When a test suite needs to be filtered against us we compare test ids
3660
# for equality, so a simple dict offers a quick and simple solution.
3661
self.tests = dict().fromkeys(test_id_list, True)
3663
# While unittest.TestCase have ids like:
3664
# <module>.<class>.<method>[(<param+)],
3665
# doctest.DocTestCase can have ids like:
3668
# <module>.<function>
3669
# <module>.<class>.<method>
3671
# Since we can't predict a test class from its name only, we settle on
3672
# a simple constraint: a test id always begins with its module name.
3675
for test_id in test_id_list:
3676
parts = test_id.split('.')
3677
mod_name = parts.pop(0)
3678
modules[mod_name] = True
3680
mod_name += '.' + part
3681
modules[mod_name] = True
3682
self.modules = modules
3684
def refers_to(self, module_name):
3685
"""Is there tests for the module or one of its sub modules."""
3686
return self.modules.has_key(module_name)
3688
def includes(self, test_id):
3689
return self.tests.has_key(test_id)
3692
class TestPrefixAliasRegistry(registry.Registry):
3693
"""A registry for test prefix aliases.
3695
This helps implement shorcuts for the --starting-with selftest
3696
option. Overriding existing prefixes is not allowed but not fatal (a
3697
warning will be emitted).
3700
def register(self, key, obj, help=None, info=None,
3701
override_existing=False):
3702
"""See Registry.register.
3704
Trying to override an existing alias causes a warning to be emitted,
3705
not a fatal execption.
3708
super(TestPrefixAliasRegistry, self).register(
3709
key, obj, help=help, info=info, override_existing=False)
3711
actual = self.get(key)
3713
'Test prefix alias %s is already used for %s, ignoring %s'
3714
% (key, actual, obj))
3716
def resolve_alias(self, id_start):
3717
"""Replace the alias by the prefix in the given string.
3719
Using an unknown prefix is an error to help catching typos.
3721
parts = id_start.split('.')
3723
parts[0] = self.get(parts[0])
3725
raise errors.BzrCommandError(
3726
'%s is not a known test prefix alias' % parts[0])
3727
return '.'.join(parts)
3730
test_prefix_alias_registry = TestPrefixAliasRegistry()
3731
"""Registry of test prefix aliases."""
3734
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3735
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3736
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3738
# Obvious highest levels prefixes, feel free to add your own via a plugin
3739
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3740
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3741
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3742
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3743
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3746
def _test_suite_testmod_names():
3747
"""Return the standard list of test module names to test."""
3750
'bzrlib.tests.blackbox',
3751
'bzrlib.tests.commands',
3752
'bzrlib.tests.doc_generate',
3753
'bzrlib.tests.per_branch',
3754
'bzrlib.tests.per_bzrdir',
3755
'bzrlib.tests.per_controldir',
3756
'bzrlib.tests.per_controldir_colo',
3757
'bzrlib.tests.per_foreign_vcs',
3758
'bzrlib.tests.per_interrepository',
3759
'bzrlib.tests.per_intertree',
3760
'bzrlib.tests.per_inventory',
3761
'bzrlib.tests.per_interbranch',
3762
'bzrlib.tests.per_lock',
3763
'bzrlib.tests.per_merger',
3764
'bzrlib.tests.per_transport',
3765
'bzrlib.tests.per_tree',
3766
'bzrlib.tests.per_pack_repository',
3767
'bzrlib.tests.per_repository',
3768
'bzrlib.tests.per_repository_chk',
3769
'bzrlib.tests.per_repository_reference',
3770
'bzrlib.tests.per_repository_vf',
3771
'bzrlib.tests.per_uifactory',
3772
'bzrlib.tests.per_versionedfile',
3773
'bzrlib.tests.per_workingtree',
3774
'bzrlib.tests.test__annotator',
3775
'bzrlib.tests.test__bencode',
3776
'bzrlib.tests.test__btree_serializer',
3777
'bzrlib.tests.test__chk_map',
3778
'bzrlib.tests.test__dirstate_helpers',
3779
'bzrlib.tests.test__groupcompress',
3780
'bzrlib.tests.test__known_graph',
3781
'bzrlib.tests.test__rio',
3782
'bzrlib.tests.test__simple_set',
3783
'bzrlib.tests.test__static_tuple',
3784
'bzrlib.tests.test__walkdirs_win32',
3785
'bzrlib.tests.test_ancestry',
3786
'bzrlib.tests.test_annotate',
3787
'bzrlib.tests.test_api',
3788
'bzrlib.tests.test_atomicfile',
3789
'bzrlib.tests.test_bad_files',
3790
'bzrlib.tests.test_bisect_multi',
3791
'bzrlib.tests.test_branch',
3792
'bzrlib.tests.test_branchbuilder',
3793
'bzrlib.tests.test_btree_index',
3794
'bzrlib.tests.test_bugtracker',
3795
'bzrlib.tests.test_bundle',
3796
'bzrlib.tests.test_bzrdir',
3797
'bzrlib.tests.test__chunks_to_lines',
3798
'bzrlib.tests.test_cache_utf8',
3799
'bzrlib.tests.test_chk_map',
3800
'bzrlib.tests.test_chk_serializer',
3801
'bzrlib.tests.test_chunk_writer',
3802
'bzrlib.tests.test_clean_tree',
3803
'bzrlib.tests.test_cleanup',
3804
'bzrlib.tests.test_cmdline',
3805
'bzrlib.tests.test_commands',
3806
'bzrlib.tests.test_commit',
3807
'bzrlib.tests.test_commit_merge',
3808
'bzrlib.tests.test_config',
3809
'bzrlib.tests.test_conflicts',
3810
'bzrlib.tests.test_controldir',
3811
'bzrlib.tests.test_counted_lock',
3812
'bzrlib.tests.test_crash',
3813
'bzrlib.tests.test_decorators',
3814
'bzrlib.tests.test_delta',
3815
'bzrlib.tests.test_debug',
3816
'bzrlib.tests.test_diff',
3817
'bzrlib.tests.test_directory_service',
3818
'bzrlib.tests.test_dirstate',
3819
'bzrlib.tests.test_email_message',
3820
'bzrlib.tests.test_eol_filters',
3821
'bzrlib.tests.test_errors',
3822
'bzrlib.tests.test_export',
3823
'bzrlib.tests.test_export_pot',
3824
'bzrlib.tests.test_extract',
3825
'bzrlib.tests.test_fetch',
3826
'bzrlib.tests.test_fixtures',
3827
'bzrlib.tests.test_fifo_cache',
3828
'bzrlib.tests.test_filters',
3829
'bzrlib.tests.test_ftp_transport',
3830
'bzrlib.tests.test_foreign',
3831
'bzrlib.tests.test_generate_docs',
3832
'bzrlib.tests.test_generate_ids',
3833
'bzrlib.tests.test_globbing',
3834
'bzrlib.tests.test_gpg',
3835
'bzrlib.tests.test_graph',
3836
'bzrlib.tests.test_groupcompress',
3837
'bzrlib.tests.test_hashcache',
3838
'bzrlib.tests.test_help',
3839
'bzrlib.tests.test_hooks',
3840
'bzrlib.tests.test_http',
3841
'bzrlib.tests.test_http_response',
3842
'bzrlib.tests.test_https_ca_bundle',
3843
'bzrlib.tests.test_i18n',
3844
'bzrlib.tests.test_identitymap',
3845
'bzrlib.tests.test_ignores',
3846
'bzrlib.tests.test_index',
3847
'bzrlib.tests.test_import_tariff',
3848
'bzrlib.tests.test_info',
3849
'bzrlib.tests.test_inv',
3850
'bzrlib.tests.test_inventory_delta',
3851
'bzrlib.tests.test_knit',
3852
'bzrlib.tests.test_lazy_import',
3853
'bzrlib.tests.test_lazy_regex',
3854
'bzrlib.tests.test_library_state',
3855
'bzrlib.tests.test_lock',
3856
'bzrlib.tests.test_lockable_files',
3857
'bzrlib.tests.test_lockdir',
3858
'bzrlib.tests.test_log',
3859
'bzrlib.tests.test_lru_cache',
3860
'bzrlib.tests.test_lsprof',
3861
'bzrlib.tests.test_mail_client',
3862
'bzrlib.tests.test_matchers',
3863
'bzrlib.tests.test_memorytree',
3864
'bzrlib.tests.test_merge',
3865
'bzrlib.tests.test_merge3',
3866
'bzrlib.tests.test_merge_core',
3867
'bzrlib.tests.test_merge_directive',
3868
'bzrlib.tests.test_mergetools',
3869
'bzrlib.tests.test_missing',
3870
'bzrlib.tests.test_msgeditor',
3871
'bzrlib.tests.test_multiparent',
3872
'bzrlib.tests.test_mutabletree',
3873
'bzrlib.tests.test_nonascii',
3874
'bzrlib.tests.test_options',
3875
'bzrlib.tests.test_osutils',
3876
'bzrlib.tests.test_osutils_encodings',
3877
'bzrlib.tests.test_pack',
3878
'bzrlib.tests.test_patch',
3879
'bzrlib.tests.test_patches',
3880
'bzrlib.tests.test_permissions',
3881
'bzrlib.tests.test_plugins',
3882
'bzrlib.tests.test_progress',
3883
'bzrlib.tests.test_pyutils',
3884
'bzrlib.tests.test_read_bundle',
3885
'bzrlib.tests.test_reconcile',
3886
'bzrlib.tests.test_reconfigure',
3887
'bzrlib.tests.test_registry',
3888
'bzrlib.tests.test_remote',
3889
'bzrlib.tests.test_rename_map',
3890
'bzrlib.tests.test_repository',
3891
'bzrlib.tests.test_revert',
3892
'bzrlib.tests.test_revision',
3893
'bzrlib.tests.test_revisionspec',
3894
'bzrlib.tests.test_revisiontree',
3895
'bzrlib.tests.test_rio',
3896
'bzrlib.tests.test_rules',
3897
'bzrlib.tests.test_sampler',
3898
'bzrlib.tests.test_scenarios',
3899
'bzrlib.tests.test_script',
3900
'bzrlib.tests.test_selftest',
3901
'bzrlib.tests.test_serializer',
3902
'bzrlib.tests.test_setup',
3903
'bzrlib.tests.test_sftp_transport',
3904
'bzrlib.tests.test_shelf',
3905
'bzrlib.tests.test_shelf_ui',
3906
'bzrlib.tests.test_smart',
3907
'bzrlib.tests.test_smart_add',
3908
'bzrlib.tests.test_smart_request',
3909
'bzrlib.tests.test_smart_transport',
3910
'bzrlib.tests.test_smtp_connection',
3911
'bzrlib.tests.test_source',
3912
'bzrlib.tests.test_ssh_transport',
3913
'bzrlib.tests.test_status',
3914
'bzrlib.tests.test_store',
3915
'bzrlib.tests.test_strace',
3916
'bzrlib.tests.test_subsume',
3917
'bzrlib.tests.test_switch',
3918
'bzrlib.tests.test_symbol_versioning',
3919
'bzrlib.tests.test_tag',
3920
'bzrlib.tests.test_test_server',
3921
'bzrlib.tests.test_testament',
3922
'bzrlib.tests.test_textfile',
3923
'bzrlib.tests.test_textmerge',
3924
'bzrlib.tests.test_cethread',
3925
'bzrlib.tests.test_timestamp',
3926
'bzrlib.tests.test_trace',
3927
'bzrlib.tests.test_transactions',
3928
'bzrlib.tests.test_transform',
3929
'bzrlib.tests.test_transport',
3930
'bzrlib.tests.test_transport_log',
3931
'bzrlib.tests.test_tree',
3932
'bzrlib.tests.test_treebuilder',
3933
'bzrlib.tests.test_treeshape',
3934
'bzrlib.tests.test_tsort',
3935
'bzrlib.tests.test_tuned_gzip',
3936
'bzrlib.tests.test_ui',
3937
'bzrlib.tests.test_uncommit',
3938
'bzrlib.tests.test_upgrade',
3939
'bzrlib.tests.test_upgrade_stacked',
3940
'bzrlib.tests.test_urlutils',
3941
'bzrlib.tests.test_utextwrap',
3942
'bzrlib.tests.test_version',
3943
'bzrlib.tests.test_version_info',
3944
'bzrlib.tests.test_versionedfile',
3945
'bzrlib.tests.test_weave',
3946
'bzrlib.tests.test_whitebox',
3947
'bzrlib.tests.test_win32utils',
3948
'bzrlib.tests.test_workingtree',
3949
'bzrlib.tests.test_workingtree_4',
3950
'bzrlib.tests.test_wsgi',
3951
'bzrlib.tests.test_xml',
3955
def _test_suite_modules_to_doctest():
3956
"""Return the list of modules to doctest."""
3958
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3962
'bzrlib.branchbuilder',
3963
'bzrlib.decorators',
3965
'bzrlib.iterablefile',
3970
'bzrlib.symbol_versioning',
3972
'bzrlib.tests.fixtures',
3974
'bzrlib.transport.http',
3975
'bzrlib.version_info_formats.format_custom',
3979
def test_suite(keep_only=None, starting_with=None):
3980
1103
"""Build and return TestSuite for the whole of bzrlib.
3982
:param keep_only: A list of test ids limiting the suite returned.
3984
:param starting_with: An id limiting the suite returned to the tests
3987
1105
This function can be replaced if you need to change the default test
3988
1106
suite on a global basis, but it is not encouraged.
1108
from doctest import DocTestSuite
1110
global MODULES_TO_DOCTEST
1113
'bzrlib.tests.test_ancestry',
1114
'bzrlib.tests.test_api',
1115
'bzrlib.tests.test_bad_files',
1116
'bzrlib.tests.test_branch',
1117
'bzrlib.tests.test_bzrdir',
1118
'bzrlib.tests.test_command',
1119
'bzrlib.tests.test_commit',
1120
'bzrlib.tests.test_commit_merge',
1121
'bzrlib.tests.test_config',
1122
'bzrlib.tests.test_conflicts',
1123
'bzrlib.tests.test_decorators',
1124
'bzrlib.tests.test_diff',
1125
'bzrlib.tests.test_doc_generate',
1126
'bzrlib.tests.test_errors',
1127
'bzrlib.tests.test_escaped_store',
1128
'bzrlib.tests.test_fetch',
1129
'bzrlib.tests.test_gpg',
1130
'bzrlib.tests.test_graph',
1131
'bzrlib.tests.test_hashcache',
1132
'bzrlib.tests.test_http',
1133
'bzrlib.tests.test_identitymap',
1134
'bzrlib.tests.test_inv',
1135
'bzrlib.tests.test_knit',
1136
'bzrlib.tests.test_lockdir',
1137
'bzrlib.tests.test_lockable_files',
1138
'bzrlib.tests.test_log',
1139
'bzrlib.tests.test_merge',
1140
'bzrlib.tests.test_merge3',
1141
'bzrlib.tests.test_merge_core',
1142
'bzrlib.tests.test_missing',
1143
'bzrlib.tests.test_msgeditor',
1144
'bzrlib.tests.test_nonascii',
1145
'bzrlib.tests.test_options',
1146
'bzrlib.tests.test_osutils',
1147
'bzrlib.tests.test_patch',
1148
'bzrlib.tests.test_permissions',
1149
'bzrlib.tests.test_plugins',
1150
'bzrlib.tests.test_progress',
1151
'bzrlib.tests.test_reconcile',
1152
'bzrlib.tests.test_repository',
1153
'bzrlib.tests.test_revision',
1154
'bzrlib.tests.test_revisionnamespaces',
1155
'bzrlib.tests.test_revprops',
1156
'bzrlib.tests.test_rio',
1157
'bzrlib.tests.test_sampler',
1158
'bzrlib.tests.test_selftest',
1159
'bzrlib.tests.test_setup',
1160
'bzrlib.tests.test_sftp_transport',
1161
'bzrlib.tests.test_smart_add',
1162
'bzrlib.tests.test_source',
1163
'bzrlib.tests.test_status',
1164
'bzrlib.tests.test_store',
1165
'bzrlib.tests.test_symbol_versioning',
1166
'bzrlib.tests.test_testament',
1167
'bzrlib.tests.test_textfile',
1168
'bzrlib.tests.test_textmerge',
1169
'bzrlib.tests.test_trace',
1170
'bzrlib.tests.test_transactions',
1171
'bzrlib.tests.test_transform',
1172
'bzrlib.tests.test_transport',
1173
'bzrlib.tests.test_tsort',
1174
'bzrlib.tests.test_tuned_gzip',
1175
'bzrlib.tests.test_ui',
1176
'bzrlib.tests.test_upgrade',
1177
'bzrlib.tests.test_versionedfile',
1178
'bzrlib.tests.test_weave',
1179
'bzrlib.tests.test_whitebox',
1180
'bzrlib.tests.test_workingtree',
1181
'bzrlib.tests.test_xml',
1183
test_transport_implementations = [
1184
'bzrlib.tests.test_transport_implementations']
3991
1187
loader = TestUtil.TestLoader()
3993
if keep_only is not None:
3994
id_filter = TestIdList(keep_only)
3996
# We take precedence over keep_only because *at loading time* using
3997
# both options means we will load less tests for the same final result.
3998
def interesting_module(name):
3999
for start in starting_with:
4001
# Either the module name starts with the specified string
4002
name.startswith(start)
4003
# or it may contain tests starting with the specified string
4004
or start.startswith(name)
4008
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4010
elif keep_only is not None:
4011
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4012
def interesting_module(name):
4013
return id_filter.refers_to(name)
4016
loader = TestUtil.TestLoader()
4017
def interesting_module(name):
4018
# No filtering, all modules are interesting
4021
suite = loader.suiteClass()
4023
# modules building their suite with loadTestsFromModuleNames
4024
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4026
for mod in _test_suite_modules_to_doctest():
4027
if not interesting_module(mod):
4028
# No tests to keep here, move along
4031
# note that this really does mean "report only" -- doctest
4032
# still runs the rest of the examples
4033
doc_suite = IsolatedDocTestSuite(
4034
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
4035
except ValueError, e:
4036
print '**failed to get doctest for: %s\n%s' % (mod, e)
4038
if len(doc_suite._tests) == 0:
4039
raise errors.BzrError("no doctests found in %s" % (mod,))
4040
suite.addTest(doc_suite)
4042
default_encoding = sys.getdefaultencoding()
4043
for name, plugin in _mod_plugin.plugins().items():
4044
if not interesting_module(plugin.module.__name__):
4046
plugin_suite = plugin.test_suite()
4047
# We used to catch ImportError here and turn it into just a warning,
4048
# but really if you don't have --no-plugins this should be a failure.
4049
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4050
if plugin_suite is None:
4051
plugin_suite = plugin.load_plugin_tests(loader)
4052
if plugin_suite is not None:
4053
suite.addTest(plugin_suite)
4054
if default_encoding != sys.getdefaultencoding():
4056
'Plugin "%s" tried to reset default encoding to: %s', name,
4057
sys.getdefaultencoding())
4059
sys.setdefaultencoding(default_encoding)
4061
if keep_only is not None:
4062
# Now that the referred modules have loaded their tests, keep only the
4064
suite = filter_suite_by_id_list(suite, id_filter)
4065
# Do some sanity checks on the id_list filtering
4066
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4068
# The tester has used both keep_only and starting_with, so he is
4069
# already aware that some tests are excluded from the list, there
4070
# is no need to tell him which.
4073
# Some tests mentioned in the list are not in the test suite. The
4074
# list may be out of date, report to the tester.
4075
for id in not_found:
4076
trace.warning('"%s" not found in the test suite', id)
4077
for id in duplicates:
4078
trace.warning('"%s" is used as an id by several tests', id)
1188
from bzrlib.transport import TransportTestProviderAdapter
1189
adapter = TransportTestProviderAdapter()
1190
adapt_modules(test_transport_implementations, adapter, loader, suite)
1191
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1192
for package in packages_to_test():
1193
suite.addTest(package.test_suite())
1194
for m in MODULES_TO_TEST:
1195
suite.addTest(loader.loadTestsFromModule(m))
1196
for m in (MODULES_TO_DOCTEST):
1197
suite.addTest(DocTestSuite(m))
1198
for name, plugin in bzrlib.plugin.all_plugins().items():
1199
if getattr(plugin, 'test_suite', None) is not None:
1200
suite.addTest(plugin.test_suite())
4083
def multiply_scenarios(*scenarios):
4084
"""Multiply two or more iterables of scenarios.
4086
It is safe to pass scenario generators or iterators.
4088
:returns: A list of compound scenarios: the cross-product of all
4089
scenarios, with the names concatenated and the parameters
4092
return reduce(_multiply_two_scenarios, map(list, scenarios))
4095
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4096
"""Multiply two sets of scenarios.
4098
:returns: the cartesian product of the two sets of scenarios, that is
4099
a scenario for every possible combination of a left scenario and a
4103
('%s,%s' % (left_name, right_name),
4104
dict(left_dict.items() + right_dict.items()))
4105
for left_name, left_dict in scenarios_left
4106
for right_name, right_dict in scenarios_right]
4109
def multiply_tests(tests, scenarios, result):
4110
"""Multiply tests_list by scenarios into result.
4112
This is the core workhorse for test parameterisation.
4114
Typically the load_tests() method for a per-implementation test suite will
4115
call multiply_tests and return the result.
4117
:param tests: The tests to parameterise.
4118
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4119
scenario_param_dict).
4120
:param result: A TestSuite to add created tests to.
4122
This returns the passed in result TestSuite with the cross product of all
4123
the tests repeated once for each scenario. Each test is adapted by adding
4124
the scenario name at the end of its id(), and updating the test object's
4125
__dict__ with the scenario_param_dict.
4127
>>> import bzrlib.tests.test_sampler
4128
>>> r = multiply_tests(
4129
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4130
... [('one', dict(param=1)),
4131
... ('two', dict(param=2))],
4132
... TestUtil.TestSuite())
4133
>>> tests = list(iter_suite_tests(r))
4137
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4143
for test in iter_suite_tests(tests):
4144
apply_scenarios(test, scenarios, result)
4148
def apply_scenarios(test, scenarios, result):
4149
"""Apply the scenarios in scenarios to test and add to result.
4151
:param test: The test to apply scenarios to.
4152
:param scenarios: An iterable of scenarios to apply to test.
4154
:seealso: apply_scenario
4156
for scenario in scenarios:
4157
result.addTest(apply_scenario(test, scenario))
4161
def apply_scenario(test, scenario):
4162
"""Copy test and apply scenario to it.
4164
:param test: A test to adapt.
4165
:param scenario: A tuple describing the scenarion.
4166
The first element of the tuple is the new test id.
4167
The second element is a dict containing attributes to set on the
4169
:return: The adapted test.
4171
new_id = "%s(%s)" % (test.id(), scenario[0])
4172
new_test = clone_test(test, new_id)
4173
for name, value in scenario[1].items():
4174
setattr(new_test, name, value)
4178
def clone_test(test, new_id):
4179
"""Clone a test giving it a new id.
4181
:param test: The test to clone.
4182
:param new_id: The id to assign to it.
4183
:return: The new test.
4185
new_test = copy.copy(test)
4186
new_test.id = lambda: new_id
4187
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4188
# causes cloned tests to share the 'details' dict. This makes it hard to
4189
# read the test output for parameterized tests, because tracebacks will be
4190
# associated with irrelevant tests.
4192
details = new_test._TestCase__details
4193
except AttributeError:
4194
# must be a different version of testtools than expected. Do nothing.
4197
# Reset the '__details' dict.
4198
new_test._TestCase__details = {}
4202
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4204
"""Helper for permutating tests against an extension module.
4206
This is meant to be used inside a modules 'load_tests()' function. It will
4207
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4208
against both implementations. Setting 'test.module' to the appropriate
4209
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4211
:param standard_tests: A test suite to permute
4212
:param loader: A TestLoader
4213
:param py_module_name: The python path to a python module that can always
4214
be loaded, and will be considered the 'python' implementation. (eg
4215
'bzrlib._chk_map_py')
4216
:param ext_module_name: The python path to an extension module. If the
4217
module cannot be loaded, a single test will be added, which notes that
4218
the module is not available. If it can be loaded, all standard_tests
4219
will be run against that module.
4220
:return: (suite, feature) suite is a test-suite that has all the permuted
4221
tests. feature is the Feature object that can be used to determine if
4222
the module is available.
4225
py_module = pyutils.get_named_object(py_module_name)
4227
('python', {'module': py_module}),
4229
suite = loader.suiteClass()
4230
feature = ModuleAvailableFeature(ext_module_name)
4231
if feature.available():
4232
scenarios.append(('C', {'module': feature.module}))
4234
# the compiled module isn't available, so we add a failing test
4235
class FailWithoutFeature(TestCase):
4236
def test_fail(self):
4237
self.requireFeature(feature)
4238
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4239
result = multiply_tests(standard_tests, scenarios, suite)
4240
return result, feature
4243
def _rmtree_temp_dir(dirname, test_id=None):
4244
# If LANG=C we probably have created some bogus paths
4245
# which rmtree(unicode) will fail to delete
4246
# so make sure we are using rmtree(str) to delete everything
4247
# except on win32, where rmtree(str) will fail
4248
# since it doesn't have the property of byte-stream paths
4249
# (they are either ascii or mbcs)
4250
if sys.platform == 'win32':
4251
# make sure we are using the unicode win32 api
4252
dirname = unicode(dirname)
4254
dirname = dirname.encode(sys.getfilesystemencoding())
4256
osutils.rmtree(dirname)
4258
# We don't want to fail here because some useful display will be lost
4259
# otherwise. Polluting the tmp dir is bad, but not giving all the
4260
# possible info to the test runner is even worse.
4262
ui.ui_factory.clear_term()
4263
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4264
# Ugly, but the last thing we want here is fail, so bear with it.
4265
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4266
).encode('ascii', 'replace')
4267
sys.stderr.write('Unable to remove testing dir %s\n%s'
4268
% (os.path.basename(dirname), printable_e))
4271
class Feature(object):
4272
"""An operating system Feature."""
4275
self._available = None
4277
def available(self):
4278
"""Is the feature available?
4280
:return: True if the feature is available.
4282
if self._available is None:
4283
self._available = self._probe()
4284
return self._available
4287
"""Implement this method in concrete features.
4289
:return: True if the feature is available.
4291
raise NotImplementedError
4294
if getattr(self, 'feature_name', None):
4295
return self.feature_name()
4296
return self.__class__.__name__
4299
class _SymlinkFeature(Feature):
4302
return osutils.has_symlinks()
4304
def feature_name(self):
4307
SymlinkFeature = _SymlinkFeature()
4310
class _HardlinkFeature(Feature):
4313
return osutils.has_hardlinks()
4315
def feature_name(self):
4318
HardlinkFeature = _HardlinkFeature()
4321
class _OsFifoFeature(Feature):
4324
return getattr(os, 'mkfifo', None)
4326
def feature_name(self):
4327
return 'filesystem fifos'
4329
OsFifoFeature = _OsFifoFeature()
4332
class _UnicodeFilenameFeature(Feature):
4333
"""Does the filesystem support Unicode filenames?"""
4337
# Check for character combinations unlikely to be covered by any
4338
# single non-unicode encoding. We use the characters
4339
# - greek small letter alpha (U+03B1) and
4340
# - braille pattern dots-123456 (U+283F).
4341
os.stat(u'\u03b1\u283f')
4342
except UnicodeEncodeError:
4344
except (IOError, OSError):
4345
# The filesystem allows the Unicode filename but the file doesn't
4349
# The filesystem allows the Unicode filename and the file exists,
4353
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4356
class _CompatabilityThunkFeature(Feature):
4357
"""This feature is just a thunk to another feature.
4359
It issues a deprecation warning if it is accessed, to let you know that you
4360
should really use a different feature.
4363
def __init__(self, dep_version, module, name,
4364
replacement_name, replacement_module=None):
4365
super(_CompatabilityThunkFeature, self).__init__()
4366
self._module = module
4367
if replacement_module is None:
4368
replacement_module = module
4369
self._replacement_module = replacement_module
4371
self._replacement_name = replacement_name
4372
self._dep_version = dep_version
4373
self._feature = None
4376
if self._feature is None:
4377
depr_msg = self._dep_version % ('%s.%s'
4378
% (self._module, self._name))
4379
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4380
self._replacement_name)
4381
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4382
# Import the new feature and use it as a replacement for the
4384
self._feature = pyutils.get_named_object(
4385
self._replacement_module, self._replacement_name)
4389
return self._feature._probe()
4392
class ModuleAvailableFeature(Feature):
4393
"""This is a feature than describes a module we want to be available.
4395
Declare the name of the module in __init__(), and then after probing, the
4396
module will be available as 'self.module'.
4398
:ivar module: The module if it is available, else None.
4401
def __init__(self, module_name):
4402
super(ModuleAvailableFeature, self).__init__()
4403
self.module_name = module_name
4407
self._module = __import__(self.module_name, {}, {}, [''])
4414
if self.available(): # Make sure the probe has been done
4418
def feature_name(self):
4419
return self.module_name
4422
def probe_unicode_in_user_encoding():
4423
"""Try to encode several unicode strings to use in unicode-aware tests.
4424
Return first successfull match.
4426
:return: (unicode value, encoded plain string value) or (None, None)
4428
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4429
for uni_val in possible_vals:
4431
str_val = uni_val.encode(osutils.get_user_encoding())
4432
except UnicodeEncodeError:
4433
# Try a different character
4436
return uni_val, str_val
4440
def probe_bad_non_ascii(encoding):
4441
"""Try to find [bad] character with code [128..255]
4442
that cannot be decoded to unicode in some encoding.
4443
Return None if all non-ascii characters is valid
4446
for i in xrange(128, 256):
4449
char.decode(encoding)
4450
except UnicodeDecodeError:
4455
class _HTTPSServerFeature(Feature):
4456
"""Some tests want an https Server, check if one is available.
4458
Right now, the only way this is available is under python2.6 which provides
4469
def feature_name(self):
4470
return 'HTTPSServer'
4473
HTTPSServerFeature = _HTTPSServerFeature()
4476
class _UnicodeFilename(Feature):
4477
"""Does the filesystem support Unicode filenames?"""
4482
except UnicodeEncodeError:
4484
except (IOError, OSError):
4485
# The filesystem allows the Unicode filename but the file doesn't
4489
# The filesystem allows the Unicode filename and the file exists,
4493
UnicodeFilename = _UnicodeFilename()
4496
class _ByteStringNamedFilesystem(Feature):
4497
"""Is the filesystem based on bytes?"""
4500
if os.name == "posix":
4504
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
4507
class _UTF8Filesystem(Feature):
4508
"""Is the filesystem UTF-8?"""
4511
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4515
UTF8Filesystem = _UTF8Filesystem()
4518
class _BreakinFeature(Feature):
4519
"""Does this platform support the breakin feature?"""
4522
from bzrlib import breakin
4523
if breakin.determine_signal() is None:
4525
if sys.platform == 'win32':
4526
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4527
# We trigger SIGBREAK via a Console api so we need ctypes to
4528
# access the function
4535
def feature_name(self):
4536
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4539
BreakinFeature = _BreakinFeature()
4542
class _CaseInsCasePresFilenameFeature(Feature):
4543
"""Is the file-system case insensitive, but case-preserving?"""
4546
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4548
# first check truly case-preserving for created files, then check
4549
# case insensitive when opening existing files.
4550
name = osutils.normpath(name)
4551
base, rel = osutils.split(name)
4552
found_rel = osutils.canonical_relpath(base, name)
4553
return (found_rel == rel
4554
and os.path.isfile(name.upper())
4555
and os.path.isfile(name.lower()))
4560
def feature_name(self):
4561
return "case-insensitive case-preserving filesystem"
4563
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4566
class _CaseInsensitiveFilesystemFeature(Feature):
4567
"""Check if underlying filesystem is case-insensitive but *not* case
4570
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4571
# more likely to be case preserving, so this case is rare.
4574
if CaseInsCasePresFilenameFeature.available():
4577
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4578
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4579
TestCaseWithMemoryTransport.TEST_ROOT = root
4581
root = TestCaseWithMemoryTransport.TEST_ROOT
4582
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4584
name_a = osutils.pathjoin(tdir, 'a')
4585
name_A = osutils.pathjoin(tdir, 'A')
4587
result = osutils.isdir(name_A)
4588
_rmtree_temp_dir(tdir)
4591
def feature_name(self):
4592
return 'case-insensitive filesystem'
4594
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4597
class _CaseSensitiveFilesystemFeature(Feature):
4600
if CaseInsCasePresFilenameFeature.available():
4602
elif CaseInsensitiveFilesystemFeature.available():
4607
def feature_name(self):
4608
return 'case-sensitive filesystem'
4610
# new coding style is for feature instances to be lowercase
4611
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4614
# Only define SubUnitBzrRunner if subunit is available.
4616
from subunit import TestProtocolClient
4617
from subunit.test_results import AutoTimingTestResultDecorator
4618
class SubUnitBzrProtocolClient(TestProtocolClient):
4620
def addSuccess(self, test, details=None):
4621
# The subunit client always includes the details in the subunit
4622
# stream, but we don't want to include it in ours.
4623
if details is not None and 'log' in details:
4625
return super(SubUnitBzrProtocolClient, self).addSuccess(
4628
class SubUnitBzrRunner(TextTestRunner):
4629
def run(self, test):
4630
result = AutoTimingTestResultDecorator(
4631
SubUnitBzrProtocolClient(self.stream))
4637
class _PosixPermissionsFeature(Feature):
4641
# create temporary file and check if specified perms are maintained.
4644
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4645
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4648
os.chmod(name, write_perms)
4650
read_perms = os.stat(name).st_mode & 0777
4652
return (write_perms == read_perms)
4654
return (os.name == 'posix') and has_perms()
4656
def feature_name(self):
4657
return 'POSIX permissions support'
4659
posix_permissions_feature = _PosixPermissionsFeature()
1204
def adapt_modules(mods_list, adapter, loader, suite):
1205
"""Adapt the modules in mods_list using adapter and add to suite."""
1206
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1207
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
