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
40
from pprint import pformat
45
from subprocess import Popen, PIPE, STDOUT
55
# nb: check this before importing anything else from within it
56
_testtools_version = getattr(testtools, '__version__', ())
57
if _testtools_version < (0, 9, 2):
58
raise ImportError("need at least testtools 0.9.2: %s is %r"
59
% (testtools.__file__, _testtools_version))
60
from testtools import content
79
43
import bzrlib.branch
44
import bzrlib.bzrdir as bzrdir
80
45
import bzrlib.commands
81
import bzrlib.timestamp
46
import bzrlib.errors as errors
83
47
import bzrlib.inventory
84
48
import bzrlib.iterablefile
85
49
import bzrlib.lockdir
89
# lsprof not available
91
50
from bzrlib.merge import merge_inner
92
51
import bzrlib.merge3
53
import bzrlib.osutils as osutils
93
54
import bzrlib.plugin
94
from bzrlib.smart import client, request, server
55
import bzrlib.progress as progress
56
from bzrlib.revision import common_ancestor
95
57
import bzrlib.store
96
from bzrlib import symbol_versioning
97
from bzrlib.symbol_versioning import (
104
58
import bzrlib.trace
105
from bzrlib.transport import (
59
from bzrlib.transport import urlescape, get_transport
110
60
import bzrlib.transport
111
from bzrlib.trace import mutter, note
112
from bzrlib.tests import (
116
from bzrlib.tests.http_server import HttpServer
117
from bzrlib.tests.TestUtil import (
61
from bzrlib.transport.local import LocalRelpathServer
62
from bzrlib.transport.readonly import ReadonlyServer
63
from bzrlib.trace import mutter
64
from bzrlib.tests.TestUtil import TestLoader, TestSuite
121
65
from bzrlib.tests.treeshape import build_tree_contents
122
from bzrlib.ui import NullProgressView
123
from bzrlib.ui.text import TextUIFactory
124
import bzrlib.version_info_formats.format_custom
125
66
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
127
# Mark this python module as being part of the implementation
128
# of unittest: this gives us better tracebacks where the last
129
# shown frame is the test code, not our assertXYZ.
132
default_transport = test_server.LocalURLServer
135
_unitialized_attr = object()
136
"""A sentinel needed to act as a default value in a method signature."""
139
# Subunit result codes, defined here to prevent a hard dependency on subunit.
144
class ExtendedTestResult(unittest._TextTestResult):
145
"""Accepts, reports and accumulates the results of running tests.
147
Compared to the unittest version this class adds support for
148
profiling, benchmarking, stopping as soon as a test fails, and
149
skipping tests. There are further-specialized subclasses for
150
different types of display.
152
When a test finishes, in whatever way, it calls one of the addSuccess,
153
addFailure or addError classes. These in turn may redirect to a more
154
specific case for the special test results supported by our extended
157
Note that just one of these objects is fed the results from many tests.
68
default_transport = LocalRelpathServer
71
MODULES_TO_DOCTEST = [
83
def packages_to_test():
84
"""Return a list of packages to test.
86
The packages are not globally imported so that import failures are
87
triggered when running selftest, not when importing the command.
90
import bzrlib.tests.blackbox
91
import bzrlib.tests.branch_implementations
92
import bzrlib.tests.bzrdir_implementations
93
import bzrlib.tests.interrepository_implementations
94
import bzrlib.tests.interversionedfile_implementations
95
import bzrlib.tests.repository_implementations
96
import bzrlib.tests.revisionstore_implementations
97
import bzrlib.tests.workingtree_implementations
100
bzrlib.tests.blackbox,
101
bzrlib.tests.branch_implementations,
102
bzrlib.tests.bzrdir_implementations,
103
bzrlib.tests.interrepository_implementations,
104
bzrlib.tests.interversionedfile_implementations,
105
bzrlib.tests.repository_implementations,
106
bzrlib.tests.revisionstore_implementations,
107
bzrlib.tests.workingtree_implementations,
111
class _MyResult(unittest._TextTestResult):
112
"""Custom TestResult.
114
Shows output in a different format, including displaying runtime for tests.
160
116
stop_early = False
162
def __init__(self, stream, descriptions, verbosity,
166
"""Construct new TestResult.
168
:param bench_history: Optionally, a writable file object to accumulate
118
def __init__(self, stream, descriptions, verbosity, pb=None):
171
119
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
172
if bench_history is not None:
173
from bzrlib.version import _get_bzr_source_tree
174
src_tree = _get_bzr_source_tree()
177
revision_id = src_tree.get_parent_ids()[0]
179
# XXX: if this is a brand new tree, do the same as if there
183
# XXX: If there's no branch, what should we do?
185
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
186
self._bench_history = bench_history
187
self.ui = ui.ui_factory
190
self.failure_count = 0
191
self.known_failure_count = 0
193
self.not_applicable_count = 0
194
self.unsupported = {}
196
self._overall_start_time = time.time()
197
self._strict = strict
199
def stopTestRun(self):
202
stopTime = time.time()
203
timeTaken = stopTime - self.startTime
205
self.stream.writeln(self.separator2)
206
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
207
run, run != 1 and "s" or "", timeTaken))
208
self.stream.writeln()
209
if not self.wasSuccessful():
210
self.stream.write("FAILED (")
211
failed, errored = map(len, (self.failures, self.errors))
213
self.stream.write("failures=%d" % failed)
215
if failed: self.stream.write(", ")
216
self.stream.write("errors=%d" % errored)
217
if self.known_failure_count:
218
if failed or errored: self.stream.write(", ")
219
self.stream.write("known_failure_count=%d" %
220
self.known_failure_count)
221
self.stream.writeln(")")
223
if self.known_failure_count:
224
self.stream.writeln("OK (known_failures=%d)" %
225
self.known_failure_count)
227
self.stream.writeln("OK")
228
if self.skip_count > 0:
229
skipped = self.skip_count
230
self.stream.writeln('%d test%s skipped' %
231
(skipped, skipped != 1 and "s" or ""))
233
for feature, count in sorted(self.unsupported.items()):
234
self.stream.writeln("Missing feature '%s' skipped %d tests." %
237
ok = self.wasStrictlySuccessful()
239
ok = self.wasSuccessful()
240
if TestCase._first_thread_leaker_id:
242
'%s is leaking threads among %d leaking tests.\n' % (
243
TestCase._first_thread_leaker_id,
244
TestCase._leaking_threads_tests))
245
# We don't report the main thread as an active one.
247
'%d non-main threads were left active in the end.\n'
248
% (TestCase._active_threads - 1))
250
def getDescription(self, test):
253
def _extractBenchmarkTime(self, testCase, details=None):
254
"""Add a benchmark time for the current test case."""
255
if details and 'benchtime' in details:
256
return float(''.join(details['benchtime'].iter_bytes()))
257
return getattr(testCase, "_benchtime", None)
259
def _elapsedTestTimeString(self):
260
"""Return a time string for the overall time the current test has taken."""
261
return self._formatTime(time.time() - self._start_time)
263
def _testTimeString(self, testCase):
264
benchmark_time = self._extractBenchmarkTime(testCase)
265
if benchmark_time is not None:
266
return self._formatTime(benchmark_time) + "*"
268
return self._elapsedTestTimeString()
270
def _formatTime(self, seconds):
271
"""Format seconds as milliseconds with leading spaces."""
272
# some benchmarks can take thousands of seconds to run, so we need 8
274
return "%8dms" % (1000 * seconds)
276
def _shortened_test_description(self, test):
278
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
122
def _elapsedTime(self):
123
return "%5dms" % (1000 * (time.time() - self._start_time))
125
def _ellipsise_unimportant_words(self, a_string, final_width,
127
"""Add ellipsese (sp?) for overly long strings.
129
:param keep_start: If true preserve the start of a_string rather
133
if len(a_string) > final_width:
134
result = a_string[:final_width-3] + '...'
138
if len(a_string) > final_width:
139
result = '...' + a_string[3-final_width:]
142
return result.ljust(final_width)
281
144
def startTest(self, test):
282
145
unittest.TestResult.startTest(self, test)
285
self.report_test_start(test)
286
test.number = self.count
287
self._recordTestStartTime()
146
# In a short description, the important words are in
147
# the beginning, but in an id, the important words are
149
SHOW_DESCRIPTIONS = False
289
def startTests(self):
291
if getattr(sys, 'frozen', None) is None:
292
bzr_path = osutils.realpath(sys.argv[0])
151
if not self.showAll and self.dots and self.pb is not None:
294
bzr_path = sys.executable
296
'bzr selftest: %s\n' % (bzr_path,))
299
bzrlib.__path__[0],))
301
' bzr-%s python-%s %s\n' % (
302
bzrlib.version_string,
303
bzrlib._format_version_tuple(sys.version_info),
304
platform.platform(aliased=1),
306
self.stream.write('\n')
308
def _recordTestStartTime(self):
309
"""Record that a test has started."""
154
final_width = osutils.terminal_width()
155
final_width = final_width - 15
157
if SHOW_DESCRIPTIONS:
158
what = test.shortDescription()
160
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
163
if what.startswith('bzrlib.tests.'):
165
what = self._ellipsise_unimportant_words(what, final_width)
167
self.stream.write(what)
168
elif self.dots and self.pb is not None:
169
self.pb.update(what, self.testsRun - 1, None)
310
171
self._start_time = time.time()
312
def _cleanupLogFile(self, test):
313
# We can only do this if we have one of our TestCases, not if
315
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
316
if setKeepLogfile is not None:
319
173
def addError(self, test, err):
320
"""Tell result that test finished with an error.
322
Called from the TestCase run() method when the test
323
fails with an unexpected error.
174
if isinstance(err[1], TestSkipped):
175
return self.addSkipped(test, err)
326
176
unittest.TestResult.addError(self, test, err)
327
self.error_count += 1
328
self.report_error(test, err)
178
self.stream.writeln("ERROR %s" % self._elapsedTime())
179
elif self.dots and self.pb is None:
180
self.stream.write('E')
182
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
329
184
if self.stop_early:
331
self._cleanupLogFile(test)
333
187
def addFailure(self, test, err):
334
"""Tell result that test failed.
336
Called from the TestCase run() method when the test
337
fails because e.g. an assert() method failed.
340
188
unittest.TestResult.addFailure(self, test, err)
341
self.failure_count += 1
342
self.report_failure(test, err)
190
self.stream.writeln(" FAIL %s" % self._elapsedTime())
191
elif self.dots and self.pb is None:
192
self.stream.write('F')
194
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
343
196
if self.stop_early:
345
self._cleanupLogFile(test)
347
def addSuccess(self, test, details=None):
348
"""Tell result that test completed successfully.
350
Called from the TestCase run()
352
if self._bench_history is not None:
353
benchmark_time = self._extractBenchmarkTime(test, details)
354
if benchmark_time is not None:
355
self._bench_history.write("%s %s\n" % (
356
self._formatTime(benchmark_time),
358
self.report_success(test)
359
self._cleanupLogFile(test)
360
unittest.TestResult.addSuccess(self, test)
361
test._log_contents = ''
363
def addExpectedFailure(self, test, err):
364
self.known_failure_count += 1
365
self.report_known_failure(test, err)
367
def addNotSupported(self, test, feature):
368
"""The test will not be run because of a missing feature.
370
# this can be called in two different ways: it may be that the
371
# test started running, and then raised (through requireFeature)
372
# UnavailableFeature. Alternatively this method can be called
373
# while probing for features before running the test code proper; in
374
# that case we will see startTest and stopTest, but the test will
375
# never actually run.
376
self.unsupported.setdefault(str(feature), 0)
377
self.unsupported[str(feature)] += 1
378
self.report_unsupported(test, feature)
380
def addSkip(self, test, reason):
381
"""A test has not run for 'reason'."""
383
self.report_skip(test, reason)
385
def addNotApplicable(self, test, reason):
386
self.not_applicable_count += 1
387
self.report_not_applicable(test, reason)
389
def _post_mortem(self):
390
"""Start a PDB post mortem session."""
391
if os.environ.get('BZR_TEST_PDB', None):
392
import pdb;pdb.post_mortem()
394
def progress(self, offset, whence):
395
"""The test is adjusting the count of tests to run."""
396
if whence == SUBUNIT_SEEK_SET:
397
self.num_tests = offset
398
elif whence == SUBUNIT_SEEK_CUR:
399
self.num_tests += offset
401
raise errors.BzrError("Unknown whence %r" % whence)
403
def report_cleaning_up(self):
406
def startTestRun(self):
407
self.startTime = time.time()
409
def report_success(self, test):
412
def wasStrictlySuccessful(self):
413
if self.unsupported or self.known_failure_count:
415
return self.wasSuccessful()
418
class TextTestResult(ExtendedTestResult):
419
"""Displays progress and results of tests in text form"""
421
def __init__(self, stream, descriptions, verbosity,
426
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
427
bench_history, strict)
428
# We no longer pass them around, but just rely on the UIFactory stack
431
warnings.warn("Passing pb to TextTestResult is deprecated")
432
self.pb = self.ui.nested_progress_bar()
433
self.pb.show_pct = False
434
self.pb.show_spinner = False
435
self.pb.show_eta = False,
436
self.pb.show_count = False
437
self.pb.show_bar = False
438
self.pb.update_latency = 0
439
self.pb.show_transport_activity = False
441
def stopTestRun(self):
442
# called when the tests that are going to run have run
445
super(TextTestResult, self).stopTestRun()
447
def startTestRun(self):
448
super(TextTestResult, self).startTestRun()
449
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
451
def printErrors(self):
452
# clear the pb to make room for the error listing
454
super(TextTestResult, self).printErrors()
456
def _progress_prefix_text(self):
457
# the longer this text, the less space we have to show the test
459
a = '[%d' % self.count # total that have been run
460
# tests skipped as known not to be relevant are not important enough
462
## if self.skip_count:
463
## a += ', %d skip' % self.skip_count
464
## if self.known_failure_count:
465
## a += '+%dX' % self.known_failure_count
467
a +='/%d' % self.num_tests
469
runtime = time.time() - self._overall_start_time
471
a += '%dm%ds' % (runtime / 60, runtime % 60)
474
total_fail_count = self.error_count + self.failure_count
476
a += ', %d failed' % total_fail_count
477
# if self.unsupported:
478
# a += ', %d missing' % len(self.unsupported)
482
def report_test_start(self, test):
485
self._progress_prefix_text()
487
+ self._shortened_test_description(test))
489
def _test_description(self, test):
490
return self._shortened_test_description(test)
492
def report_error(self, test, err):
493
self.stream.write('ERROR: %s\n %s\n' % (
494
self._test_description(test),
498
def report_failure(self, test, err):
499
self.stream.write('FAIL: %s\n %s\n' % (
500
self._test_description(test),
504
def report_known_failure(self, test, err):
507
def report_skip(self, test, reason):
510
def report_not_applicable(self, test, reason):
513
def report_unsupported(self, test, feature):
514
"""test cannot be run because feature is missing."""
516
def report_cleaning_up(self):
517
self.pb.update('Cleaning up')
520
class VerboseTestResult(ExtendedTestResult):
521
"""Produce long output, with one line per test run plus times"""
523
def _ellipsize_to_right(self, a_string, final_width):
524
"""Truncate and pad a string, keeping the right hand side"""
525
if len(a_string) > final_width:
526
result = '...' + a_string[3-final_width:]
529
return result.ljust(final_width)
531
def startTestRun(self):
532
super(VerboseTestResult, self).startTestRun()
533
self.stream.write('running %d tests...\n' % self.num_tests)
535
def report_test_start(self, test):
537
name = self._shortened_test_description(test)
538
width = osutils.terminal_width()
539
if width is not None:
540
# width needs space for 6 char status, plus 1 for slash, plus an
541
# 11-char time string, plus a trailing blank
542
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
544
self.stream.write(self._ellipsize_to_right(name, width-18))
546
self.stream.write(name)
549
def _error_summary(self, err):
551
return '%s%s' % (indent, err[1])
553
def report_error(self, test, err):
554
self.stream.writeln('ERROR %s\n%s'
555
% (self._testTimeString(test),
556
self._error_summary(err)))
558
def report_failure(self, test, err):
559
self.stream.writeln(' FAIL %s\n%s'
560
% (self._testTimeString(test),
561
self._error_summary(err)))
563
def report_known_failure(self, test, err):
564
self.stream.writeln('XFAIL %s\n%s'
565
% (self._testTimeString(test),
566
self._error_summary(err)))
568
def report_success(self, test):
569
self.stream.writeln(' OK %s' % self._testTimeString(test))
570
for bench_called, stats in getattr(test, '_benchcalls', []):
571
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
572
stats.pprint(file=self.stream)
573
# flush the stream so that we get smooth output. This verbose mode is
574
# used to show the output in PQM.
577
def report_skip(self, test, reason):
578
self.stream.writeln(' SKIP %s\n%s'
579
% (self._testTimeString(test), reason))
581
def report_not_applicable(self, test, reason):
582
self.stream.writeln(' N/A %s\n %s'
583
% (self._testTimeString(test), reason))
585
def report_unsupported(self, test, feature):
586
"""test cannot be run because feature is missing."""
587
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
588
%(self._testTimeString(test), feature))
199
def addSuccess(self, test):
201
self.stream.writeln(' OK %s' % self._elapsedTime())
202
elif self.dots and self.pb is None:
203
self.stream.write('~')
205
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
207
unittest.TestResult.addSuccess(self, test)
209
def addSkipped(self, test, skip_excinfo):
211
print >>self.stream, ' SKIP %s' % self._elapsedTime()
212
print >>self.stream, ' %s' % skip_excinfo[1]
213
elif self.dots and self.pb is None:
214
self.stream.write('S')
216
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
218
# seems best to treat this as success from point-of-view of unittest
219
# -- it actually does nothing so it barely matters :)
220
unittest.TestResult.addSuccess(self, test)
222
def printErrorList(self, flavour, errors):
223
for test, err in errors:
224
self.stream.writeln(self.separator1)
225
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
226
if getattr(test, '_get_log', None) is not None:
228
print >>self.stream, \
229
('vvvv[log from %s]' % test.id()).ljust(78,'-')
230
print >>self.stream, test._get_log()
231
print >>self.stream, \
232
('^^^^[log from %s]' % test.id()).ljust(78,'-')
233
self.stream.writeln(self.separator2)
234
self.stream.writeln("%s" % err)
591
237
class TextTestRunner(object):
1456
448
The file is removed as the test is torn down.
1458
450
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1459
self._log_file = os.fdopen(fileno, 'w+')
1460
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
451
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
452
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
453
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1461
454
self._log_file_name = name
1462
455
self.addCleanup(self._finishLogFile)
1464
457
def _finishLogFile(self):
1465
458
"""Finished with the log file.
1467
Close the file and delete it, unless setKeepLogfile was called.
1469
if bzrlib.trace._trace_file:
1470
# flush the log file, to get all content
1471
bzrlib.trace._trace_file.flush()
1472
bzrlib.trace.pop_log_file(self._log_memento)
1473
# Cache the log result and delete the file on disk
1474
self._get_log(False)
1476
def thisFailsStrictLockCheck(self):
1477
"""It is known that this test would fail with -Dstrict_locks.
1479
By default, all tests are run with strict lock checking unless
1480
-Edisable_lock_checks is supplied. However there are some tests which
1481
we know fail strict locks at this point that have not been fixed.
1482
They should call this function to disable the strict checking.
1484
This should be used sparingly, it is much better to fix the locking
1485
issues rather than papering over the problem by calling this function.
1487
debug.debug_flags.discard('strict_locks')
1489
def addCleanup(self, callable, *args, **kwargs):
460
Read contents into memory, close, and delete.
462
bzrlib.trace.disable_test_log(self._log_nonce)
463
self._log_file.seek(0)
464
self._log_contents = self._log_file.read()
465
self._log_file.close()
466
os.remove(self._log_file_name)
467
self._log_file = self._log_file_name = None
469
def addCleanup(self, callable):
1490
470
"""Arrange to run a callable when this case is torn down.
1492
Callables are run in the reverse of the order they are registered,
472
Callables are run in the reverse of the order they are registered,
1493
473
ie last-in first-out.
1495
self._cleanups.append((callable, args, kwargs))
1497
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1498
"""Overrides an object attribute restoring it after the test.
1500
:param obj: The object that will be mutated.
1502
:param attr_name: The attribute name we want to preserve/override in
1505
:param new: The optional value we want to set the attribute to.
1507
:returns: The actual attr value.
1509
value = getattr(obj, attr_name)
1510
# The actual value is captured by the call below
1511
self.addCleanup(setattr, obj, attr_name, value)
1512
if new is not _unitialized_attr:
1513
setattr(obj, attr_name, new)
475
if callable in self._cleanups:
476
raise ValueError("cleanup function %r already registered on %s"
478
self._cleanups.append(callable)
1516
480
def _cleanEnvironment(self):
1518
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1519
482
'HOME': os.getcwd(),
1520
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1521
# tests do check our impls match APPDATA
1522
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1526
'BZREMAIL': None, # may still be present in the environment
483
'APPDATA': os.getcwd(),
1528
'BZR_PROGRESS_BAR': None,
1530
'BZR_PLUGIN_PATH': None,
1531
'BZR_DISABLE_PLUGINS': None,
1532
'BZR_PLUGINS_AT': None,
1533
'BZR_CONCURRENCY': None,
1534
# Make sure that any text ui tests are consistent regardless of
1535
# the environment the test case is run in; you may want tests that
1536
# test other combinations. 'dumb' is a reasonable guess for tests
1537
# going to a pipe or a StringIO.
1541
'BZR_COLUMNS': '80',
1543
'SSH_AUTH_SOCK': None,
1547
'https_proxy': None,
1548
'HTTPS_PROXY': None,
1553
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1554
# least. If you do (care), please update this comment
1558
'BZR_REMOTE_PATH': None,
1559
# Generally speaking, we don't want apport reporting on crashes in
1560
# the test envirnoment unless we're specifically testing apport,
1561
# so that it doesn't leak into the real system environment. We
1562
# use an env var so it propagates to subprocesses.
1563
'APPORT_DISABLE': '1',
1566
488
self.addCleanup(self._restoreEnvironment)
1567
489
for name, value in new_env.iteritems():
1568
490
self._captureVar(name, value)
1570
493
def _captureVar(self, name, newvalue):
1571
"""Set an environment variable, and reset it when finished."""
1572
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
494
"""Set an environment variable, preparing it to be reset when finished."""
495
self.__old_env[name] = os.environ.get(name, None)
497
if name in os.environ:
500
os.environ[name] = newvalue
503
def _restoreVar(name, value):
505
if name in os.environ:
508
os.environ[name] = value
1574
510
def _restoreEnvironment(self):
1575
for name, value in self._old_env.iteritems():
1576
osutils.set_or_unset_env(name, value)
1578
def _restoreHooks(self):
1579
for klass, (name, hooks) in self._preserved_hooks.items():
1580
setattr(klass, name, hooks)
1582
def knownFailure(self, reason):
1583
"""This test has failed for some known reason."""
1584
raise KnownFailure(reason)
1586
def _do_skip(self, result, reason):
1587
addSkip = getattr(result, 'addSkip', None)
1588
if not callable(addSkip):
1589
result.addSuccess(result)
1591
addSkip(self, reason)
1594
def _do_known_failure(self, result, e):
1595
err = sys.exc_info()
1596
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1597
if addExpectedFailure is not None:
1598
addExpectedFailure(self, err)
1600
result.addSuccess(self)
1603
def _do_not_applicable(self, result, e):
1605
reason = 'No reason given'
1608
addNotApplicable = getattr(result, 'addNotApplicable', None)
1609
if addNotApplicable is not None:
1610
result.addNotApplicable(self, reason)
1612
self._do_skip(result, reason)
1615
def _do_unsupported_or_skip(self, result, e):
1617
addNotSupported = getattr(result, 'addNotSupported', None)
1618
if addNotSupported is not None:
1619
result.addNotSupported(self, reason)
1621
self._do_skip(result, reason)
1623
def time(self, callable, *args, **kwargs):
1624
"""Run callable and accrue the time it takes to the benchmark time.
1626
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1627
this will cause lsprofile statistics to be gathered and stored in
511
for name, value in self.__old_env.iteritems():
512
self._restoreVar(name, value)
516
unittest.TestCase.tearDown(self)
518
def _runCleanups(self):
519
"""Run registered cleanup functions.
521
This should only be called from TestCase.tearDown.
1630
if self._benchtime is None:
1631
self.addDetail('benchtime', content.Content(content.ContentType(
1632
"text", "plain"), lambda:[str(self._benchtime)]))
1636
if not self._gather_lsprof_in_benchmarks:
1637
return callable(*args, **kwargs)
1639
# record this benchmark
1640
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1642
self._benchcalls.append(((callable, args, kwargs), stats))
1645
self._benchtime += time.time() - start
523
# TODO: Perhaps this should keep running cleanups even if
525
for cleanup_fn in reversed(self._cleanups):
1647
528
def log(self, *args):
1650
def _get_log(self, keep_log_file=False):
1651
"""Internal helper to get the log from bzrlib.trace for this test.
1653
Please use self.getDetails, or self.get_log to access this in test case
1656
:param keep_log_file: When True, if the log is still a file on disk
1657
leave it as a file on disk. When False, if the log is still a file
1658
on disk, the log file is deleted and the log preserved as
1660
:return: A string containing the log.
1662
if self._log_contents is not None:
1664
self._log_contents.decode('utf8')
1665
except UnicodeDecodeError:
1666
unicodestr = self._log_contents.decode('utf8', 'replace')
1667
self._log_contents = unicodestr.encode('utf8')
532
"""Return as a string the log for this test"""
533
if self._log_file_name:
534
return open(self._log_file_name).read()
1668
536
return self._log_contents
1670
if bzrlib.trace._trace_file:
1671
# flush the log file, to get all content
1672
bzrlib.trace._trace_file.flush()
1673
if self._log_file_name is not None:
1674
logfile = open(self._log_file_name)
1676
log_contents = logfile.read()
1680
log_contents.decode('utf8')
1681
except UnicodeDecodeError:
1682
unicodestr = log_contents.decode('utf8', 'replace')
1683
log_contents = unicodestr.encode('utf8')
1684
if not keep_log_file:
1686
max_close_attempts = 100
1687
first_close_error = None
1688
while close_attempts < max_close_attempts:
1691
self._log_file.close()
1692
except IOError, ioe:
1693
if ioe.errno is None:
1694
# No errno implies 'close() called during
1695
# concurrent operation on the same file object', so
1696
# retry. Probably a thread is trying to write to
1698
if first_close_error is None:
1699
first_close_error = ioe
1704
if close_attempts > 1:
1706
'Unable to close log file on first attempt, '
1707
'will retry: %s\n' % (first_close_error,))
1708
if close_attempts == max_close_attempts:
1710
'Unable to close log file after %d attempts.\n'
1711
% (max_close_attempts,))
1712
self._log_file = None
1713
# Permit multiple calls to get_log until we clean it up in
1715
self._log_contents = log_contents
1717
os.remove(self._log_file_name)
1719
if sys.platform == 'win32' and e.errno == errno.EACCES:
1720
sys.stderr.write(('Unable to delete log file '
1721
' %r\n' % self._log_file_name))
1724
self._log_file_name = None
1727
return "No log file content and no log file name."
1730
"""Get a unicode string containing the log from bzrlib.trace.
1732
Undecodable characters are replaced.
1734
return u"".join(self.getDetails()['log'].iter_text())
1736
def requireFeature(self, feature):
1737
"""This test requires a specific feature is available.
1739
:raises UnavailableFeature: When feature is not available.
1741
if not feature.available():
1742
raise UnavailableFeature(feature)
1744
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1746
"""Run bazaar command line, splitting up a string command line."""
1747
if isinstance(args, basestring):
1748
# shlex don't understand unicode strings,
1749
# so args should be plain string (bialix 20070906)
1750
args = list(shlex.split(str(args)))
1751
return self._run_bzr_core(args, retcode=retcode,
1752
encoding=encoding, stdin=stdin, working_dir=working_dir,
1755
def _run_bzr_core(self, args, retcode, encoding, stdin,
1757
# Clear chk_map page cache, because the contents are likely to mask
1759
chk_map.clear_cache()
1760
if encoding is None:
1761
encoding = osutils.get_user_encoding()
1762
stdout = StringIOWrapper()
1763
stderr = StringIOWrapper()
1764
stdout.encoding = encoding
1765
stderr.encoding = encoding
1767
self.log('run bzr: %r', args)
537
# TODO: Delete the log after it's been read in
539
def capture(self, cmd, retcode=0):
540
"""Shortcut that splits cmd into words, runs, and returns stdout"""
541
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
543
def run_bzr_captured(self, argv, retcode=0, stdin=None):
544
"""Invoke bzr and return (stdout, stderr).
546
Useful for code that wants to check the contents of the
547
output, the way error messages are presented, etc.
549
This should be the main method for tests that want to exercise the
550
overall behavior of the bzr application (rather than a unit test
551
or a functional test of the library.)
553
Much of the old code runs bzr by forking a new copy of Python, but
554
that is slower, harder to debug, and generally not necessary.
556
This runs bzr through the interface that catches and reports
557
errors, and with logging set to something approximating the
558
default, so that error reporting can be checked.
560
argv -- arguments to invoke bzr
561
retcode -- expected return code, or None for don't-care.
562
:param stdin: A string to be used as stdin for the command.
564
if stdin is not None:
565
stdin = StringIO(stdin)
568
self.log('run bzr: %s', ' '.join(argv))
1768
569
# FIXME: don't call into logging here
1769
570
handler = logging.StreamHandler(stderr)
571
handler.setFormatter(bzrlib.trace.QuietFormatter())
1770
572
handler.setLevel(logging.INFO)
1771
573
logger = logging.getLogger('')
1772
574
logger.addHandler(handler)
1773
old_ui_factory = ui.ui_factory
1774
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1777
if working_dir is not None:
1778
cwd = osutils.getcwd()
1779
os.chdir(working_dir)
575
old_ui_factory = bzrlib.ui.ui_factory
576
bzrlib.ui.ui_factory = bzrlib.tests.blackbox.TestUIFactory(
579
bzrlib.ui.ui_factory.stdin = stdin
1783
result = self.apply_redirected(ui.ui_factory.stdin,
1785
bzrlib.commands.run_bzr_catch_user_errors,
1787
except KeyboardInterrupt:
1788
# Reraise KeyboardInterrupt with contents of redirected stdout
1789
# and stderr as arguments, for tests which are interested in
1790
# stdout and stderr and are expecting the exception.
1791
out = stdout.getvalue()
1792
err = stderr.getvalue()
1794
self.log('output:\n%r', out)
1796
self.log('errors:\n%r', err)
1797
raise KeyboardInterrupt(out, err)
581
result = self.apply_redirected(stdin, stdout, stderr,
582
bzrlib.commands.run_bzr_catch_errors,
1799
585
logger.removeHandler(handler)
1800
ui.ui_factory = old_ui_factory
586
bzrlib.ui.ui_factory = old_ui_factory
1804
587
out = stdout.getvalue()
1805
588
err = stderr.getvalue()
1807
self.log('output:\n%r', out)
590
self.log('output:\n%s', out)
1809
self.log('errors:\n%r', err)
592
self.log('errors:\n%s', err)
1810
593
if retcode is not None:
1811
self.assertEquals(retcode, result,
1812
message='Unexpected return code')
1813
return result, out, err
594
self.assertEquals(result, retcode)
1815
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1816
working_dir=None, error_regexes=[], output_encoding=None):
597
def run_bzr(self, *args, **kwargs):
1817
598
"""Invoke bzr, as if it were run from the command line.
1819
The argument list should not include the bzr program name - the
1820
first argument is normally the bzr command. Arguments may be
1821
passed in three ways:
1823
1- A list of strings, eg ["commit", "a"]. This is recommended
1824
when the command contains whitespace or metacharacters, or
1825
is built up at run time.
1827
2- A single string, eg "add a". This is the most convenient
1828
for hardcoded commands.
1830
This runs bzr through the interface that catches and reports
1831
errors, and with logging set to something approximating the
1832
default, so that error reporting can be checked.
1834
600
This should be the main method for tests that want to exercise the
1835
601
overall behavior of the bzr application (rather than a unit test
1836
602
or a functional test of the library.)
2094
662
sys.stderr = real_stderr
2095
663
sys.stdin = real_stdin
2097
def reduceLockdirTimeout(self):
2098
"""Reduce the default lock timeout for the duration of the test, so that
2099
if LockContention occurs during a test, it does so quickly.
2101
Tests that expect to provoke LockContention errors should call this.
2103
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2105
def make_utf8_encoded_stringio(self, encoding_type=None):
2106
"""Return a StringIOWrapper instance, that will encode Unicode
2109
if encoding_type is None:
2110
encoding_type = 'strict'
2112
output_encoding = 'utf-8'
2113
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2114
sio.encoding = output_encoding
2117
def disable_verb(self, verb):
2118
"""Disable a smart server verb for one test."""
2119
from bzrlib.smart import request
2120
request_handlers = request.request_handlers
2121
orig_method = request_handlers.get(verb)
2122
request_handlers.remove(verb)
2123
self.addCleanup(request_handlers.register, verb, orig_method)
2126
class CapturedCall(object):
2127
"""A helper for capturing smart server calls for easy debug analysis."""
2129
def __init__(self, params, prefix_length):
2130
"""Capture the call with params and skip prefix_length stack frames."""
2133
# The last 5 frames are the __init__, the hook frame, and 3 smart
2134
# client frames. Beyond this we could get more clever, but this is good
2136
stack = traceback.extract_stack()[prefix_length:-5]
2137
self.stack = ''.join(traceback.format_list(stack))
2140
return self.call.method
2143
return self.call.method
2149
class TestCaseWithMemoryTransport(TestCase):
2150
"""Common test class for tests that do not need disk resources.
2152
Tests that need disk resources should derive from TestCaseWithTransport.
2154
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2156
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2157
a directory which does not exist. This serves to help ensure test isolation
2158
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2159
must exist. However, TestCaseWithMemoryTransport does not offer local
2160
file defaults for the transport in tests, nor does it obey the command line
2161
override, so tests that accidentally write to the common directory should
2164
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2165
a .bzr directory that stops us ascending higher into the filesystem.
2171
def __init__(self, methodName='runTest'):
2172
# allow test parameterization after test construction and before test
2173
# execution. Variables that the parameterizer sets need to be
2174
# ones that are not set by setUp, or setUp will trash them.
2175
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2176
self.vfs_transport_factory = default_transport
2177
self.transport_server = None
2178
self.transport_readonly_server = None
2179
self.__vfs_server = None
2181
def get_transport(self, relpath=None):
2182
"""Return a writeable transport.
2184
This transport is for the test scratch space relative to
2187
:param relpath: a path relative to the base url.
2189
t = get_transport(self.get_url(relpath))
2190
self.assertFalse(t.is_readonly())
2193
def get_readonly_transport(self, relpath=None):
2194
"""Return a readonly transport for the test scratch space
2196
This can be used to test that operations which should only need
2197
readonly access in fact do not try to write.
2199
:param relpath: a path relative to the base url.
2201
t = get_transport(self.get_readonly_url(relpath))
2202
self.assertTrue(t.is_readonly())
2205
def create_transport_readonly_server(self):
2206
"""Create a transport server from class defined at init.
2208
This is mostly a hook for daughter classes.
2210
return self.transport_readonly_server()
2212
def get_readonly_server(self):
2213
"""Get the server instance for the readonly transport
2215
This is useful for some tests with specific servers to do diagnostics.
2217
if self.__readonly_server is None:
2218
if self.transport_readonly_server is None:
2219
# readonly decorator requested
2220
self.__readonly_server = test_server.ReadonlyServer()
2222
# explicit readonly transport.
2223
self.__readonly_server = self.create_transport_readonly_server()
2224
self.start_server(self.__readonly_server,
2225
self.get_vfs_only_server())
2226
return self.__readonly_server
2228
def get_readonly_url(self, relpath=None):
2229
"""Get a URL for the readonly transport.
2231
This will either be backed by '.' or a decorator to the transport
2232
used by self.get_url()
2233
relpath provides for clients to get a path relative to the base url.
2234
These should only be downwards relative, not upwards.
2236
base = self.get_readonly_server().get_url()
2237
return self._adjust_url(base, relpath)
2239
def get_vfs_only_server(self):
2240
"""Get the vfs only read/write server instance.
2242
This is useful for some tests with specific servers that need
2245
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2246
is no means to override it.
2248
if self.__vfs_server is None:
2249
self.__vfs_server = memory.MemoryServer()
2250
self.start_server(self.__vfs_server)
2251
return self.__vfs_server
2253
def get_server(self):
2254
"""Get the read/write server instance.
2256
This is useful for some tests with specific servers that need
2259
This is built from the self.transport_server factory. If that is None,
2260
then the self.get_vfs_server is returned.
2262
if self.__server is None:
2263
if (self.transport_server is None or self.transport_server is
2264
self.vfs_transport_factory):
2265
self.__server = self.get_vfs_only_server()
2267
# bring up a decorated means of access to the vfs only server.
2268
self.__server = self.transport_server()
2269
self.start_server(self.__server, self.get_vfs_only_server())
2270
return self.__server
2272
def _adjust_url(self, base, relpath):
2273
"""Get a URL (or maybe a path) for the readwrite transport.
2275
This will either be backed by '.' or to an equivalent non-file based
2277
relpath provides for clients to get a path relative to the base url.
2278
These should only be downwards relative, not upwards.
2280
if relpath is not None and relpath != '.':
2281
if not base.endswith('/'):
2283
# XXX: Really base should be a url; we did after all call
2284
# get_url()! But sometimes it's just a path (from
2285
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2286
# to a non-escaped local path.
2287
if base.startswith('./') or base.startswith('/'):
2290
base += urlutils.escape(relpath)
2293
def get_url(self, relpath=None):
2294
"""Get a URL (or maybe a path) for the readwrite transport.
2296
This will either be backed by '.' or to an equivalent non-file based
2298
relpath provides for clients to get a path relative to the base url.
2299
These should only be downwards relative, not upwards.
2301
base = self.get_server().get_url()
2302
return self._adjust_url(base, relpath)
2304
def get_vfs_only_url(self, relpath=None):
2305
"""Get a URL (or maybe a path for the plain old vfs transport.
2307
This will never be a smart protocol. It always has all the
2308
capabilities of the local filesystem, but it might actually be a
2309
MemoryTransport or some other similar virtual filesystem.
2311
This is the backing transport (if any) of the server returned by
2312
get_url and get_readonly_url.
2314
:param relpath: provides for clients to get a path relative to the base
2315
url. These should only be downwards relative, not upwards.
2318
base = self.get_vfs_only_server().get_url()
2319
return self._adjust_url(base, relpath)
2321
def _create_safety_net(self):
2322
"""Make a fake bzr directory.
2324
This prevents any tests propagating up onto the TEST_ROOT directory's
2327
root = TestCaseWithMemoryTransport.TEST_ROOT
2328
bzrdir.BzrDir.create_standalone_workingtree(root)
2330
def _check_safety_net(self):
2331
"""Check that the safety .bzr directory have not been touched.
2333
_make_test_root have created a .bzr directory to prevent tests from
2334
propagating. This method ensures than a test did not leaked.
2336
root = TestCaseWithMemoryTransport.TEST_ROOT
2337
self.permit_url(get_transport(root).base)
2338
wt = workingtree.WorkingTree.open(root)
2339
last_rev = wt.last_revision()
2340
if last_rev != 'null:':
2341
# The current test have modified the /bzr directory, we need to
2342
# recreate a new one or all the followng tests will fail.
2343
# If you need to inspect its content uncomment the following line
2344
# import pdb; pdb.set_trace()
2345
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2346
self._create_safety_net()
2347
raise AssertionError('%s/.bzr should not be modified' % root)
2349
def _make_test_root(self):
2350
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2351
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2352
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2354
TestCaseWithMemoryTransport.TEST_ROOT = root
2356
self._create_safety_net()
2358
# The same directory is used by all tests, and we're not
2359
# specifically told when all tests are finished. This will do.
2360
atexit.register(_rmtree_temp_dir, root)
2362
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2363
self.addCleanup(self._check_safety_net)
2365
def makeAndChdirToTestDir(self):
2366
"""Create a temporary directories for this one test.
2368
This must set self.test_home_dir and self.test_dir and chdir to
2371
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2373
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2374
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2375
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2376
self.permit_dir(self.test_dir)
2378
def make_branch(self, relpath, format=None):
2379
"""Create a branch on the transport at relpath."""
2380
repo = self.make_repository(relpath, format=format)
2381
return repo.bzrdir.create_branch()
2383
def make_bzrdir(self, relpath, format=None):
2385
# might be a relative or absolute path
2386
maybe_a_url = self.get_url(relpath)
2387
segments = maybe_a_url.rsplit('/', 1)
2388
t = get_transport(maybe_a_url)
2389
if len(segments) > 1 and segments[-1] not in ('', '.'):
2393
if isinstance(format, basestring):
2394
format = bzrdir.format_registry.make_bzrdir(format)
2395
return format.initialize_on_transport(t)
2396
except errors.UninitializableFormat:
2397
raise TestSkipped("Format %s is not initializable." % format)
2399
def make_repository(self, relpath, shared=False, format=None):
2400
"""Create a repository on our default transport at relpath.
2402
Note that relpath must be a relative path, not a full url.
2404
# FIXME: If you create a remoterepository this returns the underlying
2405
# real format, which is incorrect. Actually we should make sure that
2406
# RemoteBzrDir returns a RemoteRepository.
2407
# maybe mbp 20070410
2408
made_control = self.make_bzrdir(relpath, format=format)
2409
return made_control.create_repository(shared=shared)
2411
def make_smart_server(self, path):
2412
smart_server = test_server.SmartTCPServer_for_testing()
2413
self.start_server(smart_server, self.get_server())
2414
remote_transport = get_transport(smart_server.get_url()).clone(path)
2415
return remote_transport
2417
def make_branch_and_memory_tree(self, relpath, format=None):
2418
"""Create a branch on the default transport and a MemoryTree for it."""
2419
b = self.make_branch(relpath, format=format)
2420
return memorytree.MemoryTree.create_on_branch(b)
2422
def make_branch_builder(self, relpath, format=None):
2423
branch = self.make_branch(relpath, format=format)
2424
return branchbuilder.BranchBuilder(branch=branch)
2426
def overrideEnvironmentForTesting(self):
2427
test_home_dir = self.test_home_dir
2428
if isinstance(test_home_dir, unicode):
2429
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2430
os.environ['HOME'] = test_home_dir
2431
os.environ['BZR_HOME'] = test_home_dir
2434
super(TestCaseWithMemoryTransport, self).setUp()
2435
self._make_test_root()
2436
self.addCleanup(os.chdir, os.getcwdu())
2437
self.makeAndChdirToTestDir()
2438
self.overrideEnvironmentForTesting()
2439
self.__readonly_server = None
2440
self.__server = None
2441
self.reduceLockdirTimeout()
2443
def setup_smart_server_with_call_log(self):
2444
"""Sets up a smart server as the transport server with a call log."""
2445
self.transport_server = test_server.SmartTCPServer_for_testing
2446
self.hpss_calls = []
2448
# Skip the current stack down to the caller of
2449
# setup_smart_server_with_call_log
2450
prefix_length = len(traceback.extract_stack()) - 2
2451
def capture_hpss_call(params):
2452
self.hpss_calls.append(
2453
CapturedCall(params, prefix_length))
2454
client._SmartClient.hooks.install_named_hook(
2455
'call', capture_hpss_call, None)
2457
def reset_smart_call_log(self):
2458
self.hpss_calls = []
2461
class TestCaseInTempDir(TestCaseWithMemoryTransport):
665
def merge(self, branch_from, wt_to):
666
"""A helper for tests to do a ui-less merge.
668
This should move to the main library when someone has time to integrate
671
# minimal ui-less merge.
672
wt_to.branch.fetch(branch_from)
673
base_rev = common_ancestor(branch_from.last_revision(),
674
wt_to.branch.last_revision(),
675
wt_to.branch.repository)
676
merge_inner(wt_to.branch, branch_from.basis_tree(),
677
wt_to.branch.repository.revision_tree(base_rev),
679
wt_to.add_pending_merge(branch_from.last_revision())
682
BzrTestBase = TestCase
685
class TestCaseInTempDir(TestCase):
2462
686
"""Derived class that runs a test within a temporary directory.
2464
688
This is useful for tests that need to create a branch, etc.
2721
975
for readonly urls.
2723
977
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2724
be used without needed to redo it when a different
978
be used without needed to redo it when a different
2725
979
subclass is in use ?
2728
982
def setUp(self):
2729
983
super(ChrootedTestCase, self).setUp()
2730
if not self.vfs_transport_factory == memory.MemoryServer:
2731
self.transport_readonly_server = HttpServer
2734
def condition_id_re(pattern):
2735
"""Create a condition filter which performs a re check on a test's id.
2737
:param pattern: A regular expression string.
2738
:return: A callable that returns True if the re matches.
2740
filter_re = osutils.re_compile_checked(pattern, 0,
2742
def condition(test):
2744
return filter_re.search(test_id)
2748
def condition_isinstance(klass_or_klass_list):
2749
"""Create a condition filter which returns isinstance(param, klass).
2751
:return: A callable which when called with one parameter obj return the
2752
result of isinstance(obj, klass_or_klass_list).
2755
return isinstance(obj, klass_or_klass_list)
2759
def condition_id_in_list(id_list):
2760
"""Create a condition filter which verify that test's id in a list.
2762
:param id_list: A TestIdList object.
2763
:return: A callable that returns True if the test's id appears in the list.
2765
def condition(test):
2766
return id_list.includes(test.id())
2770
def condition_id_startswith(starts):
2771
"""Create a condition filter verifying that test's id starts with a string.
2773
:param starts: A list of string.
2774
:return: A callable that returns True if the test's id starts with one of
2777
def condition(test):
2778
for start in starts:
2779
if test.id().startswith(start):
2785
def exclude_tests_by_condition(suite, condition):
2786
"""Create a test suite which excludes some tests from suite.
2788
:param suite: The suite to get tests from.
2789
:param condition: A callable whose result evaluates True when called with a
2790
test case which should be excluded from the result.
2791
:return: A suite which contains the tests found in suite that fail
2795
for test in iter_suite_tests(suite):
2796
if not condition(test):
2798
return TestUtil.TestSuite(result)
2801
def filter_suite_by_condition(suite, condition):
2802
"""Create a test suite by filtering another one.
2804
:param suite: The source suite.
2805
:param condition: A callable whose result evaluates True when called with a
2806
test case which should be included in the result.
2807
:return: A suite which contains the tests found in suite that pass
2811
for test in iter_suite_tests(suite):
2814
return TestUtil.TestSuite(result)
984
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
985
self.transport_readonly_server = bzrlib.transport.http.HttpServer
2817
988
def filter_suite_by_re(suite, pattern):
2818
"""Create a test suite by filtering another one.
2820
:param suite: the source suite
2821
:param pattern: pattern that names must match
2822
:returns: the newly created suite
2824
condition = condition_id_re(pattern)
2825
result_suite = filter_suite_by_condition(suite, condition)
2829
def filter_suite_by_id_list(suite, test_id_list):
2830
"""Create a test suite by filtering another one.
2832
:param suite: The source suite.
2833
:param test_id_list: A list of the test ids to keep as strings.
2834
:returns: the newly created suite
2836
condition = condition_id_in_list(test_id_list)
2837
result_suite = filter_suite_by_condition(suite, condition)
2841
def filter_suite_by_id_startswith(suite, start):
2842
"""Create a test suite by filtering another one.
2844
:param suite: The source suite.
2845
:param start: A list of string the test id must start with one of.
2846
:returns: the newly created suite
2848
condition = condition_id_startswith(start)
2849
result_suite = filter_suite_by_condition(suite, condition)
2853
def exclude_tests_by_re(suite, pattern):
2854
"""Create a test suite which excludes some tests from suite.
2856
:param suite: The suite to get tests from.
2857
:param pattern: A regular expression string. Test ids that match this
2858
pattern will be excluded from the result.
2859
:return: A TestSuite that contains all the tests from suite without the
2860
tests that matched pattern. The order of tests is the same as it was in
2863
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2866
def preserve_input(something):
2867
"""A helper for performing test suite transformation chains.
2869
:param something: Anything you want to preserve.
2875
def randomize_suite(suite):
2876
"""Return a new TestSuite with suite's tests in random order.
2878
The tests in the input suite are flattened into a single suite in order to
2879
accomplish this. Any nested TestSuites are removed to provide global
2882
tests = list(iter_suite_tests(suite))
2883
random.shuffle(tests)
2884
return TestUtil.TestSuite(tests)
2887
def split_suite_by_condition(suite, condition):
2888
"""Split a test suite into two by a condition.
2890
:param suite: The suite to split.
2891
:param condition: The condition to match on. Tests that match this
2892
condition are returned in the first test suite, ones that do not match
2893
are in the second suite.
2894
:return: A tuple of two test suites, where the first contains tests from
2895
suite matching the condition, and the second contains the remainder
2896
from suite. The order within each output suite is the same as it was in
990
filter_re = re.compile(pattern)
2901
991
for test in iter_suite_tests(suite):
2903
matched.append(test)
2905
did_not_match.append(test)
2906
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2909
def split_suite_by_re(suite, pattern):
2910
"""Split a test suite into two by a regular expression.
2912
:param suite: The suite to split.
2913
:param pattern: A regular expression string. Test ids that match this
2914
pattern will be in the first test suite returned, and the others in the
2915
second test suite returned.
2916
:return: A tuple of two test suites, where the first contains tests from
2917
suite matching pattern, and the second contains the remainder from
2918
suite. The order within each output suite is the same as it was in
2921
return split_suite_by_condition(suite, condition_id_re(pattern))
992
if filter_re.search(test.id()):
2924
997
def run_suite(suite, name='test', verbose=False, pattern=".*",
2925
stop_on_failure=False,
2926
transport=None, lsprof_timed=None, bench_history=None,
2927
matching_tests_first=None,
2930
exclude_pattern=None,
2933
suite_decorators=None,
2935
result_decorators=None,
2937
"""Run a test suite for bzr selftest.
2939
:param runner_class: The class of runner to use. Must support the
2940
constructor arguments passed by run_suite which are more than standard
2942
:return: A boolean indicating success.
2944
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
998
stop_on_failure=False, keep_output=False,
1000
TestCaseInTempDir._TEST_NAME = name
2949
if runner_class is None:
2950
runner_class = TextTestRunner
2953
runner = runner_class(stream=stream,
1006
pb = progress.ProgressBar()
1007
runner = TextTestRunner(stream=sys.stdout,
2954
1008
descriptions=0,
2955
1009
verbosity=verbosity,
2956
bench_history=bench_history,
2958
result_decorators=result_decorators,
1010
keep_output=keep_output,
2960
1012
runner.stop_on_failure=stop_on_failure
2961
# built in decorator factories:
2963
random_order(random_seed, runner),
2964
exclude_tests(exclude_pattern),
2966
if matching_tests_first:
2967
decorators.append(tests_first(pattern))
2969
decorators.append(filter_tests(pattern))
2970
if suite_decorators:
2971
decorators.extend(suite_decorators)
2972
# tell the result object how many tests will be running: (except if
2973
# --parallel=fork is being used. Robert said he will provide a better
2974
# progress design later -- vila 20090817)
2975
if fork_decorator not in decorators:
2976
decorators.append(CountingDecorator)
2977
for decorator in decorators:
2978
suite = decorator(suite)
2980
# Done after test suite decoration to allow randomisation etc
2981
# to take effect, though that is of marginal benefit.
2983
stream.write("Listing tests only ...\n")
2984
for t in iter_suite_tests(suite):
2985
stream.write("%s\n" % (t.id()))
1014
suite = filter_suite_by_re(suite, pattern)
2987
1015
result = runner.run(suite)
2989
return result.wasStrictlySuccessful()
2991
return result.wasSuccessful()
2994
# A registry where get() returns a suite decorator.
2995
parallel_registry = registry.Registry()
2998
def fork_decorator(suite):
2999
concurrency = osutils.local_concurrency()
3000
if concurrency == 1:
3002
from testtools import ConcurrentTestSuite
3003
return ConcurrentTestSuite(suite, fork_for_tests)
3004
parallel_registry.register('fork', fork_decorator)
3007
def subprocess_decorator(suite):
3008
concurrency = osutils.local_concurrency()
3009
if concurrency == 1:
3011
from testtools import ConcurrentTestSuite
3012
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3013
parallel_registry.register('subprocess', subprocess_decorator)
3016
def exclude_tests(exclude_pattern):
3017
"""Return a test suite decorator that excludes tests."""
3018
if exclude_pattern is None:
3019
return identity_decorator
3020
def decorator(suite):
3021
return ExcludeDecorator(suite, exclude_pattern)
3025
def filter_tests(pattern):
3027
return identity_decorator
3028
def decorator(suite):
3029
return FilterTestsDecorator(suite, pattern)
3033
def random_order(random_seed, runner):
3034
"""Return a test suite decorator factory for randomising tests order.
3036
:param random_seed: now, a string which casts to a long, or a long.
3037
:param runner: A test runner with a stream attribute to report on.
3039
if random_seed is None:
3040
return identity_decorator
3041
def decorator(suite):
3042
return RandomDecorator(suite, random_seed, runner.stream)
3046
def tests_first(pattern):
3048
return identity_decorator
3049
def decorator(suite):
3050
return TestFirstDecorator(suite, pattern)
3054
def identity_decorator(suite):
3059
class TestDecorator(TestSuite):
3060
"""A decorator for TestCase/TestSuite objects.
3062
Usually, subclasses should override __iter__(used when flattening test
3063
suites), which we do to filter, reorder, parallelise and so on, run() and
3067
def __init__(self, suite):
3068
TestSuite.__init__(self)
3071
def countTestCases(self):
3074
cases += test.countTestCases()
3081
def run(self, result):
3082
# Use iteration on self, not self._tests, to allow subclasses to hook
3085
if result.shouldStop:
3091
class CountingDecorator(TestDecorator):
3092
"""A decorator which calls result.progress(self.countTestCases)."""
3094
def run(self, result):
3095
progress_method = getattr(result, 'progress', None)
3096
if callable(progress_method):
3097
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3098
return super(CountingDecorator, self).run(result)
3101
class ExcludeDecorator(TestDecorator):
3102
"""A decorator which excludes test matching an exclude pattern."""
3104
def __init__(self, suite, exclude_pattern):
3105
TestDecorator.__init__(self, suite)
3106
self.exclude_pattern = exclude_pattern
3107
self.excluded = False
3111
return iter(self._tests)
3112
self.excluded = True
3113
suite = exclude_tests_by_re(self, self.exclude_pattern)
3115
self.addTests(suite)
3116
return iter(self._tests)
3119
class FilterTestsDecorator(TestDecorator):
3120
"""A decorator which filters tests to those matching a pattern."""
3122
def __init__(self, suite, pattern):
3123
TestDecorator.__init__(self, suite)
3124
self.pattern = pattern
3125
self.filtered = False
3129
return iter(self._tests)
3130
self.filtered = True
3131
suite = filter_suite_by_re(self, self.pattern)
3133
self.addTests(suite)
3134
return iter(self._tests)
3137
class RandomDecorator(TestDecorator):
3138
"""A decorator which randomises the order of its tests."""
3140
def __init__(self, suite, random_seed, stream):
3141
TestDecorator.__init__(self, suite)
3142
self.random_seed = random_seed
3143
self.randomised = False
3144
self.stream = stream
3148
return iter(self._tests)
3149
self.randomised = True
3150
self.stream.write("Randomizing test order using seed %s\n\n" %
3151
(self.actual_seed()))
3152
# Initialise the random number generator.
3153
random.seed(self.actual_seed())
3154
suite = randomize_suite(self)
3156
self.addTests(suite)
3157
return iter(self._tests)
3159
def actual_seed(self):
3160
if self.random_seed == "now":
3161
# We convert the seed to a long to make it reuseable across
3162
# invocations (because the user can reenter it).
3163
self.random_seed = long(time.time())
3165
# Convert the seed to a long if we can
3167
self.random_seed = long(self.random_seed)
3170
return self.random_seed
3173
class TestFirstDecorator(TestDecorator):
3174
"""A decorator which moves named tests to the front."""
3176
def __init__(self, suite, pattern):
3177
TestDecorator.__init__(self, suite)
3178
self.pattern = pattern
3179
self.filtered = False
3183
return iter(self._tests)
3184
self.filtered = True
3185
suites = split_suite_by_re(self, self.pattern)
3187
self.addTests(suites)
3188
return iter(self._tests)
3191
def partition_tests(suite, count):
3192
"""Partition suite into count lists of tests."""
3194
tests = list(iter_suite_tests(suite))
3195
tests_per_process = int(math.ceil(float(len(tests)) / count))
3196
for block in range(count):
3197
low_test = block * tests_per_process
3198
high_test = low_test + tests_per_process
3199
process_tests = tests[low_test:high_test]
3200
result.append(process_tests)
3204
def workaround_zealous_crypto_random():
3205
"""Crypto.Random want to help us being secure, but we don't care here.
3207
This workaround some test failure related to the sftp server. Once paramiko
3208
stop using the controversial API in Crypto.Random, we may get rid of it.
3211
from Crypto.Random import atfork
3217
def fork_for_tests(suite):
3218
"""Take suite and start up one runner per CPU by forking()
3220
:return: An iterable of TestCase-like objects which can each have
3221
run(result) called on them to feed tests to result.
3223
concurrency = osutils.local_concurrency()
3225
from subunit import TestProtocolClient, ProtocolTestCase
3226
from subunit.test_results import AutoTimingTestResultDecorator
3227
class TestInOtherProcess(ProtocolTestCase):
3228
# Should be in subunit, I think. RBC.
3229
def __init__(self, stream, pid):
3230
ProtocolTestCase.__init__(self, stream)
3233
def run(self, result):
3235
ProtocolTestCase.run(self, result)
3237
os.waitpid(self.pid, 0)
3239
test_blocks = partition_tests(suite, concurrency)
3240
for process_tests in test_blocks:
3241
process_suite = TestSuite()
3242
process_suite.addTests(process_tests)
3243
c2pread, c2pwrite = os.pipe()
3246
workaround_zealous_crypto_random()
3249
# Leave stderr and stdout open so we can see test noise
3250
# Close stdin so that the child goes away if it decides to
3251
# read from stdin (otherwise its a roulette to see what
3252
# child actually gets keystrokes for pdb etc).
3255
stream = os.fdopen(c2pwrite, 'wb', 1)
3256
subunit_result = AutoTimingTestResultDecorator(
3257
TestProtocolClient(stream))
3258
process_suite.run(subunit_result)
3263
stream = os.fdopen(c2pread, 'rb', 1)
3264
test = TestInOtherProcess(stream, pid)
3269
def reinvoke_for_tests(suite):
3270
"""Take suite and start up one runner per CPU using subprocess().
3272
:return: An iterable of TestCase-like objects which can each have
3273
run(result) called on them to feed tests to result.
3275
concurrency = osutils.local_concurrency()
3277
from subunit import ProtocolTestCase
3278
class TestInSubprocess(ProtocolTestCase):
3279
def __init__(self, process, name):
3280
ProtocolTestCase.__init__(self, process.stdout)
3281
self.process = process
3282
self.process.stdin.close()
3285
def run(self, result):
3287
ProtocolTestCase.run(self, result)
3290
os.unlink(self.name)
3291
# print "pid %d finished" % finished_process
3292
test_blocks = partition_tests(suite, concurrency)
3293
for process_tests in test_blocks:
3294
# ugly; currently reimplement rather than reuses TestCase methods.
3295
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3296
if not os.path.isfile(bzr_path):
3297
# We are probably installed. Assume sys.argv is the right file
3298
bzr_path = sys.argv[0]
3299
bzr_path = [bzr_path]
3300
if sys.platform == "win32":
3301
# if we're on windows, we can't execute the bzr script directly
3302
bzr_path = [sys.executable] + bzr_path
3303
fd, test_list_file_name = tempfile.mkstemp()
3304
test_list_file = os.fdopen(fd, 'wb', 1)
3305
for test in process_tests:
3306
test_list_file.write(test.id() + '\n')
3307
test_list_file.close()
3309
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3311
if '--no-plugins' in sys.argv:
3312
argv.append('--no-plugins')
3313
# stderr=STDOUT would be ideal, but until we prevent noise on
3314
# stderr it can interrupt the subunit protocol.
3315
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3317
test = TestInSubprocess(process, test_list_file_name)
3320
os.unlink(test_list_file_name)
3325
class ForwardingResult(unittest.TestResult):
3327
def __init__(self, target):
3328
unittest.TestResult.__init__(self)
3329
self.result = target
3331
def startTest(self, test):
3332
self.result.startTest(test)
3334
def stopTest(self, test):
3335
self.result.stopTest(test)
3337
def startTestRun(self):
3338
self.result.startTestRun()
3340
def stopTestRun(self):
3341
self.result.stopTestRun()
3343
def addSkip(self, test, reason):
3344
self.result.addSkip(test, reason)
3346
def addSuccess(self, test):
3347
self.result.addSuccess(test)
3349
def addError(self, test, err):
3350
self.result.addError(test, err)
3352
def addFailure(self, test, err):
3353
self.result.addFailure(test, err)
3354
ForwardingResult = testtools.ExtendedToOriginalDecorator
3357
class ProfileResult(ForwardingResult):
3358
"""Generate profiling data for all activity between start and success.
3360
The profile data is appended to the test's _benchcalls attribute and can
3361
be accessed by the forwarded-to TestResult.
3363
While it might be cleaner do accumulate this in stopTest, addSuccess is
3364
where our existing output support for lsprof is, and this class aims to
3365
fit in with that: while it could be moved it's not necessary to accomplish
3366
test profiling, nor would it be dramatically cleaner.
3369
def startTest(self, test):
3370
self.profiler = bzrlib.lsprof.BzrProfiler()
3371
self.profiler.start()
3372
ForwardingResult.startTest(self, test)
3374
def addSuccess(self, test):
3375
stats = self.profiler.stop()
3377
calls = test._benchcalls
3378
except AttributeError:
3379
test._benchcalls = []
3380
calls = test._benchcalls
3381
calls.append(((test.id(), "", ""), stats))
3382
ForwardingResult.addSuccess(self, test)
3384
def stopTest(self, test):
3385
ForwardingResult.stopTest(self, test)
3386
self.profiler = None
3389
# Controlled by "bzr selftest -E=..." option
3390
# Currently supported:
3391
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3392
# preserves any flags supplied at the command line.
3393
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3394
# rather than failing tests. And no longer raise
3395
# LockContention when fctnl locks are not being used
3396
# with proper exclusion rules.
3397
selftest_debug_flags = set()
1016
return result.wasSuccessful()
3400
1019
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3402
test_suite_factory=None,
3405
matching_tests_first=None,
3408
exclude_pattern=None,
3414
suite_decorators=None,
3418
1022
"""Run the whole test suite under the enhanced runner"""
3419
# XXX: Very ugly way to do this...
3420
# Disable warning about old formats because we don't want it to disturb
3421
# any blackbox tests.
3422
from bzrlib import repository
3423
repository._deprecation_warning_done = True
3425
1023
global default_transport
3426
1024
if transport is None:
3427
1025
transport = default_transport
3428
1026
old_transport = default_transport
3429
1027
default_transport = transport
3430
global selftest_debug_flags
3431
old_debug_flags = selftest_debug_flags
3432
if debug_flags is not None:
3433
selftest_debug_flags = set(debug_flags)
1028
suite = test_suite()
3435
if load_list is None:
3438
keep_only = load_test_id_list(load_list)
3440
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3441
for start in starting_with]
3442
if test_suite_factory is None:
3443
# Reduce loading time by loading modules based on the starting_with
3445
suite = test_suite(keep_only, starting_with)
3447
suite = test_suite_factory()
3449
# But always filter as requested.
3450
suite = filter_suite_by_id_startswith(suite, starting_with)
3451
result_decorators = []
3453
result_decorators.append(ProfileResult)
3454
1030
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3455
stop_on_failure=stop_on_failure,
3456
transport=transport,
3457
lsprof_timed=lsprof_timed,
3458
bench_history=bench_history,
3459
matching_tests_first=matching_tests_first,
3460
list_only=list_only,
3461
random_seed=random_seed,
3462
exclude_pattern=exclude_pattern,
3464
runner_class=runner_class,
3465
suite_decorators=suite_decorators,
3467
result_decorators=result_decorators,
1031
stop_on_failure=stop_on_failure, keep_output=keep_output,
1032
transport=transport)
3470
1034
default_transport = old_transport
3471
selftest_debug_flags = old_debug_flags
3474
def load_test_id_list(file_name):
3475
"""Load a test id list from a text file.
3477
The format is one test id by line. No special care is taken to impose
3478
strict rules, these test ids are used to filter the test suite so a test id
3479
that do not match an existing test will do no harm. This allows user to add
3480
comments, leave blank lines, etc.
3484
ftest = open(file_name, 'rt')
3486
if e.errno != errno.ENOENT:
3489
raise errors.NoSuchFile(file_name)
3491
for test_name in ftest.readlines():
3492
test_list.append(test_name.strip())
3497
def suite_matches_id_list(test_suite, id_list):
3498
"""Warns about tests not appearing or appearing more than once.
3500
:param test_suite: A TestSuite object.
3501
:param test_id_list: The list of test ids that should be found in
3504
:return: (absents, duplicates) absents is a list containing the test found
3505
in id_list but not in test_suite, duplicates is a list containing the
3506
test found multiple times in test_suite.
3508
When using a prefined test id list, it may occurs that some tests do not
3509
exist anymore or that some tests use the same id. This function warns the
3510
tester about potential problems in his workflow (test lists are volatile)
3511
or in the test suite itself (using the same id for several tests does not
3512
help to localize defects).
3514
# Build a dict counting id occurrences
3516
for test in iter_suite_tests(test_suite):
3518
tests[id] = tests.get(id, 0) + 1
3523
occurs = tests.get(id, 0)
3525
not_found.append(id)
3527
duplicates.append(id)
3529
return not_found, duplicates
3532
class TestIdList(object):
3533
"""Test id list to filter a test suite.
3535
Relying on the assumption that test ids are built as:
3536
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3537
notation, this class offers methods to :
3538
- avoid building a test suite for modules not refered to in the test list,
3539
- keep only the tests listed from the module test suite.
3542
def __init__(self, test_id_list):
3543
# When a test suite needs to be filtered against us we compare test ids
3544
# for equality, so a simple dict offers a quick and simple solution.
3545
self.tests = dict().fromkeys(test_id_list, True)
3547
# While unittest.TestCase have ids like:
3548
# <module>.<class>.<method>[(<param+)],
3549
# doctest.DocTestCase can have ids like:
3552
# <module>.<function>
3553
# <module>.<class>.<method>
3555
# Since we can't predict a test class from its name only, we settle on
3556
# a simple constraint: a test id always begins with its module name.
3559
for test_id in test_id_list:
3560
parts = test_id.split('.')
3561
mod_name = parts.pop(0)
3562
modules[mod_name] = True
3564
mod_name += '.' + part
3565
modules[mod_name] = True
3566
self.modules = modules
3568
def refers_to(self, module_name):
3569
"""Is there tests for the module or one of its sub modules."""
3570
return self.modules.has_key(module_name)
3572
def includes(self, test_id):
3573
return self.tests.has_key(test_id)
3576
class TestPrefixAliasRegistry(registry.Registry):
3577
"""A registry for test prefix aliases.
3579
This helps implement shorcuts for the --starting-with selftest
3580
option. Overriding existing prefixes is not allowed but not fatal (a
3581
warning will be emitted).
3584
def register(self, key, obj, help=None, info=None,
3585
override_existing=False):
3586
"""See Registry.register.
3588
Trying to override an existing alias causes a warning to be emitted,
3589
not a fatal execption.
3592
super(TestPrefixAliasRegistry, self).register(
3593
key, obj, help=help, info=info, override_existing=False)
3595
actual = self.get(key)
3596
note('Test prefix alias %s is already used for %s, ignoring %s'
3597
% (key, actual, obj))
3599
def resolve_alias(self, id_start):
3600
"""Replace the alias by the prefix in the given string.
3602
Using an unknown prefix is an error to help catching typos.
3604
parts = id_start.split('.')
3606
parts[0] = self.get(parts[0])
3608
raise errors.BzrCommandError(
3609
'%s is not a known test prefix alias' % parts[0])
3610
return '.'.join(parts)
3613
test_prefix_alias_registry = TestPrefixAliasRegistry()
3614
"""Registry of test prefix aliases."""
3617
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3618
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3619
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3621
# Obvious highest levels prefixes, feel free to add your own via a plugin
3622
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3623
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3624
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3625
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3626
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3629
def _test_suite_testmod_names():
3630
"""Return the standard list of test module names to test."""
3633
'bzrlib.tests.blackbox',
3634
'bzrlib.tests.commands',
3635
'bzrlib.tests.per_branch',
3636
'bzrlib.tests.per_bzrdir',
3637
'bzrlib.tests.per_bzrdir_colo',
3638
'bzrlib.tests.per_foreign_vcs',
3639
'bzrlib.tests.per_interrepository',
3640
'bzrlib.tests.per_intertree',
3641
'bzrlib.tests.per_inventory',
3642
'bzrlib.tests.per_interbranch',
3643
'bzrlib.tests.per_lock',
3644
'bzrlib.tests.per_merger',
3645
'bzrlib.tests.per_transport',
3646
'bzrlib.tests.per_tree',
3647
'bzrlib.tests.per_pack_repository',
3648
'bzrlib.tests.per_repository',
3649
'bzrlib.tests.per_repository_chk',
3650
'bzrlib.tests.per_repository_reference',
3651
'bzrlib.tests.per_uifactory',
3652
'bzrlib.tests.per_versionedfile',
3653
'bzrlib.tests.per_workingtree',
3654
'bzrlib.tests.test__annotator',
3655
'bzrlib.tests.test__bencode',
3656
'bzrlib.tests.test__chk_map',
3657
'bzrlib.tests.test__dirstate_helpers',
3658
'bzrlib.tests.test__groupcompress',
3659
'bzrlib.tests.test__known_graph',
3660
'bzrlib.tests.test__rio',
3661
'bzrlib.tests.test__simple_set',
3662
'bzrlib.tests.test__static_tuple',
3663
'bzrlib.tests.test__walkdirs_win32',
3664
'bzrlib.tests.test_ancestry',
3665
'bzrlib.tests.test_annotate',
3666
'bzrlib.tests.test_api',
3667
'bzrlib.tests.test_atomicfile',
3668
'bzrlib.tests.test_bad_files',
3669
'bzrlib.tests.test_bisect_multi',
3670
'bzrlib.tests.test_branch',
3671
'bzrlib.tests.test_branchbuilder',
3672
'bzrlib.tests.test_btree_index',
3673
'bzrlib.tests.test_bugtracker',
3674
'bzrlib.tests.test_bundle',
3675
'bzrlib.tests.test_bzrdir',
3676
'bzrlib.tests.test__chunks_to_lines',
3677
'bzrlib.tests.test_cache_utf8',
3678
'bzrlib.tests.test_chk_map',
3679
'bzrlib.tests.test_chk_serializer',
3680
'bzrlib.tests.test_chunk_writer',
3681
'bzrlib.tests.test_clean_tree',
3682
'bzrlib.tests.test_cleanup',
3683
'bzrlib.tests.test_cmdline',
3684
'bzrlib.tests.test_commands',
3685
'bzrlib.tests.test_commit',
3686
'bzrlib.tests.test_commit_merge',
3687
'bzrlib.tests.test_config',
3688
'bzrlib.tests.test_conflicts',
3689
'bzrlib.tests.test_counted_lock',
3690
'bzrlib.tests.test_crash',
3691
'bzrlib.tests.test_decorators',
3692
'bzrlib.tests.test_delta',
3693
'bzrlib.tests.test_debug',
3694
'bzrlib.tests.test_deprecated_graph',
3695
'bzrlib.tests.test_diff',
3696
'bzrlib.tests.test_directory_service',
3697
'bzrlib.tests.test_dirstate',
3698
'bzrlib.tests.test_email_message',
3699
'bzrlib.tests.test_eol_filters',
3700
'bzrlib.tests.test_errors',
3701
'bzrlib.tests.test_export',
3702
'bzrlib.tests.test_extract',
3703
'bzrlib.tests.test_fetch',
3704
'bzrlib.tests.test_fifo_cache',
3705
'bzrlib.tests.test_filters',
3706
'bzrlib.tests.test_ftp_transport',
3707
'bzrlib.tests.test_foreign',
3708
'bzrlib.tests.test_generate_docs',
3709
'bzrlib.tests.test_generate_ids',
3710
'bzrlib.tests.test_globbing',
3711
'bzrlib.tests.test_gpg',
3712
'bzrlib.tests.test_graph',
3713
'bzrlib.tests.test_groupcompress',
3714
'bzrlib.tests.test_hashcache',
3715
'bzrlib.tests.test_help',
3716
'bzrlib.tests.test_hooks',
3717
'bzrlib.tests.test_http',
3718
'bzrlib.tests.test_http_response',
3719
'bzrlib.tests.test_https_ca_bundle',
3720
'bzrlib.tests.test_identitymap',
3721
'bzrlib.tests.test_ignores',
3722
'bzrlib.tests.test_index',
3723
'bzrlib.tests.test_import_tariff',
3724
'bzrlib.tests.test_info',
3725
'bzrlib.tests.test_inv',
3726
'bzrlib.tests.test_inventory_delta',
3727
'bzrlib.tests.test_knit',
3728
'bzrlib.tests.test_lazy_import',
3729
'bzrlib.tests.test_lazy_regex',
3730
'bzrlib.tests.test_lock',
3731
'bzrlib.tests.test_lockable_files',
3732
'bzrlib.tests.test_lockdir',
3733
'bzrlib.tests.test_log',
3734
'bzrlib.tests.test_lru_cache',
3735
'bzrlib.tests.test_lsprof',
3736
'bzrlib.tests.test_mail_client',
3737
'bzrlib.tests.test_matchers',
3738
'bzrlib.tests.test_memorytree',
3739
'bzrlib.tests.test_merge',
3740
'bzrlib.tests.test_merge3',
3741
'bzrlib.tests.test_merge_core',
3742
'bzrlib.tests.test_merge_directive',
3743
'bzrlib.tests.test_missing',
3744
'bzrlib.tests.test_msgeditor',
3745
'bzrlib.tests.test_multiparent',
3746
'bzrlib.tests.test_mutabletree',
3747
'bzrlib.tests.test_nonascii',
3748
'bzrlib.tests.test_options',
3749
'bzrlib.tests.test_osutils',
3750
'bzrlib.tests.test_osutils_encodings',
3751
'bzrlib.tests.test_pack',
3752
'bzrlib.tests.test_patch',
3753
'bzrlib.tests.test_patches',
3754
'bzrlib.tests.test_permissions',
3755
'bzrlib.tests.test_plugins',
3756
'bzrlib.tests.test_progress',
3757
'bzrlib.tests.test_read_bundle',
3758
'bzrlib.tests.test_reconcile',
3759
'bzrlib.tests.test_reconfigure',
3760
'bzrlib.tests.test_registry',
3761
'bzrlib.tests.test_remote',
3762
'bzrlib.tests.test_rename_map',
3763
'bzrlib.tests.test_repository',
3764
'bzrlib.tests.test_revert',
3765
'bzrlib.tests.test_revision',
3766
'bzrlib.tests.test_revisionspec',
3767
'bzrlib.tests.test_revisiontree',
3768
'bzrlib.tests.test_rio',
3769
'bzrlib.tests.test_rules',
3770
'bzrlib.tests.test_sampler',
3771
'bzrlib.tests.test_script',
3772
'bzrlib.tests.test_selftest',
3773
'bzrlib.tests.test_serializer',
3774
'bzrlib.tests.test_setup',
3775
'bzrlib.tests.test_sftp_transport',
3776
'bzrlib.tests.test_shelf',
3777
'bzrlib.tests.test_shelf_ui',
3778
'bzrlib.tests.test_smart',
3779
'bzrlib.tests.test_smart_add',
3780
'bzrlib.tests.test_smart_request',
3781
'bzrlib.tests.test_smart_transport',
3782
'bzrlib.tests.test_smtp_connection',
3783
'bzrlib.tests.test_source',
3784
'bzrlib.tests.test_ssh_transport',
3785
'bzrlib.tests.test_status',
3786
'bzrlib.tests.test_store',
3787
'bzrlib.tests.test_strace',
3788
'bzrlib.tests.test_subsume',
3789
'bzrlib.tests.test_switch',
3790
'bzrlib.tests.test_symbol_versioning',
3791
'bzrlib.tests.test_tag',
3792
'bzrlib.tests.test_testament',
3793
'bzrlib.tests.test_textfile',
3794
'bzrlib.tests.test_textmerge',
3795
'bzrlib.tests.test_timestamp',
3796
'bzrlib.tests.test_trace',
3797
'bzrlib.tests.test_transactions',
3798
'bzrlib.tests.test_transform',
3799
'bzrlib.tests.test_transport',
3800
'bzrlib.tests.test_transport_log',
3801
'bzrlib.tests.test_tree',
3802
'bzrlib.tests.test_treebuilder',
3803
'bzrlib.tests.test_tsort',
3804
'bzrlib.tests.test_tuned_gzip',
3805
'bzrlib.tests.test_ui',
3806
'bzrlib.tests.test_uncommit',
3807
'bzrlib.tests.test_upgrade',
3808
'bzrlib.tests.test_upgrade_stacked',
3809
'bzrlib.tests.test_urlutils',
3810
'bzrlib.tests.test_version',
3811
'bzrlib.tests.test_version_info',
3812
'bzrlib.tests.test_weave',
3813
'bzrlib.tests.test_whitebox',
3814
'bzrlib.tests.test_win32utils',
3815
'bzrlib.tests.test_workingtree',
3816
'bzrlib.tests.test_workingtree_4',
3817
'bzrlib.tests.test_wsgi',
3818
'bzrlib.tests.test_xml',
3822
def _test_suite_modules_to_doctest():
3823
"""Return the list of modules to doctest."""
3825
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3829
'bzrlib.branchbuilder',
3830
'bzrlib.decorators',
3833
'bzrlib.iterablefile',
3837
'bzrlib.symbol_versioning',
3840
'bzrlib.version_info_formats.format_custom',
3844
def test_suite(keep_only=None, starting_with=None):
3845
"""Build and return TestSuite for the whole of bzrlib.
3847
:param keep_only: A list of test ids limiting the suite returned.
3849
:param starting_with: An id limiting the suite returned to the tests
3852
This function can be replaced if you need to change the default test
3853
suite on a global basis, but it is not encouraged.
3856
loader = TestUtil.TestLoader()
3858
if keep_only is not None:
3859
id_filter = TestIdList(keep_only)
3861
# We take precedence over keep_only because *at loading time* using
3862
# both options means we will load less tests for the same final result.
3863
def interesting_module(name):
3864
for start in starting_with:
3866
# Either the module name starts with the specified string
3867
name.startswith(start)
3868
# or it may contain tests starting with the specified string
3869
or start.startswith(name)
3873
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3875
elif keep_only is not None:
3876
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3877
def interesting_module(name):
3878
return id_filter.refers_to(name)
3881
loader = TestUtil.TestLoader()
3882
def interesting_module(name):
3883
# No filtering, all modules are interesting
3886
suite = loader.suiteClass()
3888
# modules building their suite with loadTestsFromModuleNames
3889
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3891
for mod in _test_suite_modules_to_doctest():
3892
if not interesting_module(mod):
3893
# No tests to keep here, move along
3896
# note that this really does mean "report only" -- doctest
3897
# still runs the rest of the examples
3898
doc_suite = doctest.DocTestSuite(mod,
3899
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3900
except ValueError, e:
3901
print '**failed to get doctest for: %s\n%s' % (mod, e)
3903
if len(doc_suite._tests) == 0:
3904
raise errors.BzrError("no doctests found in %s" % (mod,))
3905
suite.addTest(doc_suite)
3907
default_encoding = sys.getdefaultencoding()
3908
for name, plugin in bzrlib.plugin.plugins().items():
3909
if not interesting_module(plugin.module.__name__):
3911
plugin_suite = plugin.test_suite()
3912
# We used to catch ImportError here and turn it into just a warning,
3913
# but really if you don't have --no-plugins this should be a failure.
3914
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3915
if plugin_suite is None:
3916
plugin_suite = plugin.load_plugin_tests(loader)
3917
if plugin_suite is not None:
3918
suite.addTest(plugin_suite)
3919
if default_encoding != sys.getdefaultencoding():
3920
bzrlib.trace.warning(
3921
'Plugin "%s" tried to reset default encoding to: %s', name,
3922
sys.getdefaultencoding())
3924
sys.setdefaultencoding(default_encoding)
3926
if keep_only is not None:
3927
# Now that the referred modules have loaded their tests, keep only the
3929
suite = filter_suite_by_id_list(suite, id_filter)
3930
# Do some sanity checks on the id_list filtering
3931
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3933
# The tester has used both keep_only and starting_with, so he is
3934
# already aware that some tests are excluded from the list, there
3935
# is no need to tell him which.
3938
# Some tests mentioned in the list are not in the test suite. The
3939
# list may be out of date, report to the tester.
3940
for id in not_found:
3941
bzrlib.trace.warning('"%s" not found in the test suite', id)
3942
for id in duplicates:
3943
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
1039
"""Build and return TestSuite for the whole program."""
1040
from doctest import DocTestSuite
1042
global MODULES_TO_DOCTEST
1045
'bzrlib.tests.test_ancestry',
1046
'bzrlib.tests.test_api',
1047
'bzrlib.tests.test_bad_files',
1048
'bzrlib.tests.test_branch',
1049
'bzrlib.tests.test_bzrdir',
1050
'bzrlib.tests.test_command',
1051
'bzrlib.tests.test_commit',
1052
'bzrlib.tests.test_commit_merge',
1053
'bzrlib.tests.test_config',
1054
'bzrlib.tests.test_conflicts',
1055
'bzrlib.tests.test_decorators',
1056
'bzrlib.tests.test_diff',
1057
'bzrlib.tests.test_doc_generate',
1058
'bzrlib.tests.test_errors',
1059
'bzrlib.tests.test_escaped_store',
1060
'bzrlib.tests.test_fetch',
1061
'bzrlib.tests.test_gpg',
1062
'bzrlib.tests.test_graph',
1063
'bzrlib.tests.test_hashcache',
1064
'bzrlib.tests.test_http',
1065
'bzrlib.tests.test_identitymap',
1066
'bzrlib.tests.test_inv',
1067
'bzrlib.tests.test_knit',
1068
'bzrlib.tests.test_lockdir',
1069
'bzrlib.tests.test_lockable_files',
1070
'bzrlib.tests.test_log',
1071
'bzrlib.tests.test_merge',
1072
'bzrlib.tests.test_merge3',
1073
'bzrlib.tests.test_merge_core',
1074
'bzrlib.tests.test_missing',
1075
'bzrlib.tests.test_msgeditor',
1076
'bzrlib.tests.test_nonascii',
1077
'bzrlib.tests.test_options',
1078
'bzrlib.tests.test_osutils',
1079
'bzrlib.tests.test_patch',
1080
'bzrlib.tests.test_permissions',
1081
'bzrlib.tests.test_plugins',
1082
'bzrlib.tests.test_progress',
1083
'bzrlib.tests.test_reconcile',
1084
'bzrlib.tests.test_repository',
1085
'bzrlib.tests.test_revision',
1086
'bzrlib.tests.test_revisionnamespaces',
1087
'bzrlib.tests.test_revprops',
1088
'bzrlib.tests.test_rio',
1089
'bzrlib.tests.test_sampler',
1090
'bzrlib.tests.test_selftest',
1091
'bzrlib.tests.test_setup',
1092
'bzrlib.tests.test_sftp_transport',
1093
'bzrlib.tests.test_smart_add',
1094
'bzrlib.tests.test_source',
1095
'bzrlib.tests.test_status',
1096
'bzrlib.tests.test_store',
1097
'bzrlib.tests.test_symbol_versioning',
1098
'bzrlib.tests.test_testament',
1099
'bzrlib.tests.test_textfile',
1100
'bzrlib.tests.test_textmerge',
1101
'bzrlib.tests.test_trace',
1102
'bzrlib.tests.test_transactions',
1103
'bzrlib.tests.test_transform',
1104
'bzrlib.tests.test_transport',
1105
'bzrlib.tests.test_tsort',
1106
'bzrlib.tests.test_tuned_gzip',
1107
'bzrlib.tests.test_ui',
1108
'bzrlib.tests.test_upgrade',
1109
'bzrlib.tests.test_versionedfile',
1110
'bzrlib.tests.test_weave',
1111
'bzrlib.tests.test_whitebox',
1112
'bzrlib.tests.test_workingtree',
1113
'bzrlib.tests.test_xml',
1115
test_transport_implementations = [
1116
'bzrlib.tests.test_transport_implementations']
1118
TestCase.BZRPATH = osutils.pathjoin(
1119
osutils.realpath(osutils.dirname(bzrlib.__path__[0])), 'bzr')
1120
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
1121
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
1124
# python2.4's TestLoader.loadTestsFromNames gives very poor
1125
# errors if it fails to load a named module - no indication of what's
1126
# actually wrong, just "no such module". We should probably override that
1127
# class, but for the moment just load them ourselves. (mbp 20051202)
1128
loader = TestLoader()
1129
from bzrlib.transport import TransportTestProviderAdapter
1130
adapter = TransportTestProviderAdapter()
1131
adapt_modules(test_transport_implementations, adapter, loader, suite)
1132
for mod_name in testmod_names:
1133
mod = _load_module_by_name(mod_name)
1134
suite.addTest(loader.loadTestsFromModule(mod))
1135
for package in packages_to_test():
1136
suite.addTest(package.test_suite())
1137
for m in MODULES_TO_TEST:
1138
suite.addTest(loader.loadTestsFromModule(m))
1139
for m in (MODULES_TO_DOCTEST):
1140
suite.addTest(DocTestSuite(m))
1141
for name, plugin in bzrlib.plugin.all_plugins().items():
1142
if getattr(plugin, 'test_suite', None) is not None:
1143
suite.addTest(plugin.test_suite())
3948
def multiply_scenarios(scenarios_left, scenarios_right):
3949
"""Multiply two sets of scenarios.
3951
:returns: the cartesian product of the two sets of scenarios, that is
3952
a scenario for every possible combination of a left scenario and a
3956
('%s,%s' % (left_name, right_name),
3957
dict(left_dict.items() + right_dict.items()))
3958
for left_name, left_dict in scenarios_left
3959
for right_name, right_dict in scenarios_right]
3962
def multiply_tests(tests, scenarios, result):
3963
"""Multiply tests_list by scenarios into result.
3965
This is the core workhorse for test parameterisation.
3967
Typically the load_tests() method for a per-implementation test suite will
3968
call multiply_tests and return the result.
3970
:param tests: The tests to parameterise.
3971
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3972
scenario_param_dict).
3973
:param result: A TestSuite to add created tests to.
3975
This returns the passed in result TestSuite with the cross product of all
3976
the tests repeated once for each scenario. Each test is adapted by adding
3977
the scenario name at the end of its id(), and updating the test object's
3978
__dict__ with the scenario_param_dict.
3980
>>> import bzrlib.tests.test_sampler
3981
>>> r = multiply_tests(
3982
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3983
... [('one', dict(param=1)),
3984
... ('two', dict(param=2))],
3986
>>> tests = list(iter_suite_tests(r))
3990
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3996
for test in iter_suite_tests(tests):
3997
apply_scenarios(test, scenarios, result)
4001
def apply_scenarios(test, scenarios, result):
4002
"""Apply the scenarios in scenarios to test and add to result.
4004
:param test: The test to apply scenarios to.
4005
:param scenarios: An iterable of scenarios to apply to test.
4007
:seealso: apply_scenario
4009
for scenario in scenarios:
4010
result.addTest(apply_scenario(test, scenario))
4014
def apply_scenario(test, scenario):
4015
"""Copy test and apply scenario to it.
4017
:param test: A test to adapt.
4018
:param scenario: A tuple describing the scenarion.
4019
The first element of the tuple is the new test id.
4020
The second element is a dict containing attributes to set on the
4022
:return: The adapted test.
4024
new_id = "%s(%s)" % (test.id(), scenario[0])
4025
new_test = clone_test(test, new_id)
4026
for name, value in scenario[1].items():
4027
setattr(new_test, name, value)
4031
def clone_test(test, new_id):
4032
"""Clone a test giving it a new id.
4034
:param test: The test to clone.
4035
:param new_id: The id to assign to it.
4036
:return: The new test.
4038
new_test = copy(test)
4039
new_test.id = lambda: new_id
4043
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4045
"""Helper for permutating tests against an extension module.
4047
This is meant to be used inside a modules 'load_tests()' function. It will
4048
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4049
against both implementations. Setting 'test.module' to the appropriate
4050
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4052
:param standard_tests: A test suite to permute
4053
:param loader: A TestLoader
4054
:param py_module_name: The python path to a python module that can always
4055
be loaded, and will be considered the 'python' implementation. (eg
4056
'bzrlib._chk_map_py')
4057
:param ext_module_name: The python path to an extension module. If the
4058
module cannot be loaded, a single test will be added, which notes that
4059
the module is not available. If it can be loaded, all standard_tests
4060
will be run against that module.
4061
:return: (suite, feature) suite is a test-suite that has all the permuted
4062
tests. feature is the Feature object that can be used to determine if
4063
the module is available.
4066
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4068
('python', {'module': py_module}),
4070
suite = loader.suiteClass()
4071
feature = ModuleAvailableFeature(ext_module_name)
4072
if feature.available():
4073
scenarios.append(('C', {'module': feature.module}))
4075
# the compiled module isn't available, so we add a failing test
4076
class FailWithoutFeature(TestCase):
4077
def test_fail(self):
4078
self.requireFeature(feature)
4079
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4080
result = multiply_tests(standard_tests, scenarios, suite)
4081
return result, feature
4084
def _rmtree_temp_dir(dirname, test_id=None):
4085
# If LANG=C we probably have created some bogus paths
4086
# which rmtree(unicode) will fail to delete
4087
# so make sure we are using rmtree(str) to delete everything
4088
# except on win32, where rmtree(str) will fail
4089
# since it doesn't have the property of byte-stream paths
4090
# (they are either ascii or mbcs)
4091
if sys.platform == 'win32':
4092
# make sure we are using the unicode win32 api
4093
dirname = unicode(dirname)
4095
dirname = dirname.encode(sys.getfilesystemencoding())
4097
osutils.rmtree(dirname)
4099
# We don't want to fail here because some useful display will be lost
4100
# otherwise. Polluting the tmp dir is bad, but not giving all the
4101
# possible info to the test runner is even worse.
4103
ui.ui_factory.clear_term()
4104
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4105
sys.stderr.write('Unable to remove testing dir %s\n%s'
4106
% (os.path.basename(dirname), e))
4109
class Feature(object):
4110
"""An operating system Feature."""
4113
self._available = None
4115
def available(self):
4116
"""Is the feature available?
4118
:return: True if the feature is available.
4120
if self._available is None:
4121
self._available = self._probe()
4122
return self._available
4125
"""Implement this method in concrete features.
4127
:return: True if the feature is available.
4129
raise NotImplementedError
4132
if getattr(self, 'feature_name', None):
4133
return self.feature_name()
4134
return self.__class__.__name__
4137
class _SymlinkFeature(Feature):
4140
return osutils.has_symlinks()
4142
def feature_name(self):
4145
SymlinkFeature = _SymlinkFeature()
4148
class _HardlinkFeature(Feature):
4151
return osutils.has_hardlinks()
4153
def feature_name(self):
4156
HardlinkFeature = _HardlinkFeature()
4159
class _OsFifoFeature(Feature):
4162
return getattr(os, 'mkfifo', None)
4164
def feature_name(self):
4165
return 'filesystem fifos'
4167
OsFifoFeature = _OsFifoFeature()
4170
class _UnicodeFilenameFeature(Feature):
4171
"""Does the filesystem support Unicode filenames?"""
4175
# Check for character combinations unlikely to be covered by any
4176
# single non-unicode encoding. We use the characters
4177
# - greek small letter alpha (U+03B1) and
4178
# - braille pattern dots-123456 (U+283F).
4179
os.stat(u'\u03b1\u283f')
4180
except UnicodeEncodeError:
4182
except (IOError, OSError):
4183
# The filesystem allows the Unicode filename but the file doesn't
4187
# The filesystem allows the Unicode filename and the file exists,
4191
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4194
class _CompatabilityThunkFeature(Feature):
4195
"""This feature is just a thunk to another feature.
4197
It issues a deprecation warning if it is accessed, to let you know that you
4198
should really use a different feature.
4201
def __init__(self, dep_version, module, name,
4202
replacement_name, replacement_module=None):
4203
super(_CompatabilityThunkFeature, self).__init__()
4204
self._module = module
4205
if replacement_module is None:
4206
replacement_module = module
4207
self._replacement_module = replacement_module
4209
self._replacement_name = replacement_name
4210
self._dep_version = dep_version
4211
self._feature = None
4214
if self._feature is None:
4215
depr_msg = self._dep_version % ('%s.%s'
4216
% (self._module, self._name))
4217
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4218
self._replacement_name)
4219
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4220
# Import the new feature and use it as a replacement for the
4222
mod = __import__(self._replacement_module, {}, {},
4223
[self._replacement_name])
4224
self._feature = getattr(mod, self._replacement_name)
4228
return self._feature._probe()
4231
class ModuleAvailableFeature(Feature):
4232
"""This is a feature than describes a module we want to be available.
4234
Declare the name of the module in __init__(), and then after probing, the
4235
module will be available as 'self.module'.
4237
:ivar module: The module if it is available, else None.
4240
def __init__(self, module_name):
4241
super(ModuleAvailableFeature, self).__init__()
4242
self.module_name = module_name
4246
self._module = __import__(self.module_name, {}, {}, [''])
4253
if self.available(): # Make sure the probe has been done
4257
def feature_name(self):
4258
return self.module_name
4261
# This is kept here for compatibility, it is recommended to use
4262
# 'bzrlib.tests.feature.paramiko' instead
4263
ParamikoFeature = _CompatabilityThunkFeature(
4264
deprecated_in((2,1,0)),
4265
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4268
def probe_unicode_in_user_encoding():
4269
"""Try to encode several unicode strings to use in unicode-aware tests.
4270
Return first successfull match.
4272
:return: (unicode value, encoded plain string value) or (None, None)
4274
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4275
for uni_val in possible_vals:
4277
str_val = uni_val.encode(osutils.get_user_encoding())
4278
except UnicodeEncodeError:
4279
# Try a different character
4282
return uni_val, str_val
4286
def probe_bad_non_ascii(encoding):
4287
"""Try to find [bad] character with code [128..255]
4288
that cannot be decoded to unicode in some encoding.
4289
Return None if all non-ascii characters is valid
4292
for i in xrange(128, 256):
4295
char.decode(encoding)
4296
except UnicodeDecodeError:
4301
class _HTTPSServerFeature(Feature):
4302
"""Some tests want an https Server, check if one is available.
4304
Right now, the only way this is available is under python2.6 which provides
4315
def feature_name(self):
4316
return 'HTTPSServer'
4319
HTTPSServerFeature = _HTTPSServerFeature()
4322
class _UnicodeFilename(Feature):
4323
"""Does the filesystem support Unicode filenames?"""
4328
except UnicodeEncodeError:
4330
except (IOError, OSError):
4331
# The filesystem allows the Unicode filename but the file doesn't
4335
# The filesystem allows the Unicode filename and the file exists,
4339
UnicodeFilename = _UnicodeFilename()
4342
class _UTF8Filesystem(Feature):
4343
"""Is the filesystem UTF-8?"""
4346
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4350
UTF8Filesystem = _UTF8Filesystem()
4353
class _BreakinFeature(Feature):
4354
"""Does this platform support the breakin feature?"""
4357
from bzrlib import breakin
4358
if breakin.determine_signal() is None:
4360
if sys.platform == 'win32':
4361
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4362
# We trigger SIGBREAK via a Console api so we need ctypes to
4363
# access the function
4370
def feature_name(self):
4371
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4374
BreakinFeature = _BreakinFeature()
4377
class _CaseInsCasePresFilenameFeature(Feature):
4378
"""Is the file-system case insensitive, but case-preserving?"""
4381
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4383
# first check truly case-preserving for created files, then check
4384
# case insensitive when opening existing files.
4385
name = osutils.normpath(name)
4386
base, rel = osutils.split(name)
4387
found_rel = osutils.canonical_relpath(base, name)
4388
return (found_rel == rel
4389
and os.path.isfile(name.upper())
4390
and os.path.isfile(name.lower()))
4395
def feature_name(self):
4396
return "case-insensitive case-preserving filesystem"
4398
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4401
class _CaseInsensitiveFilesystemFeature(Feature):
4402
"""Check if underlying filesystem is case-insensitive but *not* case
4405
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4406
# more likely to be case preserving, so this case is rare.
4409
if CaseInsCasePresFilenameFeature.available():
4412
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4413
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4414
TestCaseWithMemoryTransport.TEST_ROOT = root
4416
root = TestCaseWithMemoryTransport.TEST_ROOT
4417
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4419
name_a = osutils.pathjoin(tdir, 'a')
4420
name_A = osutils.pathjoin(tdir, 'A')
4422
result = osutils.isdir(name_A)
4423
_rmtree_temp_dir(tdir)
4426
def feature_name(self):
4427
return 'case-insensitive filesystem'
4429
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4432
class _CaseSensitiveFilesystemFeature(Feature):
4435
if CaseInsCasePresFilenameFeature.available():
4437
elif CaseInsensitiveFilesystemFeature.available():
4442
def feature_name(self):
4443
return 'case-sensitive filesystem'
4445
# new coding style is for feature instances to be lowercase
4446
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4449
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4450
SubUnitFeature = _CompatabilityThunkFeature(
4451
deprecated_in((2,1,0)),
4452
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4453
# Only define SubUnitBzrRunner if subunit is available.
4455
from subunit import TestProtocolClient
4456
from subunit.test_results import AutoTimingTestResultDecorator
4457
class SubUnitBzrRunner(TextTestRunner):
4458
def run(self, test):
4459
result = AutoTimingTestResultDecorator(
4460
TestProtocolClient(self.stream))
4466
class _PosixPermissionsFeature(Feature):
4470
# create temporary file and check if specified perms are maintained.
4473
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4474
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4477
os.chmod(name, write_perms)
4479
read_perms = os.stat(name).st_mode & 0777
4481
return (write_perms == read_perms)
4483
return (os.name == 'posix') and has_perms()
4485
def feature_name(self):
4486
return 'POSIX permissions support'
4488
posix_permissions_feature = _PosixPermissionsFeature()
1147
def adapt_modules(mods_list, adapter, loader, suite):
1148
"""Adapt the modules in mods_list using adapter and add to suite."""
1149
for mod_name in mods_list:
1150
mod = _load_module_by_name(mod_name)
1151
for test in iter_suite_tests(loader.loadTestsFromModule(mod)):
1152
suite.addTests(adapter.adapt(test))
1155
def _load_module_by_name(mod_name):
1156
parts = mod_name.split('.')
1157
module = __import__(mod_name)
1159
# for historical reasons python returns the top-level module even though
1160
# it loads the submodule; we need to walk down to get the one we want.
1162
module = getattr(module, parts.pop(0))
added
removed
bzrlib/tests/__init__.py
