90
59
from bzrlib.merge import merge_inner
91
60
import bzrlib.merge3
62
import bzrlib.osutils as osutils
92
63
import bzrlib.plugin
93
from bzrlib.smart import client, request, server
64
import bzrlib.progress as progress
65
from bzrlib.revision import common_ancestor
94
66
import bzrlib.store
95
from bzrlib import symbol_versioning
96
from bzrlib.symbol_versioning import (
103
67
import bzrlib.trace
104
from bzrlib.transport import get_transport, pathfilter
68
from bzrlib.transport import get_transport
105
69
import bzrlib.transport
106
from bzrlib.transport.local import LocalURLServer
107
from bzrlib.transport.memory import MemoryServer
70
from bzrlib.transport.local import LocalRelpathServer
108
71
from bzrlib.transport.readonly import ReadonlyServer
109
from bzrlib.trace import mutter, note
72
from bzrlib.trace import mutter
110
73
from bzrlib.tests import TestUtil
111
from bzrlib.tests.http_server import HttpServer
112
74
from bzrlib.tests.TestUtil import (
116
78
from bzrlib.tests.treeshape import build_tree_contents
117
from bzrlib.ui import NullProgressView
118
from bzrlib.ui.text import TextUIFactory
119
import bzrlib.version_info_formats.format_custom
79
import bzrlib.urlutils as urlutils
120
80
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
122
# Mark this python module as being part of the implementation
123
# of unittest: this gives us better tracebacks where the last
124
# shown frame is the test code, not our assertXYZ.
127
default_transport = LocalURLServer
130
_unitialized_attr = object()
131
"""A sentinel needed to act as a default value in a method signature."""
134
# Subunit result codes, defined here to prevent a hard dependency on subunit.
139
class ExtendedTestResult(unittest._TextTestResult):
140
"""Accepts, reports and accumulates the results of running tests.
142
Compared to the unittest version this class adds support for
143
profiling, benchmarking, stopping as soon as a test fails, and
144
skipping tests. There are further-specialized subclasses for
145
different types of display.
147
When a test finishes, in whatever way, it calls one of the addSuccess,
148
addFailure or addError classes. These in turn may redirect to a more
149
specific case for the special test results supported by our extended
152
Note that just one of these objects is fed the results from many tests.
82
default_transport = LocalRelpathServer
85
MODULES_TO_DOCTEST = [
87
bzrlib.bundle.serializer,
100
def packages_to_test():
101
"""Return a list of packages to test.
103
The packages are not globally imported so that import failures are
104
triggered when running selftest, not when importing the command.
107
import bzrlib.tests.blackbox
108
import bzrlib.tests.branch_implementations
109
import bzrlib.tests.bzrdir_implementations
110
import bzrlib.tests.interrepository_implementations
111
import bzrlib.tests.interversionedfile_implementations
112
import bzrlib.tests.repository_implementations
113
import bzrlib.tests.revisionstore_implementations
114
import bzrlib.tests.tree_implementations
115
import bzrlib.tests.workingtree_implementations
118
bzrlib.tests.blackbox,
119
bzrlib.tests.branch_implementations,
120
bzrlib.tests.bzrdir_implementations,
121
bzrlib.tests.interrepository_implementations,
122
bzrlib.tests.interversionedfile_implementations,
123
bzrlib.tests.repository_implementations,
124
bzrlib.tests.revisionstore_implementations,
125
bzrlib.tests.tree_implementations,
126
bzrlib.tests.workingtree_implementations,
130
class _MyResult(unittest._TextTestResult):
131
"""Custom TestResult.
133
Shows output in a different format, including displaying runtime for tests.
155
135
stop_early = False
157
def __init__(self, stream, descriptions, verbosity,
161
"""Construct new TestResult.
163
:param bench_history: Optionally, a writable file object to accumulate
137
def __init__(self, stream, descriptions, verbosity, pb=None):
166
138
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
167
if bench_history is not None:
168
from bzrlib.version import _get_bzr_source_tree
169
src_tree = _get_bzr_source_tree()
172
revision_id = src_tree.get_parent_ids()[0]
174
# XXX: if this is a brand new tree, do the same as if there
178
# XXX: If there's no branch, what should we do?
180
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
181
self._bench_history = bench_history
182
self.ui = ui.ui_factory
185
self.failure_count = 0
186
self.known_failure_count = 0
188
self.not_applicable_count = 0
189
self.unsupported = {}
191
self._overall_start_time = time.time()
192
self._strict = strict
194
def stopTestRun(self):
197
stopTime = time.time()
198
timeTaken = stopTime - self.startTime
200
self.stream.writeln(self.separator2)
201
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
202
run, run != 1 and "s" or "", timeTaken))
203
self.stream.writeln()
204
if not self.wasSuccessful():
205
self.stream.write("FAILED (")
206
failed, errored = map(len, (self.failures, self.errors))
208
self.stream.write("failures=%d" % failed)
210
if failed: self.stream.write(", ")
211
self.stream.write("errors=%d" % errored)
212
if self.known_failure_count:
213
if failed or errored: self.stream.write(", ")
214
self.stream.write("known_failure_count=%d" %
215
self.known_failure_count)
216
self.stream.writeln(")")
218
if self.known_failure_count:
219
self.stream.writeln("OK (known_failures=%d)" %
220
self.known_failure_count)
222
self.stream.writeln("OK")
223
if self.skip_count > 0:
224
skipped = self.skip_count
225
self.stream.writeln('%d test%s skipped' %
226
(skipped, skipped != 1 and "s" or ""))
228
for feature, count in sorted(self.unsupported.items()):
229
self.stream.writeln("Missing feature '%s' skipped %d tests." %
232
ok = self.wasStrictlySuccessful()
234
ok = self.wasSuccessful()
235
if TestCase._first_thread_leaker_id:
237
'%s is leaking threads among %d leaking tests.\n' % (
238
TestCase._first_thread_leaker_id,
239
TestCase._leaking_threads_tests))
240
# We don't report the main thread as an active one.
242
'%d non-main threads were left active in the end.\n'
243
% (TestCase._active_threads - 1))
245
def getDescription(self, test):
248
def _extractBenchmarkTime(self, testCase, details=None):
141
def extractBenchmarkTime(self, testCase):
249
142
"""Add a benchmark time for the current test case."""
250
if details and 'benchtime' in details:
251
return float(''.join(details['benchtime'].iter_bytes()))
252
return getattr(testCase, "_benchtime", None)
143
self._benchmarkTime = getattr(testCase, "_benchtime", None)
254
145
def _elapsedTestTimeString(self):
255
146
"""Return a time string for the overall time the current test has taken."""
256
147
return self._formatTime(time.time() - self._start_time)
258
def _testTimeString(self, testCase):
259
benchmark_time = self._extractBenchmarkTime(testCase)
260
if benchmark_time is not None:
261
return self._formatTime(benchmark_time) + "*"
149
def _testTimeString(self):
150
if self._benchmarkTime is not None:
152
self._formatTime(self._benchmarkTime),
153
self._elapsedTestTimeString())
263
return self._elapsedTestTimeString()
155
return " %s" % self._elapsedTestTimeString()
265
157
def _formatTime(self, seconds):
266
158
"""Format seconds as milliseconds with leading spaces."""
267
# some benchmarks can take thousands of seconds to run, so we need 8
269
return "%8dms" % (1000 * seconds)
159
return "%5dms" % (1000 * seconds)
271
def _shortened_test_description(self, test):
273
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
161
def _ellipsise_unimportant_words(self, a_string, final_width,
163
"""Add ellipses (sp?) for overly long strings.
165
:param keep_start: If true preserve the start of a_string rather
169
if len(a_string) > final_width:
170
result = a_string[:final_width-3] + '...'
174
if len(a_string) > final_width:
175
result = '...' + a_string[3-final_width:]
178
return result.ljust(final_width)
276
180
def startTest(self, test):
277
181
unittest.TestResult.startTest(self, test)
280
self.report_test_start(test)
281
test.number = self.count
182
# In a short description, the important words are in
183
# the beginning, but in an id, the important words are
185
SHOW_DESCRIPTIONS = False
187
if not self.showAll and self.dots and self.pb is not None:
190
final_width = osutils.terminal_width()
191
final_width = final_width - 15 - 8
193
if SHOW_DESCRIPTIONS:
194
what = test.shortDescription()
196
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
199
if what.startswith('bzrlib.tests.'):
201
what = self._ellipsise_unimportant_words(what, final_width)
203
self.stream.write(what)
204
elif self.dots and self.pb is not None:
205
self.pb.update(what, self.testsRun - 1, None)
282
207
self._recordTestStartTime()
284
def startTests(self):
286
if getattr(sys, 'frozen', None) is None:
287
bzr_path = osutils.realpath(sys.argv[0])
289
bzr_path = sys.executable
291
'bzr selftest: %s\n' % (bzr_path,))
294
bzrlib.__path__[0],))
296
' bzr-%s python-%s %s\n' % (
297
bzrlib.version_string,
298
bzrlib._format_version_tuple(sys.version_info),
299
platform.platform(aliased=1),
301
self.stream.write('\n')
303
209
def _recordTestStartTime(self):
304
210
"""Record that a test has started."""
305
211
self._start_time = time.time()
307
def _cleanupLogFile(self, test):
308
# We can only do this if we have one of our TestCases, not if
310
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
311
if setKeepLogfile is not None:
314
213
def addError(self, test, err):
315
"""Tell result that test finished with an error.
317
Called from the TestCase run() method when the test
318
fails with an unexpected error.
214
if isinstance(err[1], TestSkipped):
215
return self.addSkipped(test, err)
321
216
unittest.TestResult.addError(self, test, err)
322
self.error_count += 1
323
self.report_error(test, err)
217
self.extractBenchmarkTime(test)
219
self.stream.writeln("ERROR %s" % self._testTimeString())
220
elif self.dots and self.pb is None:
221
self.stream.write('E')
223
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
324
225
if self.stop_early:
326
self._cleanupLogFile(test)
328
228
def addFailure(self, test, err):
329
"""Tell result that test failed.
331
Called from the TestCase run() method when the test
332
fails because e.g. an assert() method failed.
335
229
unittest.TestResult.addFailure(self, test, err)
336
self.failure_count += 1
337
self.report_failure(test, err)
230
self.extractBenchmarkTime(test)
232
self.stream.writeln(" FAIL %s" % self._testTimeString())
233
elif self.dots and self.pb is None:
234
self.stream.write('F')
236
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
338
238
if self.stop_early:
340
self._cleanupLogFile(test)
342
def addSuccess(self, test, details=None):
343
"""Tell result that test completed successfully.
345
Called from the TestCase run()
347
if self._bench_history is not None:
348
benchmark_time = self._extractBenchmarkTime(test, details)
349
if benchmark_time is not None:
350
self._bench_history.write("%s %s\n" % (
351
self._formatTime(benchmark_time),
353
self.report_success(test)
354
self._cleanupLogFile(test)
241
def addSuccess(self, test):
242
self.extractBenchmarkTime(test)
244
self.stream.writeln(' OK %s' % self._testTimeString())
245
for bench_called, stats in getattr(test, '_benchcalls', []):
246
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
247
stats.pprint(file=self.stream)
248
elif self.dots and self.pb is None:
249
self.stream.write('~')
251
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
355
253
unittest.TestResult.addSuccess(self, test)
356
test._log_contents = ''
358
def addExpectedFailure(self, test, err):
359
self.known_failure_count += 1
360
self.report_known_failure(test, err)
362
def addNotSupported(self, test, feature):
363
"""The test will not be run because of a missing feature.
365
# this can be called in two different ways: it may be that the
366
# test started running, and then raised (through requireFeature)
367
# UnavailableFeature. Alternatively this method can be called
368
# while probing for features before running the test code proper; in
369
# that case we will see startTest and stopTest, but the test will
370
# never actually run.
371
self.unsupported.setdefault(str(feature), 0)
372
self.unsupported[str(feature)] += 1
373
self.report_unsupported(test, feature)
375
def addSkip(self, test, reason):
376
"""A test has not run for 'reason'."""
378
self.report_skip(test, reason)
380
def addNotApplicable(self, test, reason):
381
self.not_applicable_count += 1
382
self.report_not_applicable(test, reason)
384
def _post_mortem(self):
385
"""Start a PDB post mortem session."""
386
if os.environ.get('BZR_TEST_PDB', None):
387
import pdb;pdb.post_mortem()
389
def progress(self, offset, whence):
390
"""The test is adjusting the count of tests to run."""
391
if whence == SUBUNIT_SEEK_SET:
392
self.num_tests = offset
393
elif whence == SUBUNIT_SEEK_CUR:
394
self.num_tests += offset
396
raise errors.BzrError("Unknown whence %r" % whence)
398
def report_cleaning_up(self):
401
def startTestRun(self):
402
self.startTime = time.time()
404
def report_success(self, test):
407
def wasStrictlySuccessful(self):
408
if self.unsupported or self.known_failure_count:
410
return self.wasSuccessful()
413
class TextTestResult(ExtendedTestResult):
414
"""Displays progress and results of tests in text form"""
416
def __init__(self, stream, descriptions, verbosity,
421
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
422
bench_history, strict)
423
# We no longer pass them around, but just rely on the UIFactory stack
426
warnings.warn("Passing pb to TextTestResult is deprecated")
427
self.pb = self.ui.nested_progress_bar()
428
self.pb.show_pct = False
429
self.pb.show_spinner = False
430
self.pb.show_eta = False,
431
self.pb.show_count = False
432
self.pb.show_bar = False
433
self.pb.update_latency = 0
434
self.pb.show_transport_activity = False
436
def stopTestRun(self):
437
# called when the tests that are going to run have run
440
super(TextTestResult, self).stopTestRun()
442
def startTestRun(self):
443
super(TextTestResult, self).startTestRun()
444
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
446
def printErrors(self):
447
# clear the pb to make room for the error listing
449
super(TextTestResult, self).printErrors()
451
def _progress_prefix_text(self):
452
# the longer this text, the less space we have to show the test
454
a = '[%d' % self.count # total that have been run
455
# tests skipped as known not to be relevant are not important enough
457
## if self.skip_count:
458
## a += ', %d skip' % self.skip_count
459
## if self.known_failure_count:
460
## a += '+%dX' % self.known_failure_count
462
a +='/%d' % self.num_tests
464
runtime = time.time() - self._overall_start_time
466
a += '%dm%ds' % (runtime / 60, runtime % 60)
469
total_fail_count = self.error_count + self.failure_count
471
a += ', %d failed' % total_fail_count
472
# if self.unsupported:
473
# a += ', %d missing' % len(self.unsupported)
477
def report_test_start(self, test):
480
self._progress_prefix_text()
482
+ self._shortened_test_description(test))
484
def _test_description(self, test):
485
return self._shortened_test_description(test)
487
def report_error(self, test, err):
488
ui.ui_factory.note('ERROR: %s\n %s\n' % (
489
self._test_description(test),
493
def report_failure(self, test, err):
494
ui.ui_factory.note('FAIL: %s\n %s\n' % (
495
self._test_description(test),
499
def report_known_failure(self, test, err):
502
def report_skip(self, test, reason):
505
def report_not_applicable(self, test, reason):
508
def report_unsupported(self, test, feature):
509
"""test cannot be run because feature is missing."""
511
def report_cleaning_up(self):
512
self.pb.update('Cleaning up')
515
class VerboseTestResult(ExtendedTestResult):
516
"""Produce long output, with one line per test run plus times"""
518
def _ellipsize_to_right(self, a_string, final_width):
519
"""Truncate and pad a string, keeping the right hand side"""
520
if len(a_string) > final_width:
521
result = '...' + a_string[3-final_width:]
524
return result.ljust(final_width)
526
def startTestRun(self):
527
super(VerboseTestResult, self).startTestRun()
528
self.stream.write('running %d tests...\n' % self.num_tests)
530
def report_test_start(self, test):
532
name = self._shortened_test_description(test)
533
width = osutils.terminal_width()
534
if width is not None:
535
# width needs space for 6 char status, plus 1 for slash, plus an
536
# 11-char time string, plus a trailing blank
537
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
539
self.stream.write(self._ellipsize_to_right(name, width-18))
541
self.stream.write(name)
544
def _error_summary(self, err):
546
return '%s%s' % (indent, err[1])
548
def report_error(self, test, err):
549
self.stream.writeln('ERROR %s\n%s'
550
% (self._testTimeString(test),
551
self._error_summary(err)))
553
def report_failure(self, test, err):
554
self.stream.writeln(' FAIL %s\n%s'
555
% (self._testTimeString(test),
556
self._error_summary(err)))
558
def report_known_failure(self, test, err):
559
self.stream.writeln('XFAIL %s\n%s'
560
% (self._testTimeString(test),
561
self._error_summary(err)))
563
def report_success(self, test):
564
self.stream.writeln(' OK %s' % self._testTimeString(test))
565
for bench_called, stats in getattr(test, '_benchcalls', []):
566
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
567
stats.pprint(file=self.stream)
568
# flush the stream so that we get smooth output. This verbose mode is
569
# used to show the output in PQM.
572
def report_skip(self, test, reason):
573
self.stream.writeln(' SKIP %s\n%s'
574
% (self._testTimeString(test), reason))
576
def report_not_applicable(self, test, reason):
577
self.stream.writeln(' N/A %s\n %s'
578
% (self._testTimeString(test), reason))
580
def report_unsupported(self, test, feature):
581
"""test cannot be run because feature is missing."""
582
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
583
%(self._testTimeString(test), feature))
255
def addSkipped(self, test, skip_excinfo):
256
self.extractBenchmarkTime(test)
258
print >>self.stream, ' SKIP %s' % self._testTimeString()
259
print >>self.stream, ' %s' % skip_excinfo[1]
260
elif self.dots and self.pb is None:
261
self.stream.write('S')
263
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
265
# seems best to treat this as success from point-of-view of unittest
266
# -- it actually does nothing so it barely matters :)
269
except KeyboardInterrupt:
272
self.addError(test, test.__exc_info())
274
unittest.TestResult.addSuccess(self, test)
276
def printErrorList(self, flavour, errors):
277
for test, err in errors:
278
self.stream.writeln(self.separator1)
279
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
280
if getattr(test, '_get_log', None) is not None:
282
print >>self.stream, \
283
('vvvv[log from %s]' % test.id()).ljust(78,'-')
284
print >>self.stream, test._get_log()
285
print >>self.stream, \
286
('^^^^[log from %s]' % test.id()).ljust(78,'-')
287
self.stream.writeln(self.separator2)
288
self.stream.writeln("%s" % err)
586
291
class TextTestRunner(object):
2047
855
sys.stderr = real_stderr
2048
856
sys.stdin = real_stdin
2050
def reduceLockdirTimeout(self):
2051
"""Reduce the default lock timeout for the duration of the test, so that
2052
if LockContention occurs during a test, it does so quickly.
2054
Tests that expect to provoke LockContention errors should call this.
2056
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2058
def make_utf8_encoded_stringio(self, encoding_type=None):
2059
"""Return a StringIOWrapper instance, that will encode Unicode
2062
if encoding_type is None:
2063
encoding_type = 'strict'
2065
output_encoding = 'utf-8'
2066
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2067
sio.encoding = output_encoding
2070
def disable_verb(self, verb):
2071
"""Disable a smart server verb for one test."""
2072
from bzrlib.smart import request
2073
request_handlers = request.request_handlers
2074
orig_method = request_handlers.get(verb)
2075
request_handlers.remove(verb)
2076
self.addCleanup(request_handlers.register, verb, orig_method)
2079
class CapturedCall(object):
2080
"""A helper for capturing smart server calls for easy debug analysis."""
2082
def __init__(self, params, prefix_length):
2083
"""Capture the call with params and skip prefix_length stack frames."""
2086
# The last 5 frames are the __init__, the hook frame, and 3 smart
2087
# client frames. Beyond this we could get more clever, but this is good
2089
stack = traceback.extract_stack()[prefix_length:-5]
2090
self.stack = ''.join(traceback.format_list(stack))
2093
return self.call.method
2096
return self.call.method
2102
class TestCaseWithMemoryTransport(TestCase):
2103
"""Common test class for tests that do not need disk resources.
2105
Tests that need disk resources should derive from TestCaseWithTransport.
2107
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2109
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2110
a directory which does not exist. This serves to help ensure test isolation
2111
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2112
must exist. However, TestCaseWithMemoryTransport does not offer local
2113
file defaults for the transport in tests, nor does it obey the command line
2114
override, so tests that accidentally write to the common directory should
2117
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2118
a .bzr directory that stops us ascending higher into the filesystem.
2124
def __init__(self, methodName='runTest'):
2125
# allow test parameterization after test construction and before test
2126
# execution. Variables that the parameterizer sets need to be
2127
# ones that are not set by setUp, or setUp will trash them.
2128
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2129
self.vfs_transport_factory = default_transport
2130
self.transport_server = None
2131
self.transport_readonly_server = None
2132
self.__vfs_server = None
2134
def get_transport(self, relpath=None):
2135
"""Return a writeable transport.
2137
This transport is for the test scratch space relative to
2140
:param relpath: a path relative to the base url.
2142
t = get_transport(self.get_url(relpath))
2143
self.assertFalse(t.is_readonly())
2146
def get_readonly_transport(self, relpath=None):
2147
"""Return a readonly transport for the test scratch space
2149
This can be used to test that operations which should only need
2150
readonly access in fact do not try to write.
2152
:param relpath: a path relative to the base url.
2154
t = get_transport(self.get_readonly_url(relpath))
2155
self.assertTrue(t.is_readonly())
2158
def create_transport_readonly_server(self):
2159
"""Create a transport server from class defined at init.
2161
This is mostly a hook for daughter classes.
2163
return self.transport_readonly_server()
2165
def get_readonly_server(self):
2166
"""Get the server instance for the readonly transport
2168
This is useful for some tests with specific servers to do diagnostics.
2170
if self.__readonly_server is None:
2171
if self.transport_readonly_server is None:
2172
# readonly decorator requested
2173
self.__readonly_server = ReadonlyServer()
2175
# explicit readonly transport.
2176
self.__readonly_server = self.create_transport_readonly_server()
2177
self.start_server(self.__readonly_server,
2178
self.get_vfs_only_server())
2179
return self.__readonly_server
2181
def get_readonly_url(self, relpath=None):
2182
"""Get a URL for the readonly transport.
2184
This will either be backed by '.' or a decorator to the transport
2185
used by self.get_url()
2186
relpath provides for clients to get a path relative to the base url.
2187
These should only be downwards relative, not upwards.
2189
base = self.get_readonly_server().get_url()
2190
return self._adjust_url(base, relpath)
2192
def get_vfs_only_server(self):
2193
"""Get the vfs only read/write server instance.
2195
This is useful for some tests with specific servers that need
2198
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2199
is no means to override it.
2201
if self.__vfs_server is None:
2202
self.__vfs_server = MemoryServer()
2203
self.start_server(self.__vfs_server)
2204
return self.__vfs_server
2206
def get_server(self):
2207
"""Get the read/write server instance.
2209
This is useful for some tests with specific servers that need
2212
This is built from the self.transport_server factory. If that is None,
2213
then the self.get_vfs_server is returned.
2215
if self.__server is None:
2216
if (self.transport_server is None or self.transport_server is
2217
self.vfs_transport_factory):
2218
self.__server = self.get_vfs_only_server()
2220
# bring up a decorated means of access to the vfs only server.
2221
self.__server = self.transport_server()
2222
self.start_server(self.__server, self.get_vfs_only_server())
2223
return self.__server
2225
def _adjust_url(self, base, relpath):
2226
"""Get a URL (or maybe a path) for the readwrite transport.
2228
This will either be backed by '.' or to an equivalent non-file based
2230
relpath provides for clients to get a path relative to the base url.
2231
These should only be downwards relative, not upwards.
2233
if relpath is not None and relpath != '.':
2234
if not base.endswith('/'):
2236
# XXX: Really base should be a url; we did after all call
2237
# get_url()! But sometimes it's just a path (from
2238
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2239
# to a non-escaped local path.
2240
if base.startswith('./') or base.startswith('/'):
2243
base += urlutils.escape(relpath)
2246
def get_url(self, relpath=None):
2247
"""Get a URL (or maybe a path) for the readwrite transport.
2249
This will either be backed by '.' or to an equivalent non-file based
2251
relpath provides for clients to get a path relative to the base url.
2252
These should only be downwards relative, not upwards.
2254
base = self.get_server().get_url()
2255
return self._adjust_url(base, relpath)
2257
def get_vfs_only_url(self, relpath=None):
2258
"""Get a URL (or maybe a path for the plain old vfs transport.
2260
This will never be a smart protocol. It always has all the
2261
capabilities of the local filesystem, but it might actually be a
2262
MemoryTransport or some other similar virtual filesystem.
2264
This is the backing transport (if any) of the server returned by
2265
get_url and get_readonly_url.
2267
:param relpath: provides for clients to get a path relative to the base
2268
url. These should only be downwards relative, not upwards.
2271
base = self.get_vfs_only_server().get_url()
2272
return self._adjust_url(base, relpath)
2274
def _create_safety_net(self):
2275
"""Make a fake bzr directory.
2277
This prevents any tests propagating up onto the TEST_ROOT directory's
2280
root = TestCaseWithMemoryTransport.TEST_ROOT
2281
bzrdir.BzrDir.create_standalone_workingtree(root)
2283
def _check_safety_net(self):
2284
"""Check that the safety .bzr directory have not been touched.
2286
_make_test_root have created a .bzr directory to prevent tests from
2287
propagating. This method ensures than a test did not leaked.
2289
root = TestCaseWithMemoryTransport.TEST_ROOT
2290
self.permit_url(get_transport(root).base)
2291
wt = workingtree.WorkingTree.open(root)
2292
last_rev = wt.last_revision()
2293
if last_rev != 'null:':
2294
# The current test have modified the /bzr directory, we need to
2295
# recreate a new one or all the followng tests will fail.
2296
# If you need to inspect its content uncomment the following line
2297
# import pdb; pdb.set_trace()
2298
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2299
self._create_safety_net()
2300
raise AssertionError('%s/.bzr should not be modified' % root)
2302
def _make_test_root(self):
2303
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2304
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2305
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2307
TestCaseWithMemoryTransport.TEST_ROOT = root
2309
self._create_safety_net()
2311
# The same directory is used by all tests, and we're not
2312
# specifically told when all tests are finished. This will do.
2313
atexit.register(_rmtree_temp_dir, root)
2315
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2316
self.addCleanup(self._check_safety_net)
2318
def makeAndChdirToTestDir(self):
2319
"""Create a temporary directories for this one test.
2321
This must set self.test_home_dir and self.test_dir and chdir to
2324
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2326
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2327
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2328
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2329
self.permit_dir(self.test_dir)
2331
def make_branch(self, relpath, format=None):
2332
"""Create a branch on the transport at relpath."""
2333
repo = self.make_repository(relpath, format=format)
2334
return repo.bzrdir.create_branch()
2336
def make_bzrdir(self, relpath, format=None):
2338
# might be a relative or absolute path
2339
maybe_a_url = self.get_url(relpath)
2340
segments = maybe_a_url.rsplit('/', 1)
2341
t = get_transport(maybe_a_url)
2342
if len(segments) > 1 and segments[-1] not in ('', '.'):
2346
if isinstance(format, basestring):
2347
format = bzrdir.format_registry.make_bzrdir(format)
2348
return format.initialize_on_transport(t)
2349
except errors.UninitializableFormat:
2350
raise TestSkipped("Format %s is not initializable." % format)
2352
def make_repository(self, relpath, shared=False, format=None):
2353
"""Create a repository on our default transport at relpath.
2355
Note that relpath must be a relative path, not a full url.
2357
# FIXME: If you create a remoterepository this returns the underlying
2358
# real format, which is incorrect. Actually we should make sure that
2359
# RemoteBzrDir returns a RemoteRepository.
2360
# maybe mbp 20070410
2361
made_control = self.make_bzrdir(relpath, format=format)
2362
return made_control.create_repository(shared=shared)
2364
def make_smart_server(self, path):
2365
smart_server = server.SmartTCPServer_for_testing()
2366
self.start_server(smart_server, self.get_server())
2367
remote_transport = get_transport(smart_server.get_url()).clone(path)
2368
return remote_transport
2370
def make_branch_and_memory_tree(self, relpath, format=None):
2371
"""Create a branch on the default transport and a MemoryTree for it."""
2372
b = self.make_branch(relpath, format=format)
2373
return memorytree.MemoryTree.create_on_branch(b)
2375
def make_branch_builder(self, relpath, format=None):
2376
branch = self.make_branch(relpath, format=format)
2377
return branchbuilder.BranchBuilder(branch=branch)
2379
def overrideEnvironmentForTesting(self):
2380
test_home_dir = self.test_home_dir
2381
if isinstance(test_home_dir, unicode):
2382
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2383
os.environ['HOME'] = test_home_dir
2384
os.environ['BZR_HOME'] = test_home_dir
2387
super(TestCaseWithMemoryTransport, self).setUp()
2388
self._make_test_root()
2389
self.addCleanup(os.chdir, os.getcwdu())
2390
self.makeAndChdirToTestDir()
2391
self.overrideEnvironmentForTesting()
2392
self.__readonly_server = None
2393
self.__server = None
2394
self.reduceLockdirTimeout()
2396
def setup_smart_server_with_call_log(self):
2397
"""Sets up a smart server as the transport server with a call log."""
2398
self.transport_server = server.SmartTCPServer_for_testing
2399
self.hpss_calls = []
2401
# Skip the current stack down to the caller of
2402
# setup_smart_server_with_call_log
2403
prefix_length = len(traceback.extract_stack()) - 2
2404
def capture_hpss_call(params):
2405
self.hpss_calls.append(
2406
CapturedCall(params, prefix_length))
2407
client._SmartClient.hooks.install_named_hook(
2408
'call', capture_hpss_call, None)
2410
def reset_smart_call_log(self):
2411
self.hpss_calls = []
2414
class TestCaseInTempDir(TestCaseWithMemoryTransport):
858
def merge(self, branch_from, wt_to):
859
"""A helper for tests to do a ui-less merge.
861
This should move to the main library when someone has time to integrate
864
# minimal ui-less merge.
865
wt_to.branch.fetch(branch_from)
866
base_rev = common_ancestor(branch_from.last_revision(),
867
wt_to.branch.last_revision(),
868
wt_to.branch.repository)
869
merge_inner(wt_to.branch, branch_from.basis_tree(),
870
wt_to.branch.repository.revision_tree(base_rev),
872
wt_to.add_pending_merge(branch_from.last_revision())
875
BzrTestBase = TestCase
878
class TestCaseInTempDir(TestCase):
2415
879
"""Derived class that runs a test within a temporary directory.
2417
881
This is useful for tests that need to create a branch, etc.
2674
1170
for readonly urls.
2676
1172
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2677
be used without needed to redo it when a different
1173
be used without needed to redo it when a different
2678
1174
subclass is in use ?
2681
1177
def setUp(self):
2682
1178
super(ChrootedTestCase, self).setUp()
2683
if not self.vfs_transport_factory == MemoryServer:
2684
self.transport_readonly_server = HttpServer
2687
def condition_id_re(pattern):
2688
"""Create a condition filter which performs a re check on a test's id.
2690
:param pattern: A regular expression string.
2691
:return: A callable that returns True if the re matches.
2693
filter_re = osutils.re_compile_checked(pattern, 0,
2695
def condition(test):
2697
return filter_re.search(test_id)
2701
def condition_isinstance(klass_or_klass_list):
2702
"""Create a condition filter which returns isinstance(param, klass).
2704
:return: A callable which when called with one parameter obj return the
2705
result of isinstance(obj, klass_or_klass_list).
2708
return isinstance(obj, klass_or_klass_list)
2712
def condition_id_in_list(id_list):
2713
"""Create a condition filter which verify that test's id in a list.
2715
:param id_list: A TestIdList object.
2716
:return: A callable that returns True if the test's id appears in the list.
2718
def condition(test):
2719
return id_list.includes(test.id())
2723
def condition_id_startswith(starts):
2724
"""Create a condition filter verifying that test's id starts with a string.
2726
:param starts: A list of string.
2727
:return: A callable that returns True if the test's id starts with one of
2730
def condition(test):
2731
for start in starts:
2732
if test.id().startswith(start):
2738
def exclude_tests_by_condition(suite, condition):
2739
"""Create a test suite which excludes some tests from suite.
2741
:param suite: The suite to get tests from.
2742
:param condition: A callable whose result evaluates True when called with a
2743
test case which should be excluded from the result.
2744
:return: A suite which contains the tests found in suite that fail
2748
for test in iter_suite_tests(suite):
2749
if not condition(test):
2751
return TestUtil.TestSuite(result)
2754
def filter_suite_by_condition(suite, condition):
2755
"""Create a test suite by filtering another one.
2757
:param suite: The source suite.
2758
:param condition: A callable whose result evaluates True when called with a
2759
test case which should be included in the result.
2760
:return: A suite which contains the tests found in suite that pass
2764
for test in iter_suite_tests(suite):
2767
return TestUtil.TestSuite(result)
1179
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1180
self.transport_readonly_server = bzrlib.transport.http.HttpServer
2770
1183
def filter_suite_by_re(suite, pattern):
2771
"""Create a test suite by filtering another one.
2773
:param suite: the source suite
2774
:param pattern: pattern that names must match
2775
:returns: the newly created suite
2777
condition = condition_id_re(pattern)
2778
result_suite = filter_suite_by_condition(suite, condition)
2782
def filter_suite_by_id_list(suite, test_id_list):
2783
"""Create a test suite by filtering another one.
2785
:param suite: The source suite.
2786
:param test_id_list: A list of the test ids to keep as strings.
2787
:returns: the newly created suite
2789
condition = condition_id_in_list(test_id_list)
2790
result_suite = filter_suite_by_condition(suite, condition)
2794
def filter_suite_by_id_startswith(suite, start):
2795
"""Create a test suite by filtering another one.
2797
:param suite: The source suite.
2798
:param start: A list of string the test id must start with one of.
2799
:returns: the newly created suite
2801
condition = condition_id_startswith(start)
2802
result_suite = filter_suite_by_condition(suite, condition)
2806
def exclude_tests_by_re(suite, pattern):
2807
"""Create a test suite which excludes some tests from suite.
2809
:param suite: The suite to get tests from.
2810
:param pattern: A regular expression string. Test ids that match this
2811
pattern will be excluded from the result.
2812
:return: A TestSuite that contains all the tests from suite without the
2813
tests that matched pattern. The order of tests is the same as it was in
2816
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2819
def preserve_input(something):
2820
"""A helper for performing test suite transformation chains.
2822
:param something: Anything you want to preserve.
2828
def randomize_suite(suite):
2829
"""Return a new TestSuite with suite's tests in random order.
2831
The tests in the input suite are flattened into a single suite in order to
2832
accomplish this. Any nested TestSuites are removed to provide global
2835
tests = list(iter_suite_tests(suite))
2836
random.shuffle(tests)
2837
return TestUtil.TestSuite(tests)
2840
def split_suite_by_condition(suite, condition):
2841
"""Split a test suite into two by a condition.
2843
:param suite: The suite to split.
2844
:param condition: The condition to match on. Tests that match this
2845
condition are returned in the first test suite, ones that do not match
2846
are in the second suite.
2847
:return: A tuple of two test suites, where the first contains tests from
2848
suite matching the condition, and the second contains the remainder
2849
from suite. The order within each output suite is the same as it was in
1184
result = TestUtil.TestSuite()
1185
filter_re = re.compile(pattern)
2854
1186
for test in iter_suite_tests(suite):
2856
matched.append(test)
2858
did_not_match.append(test)
2859
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2862
def split_suite_by_re(suite, pattern):
2863
"""Split a test suite into two by a regular expression.
2865
:param suite: The suite to split.
2866
:param pattern: A regular expression string. Test ids that match this
2867
pattern will be in the first test suite returned, and the others in the
2868
second test suite returned.
2869
:return: A tuple of two test suites, where the first contains tests from
2870
suite matching pattern, and the second contains the remainder from
2871
suite. The order within each output suite is the same as it was in
2874
return split_suite_by_condition(suite, condition_id_re(pattern))
1187
if filter_re.search(test.id()):
1188
result.addTest(test)
2877
1192
def run_suite(suite, name='test', verbose=False, pattern=".*",
2878
stop_on_failure=False,
2879
transport=None, lsprof_timed=None, bench_history=None,
2880
matching_tests_first=None,
2883
exclude_pattern=None,
2886
suite_decorators=None,
2888
result_decorators=None,
2890
"""Run a test suite for bzr selftest.
2892
:param runner_class: The class of runner to use. Must support the
2893
constructor arguments passed by run_suite which are more than standard
2895
:return: A boolean indicating success.
1193
stop_on_failure=False, keep_output=False,
1194
transport=None, lsprof_timed=None):
1195
TestCaseInTempDir._TEST_NAME = name
2897
1196
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2902
if runner_class is None:
2903
runner_class = TextTestRunner
2906
runner = runner_class(stream=stream,
1202
pb = progress.ProgressBar()
1203
runner = TextTestRunner(stream=sys.stdout,
2907
1204
descriptions=0,
2908
1205
verbosity=verbosity,
2909
bench_history=bench_history,
2911
result_decorators=result_decorators,
1206
keep_output=keep_output,
2913
1208
runner.stop_on_failure=stop_on_failure
2914
# built in decorator factories:
2916
random_order(random_seed, runner),
2917
exclude_tests(exclude_pattern),
2919
if matching_tests_first:
2920
decorators.append(tests_first(pattern))
2922
decorators.append(filter_tests(pattern))
2923
if suite_decorators:
2924
decorators.extend(suite_decorators)
2925
# tell the result object how many tests will be running: (except if
2926
# --parallel=fork is being used. Robert said he will provide a better
2927
# progress design later -- vila 20090817)
2928
if fork_decorator not in decorators:
2929
decorators.append(CountingDecorator)
2930
for decorator in decorators:
2931
suite = decorator(suite)
2933
# Done after test suite decoration to allow randomisation etc
2934
# to take effect, though that is of marginal benefit.
2936
stream.write("Listing tests only ...\n")
2937
for t in iter_suite_tests(suite):
2938
stream.write("%s\n" % (t.id()))
1210
suite = filter_suite_by_re(suite, pattern)
2940
1211
result = runner.run(suite)
2942
return result.wasStrictlySuccessful()
2944
return result.wasSuccessful()
2947
# A registry where get() returns a suite decorator.
2948
parallel_registry = registry.Registry()
2951
def fork_decorator(suite):
2952
concurrency = osutils.local_concurrency()
2953
if concurrency == 1:
2955
from testtools import ConcurrentTestSuite
2956
return ConcurrentTestSuite(suite, fork_for_tests)
2957
parallel_registry.register('fork', fork_decorator)
2960
def subprocess_decorator(suite):
2961
concurrency = osutils.local_concurrency()
2962
if concurrency == 1:
2964
from testtools import ConcurrentTestSuite
2965
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2966
parallel_registry.register('subprocess', subprocess_decorator)
2969
def exclude_tests(exclude_pattern):
2970
"""Return a test suite decorator that excludes tests."""
2971
if exclude_pattern is None:
2972
return identity_decorator
2973
def decorator(suite):
2974
return ExcludeDecorator(suite, exclude_pattern)
2978
def filter_tests(pattern):
2980
return identity_decorator
2981
def decorator(suite):
2982
return FilterTestsDecorator(suite, pattern)
2986
def random_order(random_seed, runner):
2987
"""Return a test suite decorator factory for randomising tests order.
2989
:param random_seed: now, a string which casts to a long, or a long.
2990
:param runner: A test runner with a stream attribute to report on.
2992
if random_seed is None:
2993
return identity_decorator
2994
def decorator(suite):
2995
return RandomDecorator(suite, random_seed, runner.stream)
2999
def tests_first(pattern):
3001
return identity_decorator
3002
def decorator(suite):
3003
return TestFirstDecorator(suite, pattern)
3007
def identity_decorator(suite):
3012
class TestDecorator(TestSuite):
3013
"""A decorator for TestCase/TestSuite objects.
3015
Usually, subclasses should override __iter__(used when flattening test
3016
suites), which we do to filter, reorder, parallelise and so on, run() and
3020
def __init__(self, suite):
3021
TestSuite.__init__(self)
3024
def countTestCases(self):
3027
cases += test.countTestCases()
3034
def run(self, result):
3035
# Use iteration on self, not self._tests, to allow subclasses to hook
3038
if result.shouldStop:
3044
class CountingDecorator(TestDecorator):
3045
"""A decorator which calls result.progress(self.countTestCases)."""
3047
def run(self, result):
3048
progress_method = getattr(result, 'progress', None)
3049
if callable(progress_method):
3050
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3051
return super(CountingDecorator, self).run(result)
3054
class ExcludeDecorator(TestDecorator):
3055
"""A decorator which excludes test matching an exclude pattern."""
3057
def __init__(self, suite, exclude_pattern):
3058
TestDecorator.__init__(self, suite)
3059
self.exclude_pattern = exclude_pattern
3060
self.excluded = False
3064
return iter(self._tests)
3065
self.excluded = True
3066
suite = exclude_tests_by_re(self, self.exclude_pattern)
3068
self.addTests(suite)
3069
return iter(self._tests)
3072
class FilterTestsDecorator(TestDecorator):
3073
"""A decorator which filters tests to those matching a pattern."""
3075
def __init__(self, suite, pattern):
3076
TestDecorator.__init__(self, suite)
3077
self.pattern = pattern
3078
self.filtered = False
3082
return iter(self._tests)
3083
self.filtered = True
3084
suite = filter_suite_by_re(self, self.pattern)
3086
self.addTests(suite)
3087
return iter(self._tests)
3090
class RandomDecorator(TestDecorator):
3091
"""A decorator which randomises the order of its tests."""
3093
def __init__(self, suite, random_seed, stream):
3094
TestDecorator.__init__(self, suite)
3095
self.random_seed = random_seed
3096
self.randomised = False
3097
self.stream = stream
3101
return iter(self._tests)
3102
self.randomised = True
3103
self.stream.write("Randomizing test order using seed %s\n\n" %
3104
(self.actual_seed()))
3105
# Initialise the random number generator.
3106
random.seed(self.actual_seed())
3107
suite = randomize_suite(self)
3109
self.addTests(suite)
3110
return iter(self._tests)
3112
def actual_seed(self):
3113
if self.random_seed == "now":
3114
# We convert the seed to a long to make it reuseable across
3115
# invocations (because the user can reenter it).
3116
self.random_seed = long(time.time())
3118
# Convert the seed to a long if we can
3120
self.random_seed = long(self.random_seed)
3123
return self.random_seed
3126
class TestFirstDecorator(TestDecorator):
3127
"""A decorator which moves named tests to the front."""
3129
def __init__(self, suite, pattern):
3130
TestDecorator.__init__(self, suite)
3131
self.pattern = pattern
3132
self.filtered = False
3136
return iter(self._tests)
3137
self.filtered = True
3138
suites = split_suite_by_re(self, self.pattern)
3140
self.addTests(suites)
3141
return iter(self._tests)
3144
def partition_tests(suite, count):
3145
"""Partition suite into count lists of tests."""
3147
tests = list(iter_suite_tests(suite))
3148
tests_per_process = int(math.ceil(float(len(tests)) / count))
3149
for block in range(count):
3150
low_test = block * tests_per_process
3151
high_test = low_test + tests_per_process
3152
process_tests = tests[low_test:high_test]
3153
result.append(process_tests)
3157
def fork_for_tests(suite):
3158
"""Take suite and start up one runner per CPU by forking()
3160
:return: An iterable of TestCase-like objects which can each have
3161
run(result) called on them to feed tests to result.
3163
concurrency = osutils.local_concurrency()
3165
from subunit import TestProtocolClient, ProtocolTestCase
3166
from subunit.test_results import AutoTimingTestResultDecorator
3167
class TestInOtherProcess(ProtocolTestCase):
3168
# Should be in subunit, I think. RBC.
3169
def __init__(self, stream, pid):
3170
ProtocolTestCase.__init__(self, stream)
3173
def run(self, result):
3175
ProtocolTestCase.run(self, result)
3177
os.waitpid(self.pid, os.WNOHANG)
3179
test_blocks = partition_tests(suite, concurrency)
3180
for process_tests in test_blocks:
3181
process_suite = TestSuite()
3182
process_suite.addTests(process_tests)
3183
c2pread, c2pwrite = os.pipe()
3188
# Leave stderr and stdout open so we can see test noise
3189
# Close stdin so that the child goes away if it decides to
3190
# read from stdin (otherwise its a roulette to see what
3191
# child actually gets keystrokes for pdb etc).
3194
stream = os.fdopen(c2pwrite, 'wb', 1)
3195
subunit_result = AutoTimingTestResultDecorator(
3196
TestProtocolClient(stream))
3197
process_suite.run(subunit_result)
3202
stream = os.fdopen(c2pread, 'rb', 1)
3203
test = TestInOtherProcess(stream, pid)
3208
def reinvoke_for_tests(suite):
3209
"""Take suite and start up one runner per CPU using subprocess().
3211
:return: An iterable of TestCase-like objects which can each have
3212
run(result) called on them to feed tests to result.
3214
concurrency = osutils.local_concurrency()
3216
from subunit import ProtocolTestCase
3217
class TestInSubprocess(ProtocolTestCase):
3218
def __init__(self, process, name):
3219
ProtocolTestCase.__init__(self, process.stdout)
3220
self.process = process
3221
self.process.stdin.close()
3224
def run(self, result):
3226
ProtocolTestCase.run(self, result)
3229
os.unlink(self.name)
3230
# print "pid %d finished" % finished_process
3231
test_blocks = partition_tests(suite, concurrency)
3232
for process_tests in test_blocks:
3233
# ugly; currently reimplement rather than reuses TestCase methods.
3234
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3235
if not os.path.isfile(bzr_path):
3236
# We are probably installed. Assume sys.argv is the right file
3237
bzr_path = sys.argv[0]
3238
bzr_path = [bzr_path]
3239
if sys.platform == "win32":
3240
# if we're on windows, we can't execute the bzr script directly
3241
bzr_path = [sys.executable] + bzr_path
3242
fd, test_list_file_name = tempfile.mkstemp()
3243
test_list_file = os.fdopen(fd, 'wb', 1)
3244
for test in process_tests:
3245
test_list_file.write(test.id() + '\n')
3246
test_list_file.close()
3248
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3250
if '--no-plugins' in sys.argv:
3251
argv.append('--no-plugins')
3252
# stderr=STDOUT would be ideal, but until we prevent noise on
3253
# stderr it can interrupt the subunit protocol.
3254
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3256
test = TestInSubprocess(process, test_list_file_name)
3259
os.unlink(test_list_file_name)
3264
class ForwardingResult(unittest.TestResult):
3266
def __init__(self, target):
3267
unittest.TestResult.__init__(self)
3268
self.result = target
3270
def startTest(self, test):
3271
self.result.startTest(test)
3273
def stopTest(self, test):
3274
self.result.stopTest(test)
3276
def startTestRun(self):
3277
self.result.startTestRun()
3279
def stopTestRun(self):
3280
self.result.stopTestRun()
3282
def addSkip(self, test, reason):
3283
self.result.addSkip(test, reason)
3285
def addSuccess(self, test):
3286
self.result.addSuccess(test)
3288
def addError(self, test, err):
3289
self.result.addError(test, err)
3291
def addFailure(self, test, err):
3292
self.result.addFailure(test, err)
3293
ForwardingResult = testtools.ExtendedToOriginalDecorator
3296
class ProfileResult(ForwardingResult):
3297
"""Generate profiling data for all activity between start and success.
3299
The profile data is appended to the test's _benchcalls attribute and can
3300
be accessed by the forwarded-to TestResult.
3302
While it might be cleaner do accumulate this in stopTest, addSuccess is
3303
where our existing output support for lsprof is, and this class aims to
3304
fit in with that: while it could be moved it's not necessary to accomplish
3305
test profiling, nor would it be dramatically cleaner.
3308
def startTest(self, test):
3309
self.profiler = bzrlib.lsprof.BzrProfiler()
3310
self.profiler.start()
3311
ForwardingResult.startTest(self, test)
3313
def addSuccess(self, test):
3314
stats = self.profiler.stop()
3316
calls = test._benchcalls
3317
except AttributeError:
3318
test._benchcalls = []
3319
calls = test._benchcalls
3320
calls.append(((test.id(), "", ""), stats))
3321
ForwardingResult.addSuccess(self, test)
3323
def stopTest(self, test):
3324
ForwardingResult.stopTest(self, test)
3325
self.profiler = None
3328
# Controlled by "bzr selftest -E=..." option
3329
# Currently supported:
3330
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3331
# preserves any flags supplied at the command line.
3332
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3333
# rather than failing tests. And no longer raise
3334
# LockContention when fctnl locks are not being used
3335
# with proper exclusion rules.
3336
selftest_debug_flags = set()
1212
return result.wasSuccessful()
3339
1215
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3340
1217
transport=None,
3341
1218
test_suite_factory=None,
3344
matching_tests_first=None,
3347
exclude_pattern=None,
3353
suite_decorators=None,
3357
1220
"""Run the whole test suite under the enhanced runner"""
3358
# XXX: Very ugly way to do this...
3359
# Disable warning about old formats because we don't want it to disturb
3360
# any blackbox tests.
3361
from bzrlib import repository
3362
repository._deprecation_warning_done = True
3364
1221
global default_transport
3365
1222
if transport is None:
3366
1223
transport = default_transport
3367
1224
old_transport = default_transport
3368
1225
default_transport = transport
3369
global selftest_debug_flags
3370
old_debug_flags = selftest_debug_flags
3371
if debug_flags is not None:
3372
selftest_debug_flags = set(debug_flags)
3374
if load_list is None:
3377
keep_only = load_test_id_list(load_list)
3379
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3380
for start in starting_with]
3381
1227
if test_suite_factory is None:
3382
# Reduce loading time by loading modules based on the starting_with
3384
suite = test_suite(keep_only, starting_with)
1228
suite = test_suite()
3386
1230
suite = test_suite_factory()
3388
# But always filter as requested.
3389
suite = filter_suite_by_id_startswith(suite, starting_with)
3390
result_decorators = []
3392
result_decorators.append(ProfileResult)
3393
1231
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3394
stop_on_failure=stop_on_failure,
1232
stop_on_failure=stop_on_failure, keep_output=keep_output,
3395
1233
transport=transport,
3396
lsprof_timed=lsprof_timed,
3397
bench_history=bench_history,
3398
matching_tests_first=matching_tests_first,
3399
list_only=list_only,
3400
random_seed=random_seed,
3401
exclude_pattern=exclude_pattern,
3403
runner_class=runner_class,
3404
suite_decorators=suite_decorators,
3406
result_decorators=result_decorators,
1234
lsprof_timed=lsprof_timed)
3409
1236
default_transport = old_transport
3410
selftest_debug_flags = old_debug_flags
3413
def load_test_id_list(file_name):
3414
"""Load a test id list from a text file.
3416
The format is one test id by line. No special care is taken to impose
3417
strict rules, these test ids are used to filter the test suite so a test id
3418
that do not match an existing test will do no harm. This allows user to add
3419
comments, leave blank lines, etc.
3423
ftest = open(file_name, 'rt')
3425
if e.errno != errno.ENOENT:
3428
raise errors.NoSuchFile(file_name)
3430
for test_name in ftest.readlines():
3431
test_list.append(test_name.strip())
3436
def suite_matches_id_list(test_suite, id_list):
3437
"""Warns about tests not appearing or appearing more than once.
3439
:param test_suite: A TestSuite object.
3440
:param test_id_list: The list of test ids that should be found in
3443
:return: (absents, duplicates) absents is a list containing the test found
3444
in id_list but not in test_suite, duplicates is a list containing the
3445
test found multiple times in test_suite.
3447
When using a prefined test id list, it may occurs that some tests do not
3448
exist anymore or that some tests use the same id. This function warns the
3449
tester about potential problems in his workflow (test lists are volatile)
3450
or in the test suite itself (using the same id for several tests does not
3451
help to localize defects).
3453
# Build a dict counting id occurrences
3455
for test in iter_suite_tests(test_suite):
3457
tests[id] = tests.get(id, 0) + 1
3462
occurs = tests.get(id, 0)
3464
not_found.append(id)
3466
duplicates.append(id)
3468
return not_found, duplicates
3471
class TestIdList(object):
3472
"""Test id list to filter a test suite.
3474
Relying on the assumption that test ids are built as:
3475
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3476
notation, this class offers methods to :
3477
- avoid building a test suite for modules not refered to in the test list,
3478
- keep only the tests listed from the module test suite.
3481
def __init__(self, test_id_list):
3482
# When a test suite needs to be filtered against us we compare test ids
3483
# for equality, so a simple dict offers a quick and simple solution.
3484
self.tests = dict().fromkeys(test_id_list, True)
3486
# While unittest.TestCase have ids like:
3487
# <module>.<class>.<method>[(<param+)],
3488
# doctest.DocTestCase can have ids like:
3491
# <module>.<function>
3492
# <module>.<class>.<method>
3494
# Since we can't predict a test class from its name only, we settle on
3495
# a simple constraint: a test id always begins with its module name.
3498
for test_id in test_id_list:
3499
parts = test_id.split('.')
3500
mod_name = parts.pop(0)
3501
modules[mod_name] = True
3503
mod_name += '.' + part
3504
modules[mod_name] = True
3505
self.modules = modules
3507
def refers_to(self, module_name):
3508
"""Is there tests for the module or one of its sub modules."""
3509
return self.modules.has_key(module_name)
3511
def includes(self, test_id):
3512
return self.tests.has_key(test_id)
3515
class TestPrefixAliasRegistry(registry.Registry):
3516
"""A registry for test prefix aliases.
3518
This helps implement shorcuts for the --starting-with selftest
3519
option. Overriding existing prefixes is not allowed but not fatal (a
3520
warning will be emitted).
3523
def register(self, key, obj, help=None, info=None,
3524
override_existing=False):
3525
"""See Registry.register.
3527
Trying to override an existing alias causes a warning to be emitted,
3528
not a fatal execption.
3531
super(TestPrefixAliasRegistry, self).register(
3532
key, obj, help=help, info=info, override_existing=False)
3534
actual = self.get(key)
3535
note('Test prefix alias %s is already used for %s, ignoring %s'
3536
% (key, actual, obj))
3538
def resolve_alias(self, id_start):
3539
"""Replace the alias by the prefix in the given string.
3541
Using an unknown prefix is an error to help catching typos.
3543
parts = id_start.split('.')
3545
parts[0] = self.get(parts[0])
3547
raise errors.BzrCommandError(
3548
'%s is not a known test prefix alias' % parts[0])
3549
return '.'.join(parts)
3552
test_prefix_alias_registry = TestPrefixAliasRegistry()
3553
"""Registry of test prefix aliases."""
3556
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3557
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3558
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3560
# Obvious higest levels prefixes, feel free to add your own via a plugin
3561
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3562
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3563
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3564
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3565
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3568
def _test_suite_testmod_names():
3569
"""Return the standard list of test module names to test."""
3572
'bzrlib.tests.blackbox',
3573
'bzrlib.tests.commands',
3574
'bzrlib.tests.per_branch',
3575
'bzrlib.tests.per_bzrdir',
3576
'bzrlib.tests.per_foreign_vcs',
3577
'bzrlib.tests.per_interrepository',
3578
'bzrlib.tests.per_intertree',
3579
'bzrlib.tests.per_inventory',
3580
'bzrlib.tests.per_interbranch',
3581
'bzrlib.tests.per_lock',
3582
'bzrlib.tests.per_merger',
3583
'bzrlib.tests.per_transport',
3584
'bzrlib.tests.per_tree',
3585
'bzrlib.tests.per_pack_repository',
3586
'bzrlib.tests.per_repository',
3587
'bzrlib.tests.per_repository_chk',
3588
'bzrlib.tests.per_repository_reference',
3589
'bzrlib.tests.per_uifactory',
3590
'bzrlib.tests.per_versionedfile',
3591
'bzrlib.tests.per_workingtree',
3592
'bzrlib.tests.test__annotator',
3593
'bzrlib.tests.test__bencode',
3594
'bzrlib.tests.test__chk_map',
3595
'bzrlib.tests.test__dirstate_helpers',
3596
'bzrlib.tests.test__groupcompress',
3597
'bzrlib.tests.test__known_graph',
3598
'bzrlib.tests.test__rio',
3599
'bzrlib.tests.test__simple_set',
3600
'bzrlib.tests.test__static_tuple',
3601
'bzrlib.tests.test__walkdirs_win32',
3602
'bzrlib.tests.test_ancestry',
3603
'bzrlib.tests.test_annotate',
3604
'bzrlib.tests.test_api',
3605
'bzrlib.tests.test_atomicfile',
3606
'bzrlib.tests.test_bad_files',
3607
'bzrlib.tests.test_bisect_multi',
3608
'bzrlib.tests.test_branch',
3609
'bzrlib.tests.test_branchbuilder',
3610
'bzrlib.tests.test_btree_index',
3611
'bzrlib.tests.test_bugtracker',
3612
'bzrlib.tests.test_bundle',
3613
'bzrlib.tests.test_bzrdir',
3614
'bzrlib.tests.test__chunks_to_lines',
3615
'bzrlib.tests.test_cache_utf8',
3616
'bzrlib.tests.test_chk_map',
3617
'bzrlib.tests.test_chk_serializer',
3618
'bzrlib.tests.test_chunk_writer',
3619
'bzrlib.tests.test_clean_tree',
3620
'bzrlib.tests.test_cleanup',
3621
'bzrlib.tests.test_commands',
3622
'bzrlib.tests.test_commit',
3623
'bzrlib.tests.test_commit_merge',
3624
'bzrlib.tests.test_config',
3625
'bzrlib.tests.test_conflicts',
3626
'bzrlib.tests.test_counted_lock',
3627
'bzrlib.tests.test_crash',
3628
'bzrlib.tests.test_decorators',
3629
'bzrlib.tests.test_delta',
3630
'bzrlib.tests.test_debug',
3631
'bzrlib.tests.test_deprecated_graph',
3632
'bzrlib.tests.test_diff',
3633
'bzrlib.tests.test_directory_service',
3634
'bzrlib.tests.test_dirstate',
3635
'bzrlib.tests.test_email_message',
3636
'bzrlib.tests.test_eol_filters',
3637
'bzrlib.tests.test_errors',
3638
'bzrlib.tests.test_export',
3639
'bzrlib.tests.test_extract',
3640
'bzrlib.tests.test_fetch',
3641
'bzrlib.tests.test_fifo_cache',
3642
'bzrlib.tests.test_filters',
3643
'bzrlib.tests.test_ftp_transport',
3644
'bzrlib.tests.test_foreign',
3645
'bzrlib.tests.test_generate_docs',
3646
'bzrlib.tests.test_generate_ids',
3647
'bzrlib.tests.test_globbing',
3648
'bzrlib.tests.test_gpg',
3649
'bzrlib.tests.test_graph',
3650
'bzrlib.tests.test_groupcompress',
3651
'bzrlib.tests.test_hashcache',
3652
'bzrlib.tests.test_help',
3653
'bzrlib.tests.test_hooks',
3654
'bzrlib.tests.test_http',
3655
'bzrlib.tests.test_http_response',
3656
'bzrlib.tests.test_https_ca_bundle',
3657
'bzrlib.tests.test_identitymap',
3658
'bzrlib.tests.test_ignores',
3659
'bzrlib.tests.test_index',
3660
'bzrlib.tests.test_info',
3661
'bzrlib.tests.test_inv',
3662
'bzrlib.tests.test_inventory_delta',
3663
'bzrlib.tests.test_knit',
3664
'bzrlib.tests.test_lazy_import',
3665
'bzrlib.tests.test_lazy_regex',
3666
'bzrlib.tests.test_lock',
3667
'bzrlib.tests.test_lockable_files',
3668
'bzrlib.tests.test_lockdir',
3669
'bzrlib.tests.test_log',
3670
'bzrlib.tests.test_lru_cache',
3671
'bzrlib.tests.test_lsprof',
3672
'bzrlib.tests.test_mail_client',
3673
'bzrlib.tests.test_memorytree',
3674
'bzrlib.tests.test_merge',
3675
'bzrlib.tests.test_merge3',
3676
'bzrlib.tests.test_merge_core',
3677
'bzrlib.tests.test_merge_directive',
3678
'bzrlib.tests.test_missing',
3679
'bzrlib.tests.test_msgeditor',
3680
'bzrlib.tests.test_multiparent',
3681
'bzrlib.tests.test_mutabletree',
3682
'bzrlib.tests.test_nonascii',
3683
'bzrlib.tests.test_options',
3684
'bzrlib.tests.test_osutils',
3685
'bzrlib.tests.test_osutils_encodings',
3686
'bzrlib.tests.test_pack',
3687
'bzrlib.tests.test_patch',
3688
'bzrlib.tests.test_patches',
3689
'bzrlib.tests.test_permissions',
3690
'bzrlib.tests.test_plugins',
3691
'bzrlib.tests.test_progress',
3692
'bzrlib.tests.test_read_bundle',
3693
'bzrlib.tests.test_reconcile',
3694
'bzrlib.tests.test_reconfigure',
3695
'bzrlib.tests.test_registry',
3696
'bzrlib.tests.test_remote',
3697
'bzrlib.tests.test_rename_map',
3698
'bzrlib.tests.test_repository',
3699
'bzrlib.tests.test_revert',
3700
'bzrlib.tests.test_revision',
3701
'bzrlib.tests.test_revisionspec',
3702
'bzrlib.tests.test_revisiontree',
3703
'bzrlib.tests.test_rio',
3704
'bzrlib.tests.test_rules',
3705
'bzrlib.tests.test_sampler',
3706
'bzrlib.tests.test_script',
3707
'bzrlib.tests.test_selftest',
3708
'bzrlib.tests.test_serializer',
3709
'bzrlib.tests.test_setup',
3710
'bzrlib.tests.test_sftp_transport',
3711
'bzrlib.tests.test_shelf',
3712
'bzrlib.tests.test_shelf_ui',
3713
'bzrlib.tests.test_smart',
3714
'bzrlib.tests.test_smart_add',
3715
'bzrlib.tests.test_smart_request',
3716
'bzrlib.tests.test_smart_transport',
3717
'bzrlib.tests.test_smtp_connection',
3718
'bzrlib.tests.test_source',
3719
'bzrlib.tests.test_ssh_transport',
3720
'bzrlib.tests.test_status',
3721
'bzrlib.tests.test_store',
3722
'bzrlib.tests.test_strace',
3723
'bzrlib.tests.test_subsume',
3724
'bzrlib.tests.test_switch',
3725
'bzrlib.tests.test_symbol_versioning',
3726
'bzrlib.tests.test_tag',
3727
'bzrlib.tests.test_testament',
3728
'bzrlib.tests.test_textfile',
3729
'bzrlib.tests.test_textmerge',
3730
'bzrlib.tests.test_timestamp',
3731
'bzrlib.tests.test_trace',
3732
'bzrlib.tests.test_transactions',
3733
'bzrlib.tests.test_transform',
3734
'bzrlib.tests.test_transport',
3735
'bzrlib.tests.test_transport_log',
3736
'bzrlib.tests.test_tree',
3737
'bzrlib.tests.test_treebuilder',
3738
'bzrlib.tests.test_tsort',
3739
'bzrlib.tests.test_tuned_gzip',
3740
'bzrlib.tests.test_ui',
3741
'bzrlib.tests.test_uncommit',
3742
'bzrlib.tests.test_upgrade',
3743
'bzrlib.tests.test_upgrade_stacked',
3744
'bzrlib.tests.test_urlutils',
3745
'bzrlib.tests.test_version',
3746
'bzrlib.tests.test_version_info',
3747
'bzrlib.tests.test_weave',
3748
'bzrlib.tests.test_whitebox',
3749
'bzrlib.tests.test_win32utils',
3750
'bzrlib.tests.test_workingtree',
3751
'bzrlib.tests.test_workingtree_4',
3752
'bzrlib.tests.test_wsgi',
3753
'bzrlib.tests.test_xml',
3757
def _test_suite_modules_to_doctest():
3758
"""Return the list of modules to doctest."""
3761
'bzrlib.branchbuilder',
3762
'bzrlib.decorators',
3765
'bzrlib.iterablefile',
3769
'bzrlib.symbol_versioning',
3772
'bzrlib.version_info_formats.format_custom',
3776
def test_suite(keep_only=None, starting_with=None):
3777
1240
"""Build and return TestSuite for the whole of bzrlib.
3779
:param keep_only: A list of test ids limiting the suite returned.
3781
:param starting_with: An id limiting the suite returned to the tests
3784
1242
This function can be replaced if you need to change the default test
3785
1243
suite on a global basis, but it is not encouraged.
1246
'bzrlib.tests.test_ancestry',
1247
'bzrlib.tests.test_api',
1248
'bzrlib.tests.test_bad_files',
1249
'bzrlib.tests.test_branch',
1250
'bzrlib.tests.test_bundle',
1251
'bzrlib.tests.test_bzrdir',
1252
'bzrlib.tests.test_command',
1253
'bzrlib.tests.test_commit',
1254
'bzrlib.tests.test_commit_merge',
1255
'bzrlib.tests.test_config',
1256
'bzrlib.tests.test_conflicts',
1257
'bzrlib.tests.test_decorators',
1258
'bzrlib.tests.test_diff',
1259
'bzrlib.tests.test_doc_generate',
1260
'bzrlib.tests.test_emptytree',
1261
'bzrlib.tests.test_errors',
1262
'bzrlib.tests.test_escaped_store',
1263
'bzrlib.tests.test_fetch',
1264
'bzrlib.tests.test_gpg',
1265
'bzrlib.tests.test_graph',
1266
'bzrlib.tests.test_hashcache',
1267
'bzrlib.tests.test_http',
1268
'bzrlib.tests.test_identitymap',
1269
'bzrlib.tests.test_inv',
1270
'bzrlib.tests.test_knit',
1271
'bzrlib.tests.test_lockdir',
1272
'bzrlib.tests.test_lockable_files',
1273
'bzrlib.tests.test_log',
1274
'bzrlib.tests.test_merge',
1275
'bzrlib.tests.test_merge3',
1276
'bzrlib.tests.test_merge_core',
1277
'bzrlib.tests.test_missing',
1278
'bzrlib.tests.test_msgeditor',
1279
'bzrlib.tests.test_nonascii',
1280
'bzrlib.tests.test_options',
1281
'bzrlib.tests.test_osutils',
1282
'bzrlib.tests.test_patch',
1283
'bzrlib.tests.test_patches',
1284
'bzrlib.tests.test_permissions',
1285
'bzrlib.tests.test_plugins',
1286
'bzrlib.tests.test_progress',
1287
'bzrlib.tests.test_reconcile',
1288
'bzrlib.tests.test_repository',
1289
'bzrlib.tests.test_revision',
1290
'bzrlib.tests.test_revisionnamespaces',
1291
'bzrlib.tests.test_revprops',
1292
'bzrlib.tests.test_revisiontree',
1293
'bzrlib.tests.test_rio',
1294
'bzrlib.tests.test_sampler',
1295
'bzrlib.tests.test_selftest',
1296
'bzrlib.tests.test_setup',
1297
'bzrlib.tests.test_sftp_transport',
1298
'bzrlib.tests.test_smart_add',
1299
'bzrlib.tests.test_source',
1300
'bzrlib.tests.test_status',
1301
'bzrlib.tests.test_store',
1302
'bzrlib.tests.test_symbol_versioning',
1303
'bzrlib.tests.test_testament',
1304
'bzrlib.tests.test_textfile',
1305
'bzrlib.tests.test_textmerge',
1306
'bzrlib.tests.test_trace',
1307
'bzrlib.tests.test_transactions',
1308
'bzrlib.tests.test_transform',
1309
'bzrlib.tests.test_transport',
1310
'bzrlib.tests.test_tsort',
1311
'bzrlib.tests.test_tuned_gzip',
1312
'bzrlib.tests.test_ui',
1313
'bzrlib.tests.test_upgrade',
1314
'bzrlib.tests.test_urlutils',
1315
'bzrlib.tests.test_versionedfile',
1316
'bzrlib.tests.test_weave',
1317
'bzrlib.tests.test_whitebox',
1318
'bzrlib.tests.test_workingtree',
1319
'bzrlib.tests.test_xml',
1321
test_transport_implementations = [
1322
'bzrlib.tests.test_transport_implementations',
1323
'bzrlib.tests.test_read_bundle',
1325
suite = TestUtil.TestSuite()
3788
1326
loader = TestUtil.TestLoader()
3790
if keep_only is not None:
3791
id_filter = TestIdList(keep_only)
3793
# We take precedence over keep_only because *at loading time* using
3794
# both options means we will load less tests for the same final result.
3795
def interesting_module(name):
3796
for start in starting_with:
3798
# Either the module name starts with the specified string
3799
name.startswith(start)
3800
# or it may contain tests starting with the specified string
3801
or start.startswith(name)
3805
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3807
elif keep_only is not None:
3808
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3809
def interesting_module(name):
3810
return id_filter.refers_to(name)
3813
loader = TestUtil.TestLoader()
3814
def interesting_module(name):
3815
# No filtering, all modules are interesting
3818
suite = loader.suiteClass()
3820
# modules building their suite with loadTestsFromModuleNames
3821
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3823
for mod in _test_suite_modules_to_doctest():
3824
if not interesting_module(mod):
3825
# No tests to keep here, move along
3828
# note that this really does mean "report only" -- doctest
3829
# still runs the rest of the examples
3830
doc_suite = doctest.DocTestSuite(mod,
3831
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3832
except ValueError, e:
3833
print '**failed to get doctest for: %s\n%s' % (mod, e)
3835
if len(doc_suite._tests) == 0:
3836
raise errors.BzrError("no doctests found in %s" % (mod,))
3837
suite.addTest(doc_suite)
3839
default_encoding = sys.getdefaultencoding()
3840
for name, plugin in bzrlib.plugin.plugins().items():
3841
if not interesting_module(plugin.module.__name__):
3843
plugin_suite = plugin.test_suite()
3844
# We used to catch ImportError here and turn it into just a warning,
3845
# but really if you don't have --no-plugins this should be a failure.
3846
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3847
if plugin_suite is None:
3848
plugin_suite = plugin.load_plugin_tests(loader)
3849
if plugin_suite is not None:
3850
suite.addTest(plugin_suite)
3851
if default_encoding != sys.getdefaultencoding():
3852
bzrlib.trace.warning(
3853
'Plugin "%s" tried to reset default encoding to: %s', name,
3854
sys.getdefaultencoding())
3856
sys.setdefaultencoding(default_encoding)
3858
if keep_only is not None:
3859
# Now that the referred modules have loaded their tests, keep only the
3861
suite = filter_suite_by_id_list(suite, id_filter)
3862
# Do some sanity checks on the id_list filtering
3863
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3865
# The tester has used both keep_only and starting_with, so he is
3866
# already aware that some tests are excluded from the list, there
3867
# is no need to tell him which.
3870
# Some tests mentioned in the list are not in the test suite. The
3871
# list may be out of date, report to the tester.
3872
for id in not_found:
3873
bzrlib.trace.warning('"%s" not found in the test suite', id)
3874
for id in duplicates:
3875
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
1327
from bzrlib.transport import TransportTestProviderAdapter
1328
adapter = TransportTestProviderAdapter()
1329
adapt_modules(test_transport_implementations, adapter, loader, suite)
1330
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1331
for package in packages_to_test():
1332
suite.addTest(package.test_suite())
1333
for m in MODULES_TO_TEST:
1334
suite.addTest(loader.loadTestsFromModule(m))
1335
for m in MODULES_TO_DOCTEST:
1336
suite.addTest(doctest.DocTestSuite(m))
1337
for name, plugin in bzrlib.plugin.all_plugins().items():
1338
if getattr(plugin, 'test_suite', None) is not None:
1339
suite.addTest(plugin.test_suite())
3880
def multiply_scenarios(scenarios_left, scenarios_right):
3881
"""Multiply two sets of scenarios.
3883
:returns: the cartesian product of the two sets of scenarios, that is
3884
a scenario for every possible combination of a left scenario and a
3888
('%s,%s' % (left_name, right_name),
3889
dict(left_dict.items() + right_dict.items()))
3890
for left_name, left_dict in scenarios_left
3891
for right_name, right_dict in scenarios_right]
3894
def multiply_tests(tests, scenarios, result):
3895
"""Multiply tests_list by scenarios into result.
3897
This is the core workhorse for test parameterisation.
3899
Typically the load_tests() method for a per-implementation test suite will
3900
call multiply_tests and return the result.
3902
:param tests: The tests to parameterise.
3903
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3904
scenario_param_dict).
3905
:param result: A TestSuite to add created tests to.
3907
This returns the passed in result TestSuite with the cross product of all
3908
the tests repeated once for each scenario. Each test is adapted by adding
3909
the scenario name at the end of its id(), and updating the test object's
3910
__dict__ with the scenario_param_dict.
3912
>>> import bzrlib.tests.test_sampler
3913
>>> r = multiply_tests(
3914
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3915
... [('one', dict(param=1)),
3916
... ('two', dict(param=2))],
3918
>>> tests = list(iter_suite_tests(r))
3922
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3928
for test in iter_suite_tests(tests):
3929
apply_scenarios(test, scenarios, result)
3933
def apply_scenarios(test, scenarios, result):
3934
"""Apply the scenarios in scenarios to test and add to result.
3936
:param test: The test to apply scenarios to.
3937
:param scenarios: An iterable of scenarios to apply to test.
3939
:seealso: apply_scenario
3941
for scenario in scenarios:
3942
result.addTest(apply_scenario(test, scenario))
3946
def apply_scenario(test, scenario):
3947
"""Copy test and apply scenario to it.
3949
:param test: A test to adapt.
3950
:param scenario: A tuple describing the scenarion.
3951
The first element of the tuple is the new test id.
3952
The second element is a dict containing attributes to set on the
3954
:return: The adapted test.
3956
new_id = "%s(%s)" % (test.id(), scenario[0])
3957
new_test = clone_test(test, new_id)
3958
for name, value in scenario[1].items():
3959
setattr(new_test, name, value)
3963
def clone_test(test, new_id):
3964
"""Clone a test giving it a new id.
3966
:param test: The test to clone.
3967
:param new_id: The id to assign to it.
3968
:return: The new test.
3970
new_test = copy(test)
3971
new_test.id = lambda: new_id
3975
def permute_tests_for_extension(standard_tests, loader, py_module_name,
3977
"""Helper for permutating tests against an extension module.
3979
This is meant to be used inside a modules 'load_tests()' function. It will
3980
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
3981
against both implementations. Setting 'test.module' to the appropriate
3982
module. See bzrlib.tests.test__chk_map.load_tests as an example.
3984
:param standard_tests: A test suite to permute
3985
:param loader: A TestLoader
3986
:param py_module_name: The python path to a python module that can always
3987
be loaded, and will be considered the 'python' implementation. (eg
3988
'bzrlib._chk_map_py')
3989
:param ext_module_name: The python path to an extension module. If the
3990
module cannot be loaded, a single test will be added, which notes that
3991
the module is not available. If it can be loaded, all standard_tests
3992
will be run against that module.
3993
:return: (suite, feature) suite is a test-suite that has all the permuted
3994
tests. feature is the Feature object that can be used to determine if
3995
the module is available.
3998
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4000
('python', {'module': py_module}),
4002
suite = loader.suiteClass()
4003
feature = ModuleAvailableFeature(ext_module_name)
4004
if feature.available():
4005
scenarios.append(('C', {'module': feature.module}))
4007
# the compiled module isn't available, so we add a failing test
4008
class FailWithoutFeature(TestCase):
4009
def test_fail(self):
4010
self.requireFeature(feature)
4011
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4012
result = multiply_tests(standard_tests, scenarios, suite)
4013
return result, feature
4016
def _rmtree_temp_dir(dirname, test_id=None):
4017
# If LANG=C we probably have created some bogus paths
4018
# which rmtree(unicode) will fail to delete
4019
# so make sure we are using rmtree(str) to delete everything
4020
# except on win32, where rmtree(str) will fail
4021
# since it doesn't have the property of byte-stream paths
4022
# (they are either ascii or mbcs)
4023
if sys.platform == 'win32':
4024
# make sure we are using the unicode win32 api
4025
dirname = unicode(dirname)
4027
dirname = dirname.encode(sys.getfilesystemencoding())
4029
osutils.rmtree(dirname)
4031
# We don't want to fail here because some useful display will be lost
4032
# otherwise. Polluting the tmp dir is bad, but not giving all the
4033
# possible info to the test runner is even worse.
4035
ui.ui_factory.clear_term()
4036
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4037
sys.stderr.write('Unable to remove testing dir %s\n%s'
4038
% (os.path.basename(dirname), e))
4041
class Feature(object):
4042
"""An operating system Feature."""
4045
self._available = None
4047
def available(self):
4048
"""Is the feature available?
4050
:return: True if the feature is available.
4052
if self._available is None:
4053
self._available = self._probe()
4054
return self._available
4057
"""Implement this method in concrete features.
4059
:return: True if the feature is available.
4061
raise NotImplementedError
4064
if getattr(self, 'feature_name', None):
4065
return self.feature_name()
4066
return self.__class__.__name__
4069
class _SymlinkFeature(Feature):
4072
return osutils.has_symlinks()
4074
def feature_name(self):
4077
SymlinkFeature = _SymlinkFeature()
4080
class _HardlinkFeature(Feature):
4083
return osutils.has_hardlinks()
4085
def feature_name(self):
4088
HardlinkFeature = _HardlinkFeature()
4091
class _OsFifoFeature(Feature):
4094
return getattr(os, 'mkfifo', None)
4096
def feature_name(self):
4097
return 'filesystem fifos'
4099
OsFifoFeature = _OsFifoFeature()
4102
class _UnicodeFilenameFeature(Feature):
4103
"""Does the filesystem support Unicode filenames?"""
4107
# Check for character combinations unlikely to be covered by any
4108
# single non-unicode encoding. We use the characters
4109
# - greek small letter alpha (U+03B1) and
4110
# - braille pattern dots-123456 (U+283F).
4111
os.stat(u'\u03b1\u283f')
4112
except UnicodeEncodeError:
4114
except (IOError, OSError):
4115
# The filesystem allows the Unicode filename but the file doesn't
4119
# The filesystem allows the Unicode filename and the file exists,
4123
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4126
class _CompatabilityThunkFeature(Feature):
4127
"""This feature is just a thunk to another feature.
4129
It issues a deprecation warning if it is accessed, to let you know that you
4130
should really use a different feature.
4133
def __init__(self, module, name, this_name, dep_version):
4134
super(_CompatabilityThunkFeature, self).__init__()
4135
self._module = module
4137
self._this_name = this_name
4138
self._dep_version = dep_version
4139
self._feature = None
4142
if self._feature is None:
4143
msg = (self._dep_version % self._this_name) + (
4144
' Use %s.%s instead.' % (self._module, self._name))
4145
symbol_versioning.warn(msg, DeprecationWarning)
4146
mod = __import__(self._module, {}, {}, [self._name])
4147
self._feature = getattr(mod, self._name)
4151
return self._feature._probe()
4154
class ModuleAvailableFeature(Feature):
4155
"""This is a feature than describes a module we want to be available.
4157
Declare the name of the module in __init__(), and then after probing, the
4158
module will be available as 'self.module'.
4160
:ivar module: The module if it is available, else None.
4163
def __init__(self, module_name):
4164
super(ModuleAvailableFeature, self).__init__()
4165
self.module_name = module_name
4169
self._module = __import__(self.module_name, {}, {}, [''])
4176
if self.available(): # Make sure the probe has been done
4180
def feature_name(self):
4181
return self.module_name
4184
# This is kept here for compatibility, it is recommended to use
4185
# 'bzrlib.tests.feature.paramiko' instead
4186
ParamikoFeature = _CompatabilityThunkFeature('bzrlib.tests.features',
4187
'paramiko', 'bzrlib.tests.ParamikoFeature', deprecated_in((2,1,0)))
4190
def probe_unicode_in_user_encoding():
4191
"""Try to encode several unicode strings to use in unicode-aware tests.
4192
Return first successfull match.
4194
:return: (unicode value, encoded plain string value) or (None, None)
4196
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4197
for uni_val in possible_vals:
4199
str_val = uni_val.encode(osutils.get_user_encoding())
4200
except UnicodeEncodeError:
4201
# Try a different character
4204
return uni_val, str_val
4208
def probe_bad_non_ascii(encoding):
4209
"""Try to find [bad] character with code [128..255]
4210
that cannot be decoded to unicode in some encoding.
4211
Return None if all non-ascii characters is valid
4214
for i in xrange(128, 256):
4217
char.decode(encoding)
4218
except UnicodeDecodeError:
4223
class _HTTPSServerFeature(Feature):
4224
"""Some tests want an https Server, check if one is available.
4226
Right now, the only way this is available is under python2.6 which provides
4237
def feature_name(self):
4238
return 'HTTPSServer'
4241
HTTPSServerFeature = _HTTPSServerFeature()
4244
class _UnicodeFilename(Feature):
4245
"""Does the filesystem support Unicode filenames?"""
4250
except UnicodeEncodeError:
4252
except (IOError, OSError):
4253
# The filesystem allows the Unicode filename but the file doesn't
4257
# The filesystem allows the Unicode filename and the file exists,
4261
UnicodeFilename = _UnicodeFilename()
4264
class _UTF8Filesystem(Feature):
4265
"""Is the filesystem UTF-8?"""
4268
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4272
UTF8Filesystem = _UTF8Filesystem()
4275
class _BreakinFeature(Feature):
4276
"""Does this platform support the breakin feature?"""
4279
from bzrlib import breakin
4280
if breakin.determine_signal() is None:
4282
if sys.platform == 'win32':
4283
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4284
# We trigger SIGBREAK via a Console api so we need ctypes to
4285
# access the function
4292
def feature_name(self):
4293
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4296
BreakinFeature = _BreakinFeature()
4299
class _CaseInsCasePresFilenameFeature(Feature):
4300
"""Is the file-system case insensitive, but case-preserving?"""
4303
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4305
# first check truly case-preserving for created files, then check
4306
# case insensitive when opening existing files.
4307
name = osutils.normpath(name)
4308
base, rel = osutils.split(name)
4309
found_rel = osutils.canonical_relpath(base, name)
4310
return (found_rel == rel
4311
and os.path.isfile(name.upper())
4312
and os.path.isfile(name.lower()))
4317
def feature_name(self):
4318
return "case-insensitive case-preserving filesystem"
4320
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4323
class _CaseInsensitiveFilesystemFeature(Feature):
4324
"""Check if underlying filesystem is case-insensitive but *not* case
4327
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4328
# more likely to be case preserving, so this case is rare.
4331
if CaseInsCasePresFilenameFeature.available():
4334
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4335
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4336
TestCaseWithMemoryTransport.TEST_ROOT = root
4338
root = TestCaseWithMemoryTransport.TEST_ROOT
4339
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4341
name_a = osutils.pathjoin(tdir, 'a')
4342
name_A = osutils.pathjoin(tdir, 'A')
4344
result = osutils.isdir(name_A)
4345
_rmtree_temp_dir(tdir)
4348
def feature_name(self):
4349
return 'case-insensitive filesystem'
4351
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4354
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4355
SubUnitFeature = _CompatabilityThunkFeature('bzrlib.tests.features', 'subunit',
4356
'bzrlib.tests.SubUnitFeature', deprecated_in((2,1,0)))
4357
# Only define SubUnitBzrRunner if subunit is available.
4359
from subunit import TestProtocolClient
4360
from subunit.test_results import AutoTimingTestResultDecorator
4361
class SubUnitBzrRunner(TextTestRunner):
4362
def run(self, test):
4363
result = AutoTimingTestResultDecorator(
4364
TestProtocolClient(self.stream))
1343
def adapt_modules(mods_list, adapter, loader, suite):
1344
"""Adapt the modules in mods_list using adapter and add to suite."""
1345
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1346
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
