91
59
from bzrlib.merge import merge_inner
92
60
import bzrlib.merge3
62
import bzrlib.osutils as osutils
93
63
import bzrlib.plugin
94
from bzrlib.smart import client, request, server
64
import bzrlib.progress as progress
65
from bzrlib.revision import common_ancestor
95
66
import bzrlib.store
96
67
from bzrlib import symbol_versioning
97
from bzrlib.symbol_versioning import (
104
68
import bzrlib.trace
105
from bzrlib.transport import (
69
from bzrlib.transport import get_transport
110
70
import bzrlib.transport
111
from bzrlib.trace import mutter, note
112
from bzrlib.tests import (
116
from bzrlib.tests.http_server import HttpServer
71
from bzrlib.transport.local import LocalRelpathServer
72
from bzrlib.transport.readonly import ReadonlyServer
73
from bzrlib.trace import mutter
74
from bzrlib.tests import TestUtil
117
75
from bzrlib.tests.TestUtil import (
121
79
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
80
import bzrlib.urlutils as urlutils
125
81
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.
83
default_transport = LocalRelpathServer
86
MODULES_TO_DOCTEST = [
88
bzrlib.bundle.serializer,
101
def packages_to_test():
102
"""Return a list of packages to test.
104
The packages are not globally imported so that import failures are
105
triggered when running selftest, not when importing the command.
108
import bzrlib.tests.blackbox
109
import bzrlib.tests.branch_implementations
110
import bzrlib.tests.bzrdir_implementations
111
import bzrlib.tests.interrepository_implementations
112
import bzrlib.tests.interversionedfile_implementations
113
import bzrlib.tests.intertree_implementations
114
import bzrlib.tests.repository_implementations
115
import bzrlib.tests.revisionstore_implementations
116
import bzrlib.tests.tree_implementations
117
import bzrlib.tests.workingtree_implementations
120
bzrlib.tests.blackbox,
121
bzrlib.tests.branch_implementations,
122
bzrlib.tests.bzrdir_implementations,
123
bzrlib.tests.interrepository_implementations,
124
bzrlib.tests.interversionedfile_implementations,
125
bzrlib.tests.intertree_implementations,
126
bzrlib.tests.repository_implementations,
127
bzrlib.tests.revisionstore_implementations,
128
bzrlib.tests.tree_implementations,
129
bzrlib.tests.workingtree_implementations,
133
class _MyResult(unittest._TextTestResult):
134
"""Custom TestResult.
136
Shows output in a different format, including displaying runtime for tests.
160
138
stop_early = False
162
def __init__(self, stream, descriptions, verbosity,
140
def __init__(self, stream, descriptions, verbosity, pb=None,
166
142
"""Construct new TestResult.
168
144
:param bench_history: Optionally, a writable file object to accumulate
169
145
benchmark results.
171
147
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
172
149
if bench_history is not None:
173
150
from bzrlib.version import _get_bzr_source_tree
174
151
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
153
revision_id = src_tree.last_revision()
183
155
# XXX: If there's no branch, what should we do?
185
157
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
186
158
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):
160
def extractBenchmarkTime(self, testCase):
254
161
"""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)
162
self._benchmarkTime = getattr(testCase, "_benchtime", None)
259
164
def _elapsedTestTimeString(self):
260
165
"""Return a time string for the overall time the current test has taken."""
261
166
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) + "*"
168
def _testTimeString(self):
169
if self._benchmarkTime is not None:
171
self._formatTime(self._benchmarkTime),
172
self._elapsedTestTimeString())
268
return self._elapsedTestTimeString()
174
return " %s" % self._elapsedTestTimeString()
270
176
def _formatTime(self, seconds):
271
177
"""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)
178
return "%5dms" % (1000 * seconds)
276
def _shortened_test_description(self, test):
278
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
180
def _ellipsise_unimportant_words(self, a_string, final_width,
182
"""Add ellipses (sp?) for overly long strings.
184
:param keep_start: If true preserve the start of a_string rather
188
if len(a_string) > final_width:
189
result = a_string[:final_width-3] + '...'
193
if len(a_string) > final_width:
194
result = '...' + a_string[3-final_width:]
197
return result.ljust(final_width)
281
199
def startTest(self, test):
282
200
unittest.TestResult.startTest(self, test)
285
self.report_test_start(test)
286
test.number = self.count
201
# In a short description, the important words are in
202
# the beginning, but in an id, the important words are
204
SHOW_DESCRIPTIONS = False
206
if not self.showAll and self.dots and self.pb is not None:
209
final_width = osutils.terminal_width()
210
final_width = final_width - 15 - 8
212
if SHOW_DESCRIPTIONS:
213
what = test.shortDescription()
215
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
218
if what.startswith('bzrlib.tests.'):
220
what = self._ellipsise_unimportant_words(what, final_width)
222
self.stream.write(what)
223
elif self.dots and self.pb is not None:
224
self.pb.update(what, self.testsRun - 1, None)
287
226
self._recordTestStartTime()
289
def startTests(self):
291
if getattr(sys, 'frozen', None) is None:
292
bzr_path = osutils.realpath(sys.argv[0])
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
228
def _recordTestStartTime(self):
309
229
"""Record that a test has started."""
310
230
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
232
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.
233
if isinstance(err[1], TestSkipped):
234
return self.addSkipped(test, err)
326
235
unittest.TestResult.addError(self, test, err)
327
self.error_count += 1
328
self.report_error(test, err)
236
self.extractBenchmarkTime(test)
238
self.stream.writeln("ERROR %s" % self._testTimeString())
239
elif self.dots and self.pb is None:
240
self.stream.write('E')
242
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
243
self.pb.note(self._ellipsise_unimportant_words(
244
test.id() + ': ERROR',
245
osutils.terminal_width()))
329
247
if self.stop_early:
331
self._cleanupLogFile(test)
333
250
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
251
unittest.TestResult.addFailure(self, test, err)
341
self.failure_count += 1
342
self.report_failure(test, err)
252
self.extractBenchmarkTime(test)
254
self.stream.writeln(" FAIL %s" % self._testTimeString())
255
elif self.dots and self.pb is None:
256
self.stream.write('F')
258
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
259
self.pb.note(self._ellipsise_unimportant_words(
260
test.id() + ': FAIL',
261
osutils.terminal_width()))
343
263
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()
266
def addSuccess(self, test):
267
self.extractBenchmarkTime(test)
352
268
if self._bench_history is not None:
353
benchmark_time = self._extractBenchmarkTime(test, details)
354
if benchmark_time is not None:
269
if self._benchmarkTime is not None:
355
270
self._bench_history.write("%s %s\n" % (
356
self._formatTime(benchmark_time),
271
self._formatTime(self._benchmarkTime),
358
self.report_success(test)
359
self._cleanupLogFile(test)
274
self.stream.writeln(' OK %s' % self._testTimeString())
275
for bench_called, stats in getattr(test, '_benchcalls', []):
276
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
277
stats.pprint(file=self.stream)
278
elif self.dots and self.pb is None:
279
self.stream.write('~')
281
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
360
283
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))
285
def addSkipped(self, test, skip_excinfo):
286
self.extractBenchmarkTime(test)
288
print >>self.stream, ' SKIP %s' % self._testTimeString()
289
print >>self.stream, ' %s' % skip_excinfo[1]
290
elif self.dots and self.pb is None:
291
self.stream.write('S')
293
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
295
# seems best to treat this as success from point-of-view of unittest
296
# -- it actually does nothing so it barely matters :)
299
except KeyboardInterrupt:
302
self.addError(test, test.__exc_info())
304
unittest.TestResult.addSuccess(self, test)
306
def printErrorList(self, flavour, errors):
307
for test, err in errors:
308
self.stream.writeln(self.separator1)
309
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
310
if getattr(test, '_get_log', None) is not None:
312
print >>self.stream, \
313
('vvvv[log from %s]' % test.id()).ljust(78,'-')
314
print >>self.stream, test._get_log()
315
print >>self.stream, \
316
('^^^^[log from %s]' % test.id()).ljust(78,'-')
317
self.stream.writeln(self.separator2)
318
self.stream.writeln("%s" % err)
591
321
class TextTestRunner(object):
784
463
retrieved by _get_log(). We use a real OS file, not an in-memory object,
785
464
so that it can also capture file IO. When the test completes this file
786
465
is read into memory and removed from disk.
788
467
There are also convenience functions to invoke bzr's command-line
789
468
routine, and to build and check bzr trees.
791
470
In addition to the usual method of overriding tearDown(), this class also
792
471
allows subclasses to register functions into the _cleanups list, which is
793
472
run in order as the object is torn down. It's less likely this will be
794
473
accidentally overlooked.
797
_active_threads = None
798
_leaking_threads_tests = 0
799
_first_thread_leaker_id = None
800
476
_log_file_name = None
801
478
# record lsprof data when performing benchmark calls.
802
479
_gather_lsprof_in_benchmarks = False
804
481
def __init__(self, methodName='testMethod'):
805
482
super(TestCase, self).__init__(methodName)
806
483
self._cleanups = []
807
self._directory_isolation = True
808
self.exception_handlers.insert(0,
809
(UnavailableFeature, self._do_unsupported_or_skip))
810
self.exception_handlers.insert(0,
811
(TestNotApplicable, self._do_not_applicable))
814
super(TestCase, self).setUp()
815
for feature in getattr(self, '_test_needs_features', []):
816
self.requireFeature(feature)
817
self._log_contents = None
818
self.addDetail("log", content.Content(content.ContentType("text",
819
"plain", {"charset": "utf8"}),
820
lambda:[self._get_log(keep_log_file=True)]))
486
unittest.TestCase.setUp(self)
821
487
self._cleanEnvironment()
488
bzrlib.trace.disable_default_logging()
823
489
self._startLogFile()
824
490
self._benchcalls = []
825
491
self._benchtime = None
827
self._track_transports()
829
self._clear_debug_flags()
830
TestCase._active_threads = threading.activeCount()
831
self.addCleanup(self._check_leaked_threads)
836
pdb.Pdb().set_trace(sys._getframe().f_back)
838
def _check_leaked_threads(self):
839
active = threading.activeCount()
840
leaked_threads = active - TestCase._active_threads
841
TestCase._active_threads = active
842
# If some tests make the number of threads *decrease*, we'll consider
843
# that they are just observing old threads dieing, not agressively kill
844
# random threads. So we don't report these tests as leaking. The risk
845
# is that we have false positives that way (the test see 2 threads
846
# going away but leak one) but it seems less likely than the actual
847
# false positives (the test see threads going away and does not leak).
848
if leaked_threads > 0:
849
TestCase._leaking_threads_tests += 1
850
if TestCase._first_thread_leaker_id is None:
851
TestCase._first_thread_leaker_id = self.id()
853
def _clear_debug_flags(self):
854
"""Prevent externally set debug flags affecting tests.
856
Tests that want to use debug flags can just set them in the
857
debug_flags set during setup/teardown.
859
# Start with a copy of the current debug flags we can safely modify.
860
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
861
if 'allow_debug' not in selftest_debug_flags:
862
debug.debug_flags.clear()
863
if 'disable_lock_checks' not in selftest_debug_flags:
864
debug.debug_flags.add('strict_locks')
866
def _clear_hooks(self):
867
# prevent hooks affecting tests
868
self._preserved_hooks = {}
869
for key, factory in hooks.known_hooks.items():
870
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
871
current_hooks = hooks.known_hooks_key_to_object(key)
872
self._preserved_hooks[parent] = (name, current_hooks)
873
self.addCleanup(self._restoreHooks)
874
for key, factory in hooks.known_hooks.items():
875
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
876
setattr(parent, name, factory())
877
# this hook should always be installed
878
request._install_hook()
880
def disable_directory_isolation(self):
881
"""Turn off directory isolation checks."""
882
self._directory_isolation = False
884
def enable_directory_isolation(self):
885
"""Enable directory isolation checks."""
886
self._directory_isolation = True
888
def _silenceUI(self):
889
"""Turn off UI for duration of test"""
890
# by default the UI is off; tests can turn it on if they want it.
891
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
893
def _check_locks(self):
894
"""Check that all lock take/release actions have been paired."""
895
# We always check for mismatched locks. If a mismatch is found, we
896
# fail unless -Edisable_lock_checks is supplied to selftest, in which
897
# case we just print a warning.
899
acquired_locks = [lock for action, lock in self._lock_actions
900
if action == 'acquired']
901
released_locks = [lock for action, lock in self._lock_actions
902
if action == 'released']
903
broken_locks = [lock for action, lock in self._lock_actions
904
if action == 'broken']
905
# trivially, given the tests for lock acquistion and release, if we
906
# have as many in each list, it should be ok. Some lock tests also
907
# break some locks on purpose and should be taken into account by
908
# considering that breaking a lock is just a dirty way of releasing it.
909
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
910
message = ('Different number of acquired and '
911
'released or broken locks. (%s, %s + %s)' %
912
(acquired_locks, released_locks, broken_locks))
913
if not self._lock_check_thorough:
914
# Rather than fail, just warn
915
print "Broken test %s: %s" % (self, message)
919
def _track_locks(self):
920
"""Track lock activity during tests."""
921
self._lock_actions = []
922
if 'disable_lock_checks' in selftest_debug_flags:
923
self._lock_check_thorough = False
925
self._lock_check_thorough = True
927
self.addCleanup(self._check_locks)
928
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
929
self._lock_acquired, None)
930
_mod_lock.Lock.hooks.install_named_hook('lock_released',
931
self._lock_released, None)
932
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
933
self._lock_broken, None)
935
def _lock_acquired(self, result):
936
self._lock_actions.append(('acquired', result))
938
def _lock_released(self, result):
939
self._lock_actions.append(('released', result))
941
def _lock_broken(self, result):
942
self._lock_actions.append(('broken', result))
944
def permit_dir(self, name):
945
"""Permit a directory to be used by this test. See permit_url."""
946
name_transport = get_transport(name)
947
self.permit_url(name)
948
self.permit_url(name_transport.base)
950
def permit_url(self, url):
951
"""Declare that url is an ok url to use in this test.
953
Do this for memory transports, temporary test directory etc.
955
Do not do this for the current working directory, /tmp, or any other
956
preexisting non isolated url.
958
if not url.endswith('/'):
960
self._bzr_selftest_roots.append(url)
962
def permit_source_tree_branch_repo(self):
963
"""Permit the source tree bzr is running from to be opened.
965
Some code such as bzrlib.version attempts to read from the bzr branch
966
that bzr is executing from (if any). This method permits that directory
967
to be used in the test suite.
969
path = self.get_source_path()
970
self.record_directory_isolation()
973
workingtree.WorkingTree.open(path)
974
except (errors.NotBranchError, errors.NoWorkingTree):
977
self.enable_directory_isolation()
979
def _preopen_isolate_transport(self, transport):
980
"""Check that all transport openings are done in the test work area."""
981
while isinstance(transport, pathfilter.PathFilteringTransport):
982
# Unwrap pathfiltered transports
983
transport = transport.server.backing_transport.clone(
984
transport._filter('.'))
986
# ReadonlySmartTCPServer_for_testing decorates the backing transport
987
# urls it is given by prepending readonly+. This is appropriate as the
988
# client shouldn't know that the server is readonly (or not readonly).
989
# We could register all servers twice, with readonly+ prepending, but
990
# that makes for a long list; this is about the same but easier to
992
if url.startswith('readonly+'):
993
url = url[len('readonly+'):]
994
self._preopen_isolate_url(url)
996
def _preopen_isolate_url(self, url):
997
if not self._directory_isolation:
999
if self._directory_isolation == 'record':
1000
self._bzr_selftest_roots.append(url)
1002
# This prevents all transports, including e.g. sftp ones backed on disk
1003
# from working unless they are explicitly granted permission. We then
1004
# depend on the code that sets up test transports to check that they are
1005
# appropriately isolated and enable their use by calling
1006
# self.permit_transport()
1007
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1008
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1009
% (url, self._bzr_selftest_roots))
1011
def record_directory_isolation(self):
1012
"""Gather accessed directories to permit later access.
1014
This is used for tests that access the branch bzr is running from.
1016
self._directory_isolation = "record"
1018
def start_server(self, transport_server, backing_server=None):
1019
"""Start transport_server for this test.
1021
This starts the server, registers a cleanup for it and permits the
1022
server's urls to be used.
1024
if backing_server is None:
1025
transport_server.start_server()
1027
transport_server.start_server(backing_server)
1028
self.addCleanup(transport_server.stop_server)
1029
# Obtain a real transport because if the server supplies a password, it
1030
# will be hidden from the base on the client side.
1031
t = get_transport(transport_server.get_url())
1032
# Some transport servers effectively chroot the backing transport;
1033
# others like SFTPServer don't - users of the transport can walk up the
1034
# transport to read the entire backing transport. This wouldn't matter
1035
# except that the workdir tests are given - and that they expect the
1036
# server's url to point at - is one directory under the safety net. So
1037
# Branch operations into the transport will attempt to walk up one
1038
# directory. Chrooting all servers would avoid this but also mean that
1039
# we wouldn't be testing directly against non-root urls. Alternatively
1040
# getting the test framework to start the server with a backing server
1041
# at the actual safety net directory would work too, but this then
1042
# means that the self.get_url/self.get_transport methods would need
1043
# to transform all their results. On balance its cleaner to handle it
1044
# here, and permit a higher url when we have one of these transports.
1045
if t.base.endswith('/work/'):
1046
# we have safety net/test root/work
1047
t = t.clone('../..')
1048
elif isinstance(transport_server,
1049
test_server.SmartTCPServer_for_testing):
1050
# The smart server adds a path similar to work, which is traversed
1051
# up from by the client. But the server is chrooted - the actual
1052
# backing transport is not escaped from, and VFS requests to the
1053
# root will error (because they try to escape the chroot).
1055
while t2.base != t.base:
1058
self.permit_url(t.base)
1060
def _track_transports(self):
1061
"""Install checks for transport usage."""
1062
# TestCase has no safe place it can write to.
1063
self._bzr_selftest_roots = []
1064
# Currently the easiest way to be sure that nothing is going on is to
1065
# hook into bzr dir opening. This leaves a small window of error for
1066
# transport tests, but they are well known, and we can improve on this
1068
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1069
self._preopen_isolate_transport, "Check bzr directories are safe.")
1071
493
def _ndiff_strings(self, a, b):
1072
494
"""Return ndiff between two strings containing lines.
1074
496
A trailing newline is added if missing to make the strings
1075
497
print properly."""
1076
498
if b and b[-1] != '\n':
1838
789
This sends the stdout/stderr results into the test's log,
1839
790
where it may be useful for debugging. See also run_captured.
1841
:keyword stdin: A string to be used as stdin for the command.
1842
:keyword retcode: The status code the command should return;
1844
:keyword working_dir: The directory to run the command in
1845
:keyword error_regexes: A list of expected error messages. If
1846
specified they must be seen in the error output of the command.
792
:param stdin: A string to be used as stdin for the command.
1848
retcode, out, err = self._run_bzr_autosplit(
1853
working_dir=working_dir,
1855
self.assertIsInstance(error_regexes, (list, tuple))
1856
for regex in error_regexes:
1857
self.assertContainsRe(err, regex)
794
retcode = kwargs.pop('retcode', 0)
795
encoding = kwargs.pop('encoding', None)
796
stdin = kwargs.pop('stdin', None)
797
return self.run_bzr_captured(args, retcode=retcode, encoding=encoding, stdin=stdin)
799
def run_bzr_decode(self, *args, **kwargs):
800
if 'encoding' in kwargs:
801
encoding = kwargs['encoding']
803
encoding = bzrlib.user_encoding
804
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1860
806
def run_bzr_error(self, error_regexes, *args, **kwargs):
1861
807
"""Run bzr, and check that stderr contains the supplied regexes
1863
:param error_regexes: Sequence of regular expressions which
809
:param error_regexes: Sequence of regular expressions which
1864
810
must each be found in the error output. The relative ordering
1865
811
is not enforced.
1866
812
:param args: command-line arguments for bzr
1867
813
:param kwargs: Keyword arguments which are interpreted by run_bzr
1868
814
This function changes the default value of retcode to be 3,
1869
815
since in most cases this is run when you expect bzr to fail.
1871
:return: (out, err) The actual output of running the command (in case
1872
you want to do more inspection)
816
:return: (out, err) The actual output of running the command (in case you
817
want to do more inspection)
1876
820
# Make sure that commit is failing because there is nothing to do
1877
821
self.run_bzr_error(['no changes to commit'],
1878
['commit', '-m', 'my commit comment'])
822
'commit', '-m', 'my commit comment')
1879
823
# Make sure --strict is handling an unknown file, rather than
1880
824
# giving us the 'nothing to do' error
1881
825
self.build_tree(['unknown'])
1882
826
self.run_bzr_error(['Commit refused because there are unknown files'],
1883
['commit', --strict', '-m', 'my commit comment'])
827
'commit', '--strict', '-m', 'my commit comment')
1885
829
kwargs.setdefault('retcode', 3)
1886
kwargs['error_regexes'] = error_regexes
1887
830
out, err = self.run_bzr(*args, **kwargs)
831
for regex in error_regexes:
832
self.assertContainsRe(err, regex)
1890
835
def run_bzr_subprocess(self, *args, **kwargs):
1891
836
"""Run bzr in a subprocess for testing.
1893
This starts a new Python interpreter and runs bzr in there.
838
This starts a new Python interpreter and runs bzr in there.
1894
839
This should only be used for tests that have a justifiable need for
1895
840
this isolation: e.g. they are testing startup time, or signal
1896
handling, or early startup code, etc. Subprocess code can't be
841
handling, or early startup code, etc. Subprocess code can't be
1897
842
profiled or debugged so easily.
1899
:keyword retcode: The status code that is expected. Defaults to 0. If
844
:param retcode: The status code that is expected. Defaults to 0. If
1900
845
None is supplied, the status code is not checked.
1901
:keyword env_changes: A dictionary which lists changes to environment
846
:param env_changes: A dictionary which lists changes to environment
1902
847
variables. A value of None will unset the env variable.
1903
848
The values must be strings. The change will only occur in the
1904
849
child, so you don't need to fix the environment after running.
1905
:keyword universal_newlines: Convert CRLF => LF
1906
:keyword allow_plugins: By default the subprocess is run with
1907
--no-plugins to ensure test reproducibility. Also, it is possible
1908
for system-wide plugins to create unexpected output on stderr,
1909
which can cause unnecessary test failures.
1911
851
env_changes = kwargs.get('env_changes', {})
1912
working_dir = kwargs.get('working_dir', None)
1913
allow_plugins = kwargs.get('allow_plugins', False)
1915
if isinstance(args[0], list):
1917
elif isinstance(args[0], basestring):
1918
args = list(shlex.split(args[0]))
1920
raise ValueError("passing varargs to run_bzr_subprocess")
1921
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1922
working_dir=working_dir,
1923
allow_plugins=allow_plugins)
1924
# We distinguish between retcode=None and retcode not passed.
1925
supplied_retcode = kwargs.get('retcode', 0)
1926
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1927
universal_newlines=kwargs.get('universal_newlines', False),
1930
def start_bzr_subprocess(self, process_args, env_changes=None,
1931
skip_if_plan_to_signal=False,
1933
allow_plugins=False):
1934
"""Start bzr in a subprocess for testing.
1936
This starts a new Python interpreter and runs bzr in there.
1937
This should only be used for tests that have a justifiable need for
1938
this isolation: e.g. they are testing startup time, or signal
1939
handling, or early startup code, etc. Subprocess code can't be
1940
profiled or debugged so easily.
1942
:param process_args: a list of arguments to pass to the bzr executable,
1943
for example ``['--version']``.
1944
:param env_changes: A dictionary which lists changes to environment
1945
variables. A value of None will unset the env variable.
1946
The values must be strings. The change will only occur in the
1947
child, so you don't need to fix the environment after running.
1948
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1950
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1952
:returns: Popen object for the started process.
1954
if skip_if_plan_to_signal:
1955
if not getattr(os, 'kill', None):
1956
raise TestSkipped("os.kill not available.")
1958
if env_changes is None:
1962
852
def cleanup_environment():
1963
853
for env_var, value in env_changes.iteritems():
1964
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1966
def restore_environment():
1967
for env_var, value in old_env.iteritems():
1968
osutils.set_or_unset_env(env_var, value)
1970
bzr_path = self.get_bzr_path()
1973
if working_dir is not None:
1974
cwd = osutils.getcwd()
1975
os.chdir(working_dir)
1978
# win32 subprocess doesn't support preexec_fn
1979
# so we will avoid using it on all platforms, just to
1980
# make sure the code path is used, and we don't break on win32
1981
cleanup_environment()
1982
command = [sys.executable]
1983
# frozen executables don't need the path to bzr
1984
if getattr(sys, "frozen", None) is None:
1985
command.append(bzr_path)
1986
if not allow_plugins:
1987
command.append('--no-plugins')
1988
command.extend(process_args)
1989
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1991
restore_environment()
1997
def _popen(self, *args, **kwargs):
1998
"""Place a call to Popen.
2000
Allows tests to override this method to intercept the calls made to
2001
Popen for introspection.
2003
return Popen(*args, **kwargs)
2005
def get_source_path(self):
2006
"""Return the path of the directory containing bzrlib."""
2007
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2009
def get_bzr_path(self):
2010
"""Return the path of the 'bzr' executable for this test suite."""
2011
bzr_path = self.get_source_path()+'/bzr'
2012
if not os.path.isfile(bzr_path):
2013
# We are probably installed. Assume sys.argv is the right file
2014
bzr_path = sys.argv[0]
2017
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2018
universal_newlines=False, process_args=None):
2019
"""Finish the execution of process.
2021
:param process: the Popen object returned from start_bzr_subprocess.
2022
:param retcode: The status code that is expected. Defaults to 0. If
2023
None is supplied, the status code is not checked.
2024
:param send_signal: an optional signal to send to the process.
2025
:param universal_newlines: Convert CRLF => LF
2026
:returns: (stdout, stderr)
2028
if send_signal is not None:
2029
os.kill(process.pid, send_signal)
2030
out, err = process.communicate()
2032
if universal_newlines:
2033
out = out.replace('\r\n', '\n')
2034
err = err.replace('\r\n', '\n')
2036
if retcode is not None and retcode != process.returncode:
2037
if process_args is None:
2038
process_args = "(unknown args)"
2039
mutter('Output of bzr %s:\n%s', process_args, out)
2040
mutter('Error for bzr %s:\n%s', process_args, err)
2041
self.fail('Command bzr %s failed with retcode %s != %s'
2042
% (process_args, retcode, process.returncode))
855
del os.environ[env_var]
857
os.environ[env_var] = value
859
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
861
process = Popen([sys.executable, bzr_path]+args,
862
stdout=PIPE, stderr=PIPE,
863
preexec_fn=cleanup_environment)
864
out = process.stdout.read()
865
err = process.stderr.read()
866
retcode = process.wait()
867
supplied_retcode = kwargs.get('retcode', 0)
868
if supplied_retcode is not None:
869
assert supplied_retcode == retcode
2043
870
return [out, err]
2045
872
def check_inventory_shape(self, inv, shape):
2094
921
sys.stderr = real_stderr
2095
922
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):
924
def merge(self, branch_from, wt_to):
925
"""A helper for tests to do a ui-less merge.
927
This should move to the main library when someone has time to integrate
930
# minimal ui-less merge.
931
wt_to.branch.fetch(branch_from)
932
base_rev = common_ancestor(branch_from.last_revision(),
933
wt_to.branch.last_revision(),
934
wt_to.branch.repository)
935
merge_inner(wt_to.branch, branch_from.basis_tree(),
936
wt_to.branch.repository.revision_tree(base_rev),
938
wt_to.add_parent_tree_id(branch_from.last_revision())
941
BzrTestBase = TestCase
944
class TestCaseInTempDir(TestCase):
2462
945
"""Derived class that runs a test within a temporary directory.
2464
947
This is useful for tests that need to create a branch, etc.
2721
1245
for readonly urls.
2723
1247
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2724
be used without needed to redo it when a different
1248
be used without needed to redo it when a different
2725
1249
subclass is in use ?
2728
1252
def setUp(self):
2729
1253
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)
1254
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1255
self.transport_readonly_server = bzrlib.transport.http.HttpServer
2817
1258
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
1259
result = TestUtil.TestSuite()
1260
filter_re = re.compile(pattern)
2901
1261
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))
1262
if filter_re.search(test.id()):
1263
result.addTest(test)
2924
1267
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.
1268
stop_on_failure=False, keep_output=False,
1269
transport=None, lsprof_timed=None, bench_history=None):
1270
TestCaseInTempDir._TEST_NAME = name
2944
1271
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2949
if runner_class is None:
2950
runner_class = TextTestRunner
2953
runner = runner_class(stream=stream,
1277
pb = progress.ProgressBar()
1278
runner = TextTestRunner(stream=sys.stdout,
2954
1279
descriptions=0,
2955
1280
verbosity=verbosity,
2956
bench_history=bench_history,
2958
result_decorators=result_decorators,
1281
keep_output=keep_output,
1283
bench_history=bench_history)
2960
1284
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()))
1286
suite = filter_suite_by_re(suite, pattern)
2987
1287
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()
1288
return result.wasSuccessful()
3400
1291
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3401
1293
transport=None,
3402
1294
test_suite_factory=None,
3403
1295
lsprof_timed=None,
3405
matching_tests_first=None,
3408
exclude_pattern=None,
3414
suite_decorators=None,
1296
bench_history=None):
3418
1297
"""Run the whole test suite under the enhanced runner"""
3419
1298
# XXX: Very ugly way to do this...
3420
1299
# Disable warning about old formats because we don't want it to disturb
3427
1306
transport = default_transport
3428
1307
old_transport = default_transport
3429
1308
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)
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
1310
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)
1311
suite = test_suite()
3447
1313
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
1314
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3455
stop_on_failure=stop_on_failure,
1315
stop_on_failure=stop_on_failure, keep_output=keep_output,
3456
1316
transport=transport,
3457
1317
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,
1318
bench_history=bench_history)
3470
1320
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_memorytree',
3738
'bzrlib.tests.test_merge',
3739
'bzrlib.tests.test_merge3',
3740
'bzrlib.tests.test_merge_core',
3741
'bzrlib.tests.test_merge_directive',
3742
'bzrlib.tests.test_missing',
3743
'bzrlib.tests.test_msgeditor',
3744
'bzrlib.tests.test_multiparent',
3745
'bzrlib.tests.test_mutabletree',
3746
'bzrlib.tests.test_nonascii',
3747
'bzrlib.tests.test_options',
3748
'bzrlib.tests.test_osutils',
3749
'bzrlib.tests.test_osutils_encodings',
3750
'bzrlib.tests.test_pack',
3751
'bzrlib.tests.test_patch',
3752
'bzrlib.tests.test_patches',
3753
'bzrlib.tests.test_permissions',
3754
'bzrlib.tests.test_plugins',
3755
'bzrlib.tests.test_progress',
3756
'bzrlib.tests.test_read_bundle',
3757
'bzrlib.tests.test_reconcile',
3758
'bzrlib.tests.test_reconfigure',
3759
'bzrlib.tests.test_registry',
3760
'bzrlib.tests.test_remote',
3761
'bzrlib.tests.test_rename_map',
3762
'bzrlib.tests.test_repository',
3763
'bzrlib.tests.test_revert',
3764
'bzrlib.tests.test_revision',
3765
'bzrlib.tests.test_revisionspec',
3766
'bzrlib.tests.test_revisiontree',
3767
'bzrlib.tests.test_rio',
3768
'bzrlib.tests.test_rules',
3769
'bzrlib.tests.test_sampler',
3770
'bzrlib.tests.test_script',
3771
'bzrlib.tests.test_selftest',
3772
'bzrlib.tests.test_serializer',
3773
'bzrlib.tests.test_setup',
3774
'bzrlib.tests.test_sftp_transport',
3775
'bzrlib.tests.test_shelf',
3776
'bzrlib.tests.test_shelf_ui',
3777
'bzrlib.tests.test_smart',
3778
'bzrlib.tests.test_smart_add',
3779
'bzrlib.tests.test_smart_request',
3780
'bzrlib.tests.test_smart_transport',
3781
'bzrlib.tests.test_smtp_connection',
3782
'bzrlib.tests.test_source',
3783
'bzrlib.tests.test_ssh_transport',
3784
'bzrlib.tests.test_status',
3785
'bzrlib.tests.test_store',
3786
'bzrlib.tests.test_strace',
3787
'bzrlib.tests.test_subsume',
3788
'bzrlib.tests.test_switch',
3789
'bzrlib.tests.test_symbol_versioning',
3790
'bzrlib.tests.test_tag',
3791
'bzrlib.tests.test_testament',
3792
'bzrlib.tests.test_textfile',
3793
'bzrlib.tests.test_textmerge',
3794
'bzrlib.tests.test_timestamp',
3795
'bzrlib.tests.test_trace',
3796
'bzrlib.tests.test_transactions',
3797
'bzrlib.tests.test_transform',
3798
'bzrlib.tests.test_transport',
3799
'bzrlib.tests.test_transport_log',
3800
'bzrlib.tests.test_tree',
3801
'bzrlib.tests.test_treebuilder',
3802
'bzrlib.tests.test_tsort',
3803
'bzrlib.tests.test_tuned_gzip',
3804
'bzrlib.tests.test_ui',
3805
'bzrlib.tests.test_uncommit',
3806
'bzrlib.tests.test_upgrade',
3807
'bzrlib.tests.test_upgrade_stacked',
3808
'bzrlib.tests.test_urlutils',
3809
'bzrlib.tests.test_version',
3810
'bzrlib.tests.test_version_info',
3811
'bzrlib.tests.test_weave',
3812
'bzrlib.tests.test_whitebox',
3813
'bzrlib.tests.test_win32utils',
3814
'bzrlib.tests.test_workingtree',
3815
'bzrlib.tests.test_workingtree_4',
3816
'bzrlib.tests.test_wsgi',
3817
'bzrlib.tests.test_xml',
3821
def _test_suite_modules_to_doctest():
3822
"""Return the list of modules to doctest."""
3824
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3828
'bzrlib.branchbuilder',
3829
'bzrlib.decorators',
3832
'bzrlib.iterablefile',
3836
'bzrlib.symbol_versioning',
3839
'bzrlib.version_info_formats.format_custom',
3843
def test_suite(keep_only=None, starting_with=None):
3844
1324
"""Build and return TestSuite for the whole of bzrlib.
3846
:param keep_only: A list of test ids limiting the suite returned.
3848
:param starting_with: An id limiting the suite returned to the tests
3851
1326
This function can be replaced if you need to change the default test
3852
1327
suite on a global basis, but it is not encouraged.
1330
'bzrlib.tests.test_ancestry',
1331
'bzrlib.tests.test_api',
1332
'bzrlib.tests.test_atomicfile',
1333
'bzrlib.tests.test_bad_files',
1334
'bzrlib.tests.test_branch',
1335
'bzrlib.tests.test_bundle',
1336
'bzrlib.tests.test_bzrdir',
1337
'bzrlib.tests.test_cache_utf8',
1338
'bzrlib.tests.test_command',
1339
'bzrlib.tests.test_commit',
1340
'bzrlib.tests.test_commit_merge',
1341
'bzrlib.tests.test_config',
1342
'bzrlib.tests.test_conflicts',
1343
'bzrlib.tests.test_decorators',
1344
'bzrlib.tests.test_diff',
1345
'bzrlib.tests.test_doc_generate',
1346
'bzrlib.tests.test_errors',
1347
'bzrlib.tests.test_escaped_store',
1348
'bzrlib.tests.test_fetch',
1349
'bzrlib.tests.test_gpg',
1350
'bzrlib.tests.test_graph',
1351
'bzrlib.tests.test_hashcache',
1352
'bzrlib.tests.test_http',
1353
'bzrlib.tests.test_http_response',
1354
'bzrlib.tests.test_identitymap',
1355
'bzrlib.tests.test_ignores',
1356
'bzrlib.tests.test_inv',
1357
'bzrlib.tests.test_knit',
1358
'bzrlib.tests.test_lockdir',
1359
'bzrlib.tests.test_lockable_files',
1360
'bzrlib.tests.test_log',
1361
'bzrlib.tests.test_merge',
1362
'bzrlib.tests.test_merge3',
1363
'bzrlib.tests.test_merge_core',
1364
'bzrlib.tests.test_missing',
1365
'bzrlib.tests.test_msgeditor',
1366
'bzrlib.tests.test_nonascii',
1367
'bzrlib.tests.test_options',
1368
'bzrlib.tests.test_osutils',
1369
'bzrlib.tests.test_patch',
1370
'bzrlib.tests.test_patches',
1371
'bzrlib.tests.test_permissions',
1372
'bzrlib.tests.test_plugins',
1373
'bzrlib.tests.test_progress',
1374
'bzrlib.tests.test_reconcile',
1375
'bzrlib.tests.test_repository',
1376
'bzrlib.tests.test_revert',
1377
'bzrlib.tests.test_revision',
1378
'bzrlib.tests.test_revisionnamespaces',
1379
'bzrlib.tests.test_revisiontree',
1380
'bzrlib.tests.test_rio',
1381
'bzrlib.tests.test_sampler',
1382
'bzrlib.tests.test_selftest',
1383
'bzrlib.tests.test_setup',
1384
'bzrlib.tests.test_sftp_transport',
1385
'bzrlib.tests.test_ftp_transport',
1386
'bzrlib.tests.test_smart_add',
1387
'bzrlib.tests.test_source',
1388
'bzrlib.tests.test_status',
1389
'bzrlib.tests.test_store',
1390
'bzrlib.tests.test_symbol_versioning',
1391
'bzrlib.tests.test_testament',
1392
'bzrlib.tests.test_textfile',
1393
'bzrlib.tests.test_textmerge',
1394
'bzrlib.tests.test_trace',
1395
'bzrlib.tests.test_transactions',
1396
'bzrlib.tests.test_transform',
1397
'bzrlib.tests.test_transport',
1398
'bzrlib.tests.test_tree',
1399
'bzrlib.tests.test_tsort',
1400
'bzrlib.tests.test_tuned_gzip',
1401
'bzrlib.tests.test_ui',
1402
'bzrlib.tests.test_upgrade',
1403
'bzrlib.tests.test_urlutils',
1404
'bzrlib.tests.test_versionedfile',
1405
'bzrlib.tests.test_version',
1406
'bzrlib.tests.test_weave',
1407
'bzrlib.tests.test_whitebox',
1408
'bzrlib.tests.test_workingtree',
1409
'bzrlib.tests.test_xml',
1411
test_transport_implementations = [
1412
'bzrlib.tests.test_transport_implementations',
1413
'bzrlib.tests.test_read_bundle',
1415
suite = TestUtil.TestSuite()
3855
1416
loader = TestUtil.TestLoader()
3857
if keep_only is not None:
3858
id_filter = TestIdList(keep_only)
3860
# We take precedence over keep_only because *at loading time* using
3861
# both options means we will load less tests for the same final result.
3862
def interesting_module(name):
3863
for start in starting_with:
3865
# Either the module name starts with the specified string
3866
name.startswith(start)
3867
# or it may contain tests starting with the specified string
3868
or start.startswith(name)
3872
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3874
elif keep_only is not None:
3875
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3876
def interesting_module(name):
3877
return id_filter.refers_to(name)
3880
loader = TestUtil.TestLoader()
3881
def interesting_module(name):
3882
# No filtering, all modules are interesting
3885
suite = loader.suiteClass()
3887
# modules building their suite with loadTestsFromModuleNames
3888
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3890
for mod in _test_suite_modules_to_doctest():
3891
if not interesting_module(mod):
3892
# No tests to keep here, move along
3895
# note that this really does mean "report only" -- doctest
3896
# still runs the rest of the examples
3897
doc_suite = doctest.DocTestSuite(mod,
3898
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3899
except ValueError, e:
3900
print '**failed to get doctest for: %s\n%s' % (mod, e)
3902
if len(doc_suite._tests) == 0:
3903
raise errors.BzrError("no doctests found in %s" % (mod,))
3904
suite.addTest(doc_suite)
3906
default_encoding = sys.getdefaultencoding()
3907
for name, plugin in bzrlib.plugin.plugins().items():
3908
if not interesting_module(plugin.module.__name__):
3910
plugin_suite = plugin.test_suite()
3911
# We used to catch ImportError here and turn it into just a warning,
3912
# but really if you don't have --no-plugins this should be a failure.
3913
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3914
if plugin_suite is None:
3915
plugin_suite = plugin.load_plugin_tests(loader)
3916
if plugin_suite is not None:
3917
suite.addTest(plugin_suite)
3918
if default_encoding != sys.getdefaultencoding():
3919
bzrlib.trace.warning(
3920
'Plugin "%s" tried to reset default encoding to: %s', name,
3921
sys.getdefaultencoding())
3923
sys.setdefaultencoding(default_encoding)
3925
if keep_only is not None:
3926
# Now that the referred modules have loaded their tests, keep only the
3928
suite = filter_suite_by_id_list(suite, id_filter)
3929
# Do some sanity checks on the id_list filtering
3930
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3932
# The tester has used both keep_only and starting_with, so he is
3933
# already aware that some tests are excluded from the list, there
3934
# is no need to tell him which.
3937
# Some tests mentioned in the list are not in the test suite. The
3938
# list may be out of date, report to the tester.
3939
for id in not_found:
3940
bzrlib.trace.warning('"%s" not found in the test suite', id)
3941
for id in duplicates:
3942
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
1417
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1418
from bzrlib.transport import TransportTestProviderAdapter
1419
adapter = TransportTestProviderAdapter()
1420
adapt_modules(test_transport_implementations, adapter, loader, suite)
1421
for package in packages_to_test():
1422
suite.addTest(package.test_suite())
1423
for m in MODULES_TO_TEST:
1424
suite.addTest(loader.loadTestsFromModule(m))
1425
for m in MODULES_TO_DOCTEST:
1426
suite.addTest(doctest.DocTestSuite(m))
1427
for name, plugin in bzrlib.plugin.all_plugins().items():
1428
if getattr(plugin, 'test_suite', None) is not None:
1429
suite.addTest(plugin.test_suite())
3947
def multiply_scenarios(scenarios_left, scenarios_right):
3948
"""Multiply two sets of scenarios.
3950
:returns: the cartesian product of the two sets of scenarios, that is
3951
a scenario for every possible combination of a left scenario and a
3955
('%s,%s' % (left_name, right_name),
3956
dict(left_dict.items() + right_dict.items()))
3957
for left_name, left_dict in scenarios_left
3958
for right_name, right_dict in scenarios_right]
3961
def multiply_tests(tests, scenarios, result):
3962
"""Multiply tests_list by scenarios into result.
3964
This is the core workhorse for test parameterisation.
3966
Typically the load_tests() method for a per-implementation test suite will
3967
call multiply_tests and return the result.
3969
:param tests: The tests to parameterise.
3970
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3971
scenario_param_dict).
3972
:param result: A TestSuite to add created tests to.
3974
This returns the passed in result TestSuite with the cross product of all
3975
the tests repeated once for each scenario. Each test is adapted by adding
3976
the scenario name at the end of its id(), and updating the test object's
3977
__dict__ with the scenario_param_dict.
3979
>>> import bzrlib.tests.test_sampler
3980
>>> r = multiply_tests(
3981
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3982
... [('one', dict(param=1)),
3983
... ('two', dict(param=2))],
3985
>>> tests = list(iter_suite_tests(r))
3989
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3995
for test in iter_suite_tests(tests):
3996
apply_scenarios(test, scenarios, result)
4000
def apply_scenarios(test, scenarios, result):
4001
"""Apply the scenarios in scenarios to test and add to result.
4003
:param test: The test to apply scenarios to.
4004
:param scenarios: An iterable of scenarios to apply to test.
4006
:seealso: apply_scenario
4008
for scenario in scenarios:
4009
result.addTest(apply_scenario(test, scenario))
4013
def apply_scenario(test, scenario):
4014
"""Copy test and apply scenario to it.
4016
:param test: A test to adapt.
4017
:param scenario: A tuple describing the scenarion.
4018
The first element of the tuple is the new test id.
4019
The second element is a dict containing attributes to set on the
4021
:return: The adapted test.
4023
new_id = "%s(%s)" % (test.id(), scenario[0])
4024
new_test = clone_test(test, new_id)
4025
for name, value in scenario[1].items():
4026
setattr(new_test, name, value)
4030
def clone_test(test, new_id):
4031
"""Clone a test giving it a new id.
4033
:param test: The test to clone.
4034
:param new_id: The id to assign to it.
4035
:return: The new test.
4037
new_test = copy(test)
4038
new_test.id = lambda: new_id
4042
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4044
"""Helper for permutating tests against an extension module.
4046
This is meant to be used inside a modules 'load_tests()' function. It will
4047
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4048
against both implementations. Setting 'test.module' to the appropriate
4049
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4051
:param standard_tests: A test suite to permute
4052
:param loader: A TestLoader
4053
:param py_module_name: The python path to a python module that can always
4054
be loaded, and will be considered the 'python' implementation. (eg
4055
'bzrlib._chk_map_py')
4056
:param ext_module_name: The python path to an extension module. If the
4057
module cannot be loaded, a single test will be added, which notes that
4058
the module is not available. If it can be loaded, all standard_tests
4059
will be run against that module.
4060
:return: (suite, feature) suite is a test-suite that has all the permuted
4061
tests. feature is the Feature object that can be used to determine if
4062
the module is available.
4065
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4067
('python', {'module': py_module}),
4069
suite = loader.suiteClass()
4070
feature = ModuleAvailableFeature(ext_module_name)
4071
if feature.available():
4072
scenarios.append(('C', {'module': feature.module}))
4074
# the compiled module isn't available, so we add a failing test
4075
class FailWithoutFeature(TestCase):
4076
def test_fail(self):
4077
self.requireFeature(feature)
4078
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4079
result = multiply_tests(standard_tests, scenarios, suite)
4080
return result, feature
4083
def _rmtree_temp_dir(dirname, test_id=None):
4084
# If LANG=C we probably have created some bogus paths
4085
# which rmtree(unicode) will fail to delete
4086
# so make sure we are using rmtree(str) to delete everything
4087
# except on win32, where rmtree(str) will fail
4088
# since it doesn't have the property of byte-stream paths
4089
# (they are either ascii or mbcs)
4090
if sys.platform == 'win32':
4091
# make sure we are using the unicode win32 api
4092
dirname = unicode(dirname)
4094
dirname = dirname.encode(sys.getfilesystemencoding())
4096
osutils.rmtree(dirname)
4098
# We don't want to fail here because some useful display will be lost
4099
# otherwise. Polluting the tmp dir is bad, but not giving all the
4100
# possible info to the test runner is even worse.
4102
ui.ui_factory.clear_term()
4103
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4104
sys.stderr.write('Unable to remove testing dir %s\n%s'
4105
% (os.path.basename(dirname), e))
4108
class Feature(object):
4109
"""An operating system Feature."""
4112
self._available = None
4114
def available(self):
4115
"""Is the feature available?
4117
:return: True if the feature is available.
4119
if self._available is None:
4120
self._available = self._probe()
4121
return self._available
4124
"""Implement this method in concrete features.
4126
:return: True if the feature is available.
4128
raise NotImplementedError
4131
if getattr(self, 'feature_name', None):
4132
return self.feature_name()
4133
return self.__class__.__name__
4136
class _SymlinkFeature(Feature):
4139
return osutils.has_symlinks()
4141
def feature_name(self):
4144
SymlinkFeature = _SymlinkFeature()
4147
class _HardlinkFeature(Feature):
4150
return osutils.has_hardlinks()
4152
def feature_name(self):
4155
HardlinkFeature = _HardlinkFeature()
4158
class _OsFifoFeature(Feature):
4161
return getattr(os, 'mkfifo', None)
4163
def feature_name(self):
4164
return 'filesystem fifos'
4166
OsFifoFeature = _OsFifoFeature()
4169
class _UnicodeFilenameFeature(Feature):
4170
"""Does the filesystem support Unicode filenames?"""
4174
# Check for character combinations unlikely to be covered by any
4175
# single non-unicode encoding. We use the characters
4176
# - greek small letter alpha (U+03B1) and
4177
# - braille pattern dots-123456 (U+283F).
4178
os.stat(u'\u03b1\u283f')
4179
except UnicodeEncodeError:
4181
except (IOError, OSError):
4182
# The filesystem allows the Unicode filename but the file doesn't
4186
# The filesystem allows the Unicode filename and the file exists,
4190
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4193
class _CompatabilityThunkFeature(Feature):
4194
"""This feature is just a thunk to another feature.
4196
It issues a deprecation warning if it is accessed, to let you know that you
4197
should really use a different feature.
4200
def __init__(self, dep_version, module, name,
4201
replacement_name, replacement_module=None):
4202
super(_CompatabilityThunkFeature, self).__init__()
4203
self._module = module
4204
if replacement_module is None:
4205
replacement_module = module
4206
self._replacement_module = replacement_module
4208
self._replacement_name = replacement_name
4209
self._dep_version = dep_version
4210
self._feature = None
4213
if self._feature is None:
4214
depr_msg = self._dep_version % ('%s.%s'
4215
% (self._module, self._name))
4216
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4217
self._replacement_name)
4218
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4219
# Import the new feature and use it as a replacement for the
4221
mod = __import__(self._replacement_module, {}, {},
4222
[self._replacement_name])
4223
self._feature = getattr(mod, self._replacement_name)
4227
return self._feature._probe()
4230
class ModuleAvailableFeature(Feature):
4231
"""This is a feature than describes a module we want to be available.
4233
Declare the name of the module in __init__(), and then after probing, the
4234
module will be available as 'self.module'.
4236
:ivar module: The module if it is available, else None.
4239
def __init__(self, module_name):
4240
super(ModuleAvailableFeature, self).__init__()
4241
self.module_name = module_name
4245
self._module = __import__(self.module_name, {}, {}, [''])
4252
if self.available(): # Make sure the probe has been done
4256
def feature_name(self):
4257
return self.module_name
4260
# This is kept here for compatibility, it is recommended to use
4261
# 'bzrlib.tests.feature.paramiko' instead
4262
ParamikoFeature = _CompatabilityThunkFeature(
4263
deprecated_in((2,1,0)),
4264
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4267
def probe_unicode_in_user_encoding():
4268
"""Try to encode several unicode strings to use in unicode-aware tests.
4269
Return first successfull match.
4271
:return: (unicode value, encoded plain string value) or (None, None)
4273
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4274
for uni_val in possible_vals:
4276
str_val = uni_val.encode(osutils.get_user_encoding())
4277
except UnicodeEncodeError:
4278
# Try a different character
4281
return uni_val, str_val
4285
def probe_bad_non_ascii(encoding):
4286
"""Try to find [bad] character with code [128..255]
4287
that cannot be decoded to unicode in some encoding.
4288
Return None if all non-ascii characters is valid
4291
for i in xrange(128, 256):
4294
char.decode(encoding)
4295
except UnicodeDecodeError:
4300
class _HTTPSServerFeature(Feature):
4301
"""Some tests want an https Server, check if one is available.
4303
Right now, the only way this is available is under python2.6 which provides
4314
def feature_name(self):
4315
return 'HTTPSServer'
4318
HTTPSServerFeature = _HTTPSServerFeature()
4321
class _UnicodeFilename(Feature):
4322
"""Does the filesystem support Unicode filenames?"""
4327
except UnicodeEncodeError:
4329
except (IOError, OSError):
4330
# The filesystem allows the Unicode filename but the file doesn't
4334
# The filesystem allows the Unicode filename and the file exists,
4338
UnicodeFilename = _UnicodeFilename()
4341
class _UTF8Filesystem(Feature):
4342
"""Is the filesystem UTF-8?"""
4345
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4349
UTF8Filesystem = _UTF8Filesystem()
4352
class _BreakinFeature(Feature):
4353
"""Does this platform support the breakin feature?"""
4356
from bzrlib import breakin
4357
if breakin.determine_signal() is None:
4359
if sys.platform == 'win32':
4360
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4361
# We trigger SIGBREAK via a Console api so we need ctypes to
4362
# access the function
4369
def feature_name(self):
4370
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4373
BreakinFeature = _BreakinFeature()
4376
class _CaseInsCasePresFilenameFeature(Feature):
4377
"""Is the file-system case insensitive, but case-preserving?"""
4380
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4382
# first check truly case-preserving for created files, then check
4383
# case insensitive when opening existing files.
4384
name = osutils.normpath(name)
4385
base, rel = osutils.split(name)
4386
found_rel = osutils.canonical_relpath(base, name)
4387
return (found_rel == rel
4388
and os.path.isfile(name.upper())
4389
and os.path.isfile(name.lower()))
4394
def feature_name(self):
4395
return "case-insensitive case-preserving filesystem"
4397
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4400
class _CaseInsensitiveFilesystemFeature(Feature):
4401
"""Check if underlying filesystem is case-insensitive but *not* case
4404
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4405
# more likely to be case preserving, so this case is rare.
4408
if CaseInsCasePresFilenameFeature.available():
4411
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4412
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4413
TestCaseWithMemoryTransport.TEST_ROOT = root
4415
root = TestCaseWithMemoryTransport.TEST_ROOT
4416
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4418
name_a = osutils.pathjoin(tdir, 'a')
4419
name_A = osutils.pathjoin(tdir, 'A')
4421
result = osutils.isdir(name_A)
4422
_rmtree_temp_dir(tdir)
4425
def feature_name(self):
4426
return 'case-insensitive filesystem'
4428
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4431
class _CaseSensitiveFilesystemFeature(Feature):
4434
if CaseInsCasePresFilenameFeature.available():
4436
elif CaseInsensitiveFilesystemFeature.available():
4441
def feature_name(self):
4442
return 'case-sensitive filesystem'
4444
# new coding style is for feature instances to be lowercase
4445
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4448
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4449
SubUnitFeature = _CompatabilityThunkFeature(
4450
deprecated_in((2,1,0)),
4451
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4452
# Only define SubUnitBzrRunner if subunit is available.
4454
from subunit import TestProtocolClient
4455
from subunit.test_results import AutoTimingTestResultDecorator
4456
class SubUnitBzrRunner(TextTestRunner):
4457
def run(self, test):
4458
result = AutoTimingTestResultDecorator(
4459
TestProtocolClient(self.stream))
4465
class _PosixPermissionsFeature(Feature):
4469
# create temporary file and check if specified perms are maintained.
4472
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4473
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4476
os.chmod(name, write_perms)
4478
read_perms = os.stat(name).st_mode & 0777
4480
return (write_perms == read_perms)
4482
return (os.name == 'posix') and has_perms()
4484
def feature_name(self):
4485
return 'POSIX permissions support'
4487
posix_permissions_feature = _PosixPermissionsFeature()
1433
def adapt_modules(mods_list, adapter, loader, suite):
1434
"""Adapt the modules in mods_list using adapter and add to suite."""
1435
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1436
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
