1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from testsweet import TestBase, run_suite, InTempDir
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
32
from cStringIO import StringIO
39
from pprint import pformat
44
from subprocess import Popen, PIPE, STDOUT
54
# nb: check this before importing anything else from within it
55
_testtools_version = getattr(testtools, '__version__', ())
56
if _testtools_version < (0, 9, 2):
57
raise ImportError("need at least testtools 0.9.2: %s is %r"
58
% (testtools.__file__, _testtools_version))
59
from testtools import content
19
79
import bzrlib.commands
22
MODULES_TO_DOCTEST = []
25
class BzrTestBase(InTempDir):
26
"""bzr-specific test base class"""
27
def run_bzr(self, *args, **kwargs):
28
retcode = kwargs.get('retcode', 0)
29
self.assertEquals(bzrlib.commands.run_bzr(args), retcode)
32
def selftest(verbose=False):
33
from unittest import TestLoader, TestSuite
34
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
35
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
36
from doctest import DocTestSuite
43
global MODULES_TO_TEST, MODULES_TO_DOCTEST
46
['bzrlib.selftest.whitebox',
47
'bzrlib.selftest.versioning',
48
'bzrlib.selftest.testinv',
49
'bzrlib.selftest.testmerge3',
50
'bzrlib.selftest.testhashcache',
51
'bzrlib.selftest.teststatus',
52
'bzrlib.selftest.testlog',
53
'bzrlib.selftest.blackbox',
54
'bzrlib.selftest.testrevisionnamespaces',
55
'bzrlib.selftest.testbranch',
56
'bzrlib.selftest.testrevision',
58
'bzrlib.selftest.testdiff',
61
# XXX: should also test bzrlib.merge_core, but they seem to be out
62
# of date with the code.
64
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
65
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
66
if m not in MODULES_TO_DOCTEST:
67
MODULES_TO_DOCTEST.append(m)
70
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
71
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
77
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
79
for m in MODULES_TO_TEST:
80
suite.addTest(TestLoader().loadTestsFromModule(m))
82
for m in (MODULES_TO_DOCTEST):
83
suite.addTest(DocTestSuite(m))
85
for p in bzrlib.plugin.all_plugins:
86
if hasattr(p, 'test_suite'):
87
suite.addTest(p.test_suite())
89
import bzrlib.merge_core
90
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
92
return run_suite(suite, 'testbzr', verbose=verbose)
80
import bzrlib.timestamp
82
import bzrlib.inventory
83
import bzrlib.iterablefile
88
# lsprof not available
90
from bzrlib.merge import merge_inner
93
from bzrlib.smart import client, request, server
95
from bzrlib import symbol_versioning
96
from bzrlib.symbol_versioning import (
104
from bzrlib.transport import get_transport, pathfilter
105
import bzrlib.transport
106
from bzrlib.transport.local import LocalURLServer
107
from bzrlib.transport.memory import MemoryServer
108
from bzrlib.transport.readonly import ReadonlyServer
109
from bzrlib.trace import mutter, note
110
from bzrlib.tests import TestUtil
111
from bzrlib.tests.http_server import HttpServer
112
from bzrlib.tests.TestUtil import (
116
from bzrlib.tests.treeshape import build_tree_contents
117
from bzrlib.ui import NullProgressView
118
from bzrlib.ui.text import TextUIFactory
119
import bzrlib.version_info_formats.format_custom
120
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
122
# Mark this python module as being part of the implementation
123
# of unittest: this gives us better tracebacks where the last
124
# shown frame is the test code, not our assertXYZ.
127
default_transport = LocalURLServer
129
# Subunit result codes, defined here to prevent a hard dependency on subunit.
134
class ExtendedTestResult(unittest._TextTestResult):
135
"""Accepts, reports and accumulates the results of running tests.
137
Compared to the unittest version this class adds support for
138
profiling, benchmarking, stopping as soon as a test fails, and
139
skipping tests. There are further-specialized subclasses for
140
different types of display.
142
When a test finishes, in whatever way, it calls one of the addSuccess,
143
addFailure or addError classes. These in turn may redirect to a more
144
specific case for the special test results supported by our extended
147
Note that just one of these objects is fed the results from many tests.
152
def __init__(self, stream, descriptions, verbosity,
156
"""Construct new TestResult.
158
:param bench_history: Optionally, a writable file object to accumulate
161
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
162
if bench_history is not None:
163
from bzrlib.version import _get_bzr_source_tree
164
src_tree = _get_bzr_source_tree()
167
revision_id = src_tree.get_parent_ids()[0]
169
# XXX: if this is a brand new tree, do the same as if there
173
# XXX: If there's no branch, what should we do?
175
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
176
self._bench_history = bench_history
177
self.ui = ui.ui_factory
180
self.failure_count = 0
181
self.known_failure_count = 0
183
self.not_applicable_count = 0
184
self.unsupported = {}
186
self._overall_start_time = time.time()
187
self._strict = strict
189
def stopTestRun(self):
192
stopTime = time.time()
193
timeTaken = stopTime - self.startTime
195
self.stream.writeln(self.separator2)
196
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
197
run, run != 1 and "s" or "", timeTaken))
198
self.stream.writeln()
199
if not self.wasSuccessful():
200
self.stream.write("FAILED (")
201
failed, errored = map(len, (self.failures, self.errors))
203
self.stream.write("failures=%d" % failed)
205
if failed: self.stream.write(", ")
206
self.stream.write("errors=%d" % errored)
207
if self.known_failure_count:
208
if failed or errored: self.stream.write(", ")
209
self.stream.write("known_failure_count=%d" %
210
self.known_failure_count)
211
self.stream.writeln(")")
213
if self.known_failure_count:
214
self.stream.writeln("OK (known_failures=%d)" %
215
self.known_failure_count)
217
self.stream.writeln("OK")
218
if self.skip_count > 0:
219
skipped = self.skip_count
220
self.stream.writeln('%d test%s skipped' %
221
(skipped, skipped != 1 and "s" or ""))
223
for feature, count in sorted(self.unsupported.items()):
224
self.stream.writeln("Missing feature '%s' skipped %d tests." %
227
ok = self.wasStrictlySuccessful()
229
ok = self.wasSuccessful()
230
if TestCase._first_thread_leaker_id:
232
'%s is leaking threads among %d leaking tests.\n' % (
233
TestCase._first_thread_leaker_id,
234
TestCase._leaking_threads_tests))
235
# We don't report the main thread as an active one.
237
'%d non-main threads were left active in the end.\n'
238
% (TestCase._active_threads - 1))
240
def getDescription(self, test):
243
def _extractBenchmarkTime(self, testCase, details=None):
244
"""Add a benchmark time for the current test case."""
245
if details and 'benchtime' in details:
246
return float(''.join(details['benchtime'].iter_bytes()))
247
return getattr(testCase, "_benchtime", None)
249
def _elapsedTestTimeString(self):
250
"""Return a time string for the overall time the current test has taken."""
251
return self._formatTime(time.time() - self._start_time)
253
def _testTimeString(self, testCase):
254
benchmark_time = self._extractBenchmarkTime(testCase)
255
if benchmark_time is not None:
256
return self._formatTime(benchmark_time) + "*"
258
return self._elapsedTestTimeString()
260
def _formatTime(self, seconds):
261
"""Format seconds as milliseconds with leading spaces."""
262
# some benchmarks can take thousands of seconds to run, so we need 8
264
return "%8dms" % (1000 * seconds)
266
def _shortened_test_description(self, test):
268
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
271
def startTest(self, test):
272
unittest.TestResult.startTest(self, test)
275
self.report_test_start(test)
276
test.number = self.count
277
self._recordTestStartTime()
279
def startTests(self):
281
if getattr(sys, 'frozen', None) is None:
282
bzr_path = osutils.realpath(sys.argv[0])
284
bzr_path = sys.executable
286
'bzr selftest: %s\n' % (bzr_path,))
289
bzrlib.__path__[0],))
291
' bzr-%s python-%s %s\n' % (
292
bzrlib.version_string,
293
bzrlib._format_version_tuple(sys.version_info),
294
platform.platform(aliased=1),
296
self.stream.write('\n')
298
def _recordTestStartTime(self):
299
"""Record that a test has started."""
300
self._start_time = time.time()
302
def _cleanupLogFile(self, test):
303
# We can only do this if we have one of our TestCases, not if
305
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
306
if setKeepLogfile is not None:
309
def addError(self, test, err):
310
"""Tell result that test finished with an error.
312
Called from the TestCase run() method when the test
313
fails with an unexpected error.
316
unittest.TestResult.addError(self, test, err)
317
self.error_count += 1
318
self.report_error(test, err)
321
self._cleanupLogFile(test)
323
def addFailure(self, test, err):
324
"""Tell result that test failed.
326
Called from the TestCase run() method when the test
327
fails because e.g. an assert() method failed.
330
unittest.TestResult.addFailure(self, test, err)
331
self.failure_count += 1
332
self.report_failure(test, err)
335
self._cleanupLogFile(test)
337
def addSuccess(self, test, details=None):
338
"""Tell result that test completed successfully.
340
Called from the TestCase run()
342
if self._bench_history is not None:
343
benchmark_time = self._extractBenchmarkTime(test, details)
344
if benchmark_time is not None:
345
self._bench_history.write("%s %s\n" % (
346
self._formatTime(benchmark_time),
348
self.report_success(test)
349
self._cleanupLogFile(test)
350
unittest.TestResult.addSuccess(self, test)
351
test._log_contents = ''
353
def addExpectedFailure(self, test, err):
354
self.known_failure_count += 1
355
self.report_known_failure(test, err)
357
def addNotSupported(self, test, feature):
358
"""The test will not be run because of a missing feature.
360
# this can be called in two different ways: it may be that the
361
# test started running, and then raised (through requireFeature)
362
# UnavailableFeature. Alternatively this method can be called
363
# while probing for features before running the test code proper; in
364
# that case we will see startTest and stopTest, but the test will
365
# never actually run.
366
self.unsupported.setdefault(str(feature), 0)
367
self.unsupported[str(feature)] += 1
368
self.report_unsupported(test, feature)
370
def addSkip(self, test, reason):
371
"""A test has not run for 'reason'."""
373
self.report_skip(test, reason)
375
def addNotApplicable(self, test, reason):
376
self.not_applicable_count += 1
377
self.report_not_applicable(test, reason)
379
def _post_mortem(self):
380
"""Start a PDB post mortem session."""
381
if os.environ.get('BZR_TEST_PDB', None):
382
import pdb;pdb.post_mortem()
384
def progress(self, offset, whence):
385
"""The test is adjusting the count of tests to run."""
386
if whence == SUBUNIT_SEEK_SET:
387
self.num_tests = offset
388
elif whence == SUBUNIT_SEEK_CUR:
389
self.num_tests += offset
391
raise errors.BzrError("Unknown whence %r" % whence)
393
def report_cleaning_up(self):
396
def startTestRun(self):
397
self.startTime = time.time()
399
def report_success(self, test):
402
def wasStrictlySuccessful(self):
403
if self.unsupported or self.known_failure_count:
405
return self.wasSuccessful()
408
class TextTestResult(ExtendedTestResult):
409
"""Displays progress and results of tests in text form"""
411
def __init__(self, stream, descriptions, verbosity,
416
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
417
bench_history, strict)
418
# We no longer pass them around, but just rely on the UIFactory stack
421
warnings.warn("Passing pb to TextTestResult is deprecated")
422
self.pb = self.ui.nested_progress_bar()
423
self.pb.show_pct = False
424
self.pb.show_spinner = False
425
self.pb.show_eta = False,
426
self.pb.show_count = False
427
self.pb.show_bar = False
428
self.pb.update_latency = 0
429
self.pb.show_transport_activity = False
431
def stopTestRun(self):
432
# called when the tests that are going to run have run
435
super(TextTestResult, self).stopTestRun()
437
def startTestRun(self):
438
super(TextTestResult, self).startTestRun()
439
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
441
def printErrors(self):
442
# clear the pb to make room for the error listing
444
super(TextTestResult, self).printErrors()
446
def _progress_prefix_text(self):
447
# the longer this text, the less space we have to show the test
449
a = '[%d' % self.count # total that have been run
450
# tests skipped as known not to be relevant are not important enough
452
## if self.skip_count:
453
## a += ', %d skip' % self.skip_count
454
## if self.known_failure_count:
455
## a += '+%dX' % self.known_failure_count
457
a +='/%d' % self.num_tests
459
runtime = time.time() - self._overall_start_time
461
a += '%dm%ds' % (runtime / 60, runtime % 60)
464
total_fail_count = self.error_count + self.failure_count
466
a += ', %d failed' % total_fail_count
467
# if self.unsupported:
468
# a += ', %d missing' % len(self.unsupported)
472
def report_test_start(self, test):
475
self._progress_prefix_text()
477
+ self._shortened_test_description(test))
479
def _test_description(self, test):
480
return self._shortened_test_description(test)
482
def report_error(self, test, err):
483
ui.ui_factory.note('ERROR: %s\n %s\n' % (
484
self._test_description(test),
488
def report_failure(self, test, err):
489
ui.ui_factory.note('FAIL: %s\n %s\n' % (
490
self._test_description(test),
494
def report_known_failure(self, test, err):
497
def report_skip(self, test, reason):
500
def report_not_applicable(self, test, reason):
503
def report_unsupported(self, test, feature):
504
"""test cannot be run because feature is missing."""
506
def report_cleaning_up(self):
507
self.pb.update('Cleaning up')
510
class VerboseTestResult(ExtendedTestResult):
511
"""Produce long output, with one line per test run plus times"""
513
def _ellipsize_to_right(self, a_string, final_width):
514
"""Truncate and pad a string, keeping the right hand side"""
515
if len(a_string) > final_width:
516
result = '...' + a_string[3-final_width:]
519
return result.ljust(final_width)
521
def startTestRun(self):
522
super(VerboseTestResult, self).startTestRun()
523
self.stream.write('running %d tests...\n' % self.num_tests)
525
def report_test_start(self, test):
527
name = self._shortened_test_description(test)
528
width = osutils.terminal_width()
529
if width is not None:
530
# width needs space for 6 char status, plus 1 for slash, plus an
531
# 11-char time string, plus a trailing blank
532
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
534
self.stream.write(self._ellipsize_to_right(name, width-18))
536
self.stream.write(name)
539
def _error_summary(self, err):
541
return '%s%s' % (indent, err[1])
543
def report_error(self, test, err):
544
self.stream.writeln('ERROR %s\n%s'
545
% (self._testTimeString(test),
546
self._error_summary(err)))
548
def report_failure(self, test, err):
549
self.stream.writeln(' FAIL %s\n%s'
550
% (self._testTimeString(test),
551
self._error_summary(err)))
553
def report_known_failure(self, test, err):
554
self.stream.writeln('XFAIL %s\n%s'
555
% (self._testTimeString(test),
556
self._error_summary(err)))
558
def report_success(self, test):
559
self.stream.writeln(' OK %s' % self._testTimeString(test))
560
for bench_called, stats in getattr(test, '_benchcalls', []):
561
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
562
stats.pprint(file=self.stream)
563
# flush the stream so that we get smooth output. This verbose mode is
564
# used to show the output in PQM.
567
def report_skip(self, test, reason):
568
self.stream.writeln(' SKIP %s\n%s'
569
% (self._testTimeString(test), reason))
571
def report_not_applicable(self, test, reason):
572
self.stream.writeln(' N/A %s\n %s'
573
% (self._testTimeString(test), reason))
575
def report_unsupported(self, test, feature):
576
"""test cannot be run because feature is missing."""
577
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
578
%(self._testTimeString(test), feature))
581
class TextTestRunner(object):
582
stop_on_failure = False
590
result_decorators=None,
592
"""Create a TextTestRunner.
594
:param result_decorators: An optional list of decorators to apply
595
to the result object being used by the runner. Decorators are
596
applied left to right - the first element in the list is the
599
# stream may know claim to know to write unicode strings, but in older
600
# pythons this goes sufficiently wrong that it is a bad idea. (
601
# specifically a built in file with encoding 'UTF-8' will still try
602
# to encode using ascii.
603
new_encoding = osutils.get_terminal_encoding()
604
codec = codecs.lookup(new_encoding)
605
if type(codec) is tuple:
609
encode = codec.encode
610
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
611
stream.encoding = new_encoding
612
self.stream = unittest._WritelnDecorator(stream)
613
self.descriptions = descriptions
614
self.verbosity = verbosity
615
self._bench_history = bench_history
616
self._strict = strict
617
self._result_decorators = result_decorators or []
620
"Run the given test case or test suite."
621
if self.verbosity == 1:
622
result_class = TextTestResult
623
elif self.verbosity >= 2:
624
result_class = VerboseTestResult
625
original_result = result_class(self.stream,
628
bench_history=self._bench_history,
631
# Signal to result objects that look at stop early policy to stop,
632
original_result.stop_early = self.stop_on_failure
633
result = original_result
634
for decorator in self._result_decorators:
635
result = decorator(result)
636
result.stop_early = self.stop_on_failure
637
result.startTestRun()
642
# higher level code uses our extended protocol to determine
643
# what exit code to give.
644
return original_result
647
def iter_suite_tests(suite):
648
"""Return all tests in a suite, recursing through nested suites"""
649
if isinstance(suite, unittest.TestCase):
651
elif isinstance(suite, unittest.TestSuite):
653
for r in iter_suite_tests(item):
656
raise Exception('unknown type %r for object %r'
657
% (type(suite), suite))
660
TestSkipped = testtools.testcase.TestSkipped
663
class TestNotApplicable(TestSkipped):
664
"""A test is not applicable to the situation where it was run.
666
This is only normally raised by parameterized tests, if they find that
667
the instance they're constructed upon does not support one aspect
672
# traceback._some_str fails to format exceptions that have the default
673
# __str__ which does an implicit ascii conversion. However, repr() on those
674
# objects works, for all that its not quite what the doctor may have ordered.
675
def _clever_some_str(value):
680
return repr(value).replace('\\n', '\n')
682
return '<unprintable %s object>' % type(value).__name__
684
traceback._some_str = _clever_some_str
687
# deprecated - use self.knownFailure(), or self.expectFailure.
688
KnownFailure = testtools.testcase._ExpectedFailure
691
class UnavailableFeature(Exception):
692
"""A feature required for this test was not available.
694
This can be considered a specialised form of SkippedTest.
696
The feature should be used to construct the exception.
700
class CommandFailed(Exception):
704
class StringIOWrapper(object):
705
"""A wrapper around cStringIO which just adds an encoding attribute.
707
Internally we can check sys.stdout to see what the output encoding
708
should be. However, cStringIO has no encoding attribute that we can
709
set. So we wrap it instead.
714
def __init__(self, s=None):
716
self.__dict__['_cstring'] = StringIO(s)
718
self.__dict__['_cstring'] = StringIO()
720
def __getattr__(self, name, getattr=getattr):
721
return getattr(self.__dict__['_cstring'], name)
723
def __setattr__(self, name, val):
724
if name == 'encoding':
725
self.__dict__['encoding'] = val
727
return setattr(self._cstring, name, val)
730
class TestUIFactory(TextUIFactory):
731
"""A UI Factory for testing.
733
Hide the progress bar but emit note()s.
735
Allows get_password to be tested without real tty attached.
737
See also CannedInputUIFactory which lets you provide programmatic input in
740
# TODO: Capture progress events at the model level and allow them to be
741
# observed by tests that care.
743
# XXX: Should probably unify more with CannedInputUIFactory or a
744
# particular configuration of TextUIFactory, or otherwise have a clearer
745
# idea of how they're supposed to be different.
746
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
748
def __init__(self, stdout=None, stderr=None, stdin=None):
749
if stdin is not None:
750
# We use a StringIOWrapper to be able to test various
751
# encodings, but the user is still responsible to
752
# encode the string and to set the encoding attribute
753
# of StringIOWrapper.
754
stdin = StringIOWrapper(stdin)
755
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
757
def get_non_echoed_password(self):
758
"""Get password from stdin without trying to handle the echo mode"""
759
password = self.stdin.readline()
762
if password[-1] == '\n':
763
password = password[:-1]
766
def make_progress_view(self):
767
return NullProgressView()
770
class TestCase(testtools.TestCase):
771
"""Base class for bzr unit tests.
773
Tests that need access to disk resources should subclass
774
TestCaseInTempDir not TestCase.
776
Error and debug log messages are redirected from their usual
777
location into a temporary file, the contents of which can be
778
retrieved by _get_log(). We use a real OS file, not an in-memory object,
779
so that it can also capture file IO. When the test completes this file
780
is read into memory and removed from disk.
782
There are also convenience functions to invoke bzr's command-line
783
routine, and to build and check bzr trees.
785
In addition to the usual method of overriding tearDown(), this class also
786
allows subclasses to register functions into the _cleanups list, which is
787
run in order as the object is torn down. It's less likely this will be
788
accidentally overlooked.
791
_active_threads = None
792
_leaking_threads_tests = 0
793
_first_thread_leaker_id = None
794
_log_file_name = None
795
# record lsprof data when performing benchmark calls.
796
_gather_lsprof_in_benchmarks = False
798
def __init__(self, methodName='testMethod'):
799
super(TestCase, self).__init__(methodName)
801
self._directory_isolation = True
802
self.exception_handlers.insert(0,
803
(UnavailableFeature, self._do_unsupported_or_skip))
804
self.exception_handlers.insert(0,
805
(TestNotApplicable, self._do_not_applicable))
808
super(TestCase, self).setUp()
809
for feature in getattr(self, '_test_needs_features', []):
810
self.requireFeature(feature)
811
self._log_contents = None
812
self.addDetail("log", content.Content(content.ContentType("text",
813
"plain", {"charset": "utf8"}),
814
lambda:[self._get_log(keep_log_file=True)]))
815
self._cleanEnvironment()
818
self._benchcalls = []
819
self._benchtime = None
821
self._track_transports()
823
self._clear_debug_flags()
824
TestCase._active_threads = threading.activeCount()
825
self.addCleanup(self._check_leaked_threads)
830
pdb.Pdb().set_trace(sys._getframe().f_back)
832
def _check_leaked_threads(self):
833
active = threading.activeCount()
834
leaked_threads = active - TestCase._active_threads
835
TestCase._active_threads = active
836
# If some tests make the number of threads *decrease*, we'll consider
837
# that they are just observing old threads dieing, not agressively kill
838
# random threads. So we don't report these tests as leaking. The risk
839
# is that we have false positives that way (the test see 2 threads
840
# going away but leak one) but it seems less likely than the actual
841
# false positives (the test see threads going away and does not leak).
842
if leaked_threads > 0:
843
TestCase._leaking_threads_tests += 1
844
if TestCase._first_thread_leaker_id is None:
845
TestCase._first_thread_leaker_id = self.id()
847
def _clear_debug_flags(self):
848
"""Prevent externally set debug flags affecting tests.
850
Tests that want to use debug flags can just set them in the
851
debug_flags set during setup/teardown.
853
self._preserved_debug_flags = set(debug.debug_flags)
854
if 'allow_debug' not in selftest_debug_flags:
855
debug.debug_flags.clear()
856
if 'disable_lock_checks' not in selftest_debug_flags:
857
debug.debug_flags.add('strict_locks')
858
self.addCleanup(self._restore_debug_flags)
860
def _clear_hooks(self):
861
# prevent hooks affecting tests
862
self._preserved_hooks = {}
863
for key, factory in hooks.known_hooks.items():
864
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
865
current_hooks = hooks.known_hooks_key_to_object(key)
866
self._preserved_hooks[parent] = (name, current_hooks)
867
self.addCleanup(self._restoreHooks)
868
for key, factory in hooks.known_hooks.items():
869
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
870
setattr(parent, name, factory())
871
# this hook should always be installed
872
request._install_hook()
874
def disable_directory_isolation(self):
875
"""Turn off directory isolation checks."""
876
self._directory_isolation = False
878
def enable_directory_isolation(self):
879
"""Enable directory isolation checks."""
880
self._directory_isolation = True
882
def _silenceUI(self):
883
"""Turn off UI for duration of test"""
884
# by default the UI is off; tests can turn it on if they want it.
885
saved = ui.ui_factory
887
ui.ui_factory = saved
888
ui.ui_factory = ui.SilentUIFactory()
889
self.addCleanup(_restore)
891
def _check_locks(self):
892
"""Check that all lock take/release actions have been paired."""
893
# We always check for mismatched locks. If a mismatch is found, we
894
# fail unless -Edisable_lock_checks is supplied to selftest, in which
895
# case we just print a warning.
897
acquired_locks = [lock for action, lock in self._lock_actions
898
if action == 'acquired']
899
released_locks = [lock for action, lock in self._lock_actions
900
if action == 'released']
901
broken_locks = [lock for action, lock in self._lock_actions
902
if action == 'broken']
903
# trivially, given the tests for lock acquistion and release, if we
904
# have as many in each list, it should be ok. Some lock tests also
905
# break some locks on purpose and should be taken into account by
906
# considering that breaking a lock is just a dirty way of releasing it.
907
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
908
message = ('Different number of acquired and '
909
'released or broken locks. (%s, %s + %s)' %
910
(acquired_locks, released_locks, broken_locks))
911
if not self._lock_check_thorough:
912
# Rather than fail, just warn
913
print "Broken test %s: %s" % (self, message)
917
def _track_locks(self):
918
"""Track lock activity during tests."""
919
self._lock_actions = []
920
if 'disable_lock_checks' in selftest_debug_flags:
921
self._lock_check_thorough = False
923
self._lock_check_thorough = True
925
self.addCleanup(self._check_locks)
926
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
927
self._lock_acquired, None)
928
_mod_lock.Lock.hooks.install_named_hook('lock_released',
929
self._lock_released, None)
930
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
931
self._lock_broken, None)
933
def _lock_acquired(self, result):
934
self._lock_actions.append(('acquired', result))
936
def _lock_released(self, result):
937
self._lock_actions.append(('released', result))
939
def _lock_broken(self, result):
940
self._lock_actions.append(('broken', result))
942
def permit_dir(self, name):
943
"""Permit a directory to be used by this test. See permit_url."""
944
name_transport = get_transport(name)
945
self.permit_url(name)
946
self.permit_url(name_transport.base)
948
def permit_url(self, url):
949
"""Declare that url is an ok url to use in this test.
951
Do this for memory transports, temporary test directory etc.
953
Do not do this for the current working directory, /tmp, or any other
954
preexisting non isolated url.
956
if not url.endswith('/'):
958
self._bzr_selftest_roots.append(url)
960
def permit_source_tree_branch_repo(self):
961
"""Permit the source tree bzr is running from to be opened.
963
Some code such as bzrlib.version attempts to read from the bzr branch
964
that bzr is executing from (if any). This method permits that directory
965
to be used in the test suite.
967
path = self.get_source_path()
968
self.record_directory_isolation()
971
workingtree.WorkingTree.open(path)
972
except (errors.NotBranchError, errors.NoWorkingTree):
975
self.enable_directory_isolation()
977
def _preopen_isolate_transport(self, transport):
978
"""Check that all transport openings are done in the test work area."""
979
while isinstance(transport, pathfilter.PathFilteringTransport):
980
# Unwrap pathfiltered transports
981
transport = transport.server.backing_transport.clone(
982
transport._filter('.'))
984
# ReadonlySmartTCPServer_for_testing decorates the backing transport
985
# urls it is given by prepending readonly+. This is appropriate as the
986
# client shouldn't know that the server is readonly (or not readonly).
987
# We could register all servers twice, with readonly+ prepending, but
988
# that makes for a long list; this is about the same but easier to
990
if url.startswith('readonly+'):
991
url = url[len('readonly+'):]
992
self._preopen_isolate_url(url)
994
def _preopen_isolate_url(self, url):
995
if not self._directory_isolation:
997
if self._directory_isolation == 'record':
998
self._bzr_selftest_roots.append(url)
1000
# This prevents all transports, including e.g. sftp ones backed on disk
1001
# from working unless they are explicitly granted permission. We then
1002
# depend on the code that sets up test transports to check that they are
1003
# appropriately isolated and enable their use by calling
1004
# self.permit_transport()
1005
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1006
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1007
% (url, self._bzr_selftest_roots))
1009
def record_directory_isolation(self):
1010
"""Gather accessed directories to permit later access.
1012
This is used for tests that access the branch bzr is running from.
1014
self._directory_isolation = "record"
1016
def start_server(self, transport_server, backing_server=None):
1017
"""Start transport_server for this test.
1019
This starts the server, registers a cleanup for it and permits the
1020
server's urls to be used.
1022
if backing_server is None:
1023
transport_server.start_server()
1025
transport_server.start_server(backing_server)
1026
self.addCleanup(transport_server.stop_server)
1027
# Obtain a real transport because if the server supplies a password, it
1028
# will be hidden from the base on the client side.
1029
t = get_transport(transport_server.get_url())
1030
# Some transport servers effectively chroot the backing transport;
1031
# others like SFTPServer don't - users of the transport can walk up the
1032
# transport to read the entire backing transport. This wouldn't matter
1033
# except that the workdir tests are given - and that they expect the
1034
# server's url to point at - is one directory under the safety net. So
1035
# Branch operations into the transport will attempt to walk up one
1036
# directory. Chrooting all servers would avoid this but also mean that
1037
# we wouldn't be testing directly against non-root urls. Alternatively
1038
# getting the test framework to start the server with a backing server
1039
# at the actual safety net directory would work too, but this then
1040
# means that the self.get_url/self.get_transport methods would need
1041
# to transform all their results. On balance its cleaner to handle it
1042
# here, and permit a higher url when we have one of these transports.
1043
if t.base.endswith('/work/'):
1044
# we have safety net/test root/work
1045
t = t.clone('../..')
1046
elif isinstance(transport_server, server.SmartTCPServer_for_testing):
1047
# The smart server adds a path similar to work, which is traversed
1048
# up from by the client. But the server is chrooted - the actual
1049
# backing transport is not escaped from, and VFS requests to the
1050
# root will error (because they try to escape the chroot).
1052
while t2.base != t.base:
1055
self.permit_url(t.base)
1057
def _track_transports(self):
1058
"""Install checks for transport usage."""
1059
# TestCase has no safe place it can write to.
1060
self._bzr_selftest_roots = []
1061
# Currently the easiest way to be sure that nothing is going on is to
1062
# hook into bzr dir opening. This leaves a small window of error for
1063
# transport tests, but they are well known, and we can improve on this
1065
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1066
self._preopen_isolate_transport, "Check bzr directories are safe.")
1068
def _ndiff_strings(self, a, b):
1069
"""Return ndiff between two strings containing lines.
1071
A trailing newline is added if missing to make the strings
1073
if b and b[-1] != '\n':
1075
if a and a[-1] != '\n':
1077
difflines = difflib.ndiff(a.splitlines(True),
1079
linejunk=lambda x: False,
1080
charjunk=lambda x: False)
1081
return ''.join(difflines)
1083
def assertEqual(self, a, b, message=''):
1087
except UnicodeError, e:
1088
# If we can't compare without getting a UnicodeError, then
1089
# obviously they are different
1090
mutter('UnicodeError: %s', e)
1093
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1095
pformat(a), pformat(b)))
1097
assertEquals = assertEqual
1099
def assertEqualDiff(self, a, b, message=None):
1100
"""Assert two texts are equal, if not raise an exception.
1102
This is intended for use with multi-line strings where it can
1103
be hard to find the differences by eye.
1105
# TODO: perhaps override assertEquals to call this for strings?
1109
message = "texts not equal:\n"
1111
message = 'first string is missing a final newline.\n'
1113
message = 'second string is missing a final newline.\n'
1114
raise AssertionError(message +
1115
self._ndiff_strings(a, b))
1117
def assertEqualMode(self, mode, mode_test):
1118
self.assertEqual(mode, mode_test,
1119
'mode mismatch %o != %o' % (mode, mode_test))
1121
def assertEqualStat(self, expected, actual):
1122
"""assert that expected and actual are the same stat result.
1124
:param expected: A stat result.
1125
:param actual: A stat result.
1126
:raises AssertionError: If the expected and actual stat values differ
1127
other than by atime.
1129
self.assertEqual(expected.st_size, actual.st_size,
1130
'st_size did not match')
1131
self.assertEqual(expected.st_mtime, actual.st_mtime,
1132
'st_mtime did not match')
1133
self.assertEqual(expected.st_ctime, actual.st_ctime,
1134
'st_ctime did not match')
1135
if sys.platform != 'win32':
1136
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1137
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1138
# odd. Regardless we shouldn't actually try to assert anything
1139
# about their values
1140
self.assertEqual(expected.st_dev, actual.st_dev,
1141
'st_dev did not match')
1142
self.assertEqual(expected.st_ino, actual.st_ino,
1143
'st_ino did not match')
1144
self.assertEqual(expected.st_mode, actual.st_mode,
1145
'st_mode did not match')
1147
def assertLength(self, length, obj_with_len):
1148
"""Assert that obj_with_len is of length length."""
1149
if len(obj_with_len) != length:
1150
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1151
length, len(obj_with_len), obj_with_len))
1153
def assertLogsError(self, exception_class, func, *args, **kwargs):
1154
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1156
from bzrlib import trace
1158
orig_log_exception_quietly = trace.log_exception_quietly
1161
orig_log_exception_quietly()
1162
captured.append(sys.exc_info())
1163
trace.log_exception_quietly = capture
1164
func(*args, **kwargs)
1166
trace.log_exception_quietly = orig_log_exception_quietly
1167
self.assertLength(1, captured)
1168
err = captured[0][1]
1169
self.assertIsInstance(err, exception_class)
1172
def assertPositive(self, val):
1173
"""Assert that val is greater than 0."""
1174
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1176
def assertNegative(self, val):
1177
"""Assert that val is less than 0."""
1178
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1180
def assertStartsWith(self, s, prefix):
1181
if not s.startswith(prefix):
1182
raise AssertionError('string %r does not start with %r' % (s, prefix))
1184
def assertEndsWith(self, s, suffix):
1185
"""Asserts that s ends with suffix."""
1186
if not s.endswith(suffix):
1187
raise AssertionError('string %r does not end with %r' % (s, suffix))
1189
def assertContainsRe(self, haystack, needle_re, flags=0):
1190
"""Assert that a contains something matching a regular expression."""
1191
if not re.search(needle_re, haystack, flags):
1192
if '\n' in haystack or len(haystack) > 60:
1193
# a long string, format it in a more readable way
1194
raise AssertionError(
1195
'pattern "%s" not found in\n"""\\\n%s"""\n'
1196
% (needle_re, haystack))
1198
raise AssertionError('pattern "%s" not found in "%s"'
1199
% (needle_re, haystack))
1201
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1202
"""Assert that a does not match a regular expression"""
1203
if re.search(needle_re, haystack, flags):
1204
raise AssertionError('pattern "%s" found in "%s"'
1205
% (needle_re, haystack))
1207
def assertSubset(self, sublist, superlist):
1208
"""Assert that every entry in sublist is present in superlist."""
1209
missing = set(sublist) - set(superlist)
1210
if len(missing) > 0:
1211
raise AssertionError("value(s) %r not present in container %r" %
1212
(missing, superlist))
1214
def assertListRaises(self, excClass, func, *args, **kwargs):
1215
"""Fail unless excClass is raised when the iterator from func is used.
1217
Many functions can return generators this makes sure
1218
to wrap them in a list() call to make sure the whole generator
1219
is run, and that the proper exception is raised.
1222
list(func(*args, **kwargs))
1226
if getattr(excClass,'__name__', None) is not None:
1227
excName = excClass.__name__
1229
excName = str(excClass)
1230
raise self.failureException, "%s not raised" % excName
1232
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1233
"""Assert that a callable raises a particular exception.
1235
:param excClass: As for the except statement, this may be either an
1236
exception class, or a tuple of classes.
1237
:param callableObj: A callable, will be passed ``*args`` and
1240
Returns the exception so that you can examine it.
1243
callableObj(*args, **kwargs)
1247
if getattr(excClass,'__name__', None) is not None:
1248
excName = excClass.__name__
1251
excName = str(excClass)
1252
raise self.failureException, "%s not raised" % excName
1254
def assertIs(self, left, right, message=None):
1255
if not (left is right):
1256
if message is not None:
1257
raise AssertionError(message)
1259
raise AssertionError("%r is not %r." % (left, right))
1261
def assertIsNot(self, left, right, message=None):
1263
if message is not None:
1264
raise AssertionError(message)
1266
raise AssertionError("%r is %r." % (left, right))
1268
def assertTransportMode(self, transport, path, mode):
1269
"""Fail if a path does not have mode "mode".
1271
If modes are not supported on this transport, the assertion is ignored.
1273
if not transport._can_roundtrip_unix_modebits():
1275
path_stat = transport.stat(path)
1276
actual_mode = stat.S_IMODE(path_stat.st_mode)
1277
self.assertEqual(mode, actual_mode,
1278
'mode of %r incorrect (%s != %s)'
1279
% (path, oct(mode), oct(actual_mode)))
1281
def assertIsSameRealPath(self, path1, path2):
1282
"""Fail if path1 and path2 points to different files"""
1283
self.assertEqual(osutils.realpath(path1),
1284
osutils.realpath(path2),
1285
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1287
def assertIsInstance(self, obj, kls, msg=None):
1288
"""Fail if obj is not an instance of kls
1290
:param msg: Supplementary message to show if the assertion fails.
1292
if not isinstance(obj, kls):
1293
m = "%r is an instance of %s rather than %s" % (
1294
obj, obj.__class__, kls)
1299
def assertFileEqual(self, content, path):
1300
"""Fail if path does not contain 'content'."""
1301
self.failUnlessExists(path)
1302
f = file(path, 'rb')
1307
self.assertEqualDiff(content, s)
1309
def failUnlessExists(self, path):
1310
"""Fail unless path or paths, which may be abs or relative, exist."""
1311
if not isinstance(path, basestring):
1313
self.failUnlessExists(p)
1315
self.failUnless(osutils.lexists(path),path+" does not exist")
1317
def failIfExists(self, path):
1318
"""Fail if path or paths, which may be abs or relative, exist."""
1319
if not isinstance(path, basestring):
1321
self.failIfExists(p)
1323
self.failIf(osutils.lexists(path),path+" exists")
1325
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1326
"""A helper for callDeprecated and applyDeprecated.
1328
:param a_callable: A callable to call.
1329
:param args: The positional arguments for the callable
1330
:param kwargs: The keyword arguments for the callable
1331
:return: A tuple (warnings, result). result is the result of calling
1332
a_callable(``*args``, ``**kwargs``).
1335
def capture_warnings(msg, cls=None, stacklevel=None):
1336
# we've hooked into a deprecation specific callpath,
1337
# only deprecations should getting sent via it.
1338
self.assertEqual(cls, DeprecationWarning)
1339
local_warnings.append(msg)
1340
original_warning_method = symbol_versioning.warn
1341
symbol_versioning.set_warning_method(capture_warnings)
1343
result = a_callable(*args, **kwargs)
1345
symbol_versioning.set_warning_method(original_warning_method)
1346
return (local_warnings, result)
1348
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1349
"""Call a deprecated callable without warning the user.
1351
Note that this only captures warnings raised by symbol_versioning.warn,
1352
not other callers that go direct to the warning module.
1354
To test that a deprecated method raises an error, do something like
1357
self.assertRaises(errors.ReservedId,
1358
self.applyDeprecated,
1359
deprecated_in((1, 5, 0)),
1363
:param deprecation_format: The deprecation format that the callable
1364
should have been deprecated with. This is the same type as the
1365
parameter to deprecated_method/deprecated_function. If the
1366
callable is not deprecated with this format, an assertion error
1368
:param a_callable: A callable to call. This may be a bound method or
1369
a regular function. It will be called with ``*args`` and
1371
:param args: The positional arguments for the callable
1372
:param kwargs: The keyword arguments for the callable
1373
:return: The result of a_callable(``*args``, ``**kwargs``)
1375
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1377
expected_first_warning = symbol_versioning.deprecation_string(
1378
a_callable, deprecation_format)
1379
if len(call_warnings) == 0:
1380
self.fail("No deprecation warning generated by call to %s" %
1382
self.assertEqual(expected_first_warning, call_warnings[0])
1385
def callCatchWarnings(self, fn, *args, **kw):
1386
"""Call a callable that raises python warnings.
1388
The caller's responsible for examining the returned warnings.
1390
If the callable raises an exception, the exception is not
1391
caught and propagates up to the caller. In that case, the list
1392
of warnings is not available.
1394
:returns: ([warning_object, ...], fn_result)
1396
# XXX: This is not perfect, because it completely overrides the
1397
# warnings filters, and some code may depend on suppressing particular
1398
# warnings. It's the easiest way to insulate ourselves from -Werror,
1399
# though. -- Andrew, 20071062
1401
def _catcher(message, category, filename, lineno, file=None, line=None):
1402
# despite the name, 'message' is normally(?) a Warning subclass
1404
wlist.append(message)
1405
saved_showwarning = warnings.showwarning
1406
saved_filters = warnings.filters
1408
warnings.showwarning = _catcher
1409
warnings.filters = []
1410
result = fn(*args, **kw)
1412
warnings.showwarning = saved_showwarning
1413
warnings.filters = saved_filters
1414
return wlist, result
1416
def callDeprecated(self, expected, callable, *args, **kwargs):
1417
"""Assert that a callable is deprecated in a particular way.
1419
This is a very precise test for unusual requirements. The
1420
applyDeprecated helper function is probably more suited for most tests
1421
as it allows you to simply specify the deprecation format being used
1422
and will ensure that that is issued for the function being called.
1424
Note that this only captures warnings raised by symbol_versioning.warn,
1425
not other callers that go direct to the warning module. To catch
1426
general warnings, use callCatchWarnings.
1428
:param expected: a list of the deprecation warnings expected, in order
1429
:param callable: The callable to call
1430
:param args: The positional arguments for the callable
1431
:param kwargs: The keyword arguments for the callable
1433
call_warnings, result = self._capture_deprecation_warnings(callable,
1435
self.assertEqual(expected, call_warnings)
1438
def _startLogFile(self):
1439
"""Send bzr and test log messages to a temporary file.
1441
The file is removed as the test is torn down.
1443
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1444
self._log_file = os.fdopen(fileno, 'w+')
1445
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1446
self._log_file_name = name
1447
self.addCleanup(self._finishLogFile)
1449
def _finishLogFile(self):
1450
"""Finished with the log file.
1452
Close the file and delete it, unless setKeepLogfile was called.
1454
if bzrlib.trace._trace_file:
1455
# flush the log file, to get all content
1456
bzrlib.trace._trace_file.flush()
1457
bzrlib.trace.pop_log_file(self._log_memento)
1458
# Cache the log result and delete the file on disk
1459
self._get_log(False)
1461
def thisFailsStrictLockCheck(self):
1462
"""It is known that this test would fail with -Dstrict_locks.
1464
By default, all tests are run with strict lock checking unless
1465
-Edisable_lock_checks is supplied. However there are some tests which
1466
we know fail strict locks at this point that have not been fixed.
1467
They should call this function to disable the strict checking.
1469
This should be used sparingly, it is much better to fix the locking
1470
issues rather than papering over the problem by calling this function.
1472
debug.debug_flags.discard('strict_locks')
1474
def addCleanup(self, callable, *args, **kwargs):
1475
"""Arrange to run a callable when this case is torn down.
1477
Callables are run in the reverse of the order they are registered,
1478
ie last-in first-out.
1480
self._cleanups.append((callable, args, kwargs))
1482
def _cleanEnvironment(self):
1484
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1485
'HOME': os.getcwd(),
1486
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1487
# tests do check our impls match APPDATA
1488
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1492
'BZREMAIL': None, # may still be present in the environment
1494
'BZR_PROGRESS_BAR': None,
1496
'BZR_PLUGIN_PATH': None,
1497
'BZR_CONCURRENCY': None,
1498
# Make sure that any text ui tests are consistent regardless of
1499
# the environment the test case is run in; you may want tests that
1500
# test other combinations. 'dumb' is a reasonable guess for tests
1501
# going to a pipe or a StringIO.
1505
'BZR_COLUMNS': '80',
1507
'SSH_AUTH_SOCK': None,
1511
'https_proxy': None,
1512
'HTTPS_PROXY': None,
1517
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1518
# least. If you do (care), please update this comment
1522
'BZR_REMOTE_PATH': None,
1525
self.addCleanup(self._restoreEnvironment)
1526
for name, value in new_env.iteritems():
1527
self._captureVar(name, value)
1529
def _captureVar(self, name, newvalue):
1530
"""Set an environment variable, and reset it when finished."""
1531
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1533
def _restore_debug_flags(self):
1534
debug.debug_flags.clear()
1535
debug.debug_flags.update(self._preserved_debug_flags)
1537
def _restoreEnvironment(self):
1538
for name, value in self.__old_env.iteritems():
1539
osutils.set_or_unset_env(name, value)
1541
def _restoreHooks(self):
1542
for klass, (name, hooks) in self._preserved_hooks.items():
1543
setattr(klass, name, hooks)
1545
def knownFailure(self, reason):
1546
"""This test has failed for some known reason."""
1547
raise KnownFailure(reason)
1549
def _do_skip(self, result, reason):
1550
addSkip = getattr(result, 'addSkip', None)
1551
if not callable(addSkip):
1552
result.addSuccess(result)
1554
addSkip(self, reason)
1557
def _do_known_failure(self, result, e):
1558
err = sys.exc_info()
1559
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1560
if addExpectedFailure is not None:
1561
addExpectedFailure(self, err)
1563
result.addSuccess(self)
1566
def _do_not_applicable(self, result, e):
1568
reason = 'No reason given'
1571
addNotApplicable = getattr(result, 'addNotApplicable', None)
1572
if addNotApplicable is not None:
1573
result.addNotApplicable(self, reason)
1575
self._do_skip(result, reason)
1578
def _do_unsupported_or_skip(self, result, e):
1580
addNotSupported = getattr(result, 'addNotSupported', None)
1581
if addNotSupported is not None:
1582
result.addNotSupported(self, reason)
1584
self._do_skip(result, reason)
1586
def time(self, callable, *args, **kwargs):
1587
"""Run callable and accrue the time it takes to the benchmark time.
1589
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1590
this will cause lsprofile statistics to be gathered and stored in
1593
if self._benchtime is None:
1594
self.addDetail('benchtime', content.Content(content.ContentType(
1595
"text", "plain"), lambda:[str(self._benchtime)]))
1599
if not self._gather_lsprof_in_benchmarks:
1600
return callable(*args, **kwargs)
1602
# record this benchmark
1603
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1605
self._benchcalls.append(((callable, args, kwargs), stats))
1608
self._benchtime += time.time() - start
1610
def log(self, *args):
1613
def _get_log(self, keep_log_file=False):
1614
"""Internal helper to get the log from bzrlib.trace for this test.
1616
Please use self.getDetails, or self.get_log to access this in test case
1619
:param keep_log_file: When True, if the log is still a file on disk
1620
leave it as a file on disk. When False, if the log is still a file
1621
on disk, the log file is deleted and the log preserved as
1623
:return: A string containing the log.
1625
if self._log_contents is not None:
1627
self._log_contents.decode('utf8')
1628
except UnicodeDecodeError:
1629
unicodestr = self._log_contents.decode('utf8', 'replace')
1630
self._log_contents = unicodestr.encode('utf8')
1631
return self._log_contents
1633
if bzrlib.trace._trace_file:
1634
# flush the log file, to get all content
1635
bzrlib.trace._trace_file.flush()
1636
if self._log_file_name is not None:
1637
logfile = open(self._log_file_name)
1639
log_contents = logfile.read()
1643
log_contents.decode('utf8')
1644
except UnicodeDecodeError:
1645
unicodestr = log_contents.decode('utf8', 'replace')
1646
log_contents = unicodestr.encode('utf8')
1647
if not keep_log_file:
1648
self._log_file.close()
1649
self._log_file = None
1650
# Permit multiple calls to get_log until we clean it up in
1652
self._log_contents = log_contents
1654
os.remove(self._log_file_name)
1656
if sys.platform == 'win32' and e.errno == errno.EACCES:
1657
sys.stderr.write(('Unable to delete log file '
1658
' %r\n' % self._log_file_name))
1661
self._log_file_name = None
1664
return "No log file content and no log file name."
1667
"""Get a unicode string containing the log from bzrlib.trace.
1669
Undecodable characters are replaced.
1671
return u"".join(self.getDetails()['log'].iter_text())
1673
def requireFeature(self, feature):
1674
"""This test requires a specific feature is available.
1676
:raises UnavailableFeature: When feature is not available.
1678
if not feature.available():
1679
raise UnavailableFeature(feature)
1681
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1683
"""Run bazaar command line, splitting up a string command line."""
1684
if isinstance(args, basestring):
1685
# shlex don't understand unicode strings,
1686
# so args should be plain string (bialix 20070906)
1687
args = list(shlex.split(str(args)))
1688
return self._run_bzr_core(args, retcode=retcode,
1689
encoding=encoding, stdin=stdin, working_dir=working_dir,
1692
def _run_bzr_core(self, args, retcode, encoding, stdin,
1694
# Clear chk_map page cache, because the contents are likely to mask
1696
chk_map.clear_cache()
1697
if encoding is None:
1698
encoding = osutils.get_user_encoding()
1699
stdout = StringIOWrapper()
1700
stderr = StringIOWrapper()
1701
stdout.encoding = encoding
1702
stderr.encoding = encoding
1704
self.log('run bzr: %r', args)
1705
# FIXME: don't call into logging here
1706
handler = logging.StreamHandler(stderr)
1707
handler.setLevel(logging.INFO)
1708
logger = logging.getLogger('')
1709
logger.addHandler(handler)
1710
old_ui_factory = ui.ui_factory
1711
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1714
if working_dir is not None:
1715
cwd = osutils.getcwd()
1716
os.chdir(working_dir)
1720
result = self.apply_redirected(ui.ui_factory.stdin,
1722
bzrlib.commands.run_bzr_catch_user_errors,
1724
except KeyboardInterrupt:
1725
# Reraise KeyboardInterrupt with contents of redirected stdout
1726
# and stderr as arguments, for tests which are interested in
1727
# stdout and stderr and are expecting the exception.
1728
out = stdout.getvalue()
1729
err = stderr.getvalue()
1731
self.log('output:\n%r', out)
1733
self.log('errors:\n%r', err)
1734
raise KeyboardInterrupt(out, err)
1736
logger.removeHandler(handler)
1737
ui.ui_factory = old_ui_factory
1741
out = stdout.getvalue()
1742
err = stderr.getvalue()
1744
self.log('output:\n%r', out)
1746
self.log('errors:\n%r', err)
1747
if retcode is not None:
1748
self.assertEquals(retcode, result,
1749
message='Unexpected return code')
1750
return result, out, err
1752
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1753
working_dir=None, error_regexes=[], output_encoding=None):
1754
"""Invoke bzr, as if it were run from the command line.
1756
The argument list should not include the bzr program name - the
1757
first argument is normally the bzr command. Arguments may be
1758
passed in three ways:
1760
1- A list of strings, eg ["commit", "a"]. This is recommended
1761
when the command contains whitespace or metacharacters, or
1762
is built up at run time.
1764
2- A single string, eg "add a". This is the most convenient
1765
for hardcoded commands.
1767
This runs bzr through the interface that catches and reports
1768
errors, and with logging set to something approximating the
1769
default, so that error reporting can be checked.
1771
This should be the main method for tests that want to exercise the
1772
overall behavior of the bzr application (rather than a unit test
1773
or a functional test of the library.)
1775
This sends the stdout/stderr results into the test's log,
1776
where it may be useful for debugging. See also run_captured.
1778
:keyword stdin: A string to be used as stdin for the command.
1779
:keyword retcode: The status code the command should return;
1781
:keyword working_dir: The directory to run the command in
1782
:keyword error_regexes: A list of expected error messages. If
1783
specified they must be seen in the error output of the command.
1785
retcode, out, err = self._run_bzr_autosplit(
1790
working_dir=working_dir,
1792
self.assertIsInstance(error_regexes, (list, tuple))
1793
for regex in error_regexes:
1794
self.assertContainsRe(err, regex)
1797
def run_bzr_error(self, error_regexes, *args, **kwargs):
1798
"""Run bzr, and check that stderr contains the supplied regexes
1800
:param error_regexes: Sequence of regular expressions which
1801
must each be found in the error output. The relative ordering
1803
:param args: command-line arguments for bzr
1804
:param kwargs: Keyword arguments which are interpreted by run_bzr
1805
This function changes the default value of retcode to be 3,
1806
since in most cases this is run when you expect bzr to fail.
1808
:return: (out, err) The actual output of running the command (in case
1809
you want to do more inspection)
1813
# Make sure that commit is failing because there is nothing to do
1814
self.run_bzr_error(['no changes to commit'],
1815
['commit', '-m', 'my commit comment'])
1816
# Make sure --strict is handling an unknown file, rather than
1817
# giving us the 'nothing to do' error
1818
self.build_tree(['unknown'])
1819
self.run_bzr_error(['Commit refused because there are unknown files'],
1820
['commit', --strict', '-m', 'my commit comment'])
1822
kwargs.setdefault('retcode', 3)
1823
kwargs['error_regexes'] = error_regexes
1824
out, err = self.run_bzr(*args, **kwargs)
1827
def run_bzr_subprocess(self, *args, **kwargs):
1828
"""Run bzr in a subprocess for testing.
1830
This starts a new Python interpreter and runs bzr in there.
1831
This should only be used for tests that have a justifiable need for
1832
this isolation: e.g. they are testing startup time, or signal
1833
handling, or early startup code, etc. Subprocess code can't be
1834
profiled or debugged so easily.
1836
:keyword retcode: The status code that is expected. Defaults to 0. If
1837
None is supplied, the status code is not checked.
1838
:keyword env_changes: A dictionary which lists changes to environment
1839
variables. A value of None will unset the env variable.
1840
The values must be strings. The change will only occur in the
1841
child, so you don't need to fix the environment after running.
1842
:keyword universal_newlines: Convert CRLF => LF
1843
:keyword allow_plugins: By default the subprocess is run with
1844
--no-plugins to ensure test reproducibility. Also, it is possible
1845
for system-wide plugins to create unexpected output on stderr,
1846
which can cause unnecessary test failures.
1848
env_changes = kwargs.get('env_changes', {})
1849
working_dir = kwargs.get('working_dir', None)
1850
allow_plugins = kwargs.get('allow_plugins', False)
1852
if isinstance(args[0], list):
1854
elif isinstance(args[0], basestring):
1855
args = list(shlex.split(args[0]))
1857
raise ValueError("passing varargs to run_bzr_subprocess")
1858
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1859
working_dir=working_dir,
1860
allow_plugins=allow_plugins)
1861
# We distinguish between retcode=None and retcode not passed.
1862
supplied_retcode = kwargs.get('retcode', 0)
1863
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1864
universal_newlines=kwargs.get('universal_newlines', False),
1867
def start_bzr_subprocess(self, process_args, env_changes=None,
1868
skip_if_plan_to_signal=False,
1870
allow_plugins=False):
1871
"""Start bzr in a subprocess for testing.
1873
This starts a new Python interpreter and runs bzr in there.
1874
This should only be used for tests that have a justifiable need for
1875
this isolation: e.g. they are testing startup time, or signal
1876
handling, or early startup code, etc. Subprocess code can't be
1877
profiled or debugged so easily.
1879
:param process_args: a list of arguments to pass to the bzr executable,
1880
for example ``['--version']``.
1881
:param env_changes: A dictionary which lists changes to environment
1882
variables. A value of None will unset the env variable.
1883
The values must be strings. The change will only occur in the
1884
child, so you don't need to fix the environment after running.
1885
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1887
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1889
:returns: Popen object for the started process.
1891
if skip_if_plan_to_signal:
1892
if not getattr(os, 'kill', None):
1893
raise TestSkipped("os.kill not available.")
1895
if env_changes is None:
1899
def cleanup_environment():
1900
for env_var, value in env_changes.iteritems():
1901
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1903
def restore_environment():
1904
for env_var, value in old_env.iteritems():
1905
osutils.set_or_unset_env(env_var, value)
1907
bzr_path = self.get_bzr_path()
1910
if working_dir is not None:
1911
cwd = osutils.getcwd()
1912
os.chdir(working_dir)
1915
# win32 subprocess doesn't support preexec_fn
1916
# so we will avoid using it on all platforms, just to
1917
# make sure the code path is used, and we don't break on win32
1918
cleanup_environment()
1919
command = [sys.executable]
1920
# frozen executables don't need the path to bzr
1921
if getattr(sys, "frozen", None) is None:
1922
command.append(bzr_path)
1923
if not allow_plugins:
1924
command.append('--no-plugins')
1925
command.extend(process_args)
1926
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1928
restore_environment()
1934
def _popen(self, *args, **kwargs):
1935
"""Place a call to Popen.
1937
Allows tests to override this method to intercept the calls made to
1938
Popen for introspection.
1940
return Popen(*args, **kwargs)
1942
def get_source_path(self):
1943
"""Return the path of the directory containing bzrlib."""
1944
return os.path.dirname(os.path.dirname(bzrlib.__file__))
1946
def get_bzr_path(self):
1947
"""Return the path of the 'bzr' executable for this test suite."""
1948
bzr_path = self.get_source_path()+'/bzr'
1949
if not os.path.isfile(bzr_path):
1950
# We are probably installed. Assume sys.argv is the right file
1951
bzr_path = sys.argv[0]
1954
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1955
universal_newlines=False, process_args=None):
1956
"""Finish the execution of process.
1958
:param process: the Popen object returned from start_bzr_subprocess.
1959
:param retcode: The status code that is expected. Defaults to 0. If
1960
None is supplied, the status code is not checked.
1961
:param send_signal: an optional signal to send to the process.
1962
:param universal_newlines: Convert CRLF => LF
1963
:returns: (stdout, stderr)
1965
if send_signal is not None:
1966
os.kill(process.pid, send_signal)
1967
out, err = process.communicate()
1969
if universal_newlines:
1970
out = out.replace('\r\n', '\n')
1971
err = err.replace('\r\n', '\n')
1973
if retcode is not None and retcode != process.returncode:
1974
if process_args is None:
1975
process_args = "(unknown args)"
1976
mutter('Output of bzr %s:\n%s', process_args, out)
1977
mutter('Error for bzr %s:\n%s', process_args, err)
1978
self.fail('Command bzr %s failed with retcode %s != %s'
1979
% (process_args, retcode, process.returncode))
1982
def check_inventory_shape(self, inv, shape):
1983
"""Compare an inventory to a list of expected names.
1985
Fail if they are not precisely equal.
1988
shape = list(shape) # copy
1989
for path, ie in inv.entries():
1990
name = path.replace('\\', '/')
1991
if ie.kind == 'directory':
1998
self.fail("expected paths not found in inventory: %r" % shape)
2000
self.fail("unexpected paths found in inventory: %r" % extras)
2002
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2003
a_callable=None, *args, **kwargs):
2004
"""Call callable with redirected std io pipes.
2006
Returns the return code."""
2007
if not callable(a_callable):
2008
raise ValueError("a_callable must be callable.")
2010
stdin = StringIO("")
2012
if getattr(self, "_log_file", None) is not None:
2013
stdout = self._log_file
2017
if getattr(self, "_log_file", None is not None):
2018
stderr = self._log_file
2021
real_stdin = sys.stdin
2022
real_stdout = sys.stdout
2023
real_stderr = sys.stderr
2028
return a_callable(*args, **kwargs)
2030
sys.stdout = real_stdout
2031
sys.stderr = real_stderr
2032
sys.stdin = real_stdin
2034
def reduceLockdirTimeout(self):
2035
"""Reduce the default lock timeout for the duration of the test, so that
2036
if LockContention occurs during a test, it does so quickly.
2038
Tests that expect to provoke LockContention errors should call this.
2040
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
2042
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
2043
self.addCleanup(resetTimeout)
2044
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2046
def make_utf8_encoded_stringio(self, encoding_type=None):
2047
"""Return a StringIOWrapper instance, that will encode Unicode
2050
if encoding_type is None:
2051
encoding_type = 'strict'
2053
output_encoding = 'utf-8'
2054
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2055
sio.encoding = output_encoding
2058
def disable_verb(self, verb):
2059
"""Disable a smart server verb for one test."""
2060
from bzrlib.smart import request
2061
request_handlers = request.request_handlers
2062
orig_method = request_handlers.get(verb)
2063
request_handlers.remove(verb)
2065
request_handlers.register(verb, orig_method)
2066
self.addCleanup(restoreVerb)
2069
class CapturedCall(object):
2070
"""A helper for capturing smart server calls for easy debug analysis."""
2072
def __init__(self, params, prefix_length):
2073
"""Capture the call with params and skip prefix_length stack frames."""
2076
# The last 5 frames are the __init__, the hook frame, and 3 smart
2077
# client frames. Beyond this we could get more clever, but this is good
2079
stack = traceback.extract_stack()[prefix_length:-5]
2080
self.stack = ''.join(traceback.format_list(stack))
2083
return self.call.method
2086
return self.call.method
2092
class TestCaseWithMemoryTransport(TestCase):
2093
"""Common test class for tests that do not need disk resources.
2095
Tests that need disk resources should derive from TestCaseWithTransport.
2097
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2099
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2100
a directory which does not exist. This serves to help ensure test isolation
2101
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2102
must exist. However, TestCaseWithMemoryTransport does not offer local
2103
file defaults for the transport in tests, nor does it obey the command line
2104
override, so tests that accidentally write to the common directory should
2107
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2108
a .bzr directory that stops us ascending higher into the filesystem.
2114
def __init__(self, methodName='runTest'):
2115
# allow test parameterization after test construction and before test
2116
# execution. Variables that the parameterizer sets need to be
2117
# ones that are not set by setUp, or setUp will trash them.
2118
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2119
self.vfs_transport_factory = default_transport
2120
self.transport_server = None
2121
self.transport_readonly_server = None
2122
self.__vfs_server = None
2124
def get_transport(self, relpath=None):
2125
"""Return a writeable transport.
2127
This transport is for the test scratch space relative to
2130
:param relpath: a path relative to the base url.
2132
t = get_transport(self.get_url(relpath))
2133
self.assertFalse(t.is_readonly())
2136
def get_readonly_transport(self, relpath=None):
2137
"""Return a readonly transport for the test scratch space
2139
This can be used to test that operations which should only need
2140
readonly access in fact do not try to write.
2142
:param relpath: a path relative to the base url.
2144
t = get_transport(self.get_readonly_url(relpath))
2145
self.assertTrue(t.is_readonly())
2148
def create_transport_readonly_server(self):
2149
"""Create a transport server from class defined at init.
2151
This is mostly a hook for daughter classes.
2153
return self.transport_readonly_server()
2155
def get_readonly_server(self):
2156
"""Get the server instance for the readonly transport
2158
This is useful for some tests with specific servers to do diagnostics.
2160
if self.__readonly_server is None:
2161
if self.transport_readonly_server is None:
2162
# readonly decorator requested
2163
self.__readonly_server = ReadonlyServer()
2165
# explicit readonly transport.
2166
self.__readonly_server = self.create_transport_readonly_server()
2167
self.start_server(self.__readonly_server,
2168
self.get_vfs_only_server())
2169
return self.__readonly_server
2171
def get_readonly_url(self, relpath=None):
2172
"""Get a URL for the readonly transport.
2174
This will either be backed by '.' or a decorator to the transport
2175
used by self.get_url()
2176
relpath provides for clients to get a path relative to the base url.
2177
These should only be downwards relative, not upwards.
2179
base = self.get_readonly_server().get_url()
2180
return self._adjust_url(base, relpath)
2182
def get_vfs_only_server(self):
2183
"""Get the vfs only read/write server instance.
2185
This is useful for some tests with specific servers that need
2188
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2189
is no means to override it.
2191
if self.__vfs_server is None:
2192
self.__vfs_server = MemoryServer()
2193
self.start_server(self.__vfs_server)
2194
return self.__vfs_server
2196
def get_server(self):
2197
"""Get the read/write server instance.
2199
This is useful for some tests with specific servers that need
2202
This is built from the self.transport_server factory. If that is None,
2203
then the self.get_vfs_server is returned.
2205
if self.__server is None:
2206
if (self.transport_server is None or self.transport_server is
2207
self.vfs_transport_factory):
2208
self.__server = self.get_vfs_only_server()
2210
# bring up a decorated means of access to the vfs only server.
2211
self.__server = self.transport_server()
2212
self.start_server(self.__server, self.get_vfs_only_server())
2213
return self.__server
2215
def _adjust_url(self, base, relpath):
2216
"""Get a URL (or maybe a path) for the readwrite transport.
2218
This will either be backed by '.' or to an equivalent non-file based
2220
relpath provides for clients to get a path relative to the base url.
2221
These should only be downwards relative, not upwards.
2223
if relpath is not None and relpath != '.':
2224
if not base.endswith('/'):
2226
# XXX: Really base should be a url; we did after all call
2227
# get_url()! But sometimes it's just a path (from
2228
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2229
# to a non-escaped local path.
2230
if base.startswith('./') or base.startswith('/'):
2233
base += urlutils.escape(relpath)
2236
def get_url(self, relpath=None):
2237
"""Get a URL (or maybe a path) for the readwrite transport.
2239
This will either be backed by '.' or to an equivalent non-file based
2241
relpath provides for clients to get a path relative to the base url.
2242
These should only be downwards relative, not upwards.
2244
base = self.get_server().get_url()
2245
return self._adjust_url(base, relpath)
2247
def get_vfs_only_url(self, relpath=None):
2248
"""Get a URL (or maybe a path for the plain old vfs transport.
2250
This will never be a smart protocol. It always has all the
2251
capabilities of the local filesystem, but it might actually be a
2252
MemoryTransport or some other similar virtual filesystem.
2254
This is the backing transport (if any) of the server returned by
2255
get_url and get_readonly_url.
2257
:param relpath: provides for clients to get a path relative to the base
2258
url. These should only be downwards relative, not upwards.
2261
base = self.get_vfs_only_server().get_url()
2262
return self._adjust_url(base, relpath)
2264
def _create_safety_net(self):
2265
"""Make a fake bzr directory.
2267
This prevents any tests propagating up onto the TEST_ROOT directory's
2270
root = TestCaseWithMemoryTransport.TEST_ROOT
2271
bzrdir.BzrDir.create_standalone_workingtree(root)
2273
def _check_safety_net(self):
2274
"""Check that the safety .bzr directory have not been touched.
2276
_make_test_root have created a .bzr directory to prevent tests from
2277
propagating. This method ensures than a test did not leaked.
2279
root = TestCaseWithMemoryTransport.TEST_ROOT
2280
self.permit_url(get_transport(root).base)
2281
wt = workingtree.WorkingTree.open(root)
2282
last_rev = wt.last_revision()
2283
if last_rev != 'null:':
2284
# The current test have modified the /bzr directory, we need to
2285
# recreate a new one or all the followng tests will fail.
2286
# If you need to inspect its content uncomment the following line
2287
# import pdb; pdb.set_trace()
2288
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2289
self._create_safety_net()
2290
raise AssertionError('%s/.bzr should not be modified' % root)
2292
def _make_test_root(self):
2293
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2294
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2295
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2297
TestCaseWithMemoryTransport.TEST_ROOT = root
2299
self._create_safety_net()
2301
# The same directory is used by all tests, and we're not
2302
# specifically told when all tests are finished. This will do.
2303
atexit.register(_rmtree_temp_dir, root)
2305
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2306
self.addCleanup(self._check_safety_net)
2308
def makeAndChdirToTestDir(self):
2309
"""Create a temporary directories for this one test.
2311
This must set self.test_home_dir and self.test_dir and chdir to
2314
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2316
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2317
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2318
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2319
self.permit_dir(self.test_dir)
2321
def make_branch(self, relpath, format=None):
2322
"""Create a branch on the transport at relpath."""
2323
repo = self.make_repository(relpath, format=format)
2324
return repo.bzrdir.create_branch()
2326
def make_bzrdir(self, relpath, format=None):
2328
# might be a relative or absolute path
2329
maybe_a_url = self.get_url(relpath)
2330
segments = maybe_a_url.rsplit('/', 1)
2331
t = get_transport(maybe_a_url)
2332
if len(segments) > 1 and segments[-1] not in ('', '.'):
2336
if isinstance(format, basestring):
2337
format = bzrdir.format_registry.make_bzrdir(format)
2338
return format.initialize_on_transport(t)
2339
except errors.UninitializableFormat:
2340
raise TestSkipped("Format %s is not initializable." % format)
2342
def make_repository(self, relpath, shared=False, format=None):
2343
"""Create a repository on our default transport at relpath.
2345
Note that relpath must be a relative path, not a full url.
2347
# FIXME: If you create a remoterepository this returns the underlying
2348
# real format, which is incorrect. Actually we should make sure that
2349
# RemoteBzrDir returns a RemoteRepository.
2350
# maybe mbp 20070410
2351
made_control = self.make_bzrdir(relpath, format=format)
2352
return made_control.create_repository(shared=shared)
2354
def make_smart_server(self, path):
2355
smart_server = server.SmartTCPServer_for_testing()
2356
self.start_server(smart_server, self.get_server())
2357
remote_transport = get_transport(smart_server.get_url()).clone(path)
2358
return remote_transport
2360
def make_branch_and_memory_tree(self, relpath, format=None):
2361
"""Create a branch on the default transport and a MemoryTree for it."""
2362
b = self.make_branch(relpath, format=format)
2363
return memorytree.MemoryTree.create_on_branch(b)
2365
def make_branch_builder(self, relpath, format=None):
2366
branch = self.make_branch(relpath, format=format)
2367
return branchbuilder.BranchBuilder(branch=branch)
2369
def overrideEnvironmentForTesting(self):
2370
test_home_dir = self.test_home_dir
2371
if isinstance(test_home_dir, unicode):
2372
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2373
os.environ['HOME'] = test_home_dir
2374
os.environ['BZR_HOME'] = test_home_dir
2377
super(TestCaseWithMemoryTransport, self).setUp()
2378
self._make_test_root()
2379
_currentdir = os.getcwdu()
2380
def _leaveDirectory():
2381
os.chdir(_currentdir)
2382
self.addCleanup(_leaveDirectory)
2383
self.makeAndChdirToTestDir()
2384
self.overrideEnvironmentForTesting()
2385
self.__readonly_server = None
2386
self.__server = None
2387
self.reduceLockdirTimeout()
2389
def setup_smart_server_with_call_log(self):
2390
"""Sets up a smart server as the transport server with a call log."""
2391
self.transport_server = server.SmartTCPServer_for_testing
2392
self.hpss_calls = []
2394
# Skip the current stack down to the caller of
2395
# setup_smart_server_with_call_log
2396
prefix_length = len(traceback.extract_stack()) - 2
2397
def capture_hpss_call(params):
2398
self.hpss_calls.append(
2399
CapturedCall(params, prefix_length))
2400
client._SmartClient.hooks.install_named_hook(
2401
'call', capture_hpss_call, None)
2403
def reset_smart_call_log(self):
2404
self.hpss_calls = []
2407
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2408
"""Derived class that runs a test within a temporary directory.
2410
This is useful for tests that need to create a branch, etc.
2412
The directory is created in a slightly complex way: for each
2413
Python invocation, a new temporary top-level directory is created.
2414
All test cases create their own directory within that. If the
2415
tests complete successfully, the directory is removed.
2417
:ivar test_base_dir: The path of the top-level directory for this
2418
test, which contains a home directory and a work directory.
2420
:ivar test_home_dir: An initially empty directory under test_base_dir
2421
which is used as $HOME for this test.
2423
:ivar test_dir: A directory under test_base_dir used as the current
2424
directory when the test proper is run.
2427
OVERRIDE_PYTHON = 'python'
2429
def check_file_contents(self, filename, expect):
2430
self.log("check contents of file %s" % filename)
2431
contents = file(filename, 'r').read()
2432
if contents != expect:
2433
self.log("expected: %r" % expect)
2434
self.log("actually: %r" % contents)
2435
self.fail("contents of %s not as expected" % filename)
2437
def _getTestDirPrefix(self):
2438
# create a directory within the top level test directory
2439
if sys.platform in ('win32', 'cygwin'):
2440
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2441
# windows is likely to have path-length limits so use a short name
2442
name_prefix = name_prefix[-30:]
2444
name_prefix = re.sub('[/]', '_', self.id())
2447
def makeAndChdirToTestDir(self):
2448
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2450
For TestCaseInTempDir we create a temporary directory based on the test
2451
name and then create two subdirs - test and home under it.
2453
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2454
self._getTestDirPrefix())
2456
for i in range(100):
2457
if os.path.exists(name):
2458
name = name_prefix + '_' + str(i)
2460
# now create test and home directories within this dir
2461
self.test_base_dir = name
2462
self.addCleanup(self.deleteTestDir)
2463
os.mkdir(self.test_base_dir)
2465
self.permit_dir(self.test_base_dir)
2466
# 'sprouting' and 'init' of a branch both walk up the tree to find
2467
# stacking policy to honour; create a bzr dir with an unshared
2468
# repository (but not a branch - our code would be trying to escape
2469
# then!) to stop them, and permit it to be read.
2470
# control = bzrdir.BzrDir.create(self.test_base_dir)
2471
# control.create_repository()
2472
self.test_home_dir = self.test_base_dir + '/home'
2473
os.mkdir(self.test_home_dir)
2474
self.test_dir = self.test_base_dir + '/work'
2475
os.mkdir(self.test_dir)
2476
os.chdir(self.test_dir)
2477
# put name of test inside
2478
f = file(self.test_base_dir + '/name', 'w')
2484
def deleteTestDir(self):
2485
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2486
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2488
def build_tree(self, shape, line_endings='binary', transport=None):
2489
"""Build a test tree according to a pattern.
2491
shape is a sequence of file specifications. If the final
2492
character is '/', a directory is created.
2494
This assumes that all the elements in the tree being built are new.
2496
This doesn't add anything to a branch.
2498
:type shape: list or tuple.
2499
:param line_endings: Either 'binary' or 'native'
2500
in binary mode, exact contents are written in native mode, the
2501
line endings match the default platform endings.
2502
:param transport: A transport to write to, for building trees on VFS's.
2503
If the transport is readonly or None, "." is opened automatically.
2506
if type(shape) not in (list, tuple):
2507
raise AssertionError("Parameter 'shape' should be "
2508
"a list or a tuple. Got %r instead" % (shape,))
2509
# It's OK to just create them using forward slashes on windows.
2510
if transport is None or transport.is_readonly():
2511
transport = get_transport(".")
2513
self.assertIsInstance(name, basestring)
2515
transport.mkdir(urlutils.escape(name[:-1]))
2517
if line_endings == 'binary':
2519
elif line_endings == 'native':
2522
raise errors.BzrError(
2523
'Invalid line ending request %r' % line_endings)
2524
content = "contents of %s%s" % (name.encode('utf-8'), end)
2525
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2527
def build_tree_contents(self, shape):
2528
build_tree_contents(shape)
2530
def assertInWorkingTree(self, path, root_path='.', tree=None):
2531
"""Assert whether path or paths are in the WorkingTree"""
2533
tree = workingtree.WorkingTree.open(root_path)
2534
if not isinstance(path, basestring):
2536
self.assertInWorkingTree(p, tree=tree)
2538
self.assertIsNot(tree.path2id(path), None,
2539
path+' not in working tree.')
2541
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2542
"""Assert whether path or paths are not in the WorkingTree"""
2544
tree = workingtree.WorkingTree.open(root_path)
2545
if not isinstance(path, basestring):
2547
self.assertNotInWorkingTree(p,tree=tree)
2549
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2552
class TestCaseWithTransport(TestCaseInTempDir):
2553
"""A test case that provides get_url and get_readonly_url facilities.
2555
These back onto two transport servers, one for readonly access and one for
2558
If no explicit class is provided for readonly access, a
2559
ReadonlyTransportDecorator is used instead which allows the use of non disk
2560
based read write transports.
2562
If an explicit class is provided for readonly access, that server and the
2563
readwrite one must both define get_url() as resolving to os.getcwd().
2566
def get_vfs_only_server(self):
2567
"""See TestCaseWithMemoryTransport.
2569
This is useful for some tests with specific servers that need
2572
if self.__vfs_server is None:
2573
self.__vfs_server = self.vfs_transport_factory()
2574
self.start_server(self.__vfs_server)
2575
return self.__vfs_server
2577
def make_branch_and_tree(self, relpath, format=None):
2578
"""Create a branch on the transport and a tree locally.
2580
If the transport is not a LocalTransport, the Tree can't be created on
2581
the transport. In that case if the vfs_transport_factory is
2582
LocalURLServer the working tree is created in the local
2583
directory backing the transport, and the returned tree's branch and
2584
repository will also be accessed locally. Otherwise a lightweight
2585
checkout is created and returned.
2587
We do this because we can't physically create a tree in the local
2588
path, with a branch reference to the transport_factory url, and
2589
a branch + repository in the vfs_transport, unless the vfs_transport
2590
namespace is distinct from the local disk - the two branch objects
2591
would collide. While we could construct a tree with its branch object
2592
pointing at the transport_factory transport in memory, reopening it
2593
would behaving unexpectedly, and has in the past caused testing bugs
2594
when we tried to do it that way.
2596
:param format: The BzrDirFormat.
2597
:returns: the WorkingTree.
2599
# TODO: always use the local disk path for the working tree,
2600
# this obviously requires a format that supports branch references
2601
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2603
b = self.make_branch(relpath, format=format)
2605
return b.bzrdir.create_workingtree()
2606
except errors.NotLocalUrl:
2607
# We can only make working trees locally at the moment. If the
2608
# transport can't support them, then we keep the non-disk-backed
2609
# branch and create a local checkout.
2610
if self.vfs_transport_factory is LocalURLServer:
2611
# the branch is colocated on disk, we cannot create a checkout.
2612
# hopefully callers will expect this.
2613
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2614
wt = local_controldir.create_workingtree()
2615
if wt.branch._format != b._format:
2617
# Make sure that assigning to wt._branch fixes wt.branch,
2618
# in case the implementation details of workingtree objects
2620
self.assertIs(b, wt.branch)
2623
return b.create_checkout(relpath, lightweight=True)
2625
def assertIsDirectory(self, relpath, transport):
2626
"""Assert that relpath within transport is a directory.
2628
This may not be possible on all transports; in that case it propagates
2629
a TransportNotPossible.
2632
mode = transport.stat(relpath).st_mode
2633
except errors.NoSuchFile:
2634
self.fail("path %s is not a directory; no such file"
2636
if not stat.S_ISDIR(mode):
2637
self.fail("path %s is not a directory; has mode %#o"
2640
def assertTreesEqual(self, left, right):
2641
"""Check that left and right have the same content and properties."""
2642
# we use a tree delta to check for equality of the content, and we
2643
# manually check for equality of other things such as the parents list.
2644
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2645
differences = left.changes_from(right)
2646
self.assertFalse(differences.has_changed(),
2647
"Trees %r and %r are different: %r" % (left, right, differences))
2650
super(TestCaseWithTransport, self).setUp()
2651
self.__vfs_server = None
2653
def disable_missing_extensions_warning(self):
2654
"""Some tests expect a precise stderr content.
2656
There is no point in forcing them to duplicate the extension related
2659
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2662
class ChrootedTestCase(TestCaseWithTransport):
2663
"""A support class that provides readonly urls outside the local namespace.
2665
This is done by checking if self.transport_server is a MemoryServer. if it
2666
is then we are chrooted already, if it is not then an HttpServer is used
2669
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2670
be used without needed to redo it when a different
2671
subclass is in use ?
2675
super(ChrootedTestCase, self).setUp()
2676
if not self.vfs_transport_factory == MemoryServer:
2677
self.transport_readonly_server = HttpServer
2680
def condition_id_re(pattern):
2681
"""Create a condition filter which performs a re check on a test's id.
2683
:param pattern: A regular expression string.
2684
:return: A callable that returns True if the re matches.
2686
filter_re = osutils.re_compile_checked(pattern, 0,
2688
def condition(test):
2690
return filter_re.search(test_id)
2694
def condition_isinstance(klass_or_klass_list):
2695
"""Create a condition filter which returns isinstance(param, klass).
2697
:return: A callable which when called with one parameter obj return the
2698
result of isinstance(obj, klass_or_klass_list).
2701
return isinstance(obj, klass_or_klass_list)
2705
def condition_id_in_list(id_list):
2706
"""Create a condition filter which verify that test's id in a list.
2708
:param id_list: A TestIdList object.
2709
:return: A callable that returns True if the test's id appears in the list.
2711
def condition(test):
2712
return id_list.includes(test.id())
2716
def condition_id_startswith(starts):
2717
"""Create a condition filter verifying that test's id starts with a string.
2719
:param starts: A list of string.
2720
:return: A callable that returns True if the test's id starts with one of
2723
def condition(test):
2724
for start in starts:
2725
if test.id().startswith(start):
2731
def exclude_tests_by_condition(suite, condition):
2732
"""Create a test suite which excludes some tests from suite.
2734
:param suite: The suite to get tests from.
2735
:param condition: A callable whose result evaluates True when called with a
2736
test case which should be excluded from the result.
2737
:return: A suite which contains the tests found in suite that fail
2741
for test in iter_suite_tests(suite):
2742
if not condition(test):
2744
return TestUtil.TestSuite(result)
2747
def filter_suite_by_condition(suite, condition):
2748
"""Create a test suite by filtering another one.
2750
:param suite: The source suite.
2751
:param condition: A callable whose result evaluates True when called with a
2752
test case which should be included in the result.
2753
:return: A suite which contains the tests found in suite that pass
2757
for test in iter_suite_tests(suite):
2760
return TestUtil.TestSuite(result)
2763
def filter_suite_by_re(suite, pattern):
2764
"""Create a test suite by filtering another one.
2766
:param suite: the source suite
2767
:param pattern: pattern that names must match
2768
:returns: the newly created suite
2770
condition = condition_id_re(pattern)
2771
result_suite = filter_suite_by_condition(suite, condition)
2775
def filter_suite_by_id_list(suite, test_id_list):
2776
"""Create a test suite by filtering another one.
2778
:param suite: The source suite.
2779
:param test_id_list: A list of the test ids to keep as strings.
2780
:returns: the newly created suite
2782
condition = condition_id_in_list(test_id_list)
2783
result_suite = filter_suite_by_condition(suite, condition)
2787
def filter_suite_by_id_startswith(suite, start):
2788
"""Create a test suite by filtering another one.
2790
:param suite: The source suite.
2791
:param start: A list of string the test id must start with one of.
2792
:returns: the newly created suite
2794
condition = condition_id_startswith(start)
2795
result_suite = filter_suite_by_condition(suite, condition)
2799
def exclude_tests_by_re(suite, pattern):
2800
"""Create a test suite which excludes some tests from suite.
2802
:param suite: The suite to get tests from.
2803
:param pattern: A regular expression string. Test ids that match this
2804
pattern will be excluded from the result.
2805
:return: A TestSuite that contains all the tests from suite without the
2806
tests that matched pattern. The order of tests is the same as it was in
2809
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2812
def preserve_input(something):
2813
"""A helper for performing test suite transformation chains.
2815
:param something: Anything you want to preserve.
2821
def randomize_suite(suite):
2822
"""Return a new TestSuite with suite's tests in random order.
2824
The tests in the input suite are flattened into a single suite in order to
2825
accomplish this. Any nested TestSuites are removed to provide global
2828
tests = list(iter_suite_tests(suite))
2829
random.shuffle(tests)
2830
return TestUtil.TestSuite(tests)
2833
def split_suite_by_condition(suite, condition):
2834
"""Split a test suite into two by a condition.
2836
:param suite: The suite to split.
2837
:param condition: The condition to match on. Tests that match this
2838
condition are returned in the first test suite, ones that do not match
2839
are in the second suite.
2840
:return: A tuple of two test suites, where the first contains tests from
2841
suite matching the condition, and the second contains the remainder
2842
from suite. The order within each output suite is the same as it was in
2847
for test in iter_suite_tests(suite):
2849
matched.append(test)
2851
did_not_match.append(test)
2852
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2855
def split_suite_by_re(suite, pattern):
2856
"""Split a test suite into two by a regular expression.
2858
:param suite: The suite to split.
2859
:param pattern: A regular expression string. Test ids that match this
2860
pattern will be in the first test suite returned, and the others in the
2861
second test suite returned.
2862
:return: A tuple of two test suites, where the first contains tests from
2863
suite matching pattern, and the second contains the remainder from
2864
suite. The order within each output suite is the same as it was in
2867
return split_suite_by_condition(suite, condition_id_re(pattern))
2870
def run_suite(suite, name='test', verbose=False, pattern=".*",
2871
stop_on_failure=False,
2872
transport=None, lsprof_timed=None, bench_history=None,
2873
matching_tests_first=None,
2876
exclude_pattern=None,
2879
suite_decorators=None,
2881
result_decorators=None,
2883
"""Run a test suite for bzr selftest.
2885
:param runner_class: The class of runner to use. Must support the
2886
constructor arguments passed by run_suite which are more than standard
2888
:return: A boolean indicating success.
2890
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2895
if runner_class is None:
2896
runner_class = TextTestRunner
2899
runner = runner_class(stream=stream,
2901
verbosity=verbosity,
2902
bench_history=bench_history,
2904
result_decorators=result_decorators,
2906
runner.stop_on_failure=stop_on_failure
2907
# built in decorator factories:
2909
random_order(random_seed, runner),
2910
exclude_tests(exclude_pattern),
2912
if matching_tests_first:
2913
decorators.append(tests_first(pattern))
2915
decorators.append(filter_tests(pattern))
2916
if suite_decorators:
2917
decorators.extend(suite_decorators)
2918
# tell the result object how many tests will be running: (except if
2919
# --parallel=fork is being used. Robert said he will provide a better
2920
# progress design later -- vila 20090817)
2921
if fork_decorator not in decorators:
2922
decorators.append(CountingDecorator)
2923
for decorator in decorators:
2924
suite = decorator(suite)
2926
# Done after test suite decoration to allow randomisation etc
2927
# to take effect, though that is of marginal benefit.
2929
stream.write("Listing tests only ...\n")
2930
for t in iter_suite_tests(suite):
2931
stream.write("%s\n" % (t.id()))
2933
result = runner.run(suite)
2935
return result.wasStrictlySuccessful()
2937
return result.wasSuccessful()
2940
# A registry where get() returns a suite decorator.
2941
parallel_registry = registry.Registry()
2944
def fork_decorator(suite):
2945
concurrency = osutils.local_concurrency()
2946
if concurrency == 1:
2948
from testtools import ConcurrentTestSuite
2949
return ConcurrentTestSuite(suite, fork_for_tests)
2950
parallel_registry.register('fork', fork_decorator)
2953
def subprocess_decorator(suite):
2954
concurrency = osutils.local_concurrency()
2955
if concurrency == 1:
2957
from testtools import ConcurrentTestSuite
2958
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2959
parallel_registry.register('subprocess', subprocess_decorator)
2962
def exclude_tests(exclude_pattern):
2963
"""Return a test suite decorator that excludes tests."""
2964
if exclude_pattern is None:
2965
return identity_decorator
2966
def decorator(suite):
2967
return ExcludeDecorator(suite, exclude_pattern)
2971
def filter_tests(pattern):
2973
return identity_decorator
2974
def decorator(suite):
2975
return FilterTestsDecorator(suite, pattern)
2979
def random_order(random_seed, runner):
2980
"""Return a test suite decorator factory for randomising tests order.
2982
:param random_seed: now, a string which casts to a long, or a long.
2983
:param runner: A test runner with a stream attribute to report on.
2985
if random_seed is None:
2986
return identity_decorator
2987
def decorator(suite):
2988
return RandomDecorator(suite, random_seed, runner.stream)
2992
def tests_first(pattern):
2994
return identity_decorator
2995
def decorator(suite):
2996
return TestFirstDecorator(suite, pattern)
3000
def identity_decorator(suite):
3005
class TestDecorator(TestSuite):
3006
"""A decorator for TestCase/TestSuite objects.
3008
Usually, subclasses should override __iter__(used when flattening test
3009
suites), which we do to filter, reorder, parallelise and so on, run() and
3013
def __init__(self, suite):
3014
TestSuite.__init__(self)
3017
def countTestCases(self):
3020
cases += test.countTestCases()
3027
def run(self, result):
3028
# Use iteration on self, not self._tests, to allow subclasses to hook
3031
if result.shouldStop:
3037
class CountingDecorator(TestDecorator):
3038
"""A decorator which calls result.progress(self.countTestCases)."""
3040
def run(self, result):
3041
progress_method = getattr(result, 'progress', None)
3042
if callable(progress_method):
3043
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3044
return super(CountingDecorator, self).run(result)
3047
class ExcludeDecorator(TestDecorator):
3048
"""A decorator which excludes test matching an exclude pattern."""
3050
def __init__(self, suite, exclude_pattern):
3051
TestDecorator.__init__(self, suite)
3052
self.exclude_pattern = exclude_pattern
3053
self.excluded = False
3057
return iter(self._tests)
3058
self.excluded = True
3059
suite = exclude_tests_by_re(self, self.exclude_pattern)
3061
self.addTests(suite)
3062
return iter(self._tests)
3065
class FilterTestsDecorator(TestDecorator):
3066
"""A decorator which filters tests to those matching a pattern."""
3068
def __init__(self, suite, pattern):
3069
TestDecorator.__init__(self, suite)
3070
self.pattern = pattern
3071
self.filtered = False
3075
return iter(self._tests)
3076
self.filtered = True
3077
suite = filter_suite_by_re(self, self.pattern)
3079
self.addTests(suite)
3080
return iter(self._tests)
3083
class RandomDecorator(TestDecorator):
3084
"""A decorator which randomises the order of its tests."""
3086
def __init__(self, suite, random_seed, stream):
3087
TestDecorator.__init__(self, suite)
3088
self.random_seed = random_seed
3089
self.randomised = False
3090
self.stream = stream
3094
return iter(self._tests)
3095
self.randomised = True
3096
self.stream.write("Randomizing test order using seed %s\n\n" %
3097
(self.actual_seed()))
3098
# Initialise the random number generator.
3099
random.seed(self.actual_seed())
3100
suite = randomize_suite(self)
3102
self.addTests(suite)
3103
return iter(self._tests)
3105
def actual_seed(self):
3106
if self.random_seed == "now":
3107
# We convert the seed to a long to make it reuseable across
3108
# invocations (because the user can reenter it).
3109
self.random_seed = long(time.time())
3111
# Convert the seed to a long if we can
3113
self.random_seed = long(self.random_seed)
3116
return self.random_seed
3119
class TestFirstDecorator(TestDecorator):
3120
"""A decorator which moves named tests to the front."""
3122
def __init__(self, suite, pattern):
3123
TestDecorator.__init__(self, suite)
3124
self.pattern = pattern
3125
self.filtered = False
3129
return iter(self._tests)
3130
self.filtered = True
3131
suites = split_suite_by_re(self, self.pattern)
3133
self.addTests(suites)
3134
return iter(self._tests)
3137
def partition_tests(suite, count):
3138
"""Partition suite into count lists of tests."""
3140
tests = list(iter_suite_tests(suite))
3141
tests_per_process = int(math.ceil(float(len(tests)) / count))
3142
for block in range(count):
3143
low_test = block * tests_per_process
3144
high_test = low_test + tests_per_process
3145
process_tests = tests[low_test:high_test]
3146
result.append(process_tests)
3150
def fork_for_tests(suite):
3151
"""Take suite and start up one runner per CPU by forking()
3153
:return: An iterable of TestCase-like objects which can each have
3154
run(result) called on them to feed tests to result.
3156
concurrency = osutils.local_concurrency()
3158
from subunit import TestProtocolClient, ProtocolTestCase
3159
from subunit.test_results import AutoTimingTestResultDecorator
3160
class TestInOtherProcess(ProtocolTestCase):
3161
# Should be in subunit, I think. RBC.
3162
def __init__(self, stream, pid):
3163
ProtocolTestCase.__init__(self, stream)
3166
def run(self, result):
3168
ProtocolTestCase.run(self, result)
3170
os.waitpid(self.pid, os.WNOHANG)
3172
test_blocks = partition_tests(suite, concurrency)
3173
for process_tests in test_blocks:
3174
process_suite = TestSuite()
3175
process_suite.addTests(process_tests)
3176
c2pread, c2pwrite = os.pipe()
3181
# Leave stderr and stdout open so we can see test noise
3182
# Close stdin so that the child goes away if it decides to
3183
# read from stdin (otherwise its a roulette to see what
3184
# child actually gets keystrokes for pdb etc).
3187
stream = os.fdopen(c2pwrite, 'wb', 1)
3188
subunit_result = AutoTimingTestResultDecorator(
3189
TestProtocolClient(stream))
3190
process_suite.run(subunit_result)
3195
stream = os.fdopen(c2pread, 'rb', 1)
3196
test = TestInOtherProcess(stream, pid)
3201
def reinvoke_for_tests(suite):
3202
"""Take suite and start up one runner per CPU using subprocess().
3204
:return: An iterable of TestCase-like objects which can each have
3205
run(result) called on them to feed tests to result.
3207
concurrency = osutils.local_concurrency()
3209
from subunit import ProtocolTestCase
3210
class TestInSubprocess(ProtocolTestCase):
3211
def __init__(self, process, name):
3212
ProtocolTestCase.__init__(self, process.stdout)
3213
self.process = process
3214
self.process.stdin.close()
3217
def run(self, result):
3219
ProtocolTestCase.run(self, result)
3222
os.unlink(self.name)
3223
# print "pid %d finished" % finished_process
3224
test_blocks = partition_tests(suite, concurrency)
3225
for process_tests in test_blocks:
3226
# ugly; currently reimplement rather than reuses TestCase methods.
3227
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3228
if not os.path.isfile(bzr_path):
3229
# We are probably installed. Assume sys.argv is the right file
3230
bzr_path = sys.argv[0]
3231
bzr_path = [bzr_path]
3232
if sys.platform == "win32":
3233
# if we're on windows, we can't execute the bzr script directly
3234
bzr_path = [sys.executable] + bzr_path
3235
fd, test_list_file_name = tempfile.mkstemp()
3236
test_list_file = os.fdopen(fd, 'wb', 1)
3237
for test in process_tests:
3238
test_list_file.write(test.id() + '\n')
3239
test_list_file.close()
3241
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3243
if '--no-plugins' in sys.argv:
3244
argv.append('--no-plugins')
3245
# stderr=STDOUT would be ideal, but until we prevent noise on
3246
# stderr it can interrupt the subunit protocol.
3247
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3249
test = TestInSubprocess(process, test_list_file_name)
3252
os.unlink(test_list_file_name)
3257
class ForwardingResult(unittest.TestResult):
3259
def __init__(self, target):
3260
unittest.TestResult.__init__(self)
3261
self.result = target
3263
def startTest(self, test):
3264
self.result.startTest(test)
3266
def stopTest(self, test):
3267
self.result.stopTest(test)
3269
def startTestRun(self):
3270
self.result.startTestRun()
3272
def stopTestRun(self):
3273
self.result.stopTestRun()
3275
def addSkip(self, test, reason):
3276
self.result.addSkip(test, reason)
3278
def addSuccess(self, test):
3279
self.result.addSuccess(test)
3281
def addError(self, test, err):
3282
self.result.addError(test, err)
3284
def addFailure(self, test, err):
3285
self.result.addFailure(test, err)
3286
ForwardingResult = testtools.ExtendedToOriginalDecorator
3289
class ProfileResult(ForwardingResult):
3290
"""Generate profiling data for all activity between start and success.
3292
The profile data is appended to the test's _benchcalls attribute and can
3293
be accessed by the forwarded-to TestResult.
3295
While it might be cleaner do accumulate this in stopTest, addSuccess is
3296
where our existing output support for lsprof is, and this class aims to
3297
fit in with that: while it could be moved it's not necessary to accomplish
3298
test profiling, nor would it be dramatically cleaner.
3301
def startTest(self, test):
3302
self.profiler = bzrlib.lsprof.BzrProfiler()
3303
self.profiler.start()
3304
ForwardingResult.startTest(self, test)
3306
def addSuccess(self, test):
3307
stats = self.profiler.stop()
3309
calls = test._benchcalls
3310
except AttributeError:
3311
test._benchcalls = []
3312
calls = test._benchcalls
3313
calls.append(((test.id(), "", ""), stats))
3314
ForwardingResult.addSuccess(self, test)
3316
def stopTest(self, test):
3317
ForwardingResult.stopTest(self, test)
3318
self.profiler = None
3321
# Controlled by "bzr selftest -E=..." option
3322
# Currently supported:
3323
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3324
# preserves any flags supplied at the command line.
3325
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3326
# rather than failing tests. And no longer raise
3327
# LockContention when fctnl locks are not being used
3328
# with proper exclusion rules.
3329
selftest_debug_flags = set()
3332
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3334
test_suite_factory=None,
3337
matching_tests_first=None,
3340
exclude_pattern=None,
3346
suite_decorators=None,
3350
"""Run the whole test suite under the enhanced runner"""
3351
# XXX: Very ugly way to do this...
3352
# Disable warning about old formats because we don't want it to disturb
3353
# any blackbox tests.
3354
from bzrlib import repository
3355
repository._deprecation_warning_done = True
3357
global default_transport
3358
if transport is None:
3359
transport = default_transport
3360
old_transport = default_transport
3361
default_transport = transport
3362
global selftest_debug_flags
3363
old_debug_flags = selftest_debug_flags
3364
if debug_flags is not None:
3365
selftest_debug_flags = set(debug_flags)
3367
if load_list is None:
3370
keep_only = load_test_id_list(load_list)
3372
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3373
for start in starting_with]
3374
if test_suite_factory is None:
3375
# Reduce loading time by loading modules based on the starting_with
3377
suite = test_suite(keep_only, starting_with)
3379
suite = test_suite_factory()
3381
# But always filter as requested.
3382
suite = filter_suite_by_id_startswith(suite, starting_with)
3383
result_decorators = []
3385
result_decorators.append(ProfileResult)
3386
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3387
stop_on_failure=stop_on_failure,
3388
transport=transport,
3389
lsprof_timed=lsprof_timed,
3390
bench_history=bench_history,
3391
matching_tests_first=matching_tests_first,
3392
list_only=list_only,
3393
random_seed=random_seed,
3394
exclude_pattern=exclude_pattern,
3396
runner_class=runner_class,
3397
suite_decorators=suite_decorators,
3399
result_decorators=result_decorators,
3402
default_transport = old_transport
3403
selftest_debug_flags = old_debug_flags
3406
def load_test_id_list(file_name):
3407
"""Load a test id list from a text file.
3409
The format is one test id by line. No special care is taken to impose
3410
strict rules, these test ids are used to filter the test suite so a test id
3411
that do not match an existing test will do no harm. This allows user to add
3412
comments, leave blank lines, etc.
3416
ftest = open(file_name, 'rt')
3418
if e.errno != errno.ENOENT:
3421
raise errors.NoSuchFile(file_name)
3423
for test_name in ftest.readlines():
3424
test_list.append(test_name.strip())
3429
def suite_matches_id_list(test_suite, id_list):
3430
"""Warns about tests not appearing or appearing more than once.
3432
:param test_suite: A TestSuite object.
3433
:param test_id_list: The list of test ids that should be found in
3436
:return: (absents, duplicates) absents is a list containing the test found
3437
in id_list but not in test_suite, duplicates is a list containing the
3438
test found multiple times in test_suite.
3440
When using a prefined test id list, it may occurs that some tests do not
3441
exist anymore or that some tests use the same id. This function warns the
3442
tester about potential problems in his workflow (test lists are volatile)
3443
or in the test suite itself (using the same id for several tests does not
3444
help to localize defects).
3446
# Build a dict counting id occurrences
3448
for test in iter_suite_tests(test_suite):
3450
tests[id] = tests.get(id, 0) + 1
3455
occurs = tests.get(id, 0)
3457
not_found.append(id)
3459
duplicates.append(id)
3461
return not_found, duplicates
3464
class TestIdList(object):
3465
"""Test id list to filter a test suite.
3467
Relying on the assumption that test ids are built as:
3468
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3469
notation, this class offers methods to :
3470
- avoid building a test suite for modules not refered to in the test list,
3471
- keep only the tests listed from the module test suite.
3474
def __init__(self, test_id_list):
3475
# When a test suite needs to be filtered against us we compare test ids
3476
# for equality, so a simple dict offers a quick and simple solution.
3477
self.tests = dict().fromkeys(test_id_list, True)
3479
# While unittest.TestCase have ids like:
3480
# <module>.<class>.<method>[(<param+)],
3481
# doctest.DocTestCase can have ids like:
3484
# <module>.<function>
3485
# <module>.<class>.<method>
3487
# Since we can't predict a test class from its name only, we settle on
3488
# a simple constraint: a test id always begins with its module name.
3491
for test_id in test_id_list:
3492
parts = test_id.split('.')
3493
mod_name = parts.pop(0)
3494
modules[mod_name] = True
3496
mod_name += '.' + part
3497
modules[mod_name] = True
3498
self.modules = modules
3500
def refers_to(self, module_name):
3501
"""Is there tests for the module or one of its sub modules."""
3502
return self.modules.has_key(module_name)
3504
def includes(self, test_id):
3505
return self.tests.has_key(test_id)
3508
class TestPrefixAliasRegistry(registry.Registry):
3509
"""A registry for test prefix aliases.
3511
This helps implement shorcuts for the --starting-with selftest
3512
option. Overriding existing prefixes is not allowed but not fatal (a
3513
warning will be emitted).
3516
def register(self, key, obj, help=None, info=None,
3517
override_existing=False):
3518
"""See Registry.register.
3520
Trying to override an existing alias causes a warning to be emitted,
3521
not a fatal execption.
3524
super(TestPrefixAliasRegistry, self).register(
3525
key, obj, help=help, info=info, override_existing=False)
3527
actual = self.get(key)
3528
note('Test prefix alias %s is already used for %s, ignoring %s'
3529
% (key, actual, obj))
3531
def resolve_alias(self, id_start):
3532
"""Replace the alias by the prefix in the given string.
3534
Using an unknown prefix is an error to help catching typos.
3536
parts = id_start.split('.')
3538
parts[0] = self.get(parts[0])
3540
raise errors.BzrCommandError(
3541
'%s is not a known test prefix alias' % parts[0])
3542
return '.'.join(parts)
3545
test_prefix_alias_registry = TestPrefixAliasRegistry()
3546
"""Registry of test prefix aliases."""
3549
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3550
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3551
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3553
# Obvious higest levels prefixes, feel free to add your own via a plugin
3554
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3555
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3556
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3557
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3558
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3561
def _test_suite_testmod_names():
3562
"""Return the standard list of test module names to test."""
3565
'bzrlib.tests.blackbox',
3566
'bzrlib.tests.commands',
3567
'bzrlib.tests.per_branch',
3568
'bzrlib.tests.per_bzrdir',
3569
'bzrlib.tests.per_foreign_vcs',
3570
'bzrlib.tests.per_interrepository',
3571
'bzrlib.tests.per_intertree',
3572
'bzrlib.tests.per_inventory',
3573
'bzrlib.tests.per_interbranch',
3574
'bzrlib.tests.per_lock',
3575
'bzrlib.tests.per_merger',
3576
'bzrlib.tests.per_transport',
3577
'bzrlib.tests.per_tree',
3578
'bzrlib.tests.per_pack_repository',
3579
'bzrlib.tests.per_repository',
3580
'bzrlib.tests.per_repository_chk',
3581
'bzrlib.tests.per_repository_reference',
3582
'bzrlib.tests.per_uifactory',
3583
'bzrlib.tests.per_versionedfile',
3584
'bzrlib.tests.per_workingtree',
3585
'bzrlib.tests.test__annotator',
3586
'bzrlib.tests.test__bencode',
3587
'bzrlib.tests.test__chk_map',
3588
'bzrlib.tests.test__dirstate_helpers',
3589
'bzrlib.tests.test__groupcompress',
3590
'bzrlib.tests.test__known_graph',
3591
'bzrlib.tests.test__rio',
3592
'bzrlib.tests.test__simple_set',
3593
'bzrlib.tests.test__static_tuple',
3594
'bzrlib.tests.test__walkdirs_win32',
3595
'bzrlib.tests.test_ancestry',
3596
'bzrlib.tests.test_annotate',
3597
'bzrlib.tests.test_api',
3598
'bzrlib.tests.test_atomicfile',
3599
'bzrlib.tests.test_bad_files',
3600
'bzrlib.tests.test_bisect_multi',
3601
'bzrlib.tests.test_branch',
3602
'bzrlib.tests.test_branchbuilder',
3603
'bzrlib.tests.test_btree_index',
3604
'bzrlib.tests.test_bugtracker',
3605
'bzrlib.tests.test_bundle',
3606
'bzrlib.tests.test_bzrdir',
3607
'bzrlib.tests.test__chunks_to_lines',
3608
'bzrlib.tests.test_cache_utf8',
3609
'bzrlib.tests.test_chk_map',
3610
'bzrlib.tests.test_chk_serializer',
3611
'bzrlib.tests.test_chunk_writer',
3612
'bzrlib.tests.test_clean_tree',
3613
'bzrlib.tests.test_cleanup',
3614
'bzrlib.tests.test_commands',
3615
'bzrlib.tests.test_commit',
3616
'bzrlib.tests.test_commit_merge',
3617
'bzrlib.tests.test_config',
3618
'bzrlib.tests.test_conflicts',
3619
'bzrlib.tests.test_counted_lock',
3620
'bzrlib.tests.test_crash',
3621
'bzrlib.tests.test_decorators',
3622
'bzrlib.tests.test_delta',
3623
'bzrlib.tests.test_debug',
3624
'bzrlib.tests.test_deprecated_graph',
3625
'bzrlib.tests.test_diff',
3626
'bzrlib.tests.test_directory_service',
3627
'bzrlib.tests.test_dirstate',
3628
'bzrlib.tests.test_email_message',
3629
'bzrlib.tests.test_eol_filters',
3630
'bzrlib.tests.test_errors',
3631
'bzrlib.tests.test_export',
3632
'bzrlib.tests.test_extract',
3633
'bzrlib.tests.test_fetch',
3634
'bzrlib.tests.test_fifo_cache',
3635
'bzrlib.tests.test_filters',
3636
'bzrlib.tests.test_ftp_transport',
3637
'bzrlib.tests.test_foreign',
3638
'bzrlib.tests.test_generate_docs',
3639
'bzrlib.tests.test_generate_ids',
3640
'bzrlib.tests.test_globbing',
3641
'bzrlib.tests.test_gpg',
3642
'bzrlib.tests.test_graph',
3643
'bzrlib.tests.test_groupcompress',
3644
'bzrlib.tests.test_hashcache',
3645
'bzrlib.tests.test_help',
3646
'bzrlib.tests.test_hooks',
3647
'bzrlib.tests.test_http',
3648
'bzrlib.tests.test_http_response',
3649
'bzrlib.tests.test_https_ca_bundle',
3650
'bzrlib.tests.test_identitymap',
3651
'bzrlib.tests.test_ignores',
3652
'bzrlib.tests.test_index',
3653
'bzrlib.tests.test_info',
3654
'bzrlib.tests.test_inv',
3655
'bzrlib.tests.test_inventory_delta',
3656
'bzrlib.tests.test_knit',
3657
'bzrlib.tests.test_lazy_import',
3658
'bzrlib.tests.test_lazy_regex',
3659
'bzrlib.tests.test_lock',
3660
'bzrlib.tests.test_lockable_files',
3661
'bzrlib.tests.test_lockdir',
3662
'bzrlib.tests.test_log',
3663
'bzrlib.tests.test_lru_cache',
3664
'bzrlib.tests.test_lsprof',
3665
'bzrlib.tests.test_mail_client',
3666
'bzrlib.tests.test_memorytree',
3667
'bzrlib.tests.test_merge',
3668
'bzrlib.tests.test_merge3',
3669
'bzrlib.tests.test_merge_core',
3670
'bzrlib.tests.test_merge_directive',
3671
'bzrlib.tests.test_missing',
3672
'bzrlib.tests.test_msgeditor',
3673
'bzrlib.tests.test_multiparent',
3674
'bzrlib.tests.test_mutabletree',
3675
'bzrlib.tests.test_nonascii',
3676
'bzrlib.tests.test_options',
3677
'bzrlib.tests.test_osutils',
3678
'bzrlib.tests.test_osutils_encodings',
3679
'bzrlib.tests.test_pack',
3680
'bzrlib.tests.test_patch',
3681
'bzrlib.tests.test_patches',
3682
'bzrlib.tests.test_permissions',
3683
'bzrlib.tests.test_plugins',
3684
'bzrlib.tests.test_progress',
3685
'bzrlib.tests.test_read_bundle',
3686
'bzrlib.tests.test_reconcile',
3687
'bzrlib.tests.test_reconfigure',
3688
'bzrlib.tests.test_registry',
3689
'bzrlib.tests.test_remote',
3690
'bzrlib.tests.test_rename_map',
3691
'bzrlib.tests.test_repository',
3692
'bzrlib.tests.test_revert',
3693
'bzrlib.tests.test_revision',
3694
'bzrlib.tests.test_revisionspec',
3695
'bzrlib.tests.test_revisiontree',
3696
'bzrlib.tests.test_rio',
3697
'bzrlib.tests.test_rules',
3698
'bzrlib.tests.test_sampler',
3699
'bzrlib.tests.test_script',
3700
'bzrlib.tests.test_selftest',
3701
'bzrlib.tests.test_serializer',
3702
'bzrlib.tests.test_setup',
3703
'bzrlib.tests.test_sftp_transport',
3704
'bzrlib.tests.test_shelf',
3705
'bzrlib.tests.test_shelf_ui',
3706
'bzrlib.tests.test_smart',
3707
'bzrlib.tests.test_smart_add',
3708
'bzrlib.tests.test_smart_request',
3709
'bzrlib.tests.test_smart_transport',
3710
'bzrlib.tests.test_smtp_connection',
3711
'bzrlib.tests.test_source',
3712
'bzrlib.tests.test_ssh_transport',
3713
'bzrlib.tests.test_status',
3714
'bzrlib.tests.test_store',
3715
'bzrlib.tests.test_strace',
3716
'bzrlib.tests.test_subsume',
3717
'bzrlib.tests.test_switch',
3718
'bzrlib.tests.test_symbol_versioning',
3719
'bzrlib.tests.test_tag',
3720
'bzrlib.tests.test_testament',
3721
'bzrlib.tests.test_textfile',
3722
'bzrlib.tests.test_textmerge',
3723
'bzrlib.tests.test_timestamp',
3724
'bzrlib.tests.test_trace',
3725
'bzrlib.tests.test_transactions',
3726
'bzrlib.tests.test_transform',
3727
'bzrlib.tests.test_transport',
3728
'bzrlib.tests.test_transport_log',
3729
'bzrlib.tests.test_tree',
3730
'bzrlib.tests.test_treebuilder',
3731
'bzrlib.tests.test_tsort',
3732
'bzrlib.tests.test_tuned_gzip',
3733
'bzrlib.tests.test_ui',
3734
'bzrlib.tests.test_uncommit',
3735
'bzrlib.tests.test_upgrade',
3736
'bzrlib.tests.test_upgrade_stacked',
3737
'bzrlib.tests.test_urlutils',
3738
'bzrlib.tests.test_version',
3739
'bzrlib.tests.test_version_info',
3740
'bzrlib.tests.test_weave',
3741
'bzrlib.tests.test_whitebox',
3742
'bzrlib.tests.test_win32utils',
3743
'bzrlib.tests.test_workingtree',
3744
'bzrlib.tests.test_workingtree_4',
3745
'bzrlib.tests.test_wsgi',
3746
'bzrlib.tests.test_xml',
3750
def _test_suite_modules_to_doctest():
3751
"""Return the list of modules to doctest."""
3754
'bzrlib.branchbuilder',
3755
'bzrlib.decorators',
3758
'bzrlib.iterablefile',
3762
'bzrlib.symbol_versioning',
3765
'bzrlib.version_info_formats.format_custom',
3769
def test_suite(keep_only=None, starting_with=None):
3770
"""Build and return TestSuite for the whole of bzrlib.
3772
:param keep_only: A list of test ids limiting the suite returned.
3774
:param starting_with: An id limiting the suite returned to the tests
3777
This function can be replaced if you need to change the default test
3778
suite on a global basis, but it is not encouraged.
3781
loader = TestUtil.TestLoader()
3783
if keep_only is not None:
3784
id_filter = TestIdList(keep_only)
3786
# We take precedence over keep_only because *at loading time* using
3787
# both options means we will load less tests for the same final result.
3788
def interesting_module(name):
3789
for start in starting_with:
3791
# Either the module name starts with the specified string
3792
name.startswith(start)
3793
# or it may contain tests starting with the specified string
3794
or start.startswith(name)
3798
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3800
elif keep_only is not None:
3801
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3802
def interesting_module(name):
3803
return id_filter.refers_to(name)
3806
loader = TestUtil.TestLoader()
3807
def interesting_module(name):
3808
# No filtering, all modules are interesting
3811
suite = loader.suiteClass()
3813
# modules building their suite with loadTestsFromModuleNames
3814
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3816
for mod in _test_suite_modules_to_doctest():
3817
if not interesting_module(mod):
3818
# No tests to keep here, move along
3821
# note that this really does mean "report only" -- doctest
3822
# still runs the rest of the examples
3823
doc_suite = doctest.DocTestSuite(mod,
3824
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3825
except ValueError, e:
3826
print '**failed to get doctest for: %s\n%s' % (mod, e)
3828
if len(doc_suite._tests) == 0:
3829
raise errors.BzrError("no doctests found in %s" % (mod,))
3830
suite.addTest(doc_suite)
3832
default_encoding = sys.getdefaultencoding()
3833
for name, plugin in bzrlib.plugin.plugins().items():
3834
if not interesting_module(plugin.module.__name__):
3836
plugin_suite = plugin.test_suite()
3837
# We used to catch ImportError here and turn it into just a warning,
3838
# but really if you don't have --no-plugins this should be a failure.
3839
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3840
if plugin_suite is None:
3841
plugin_suite = plugin.load_plugin_tests(loader)
3842
if plugin_suite is not None:
3843
suite.addTest(plugin_suite)
3844
if default_encoding != sys.getdefaultencoding():
3845
bzrlib.trace.warning(
3846
'Plugin "%s" tried to reset default encoding to: %s', name,
3847
sys.getdefaultencoding())
3849
sys.setdefaultencoding(default_encoding)
3851
if keep_only is not None:
3852
# Now that the referred modules have loaded their tests, keep only the
3854
suite = filter_suite_by_id_list(suite, id_filter)
3855
# Do some sanity checks on the id_list filtering
3856
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3858
# The tester has used both keep_only and starting_with, so he is
3859
# already aware that some tests are excluded from the list, there
3860
# is no need to tell him which.
3863
# Some tests mentioned in the list are not in the test suite. The
3864
# list may be out of date, report to the tester.
3865
for id in not_found:
3866
bzrlib.trace.warning('"%s" not found in the test suite', id)
3867
for id in duplicates:
3868
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3873
def multiply_scenarios(scenarios_left, scenarios_right):
3874
"""Multiply two sets of scenarios.
3876
:returns: the cartesian product of the two sets of scenarios, that is
3877
a scenario for every possible combination of a left scenario and a
3881
('%s,%s' % (left_name, right_name),
3882
dict(left_dict.items() + right_dict.items()))
3883
for left_name, left_dict in scenarios_left
3884
for right_name, right_dict in scenarios_right]
3887
def multiply_tests(tests, scenarios, result):
3888
"""Multiply tests_list by scenarios into result.
3890
This is the core workhorse for test parameterisation.
3892
Typically the load_tests() method for a per-implementation test suite will
3893
call multiply_tests and return the result.
3895
:param tests: The tests to parameterise.
3896
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3897
scenario_param_dict).
3898
:param result: A TestSuite to add created tests to.
3900
This returns the passed in result TestSuite with the cross product of all
3901
the tests repeated once for each scenario. Each test is adapted by adding
3902
the scenario name at the end of its id(), and updating the test object's
3903
__dict__ with the scenario_param_dict.
3905
>>> import bzrlib.tests.test_sampler
3906
>>> r = multiply_tests(
3907
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3908
... [('one', dict(param=1)),
3909
... ('two', dict(param=2))],
3911
>>> tests = list(iter_suite_tests(r))
3915
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3921
for test in iter_suite_tests(tests):
3922
apply_scenarios(test, scenarios, result)
3926
def apply_scenarios(test, scenarios, result):
3927
"""Apply the scenarios in scenarios to test and add to result.
3929
:param test: The test to apply scenarios to.
3930
:param scenarios: An iterable of scenarios to apply to test.
3932
:seealso: apply_scenario
3934
for scenario in scenarios:
3935
result.addTest(apply_scenario(test, scenario))
3939
def apply_scenario(test, scenario):
3940
"""Copy test and apply scenario to it.
3942
:param test: A test to adapt.
3943
:param scenario: A tuple describing the scenarion.
3944
The first element of the tuple is the new test id.
3945
The second element is a dict containing attributes to set on the
3947
:return: The adapted test.
3949
new_id = "%s(%s)" % (test.id(), scenario[0])
3950
new_test = clone_test(test, new_id)
3951
for name, value in scenario[1].items():
3952
setattr(new_test, name, value)
3956
def clone_test(test, new_id):
3957
"""Clone a test giving it a new id.
3959
:param test: The test to clone.
3960
:param new_id: The id to assign to it.
3961
:return: The new test.
3963
new_test = copy(test)
3964
new_test.id = lambda: new_id
3968
def permute_tests_for_extension(standard_tests, loader, py_module_name,
3970
"""Helper for permutating tests against an extension module.
3972
This is meant to be used inside a modules 'load_tests()' function. It will
3973
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
3974
against both implementations. Setting 'test.module' to the appropriate
3975
module. See bzrlib.tests.test__chk_map.load_tests as an example.
3977
:param standard_tests: A test suite to permute
3978
:param loader: A TestLoader
3979
:param py_module_name: The python path to a python module that can always
3980
be loaded, and will be considered the 'python' implementation. (eg
3981
'bzrlib._chk_map_py')
3982
:param ext_module_name: The python path to an extension module. If the
3983
module cannot be loaded, a single test will be added, which notes that
3984
the module is not available. If it can be loaded, all standard_tests
3985
will be run against that module.
3986
:return: (suite, feature) suite is a test-suite that has all the permuted
3987
tests. feature is the Feature object that can be used to determine if
3988
the module is available.
3991
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
3993
('python', {'module': py_module}),
3995
suite = loader.suiteClass()
3996
feature = ModuleAvailableFeature(ext_module_name)
3997
if feature.available():
3998
scenarios.append(('C', {'module': feature.module}))
4000
# the compiled module isn't available, so we add a failing test
4001
class FailWithoutFeature(TestCase):
4002
def test_fail(self):
4003
self.requireFeature(feature)
4004
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4005
result = multiply_tests(standard_tests, scenarios, suite)
4006
return result, feature
4009
def _rmtree_temp_dir(dirname, test_id=None):
4010
# If LANG=C we probably have created some bogus paths
4011
# which rmtree(unicode) will fail to delete
4012
# so make sure we are using rmtree(str) to delete everything
4013
# except on win32, where rmtree(str) will fail
4014
# since it doesn't have the property of byte-stream paths
4015
# (they are either ascii or mbcs)
4016
if sys.platform == 'win32':
4017
# make sure we are using the unicode win32 api
4018
dirname = unicode(dirname)
4020
dirname = dirname.encode(sys.getfilesystemencoding())
4022
osutils.rmtree(dirname)
4024
# We don't want to fail here because some useful display will be lost
4025
# otherwise. Polluting the tmp dir is bad, but not giving all the
4026
# possible info to the test runner is even worse.
4028
ui.ui_factory.clear_term()
4029
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4030
sys.stderr.write('Unable to remove testing dir %s\n%s'
4031
% (os.path.basename(dirname), e))
4034
class Feature(object):
4035
"""An operating system Feature."""
4038
self._available = None
4040
def available(self):
4041
"""Is the feature available?
4043
:return: True if the feature is available.
4045
if self._available is None:
4046
self._available = self._probe()
4047
return self._available
4050
"""Implement this method in concrete features.
4052
:return: True if the feature is available.
4054
raise NotImplementedError
4057
if getattr(self, 'feature_name', None):
4058
return self.feature_name()
4059
return self.__class__.__name__
4062
class _SymlinkFeature(Feature):
4065
return osutils.has_symlinks()
4067
def feature_name(self):
4070
SymlinkFeature = _SymlinkFeature()
4073
class _HardlinkFeature(Feature):
4076
return osutils.has_hardlinks()
4078
def feature_name(self):
4081
HardlinkFeature = _HardlinkFeature()
4084
class _OsFifoFeature(Feature):
4087
return getattr(os, 'mkfifo', None)
4089
def feature_name(self):
4090
return 'filesystem fifos'
4092
OsFifoFeature = _OsFifoFeature()
4095
class _UnicodeFilenameFeature(Feature):
4096
"""Does the filesystem support Unicode filenames?"""
4100
# Check for character combinations unlikely to be covered by any
4101
# single non-unicode encoding. We use the characters
4102
# - greek small letter alpha (U+03B1) and
4103
# - braille pattern dots-123456 (U+283F).
4104
os.stat(u'\u03b1\u283f')
4105
except UnicodeEncodeError:
4107
except (IOError, OSError):
4108
# The filesystem allows the Unicode filename but the file doesn't
4112
# The filesystem allows the Unicode filename and the file exists,
4116
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4119
class _CompatabilityThunkFeature(Feature):
4120
"""This feature is just a thunk to another feature.
4122
It issues a deprecation warning if it is accessed, to let you know that you
4123
should really use a different feature.
4126
def __init__(self, module, name, this_name, dep_version):
4127
super(_CompatabilityThunkFeature, self).__init__()
4128
self._module = module
4130
self._this_name = this_name
4131
self._dep_version = dep_version
4132
self._feature = None
4135
if self._feature is None:
4136
msg = (self._dep_version % self._this_name) + (
4137
' Use %s.%s instead.' % (self._module, self._name))
4138
symbol_versioning.warn(msg, DeprecationWarning)
4139
mod = __import__(self._module, {}, {}, [self._name])
4140
self._feature = getattr(mod, self._name)
4144
return self._feature._probe()
4147
class ModuleAvailableFeature(Feature):
4148
"""This is a feature than describes a module we want to be available.
4150
Declare the name of the module in __init__(), and then after probing, the
4151
module will be available as 'self.module'.
4153
:ivar module: The module if it is available, else None.
4156
def __init__(self, module_name):
4157
super(ModuleAvailableFeature, self).__init__()
4158
self.module_name = module_name
4162
self._module = __import__(self.module_name, {}, {}, [''])
4169
if self.available(): # Make sure the probe has been done
4173
def feature_name(self):
4174
return self.module_name
4177
# This is kept here for compatibility, it is recommended to use
4178
# 'bzrlib.tests.feature.paramiko' instead
4179
ParamikoFeature = _CompatabilityThunkFeature('bzrlib.tests.features',
4180
'paramiko', 'bzrlib.tests.ParamikoFeature', deprecated_in((2,1,0)))
4183
def probe_unicode_in_user_encoding():
4184
"""Try to encode several unicode strings to use in unicode-aware tests.
4185
Return first successfull match.
4187
:return: (unicode value, encoded plain string value) or (None, None)
4189
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4190
for uni_val in possible_vals:
4192
str_val = uni_val.encode(osutils.get_user_encoding())
4193
except UnicodeEncodeError:
4194
# Try a different character
4197
return uni_val, str_val
4201
def probe_bad_non_ascii(encoding):
4202
"""Try to find [bad] character with code [128..255]
4203
that cannot be decoded to unicode in some encoding.
4204
Return None if all non-ascii characters is valid
4207
for i in xrange(128, 256):
4210
char.decode(encoding)
4211
except UnicodeDecodeError:
4216
class _HTTPSServerFeature(Feature):
4217
"""Some tests want an https Server, check if one is available.
4219
Right now, the only way this is available is under python2.6 which provides
4230
def feature_name(self):
4231
return 'HTTPSServer'
4234
HTTPSServerFeature = _HTTPSServerFeature()
4237
class _UnicodeFilename(Feature):
4238
"""Does the filesystem support Unicode filenames?"""
4243
except UnicodeEncodeError:
4245
except (IOError, OSError):
4246
# The filesystem allows the Unicode filename but the file doesn't
4250
# The filesystem allows the Unicode filename and the file exists,
4254
UnicodeFilename = _UnicodeFilename()
4257
class _UTF8Filesystem(Feature):
4258
"""Is the filesystem UTF-8?"""
4261
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4265
UTF8Filesystem = _UTF8Filesystem()
4268
class _BreakinFeature(Feature):
4269
"""Does this platform support the breakin feature?"""
4272
from bzrlib import breakin
4273
if breakin.determine_signal() is None:
4275
if sys.platform == 'win32':
4276
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4277
# We trigger SIGBREAK via a Console api so we need ctypes to
4278
# access the function
4285
def feature_name(self):
4286
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4289
BreakinFeature = _BreakinFeature()
4292
class _CaseInsCasePresFilenameFeature(Feature):
4293
"""Is the file-system case insensitive, but case-preserving?"""
4296
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4298
# first check truly case-preserving for created files, then check
4299
# case insensitive when opening existing files.
4300
name = osutils.normpath(name)
4301
base, rel = osutils.split(name)
4302
found_rel = osutils.canonical_relpath(base, name)
4303
return (found_rel == rel
4304
and os.path.isfile(name.upper())
4305
and os.path.isfile(name.lower()))
4310
def feature_name(self):
4311
return "case-insensitive case-preserving filesystem"
4313
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4316
class _CaseInsensitiveFilesystemFeature(Feature):
4317
"""Check if underlying filesystem is case-insensitive but *not* case
4320
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4321
# more likely to be case preserving, so this case is rare.
4324
if CaseInsCasePresFilenameFeature.available():
4327
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4328
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4329
TestCaseWithMemoryTransport.TEST_ROOT = root
4331
root = TestCaseWithMemoryTransport.TEST_ROOT
4332
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4334
name_a = osutils.pathjoin(tdir, 'a')
4335
name_A = osutils.pathjoin(tdir, 'A')
4337
result = osutils.isdir(name_A)
4338
_rmtree_temp_dir(tdir)
4341
def feature_name(self):
4342
return 'case-insensitive filesystem'
4344
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4347
class _CaseSensitiveFilesystemFeature(Feature):
4350
if CaseInsCasePresFilenameFeature.available():
4352
elif CaseInsensitiveFilesystemFeature.available():
4357
def feature_name(self):
4358
return 'case-sensitive filesystem'
4360
# new coding style is for feature instances to be lowercase
4361
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4364
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4365
SubUnitFeature = _CompatabilityThunkFeature('bzrlib.tests.features', 'subunit',
4366
'bzrlib.tests.SubUnitFeature', deprecated_in((2,1,0)))
4367
# Only define SubUnitBzrRunner if subunit is available.
4369
from subunit import TestProtocolClient
4370
from subunit.test_results import AutoTimingTestResultDecorator
4371
class SubUnitBzrRunner(TextTestRunner):
4372
def run(self, test):
4373
result = AutoTimingTestResultDecorator(
4374
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
