26
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
27
# new assertFoo() methods.
30
31
from cStringIO import StringIO
38
from pprint import pformat
43
from subprocess import Popen, PIPE, STDOUT
44
67
import bzrlib.branch
45
import bzrlib.bzrdir as bzrdir
46
68
import bzrlib.commands
47
import bzrlib.errors as errors
69
import bzrlib.timestamp
48
71
import bzrlib.inventory
49
72
import bzrlib.iterablefile
50
73
import bzrlib.lockdir
77
# lsprof not available
51
79
from bzrlib.merge import merge_inner
52
80
import bzrlib.merge3
54
import bzrlib.osutils as osutils
55
81
import bzrlib.plugin
56
from bzrlib.revision import common_ancestor
82
from bzrlib.smart import client, request, server
57
83
import bzrlib.store
84
from bzrlib import symbol_versioning
85
from bzrlib.symbol_versioning import (
58
91
import bzrlib.trace
59
from bzrlib.transport import urlescape, get_transport
92
from bzrlib.transport import get_transport
60
93
import bzrlib.transport
61
from bzrlib.transport.local import LocalRelpathServer
94
from bzrlib.transport.local import LocalURLServer
95
from bzrlib.transport.memory import MemoryServer
62
96
from bzrlib.transport.readonly import ReadonlyServer
63
from bzrlib.trace import mutter
64
from bzrlib.tests.TestUtil import TestLoader, TestSuite
97
from bzrlib.trace import mutter, note
98
from bzrlib.tests import TestUtil
99
from bzrlib.tests.http_server import HttpServer
100
from bzrlib.tests.TestUtil import (
65
104
from bzrlib.tests.treeshape import build_tree_contents
105
from bzrlib.ui import NullProgressView
106
from bzrlib.ui.text import TextUIFactory
107
import bzrlib.version_info_formats.format_custom
66
108
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
68
default_transport = LocalRelpathServer
71
MODULES_TO_DOCTEST = [
83
def packages_to_test():
84
"""Return a list of packages to test.
86
The packages are not globally imported so that import failures are
87
triggered when running selftest, not when importing the command.
90
import bzrlib.tests.blackbox
91
import bzrlib.tests.branch_implementations
92
import bzrlib.tests.bzrdir_implementations
93
import bzrlib.tests.interrepository_implementations
94
import bzrlib.tests.interversionedfile_implementations
95
import bzrlib.tests.repository_implementations
96
import bzrlib.tests.revisionstore_implementations
97
import bzrlib.tests.workingtree_implementations
100
bzrlib.tests.blackbox,
101
bzrlib.tests.branch_implementations,
102
bzrlib.tests.bzrdir_implementations,
103
bzrlib.tests.interrepository_implementations,
104
bzrlib.tests.interversionedfile_implementations,
105
bzrlib.tests.repository_implementations,
106
bzrlib.tests.revisionstore_implementations,
107
bzrlib.tests.workingtree_implementations,
111
class _MyResult(unittest._TextTestResult):
112
"""Custom TestResult.
114
Shows output in a different format, including displaying runtime for tests.
110
# Mark this python module as being part of the implementation
111
# of unittest: this gives us better tracebacks where the last
112
# shown frame is the test code, not our assertXYZ.
115
default_transport = LocalURLServer
117
# Subunit result codes, defined here to prevent a hard dependency on subunit.
122
class ExtendedTestResult(unittest._TextTestResult):
123
"""Accepts, reports and accumulates the results of running tests.
125
Compared to the unittest version this class adds support for
126
profiling, benchmarking, stopping as soon as a test fails, and
127
skipping tests. There are further-specialized subclasses for
128
different types of display.
130
When a test finishes, in whatever way, it calls one of the addSuccess,
131
addFailure or addError classes. These in turn may redirect to a more
132
specific case for the special test results supported by our extended
135
Note that just one of these objects is fed the results from many tests.
116
138
stop_early = False
118
def _elapsedTime(self):
119
return "%5dms" % (1000 * (time.time() - self._start_time))
140
def __init__(self, stream, descriptions, verbosity,
144
"""Construct new TestResult.
146
:param bench_history: Optionally, a writable file object to accumulate
149
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
150
if bench_history is not None:
151
from bzrlib.version import _get_bzr_source_tree
152
src_tree = _get_bzr_source_tree()
155
revision_id = src_tree.get_parent_ids()[0]
157
# XXX: if this is a brand new tree, do the same as if there
161
# XXX: If there's no branch, what should we do?
163
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
164
self._bench_history = bench_history
165
self.ui = ui.ui_factory
168
self.failure_count = 0
169
self.known_failure_count = 0
171
self.not_applicable_count = 0
172
self.unsupported = {}
174
self._overall_start_time = time.time()
175
self._strict = strict
178
# nb: called stopTestRun in the version of this that Python merged
179
# upstream, according to lifeless 20090803
181
ok = self.wasStrictlySuccessful()
183
ok = self.wasSuccessful()
185
self.stream.write('tests passed\n')
187
self.stream.write('tests failed\n')
188
if TestCase._first_thread_leaker_id:
190
'%s is leaking threads among %d leaking tests.\n' % (
191
TestCase._first_thread_leaker_id,
192
TestCase._leaking_threads_tests))
194
def _extractBenchmarkTime(self, testCase):
195
"""Add a benchmark time for the current test case."""
196
return getattr(testCase, "_benchtime", None)
198
def _elapsedTestTimeString(self):
199
"""Return a time string for the overall time the current test has taken."""
200
return self._formatTime(time.time() - self._start_time)
202
def _testTimeString(self, testCase):
203
benchmark_time = self._extractBenchmarkTime(testCase)
204
if benchmark_time is not None:
205
return self._formatTime(benchmark_time) + "*"
207
return self._elapsedTestTimeString()
209
def _formatTime(self, seconds):
210
"""Format seconds as milliseconds with leading spaces."""
211
# some benchmarks can take thousands of seconds to run, so we need 8
213
return "%8dms" % (1000 * seconds)
215
def _shortened_test_description(self, test):
217
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
121
220
def startTest(self, test):
122
221
unittest.TestResult.startTest(self, test)
123
# In a short description, the important words are in
124
# the beginning, but in an id, the important words are
126
SHOW_DESCRIPTIONS = False
128
width = osutils.terminal_width()
129
name_width = width - 15
131
if SHOW_DESCRIPTIONS:
132
what = test.shortDescription()
134
if len(what) > name_width:
135
what = what[:name_width-3] + '...'
138
if what.startswith('bzrlib.tests.'):
140
if len(what) > name_width:
141
what = '...' + what[3-name_width:]
142
what = what.ljust(name_width)
143
self.stream.write(what)
224
self.report_test_start(test)
225
test.number = self.count
226
self._recordTestStartTime()
228
def startTests(self):
230
if getattr(sys, 'frozen', None) is None:
231
bzr_path = osutils.realpath(sys.argv[0])
233
bzr_path = sys.executable
235
'testing: %s\n' % (bzr_path,))
238
bzrlib.__path__[0],))
240
' bzr-%s python-%s %s\n' % (
241
bzrlib.version_string,
242
bzrlib._format_version_tuple(sys.version_info),
243
platform.platform(aliased=1),
245
self.stream.write('\n')
247
def _recordTestStartTime(self):
248
"""Record that a test has started."""
145
249
self._start_time = time.time()
251
def _cleanupLogFile(self, test):
252
# We can only do this if we have one of our TestCases, not if
254
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
255
if setKeepLogfile is not None:
147
258
def addError(self, test, err):
148
if isinstance(err[1], TestSkipped):
149
return self.addSkipped(test, err)
150
unittest.TestResult.addError(self, test, err)
152
self.stream.writeln("ERROR %s" % self._elapsedTime())
154
self.stream.write('E')
259
"""Tell result that test finished with an error.
261
Called from the TestCase run() method when the test
262
fails with an unexpected error.
264
self._testConcluded(test)
265
if isinstance(err[1], TestNotApplicable):
266
return self._addNotApplicable(test, err)
267
elif isinstance(err[1], UnavailableFeature):
268
return self.addNotSupported(test, err[1].args[0])
270
unittest.TestResult.addError(self, test, err)
271
self.error_count += 1
272
self.report_error(test, err)
275
self._cleanupLogFile(test)
159
277
def addFailure(self, test, err):
160
unittest.TestResult.addFailure(self, test, err)
162
self.stream.writeln(" FAIL %s" % self._elapsedTime())
164
self.stream.write('F')
278
"""Tell result that test failed.
280
Called from the TestCase run() method when the test
281
fails because e.g. an assert() method failed.
283
self._testConcluded(test)
284
if isinstance(err[1], KnownFailure):
285
return self._addKnownFailure(test, err)
287
unittest.TestResult.addFailure(self, test, err)
288
self.failure_count += 1
289
self.report_failure(test, err)
292
self._cleanupLogFile(test)
169
294
def addSuccess(self, test):
171
self.stream.writeln(' OK %s' % self._elapsedTime())
173
self.stream.write('~')
175
unittest.TestResult.addSuccess(self, test)
177
def addSkipped(self, test, skip_excinfo):
179
print >>self.stream, ' SKIP %s' % self._elapsedTime()
180
print >>self.stream, ' %s' % skip_excinfo[1]
182
self.stream.write('S')
184
# seems best to treat this as success from point-of-view of unittest
185
# -- it actually does nothing so it barely matters :)
186
unittest.TestResult.addSuccess(self, test)
295
"""Tell result that test completed successfully.
297
Called from the TestCase run()
299
self._testConcluded(test)
300
if self._bench_history is not None:
301
benchmark_time = self._extractBenchmarkTime(test)
302
if benchmark_time is not None:
303
self._bench_history.write("%s %s\n" % (
304
self._formatTime(benchmark_time),
306
self.report_success(test)
307
self._cleanupLogFile(test)
308
unittest.TestResult.addSuccess(self, test)
309
test._log_contents = ''
311
def _testConcluded(self, test):
312
"""Common code when a test has finished.
314
Called regardless of whether it succeded, failed, etc.
318
def _addKnownFailure(self, test, err):
319
self.known_failure_count += 1
320
self.report_known_failure(test, err)
322
def addNotSupported(self, test, feature):
323
"""The test will not be run because of a missing feature.
325
# this can be called in two different ways: it may be that the
326
# test started running, and then raised (through addError)
327
# UnavailableFeature. Alternatively this method can be called
328
# while probing for features before running the tests; in that
329
# case we will see startTest and stopTest, but the test will never
331
self.unsupported.setdefault(str(feature), 0)
332
self.unsupported[str(feature)] += 1
333
self.report_unsupported(test, feature)
335
def addSkip(self, test, reason):
336
"""A test has not run for 'reason'."""
338
self.report_skip(test, reason)
340
def _addNotApplicable(self, test, skip_excinfo):
341
if isinstance(skip_excinfo[1], TestNotApplicable):
342
self.not_applicable_count += 1
343
self.report_not_applicable(test, skip_excinfo)
346
except KeyboardInterrupt:
349
self.addError(test, test.exc_info())
351
# seems best to treat this as success from point-of-view of unittest
352
# -- it actually does nothing so it barely matters :)
353
unittest.TestResult.addSuccess(self, test)
354
test._log_contents = ''
188
356
def printErrorList(self, flavour, errors):
189
357
for test, err in errors:
190
358
self.stream.writeln(self.separator1)
191
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
359
self.stream.write("%s: " % flavour)
360
self.stream.writeln(self.getDescription(test))
192
361
if getattr(test, '_get_log', None) is not None:
194
print >>self.stream, \
195
('vvvv[log from %s]' % test.id()).ljust(78,'-')
196
print >>self.stream, test._get_log()
197
print >>self.stream, \
198
('^^^^[log from %s]' % test.id()).ljust(78,'-')
362
log_contents = test._get_log()
364
self.stream.write('\n')
366
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
367
self.stream.write('\n')
368
self.stream.write(log_contents)
369
self.stream.write('\n')
371
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
372
self.stream.write('\n')
199
373
self.stream.writeln(self.separator2)
200
374
self.stream.writeln("%s" % err)
203
class TextTestRunner(unittest.TextTestRunner):
376
def progress(self, offset, whence):
377
"""The test is adjusting the count of tests to run."""
378
if whence == SUBUNIT_SEEK_SET:
379
self.num_tests = offset
380
elif whence == SUBUNIT_SEEK_CUR:
381
self.num_tests += offset
383
raise errors.BzrError("Unknown whence %r" % whence)
388
def report_cleaning_up(self):
391
def report_success(self, test):
394
def wasStrictlySuccessful(self):
395
if self.unsupported or self.known_failure_count:
397
return self.wasSuccessful()
400
class TextTestResult(ExtendedTestResult):
401
"""Displays progress and results of tests in text form"""
403
def __init__(self, stream, descriptions, verbosity,
408
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
409
bench_history, strict)
410
# We no longer pass them around, but just rely on the UIFactory stack
413
warnings.warn("Passing pb to TextTestResult is deprecated")
414
self.pb = self.ui.nested_progress_bar()
415
self.pb.show_pct = False
416
self.pb.show_spinner = False
417
self.pb.show_eta = False,
418
self.pb.show_count = False
419
self.pb.show_bar = False
420
self.pb.update_latency = 0
421
self.pb.show_transport_activity = False
424
# called when the tests that are going to run have run
426
super(TextTestResult, self).done()
431
def report_starting(self):
432
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
434
def printErrors(self):
435
# clear the pb to make room for the error listing
437
super(TextTestResult, self).printErrors()
439
def _progress_prefix_text(self):
440
# the longer this text, the less space we have to show the test
442
a = '[%d' % self.count # total that have been run
443
# tests skipped as known not to be relevant are not important enough
445
## if self.skip_count:
446
## a += ', %d skip' % self.skip_count
447
## if self.known_failure_count:
448
## a += '+%dX' % self.known_failure_count
450
a +='/%d' % self.num_tests
452
runtime = time.time() - self._overall_start_time
454
a += '%dm%ds' % (runtime / 60, runtime % 60)
458
a += ', %d err' % self.error_count
459
if self.failure_count:
460
a += ', %d fail' % self.failure_count
462
a += ', %d missing' % len(self.unsupported)
466
def report_test_start(self, test):
469
self._progress_prefix_text()
471
+ self._shortened_test_description(test))
473
def _test_description(self, test):
474
return self._shortened_test_description(test)
476
def report_error(self, test, err):
477
self.pb.note('ERROR: %s\n %s\n',
478
self._test_description(test),
482
def report_failure(self, test, err):
483
self.pb.note('FAIL: %s\n %s\n',
484
self._test_description(test),
488
def report_known_failure(self, test, err):
489
self.pb.note('XFAIL: %s\n%s\n',
490
self._test_description(test), err[1])
492
def report_skip(self, test, reason):
495
def report_not_applicable(self, test, skip_excinfo):
498
def report_unsupported(self, test, feature):
499
"""test cannot be run because feature is missing."""
501
def report_cleaning_up(self):
502
self.pb.update('Cleaning up')
505
class VerboseTestResult(ExtendedTestResult):
506
"""Produce long output, with one line per test run plus times"""
508
def _ellipsize_to_right(self, a_string, final_width):
509
"""Truncate and pad a string, keeping the right hand side"""
510
if len(a_string) > final_width:
511
result = '...' + a_string[3-final_width:]
514
return result.ljust(final_width)
516
def report_starting(self):
517
self.stream.write('running %d tests...\n' % self.num_tests)
519
def report_test_start(self, test):
521
name = self._shortened_test_description(test)
522
# width needs space for 6 char status, plus 1 for slash, plus an
523
# 11-char time string, plus a trailing blank
524
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
525
self.stream.write(self._ellipsize_to_right(name,
526
osutils.terminal_width()-18))
529
def _error_summary(self, err):
531
return '%s%s' % (indent, err[1])
533
def report_error(self, test, err):
534
self.stream.writeln('ERROR %s\n%s'
535
% (self._testTimeString(test),
536
self._error_summary(err)))
538
def report_failure(self, test, err):
539
self.stream.writeln(' FAIL %s\n%s'
540
% (self._testTimeString(test),
541
self._error_summary(err)))
543
def report_known_failure(self, test, err):
544
self.stream.writeln('XFAIL %s\n%s'
545
% (self._testTimeString(test),
546
self._error_summary(err)))
548
def report_success(self, test):
549
self.stream.writeln(' OK %s' % self._testTimeString(test))
550
for bench_called, stats in getattr(test, '_benchcalls', []):
551
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
552
stats.pprint(file=self.stream)
553
# flush the stream so that we get smooth output. This verbose mode is
554
# used to show the output in PQM.
557
def report_skip(self, test, reason):
558
self.stream.writeln(' SKIP %s\n%s'
559
% (self._testTimeString(test), reason))
561
def report_not_applicable(self, test, skip_excinfo):
562
self.stream.writeln(' N/A %s\n%s'
563
% (self._testTimeString(test),
564
self._error_summary(skip_excinfo)))
566
def report_unsupported(self, test, feature):
567
"""test cannot be run because feature is missing."""
568
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
569
%(self._testTimeString(test), feature))
572
class TextTestRunner(object):
204
573
stop_on_failure = False
206
def _makeResult(self):
207
result = _MyResult(self.stream, self.descriptions, self.verbosity)
583
self.stream = unittest._WritelnDecorator(stream)
584
self.descriptions = descriptions
585
self.verbosity = verbosity
586
self._bench_history = bench_history
587
self.list_only = list_only
588
self._strict = strict
591
"Run the given test case or test suite."
592
startTime = time.time()
593
if self.verbosity == 1:
594
result_class = TextTestResult
595
elif self.verbosity >= 2:
596
result_class = VerboseTestResult
597
result = result_class(self.stream,
600
bench_history=self._bench_history,
208
603
result.stop_early = self.stop_on_failure
604
result.report_starting()
606
if self.verbosity >= 2:
607
self.stream.writeln("Listing tests only ...\n")
609
for t in iter_suite_tests(test):
610
self.stream.writeln("%s" % (t.id()))
619
if isinstance(test, testtools.ConcurrentTestSuite):
620
# We need to catch bzr specific behaviors
621
test.run(BZRTransformingResult(result))
624
run = result.testsRun
626
stopTime = time.time()
627
timeTaken = stopTime - startTime
629
self.stream.writeln(result.separator2)
630
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
631
run, run != 1 and "s" or "", timeTaken))
632
self.stream.writeln()
633
if not result.wasSuccessful():
634
self.stream.write("FAILED (")
635
failed, errored = map(len, (result.failures, result.errors))
637
self.stream.write("failures=%d" % failed)
639
if failed: self.stream.write(", ")
640
self.stream.write("errors=%d" % errored)
641
if result.known_failure_count:
642
if failed or errored: self.stream.write(", ")
643
self.stream.write("known_failure_count=%d" %
644
result.known_failure_count)
645
self.stream.writeln(")")
647
if result.known_failure_count:
648
self.stream.writeln("OK (known_failures=%d)" %
649
result.known_failure_count)
651
self.stream.writeln("OK")
652
if result.skip_count > 0:
653
skipped = result.skip_count
654
self.stream.writeln('%d test%s skipped' %
655
(skipped, skipped != 1 and "s" or ""))
656
if result.unsupported:
657
for feature, count in sorted(result.unsupported.items()):
658
self.stream.writeln("Missing feature '%s' skipped %d tests." %
212
664
def iter_suite_tests(suite):
213
665
"""Return all tests in a suite, recursing through nested suites"""
214
for item in suite._tests:
215
if isinstance(item, unittest.TestCase):
217
elif isinstance(item, unittest.TestSuite):
666
if isinstance(suite, unittest.TestCase):
668
elif isinstance(suite, unittest.TestSuite):
218
670
for r in iter_suite_tests(item):
221
raise Exception('unknown object %r inside test suite %r'
673
raise Exception('unknown type %r for object %r'
674
% (type(suite), suite))
225
677
class TestSkipped(Exception):
226
678
"""Indicates that a test was intentionally skipped, rather than failing."""
681
class TestNotApplicable(TestSkipped):
682
"""A test is not applicable to the situation where it was run.
684
This is only normally raised by parameterized tests, if they find that
685
the instance they're constructed upon does not support one aspect
690
class KnownFailure(AssertionError):
691
"""Indicates that a test failed in a precisely expected manner.
693
Such failures dont block the whole test suite from passing because they are
694
indicators of partially completed code or of future work. We have an
695
explicit error for them so that we can ensure that they are always visible:
696
KnownFailures are always shown in the output of bzr selftest.
700
class UnavailableFeature(Exception):
701
"""A feature required for this test was not available.
703
The feature should be used to construct the exception.
230
707
class CommandFailed(Exception):
711
class StringIOWrapper(object):
712
"""A wrapper around cStringIO which just adds an encoding attribute.
714
Internally we can check sys.stdout to see what the output encoding
715
should be. However, cStringIO has no encoding attribute that we can
716
set. So we wrap it instead.
721
def __init__(self, s=None):
723
self.__dict__['_cstring'] = StringIO(s)
725
self.__dict__['_cstring'] = StringIO()
727
def __getattr__(self, name, getattr=getattr):
728
return getattr(self.__dict__['_cstring'], name)
730
def __setattr__(self, name, val):
731
if name == 'encoding':
732
self.__dict__['encoding'] = val
734
return setattr(self._cstring, name, val)
737
class TestUIFactory(TextUIFactory):
738
"""A UI Factory for testing.
740
Hide the progress bar but emit note()s.
742
Allows get_password to be tested without real tty attached.
744
See also CannedInputUIFactory which lets you provide programmatic input in
747
# TODO: Capture progress events at the model level and allow them to be
748
# observed by tests that care.
750
# XXX: Should probably unify more with CannedInputUIFactory or a
751
# particular configuration of TextUIFactory, or otherwise have a clearer
752
# idea of how they're supposed to be different.
753
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
755
def __init__(self, stdout=None, stderr=None, stdin=None):
756
if stdin is not None:
757
# We use a StringIOWrapper to be able to test various
758
# encodings, but the user is still responsible to
759
# encode the string and to set the encoding attribute
760
# of StringIOWrapper.
761
stdin = StringIOWrapper(stdin)
762
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
764
def get_non_echoed_password(self):
765
"""Get password from stdin without trying to handle the echo mode"""
766
password = self.stdin.readline()
769
if password[-1] == '\n':
770
password = password[:-1]
773
def make_progress_view(self):
774
return NullProgressView()
233
777
class TestCase(unittest.TestCase):
234
778
"""Base class for bzr unit tests.
236
Tests that need access to disk resources should subclass
780
Tests that need access to disk resources should subclass
237
781
TestCaseInTempDir not TestCase.
239
783
Error and debug log messages are redirected from their usual
349
1309
The file is removed as the test is torn down.
351
1311
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
352
encoder, decoder, stream_reader, stream_writer = codecs.lookup('UTF-8')
353
self._log_file = stream_writer(os.fdopen(fileno, 'w+'))
354
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1312
self._log_file = os.fdopen(fileno, 'w+')
1313
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
355
1314
self._log_file_name = name
356
1315
self.addCleanup(self._finishLogFile)
358
1317
def _finishLogFile(self):
359
1318
"""Finished with the log file.
361
Read contents into memory, close, and delete.
1320
Close the file and delete it, unless setKeepLogfile was called.
363
bzrlib.trace.disable_test_log(self._log_nonce)
364
self._log_file.seek(0)
365
self._log_contents = self._log_file.read()
1322
if self._log_file is None:
1324
bzrlib.trace.pop_log_file(self._log_memento)
366
1325
self._log_file.close()
367
os.remove(self._log_file_name)
368
self._log_file = self._log_file_name = None
370
def addCleanup(self, callable):
1326
self._log_file = None
1327
if not self._keep_log_file:
1328
os.remove(self._log_file_name)
1329
self._log_file_name = None
1331
def setKeepLogfile(self):
1332
"""Make the logfile not be deleted when _finishLogFile is called."""
1333
self._keep_log_file = True
1335
def thisFailsStrictLockCheck(self):
1336
"""It is known that this test would fail with -Dstrict_locks.
1338
By default, all tests are run with strict lock checking unless
1339
-Edisable_lock_checks is supplied. However there are some tests which
1340
we know fail strict locks at this point that have not been fixed.
1341
They should call this function to disable the strict checking.
1343
This should be used sparingly, it is much better to fix the locking
1344
issues rather than papering over the problem by calling this function.
1346
debug.debug_flags.discard('strict_locks')
1348
def addCleanup(self, callable, *args, **kwargs):
371
1349
"""Arrange to run a callable when this case is torn down.
373
Callables are run in the reverse of the order they are registered,
1351
Callables are run in the reverse of the order they are registered,
374
1352
ie last-in first-out.
376
if callable in self._cleanups:
377
raise ValueError("cleanup function %r already registered on %s"
379
self._cleanups.append(callable)
1354
self._cleanups.append((callable, args, kwargs))
381
1356
def _cleanEnvironment(self):
1358
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
383
1359
'HOME': os.getcwd(),
384
'APPDATA': os.getcwd(),
1360
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1361
# tests do check our impls match APPDATA
1362
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1366
'BZREMAIL': None, # may still be present in the environment
1368
'BZR_PROGRESS_BAR': None,
1370
'BZR_PLUGIN_PATH': None,
1371
# Make sure that any text ui tests are consistent regardless of
1372
# the environment the test case is run in; you may want tests that
1373
# test other combinations. 'dumb' is a reasonable guess for tests
1374
# going to a pipe or a StringIO.
1379
'SSH_AUTH_SOCK': None,
1383
'https_proxy': None,
1384
'HTTPS_PROXY': None,
1389
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1390
# least. If you do (care), please update this comment
1394
'BZR_REMOTE_PATH': None,
388
1396
self.__old_env = {}
389
1397
self.addCleanup(self._restoreEnvironment)
390
1398
for name, value in new_env.iteritems():
391
1399
self._captureVar(name, value)
394
1401
def _captureVar(self, name, newvalue):
395
"""Set an environment variable, preparing it to be reset when finished."""
396
self.__old_env[name] = os.environ.get(name, None)
398
if name in os.environ:
401
os.environ[name] = newvalue
1402
"""Set an environment variable, and reset it when finished."""
1403
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
404
def _restoreVar(name, value):
406
if name in os.environ:
409
os.environ[name] = value
1405
def _restore_debug_flags(self):
1406
debug.debug_flags.clear()
1407
debug.debug_flags.update(self._preserved_debug_flags)
411
1409
def _restoreEnvironment(self):
412
1410
for name, value in self.__old_env.iteritems():
413
self._restoreVar(name, value)
1411
osutils.set_or_unset_env(name, value)
1413
def _restoreHooks(self):
1414
for klass, (name, hooks) in self._preserved_hooks.items():
1415
setattr(klass, name, hooks)
1417
def knownFailure(self, reason):
1418
"""This test has failed for some known reason."""
1419
raise KnownFailure(reason)
1421
def _do_skip(self, result, reason):
1422
addSkip = getattr(result, 'addSkip', None)
1423
if not callable(addSkip):
1424
result.addError(self, sys.exc_info())
1426
addSkip(self, reason)
1428
def run(self, result=None):
1429
if result is None: result = self.defaultTestResult()
1430
for feature in getattr(self, '_test_needs_features', []):
1431
if not feature.available():
1432
result.startTest(self)
1433
if getattr(result, 'addNotSupported', None):
1434
result.addNotSupported(self, feature)
1436
result.addSuccess(self)
1437
result.stopTest(self)
1441
result.startTest(self)
1442
absent_attr = object()
1444
method_name = getattr(self, '_testMethodName', absent_attr)
1445
if method_name is absent_attr:
1447
method_name = getattr(self, '_TestCase__testMethodName')
1448
testMethod = getattr(self, method_name)
1452
if not self._bzr_test_setUp_run:
1454
"test setUp did not invoke "
1455
"bzrlib.tests.TestCase's setUp")
1456
except KeyboardInterrupt:
1459
except TestSkipped, e:
1460
self._do_skip(result, e.args[0])
1464
result.addError(self, sys.exc_info())
1472
except self.failureException:
1473
result.addFailure(self, sys.exc_info())
1474
except TestSkipped, e:
1476
reason = "No reason given."
1479
self._do_skip(result, reason)
1480
except KeyboardInterrupt:
1484
result.addError(self, sys.exc_info())
1488
if not self._bzr_test_tearDown_run:
1490
"test tearDown did not invoke "
1491
"bzrlib.tests.TestCase's tearDown")
1492
except KeyboardInterrupt:
1496
result.addError(self, sys.exc_info())
1499
if ok: result.addSuccess(self)
1501
result.stopTest(self)
1503
except TestNotApplicable:
1504
# Not moved from the result [yet].
1507
except KeyboardInterrupt:
1512
for attr_name in self.attrs_to_keep:
1513
if attr_name in self.__dict__:
1514
saved_attrs[attr_name] = self.__dict__[attr_name]
1515
self.__dict__ = saved_attrs
415
1517
def tearDown(self):
416
1518
self._runCleanups()
1519
self._log_contents = ''
1520
self._bzr_test_tearDown_run = True
417
1521
unittest.TestCase.tearDown(self)
1523
def time(self, callable, *args, **kwargs):
1524
"""Run callable and accrue the time it takes to the benchmark time.
1526
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1527
this will cause lsprofile statistics to be gathered and stored in
1530
if self._benchtime is None:
1534
if not self._gather_lsprof_in_benchmarks:
1535
return callable(*args, **kwargs)
1537
# record this benchmark
1538
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1540
self._benchcalls.append(((callable, args, kwargs), stats))
1543
self._benchtime += time.time() - start
419
1545
def _runCleanups(self):
420
"""Run registered cleanup functions.
1546
"""Run registered cleanup functions.
422
1548
This should only be called from TestCase.tearDown.
424
# TODO: Perhaps this should keep running cleanups even if
1550
# TODO: Perhaps this should keep running cleanups even if
425
1551
# one of them fails?
426
for cleanup_fn in reversed(self._cleanups):
1553
# Actually pop the cleanups from the list so tearDown running
1554
# twice is safe (this happens for skipped tests).
1555
while self._cleanups:
1556
cleanup, args, kwargs = self._cleanups.pop()
1557
cleanup(*args, **kwargs)
429
1559
def log(self, *args):
433
"""Return as a string the log for this test"""
434
if self._log_file_name:
435
return open(self._log_file_name).read()
1562
def _get_log(self, keep_log_file=False):
1563
"""Get the log from bzrlib.trace calls from this test.
1565
:param keep_log_file: When True, if the log is still a file on disk
1566
leave it as a file on disk. When False, if the log is still a file
1567
on disk, the log file is deleted and the log preserved as
1569
:return: A string containing the log.
1571
# flush the log file, to get all content
1573
if bzrlib.trace._trace_file:
1574
bzrlib.trace._trace_file.flush()
1575
if self._log_contents:
1576
# XXX: this can hardly contain the content flushed above --vila
437
1578
return self._log_contents
438
# TODO: Delete the log after it's been read in
440
def capture(self, cmd, retcode=0):
441
"""Shortcut that splits cmd into words, runs, and returns stdout"""
442
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
444
def run_bzr_captured(self, argv, retcode=0):
445
"""Invoke bzr and return (stdout, stderr).
447
Useful for code that wants to check the contents of the
448
output, the way error messages are presented, etc.
450
This should be the main method for tests that want to exercise the
451
overall behavior of the bzr application (rather than a unit test
452
or a functional test of the library.)
454
Much of the old code runs bzr by forking a new copy of Python, but
455
that is slower, harder to debug, and generally not necessary.
457
This runs bzr through the interface that catches and reports
458
errors, and with logging set to something approximating the
459
default, so that error reporting can be checked.
461
argv -- arguments to invoke bzr
462
retcode -- expected return code, or None for don't-care.
1579
if self._log_file_name is not None:
1580
logfile = open(self._log_file_name)
1582
log_contents = logfile.read()
1585
if not keep_log_file:
1586
self._log_contents = log_contents
1588
os.remove(self._log_file_name)
1590
if sys.platform == 'win32' and e.errno == errno.EACCES:
1591
sys.stderr.write(('Unable to delete log file '
1592
' %r\n' % self._log_file_name))
1597
return "DELETED log file to reduce memory footprint"
1599
def requireFeature(self, feature):
1600
"""This test requires a specific feature is available.
1602
:raises UnavailableFeature: When feature is not available.
466
self.log('run bzr: %s', ' '.join(argv))
1604
if not feature.available():
1605
raise UnavailableFeature(feature)
1607
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1609
"""Run bazaar command line, splitting up a string command line."""
1610
if isinstance(args, basestring):
1611
# shlex don't understand unicode strings,
1612
# so args should be plain string (bialix 20070906)
1613
args = list(shlex.split(str(args)))
1614
return self._run_bzr_core(args, retcode=retcode,
1615
encoding=encoding, stdin=stdin, working_dir=working_dir,
1618
def _run_bzr_core(self, args, retcode, encoding, stdin,
1620
if encoding is None:
1621
encoding = osutils.get_user_encoding()
1622
stdout = StringIOWrapper()
1623
stderr = StringIOWrapper()
1624
stdout.encoding = encoding
1625
stderr.encoding = encoding
1627
self.log('run bzr: %r', args)
467
1628
# FIXME: don't call into logging here
468
1629
handler = logging.StreamHandler(stderr)
469
handler.setFormatter(bzrlib.trace.QuietFormatter())
470
1630
handler.setLevel(logging.INFO)
471
1631
logger = logging.getLogger('')
472
1632
logger.addHandler(handler)
1633
old_ui_factory = ui.ui_factory
1634
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1637
if working_dir is not None:
1638
cwd = osutils.getcwd()
1639
os.chdir(working_dir)
474
result = self.apply_redirected(None, stdout, stderr,
475
bzrlib.commands.run_bzr_catch_errors,
1642
result = self.apply_redirected(ui.ui_factory.stdin,
1644
bzrlib.commands.run_bzr_catch_user_errors,
478
1647
logger.removeHandler(handler)
1648
ui.ui_factory = old_ui_factory
479
1652
out = stdout.getvalue()
480
1653
err = stderr.getvalue()
482
self.log('output:\n%s', out)
1655
self.log('output:\n%r', out)
484
self.log('errors:\n%s', err)
1657
self.log('errors:\n%r', err)
485
1658
if retcode is not None:
486
self.assertEquals(result, retcode)
1659
self.assertEquals(retcode, result,
1660
message='Unexpected return code')
489
def run_bzr(self, *args, **kwargs):
1663
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1664
working_dir=None, error_regexes=[], output_encoding=None):
490
1665
"""Invoke bzr, as if it were run from the command line.
1667
The argument list should not include the bzr program name - the
1668
first argument is normally the bzr command. Arguments may be
1669
passed in three ways:
1671
1- A list of strings, eg ["commit", "a"]. This is recommended
1672
when the command contains whitespace or metacharacters, or
1673
is built up at run time.
1675
2- A single string, eg "add a". This is the most convenient
1676
for hardcoded commands.
1678
This runs bzr through the interface that catches and reports
1679
errors, and with logging set to something approximating the
1680
default, so that error reporting can be checked.
492
1682
This should be the main method for tests that want to exercise the
493
1683
overall behavior of the bzr application (rather than a unit test
494
1684
or a functional test of the library.)
496
1686
This sends the stdout/stderr results into the test's log,
497
1687
where it may be useful for debugging. See also run_captured.
499
retcode = kwargs.pop('retcode', 0)
500
return self.run_bzr_captured(args, retcode)
1689
:keyword stdin: A string to be used as stdin for the command.
1690
:keyword retcode: The status code the command should return;
1692
:keyword working_dir: The directory to run the command in
1693
:keyword error_regexes: A list of expected error messages. If
1694
specified they must be seen in the error output of the command.
1696
out, err = self._run_bzr_autosplit(
1701
working_dir=working_dir,
1703
self.assertIsInstance(error_regexes, (list, tuple))
1704
for regex in error_regexes:
1705
self.assertContainsRe(err, regex)
1708
def run_bzr_error(self, error_regexes, *args, **kwargs):
1709
"""Run bzr, and check that stderr contains the supplied regexes
1711
:param error_regexes: Sequence of regular expressions which
1712
must each be found in the error output. The relative ordering
1714
:param args: command-line arguments for bzr
1715
:param kwargs: Keyword arguments which are interpreted by run_bzr
1716
This function changes the default value of retcode to be 3,
1717
since in most cases this is run when you expect bzr to fail.
1719
:return: (out, err) The actual output of running the command (in case
1720
you want to do more inspection)
1724
# Make sure that commit is failing because there is nothing to do
1725
self.run_bzr_error(['no changes to commit'],
1726
['commit', '-m', 'my commit comment'])
1727
# Make sure --strict is handling an unknown file, rather than
1728
# giving us the 'nothing to do' error
1729
self.build_tree(['unknown'])
1730
self.run_bzr_error(['Commit refused because there are unknown files'],
1731
['commit', --strict', '-m', 'my commit comment'])
1733
kwargs.setdefault('retcode', 3)
1734
kwargs['error_regexes'] = error_regexes
1735
out, err = self.run_bzr(*args, **kwargs)
1738
def run_bzr_subprocess(self, *args, **kwargs):
1739
"""Run bzr in a subprocess for testing.
1741
This starts a new Python interpreter and runs bzr in there.
1742
This should only be used for tests that have a justifiable need for
1743
this isolation: e.g. they are testing startup time, or signal
1744
handling, or early startup code, etc. Subprocess code can't be
1745
profiled or debugged so easily.
1747
:keyword retcode: The status code that is expected. Defaults to 0. If
1748
None is supplied, the status code is not checked.
1749
:keyword env_changes: A dictionary which lists changes to environment
1750
variables. A value of None will unset the env variable.
1751
The values must be strings. The change will only occur in the
1752
child, so you don't need to fix the environment after running.
1753
:keyword universal_newlines: Convert CRLF => LF
1754
:keyword allow_plugins: By default the subprocess is run with
1755
--no-plugins to ensure test reproducibility. Also, it is possible
1756
for system-wide plugins to create unexpected output on stderr,
1757
which can cause unnecessary test failures.
1759
env_changes = kwargs.get('env_changes', {})
1760
working_dir = kwargs.get('working_dir', None)
1761
allow_plugins = kwargs.get('allow_plugins', False)
1763
if isinstance(args[0], list):
1765
elif isinstance(args[0], basestring):
1766
args = list(shlex.split(args[0]))
1768
raise ValueError("passing varargs to run_bzr_subprocess")
1769
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1770
working_dir=working_dir,
1771
allow_plugins=allow_plugins)
1772
# We distinguish between retcode=None and retcode not passed.
1773
supplied_retcode = kwargs.get('retcode', 0)
1774
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1775
universal_newlines=kwargs.get('universal_newlines', False),
1778
def start_bzr_subprocess(self, process_args, env_changes=None,
1779
skip_if_plan_to_signal=False,
1781
allow_plugins=False):
1782
"""Start bzr in a subprocess for testing.
1784
This starts a new Python interpreter and runs bzr in there.
1785
This should only be used for tests that have a justifiable need for
1786
this isolation: e.g. they are testing startup time, or signal
1787
handling, or early startup code, etc. Subprocess code can't be
1788
profiled or debugged so easily.
1790
:param process_args: a list of arguments to pass to the bzr executable,
1791
for example ``['--version']``.
1792
:param env_changes: A dictionary which lists changes to environment
1793
variables. A value of None will unset the env variable.
1794
The values must be strings. The change will only occur in the
1795
child, so you don't need to fix the environment after running.
1796
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1798
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1800
:returns: Popen object for the started process.
1802
if skip_if_plan_to_signal:
1803
if not getattr(os, 'kill', None):
1804
raise TestSkipped("os.kill not available.")
1806
if env_changes is None:
1810
def cleanup_environment():
1811
for env_var, value in env_changes.iteritems():
1812
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1814
def restore_environment():
1815
for env_var, value in old_env.iteritems():
1816
osutils.set_or_unset_env(env_var, value)
1818
bzr_path = self.get_bzr_path()
1821
if working_dir is not None:
1822
cwd = osutils.getcwd()
1823
os.chdir(working_dir)
1826
# win32 subprocess doesn't support preexec_fn
1827
# so we will avoid using it on all platforms, just to
1828
# make sure the code path is used, and we don't break on win32
1829
cleanup_environment()
1830
command = [sys.executable]
1831
# frozen executables don't need the path to bzr
1832
if getattr(sys, "frozen", None) is None:
1833
command.append(bzr_path)
1834
if not allow_plugins:
1835
command.append('--no-plugins')
1836
command.extend(process_args)
1837
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1839
restore_environment()
1845
def _popen(self, *args, **kwargs):
1846
"""Place a call to Popen.
1848
Allows tests to override this method to intercept the calls made to
1849
Popen for introspection.
1851
return Popen(*args, **kwargs)
1853
def get_bzr_path(self):
1854
"""Return the path of the 'bzr' executable for this test suite."""
1855
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1856
if not os.path.isfile(bzr_path):
1857
# We are probably installed. Assume sys.argv is the right file
1858
bzr_path = sys.argv[0]
1861
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1862
universal_newlines=False, process_args=None):
1863
"""Finish the execution of process.
1865
:param process: the Popen object returned from start_bzr_subprocess.
1866
:param retcode: The status code that is expected. Defaults to 0. If
1867
None is supplied, the status code is not checked.
1868
:param send_signal: an optional signal to send to the process.
1869
:param universal_newlines: Convert CRLF => LF
1870
:returns: (stdout, stderr)
1872
if send_signal is not None:
1873
os.kill(process.pid, send_signal)
1874
out, err = process.communicate()
1876
if universal_newlines:
1877
out = out.replace('\r\n', '\n')
1878
err = err.replace('\r\n', '\n')
1880
if retcode is not None and retcode != process.returncode:
1881
if process_args is None:
1882
process_args = "(unknown args)"
1883
mutter('Output of bzr %s:\n%s', process_args, out)
1884
mutter('Error for bzr %s:\n%s', process_args, err)
1885
self.fail('Command bzr %s failed with retcode %s != %s'
1886
% (process_args, retcode, process.returncode))
502
1889
def check_inventory_shape(self, inv, shape):
503
1890
"""Compare an inventory to a list of expected names.
551
1938
sys.stderr = real_stderr
552
1939
sys.stdin = real_stdin
554
def merge(self, branch_from, wt_to):
555
"""A helper for tests to do a ui-less merge.
557
This should move to the main library when someone has time to integrate
560
# minimal ui-less merge.
561
wt_to.branch.fetch(branch_from)
562
base_rev = common_ancestor(branch_from.last_revision(),
563
wt_to.branch.last_revision(),
564
wt_to.branch.repository)
565
merge_inner(wt_to.branch, branch_from.basis_tree(),
566
wt_to.branch.repository.revision_tree(base_rev),
568
wt_to.add_pending_merge(branch_from.last_revision())
571
BzrTestBase = TestCase
574
class TestCaseInTempDir(TestCase):
1941
def reduceLockdirTimeout(self):
1942
"""Reduce the default lock timeout for the duration of the test, so that
1943
if LockContention occurs during a test, it does so quickly.
1945
Tests that expect to provoke LockContention errors should call this.
1947
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1949
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1950
self.addCleanup(resetTimeout)
1951
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1953
def make_utf8_encoded_stringio(self, encoding_type=None):
1954
"""Return a StringIOWrapper instance, that will encode Unicode
1957
if encoding_type is None:
1958
encoding_type = 'strict'
1960
output_encoding = 'utf-8'
1961
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1962
sio.encoding = output_encoding
1965
def disable_verb(self, verb):
1966
"""Disable a smart server verb for one test."""
1967
from bzrlib.smart import request
1968
request_handlers = request.request_handlers
1969
orig_method = request_handlers.get(verb)
1970
request_handlers.remove(verb)
1972
request_handlers.register(verb, orig_method)
1973
self.addCleanup(restoreVerb)
1976
class CapturedCall(object):
1977
"""A helper for capturing smart server calls for easy debug analysis."""
1979
def __init__(self, params, prefix_length):
1980
"""Capture the call with params and skip prefix_length stack frames."""
1983
# The last 5 frames are the __init__, the hook frame, and 3 smart
1984
# client frames. Beyond this we could get more clever, but this is good
1986
stack = traceback.extract_stack()[prefix_length:-5]
1987
self.stack = ''.join(traceback.format_list(stack))
1990
return self.call.method
1993
return self.call.method
1999
class TestCaseWithMemoryTransport(TestCase):
2000
"""Common test class for tests that do not need disk resources.
2002
Tests that need disk resources should derive from TestCaseWithTransport.
2004
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2006
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2007
a directory which does not exist. This serves to help ensure test isolation
2008
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2009
must exist. However, TestCaseWithMemoryTransport does not offer local
2010
file defaults for the transport in tests, nor does it obey the command line
2011
override, so tests that accidentally write to the common directory should
2014
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2015
a .bzr directory that stops us ascending higher into the filesystem.
2021
def __init__(self, methodName='runTest'):
2022
# allow test parameterization after test construction and before test
2023
# execution. Variables that the parameterizer sets need to be
2024
# ones that are not set by setUp, or setUp will trash them.
2025
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2026
self.vfs_transport_factory = default_transport
2027
self.transport_server = None
2028
self.transport_readonly_server = None
2029
self.__vfs_server = None
2031
def get_transport(self, relpath=None):
2032
"""Return a writeable transport.
2034
This transport is for the test scratch space relative to
2037
:param relpath: a path relative to the base url.
2039
t = get_transport(self.get_url(relpath))
2040
self.assertFalse(t.is_readonly())
2043
def get_readonly_transport(self, relpath=None):
2044
"""Return a readonly transport for the test scratch space
2046
This can be used to test that operations which should only need
2047
readonly access in fact do not try to write.
2049
:param relpath: a path relative to the base url.
2051
t = get_transport(self.get_readonly_url(relpath))
2052
self.assertTrue(t.is_readonly())
2055
def create_transport_readonly_server(self):
2056
"""Create a transport server from class defined at init.
2058
This is mostly a hook for daughter classes.
2060
return self.transport_readonly_server()
2062
def get_readonly_server(self):
2063
"""Get the server instance for the readonly transport
2065
This is useful for some tests with specific servers to do diagnostics.
2067
if self.__readonly_server is None:
2068
if self.transport_readonly_server is None:
2069
# readonly decorator requested
2070
# bring up the server
2071
self.__readonly_server = ReadonlyServer()
2072
self.__readonly_server.setUp(self.get_vfs_only_server())
2074
self.__readonly_server = self.create_transport_readonly_server()
2075
self.__readonly_server.setUp(self.get_vfs_only_server())
2076
self.addCleanup(self.__readonly_server.tearDown)
2077
return self.__readonly_server
2079
def get_readonly_url(self, relpath=None):
2080
"""Get a URL for the readonly transport.
2082
This will either be backed by '.' or a decorator to the transport
2083
used by self.get_url()
2084
relpath provides for clients to get a path relative to the base url.
2085
These should only be downwards relative, not upwards.
2087
base = self.get_readonly_server().get_url()
2088
return self._adjust_url(base, relpath)
2090
def get_vfs_only_server(self):
2091
"""Get the vfs only read/write server instance.
2093
This is useful for some tests with specific servers that need
2096
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2097
is no means to override it.
2099
if self.__vfs_server is None:
2100
self.__vfs_server = MemoryServer()
2101
self.__vfs_server.setUp()
2102
self.addCleanup(self.__vfs_server.tearDown)
2103
return self.__vfs_server
2105
def get_server(self):
2106
"""Get the read/write server instance.
2108
This is useful for some tests with specific servers that need
2111
This is built from the self.transport_server factory. If that is None,
2112
then the self.get_vfs_server is returned.
2114
if self.__server is None:
2115
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
2116
return self.get_vfs_only_server()
2118
# bring up a decorated means of access to the vfs only server.
2119
self.__server = self.transport_server()
2121
self.__server.setUp(self.get_vfs_only_server())
2122
except TypeError, e:
2123
# This should never happen; the try:Except here is to assist
2124
# developers having to update code rather than seeing an
2125
# uninformative TypeError.
2126
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2127
self.addCleanup(self.__server.tearDown)
2128
return self.__server
2130
def _adjust_url(self, base, relpath):
2131
"""Get a URL (or maybe a path) for the readwrite transport.
2133
This will either be backed by '.' or to an equivalent non-file based
2135
relpath provides for clients to get a path relative to the base url.
2136
These should only be downwards relative, not upwards.
2138
if relpath is not None and relpath != '.':
2139
if not base.endswith('/'):
2141
# XXX: Really base should be a url; we did after all call
2142
# get_url()! But sometimes it's just a path (from
2143
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2144
# to a non-escaped local path.
2145
if base.startswith('./') or base.startswith('/'):
2148
base += urlutils.escape(relpath)
2151
def get_url(self, relpath=None):
2152
"""Get a URL (or maybe a path) for the readwrite transport.
2154
This will either be backed by '.' or to an equivalent non-file based
2156
relpath provides for clients to get a path relative to the base url.
2157
These should only be downwards relative, not upwards.
2159
base = self.get_server().get_url()
2160
return self._adjust_url(base, relpath)
2162
def get_vfs_only_url(self, relpath=None):
2163
"""Get a URL (or maybe a path for the plain old vfs transport.
2165
This will never be a smart protocol. It always has all the
2166
capabilities of the local filesystem, but it might actually be a
2167
MemoryTransport or some other similar virtual filesystem.
2169
This is the backing transport (if any) of the server returned by
2170
get_url and get_readonly_url.
2172
:param relpath: provides for clients to get a path relative to the base
2173
url. These should only be downwards relative, not upwards.
2176
base = self.get_vfs_only_server().get_url()
2177
return self._adjust_url(base, relpath)
2179
def _create_safety_net(self):
2180
"""Make a fake bzr directory.
2182
This prevents any tests propagating up onto the TEST_ROOT directory's
2185
root = TestCaseWithMemoryTransport.TEST_ROOT
2186
bzrdir.BzrDir.create_standalone_workingtree(root)
2188
def _check_safety_net(self):
2189
"""Check that the safety .bzr directory have not been touched.
2191
_make_test_root have created a .bzr directory to prevent tests from
2192
propagating. This method ensures than a test did not leaked.
2194
root = TestCaseWithMemoryTransport.TEST_ROOT
2195
wt = workingtree.WorkingTree.open(root)
2196
last_rev = wt.last_revision()
2197
if last_rev != 'null:':
2198
# The current test have modified the /bzr directory, we need to
2199
# recreate a new one or all the followng tests will fail.
2200
# If you need to inspect its content uncomment the following line
2201
# import pdb; pdb.set_trace()
2202
_rmtree_temp_dir(root + '/.bzr')
2203
self._create_safety_net()
2204
raise AssertionError('%s/.bzr should not be modified' % root)
2206
def _make_test_root(self):
2207
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2208
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2209
TestCaseWithMemoryTransport.TEST_ROOT = root
2211
self._create_safety_net()
2213
# The same directory is used by all tests, and we're not
2214
# specifically told when all tests are finished. This will do.
2215
atexit.register(_rmtree_temp_dir, root)
2217
self.addCleanup(self._check_safety_net)
2219
def makeAndChdirToTestDir(self):
2220
"""Create a temporary directories for this one test.
2222
This must set self.test_home_dir and self.test_dir and chdir to
2225
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2227
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2228
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2229
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2231
def make_branch(self, relpath, format=None):
2232
"""Create a branch on the transport at relpath."""
2233
repo = self.make_repository(relpath, format=format)
2234
return repo.bzrdir.create_branch()
2236
def make_bzrdir(self, relpath, format=None):
2238
# might be a relative or absolute path
2239
maybe_a_url = self.get_url(relpath)
2240
segments = maybe_a_url.rsplit('/', 1)
2241
t = get_transport(maybe_a_url)
2242
if len(segments) > 1 and segments[-1] not in ('', '.'):
2246
if isinstance(format, basestring):
2247
format = bzrdir.format_registry.make_bzrdir(format)
2248
return format.initialize_on_transport(t)
2249
except errors.UninitializableFormat:
2250
raise TestSkipped("Format %s is not initializable." % format)
2252
def make_repository(self, relpath, shared=False, format=None):
2253
"""Create a repository on our default transport at relpath.
2255
Note that relpath must be a relative path, not a full url.
2257
# FIXME: If you create a remoterepository this returns the underlying
2258
# real format, which is incorrect. Actually we should make sure that
2259
# RemoteBzrDir returns a RemoteRepository.
2260
# maybe mbp 20070410
2261
made_control = self.make_bzrdir(relpath, format=format)
2262
return made_control.create_repository(shared=shared)
2264
def make_smart_server(self, path):
2265
smart_server = server.SmartTCPServer_for_testing()
2266
smart_server.setUp(self.get_server())
2267
remote_transport = get_transport(smart_server.get_url()).clone(path)
2268
self.addCleanup(smart_server.tearDown)
2269
return remote_transport
2271
def make_branch_and_memory_tree(self, relpath, format=None):
2272
"""Create a branch on the default transport and a MemoryTree for it."""
2273
b = self.make_branch(relpath, format=format)
2274
return memorytree.MemoryTree.create_on_branch(b)
2276
def make_branch_builder(self, relpath, format=None):
2277
branch = self.make_branch(relpath, format=format)
2278
return branchbuilder.BranchBuilder(branch=branch)
2280
def overrideEnvironmentForTesting(self):
2281
os.environ['HOME'] = self.test_home_dir
2282
os.environ['BZR_HOME'] = self.test_home_dir
2285
super(TestCaseWithMemoryTransport, self).setUp()
2286
self._make_test_root()
2287
_currentdir = os.getcwdu()
2288
def _leaveDirectory():
2289
os.chdir(_currentdir)
2290
self.addCleanup(_leaveDirectory)
2291
self.makeAndChdirToTestDir()
2292
self.overrideEnvironmentForTesting()
2293
self.__readonly_server = None
2294
self.__server = None
2295
self.reduceLockdirTimeout()
2297
def setup_smart_server_with_call_log(self):
2298
"""Sets up a smart server as the transport server with a call log."""
2299
self.transport_server = server.SmartTCPServer_for_testing
2300
self.hpss_calls = []
2302
# Skip the current stack down to the caller of
2303
# setup_smart_server_with_call_log
2304
prefix_length = len(traceback.extract_stack()) - 2
2305
def capture_hpss_call(params):
2306
self.hpss_calls.append(
2307
CapturedCall(params, prefix_length))
2308
client._SmartClient.hooks.install_named_hook(
2309
'call', capture_hpss_call, None)
2311
def reset_smart_call_log(self):
2312
self.hpss_calls = []
2315
class TestCaseInTempDir(TestCaseWithMemoryTransport):
575
2316
"""Derived class that runs a test within a temporary directory.
577
2318
This is useful for tests that need to create a branch, etc.
861
2552
for readonly urls.
863
2554
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
864
be used without needed to redo it when a different
2555
be used without needed to redo it when a different
865
2556
subclass is in use ?
868
2559
def setUp(self):
869
2560
super(ChrootedTestCase, self).setUp()
870
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
871
self.transport_readonly_server = bzrlib.transport.http.HttpServer
2561
if not self.vfs_transport_factory == MemoryServer:
2562
self.transport_readonly_server = HttpServer
2565
def condition_id_re(pattern):
2566
"""Create a condition filter which performs a re check on a test's id.
2568
:param pattern: A regular expression string.
2569
:return: A callable that returns True if the re matches.
2571
filter_re = osutils.re_compile_checked(pattern, 0,
2573
def condition(test):
2575
return filter_re.search(test_id)
2579
def condition_isinstance(klass_or_klass_list):
2580
"""Create a condition filter which returns isinstance(param, klass).
2582
:return: A callable which when called with one parameter obj return the
2583
result of isinstance(obj, klass_or_klass_list).
2586
return isinstance(obj, klass_or_klass_list)
2590
def condition_id_in_list(id_list):
2591
"""Create a condition filter which verify that test's id in a list.
2593
:param id_list: A TestIdList object.
2594
:return: A callable that returns True if the test's id appears in the list.
2596
def condition(test):
2597
return id_list.includes(test.id())
2601
def condition_id_startswith(starts):
2602
"""Create a condition filter verifying that test's id starts with a string.
2604
:param starts: A list of string.
2605
:return: A callable that returns True if the test's id starts with one of
2608
def condition(test):
2609
for start in starts:
2610
if test.id().startswith(start):
2616
def exclude_tests_by_condition(suite, condition):
2617
"""Create a test suite which excludes some tests from suite.
2619
:param suite: The suite to get tests from.
2620
:param condition: A callable whose result evaluates True when called with a
2621
test case which should be excluded from the result.
2622
:return: A suite which contains the tests found in suite that fail
2626
for test in iter_suite_tests(suite):
2627
if not condition(test):
2629
return TestUtil.TestSuite(result)
2632
def filter_suite_by_condition(suite, condition):
2633
"""Create a test suite by filtering another one.
2635
:param suite: The source suite.
2636
:param condition: A callable whose result evaluates True when called with a
2637
test case which should be included in the result.
2638
:return: A suite which contains the tests found in suite that pass
2642
for test in iter_suite_tests(suite):
2645
return TestUtil.TestSuite(result)
874
2648
def filter_suite_by_re(suite, pattern):
876
filter_re = re.compile(pattern)
2649
"""Create a test suite by filtering another one.
2651
:param suite: the source suite
2652
:param pattern: pattern that names must match
2653
:returns: the newly created suite
2655
condition = condition_id_re(pattern)
2656
result_suite = filter_suite_by_condition(suite, condition)
2660
def filter_suite_by_id_list(suite, test_id_list):
2661
"""Create a test suite by filtering another one.
2663
:param suite: The source suite.
2664
:param test_id_list: A list of the test ids to keep as strings.
2665
:returns: the newly created suite
2667
condition = condition_id_in_list(test_id_list)
2668
result_suite = filter_suite_by_condition(suite, condition)
2672
def filter_suite_by_id_startswith(suite, start):
2673
"""Create a test suite by filtering another one.
2675
:param suite: The source suite.
2676
:param start: A list of string the test id must start with one of.
2677
:returns: the newly created suite
2679
condition = condition_id_startswith(start)
2680
result_suite = filter_suite_by_condition(suite, condition)
2684
def exclude_tests_by_re(suite, pattern):
2685
"""Create a test suite which excludes some tests from suite.
2687
:param suite: The suite to get tests from.
2688
:param pattern: A regular expression string. Test ids that match this
2689
pattern will be excluded from the result.
2690
:return: A TestSuite that contains all the tests from suite without the
2691
tests that matched pattern. The order of tests is the same as it was in
2694
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2697
def preserve_input(something):
2698
"""A helper for performing test suite transformation chains.
2700
:param something: Anything you want to preserve.
2706
def randomize_suite(suite):
2707
"""Return a new TestSuite with suite's tests in random order.
2709
The tests in the input suite are flattened into a single suite in order to
2710
accomplish this. Any nested TestSuites are removed to provide global
2713
tests = list(iter_suite_tests(suite))
2714
random.shuffle(tests)
2715
return TestUtil.TestSuite(tests)
2718
def split_suite_by_condition(suite, condition):
2719
"""Split a test suite into two by a condition.
2721
:param suite: The suite to split.
2722
:param condition: The condition to match on. Tests that match this
2723
condition are returned in the first test suite, ones that do not match
2724
are in the second suite.
2725
:return: A tuple of two test suites, where the first contains tests from
2726
suite matching the condition, and the second contains the remainder
2727
from suite. The order within each output suite is the same as it was in
877
2732
for test in iter_suite_tests(suite):
878
if filter_re.search(test.id()):
2734
matched.append(test)
2736
did_not_match.append(test)
2737
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2740
def split_suite_by_re(suite, pattern):
2741
"""Split a test suite into two by a regular expression.
2743
:param suite: The suite to split.
2744
:param pattern: A regular expression string. Test ids that match this
2745
pattern will be in the first test suite returned, and the others in the
2746
second test suite returned.
2747
:return: A tuple of two test suites, where the first contains tests from
2748
suite matching pattern, and the second contains the remainder from
2749
suite. The order within each output suite is the same as it was in
2752
return split_suite_by_condition(suite, condition_id_re(pattern))
883
2755
def run_suite(suite, name='test', verbose=False, pattern=".*",
884
stop_on_failure=False, keep_output=False,
886
TestCaseInTempDir._TEST_NAME = name
2756
stop_on_failure=False,
2757
transport=None, lsprof_timed=None, bench_history=None,
2758
matching_tests_first=None,
2761
exclude_pattern=None,
2764
suite_decorators=None,
2766
"""Run a test suite for bzr selftest.
2768
:param runner_class: The class of runner to use. Must support the
2769
constructor arguments passed by run_suite which are more than standard
2771
:return: A boolean indicating success.
2773
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
891
runner = TextTestRunner(stream=sys.stdout,
2778
if runner_class is None:
2779
runner_class = TextTestRunner
2782
runner = runner_class(stream=stream,
2784
verbosity=verbosity,
2785
bench_history=bench_history,
2786
list_only=list_only,
894
2789
runner.stop_on_failure=stop_on_failure
896
suite = filter_suite_by_re(suite, pattern)
2790
# built in decorator factories:
2792
random_order(random_seed, runner),
2793
exclude_tests(exclude_pattern),
2795
if matching_tests_first:
2796
decorators.append(tests_first(pattern))
2798
decorators.append(filter_tests(pattern))
2799
if suite_decorators:
2800
decorators.extend(suite_decorators)
2801
# tell the result object how many tests will be running: (except if
2802
# --parallel=fork is being used. Robert said he will provide a better
2803
# progress design later -- vila 20090817)
2804
if fork_decorator not in decorators:
2805
decorators.append(CountingDecorator)
2806
for decorator in decorators:
2807
suite = decorator(suite)
897
2808
result = runner.run(suite)
898
# This is still a little bogus,
899
# but only a little. Folk not using our testrunner will
900
# have to delete their temp directories themselves.
901
test_root = TestCaseInTempDir.TEST_ROOT
902
if result.wasSuccessful() or not keep_output:
903
if test_root is not None:
904
print 'Deleting test root %s...' % test_root
906
shutil.rmtree(test_root)
2813
return result.wasStrictlySuccessful()
910
print "Failed tests working directories are in '%s'\n" % TestCaseInTempDir.TEST_ROOT
911
return result.wasSuccessful()
2815
return result.wasSuccessful()
2818
# A registry where get() returns a suite decorator.
2819
parallel_registry = registry.Registry()
2822
def fork_decorator(suite):
2823
concurrency = osutils.local_concurrency()
2824
if concurrency == 1:
2826
from testtools import ConcurrentTestSuite
2827
return ConcurrentTestSuite(suite, fork_for_tests)
2828
parallel_registry.register('fork', fork_decorator)
2831
def subprocess_decorator(suite):
2832
concurrency = osutils.local_concurrency()
2833
if concurrency == 1:
2835
from testtools import ConcurrentTestSuite
2836
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2837
parallel_registry.register('subprocess', subprocess_decorator)
2840
def exclude_tests(exclude_pattern):
2841
"""Return a test suite decorator that excludes tests."""
2842
if exclude_pattern is None:
2843
return identity_decorator
2844
def decorator(suite):
2845
return ExcludeDecorator(suite, exclude_pattern)
2849
def filter_tests(pattern):
2851
return identity_decorator
2852
def decorator(suite):
2853
return FilterTestsDecorator(suite, pattern)
2857
def random_order(random_seed, runner):
2858
"""Return a test suite decorator factory for randomising tests order.
2860
:param random_seed: now, a string which casts to a long, or a long.
2861
:param runner: A test runner with a stream attribute to report on.
2863
if random_seed is None:
2864
return identity_decorator
2865
def decorator(suite):
2866
return RandomDecorator(suite, random_seed, runner.stream)
2870
def tests_first(pattern):
2872
return identity_decorator
2873
def decorator(suite):
2874
return TestFirstDecorator(suite, pattern)
2878
def identity_decorator(suite):
2883
class TestDecorator(TestSuite):
2884
"""A decorator for TestCase/TestSuite objects.
2886
Usually, subclasses should override __iter__(used when flattening test
2887
suites), which we do to filter, reorder, parallelise and so on, run() and
2891
def __init__(self, suite):
2892
TestSuite.__init__(self)
2895
def countTestCases(self):
2898
cases += test.countTestCases()
2905
def run(self, result):
2906
# Use iteration on self, not self._tests, to allow subclasses to hook
2909
if result.shouldStop:
2915
class CountingDecorator(TestDecorator):
2916
"""A decorator which calls result.progress(self.countTestCases)."""
2918
def run(self, result):
2919
progress_method = getattr(result, 'progress', None)
2920
if callable(progress_method):
2921
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
2922
return super(CountingDecorator, self).run(result)
2925
class ExcludeDecorator(TestDecorator):
2926
"""A decorator which excludes test matching an exclude pattern."""
2928
def __init__(self, suite, exclude_pattern):
2929
TestDecorator.__init__(self, suite)
2930
self.exclude_pattern = exclude_pattern
2931
self.excluded = False
2935
return iter(self._tests)
2936
self.excluded = True
2937
suite = exclude_tests_by_re(self, self.exclude_pattern)
2939
self.addTests(suite)
2940
return iter(self._tests)
2943
class FilterTestsDecorator(TestDecorator):
2944
"""A decorator which filters tests to those matching a pattern."""
2946
def __init__(self, suite, pattern):
2947
TestDecorator.__init__(self, suite)
2948
self.pattern = pattern
2949
self.filtered = False
2953
return iter(self._tests)
2954
self.filtered = True
2955
suite = filter_suite_by_re(self, self.pattern)
2957
self.addTests(suite)
2958
return iter(self._tests)
2961
class RandomDecorator(TestDecorator):
2962
"""A decorator which randomises the order of its tests."""
2964
def __init__(self, suite, random_seed, stream):
2965
TestDecorator.__init__(self, suite)
2966
self.random_seed = random_seed
2967
self.randomised = False
2968
self.stream = stream
2972
return iter(self._tests)
2973
self.randomised = True
2974
self.stream.writeln("Randomizing test order using seed %s\n" %
2975
(self.actual_seed()))
2976
# Initialise the random number generator.
2977
random.seed(self.actual_seed())
2978
suite = randomize_suite(self)
2980
self.addTests(suite)
2981
return iter(self._tests)
2983
def actual_seed(self):
2984
if self.random_seed == "now":
2985
# We convert the seed to a long to make it reuseable across
2986
# invocations (because the user can reenter it).
2987
self.random_seed = long(time.time())
2989
# Convert the seed to a long if we can
2991
self.random_seed = long(self.random_seed)
2994
return self.random_seed
2997
class TestFirstDecorator(TestDecorator):
2998
"""A decorator which moves named tests to the front."""
3000
def __init__(self, suite, pattern):
3001
TestDecorator.__init__(self, suite)
3002
self.pattern = pattern
3003
self.filtered = False
3007
return iter(self._tests)
3008
self.filtered = True
3009
suites = split_suite_by_re(self, self.pattern)
3011
self.addTests(suites)
3012
return iter(self._tests)
3015
def partition_tests(suite, count):
3016
"""Partition suite into count lists of tests."""
3018
tests = list(iter_suite_tests(suite))
3019
tests_per_process = int(math.ceil(float(len(tests)) / count))
3020
for block in range(count):
3021
low_test = block * tests_per_process
3022
high_test = low_test + tests_per_process
3023
process_tests = tests[low_test:high_test]
3024
result.append(process_tests)
3028
def fork_for_tests(suite):
3029
"""Take suite and start up one runner per CPU by forking()
3031
:return: An iterable of TestCase-like objects which can each have
3032
run(result) called on them to feed tests to result.
3034
concurrency = osutils.local_concurrency()
3036
from subunit import TestProtocolClient, ProtocolTestCase
3038
from subunit.test_results import AutoTimingTestResultDecorator
3040
AutoTimingTestResultDecorator = lambda x:x
3041
class TestInOtherProcess(ProtocolTestCase):
3042
# Should be in subunit, I think. RBC.
3043
def __init__(self, stream, pid):
3044
ProtocolTestCase.__init__(self, stream)
3047
def run(self, result):
3049
ProtocolTestCase.run(self, result)
3051
os.waitpid(self.pid, os.WNOHANG)
3053
test_blocks = partition_tests(suite, concurrency)
3054
for process_tests in test_blocks:
3055
process_suite = TestSuite()
3056
process_suite.addTests(process_tests)
3057
c2pread, c2pwrite = os.pipe()
3062
# Leave stderr and stdout open so we can see test noise
3063
# Close stdin so that the child goes away if it decides to
3064
# read from stdin (otherwise its a roulette to see what
3065
# child actually gets keystrokes for pdb etc).
3068
stream = os.fdopen(c2pwrite, 'wb', 1)
3069
subunit_result = AutoTimingTestResultDecorator(
3070
TestProtocolClient(stream))
3071
process_suite.run(subunit_result)
3076
stream = os.fdopen(c2pread, 'rb', 1)
3077
test = TestInOtherProcess(stream, pid)
3082
def reinvoke_for_tests(suite):
3083
"""Take suite and start up one runner per CPU using subprocess().
3085
:return: An iterable of TestCase-like objects which can each have
3086
run(result) called on them to feed tests to result.
3088
concurrency = osutils.local_concurrency()
3090
from subunit import ProtocolTestCase
3091
class TestInSubprocess(ProtocolTestCase):
3092
def __init__(self, process, name):
3093
ProtocolTestCase.__init__(self, process.stdout)
3094
self.process = process
3095
self.process.stdin.close()
3098
def run(self, result):
3100
ProtocolTestCase.run(self, result)
3103
os.unlink(self.name)
3104
# print "pid %d finished" % finished_process
3105
test_blocks = partition_tests(suite, concurrency)
3106
for process_tests in test_blocks:
3107
# ugly; currently reimplement rather than reuses TestCase methods.
3108
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3109
if not os.path.isfile(bzr_path):
3110
# We are probably installed. Assume sys.argv is the right file
3111
bzr_path = sys.argv[0]
3112
fd, test_list_file_name = tempfile.mkstemp()
3113
test_list_file = os.fdopen(fd, 'wb', 1)
3114
for test in process_tests:
3115
test_list_file.write(test.id() + '\n')
3116
test_list_file.close()
3118
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3120
if '--no-plugins' in sys.argv:
3121
argv.append('--no-plugins')
3122
# stderr=STDOUT would be ideal, but until we prevent noise on
3123
# stderr it can interrupt the subunit protocol.
3124
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3126
test = TestInSubprocess(process, test_list_file_name)
3129
os.unlink(test_list_file_name)
3134
class BZRTransformingResult(unittest.TestResult):
3136
def __init__(self, target):
3137
unittest.TestResult.__init__(self)
3138
self.result = target
3140
def startTest(self, test):
3141
self.result.startTest(test)
3143
def stopTest(self, test):
3144
self.result.stopTest(test)
3146
def addError(self, test, err):
3147
feature = self._error_looks_like('UnavailableFeature: ', err)
3148
if feature is not None:
3149
self.result.addNotSupported(test, feature)
3151
self.result.addError(test, err)
3153
def addFailure(self, test, err):
3154
known = self._error_looks_like('KnownFailure: ', err)
3155
if known is not None:
3156
self.result._addKnownFailure(test, [KnownFailure,
3157
KnownFailure(known), None])
3159
self.result.addFailure(test, err)
3161
def addSkip(self, test, reason):
3162
self.result.addSkip(test, reason)
3164
def addSuccess(self, test):
3165
self.result.addSuccess(test)
3167
def _error_looks_like(self, prefix, err):
3168
"""Deserialize exception and returns the stringify value."""
3172
if isinstance(exc, subunit.RemoteException):
3173
# stringify the exception gives access to the remote traceback
3174
# We search the last line for 'prefix'
3175
lines = str(exc).split('\n')
3176
while lines and not lines[-1]:
3179
if lines[-1].startswith(prefix):
3180
value = lines[-1][len(prefix):]
3184
# Controlled by "bzr selftest -E=..." option
3185
# Currently supported:
3186
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3187
# preserves any flags supplied at the command line.
3188
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3189
# rather than failing tests. And no longer raise
3190
# LockContention when fctnl locks are not being used
3191
# with proper exclusion rules.
3192
selftest_debug_flags = set()
914
3195
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3197
test_suite_factory=None,
3200
matching_tests_first=None,
3203
exclude_pattern=None,
3209
suite_decorators=None,
917
3211
"""Run the whole test suite under the enhanced runner"""
3212
# XXX: Very ugly way to do this...
3213
# Disable warning about old formats because we don't want it to disturb
3214
# any blackbox tests.
3215
from bzrlib import repository
3216
repository._deprecation_warning_done = True
918
3218
global default_transport
919
3219
if transport is None:
920
3220
transport = default_transport
921
3221
old_transport = default_transport
922
3222
default_transport = transport
3223
global selftest_debug_flags
3224
old_debug_flags = selftest_debug_flags
3225
if debug_flags is not None:
3226
selftest_debug_flags = set(debug_flags)
3228
if load_list is None:
3231
keep_only = load_test_id_list(load_list)
3232
if test_suite_factory is None:
3233
suite = test_suite(keep_only, starting_with)
3235
suite = test_suite_factory()
925
3236
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
926
stop_on_failure=stop_on_failure, keep_output=keep_output,
3237
stop_on_failure=stop_on_failure,
3238
transport=transport,
3239
lsprof_timed=lsprof_timed,
3240
bench_history=bench_history,
3241
matching_tests_first=matching_tests_first,
3242
list_only=list_only,
3243
random_seed=random_seed,
3244
exclude_pattern=exclude_pattern,
3246
runner_class=runner_class,
3247
suite_decorators=suite_decorators,
929
3250
default_transport = old_transport
934
"""Build and return TestSuite for the whole program."""
935
from doctest import DocTestSuite
937
global MODULES_TO_DOCTEST
3251
selftest_debug_flags = old_debug_flags
3254
def load_test_id_list(file_name):
3255
"""Load a test id list from a text file.
3257
The format is one test id by line. No special care is taken to impose
3258
strict rules, these test ids are used to filter the test suite so a test id
3259
that do not match an existing test will do no harm. This allows user to add
3260
comments, leave blank lines, etc.
3264
ftest = open(file_name, 'rt')
3266
if e.errno != errno.ENOENT:
3269
raise errors.NoSuchFile(file_name)
3271
for test_name in ftest.readlines():
3272
test_list.append(test_name.strip())
3277
def suite_matches_id_list(test_suite, id_list):
3278
"""Warns about tests not appearing or appearing more than once.
3280
:param test_suite: A TestSuite object.
3281
:param test_id_list: The list of test ids that should be found in
3284
:return: (absents, duplicates) absents is a list containing the test found
3285
in id_list but not in test_suite, duplicates is a list containing the
3286
test found multiple times in test_suite.
3288
When using a prefined test id list, it may occurs that some tests do not
3289
exist anymore or that some tests use the same id. This function warns the
3290
tester about potential problems in his workflow (test lists are volatile)
3291
or in the test suite itself (using the same id for several tests does not
3292
help to localize defects).
3294
# Build a dict counting id occurrences
3296
for test in iter_suite_tests(test_suite):
3298
tests[id] = tests.get(id, 0) + 1
3303
occurs = tests.get(id, 0)
3305
not_found.append(id)
3307
duplicates.append(id)
3309
return not_found, duplicates
3312
class TestIdList(object):
3313
"""Test id list to filter a test suite.
3315
Relying on the assumption that test ids are built as:
3316
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3317
notation, this class offers methods to :
3318
- avoid building a test suite for modules not refered to in the test list,
3319
- keep only the tests listed from the module test suite.
3322
def __init__(self, test_id_list):
3323
# When a test suite needs to be filtered against us we compare test ids
3324
# for equality, so a simple dict offers a quick and simple solution.
3325
self.tests = dict().fromkeys(test_id_list, True)
3327
# While unittest.TestCase have ids like:
3328
# <module>.<class>.<method>[(<param+)],
3329
# doctest.DocTestCase can have ids like:
3332
# <module>.<function>
3333
# <module>.<class>.<method>
3335
# Since we can't predict a test class from its name only, we settle on
3336
# a simple constraint: a test id always begins with its module name.
3339
for test_id in test_id_list:
3340
parts = test_id.split('.')
3341
mod_name = parts.pop(0)
3342
modules[mod_name] = True
3344
mod_name += '.' + part
3345
modules[mod_name] = True
3346
self.modules = modules
3348
def refers_to(self, module_name):
3349
"""Is there tests for the module or one of its sub modules."""
3350
return self.modules.has_key(module_name)
3352
def includes(self, test_id):
3353
return self.tests.has_key(test_id)
3356
class TestPrefixAliasRegistry(registry.Registry):
3357
"""A registry for test prefix aliases.
3359
This helps implement shorcuts for the --starting-with selftest
3360
option. Overriding existing prefixes is not allowed but not fatal (a
3361
warning will be emitted).
3364
def register(self, key, obj, help=None, info=None,
3365
override_existing=False):
3366
"""See Registry.register.
3368
Trying to override an existing alias causes a warning to be emitted,
3369
not a fatal execption.
3372
super(TestPrefixAliasRegistry, self).register(
3373
key, obj, help=help, info=info, override_existing=False)
3375
actual = self.get(key)
3376
note('Test prefix alias %s is already used for %s, ignoring %s'
3377
% (key, actual, obj))
3379
def resolve_alias(self, id_start):
3380
"""Replace the alias by the prefix in the given string.
3382
Using an unknown prefix is an error to help catching typos.
3384
parts = id_start.split('.')
3386
parts[0] = self.get(parts[0])
3388
raise errors.BzrCommandError(
3389
'%s is not a known test prefix alias' % parts[0])
3390
return '.'.join(parts)
3393
test_prefix_alias_registry = TestPrefixAliasRegistry()
3394
"""Registry of test prefix aliases."""
3397
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3398
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3399
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3401
# Obvious higest levels prefixes, feel free to add your own via a plugin
3402
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3403
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3404
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3405
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3406
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3409
def test_suite(keep_only=None, starting_with=None):
3410
"""Build and return TestSuite for the whole of bzrlib.
3412
:param keep_only: A list of test ids limiting the suite returned.
3414
:param starting_with: An id limiting the suite returned to the tests
3417
This function can be replaced if you need to change the default test
3418
suite on a global basis, but it is not encouraged.
3422
'bzrlib.tests.blackbox',
3423
'bzrlib.tests.commands',
3424
'bzrlib.tests.per_branch',
3425
'bzrlib.tests.per_bzrdir',
3426
'bzrlib.tests.per_interrepository',
3427
'bzrlib.tests.per_intertree',
3428
'bzrlib.tests.per_inventory',
3429
'bzrlib.tests.per_interbranch',
3430
'bzrlib.tests.per_lock',
3431
'bzrlib.tests.per_transport',
3432
'bzrlib.tests.per_tree',
3433
'bzrlib.tests.per_pack_repository',
3434
'bzrlib.tests.per_repository',
3435
'bzrlib.tests.per_repository_chk',
3436
'bzrlib.tests.per_repository_reference',
3437
'bzrlib.tests.per_versionedfile',
3438
'bzrlib.tests.per_workingtree',
3439
'bzrlib.tests.test__annotator',
3440
'bzrlib.tests.test__chk_map',
3441
'bzrlib.tests.test__dirstate_helpers',
3442
'bzrlib.tests.test__groupcompress',
3443
'bzrlib.tests.test__known_graph',
3444
'bzrlib.tests.test__rio',
3445
'bzrlib.tests.test__walkdirs_win32',
940
3446
'bzrlib.tests.test_ancestry',
941
3447
'bzrlib.tests.test_annotate',
942
3448
'bzrlib.tests.test_api',
3449
'bzrlib.tests.test_atomicfile',
943
3450
'bzrlib.tests.test_bad_files',
944
'bzrlib.tests.test_basis_inventory',
3451
'bzrlib.tests.test_bencode',
3452
'bzrlib.tests.test_bisect_multi',
945
3453
'bzrlib.tests.test_branch',
3454
'bzrlib.tests.test_branchbuilder',
3455
'bzrlib.tests.test_btree_index',
3456
'bzrlib.tests.test_bugtracker',
3457
'bzrlib.tests.test_bundle',
946
3458
'bzrlib.tests.test_bzrdir',
947
'bzrlib.tests.test_command',
3459
'bzrlib.tests.test__chunks_to_lines',
3460
'bzrlib.tests.test_cache_utf8',
3461
'bzrlib.tests.test_chk_map',
3462
'bzrlib.tests.test_chk_serializer',
3463
'bzrlib.tests.test_chunk_writer',
3464
'bzrlib.tests.test_clean_tree',
3465
'bzrlib.tests.test_commands',
948
3466
'bzrlib.tests.test_commit',
949
3467
'bzrlib.tests.test_commit_merge',
950
3468
'bzrlib.tests.test_config',
951
3469
'bzrlib.tests.test_conflicts',
3470
'bzrlib.tests.test_counted_lock',
3471
'bzrlib.tests.test_crash',
952
3472
'bzrlib.tests.test_decorators',
3473
'bzrlib.tests.test_delta',
3474
'bzrlib.tests.test_debug',
3475
'bzrlib.tests.test_deprecated_graph',
953
3476
'bzrlib.tests.test_diff',
954
'bzrlib.tests.test_doc_generate',
3477
'bzrlib.tests.test_directory_service',
3478
'bzrlib.tests.test_dirstate',
3479
'bzrlib.tests.test_email_message',
3480
'bzrlib.tests.test_eol_filters',
955
3481
'bzrlib.tests.test_errors',
956
'bzrlib.tests.test_escaped_store',
3482
'bzrlib.tests.test_export',
3483
'bzrlib.tests.test_extract',
957
3484
'bzrlib.tests.test_fetch',
3485
'bzrlib.tests.test_fifo_cache',
3486
'bzrlib.tests.test_filters',
3487
'bzrlib.tests.test_ftp_transport',
3488
'bzrlib.tests.test_foreign',
3489
'bzrlib.tests.test_generate_docs',
3490
'bzrlib.tests.test_generate_ids',
3491
'bzrlib.tests.test_globbing',
958
3492
'bzrlib.tests.test_gpg',
959
3493
'bzrlib.tests.test_graph',
3494
'bzrlib.tests.test_groupcompress',
960
3495
'bzrlib.tests.test_hashcache',
3496
'bzrlib.tests.test_help',
3497
'bzrlib.tests.test_hooks',
961
3498
'bzrlib.tests.test_http',
3499
'bzrlib.tests.test_http_response',
3500
'bzrlib.tests.test_https_ca_bundle',
962
3501
'bzrlib.tests.test_identitymap',
3502
'bzrlib.tests.test_ignores',
3503
'bzrlib.tests.test_index',
3504
'bzrlib.tests.test_info',
963
3505
'bzrlib.tests.test_inv',
3506
'bzrlib.tests.test_inventory_delta',
964
3507
'bzrlib.tests.test_knit',
3508
'bzrlib.tests.test_lazy_import',
3509
'bzrlib.tests.test_lazy_regex',
3510
'bzrlib.tests.test_lock',
3511
'bzrlib.tests.test_lockable_files',
965
3512
'bzrlib.tests.test_lockdir',
966
'bzrlib.tests.test_lockable_files',
967
3513
'bzrlib.tests.test_log',
3514
'bzrlib.tests.test_lru_cache',
3515
'bzrlib.tests.test_lsprof',
3516
'bzrlib.tests.test_mail_client',
3517
'bzrlib.tests.test_memorytree',
968
3518
'bzrlib.tests.test_merge',
969
3519
'bzrlib.tests.test_merge3',
970
3520
'bzrlib.tests.test_merge_core',
3521
'bzrlib.tests.test_merge_directive',
971
3522
'bzrlib.tests.test_missing',
972
3523
'bzrlib.tests.test_msgeditor',
3524
'bzrlib.tests.test_multiparent',
3525
'bzrlib.tests.test_mutabletree',
973
3526
'bzrlib.tests.test_nonascii',
974
3527
'bzrlib.tests.test_options',
975
3528
'bzrlib.tests.test_osutils',
3529
'bzrlib.tests.test_osutils_encodings',
3530
'bzrlib.tests.test_pack',
3531
'bzrlib.tests.test_patch',
3532
'bzrlib.tests.test_patches',
976
3533
'bzrlib.tests.test_permissions',
977
3534
'bzrlib.tests.test_plugins',
978
3535
'bzrlib.tests.test_progress',
3536
'bzrlib.tests.test_read_bundle',
979
3537
'bzrlib.tests.test_reconcile',
3538
'bzrlib.tests.test_reconfigure',
3539
'bzrlib.tests.test_registry',
3540
'bzrlib.tests.test_remote',
3541
'bzrlib.tests.test_rename_map',
980
3542
'bzrlib.tests.test_repository',
3543
'bzrlib.tests.test_revert',
981
3544
'bzrlib.tests.test_revision',
982
'bzrlib.tests.test_revisionnamespaces',
983
'bzrlib.tests.test_revprops',
3545
'bzrlib.tests.test_revisionspec',
3546
'bzrlib.tests.test_revisiontree',
984
3547
'bzrlib.tests.test_rio',
3548
'bzrlib.tests.test_rules',
985
3549
'bzrlib.tests.test_sampler',
986
3550
'bzrlib.tests.test_selftest',
3551
'bzrlib.tests.test_serializer',
987
3552
'bzrlib.tests.test_setup',
988
3553
'bzrlib.tests.test_sftp_transport',
3554
'bzrlib.tests.test_shelf',
3555
'bzrlib.tests.test_shelf_ui',
3556
'bzrlib.tests.test_smart',
989
3557
'bzrlib.tests.test_smart_add',
3558
'bzrlib.tests.test_smart_request',
3559
'bzrlib.tests.test_smart_transport',
3560
'bzrlib.tests.test_smtp_connection',
990
3561
'bzrlib.tests.test_source',
3562
'bzrlib.tests.test_ssh_transport',
3563
'bzrlib.tests.test_status',
991
3564
'bzrlib.tests.test_store',
3565
'bzrlib.tests.test_strace',
3566
'bzrlib.tests.test_subsume',
3567
'bzrlib.tests.test_switch',
992
3568
'bzrlib.tests.test_symbol_versioning',
3569
'bzrlib.tests.test_tag',
993
3570
'bzrlib.tests.test_testament',
3571
'bzrlib.tests.test_textfile',
3572
'bzrlib.tests.test_textmerge',
3573
'bzrlib.tests.test_timestamp',
994
3574
'bzrlib.tests.test_trace',
995
3575
'bzrlib.tests.test_transactions',
996
3576
'bzrlib.tests.test_transform',
997
3577
'bzrlib.tests.test_transport',
3578
'bzrlib.tests.test_transport_log',
3579
'bzrlib.tests.test_tree',
3580
'bzrlib.tests.test_treebuilder',
998
3581
'bzrlib.tests.test_tsort',
3582
'bzrlib.tests.test_tuned_gzip',
999
3583
'bzrlib.tests.test_ui',
3584
'bzrlib.tests.test_uncommit',
1000
3585
'bzrlib.tests.test_upgrade',
1001
'bzrlib.tests.test_versionedfile',
3586
'bzrlib.tests.test_upgrade_stacked',
3587
'bzrlib.tests.test_urlutils',
3588
'bzrlib.tests.test_version',
3589
'bzrlib.tests.test_version_info',
1002
3590
'bzrlib.tests.test_weave',
1003
3591
'bzrlib.tests.test_whitebox',
3592
'bzrlib.tests.test_win32utils',
1004
3593
'bzrlib.tests.test_workingtree',
3594
'bzrlib.tests.test_workingtree_4',
3595
'bzrlib.tests.test_wsgi',
1005
3596
'bzrlib.tests.test_xml',
1007
test_transport_implementations = [
1008
'bzrlib.tests.test_transport_implementations']
1010
TestCase.BZRPATH = osutils.pathjoin(
1011
osutils.realpath(osutils.dirname(bzrlib.__path__[0])), 'bzr')
1012
print '%10s: %s' % ('bzr', osutils.realpath(sys.argv[0]))
1013
print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
1016
# python2.4's TestLoader.loadTestsFromNames gives very poor
1017
# errors if it fails to load a named module - no indication of what's
1018
# actually wrong, just "no such module". We should probably override that
1019
# class, but for the moment just load them ourselves. (mbp 20051202)
1020
loader = TestLoader()
1021
from bzrlib.transport import TransportTestProviderAdapter
1022
adapter = TransportTestProviderAdapter()
1023
adapt_modules(test_transport_implementations, adapter, loader, suite)
1024
for mod_name in testmod_names:
1025
mod = _load_module_by_name(mod_name)
1026
suite.addTest(loader.loadTestsFromModule(mod))
1027
for package in packages_to_test():
1028
suite.addTest(package.test_suite())
1029
for m in MODULES_TO_TEST:
1030
suite.addTest(loader.loadTestsFromModule(m))
1031
for m in (MODULES_TO_DOCTEST):
1032
suite.addTest(DocTestSuite(m))
1033
for name, plugin in bzrlib.plugin.all_plugins().items():
1034
if getattr(plugin, 'test_suite', None) is not None:
1035
suite.addTest(plugin.test_suite())
3599
loader = TestUtil.TestLoader()
3601
if keep_only is not None:
3602
id_filter = TestIdList(keep_only)
3604
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3605
for start in starting_with]
3606
# We take precedence over keep_only because *at loading time* using
3607
# both options means we will load less tests for the same final result.
3608
def interesting_module(name):
3609
for start in starting_with:
3611
# Either the module name starts with the specified string
3612
name.startswith(start)
3613
# or it may contain tests starting with the specified string
3614
or start.startswith(name)
3618
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3620
elif keep_only is not None:
3621
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3622
def interesting_module(name):
3623
return id_filter.refers_to(name)
3626
loader = TestUtil.TestLoader()
3627
def interesting_module(name):
3628
# No filtering, all modules are interesting
3631
suite = loader.suiteClass()
3633
# modules building their suite with loadTestsFromModuleNames
3634
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3636
modules_to_doctest = [
3638
'bzrlib.branchbuilder',
3641
'bzrlib.iterablefile',
3645
'bzrlib.symbol_versioning',
3648
'bzrlib.version_info_formats.format_custom',
3651
for mod in modules_to_doctest:
3652
if not interesting_module(mod):
3653
# No tests to keep here, move along
3656
# note that this really does mean "report only" -- doctest
3657
# still runs the rest of the examples
3658
doc_suite = doctest.DocTestSuite(mod,
3659
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3660
except ValueError, e:
3661
print '**failed to get doctest for: %s\n%s' % (mod, e)
3663
if len(doc_suite._tests) == 0:
3664
raise errors.BzrError("no doctests found in %s" % (mod,))
3665
suite.addTest(doc_suite)
3667
default_encoding = sys.getdefaultencoding()
3668
for name, plugin in bzrlib.plugin.plugins().items():
3669
if not interesting_module(plugin.module.__name__):
3671
plugin_suite = plugin.test_suite()
3672
# We used to catch ImportError here and turn it into just a warning,
3673
# but really if you don't have --no-plugins this should be a failure.
3674
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3675
if plugin_suite is None:
3676
plugin_suite = plugin.load_plugin_tests(loader)
3677
if plugin_suite is not None:
3678
suite.addTest(plugin_suite)
3679
if default_encoding != sys.getdefaultencoding():
3680
bzrlib.trace.warning(
3681
'Plugin "%s" tried to reset default encoding to: %s', name,
3682
sys.getdefaultencoding())
3684
sys.setdefaultencoding(default_encoding)
3687
suite = filter_suite_by_id_startswith(suite, starting_with)
3689
if keep_only is not None:
3690
# Now that the referred modules have loaded their tests, keep only the
3692
suite = filter_suite_by_id_list(suite, id_filter)
3693
# Do some sanity checks on the id_list filtering
3694
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3696
# The tester has used both keep_only and starting_with, so he is
3697
# already aware that some tests are excluded from the list, there
3698
# is no need to tell him which.
3701
# Some tests mentioned in the list are not in the test suite. The
3702
# list may be out of date, report to the tester.
3703
for id in not_found:
3704
bzrlib.trace.warning('"%s" not found in the test suite', id)
3705
for id in duplicates:
3706
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
1039
def adapt_modules(mods_list, adapter, loader, suite):
1040
"""Adapt the modules in mods_list using adapter and add to suite."""
1041
for mod_name in mods_list:
1042
mod = _load_module_by_name(mod_name)
1043
for test in iter_suite_tests(loader.loadTestsFromModule(mod)):
1044
suite.addTests(adapter.adapt(test))
1047
def _load_module_by_name(mod_name):
1048
parts = mod_name.split('.')
1049
module = __import__(mod_name)
1051
# for historical reasons python returns the top-level module even though
1052
# it loads the submodule; we need to walk down to get the one we want.
1054
module = getattr(module, parts.pop(0))
3711
def multiply_scenarios(scenarios_left, scenarios_right):
3712
"""Multiply two sets of scenarios.
3714
:returns: the cartesian product of the two sets of scenarios, that is
3715
a scenario for every possible combination of a left scenario and a
3719
('%s,%s' % (left_name, right_name),
3720
dict(left_dict.items() + right_dict.items()))
3721
for left_name, left_dict in scenarios_left
3722
for right_name, right_dict in scenarios_right]
3725
def multiply_tests(tests, scenarios, result):
3726
"""Multiply tests_list by scenarios into result.
3728
This is the core workhorse for test parameterisation.
3730
Typically the load_tests() method for a per-implementation test suite will
3731
call multiply_tests and return the result.
3733
:param tests: The tests to parameterise.
3734
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3735
scenario_param_dict).
3736
:param result: A TestSuite to add created tests to.
3738
This returns the passed in result TestSuite with the cross product of all
3739
the tests repeated once for each scenario. Each test is adapted by adding
3740
the scenario name at the end of its id(), and updating the test object's
3741
__dict__ with the scenario_param_dict.
3743
>>> import bzrlib.tests.test_sampler
3744
>>> r = multiply_tests(
3745
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3746
... [('one', dict(param=1)),
3747
... ('two', dict(param=2))],
3749
>>> tests = list(iter_suite_tests(r))
3753
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3759
for test in iter_suite_tests(tests):
3760
apply_scenarios(test, scenarios, result)
3764
def apply_scenarios(test, scenarios, result):
3765
"""Apply the scenarios in scenarios to test and add to result.
3767
:param test: The test to apply scenarios to.
3768
:param scenarios: An iterable of scenarios to apply to test.
3770
:seealso: apply_scenario
3772
for scenario in scenarios:
3773
result.addTest(apply_scenario(test, scenario))
3777
def apply_scenario(test, scenario):
3778
"""Copy test and apply scenario to it.
3780
:param test: A test to adapt.
3781
:param scenario: A tuple describing the scenarion.
3782
The first element of the tuple is the new test id.
3783
The second element is a dict containing attributes to set on the
3785
:return: The adapted test.
3787
new_id = "%s(%s)" % (test.id(), scenario[0])
3788
new_test = clone_test(test, new_id)
3789
for name, value in scenario[1].items():
3790
setattr(new_test, name, value)
3794
def clone_test(test, new_id):
3795
"""Clone a test giving it a new id.
3797
:param test: The test to clone.
3798
:param new_id: The id to assign to it.
3799
:return: The new test.
3801
from copy import deepcopy
3802
new_test = deepcopy(test)
3803
new_test.id = lambda: new_id
3807
def _rmtree_temp_dir(dirname):
3808
# If LANG=C we probably have created some bogus paths
3809
# which rmtree(unicode) will fail to delete
3810
# so make sure we are using rmtree(str) to delete everything
3811
# except on win32, where rmtree(str) will fail
3812
# since it doesn't have the property of byte-stream paths
3813
# (they are either ascii or mbcs)
3814
if sys.platform == 'win32':
3815
# make sure we are using the unicode win32 api
3816
dirname = unicode(dirname)
3818
dirname = dirname.encode(sys.getfilesystemencoding())
3820
osutils.rmtree(dirname)
3822
# We don't want to fail here because some useful display will be lost
3823
# otherwise. Polluting the tmp dir is bad, but not giving all the
3824
# possible info to the test runner is even worse.
3825
sys.stderr.write('Unable to remove testing dir %s\n%s'
3826
% (os.path.basename(dirname), e))
3829
class Feature(object):
3830
"""An operating system Feature."""
3833
self._available = None
3835
def available(self):
3836
"""Is the feature available?
3838
:return: True if the feature is available.
3840
if self._available is None:
3841
self._available = self._probe()
3842
return self._available
3845
"""Implement this method in concrete features.
3847
:return: True if the feature is available.
3849
raise NotImplementedError
3852
if getattr(self, 'feature_name', None):
3853
return self.feature_name()
3854
return self.__class__.__name__
3857
class _SymlinkFeature(Feature):
3860
return osutils.has_symlinks()
3862
def feature_name(self):
3865
SymlinkFeature = _SymlinkFeature()
3868
class _HardlinkFeature(Feature):
3871
return osutils.has_hardlinks()
3873
def feature_name(self):
3876
HardlinkFeature = _HardlinkFeature()
3879
class _OsFifoFeature(Feature):
3882
return getattr(os, 'mkfifo', None)
3884
def feature_name(self):
3885
return 'filesystem fifos'
3887
OsFifoFeature = _OsFifoFeature()
3890
class _UnicodeFilenameFeature(Feature):
3891
"""Does the filesystem support Unicode filenames?"""
3895
# Check for character combinations unlikely to be covered by any
3896
# single non-unicode encoding. We use the characters
3897
# - greek small letter alpha (U+03B1) and
3898
# - braille pattern dots-123456 (U+283F).
3899
os.stat(u'\u03b1\u283f')
3900
except UnicodeEncodeError:
3902
except (IOError, OSError):
3903
# The filesystem allows the Unicode filename but the file doesn't
3907
# The filesystem allows the Unicode filename and the file exists,
3911
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3914
def probe_unicode_in_user_encoding():
3915
"""Try to encode several unicode strings to use in unicode-aware tests.
3916
Return first successfull match.
3918
:return: (unicode value, encoded plain string value) or (None, None)
3920
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3921
for uni_val in possible_vals:
3923
str_val = uni_val.encode(osutils.get_user_encoding())
3924
except UnicodeEncodeError:
3925
# Try a different character
3928
return uni_val, str_val
3932
def probe_bad_non_ascii(encoding):
3933
"""Try to find [bad] character with code [128..255]
3934
that cannot be decoded to unicode in some encoding.
3935
Return None if all non-ascii characters is valid
3938
for i in xrange(128, 256):
3941
char.decode(encoding)
3942
except UnicodeDecodeError:
3947
class _HTTPSServerFeature(Feature):
3948
"""Some tests want an https Server, check if one is available.
3950
Right now, the only way this is available is under python2.6 which provides
3961
def feature_name(self):
3962
return 'HTTPSServer'
3965
HTTPSServerFeature = _HTTPSServerFeature()
3968
class _UnicodeFilename(Feature):
3969
"""Does the filesystem support Unicode filenames?"""
3974
except UnicodeEncodeError:
3976
except (IOError, OSError):
3977
# The filesystem allows the Unicode filename but the file doesn't
3981
# The filesystem allows the Unicode filename and the file exists,
3985
UnicodeFilename = _UnicodeFilename()
3988
class _UTF8Filesystem(Feature):
3989
"""Is the filesystem UTF-8?"""
3992
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3996
UTF8Filesystem = _UTF8Filesystem()
3999
class _CaseInsCasePresFilenameFeature(Feature):
4000
"""Is the file-system case insensitive, but case-preserving?"""
4003
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4005
# first check truly case-preserving for created files, then check
4006
# case insensitive when opening existing files.
4007
name = osutils.normpath(name)
4008
base, rel = osutils.split(name)
4009
found_rel = osutils.canonical_relpath(base, name)
4010
return (found_rel == rel
4011
and os.path.isfile(name.upper())
4012
and os.path.isfile(name.lower()))
4017
def feature_name(self):
4018
return "case-insensitive case-preserving filesystem"
4020
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4023
class _CaseInsensitiveFilesystemFeature(Feature):
4024
"""Check if underlying filesystem is case-insensitive but *not* case
4027
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4028
# more likely to be case preserving, so this case is rare.
4031
if CaseInsCasePresFilenameFeature.available():
4034
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4035
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4036
TestCaseWithMemoryTransport.TEST_ROOT = root
4038
root = TestCaseWithMemoryTransport.TEST_ROOT
4039
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4041
name_a = osutils.pathjoin(tdir, 'a')
4042
name_A = osutils.pathjoin(tdir, 'A')
4044
result = osutils.isdir(name_A)
4045
_rmtree_temp_dir(tdir)
4048
def feature_name(self):
4049
return 'case-insensitive filesystem'
4051
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4054
class _SubUnitFeature(Feature):
4055
"""Check if subunit is available."""
4064
def feature_name(self):
4067
SubUnitFeature = _SubUnitFeature()
4068
# Only define SubUnitBzrRunner if subunit is available.
4070
from subunit import TestProtocolClient
4072
from subunit.test_results import AutoTimingTestResultDecorator
4074
AutoTimingTestResultDecorator = lambda x:x
4075
class SubUnitBzrRunner(TextTestRunner):
4076
def run(self, test):
4077
result = AutoTimingTestResultDecorator(
4078
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
