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
17
"""Testing framework extensions"""
19
# TODO: Perhaps there should be an API to find out if bzr running under the
20
# test suite -- some plugins might want to avoid making intrusive changes if
21
# this is the case. However, we want behaviour under to test to diverge as
22
# little as possible, so this should be used rarely if it's added at all.
23
# (Suggestion from j-a-meinel, 2005-11-24)
25
# NOTE: Some classes in here use camelCaseNaming() rather than
26
# underscore_naming(). That's for consistency with unittest; it's not the
27
# general style of bzrlib. Please continue that consistency when adding e.g.
28
# new assertFoo() methods.
33
from cStringIO import StringIO
55
# nb: check this before importing anything else from within it
56
_testtools_version = getattr(testtools, '__version__', ())
57
if _testtools_version < (0, 9, 2):
58
raise ImportError("need at least testtools 0.9.2: %s is %r"
59
% (testtools.__file__, _testtools_version))
60
from testtools import content
77
transport as _mod_transport,
19
81
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',
58
# XXX: should also test bzrlib.merge_core, but they seem to be out
59
# of date with the code.
61
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
62
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
63
if m not in MODULES_TO_DOCTEST:
64
MODULES_TO_DOCTEST.append(m)
67
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
68
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
74
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
76
for m in MODULES_TO_TEST:
77
suite.addTest(TestLoader().loadTestsFromModule(m))
79
for m in (MODULES_TO_DOCTEST):
80
suite.addTest(DocTestSuite(m))
82
for p in bzrlib.plugin.all_plugins:
83
if hasattr(p, 'test_suite'):
84
suite.addTest(p.test_suite())
86
import bzrlib.merge_core
87
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
89
return run_suite(suite, 'testbzr', verbose=verbose)
82
import bzrlib.timestamp
84
import bzrlib.inventory
85
import bzrlib.iterablefile
90
# lsprof not available
92
from bzrlib.merge import merge_inner
95
from bzrlib.smart import client, request, server
97
from bzrlib import symbol_versioning
98
from bzrlib.symbol_versioning import (
106
from bzrlib.transport import (
110
from bzrlib.trace import mutter, note
111
from bzrlib.tests import (
116
from bzrlib.tests.http_server import HttpServer
117
from bzrlib.tests.TestUtil import (
121
from bzrlib.ui import NullProgressView
122
from bzrlib.ui.text import TextUIFactory
123
import bzrlib.version_info_formats.format_custom
124
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
126
# Mark this python module as being part of the implementation
127
# of unittest: this gives us better tracebacks where the last
128
# shown frame is the test code, not our assertXYZ.
131
default_transport = test_server.LocalURLServer
134
_unitialized_attr = object()
135
"""A sentinel needed to act as a default value in a method signature."""
138
# Subunit result codes, defined here to prevent a hard dependency on subunit.
143
class ExtendedTestResult(unittest._TextTestResult):
144
"""Accepts, reports and accumulates the results of running tests.
146
Compared to the unittest version this class adds support for
147
profiling, benchmarking, stopping as soon as a test fails, and
148
skipping tests. There are further-specialized subclasses for
149
different types of display.
151
When a test finishes, in whatever way, it calls one of the addSuccess,
152
addFailure or addError classes. These in turn may redirect to a more
153
specific case for the special test results supported by our extended
156
Note that just one of these objects is fed the results from many tests.
161
def __init__(self, stream, descriptions, verbosity,
165
"""Construct new TestResult.
167
:param bench_history: Optionally, a writable file object to accumulate
170
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
171
if bench_history is not None:
172
from bzrlib.version import _get_bzr_source_tree
173
src_tree = _get_bzr_source_tree()
176
revision_id = src_tree.get_parent_ids()[0]
178
# XXX: if this is a brand new tree, do the same as if there
182
# XXX: If there's no branch, what should we do?
184
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
185
self._bench_history = bench_history
186
self.ui = ui.ui_factory
189
self.failure_count = 0
190
self.known_failure_count = 0
192
self.not_applicable_count = 0
193
self.unsupported = {}
195
self._overall_start_time = time.time()
196
self._strict = strict
198
def stopTestRun(self):
201
stopTime = time.time()
202
timeTaken = stopTime - self.startTime
204
self.stream.writeln(self.separator2)
205
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
206
run, run != 1 and "s" or "", timeTaken))
207
self.stream.writeln()
208
if not self.wasSuccessful():
209
self.stream.write("FAILED (")
210
failed, errored = map(len, (self.failures, self.errors))
212
self.stream.write("failures=%d" % failed)
214
if failed: self.stream.write(", ")
215
self.stream.write("errors=%d" % errored)
216
if self.known_failure_count:
217
if failed or errored: self.stream.write(", ")
218
self.stream.write("known_failure_count=%d" %
219
self.known_failure_count)
220
self.stream.writeln(")")
222
if self.known_failure_count:
223
self.stream.writeln("OK (known_failures=%d)" %
224
self.known_failure_count)
226
self.stream.writeln("OK")
227
if self.skip_count > 0:
228
skipped = self.skip_count
229
self.stream.writeln('%d test%s skipped' %
230
(skipped, skipped != 1 and "s" or ""))
232
for feature, count in sorted(self.unsupported.items()):
233
self.stream.writeln("Missing feature '%s' skipped %d tests." %
236
ok = self.wasStrictlySuccessful()
238
ok = self.wasSuccessful()
239
if TestCase._first_thread_leaker_id:
241
'%s is leaking threads among %d leaking tests.\n' % (
242
TestCase._first_thread_leaker_id,
243
TestCase._leaking_threads_tests))
244
# We don't report the main thread as an active one.
246
'%d non-main threads were left active in the end.\n'
247
% (TestCase._active_threads - 1))
249
def getDescription(self, test):
252
def _extractBenchmarkTime(self, testCase, details=None):
253
"""Add a benchmark time for the current test case."""
254
if details and 'benchtime' in details:
255
return float(''.join(details['benchtime'].iter_bytes()))
256
return getattr(testCase, "_benchtime", None)
258
def _elapsedTestTimeString(self):
259
"""Return a time string for the overall time the current test has taken."""
260
return self._formatTime(time.time() - self._start_time)
262
def _testTimeString(self, testCase):
263
benchmark_time = self._extractBenchmarkTime(testCase)
264
if benchmark_time is not None:
265
return self._formatTime(benchmark_time) + "*"
267
return self._elapsedTestTimeString()
269
def _formatTime(self, seconds):
270
"""Format seconds as milliseconds with leading spaces."""
271
# some benchmarks can take thousands of seconds to run, so we need 8
273
return "%8dms" % (1000 * seconds)
275
def _shortened_test_description(self, test):
277
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
280
def startTest(self, test):
281
unittest.TestResult.startTest(self, test)
284
self.report_test_start(test)
285
test.number = self.count
286
self._recordTestStartTime()
288
def startTests(self):
290
if getattr(sys, 'frozen', None) is None:
291
bzr_path = osutils.realpath(sys.argv[0])
293
bzr_path = sys.executable
295
'bzr selftest: %s\n' % (bzr_path,))
298
bzrlib.__path__[0],))
300
' bzr-%s python-%s %s\n' % (
301
bzrlib.version_string,
302
bzrlib._format_version_tuple(sys.version_info),
303
platform.platform(aliased=1),
305
self.stream.write('\n')
307
def _recordTestStartTime(self):
308
"""Record that a test has started."""
309
self._start_time = time.time()
311
def _cleanupLogFile(self, test):
312
# We can only do this if we have one of our TestCases, not if
314
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
315
if setKeepLogfile is not None:
318
def addError(self, test, err):
319
"""Tell result that test finished with an error.
321
Called from the TestCase run() method when the test
322
fails with an unexpected error.
325
unittest.TestResult.addError(self, test, err)
326
self.error_count += 1
327
self.report_error(test, err)
330
self._cleanupLogFile(test)
332
def addFailure(self, test, err):
333
"""Tell result that test failed.
335
Called from the TestCase run() method when the test
336
fails because e.g. an assert() method failed.
339
unittest.TestResult.addFailure(self, test, err)
340
self.failure_count += 1
341
self.report_failure(test, err)
344
self._cleanupLogFile(test)
346
def addSuccess(self, test, details=None):
347
"""Tell result that test completed successfully.
349
Called from the TestCase run()
351
if self._bench_history is not None:
352
benchmark_time = self._extractBenchmarkTime(test, details)
353
if benchmark_time is not None:
354
self._bench_history.write("%s %s\n" % (
355
self._formatTime(benchmark_time),
357
self.report_success(test)
358
self._cleanupLogFile(test)
359
unittest.TestResult.addSuccess(self, test)
360
test._log_contents = ''
362
def addExpectedFailure(self, test, err):
363
self.known_failure_count += 1
364
self.report_known_failure(test, err)
366
def addNotSupported(self, test, feature):
367
"""The test will not be run because of a missing feature.
369
# this can be called in two different ways: it may be that the
370
# test started running, and then raised (through requireFeature)
371
# UnavailableFeature. Alternatively this method can be called
372
# while probing for features before running the test code proper; in
373
# that case we will see startTest and stopTest, but the test will
374
# never actually run.
375
self.unsupported.setdefault(str(feature), 0)
376
self.unsupported[str(feature)] += 1
377
self.report_unsupported(test, feature)
379
def addSkip(self, test, reason):
380
"""A test has not run for 'reason'."""
382
self.report_skip(test, reason)
384
def addNotApplicable(self, test, reason):
385
self.not_applicable_count += 1
386
self.report_not_applicable(test, reason)
388
def _post_mortem(self):
389
"""Start a PDB post mortem session."""
390
if os.environ.get('BZR_TEST_PDB', None):
391
import pdb;pdb.post_mortem()
393
def progress(self, offset, whence):
394
"""The test is adjusting the count of tests to run."""
395
if whence == SUBUNIT_SEEK_SET:
396
self.num_tests = offset
397
elif whence == SUBUNIT_SEEK_CUR:
398
self.num_tests += offset
400
raise errors.BzrError("Unknown whence %r" % whence)
402
def report_cleaning_up(self):
405
def startTestRun(self):
406
self.startTime = time.time()
408
def report_success(self, test):
411
def wasStrictlySuccessful(self):
412
if self.unsupported or self.known_failure_count:
414
return self.wasSuccessful()
417
class TextTestResult(ExtendedTestResult):
418
"""Displays progress and results of tests in text form"""
420
def __init__(self, stream, descriptions, verbosity,
425
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
426
bench_history, strict)
427
# We no longer pass them around, but just rely on the UIFactory stack
430
warnings.warn("Passing pb to TextTestResult is deprecated")
431
self.pb = self.ui.nested_progress_bar()
432
self.pb.show_pct = False
433
self.pb.show_spinner = False
434
self.pb.show_eta = False,
435
self.pb.show_count = False
436
self.pb.show_bar = False
437
self.pb.update_latency = 0
438
self.pb.show_transport_activity = False
440
def stopTestRun(self):
441
# called when the tests that are going to run have run
444
super(TextTestResult, self).stopTestRun()
446
def startTestRun(self):
447
super(TextTestResult, self).startTestRun()
448
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
450
def printErrors(self):
451
# clear the pb to make room for the error listing
453
super(TextTestResult, self).printErrors()
455
def _progress_prefix_text(self):
456
# the longer this text, the less space we have to show the test
458
a = '[%d' % self.count # total that have been run
459
# tests skipped as known not to be relevant are not important enough
461
## if self.skip_count:
462
## a += ', %d skip' % self.skip_count
463
## if self.known_failure_count:
464
## a += '+%dX' % self.known_failure_count
466
a +='/%d' % self.num_tests
468
runtime = time.time() - self._overall_start_time
470
a += '%dm%ds' % (runtime / 60, runtime % 60)
473
total_fail_count = self.error_count + self.failure_count
475
a += ', %d failed' % total_fail_count
476
# if self.unsupported:
477
# a += ', %d missing' % len(self.unsupported)
481
def report_test_start(self, test):
484
self._progress_prefix_text()
486
+ self._shortened_test_description(test))
488
def _test_description(self, test):
489
return self._shortened_test_description(test)
491
def report_error(self, test, err):
492
self.stream.write('ERROR: %s\n %s\n' % (
493
self._test_description(test),
497
def report_failure(self, test, err):
498
self.stream.write('FAIL: %s\n %s\n' % (
499
self._test_description(test),
503
def report_known_failure(self, test, err):
506
def report_skip(self, test, reason):
509
def report_not_applicable(self, test, reason):
512
def report_unsupported(self, test, feature):
513
"""test cannot be run because feature is missing."""
515
def report_cleaning_up(self):
516
self.pb.update('Cleaning up')
519
class VerboseTestResult(ExtendedTestResult):
520
"""Produce long output, with one line per test run plus times"""
522
def _ellipsize_to_right(self, a_string, final_width):
523
"""Truncate and pad a string, keeping the right hand side"""
524
if len(a_string) > final_width:
525
result = '...' + a_string[3-final_width:]
528
return result.ljust(final_width)
530
def startTestRun(self):
531
super(VerboseTestResult, self).startTestRun()
532
self.stream.write('running %d tests...\n' % self.num_tests)
534
def report_test_start(self, test):
536
name = self._shortened_test_description(test)
537
width = osutils.terminal_width()
538
if width is not None:
539
# width needs space for 6 char status, plus 1 for slash, plus an
540
# 11-char time string, plus a trailing blank
541
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
543
self.stream.write(self._ellipsize_to_right(name, width-18))
545
self.stream.write(name)
548
def _error_summary(self, err):
550
return '%s%s' % (indent, err[1])
552
def report_error(self, test, err):
553
self.stream.writeln('ERROR %s\n%s'
554
% (self._testTimeString(test),
555
self._error_summary(err)))
557
def report_failure(self, test, err):
558
self.stream.writeln(' FAIL %s\n%s'
559
% (self._testTimeString(test),
560
self._error_summary(err)))
562
def report_known_failure(self, test, err):
563
self.stream.writeln('XFAIL %s\n%s'
564
% (self._testTimeString(test),
565
self._error_summary(err)))
567
def report_success(self, test):
568
self.stream.writeln(' OK %s' % self._testTimeString(test))
569
for bench_called, stats in getattr(test, '_benchcalls', []):
570
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
571
stats.pprint(file=self.stream)
572
# flush the stream so that we get smooth output. This verbose mode is
573
# used to show the output in PQM.
576
def report_skip(self, test, reason):
577
self.stream.writeln(' SKIP %s\n%s'
578
% (self._testTimeString(test), reason))
580
def report_not_applicable(self, test, reason):
581
self.stream.writeln(' N/A %s\n %s'
582
% (self._testTimeString(test), reason))
584
def report_unsupported(self, test, feature):
585
"""test cannot be run because feature is missing."""
586
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
587
%(self._testTimeString(test), feature))
590
class TextTestRunner(object):
591
stop_on_failure = False
599
result_decorators=None,
601
"""Create a TextTestRunner.
603
:param result_decorators: An optional list of decorators to apply
604
to the result object being used by the runner. Decorators are
605
applied left to right - the first element in the list is the
608
# stream may know claim to know to write unicode strings, but in older
609
# pythons this goes sufficiently wrong that it is a bad idea. (
610
# specifically a built in file with encoding 'UTF-8' will still try
611
# to encode using ascii.
612
new_encoding = osutils.get_terminal_encoding()
613
codec = codecs.lookup(new_encoding)
614
if type(codec) is tuple:
618
encode = codec.encode
619
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
620
stream.encoding = new_encoding
621
self.stream = unittest._WritelnDecorator(stream)
622
self.descriptions = descriptions
623
self.verbosity = verbosity
624
self._bench_history = bench_history
625
self._strict = strict
626
self._result_decorators = result_decorators or []
629
"Run the given test case or test suite."
630
if self.verbosity == 1:
631
result_class = TextTestResult
632
elif self.verbosity >= 2:
633
result_class = VerboseTestResult
634
original_result = result_class(self.stream,
637
bench_history=self._bench_history,
640
# Signal to result objects that look at stop early policy to stop,
641
original_result.stop_early = self.stop_on_failure
642
result = original_result
643
for decorator in self._result_decorators:
644
result = decorator(result)
645
result.stop_early = self.stop_on_failure
646
result.startTestRun()
651
# higher level code uses our extended protocol to determine
652
# what exit code to give.
653
return original_result
656
def iter_suite_tests(suite):
657
"""Return all tests in a suite, recursing through nested suites"""
658
if isinstance(suite, unittest.TestCase):
660
elif isinstance(suite, unittest.TestSuite):
662
for r in iter_suite_tests(item):
665
raise Exception('unknown type %r for object %r'
666
% (type(suite), suite))
669
TestSkipped = testtools.testcase.TestSkipped
672
class TestNotApplicable(TestSkipped):
673
"""A test is not applicable to the situation where it was run.
675
This is only normally raised by parameterized tests, if they find that
676
the instance they're constructed upon does not support one aspect
681
# traceback._some_str fails to format exceptions that have the default
682
# __str__ which does an implicit ascii conversion. However, repr() on those
683
# objects works, for all that its not quite what the doctor may have ordered.
684
def _clever_some_str(value):
689
return repr(value).replace('\\n', '\n')
691
return '<unprintable %s object>' % type(value).__name__
693
traceback._some_str = _clever_some_str
696
# deprecated - use self.knownFailure(), or self.expectFailure.
697
KnownFailure = testtools.testcase._ExpectedFailure
700
class UnavailableFeature(Exception):
701
"""A feature required for this test was not available.
703
This can be considered a specialised form of SkippedTest.
705
The feature should be used to construct the exception.
709
class StringIOWrapper(object):
710
"""A wrapper around cStringIO which just adds an encoding attribute.
712
Internally we can check sys.stdout to see what the output encoding
713
should be. However, cStringIO has no encoding attribute that we can
714
set. So we wrap it instead.
719
def __init__(self, s=None):
721
self.__dict__['_cstring'] = StringIO(s)
723
self.__dict__['_cstring'] = StringIO()
725
def __getattr__(self, name, getattr=getattr):
726
return getattr(self.__dict__['_cstring'], name)
728
def __setattr__(self, name, val):
729
if name == 'encoding':
730
self.__dict__['encoding'] = val
732
return setattr(self._cstring, name, val)
735
class TestUIFactory(TextUIFactory):
736
"""A UI Factory for testing.
738
Hide the progress bar but emit note()s.
740
Allows get_password to be tested without real tty attached.
742
See also CannedInputUIFactory which lets you provide programmatic input in
745
# TODO: Capture progress events at the model level and allow them to be
746
# observed by tests that care.
748
# XXX: Should probably unify more with CannedInputUIFactory or a
749
# particular configuration of TextUIFactory, or otherwise have a clearer
750
# idea of how they're supposed to be different.
751
# See https://bugs.launchpad.net/bzr/+bug/408213
753
def __init__(self, stdout=None, stderr=None, stdin=None):
754
if stdin is not None:
755
# We use a StringIOWrapper to be able to test various
756
# encodings, but the user is still responsible to
757
# encode the string and to set the encoding attribute
758
# of StringIOWrapper.
759
stdin = StringIOWrapper(stdin)
760
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
762
def get_non_echoed_password(self):
763
"""Get password from stdin without trying to handle the echo mode"""
764
password = self.stdin.readline()
767
if password[-1] == '\n':
768
password = password[:-1]
771
def make_progress_view(self):
772
return NullProgressView()
775
class TestCase(testtools.TestCase):
776
"""Base class for bzr unit tests.
778
Tests that need access to disk resources should subclass
779
TestCaseInTempDir not TestCase.
781
Error and debug log messages are redirected from their usual
782
location into a temporary file, the contents of which can be
783
retrieved by _get_log(). We use a real OS file, not an in-memory object,
784
so that it can also capture file IO. When the test completes this file
785
is read into memory and removed from disk.
787
There are also convenience functions to invoke bzr's command-line
788
routine, and to build and check bzr trees.
790
In addition to the usual method of overriding tearDown(), this class also
791
allows subclasses to register functions into the _cleanups list, which is
792
run in order as the object is torn down. It's less likely this will be
793
accidentally overlooked.
796
_active_threads = None
797
_leaking_threads_tests = 0
798
_first_thread_leaker_id = None
799
_log_file_name = None
800
# record lsprof data when performing benchmark calls.
801
_gather_lsprof_in_benchmarks = False
803
def __init__(self, methodName='testMethod'):
804
super(TestCase, self).__init__(methodName)
806
self._directory_isolation = True
807
self.exception_handlers.insert(0,
808
(UnavailableFeature, self._do_unsupported_or_skip))
809
self.exception_handlers.insert(0,
810
(TestNotApplicable, self._do_not_applicable))
813
super(TestCase, self).setUp()
814
for feature in getattr(self, '_test_needs_features', []):
815
self.requireFeature(feature)
816
self._log_contents = None
817
self.addDetail("log", content.Content(content.ContentType("text",
818
"plain", {"charset": "utf8"}),
819
lambda:[self._get_log(keep_log_file=True)]))
820
self._cleanEnvironment()
823
self._benchcalls = []
824
self._benchtime = None
826
self._track_transports()
828
self._clear_debug_flags()
829
TestCase._active_threads = threading.activeCount()
830
self.addCleanup(self._check_leaked_threads)
835
pdb.Pdb().set_trace(sys._getframe().f_back)
837
def _check_leaked_threads(self):
838
active = threading.activeCount()
839
leaked_threads = active - TestCase._active_threads
840
TestCase._active_threads = active
841
# If some tests make the number of threads *decrease*, we'll consider
842
# that they are just observing old threads dieing, not agressively kill
843
# random threads. So we don't report these tests as leaking. The risk
844
# is that we have false positives that way (the test see 2 threads
845
# going away but leak one) but it seems less likely than the actual
846
# false positives (the test see threads going away and does not leak).
847
if leaked_threads > 0:
848
TestCase._leaking_threads_tests += 1
849
if TestCase._first_thread_leaker_id is None:
850
TestCase._first_thread_leaker_id = self.id()
852
def _clear_debug_flags(self):
853
"""Prevent externally set debug flags affecting tests.
855
Tests that want to use debug flags can just set them in the
856
debug_flags set during setup/teardown.
858
# Start with a copy of the current debug flags we can safely modify.
859
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
860
if 'allow_debug' not in selftest_debug_flags:
861
debug.debug_flags.clear()
862
if 'disable_lock_checks' not in selftest_debug_flags:
863
debug.debug_flags.add('strict_locks')
865
def _clear_hooks(self):
866
# prevent hooks affecting tests
867
self._preserved_hooks = {}
868
for key, factory in hooks.known_hooks.items():
869
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
870
current_hooks = hooks.known_hooks_key_to_object(key)
871
self._preserved_hooks[parent] = (name, current_hooks)
872
self.addCleanup(self._restoreHooks)
873
for key, factory in hooks.known_hooks.items():
874
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
875
setattr(parent, name, factory())
876
# this hook should always be installed
877
request._install_hook()
879
def disable_directory_isolation(self):
880
"""Turn off directory isolation checks."""
881
self._directory_isolation = False
883
def enable_directory_isolation(self):
884
"""Enable directory isolation checks."""
885
self._directory_isolation = True
887
def _silenceUI(self):
888
"""Turn off UI for duration of test"""
889
# by default the UI is off; tests can turn it on if they want it.
890
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
892
def _check_locks(self):
893
"""Check that all lock take/release actions have been paired."""
894
# We always check for mismatched locks. If a mismatch is found, we
895
# fail unless -Edisable_lock_checks is supplied to selftest, in which
896
# case we just print a warning.
898
acquired_locks = [lock for action, lock in self._lock_actions
899
if action == 'acquired']
900
released_locks = [lock for action, lock in self._lock_actions
901
if action == 'released']
902
broken_locks = [lock for action, lock in self._lock_actions
903
if action == 'broken']
904
# trivially, given the tests for lock acquistion and release, if we
905
# have as many in each list, it should be ok. Some lock tests also
906
# break some locks on purpose and should be taken into account by
907
# considering that breaking a lock is just a dirty way of releasing it.
908
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
909
message = ('Different number of acquired and '
910
'released or broken locks. (%s, %s + %s)' %
911
(acquired_locks, released_locks, broken_locks))
912
if not self._lock_check_thorough:
913
# Rather than fail, just warn
914
print "Broken test %s: %s" % (self, message)
918
def _track_locks(self):
919
"""Track lock activity during tests."""
920
self._lock_actions = []
921
if 'disable_lock_checks' in selftest_debug_flags:
922
self._lock_check_thorough = False
924
self._lock_check_thorough = True
926
self.addCleanup(self._check_locks)
927
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
928
self._lock_acquired, None)
929
_mod_lock.Lock.hooks.install_named_hook('lock_released',
930
self._lock_released, None)
931
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
932
self._lock_broken, None)
934
def _lock_acquired(self, result):
935
self._lock_actions.append(('acquired', result))
937
def _lock_released(self, result):
938
self._lock_actions.append(('released', result))
940
def _lock_broken(self, result):
941
self._lock_actions.append(('broken', result))
943
def permit_dir(self, name):
944
"""Permit a directory to be used by this test. See permit_url."""
945
name_transport = _mod_transport.get_transport(name)
946
self.permit_url(name)
947
self.permit_url(name_transport.base)
949
def permit_url(self, url):
950
"""Declare that url is an ok url to use in this test.
952
Do this for memory transports, temporary test directory etc.
954
Do not do this for the current working directory, /tmp, or any other
955
preexisting non isolated url.
957
if not url.endswith('/'):
959
self._bzr_selftest_roots.append(url)
961
def permit_source_tree_branch_repo(self):
962
"""Permit the source tree bzr is running from to be opened.
964
Some code such as bzrlib.version attempts to read from the bzr branch
965
that bzr is executing from (if any). This method permits that directory
966
to be used in the test suite.
968
path = self.get_source_path()
969
self.record_directory_isolation()
972
workingtree.WorkingTree.open(path)
973
except (errors.NotBranchError, errors.NoWorkingTree):
976
self.enable_directory_isolation()
978
def _preopen_isolate_transport(self, transport):
979
"""Check that all transport openings are done in the test work area."""
980
while isinstance(transport, pathfilter.PathFilteringTransport):
981
# Unwrap pathfiltered transports
982
transport = transport.server.backing_transport.clone(
983
transport._filter('.'))
985
# ReadonlySmartTCPServer_for_testing decorates the backing transport
986
# urls it is given by prepending readonly+. This is appropriate as the
987
# client shouldn't know that the server is readonly (or not readonly).
988
# We could register all servers twice, with readonly+ prepending, but
989
# that makes for a long list; this is about the same but easier to
991
if url.startswith('readonly+'):
992
url = url[len('readonly+'):]
993
self._preopen_isolate_url(url)
995
def _preopen_isolate_url(self, url):
996
if not self._directory_isolation:
998
if self._directory_isolation == 'record':
999
self._bzr_selftest_roots.append(url)
1001
# This prevents all transports, including e.g. sftp ones backed on disk
1002
# from working unless they are explicitly granted permission. We then
1003
# depend on the code that sets up test transports to check that they are
1004
# appropriately isolated and enable their use by calling
1005
# self.permit_transport()
1006
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1007
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1008
% (url, self._bzr_selftest_roots))
1010
def record_directory_isolation(self):
1011
"""Gather accessed directories to permit later access.
1013
This is used for tests that access the branch bzr is running from.
1015
self._directory_isolation = "record"
1017
def start_server(self, transport_server, backing_server=None):
1018
"""Start transport_server for this test.
1020
This starts the server, registers a cleanup for it and permits the
1021
server's urls to be used.
1023
if backing_server is None:
1024
transport_server.start_server()
1026
transport_server.start_server(backing_server)
1027
self.addCleanup(transport_server.stop_server)
1028
# Obtain a real transport because if the server supplies a password, it
1029
# will be hidden from the base on the client side.
1030
t = _mod_transport.get_transport(transport_server.get_url())
1031
# Some transport servers effectively chroot the backing transport;
1032
# others like SFTPServer don't - users of the transport can walk up the
1033
# transport to read the entire backing transport. This wouldn't matter
1034
# except that the workdir tests are given - and that they expect the
1035
# server's url to point at - is one directory under the safety net. So
1036
# Branch operations into the transport will attempt to walk up one
1037
# directory. Chrooting all servers would avoid this but also mean that
1038
# we wouldn't be testing directly against non-root urls. Alternatively
1039
# getting the test framework to start the server with a backing server
1040
# at the actual safety net directory would work too, but this then
1041
# means that the self.get_url/self.get_transport methods would need
1042
# to transform all their results. On balance its cleaner to handle it
1043
# here, and permit a higher url when we have one of these transports.
1044
if t.base.endswith('/work/'):
1045
# we have safety net/test root/work
1046
t = t.clone('../..')
1047
elif isinstance(transport_server,
1048
test_server.SmartTCPServer_for_testing):
1049
# The smart server adds a path similar to work, which is traversed
1050
# up from by the client. But the server is chrooted - the actual
1051
# backing transport is not escaped from, and VFS requests to the
1052
# root will error (because they try to escape the chroot).
1054
while t2.base != t.base:
1057
self.permit_url(t.base)
1059
def _track_transports(self):
1060
"""Install checks for transport usage."""
1061
# TestCase has no safe place it can write to.
1062
self._bzr_selftest_roots = []
1063
# Currently the easiest way to be sure that nothing is going on is to
1064
# hook into bzr dir opening. This leaves a small window of error for
1065
# transport tests, but they are well known, and we can improve on this
1067
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1068
self._preopen_isolate_transport, "Check bzr directories are safe.")
1070
def _ndiff_strings(self, a, b):
1071
"""Return ndiff between two strings containing lines.
1073
A trailing newline is added if missing to make the strings
1075
if b and b[-1] != '\n':
1077
if a and a[-1] != '\n':
1079
difflines = difflib.ndiff(a.splitlines(True),
1081
linejunk=lambda x: False,
1082
charjunk=lambda x: False)
1083
return ''.join(difflines)
1085
def assertEqual(self, a, b, message=''):
1089
except UnicodeError, e:
1090
# If we can't compare without getting a UnicodeError, then
1091
# obviously they are different
1092
mutter('UnicodeError: %s', e)
1095
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1097
pprint.pformat(a), pprint.pformat(b)))
1099
assertEquals = assertEqual
1101
def assertEqualDiff(self, a, b, message=None):
1102
"""Assert two texts are equal, if not raise an exception.
1104
This is intended for use with multi-line strings where it can
1105
be hard to find the differences by eye.
1107
# TODO: perhaps override assertEquals to call this for strings?
1111
message = "texts not equal:\n"
1113
message = 'first string is missing a final newline.\n'
1115
message = 'second string is missing a final newline.\n'
1116
raise AssertionError(message +
1117
self._ndiff_strings(a, b))
1119
def assertEqualMode(self, mode, mode_test):
1120
self.assertEqual(mode, mode_test,
1121
'mode mismatch %o != %o' % (mode, mode_test))
1123
def assertEqualStat(self, expected, actual):
1124
"""assert that expected and actual are the same stat result.
1126
:param expected: A stat result.
1127
:param actual: A stat result.
1128
:raises AssertionError: If the expected and actual stat values differ
1129
other than by atime.
1131
self.assertEqual(expected.st_size, actual.st_size,
1132
'st_size did not match')
1133
self.assertEqual(expected.st_mtime, actual.st_mtime,
1134
'st_mtime did not match')
1135
self.assertEqual(expected.st_ctime, actual.st_ctime,
1136
'st_ctime did not match')
1137
if sys.platform != 'win32':
1138
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1139
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1140
# odd. Regardless we shouldn't actually try to assert anything
1141
# about their values
1142
self.assertEqual(expected.st_dev, actual.st_dev,
1143
'st_dev did not match')
1144
self.assertEqual(expected.st_ino, actual.st_ino,
1145
'st_ino did not match')
1146
self.assertEqual(expected.st_mode, actual.st_mode,
1147
'st_mode did not match')
1149
def assertLength(self, length, obj_with_len):
1150
"""Assert that obj_with_len is of length length."""
1151
if len(obj_with_len) != length:
1152
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1153
length, len(obj_with_len), obj_with_len))
1155
def assertLogsError(self, exception_class, func, *args, **kwargs):
1156
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1158
from bzrlib import trace
1160
orig_log_exception_quietly = trace.log_exception_quietly
1163
orig_log_exception_quietly()
1164
captured.append(sys.exc_info())
1165
trace.log_exception_quietly = capture
1166
func(*args, **kwargs)
1168
trace.log_exception_quietly = orig_log_exception_quietly
1169
self.assertLength(1, captured)
1170
err = captured[0][1]
1171
self.assertIsInstance(err, exception_class)
1174
def assertPositive(self, val):
1175
"""Assert that val is greater than 0."""
1176
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1178
def assertNegative(self, val):
1179
"""Assert that val is less than 0."""
1180
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1182
def assertStartsWith(self, s, prefix):
1183
if not s.startswith(prefix):
1184
raise AssertionError('string %r does not start with %r' % (s, prefix))
1186
def assertEndsWith(self, s, suffix):
1187
"""Asserts that s ends with suffix."""
1188
if not s.endswith(suffix):
1189
raise AssertionError('string %r does not end with %r' % (s, suffix))
1191
def assertContainsRe(self, haystack, needle_re, flags=0):
1192
"""Assert that a contains something matching a regular expression."""
1193
if not re.search(needle_re, haystack, flags):
1194
if '\n' in haystack or len(haystack) > 60:
1195
# a long string, format it in a more readable way
1196
raise AssertionError(
1197
'pattern "%s" not found in\n"""\\\n%s"""\n'
1198
% (needle_re, haystack))
1200
raise AssertionError('pattern "%s" not found in "%s"'
1201
% (needle_re, haystack))
1203
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1204
"""Assert that a does not match a regular expression"""
1205
if re.search(needle_re, haystack, flags):
1206
raise AssertionError('pattern "%s" found in "%s"'
1207
% (needle_re, haystack))
1209
def assertContainsString(self, haystack, needle):
1210
if haystack.find(needle) == -1:
1211
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1213
def assertSubset(self, sublist, superlist):
1214
"""Assert that every entry in sublist is present in superlist."""
1215
missing = set(sublist) - set(superlist)
1216
if len(missing) > 0:
1217
raise AssertionError("value(s) %r not present in container %r" %
1218
(missing, superlist))
1220
def assertListRaises(self, excClass, func, *args, **kwargs):
1221
"""Fail unless excClass is raised when the iterator from func is used.
1223
Many functions can return generators this makes sure
1224
to wrap them in a list() call to make sure the whole generator
1225
is run, and that the proper exception is raised.
1228
list(func(*args, **kwargs))
1232
if getattr(excClass,'__name__', None) is not None:
1233
excName = excClass.__name__
1235
excName = str(excClass)
1236
raise self.failureException, "%s not raised" % excName
1238
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1239
"""Assert that a callable raises a particular exception.
1241
:param excClass: As for the except statement, this may be either an
1242
exception class, or a tuple of classes.
1243
:param callableObj: A callable, will be passed ``*args`` and
1246
Returns the exception so that you can examine it.
1249
callableObj(*args, **kwargs)
1253
if getattr(excClass,'__name__', None) is not None:
1254
excName = excClass.__name__
1257
excName = str(excClass)
1258
raise self.failureException, "%s not raised" % excName
1260
def assertIs(self, left, right, message=None):
1261
if not (left is right):
1262
if message is not None:
1263
raise AssertionError(message)
1265
raise AssertionError("%r is not %r." % (left, right))
1267
def assertIsNot(self, left, right, message=None):
1269
if message is not None:
1270
raise AssertionError(message)
1272
raise AssertionError("%r is %r." % (left, right))
1274
def assertTransportMode(self, transport, path, mode):
1275
"""Fail if a path does not have mode "mode".
1277
If modes are not supported on this transport, the assertion is ignored.
1279
if not transport._can_roundtrip_unix_modebits():
1281
path_stat = transport.stat(path)
1282
actual_mode = stat.S_IMODE(path_stat.st_mode)
1283
self.assertEqual(mode, actual_mode,
1284
'mode of %r incorrect (%s != %s)'
1285
% (path, oct(mode), oct(actual_mode)))
1287
def assertIsSameRealPath(self, path1, path2):
1288
"""Fail if path1 and path2 points to different files"""
1289
self.assertEqual(osutils.realpath(path1),
1290
osutils.realpath(path2),
1291
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1293
def assertIsInstance(self, obj, kls, msg=None):
1294
"""Fail if obj is not an instance of kls
1296
:param msg: Supplementary message to show if the assertion fails.
1298
if not isinstance(obj, kls):
1299
m = "%r is an instance of %s rather than %s" % (
1300
obj, obj.__class__, kls)
1305
def assertFileEqual(self, content, path):
1306
"""Fail if path does not contain 'content'."""
1307
self.failUnlessExists(path)
1308
f = file(path, 'rb')
1313
self.assertEqualDiff(content, s)
1315
def assertDocstring(self, expected_docstring, obj):
1316
"""Fail if obj does not have expected_docstring"""
1318
# With -OO the docstring should be None instead
1319
self.assertIs(obj.__doc__, None)
1321
self.assertEqual(expected_docstring, obj.__doc__)
1323
def failUnlessExists(self, path):
1324
"""Fail unless path or paths, which may be abs or relative, exist."""
1325
if not isinstance(path, basestring):
1327
self.failUnlessExists(p)
1329
self.failUnless(osutils.lexists(path),path+" does not exist")
1331
def failIfExists(self, path):
1332
"""Fail if path or paths, which may be abs or relative, exist."""
1333
if not isinstance(path, basestring):
1335
self.failIfExists(p)
1337
self.failIf(osutils.lexists(path),path+" exists")
1339
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1340
"""A helper for callDeprecated and applyDeprecated.
1342
:param a_callable: A callable to call.
1343
:param args: The positional arguments for the callable
1344
:param kwargs: The keyword arguments for the callable
1345
:return: A tuple (warnings, result). result is the result of calling
1346
a_callable(``*args``, ``**kwargs``).
1349
def capture_warnings(msg, cls=None, stacklevel=None):
1350
# we've hooked into a deprecation specific callpath,
1351
# only deprecations should getting sent via it.
1352
self.assertEqual(cls, DeprecationWarning)
1353
local_warnings.append(msg)
1354
original_warning_method = symbol_versioning.warn
1355
symbol_versioning.set_warning_method(capture_warnings)
1357
result = a_callable(*args, **kwargs)
1359
symbol_versioning.set_warning_method(original_warning_method)
1360
return (local_warnings, result)
1362
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1363
"""Call a deprecated callable without warning the user.
1365
Note that this only captures warnings raised by symbol_versioning.warn,
1366
not other callers that go direct to the warning module.
1368
To test that a deprecated method raises an error, do something like
1371
self.assertRaises(errors.ReservedId,
1372
self.applyDeprecated,
1373
deprecated_in((1, 5, 0)),
1377
:param deprecation_format: The deprecation format that the callable
1378
should have been deprecated with. This is the same type as the
1379
parameter to deprecated_method/deprecated_function. If the
1380
callable is not deprecated with this format, an assertion error
1382
:param a_callable: A callable to call. This may be a bound method or
1383
a regular function. It will be called with ``*args`` and
1385
:param args: The positional arguments for the callable
1386
:param kwargs: The keyword arguments for the callable
1387
:return: The result of a_callable(``*args``, ``**kwargs``)
1389
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1391
expected_first_warning = symbol_versioning.deprecation_string(
1392
a_callable, deprecation_format)
1393
if len(call_warnings) == 0:
1394
self.fail("No deprecation warning generated by call to %s" %
1396
self.assertEqual(expected_first_warning, call_warnings[0])
1399
def callCatchWarnings(self, fn, *args, **kw):
1400
"""Call a callable that raises python warnings.
1402
The caller's responsible for examining the returned warnings.
1404
If the callable raises an exception, the exception is not
1405
caught and propagates up to the caller. In that case, the list
1406
of warnings is not available.
1408
:returns: ([warning_object, ...], fn_result)
1410
# XXX: This is not perfect, because it completely overrides the
1411
# warnings filters, and some code may depend on suppressing particular
1412
# warnings. It's the easiest way to insulate ourselves from -Werror,
1413
# though. -- Andrew, 20071062
1415
def _catcher(message, category, filename, lineno, file=None, line=None):
1416
# despite the name, 'message' is normally(?) a Warning subclass
1418
wlist.append(message)
1419
saved_showwarning = warnings.showwarning
1420
saved_filters = warnings.filters
1422
warnings.showwarning = _catcher
1423
warnings.filters = []
1424
result = fn(*args, **kw)
1426
warnings.showwarning = saved_showwarning
1427
warnings.filters = saved_filters
1428
return wlist, result
1430
def callDeprecated(self, expected, callable, *args, **kwargs):
1431
"""Assert that a callable is deprecated in a particular way.
1433
This is a very precise test for unusual requirements. The
1434
applyDeprecated helper function is probably more suited for most tests
1435
as it allows you to simply specify the deprecation format being used
1436
and will ensure that that is issued for the function being called.
1438
Note that this only captures warnings raised by symbol_versioning.warn,
1439
not other callers that go direct to the warning module. To catch
1440
general warnings, use callCatchWarnings.
1442
:param expected: a list of the deprecation warnings expected, in order
1443
:param callable: The callable to call
1444
:param args: The positional arguments for the callable
1445
:param kwargs: The keyword arguments for the callable
1447
call_warnings, result = self._capture_deprecation_warnings(callable,
1449
self.assertEqual(expected, call_warnings)
1452
def _startLogFile(self):
1453
"""Send bzr and test log messages to a temporary file.
1455
The file is removed as the test is torn down.
1457
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1458
self._log_file = os.fdopen(fileno, 'w+')
1459
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1460
self._log_file_name = name
1461
self.addCleanup(self._finishLogFile)
1463
def _finishLogFile(self):
1464
"""Finished with the log file.
1466
Close the file and delete it, unless setKeepLogfile was called.
1468
if bzrlib.trace._trace_file:
1469
# flush the log file, to get all content
1470
bzrlib.trace._trace_file.flush()
1471
bzrlib.trace.pop_log_file(self._log_memento)
1472
# Cache the log result and delete the file on disk
1473
self._get_log(False)
1475
def thisFailsStrictLockCheck(self):
1476
"""It is known that this test would fail with -Dstrict_locks.
1478
By default, all tests are run with strict lock checking unless
1479
-Edisable_lock_checks is supplied. However there are some tests which
1480
we know fail strict locks at this point that have not been fixed.
1481
They should call this function to disable the strict checking.
1483
This should be used sparingly, it is much better to fix the locking
1484
issues rather than papering over the problem by calling this function.
1486
debug.debug_flags.discard('strict_locks')
1488
def addCleanup(self, callable, *args, **kwargs):
1489
"""Arrange to run a callable when this case is torn down.
1491
Callables are run in the reverse of the order they are registered,
1492
ie last-in first-out.
1494
self._cleanups.append((callable, args, kwargs))
1496
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1497
"""Overrides an object attribute restoring it after the test.
1499
:param obj: The object that will be mutated.
1501
:param attr_name: The attribute name we want to preserve/override in
1504
:param new: The optional value we want to set the attribute to.
1506
:returns: The actual attr value.
1508
value = getattr(obj, attr_name)
1509
# The actual value is captured by the call below
1510
self.addCleanup(setattr, obj, attr_name, value)
1511
if new is not _unitialized_attr:
1512
setattr(obj, attr_name, new)
1515
def _cleanEnvironment(self):
1517
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1518
'HOME': os.getcwd(),
1519
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1520
# tests do check our impls match APPDATA
1521
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1525
'BZREMAIL': None, # may still be present in the environment
1526
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
1527
'BZR_PROGRESS_BAR': None,
1529
'BZR_PLUGIN_PATH': None,
1530
'BZR_DISABLE_PLUGINS': None,
1531
'BZR_PLUGINS_AT': None,
1532
'BZR_CONCURRENCY': None,
1533
# Make sure that any text ui tests are consistent regardless of
1534
# the environment the test case is run in; you may want tests that
1535
# test other combinations. 'dumb' is a reasonable guess for tests
1536
# going to a pipe or a StringIO.
1540
'BZR_COLUMNS': '80',
1542
'SSH_AUTH_SOCK': None,
1546
'https_proxy': None,
1547
'HTTPS_PROXY': None,
1552
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1553
# least. If you do (care), please update this comment
1557
'BZR_REMOTE_PATH': None,
1558
# Generally speaking, we don't want apport reporting on crashes in
1559
# the test envirnoment unless we're specifically testing apport,
1560
# so that it doesn't leak into the real system environment. We
1561
# use an env var so it propagates to subprocesses.
1562
'APPORT_DISABLE': '1',
1565
self.addCleanup(self._restoreEnvironment)
1566
for name, value in new_env.iteritems():
1567
self._captureVar(name, value)
1569
def _captureVar(self, name, newvalue):
1570
"""Set an environment variable, and reset it when finished."""
1571
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1573
def _restoreEnvironment(self):
1574
for name, value in self._old_env.iteritems():
1575
osutils.set_or_unset_env(name, value)
1577
def _restoreHooks(self):
1578
for klass, (name, hooks) in self._preserved_hooks.items():
1579
setattr(klass, name, hooks)
1581
def knownFailure(self, reason):
1582
"""This test has failed for some known reason."""
1583
raise KnownFailure(reason)
1585
def _do_skip(self, result, reason):
1586
addSkip = getattr(result, 'addSkip', None)
1587
if not callable(addSkip):
1588
result.addSuccess(result)
1590
addSkip(self, reason)
1593
def _do_known_failure(self, result, e):
1594
err = sys.exc_info()
1595
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1596
if addExpectedFailure is not None:
1597
addExpectedFailure(self, err)
1599
result.addSuccess(self)
1602
def _do_not_applicable(self, result, e):
1604
reason = 'No reason given'
1607
addNotApplicable = getattr(result, 'addNotApplicable', None)
1608
if addNotApplicable is not None:
1609
result.addNotApplicable(self, reason)
1611
self._do_skip(result, reason)
1614
def _do_unsupported_or_skip(self, result, e):
1616
addNotSupported = getattr(result, 'addNotSupported', None)
1617
if addNotSupported is not None:
1618
result.addNotSupported(self, reason)
1620
self._do_skip(result, reason)
1622
def time(self, callable, *args, **kwargs):
1623
"""Run callable and accrue the time it takes to the benchmark time.
1625
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1626
this will cause lsprofile statistics to be gathered and stored in
1629
if self._benchtime is None:
1630
self.addDetail('benchtime', content.Content(content.ContentType(
1631
"text", "plain"), lambda:[str(self._benchtime)]))
1635
if not self._gather_lsprof_in_benchmarks:
1636
return callable(*args, **kwargs)
1638
# record this benchmark
1639
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1641
self._benchcalls.append(((callable, args, kwargs), stats))
1644
self._benchtime += time.time() - start
1646
def log(self, *args):
1649
def _get_log(self, keep_log_file=False):
1650
"""Internal helper to get the log from bzrlib.trace for this test.
1652
Please use self.getDetails, or self.get_log to access this in test case
1655
:param keep_log_file: When True, if the log is still a file on disk
1656
leave it as a file on disk. When False, if the log is still a file
1657
on disk, the log file is deleted and the log preserved as
1659
:return: A string containing the log.
1661
if self._log_contents is not None:
1663
self._log_contents.decode('utf8')
1664
except UnicodeDecodeError:
1665
unicodestr = self._log_contents.decode('utf8', 'replace')
1666
self._log_contents = unicodestr.encode('utf8')
1667
return self._log_contents
1669
if bzrlib.trace._trace_file:
1670
# flush the log file, to get all content
1671
bzrlib.trace._trace_file.flush()
1672
if self._log_file_name is not None:
1673
logfile = open(self._log_file_name)
1675
log_contents = logfile.read()
1679
log_contents.decode('utf8')
1680
except UnicodeDecodeError:
1681
unicodestr = log_contents.decode('utf8', 'replace')
1682
log_contents = unicodestr.encode('utf8')
1683
if not keep_log_file:
1685
max_close_attempts = 100
1686
first_close_error = None
1687
while close_attempts < max_close_attempts:
1690
self._log_file.close()
1691
except IOError, ioe:
1692
if ioe.errno is None:
1693
# No errno implies 'close() called during
1694
# concurrent operation on the same file object', so
1695
# retry. Probably a thread is trying to write to
1697
if first_close_error is None:
1698
first_close_error = ioe
1703
if close_attempts > 1:
1705
'Unable to close log file on first attempt, '
1706
'will retry: %s\n' % (first_close_error,))
1707
if close_attempts == max_close_attempts:
1709
'Unable to close log file after %d attempts.\n'
1710
% (max_close_attempts,))
1711
self._log_file = None
1712
# Permit multiple calls to get_log until we clean it up in
1714
self._log_contents = log_contents
1716
os.remove(self._log_file_name)
1718
if sys.platform == 'win32' and e.errno == errno.EACCES:
1719
sys.stderr.write(('Unable to delete log file '
1720
' %r\n' % self._log_file_name))
1723
self._log_file_name = None
1726
return "No log file content and no log file name."
1729
"""Get a unicode string containing the log from bzrlib.trace.
1731
Undecodable characters are replaced.
1733
return u"".join(self.getDetails()['log'].iter_text())
1735
def requireFeature(self, feature):
1736
"""This test requires a specific feature is available.
1738
:raises UnavailableFeature: When feature is not available.
1740
if not feature.available():
1741
raise UnavailableFeature(feature)
1743
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1745
"""Run bazaar command line, splitting up a string command line."""
1746
if isinstance(args, basestring):
1747
# shlex don't understand unicode strings,
1748
# so args should be plain string (bialix 20070906)
1749
args = list(shlex.split(str(args)))
1750
return self._run_bzr_core(args, retcode=retcode,
1751
encoding=encoding, stdin=stdin, working_dir=working_dir,
1754
def _run_bzr_core(self, args, retcode, encoding, stdin,
1756
# Clear chk_map page cache, because the contents are likely to mask
1758
chk_map.clear_cache()
1759
if encoding is None:
1760
encoding = osutils.get_user_encoding()
1761
stdout = StringIOWrapper()
1762
stderr = StringIOWrapper()
1763
stdout.encoding = encoding
1764
stderr.encoding = encoding
1766
self.log('run bzr: %r', args)
1767
# FIXME: don't call into logging here
1768
handler = logging.StreamHandler(stderr)
1769
handler.setLevel(logging.INFO)
1770
logger = logging.getLogger('')
1771
logger.addHandler(handler)
1772
old_ui_factory = ui.ui_factory
1773
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1776
if working_dir is not None:
1777
cwd = osutils.getcwd()
1778
os.chdir(working_dir)
1782
result = self.apply_redirected(ui.ui_factory.stdin,
1784
bzrlib.commands.run_bzr_catch_user_errors,
1786
except KeyboardInterrupt:
1787
# Reraise KeyboardInterrupt with contents of redirected stdout
1788
# and stderr as arguments, for tests which are interested in
1789
# stdout and stderr and are expecting the exception.
1790
out = stdout.getvalue()
1791
err = stderr.getvalue()
1793
self.log('output:\n%r', out)
1795
self.log('errors:\n%r', err)
1796
raise KeyboardInterrupt(out, err)
1798
logger.removeHandler(handler)
1799
ui.ui_factory = old_ui_factory
1803
out = stdout.getvalue()
1804
err = stderr.getvalue()
1806
self.log('output:\n%r', out)
1808
self.log('errors:\n%r', err)
1809
if retcode is not None:
1810
self.assertEquals(retcode, result,
1811
message='Unexpected return code')
1812
return result, out, err
1814
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1815
working_dir=None, error_regexes=[], output_encoding=None):
1816
"""Invoke bzr, as if it were run from the command line.
1818
The argument list should not include the bzr program name - the
1819
first argument is normally the bzr command. Arguments may be
1820
passed in three ways:
1822
1- A list of strings, eg ["commit", "a"]. This is recommended
1823
when the command contains whitespace or metacharacters, or
1824
is built up at run time.
1826
2- A single string, eg "add a". This is the most convenient
1827
for hardcoded commands.
1829
This runs bzr through the interface that catches and reports
1830
errors, and with logging set to something approximating the
1831
default, so that error reporting can be checked.
1833
This should be the main method for tests that want to exercise the
1834
overall behavior of the bzr application (rather than a unit test
1835
or a functional test of the library.)
1837
This sends the stdout/stderr results into the test's log,
1838
where it may be useful for debugging. See also run_captured.
1840
:keyword stdin: A string to be used as stdin for the command.
1841
:keyword retcode: The status code the command should return;
1843
:keyword working_dir: The directory to run the command in
1844
:keyword error_regexes: A list of expected error messages. If
1845
specified they must be seen in the error output of the command.
1847
retcode, out, err = self._run_bzr_autosplit(
1852
working_dir=working_dir,
1854
self.assertIsInstance(error_regexes, (list, tuple))
1855
for regex in error_regexes:
1856
self.assertContainsRe(err, regex)
1859
def run_bzr_error(self, error_regexes, *args, **kwargs):
1860
"""Run bzr, and check that stderr contains the supplied regexes
1862
:param error_regexes: Sequence of regular expressions which
1863
must each be found in the error output. The relative ordering
1865
:param args: command-line arguments for bzr
1866
:param kwargs: Keyword arguments which are interpreted by run_bzr
1867
This function changes the default value of retcode to be 3,
1868
since in most cases this is run when you expect bzr to fail.
1870
:return: (out, err) The actual output of running the command (in case
1871
you want to do more inspection)
1875
# Make sure that commit is failing because there is nothing to do
1876
self.run_bzr_error(['no changes to commit'],
1877
['commit', '-m', 'my commit comment'])
1878
# Make sure --strict is handling an unknown file, rather than
1879
# giving us the 'nothing to do' error
1880
self.build_tree(['unknown'])
1881
self.run_bzr_error(['Commit refused because there are unknown files'],
1882
['commit', --strict', '-m', 'my commit comment'])
1884
kwargs.setdefault('retcode', 3)
1885
kwargs['error_regexes'] = error_regexes
1886
out, err = self.run_bzr(*args, **kwargs)
1889
def run_bzr_subprocess(self, *args, **kwargs):
1890
"""Run bzr in a subprocess for testing.
1892
This starts a new Python interpreter and runs bzr in there.
1893
This should only be used for tests that have a justifiable need for
1894
this isolation: e.g. they are testing startup time, or signal
1895
handling, or early startup code, etc. Subprocess code can't be
1896
profiled or debugged so easily.
1898
:keyword retcode: The status code that is expected. Defaults to 0. If
1899
None is supplied, the status code is not checked.
1900
:keyword env_changes: A dictionary which lists changes to environment
1901
variables. A value of None will unset the env variable.
1902
The values must be strings. The change will only occur in the
1903
child, so you don't need to fix the environment after running.
1904
:keyword universal_newlines: Convert CRLF => LF
1905
:keyword allow_plugins: By default the subprocess is run with
1906
--no-plugins to ensure test reproducibility. Also, it is possible
1907
for system-wide plugins to create unexpected output on stderr,
1908
which can cause unnecessary test failures.
1910
env_changes = kwargs.get('env_changes', {})
1911
working_dir = kwargs.get('working_dir', None)
1912
allow_plugins = kwargs.get('allow_plugins', False)
1914
if isinstance(args[0], list):
1916
elif isinstance(args[0], basestring):
1917
args = list(shlex.split(args[0]))
1919
raise ValueError("passing varargs to run_bzr_subprocess")
1920
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1921
working_dir=working_dir,
1922
allow_plugins=allow_plugins)
1923
# We distinguish between retcode=None and retcode not passed.
1924
supplied_retcode = kwargs.get('retcode', 0)
1925
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1926
universal_newlines=kwargs.get('universal_newlines', False),
1929
def start_bzr_subprocess(self, process_args, env_changes=None,
1930
skip_if_plan_to_signal=False,
1932
allow_plugins=False):
1933
"""Start bzr in a subprocess for testing.
1935
This starts a new Python interpreter and runs bzr in there.
1936
This should only be used for tests that have a justifiable need for
1937
this isolation: e.g. they are testing startup time, or signal
1938
handling, or early startup code, etc. Subprocess code can't be
1939
profiled or debugged so easily.
1941
:param process_args: a list of arguments to pass to the bzr executable,
1942
for example ``['--version']``.
1943
:param env_changes: A dictionary which lists changes to environment
1944
variables. A value of None will unset the env variable.
1945
The values must be strings. The change will only occur in the
1946
child, so you don't need to fix the environment after running.
1947
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1949
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1951
:returns: Popen object for the started process.
1953
if skip_if_plan_to_signal:
1954
if not getattr(os, 'kill', None):
1955
raise TestSkipped("os.kill not available.")
1957
if env_changes is None:
1961
def cleanup_environment():
1962
for env_var, value in env_changes.iteritems():
1963
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1965
def restore_environment():
1966
for env_var, value in old_env.iteritems():
1967
osutils.set_or_unset_env(env_var, value)
1969
bzr_path = self.get_bzr_path()
1972
if working_dir is not None:
1973
cwd = osutils.getcwd()
1974
os.chdir(working_dir)
1977
# win32 subprocess doesn't support preexec_fn
1978
# so we will avoid using it on all platforms, just to
1979
# make sure the code path is used, and we don't break on win32
1980
cleanup_environment()
1981
command = [sys.executable]
1982
# frozen executables don't need the path to bzr
1983
if getattr(sys, "frozen", None) is None:
1984
command.append(bzr_path)
1985
if not allow_plugins:
1986
command.append('--no-plugins')
1987
command.extend(process_args)
1988
process = self._popen(command, stdin=subprocess.PIPE,
1989
stdout=subprocess.PIPE,
1990
stderr=subprocess.PIPE)
1992
restore_environment()
1998
def _popen(self, *args, **kwargs):
1999
"""Place a call to Popen.
2001
Allows tests to override this method to intercept the calls made to
2002
Popen for introspection.
2004
return subprocess.Popen(*args, **kwargs)
2006
def get_source_path(self):
2007
"""Return the path of the directory containing bzrlib."""
2008
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2010
def get_bzr_path(self):
2011
"""Return the path of the 'bzr' executable for this test suite."""
2012
bzr_path = self.get_source_path()+'/bzr'
2013
if not os.path.isfile(bzr_path):
2014
# We are probably installed. Assume sys.argv is the right file
2015
bzr_path = sys.argv[0]
2018
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2019
universal_newlines=False, process_args=None):
2020
"""Finish the execution of process.
2022
:param process: the Popen object returned from start_bzr_subprocess.
2023
:param retcode: The status code that is expected. Defaults to 0. If
2024
None is supplied, the status code is not checked.
2025
:param send_signal: an optional signal to send to the process.
2026
:param universal_newlines: Convert CRLF => LF
2027
:returns: (stdout, stderr)
2029
if send_signal is not None:
2030
os.kill(process.pid, send_signal)
2031
out, err = process.communicate()
2033
if universal_newlines:
2034
out = out.replace('\r\n', '\n')
2035
err = err.replace('\r\n', '\n')
2037
if retcode is not None and retcode != process.returncode:
2038
if process_args is None:
2039
process_args = "(unknown args)"
2040
mutter('Output of bzr %s:\n%s', process_args, out)
2041
mutter('Error for bzr %s:\n%s', process_args, err)
2042
self.fail('Command bzr %s failed with retcode %s != %s'
2043
% (process_args, retcode, process.returncode))
2046
def check_inventory_shape(self, inv, shape):
2047
"""Compare an inventory to a list of expected names.
2049
Fail if they are not precisely equal.
2052
shape = list(shape) # copy
2053
for path, ie in inv.entries():
2054
name = path.replace('\\', '/')
2055
if ie.kind == 'directory':
2062
self.fail("expected paths not found in inventory: %r" % shape)
2064
self.fail("unexpected paths found in inventory: %r" % extras)
2066
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2067
a_callable=None, *args, **kwargs):
2068
"""Call callable with redirected std io pipes.
2070
Returns the return code."""
2071
if not callable(a_callable):
2072
raise ValueError("a_callable must be callable.")
2074
stdin = StringIO("")
2076
if getattr(self, "_log_file", None) is not None:
2077
stdout = self._log_file
2081
if getattr(self, "_log_file", None is not None):
2082
stderr = self._log_file
2085
real_stdin = sys.stdin
2086
real_stdout = sys.stdout
2087
real_stderr = sys.stderr
2092
return a_callable(*args, **kwargs)
2094
sys.stdout = real_stdout
2095
sys.stderr = real_stderr
2096
sys.stdin = real_stdin
2098
def reduceLockdirTimeout(self):
2099
"""Reduce the default lock timeout for the duration of the test, so that
2100
if LockContention occurs during a test, it does so quickly.
2102
Tests that expect to provoke LockContention errors should call this.
2104
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2106
def make_utf8_encoded_stringio(self, encoding_type=None):
2107
"""Return a StringIOWrapper instance, that will encode Unicode
2110
if encoding_type is None:
2111
encoding_type = 'strict'
2113
output_encoding = 'utf-8'
2114
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2115
sio.encoding = output_encoding
2118
def disable_verb(self, verb):
2119
"""Disable a smart server verb for one test."""
2120
from bzrlib.smart import request
2121
request_handlers = request.request_handlers
2122
orig_method = request_handlers.get(verb)
2123
request_handlers.remove(verb)
2124
self.addCleanup(request_handlers.register, verb, orig_method)
2127
class CapturedCall(object):
2128
"""A helper for capturing smart server calls for easy debug analysis."""
2130
def __init__(self, params, prefix_length):
2131
"""Capture the call with params and skip prefix_length stack frames."""
2134
# The last 5 frames are the __init__, the hook frame, and 3 smart
2135
# client frames. Beyond this we could get more clever, but this is good
2137
stack = traceback.extract_stack()[prefix_length:-5]
2138
self.stack = ''.join(traceback.format_list(stack))
2141
return self.call.method
2144
return self.call.method
2150
class TestCaseWithMemoryTransport(TestCase):
2151
"""Common test class for tests that do not need disk resources.
2153
Tests that need disk resources should derive from TestCaseWithTransport.
2155
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2157
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2158
a directory which does not exist. This serves to help ensure test isolation
2159
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2160
must exist. However, TestCaseWithMemoryTransport does not offer local
2161
file defaults for the transport in tests, nor does it obey the command line
2162
override, so tests that accidentally write to the common directory should
2165
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2166
a .bzr directory that stops us ascending higher into the filesystem.
2172
def __init__(self, methodName='runTest'):
2173
# allow test parameterization after test construction and before test
2174
# execution. Variables that the parameterizer sets need to be
2175
# ones that are not set by setUp, or setUp will trash them.
2176
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2177
self.vfs_transport_factory = default_transport
2178
self.transport_server = None
2179
self.transport_readonly_server = None
2180
self.__vfs_server = None
2182
def get_transport(self, relpath=None):
2183
"""Return a writeable transport.
2185
This transport is for the test scratch space relative to
2188
:param relpath: a path relative to the base url.
2190
t = _mod_transport.get_transport(self.get_url(relpath))
2191
self.assertFalse(t.is_readonly())
2194
def get_readonly_transport(self, relpath=None):
2195
"""Return a readonly transport for the test scratch space
2197
This can be used to test that operations which should only need
2198
readonly access in fact do not try to write.
2200
:param relpath: a path relative to the base url.
2202
t = _mod_transport.get_transport(self.get_readonly_url(relpath))
2203
self.assertTrue(t.is_readonly())
2206
def create_transport_readonly_server(self):
2207
"""Create a transport server from class defined at init.
2209
This is mostly a hook for daughter classes.
2211
return self.transport_readonly_server()
2213
def get_readonly_server(self):
2214
"""Get the server instance for the readonly transport
2216
This is useful for some tests with specific servers to do diagnostics.
2218
if self.__readonly_server is None:
2219
if self.transport_readonly_server is None:
2220
# readonly decorator requested
2221
self.__readonly_server = test_server.ReadonlyServer()
2223
# explicit readonly transport.
2224
self.__readonly_server = self.create_transport_readonly_server()
2225
self.start_server(self.__readonly_server,
2226
self.get_vfs_only_server())
2227
return self.__readonly_server
2229
def get_readonly_url(self, relpath=None):
2230
"""Get a URL for the readonly transport.
2232
This will either be backed by '.' or a decorator to the transport
2233
used by self.get_url()
2234
relpath provides for clients to get a path relative to the base url.
2235
These should only be downwards relative, not upwards.
2237
base = self.get_readonly_server().get_url()
2238
return self._adjust_url(base, relpath)
2240
def get_vfs_only_server(self):
2241
"""Get the vfs only read/write server instance.
2243
This is useful for some tests with specific servers that need
2246
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2247
is no means to override it.
2249
if self.__vfs_server is None:
2250
self.__vfs_server = memory.MemoryServer()
2251
self.start_server(self.__vfs_server)
2252
return self.__vfs_server
2254
def get_server(self):
2255
"""Get the read/write server instance.
2257
This is useful for some tests with specific servers that need
2260
This is built from the self.transport_server factory. If that is None,
2261
then the self.get_vfs_server is returned.
2263
if self.__server is None:
2264
if (self.transport_server is None or self.transport_server is
2265
self.vfs_transport_factory):
2266
self.__server = self.get_vfs_only_server()
2268
# bring up a decorated means of access to the vfs only server.
2269
self.__server = self.transport_server()
2270
self.start_server(self.__server, self.get_vfs_only_server())
2271
return self.__server
2273
def _adjust_url(self, base, relpath):
2274
"""Get a URL (or maybe a path) for the readwrite transport.
2276
This will either be backed by '.' or to an equivalent non-file based
2278
relpath provides for clients to get a path relative to the base url.
2279
These should only be downwards relative, not upwards.
2281
if relpath is not None and relpath != '.':
2282
if not base.endswith('/'):
2284
# XXX: Really base should be a url; we did after all call
2285
# get_url()! But sometimes it's just a path (from
2286
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2287
# to a non-escaped local path.
2288
if base.startswith('./') or base.startswith('/'):
2291
base += urlutils.escape(relpath)
2294
def get_url(self, relpath=None):
2295
"""Get a URL (or maybe a path) for the readwrite transport.
2297
This will either be backed by '.' or to an equivalent non-file based
2299
relpath provides for clients to get a path relative to the base url.
2300
These should only be downwards relative, not upwards.
2302
base = self.get_server().get_url()
2303
return self._adjust_url(base, relpath)
2305
def get_vfs_only_url(self, relpath=None):
2306
"""Get a URL (or maybe a path for the plain old vfs transport.
2308
This will never be a smart protocol. It always has all the
2309
capabilities of the local filesystem, but it might actually be a
2310
MemoryTransport or some other similar virtual filesystem.
2312
This is the backing transport (if any) of the server returned by
2313
get_url and get_readonly_url.
2315
:param relpath: provides for clients to get a path relative to the base
2316
url. These should only be downwards relative, not upwards.
2319
base = self.get_vfs_only_server().get_url()
2320
return self._adjust_url(base, relpath)
2322
def _create_safety_net(self):
2323
"""Make a fake bzr directory.
2325
This prevents any tests propagating up onto the TEST_ROOT directory's
2328
root = TestCaseWithMemoryTransport.TEST_ROOT
2329
bzrdir.BzrDir.create_standalone_workingtree(root)
2331
def _check_safety_net(self):
2332
"""Check that the safety .bzr directory have not been touched.
2334
_make_test_root have created a .bzr directory to prevent tests from
2335
propagating. This method ensures than a test did not leaked.
2337
root = TestCaseWithMemoryTransport.TEST_ROOT
2338
self.permit_url(_mod_transport.get_transport(root).base)
2339
wt = workingtree.WorkingTree.open(root)
2340
last_rev = wt.last_revision()
2341
if last_rev != 'null:':
2342
# The current test have modified the /bzr directory, we need to
2343
# recreate a new one or all the followng tests will fail.
2344
# If you need to inspect its content uncomment the following line
2345
# import pdb; pdb.set_trace()
2346
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2347
self._create_safety_net()
2348
raise AssertionError('%s/.bzr should not be modified' % root)
2350
def _make_test_root(self):
2351
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2352
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2353
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2355
TestCaseWithMemoryTransport.TEST_ROOT = root
2357
self._create_safety_net()
2359
# The same directory is used by all tests, and we're not
2360
# specifically told when all tests are finished. This will do.
2361
atexit.register(_rmtree_temp_dir, root)
2363
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2364
self.addCleanup(self._check_safety_net)
2366
def makeAndChdirToTestDir(self):
2367
"""Create a temporary directories for this one test.
2369
This must set self.test_home_dir and self.test_dir and chdir to
2372
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2374
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2375
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2376
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2377
self.permit_dir(self.test_dir)
2379
def make_branch(self, relpath, format=None):
2380
"""Create a branch on the transport at relpath."""
2381
repo = self.make_repository(relpath, format=format)
2382
return repo.bzrdir.create_branch()
2384
def make_bzrdir(self, relpath, format=None):
2386
# might be a relative or absolute path
2387
maybe_a_url = self.get_url(relpath)
2388
segments = maybe_a_url.rsplit('/', 1)
2389
t = _mod_transport.get_transport(maybe_a_url)
2390
if len(segments) > 1 and segments[-1] not in ('', '.'):
2394
if isinstance(format, basestring):
2395
format = bzrdir.format_registry.make_bzrdir(format)
2396
return format.initialize_on_transport(t)
2397
except errors.UninitializableFormat:
2398
raise TestSkipped("Format %s is not initializable." % format)
2400
def make_repository(self, relpath, shared=False, format=None):
2401
"""Create a repository on our default transport at relpath.
2403
Note that relpath must be a relative path, not a full url.
2405
# FIXME: If you create a remoterepository this returns the underlying
2406
# real format, which is incorrect. Actually we should make sure that
2407
# RemoteBzrDir returns a RemoteRepository.
2408
# maybe mbp 20070410
2409
made_control = self.make_bzrdir(relpath, format=format)
2410
return made_control.create_repository(shared=shared)
2412
def make_smart_server(self, path, backing_server=None):
2413
if backing_server is None:
2414
backing_server = self.get_server()
2415
smart_server = test_server.SmartTCPServer_for_testing()
2416
self.start_server(smart_server, backing_server)
2417
remote_transport = _mod_transport.get_transport(smart_server.get_url()
2419
return remote_transport
2421
def make_branch_and_memory_tree(self, relpath, format=None):
2422
"""Create a branch on the default transport and a MemoryTree for it."""
2423
b = self.make_branch(relpath, format=format)
2424
return memorytree.MemoryTree.create_on_branch(b)
2426
def make_branch_builder(self, relpath, format=None):
2427
branch = self.make_branch(relpath, format=format)
2428
return branchbuilder.BranchBuilder(branch=branch)
2430
def overrideEnvironmentForTesting(self):
2431
test_home_dir = self.test_home_dir
2432
if isinstance(test_home_dir, unicode):
2433
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2434
os.environ['HOME'] = test_home_dir
2435
os.environ['BZR_HOME'] = test_home_dir
2438
super(TestCaseWithMemoryTransport, self).setUp()
2439
self._make_test_root()
2440
self.addCleanup(os.chdir, os.getcwdu())
2441
self.makeAndChdirToTestDir()
2442
self.overrideEnvironmentForTesting()
2443
self.__readonly_server = None
2444
self.__server = None
2445
self.reduceLockdirTimeout()
2447
def setup_smart_server_with_call_log(self):
2448
"""Sets up a smart server as the transport server with a call log."""
2449
self.transport_server = test_server.SmartTCPServer_for_testing
2450
self.hpss_calls = []
2452
# Skip the current stack down to the caller of
2453
# setup_smart_server_with_call_log
2454
prefix_length = len(traceback.extract_stack()) - 2
2455
def capture_hpss_call(params):
2456
self.hpss_calls.append(
2457
CapturedCall(params, prefix_length))
2458
client._SmartClient.hooks.install_named_hook(
2459
'call', capture_hpss_call, None)
2461
def reset_smart_call_log(self):
2462
self.hpss_calls = []
2465
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2466
"""Derived class that runs a test within a temporary directory.
2468
This is useful for tests that need to create a branch, etc.
2470
The directory is created in a slightly complex way: for each
2471
Python invocation, a new temporary top-level directory is created.
2472
All test cases create their own directory within that. If the
2473
tests complete successfully, the directory is removed.
2475
:ivar test_base_dir: The path of the top-level directory for this
2476
test, which contains a home directory and a work directory.
2478
:ivar test_home_dir: An initially empty directory under test_base_dir
2479
which is used as $HOME for this test.
2481
:ivar test_dir: A directory under test_base_dir used as the current
2482
directory when the test proper is run.
2485
OVERRIDE_PYTHON = 'python'
2487
def check_file_contents(self, filename, expect):
2488
self.log("check contents of file %s" % filename)
2494
if contents != expect:
2495
self.log("expected: %r" % expect)
2496
self.log("actually: %r" % contents)
2497
self.fail("contents of %s not as expected" % filename)
2499
def _getTestDirPrefix(self):
2500
# create a directory within the top level test directory
2501
if sys.platform in ('win32', 'cygwin'):
2502
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2503
# windows is likely to have path-length limits so use a short name
2504
name_prefix = name_prefix[-30:]
2506
name_prefix = re.sub('[/]', '_', self.id())
2509
def makeAndChdirToTestDir(self):
2510
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2512
For TestCaseInTempDir we create a temporary directory based on the test
2513
name and then create two subdirs - test and home under it.
2515
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2516
self._getTestDirPrefix())
2518
for i in range(100):
2519
if os.path.exists(name):
2520
name = name_prefix + '_' + str(i)
2522
# now create test and home directories within this dir
2523
self.test_base_dir = name
2524
self.addCleanup(self.deleteTestDir)
2525
os.mkdir(self.test_base_dir)
2527
self.permit_dir(self.test_base_dir)
2528
# 'sprouting' and 'init' of a branch both walk up the tree to find
2529
# stacking policy to honour; create a bzr dir with an unshared
2530
# repository (but not a branch - our code would be trying to escape
2531
# then!) to stop them, and permit it to be read.
2532
# control = bzrdir.BzrDir.create(self.test_base_dir)
2533
# control.create_repository()
2534
self.test_home_dir = self.test_base_dir + '/home'
2535
os.mkdir(self.test_home_dir)
2536
self.test_dir = self.test_base_dir + '/work'
2537
os.mkdir(self.test_dir)
2538
os.chdir(self.test_dir)
2539
# put name of test inside
2540
f = file(self.test_base_dir + '/name', 'w')
2546
def deleteTestDir(self):
2547
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2548
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2550
def build_tree(self, shape, line_endings='binary', transport=None):
2551
"""Build a test tree according to a pattern.
2553
shape is a sequence of file specifications. If the final
2554
character is '/', a directory is created.
2556
This assumes that all the elements in the tree being built are new.
2558
This doesn't add anything to a branch.
2560
:type shape: list or tuple.
2561
:param line_endings: Either 'binary' or 'native'
2562
in binary mode, exact contents are written in native mode, the
2563
line endings match the default platform endings.
2564
:param transport: A transport to write to, for building trees on VFS's.
2565
If the transport is readonly or None, "." is opened automatically.
2568
if type(shape) not in (list, tuple):
2569
raise AssertionError("Parameter 'shape' should be "
2570
"a list or a tuple. Got %r instead" % (shape,))
2571
# It's OK to just create them using forward slashes on windows.
2572
if transport is None or transport.is_readonly():
2573
transport = _mod_transport.get_transport(".")
2575
self.assertIsInstance(name, basestring)
2577
transport.mkdir(urlutils.escape(name[:-1]))
2579
if line_endings == 'binary':
2581
elif line_endings == 'native':
2584
raise errors.BzrError(
2585
'Invalid line ending request %r' % line_endings)
2586
content = "contents of %s%s" % (name.encode('utf-8'), end)
2587
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2589
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2591
def assertInWorkingTree(self, path, root_path='.', tree=None):
2592
"""Assert whether path or paths are in the WorkingTree"""
2594
tree = workingtree.WorkingTree.open(root_path)
2595
if not isinstance(path, basestring):
2597
self.assertInWorkingTree(p, tree=tree)
2599
self.assertIsNot(tree.path2id(path), None,
2600
path+' not in working tree.')
2602
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2603
"""Assert whether path or paths are not in the WorkingTree"""
2605
tree = workingtree.WorkingTree.open(root_path)
2606
if not isinstance(path, basestring):
2608
self.assertNotInWorkingTree(p,tree=tree)
2610
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2613
class TestCaseWithTransport(TestCaseInTempDir):
2614
"""A test case that provides get_url and get_readonly_url facilities.
2616
These back onto two transport servers, one for readonly access and one for
2619
If no explicit class is provided for readonly access, a
2620
ReadonlyTransportDecorator is used instead which allows the use of non disk
2621
based read write transports.
2623
If an explicit class is provided for readonly access, that server and the
2624
readwrite one must both define get_url() as resolving to os.getcwd().
2627
def get_vfs_only_server(self):
2628
"""See TestCaseWithMemoryTransport.
2630
This is useful for some tests with specific servers that need
2633
if self.__vfs_server is None:
2634
self.__vfs_server = self.vfs_transport_factory()
2635
self.start_server(self.__vfs_server)
2636
return self.__vfs_server
2638
def make_branch_and_tree(self, relpath, format=None):
2639
"""Create a branch on the transport and a tree locally.
2641
If the transport is not a LocalTransport, the Tree can't be created on
2642
the transport. In that case if the vfs_transport_factory is
2643
LocalURLServer the working tree is created in the local
2644
directory backing the transport, and the returned tree's branch and
2645
repository will also be accessed locally. Otherwise a lightweight
2646
checkout is created and returned.
2648
We do this because we can't physically create a tree in the local
2649
path, with a branch reference to the transport_factory url, and
2650
a branch + repository in the vfs_transport, unless the vfs_transport
2651
namespace is distinct from the local disk - the two branch objects
2652
would collide. While we could construct a tree with its branch object
2653
pointing at the transport_factory transport in memory, reopening it
2654
would behaving unexpectedly, and has in the past caused testing bugs
2655
when we tried to do it that way.
2657
:param format: The BzrDirFormat.
2658
:returns: the WorkingTree.
2660
# TODO: always use the local disk path for the working tree,
2661
# this obviously requires a format that supports branch references
2662
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2664
b = self.make_branch(relpath, format=format)
2666
return b.bzrdir.create_workingtree()
2667
except errors.NotLocalUrl:
2668
# We can only make working trees locally at the moment. If the
2669
# transport can't support them, then we keep the non-disk-backed
2670
# branch and create a local checkout.
2671
if self.vfs_transport_factory is test_server.LocalURLServer:
2672
# the branch is colocated on disk, we cannot create a checkout.
2673
# hopefully callers will expect this.
2674
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2675
wt = local_controldir.create_workingtree()
2676
if wt.branch._format != b._format:
2678
# Make sure that assigning to wt._branch fixes wt.branch,
2679
# in case the implementation details of workingtree objects
2681
self.assertIs(b, wt.branch)
2684
return b.create_checkout(relpath, lightweight=True)
2686
def assertIsDirectory(self, relpath, transport):
2687
"""Assert that relpath within transport is a directory.
2689
This may not be possible on all transports; in that case it propagates
2690
a TransportNotPossible.
2693
mode = transport.stat(relpath).st_mode
2694
except errors.NoSuchFile:
2695
self.fail("path %s is not a directory; no such file"
2697
if not stat.S_ISDIR(mode):
2698
self.fail("path %s is not a directory; has mode %#o"
2701
def assertTreesEqual(self, left, right):
2702
"""Check that left and right have the same content and properties."""
2703
# we use a tree delta to check for equality of the content, and we
2704
# manually check for equality of other things such as the parents list.
2705
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2706
differences = left.changes_from(right)
2707
self.assertFalse(differences.has_changed(),
2708
"Trees %r and %r are different: %r" % (left, right, differences))
2711
super(TestCaseWithTransport, self).setUp()
2712
self.__vfs_server = None
2714
def disable_missing_extensions_warning(self):
2715
"""Some tests expect a precise stderr content.
2717
There is no point in forcing them to duplicate the extension related
2720
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2723
class ChrootedTestCase(TestCaseWithTransport):
2724
"""A support class that provides readonly urls outside the local namespace.
2726
This is done by checking if self.transport_server is a MemoryServer. if it
2727
is then we are chrooted already, if it is not then an HttpServer is used
2730
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2731
be used without needed to redo it when a different
2732
subclass is in use ?
2736
super(ChrootedTestCase, self).setUp()
2737
if not self.vfs_transport_factory == memory.MemoryServer:
2738
self.transport_readonly_server = HttpServer
2741
def condition_id_re(pattern):
2742
"""Create a condition filter which performs a re check on a test's id.
2744
:param pattern: A regular expression string.
2745
:return: A callable that returns True if the re matches.
2747
filter_re = re.compile(pattern, 0)
2748
def condition(test):
2750
return filter_re.search(test_id)
2754
def condition_isinstance(klass_or_klass_list):
2755
"""Create a condition filter which returns isinstance(param, klass).
2757
:return: A callable which when called with one parameter obj return the
2758
result of isinstance(obj, klass_or_klass_list).
2761
return isinstance(obj, klass_or_klass_list)
2765
def condition_id_in_list(id_list):
2766
"""Create a condition filter which verify that test's id in a list.
2768
:param id_list: A TestIdList object.
2769
:return: A callable that returns True if the test's id appears in the list.
2771
def condition(test):
2772
return id_list.includes(test.id())
2776
def condition_id_startswith(starts):
2777
"""Create a condition filter verifying that test's id starts with a string.
2779
:param starts: A list of string.
2780
:return: A callable that returns True if the test's id starts with one of
2783
def condition(test):
2784
for start in starts:
2785
if test.id().startswith(start):
2791
def exclude_tests_by_condition(suite, condition):
2792
"""Create a test suite which excludes some tests from suite.
2794
:param suite: The suite to get tests from.
2795
:param condition: A callable whose result evaluates True when called with a
2796
test case which should be excluded from the result.
2797
:return: A suite which contains the tests found in suite that fail
2801
for test in iter_suite_tests(suite):
2802
if not condition(test):
2804
return TestUtil.TestSuite(result)
2807
def filter_suite_by_condition(suite, condition):
2808
"""Create a test suite by filtering another one.
2810
:param suite: The source suite.
2811
:param condition: A callable whose result evaluates True when called with a
2812
test case which should be included in the result.
2813
:return: A suite which contains the tests found in suite that pass
2817
for test in iter_suite_tests(suite):
2820
return TestUtil.TestSuite(result)
2823
def filter_suite_by_re(suite, pattern):
2824
"""Create a test suite by filtering another one.
2826
:param suite: the source suite
2827
:param pattern: pattern that names must match
2828
:returns: the newly created suite
2830
condition = condition_id_re(pattern)
2831
result_suite = filter_suite_by_condition(suite, condition)
2835
def filter_suite_by_id_list(suite, test_id_list):
2836
"""Create a test suite by filtering another one.
2838
:param suite: The source suite.
2839
:param test_id_list: A list of the test ids to keep as strings.
2840
:returns: the newly created suite
2842
condition = condition_id_in_list(test_id_list)
2843
result_suite = filter_suite_by_condition(suite, condition)
2847
def filter_suite_by_id_startswith(suite, start):
2848
"""Create a test suite by filtering another one.
2850
:param suite: The source suite.
2851
:param start: A list of string the test id must start with one of.
2852
:returns: the newly created suite
2854
condition = condition_id_startswith(start)
2855
result_suite = filter_suite_by_condition(suite, condition)
2859
def exclude_tests_by_re(suite, pattern):
2860
"""Create a test suite which excludes some tests from suite.
2862
:param suite: The suite to get tests from.
2863
:param pattern: A regular expression string. Test ids that match this
2864
pattern will be excluded from the result.
2865
:return: A TestSuite that contains all the tests from suite without the
2866
tests that matched pattern. The order of tests is the same as it was in
2869
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2872
def preserve_input(something):
2873
"""A helper for performing test suite transformation chains.
2875
:param something: Anything you want to preserve.
2881
def randomize_suite(suite):
2882
"""Return a new TestSuite with suite's tests in random order.
2884
The tests in the input suite are flattened into a single suite in order to
2885
accomplish this. Any nested TestSuites are removed to provide global
2888
tests = list(iter_suite_tests(suite))
2889
random.shuffle(tests)
2890
return TestUtil.TestSuite(tests)
2893
def split_suite_by_condition(suite, condition):
2894
"""Split a test suite into two by a condition.
2896
:param suite: The suite to split.
2897
:param condition: The condition to match on. Tests that match this
2898
condition are returned in the first test suite, ones that do not match
2899
are in the second suite.
2900
:return: A tuple of two test suites, where the first contains tests from
2901
suite matching the condition, and the second contains the remainder
2902
from suite. The order within each output suite is the same as it was in
2907
for test in iter_suite_tests(suite):
2909
matched.append(test)
2911
did_not_match.append(test)
2912
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2915
def split_suite_by_re(suite, pattern):
2916
"""Split a test suite into two by a regular expression.
2918
:param suite: The suite to split.
2919
:param pattern: A regular expression string. Test ids that match this
2920
pattern will be in the first test suite returned, and the others in the
2921
second test suite returned.
2922
:return: A tuple of two test suites, where the first contains tests from
2923
suite matching pattern, and the second contains the remainder from
2924
suite. The order within each output suite is the same as it was in
2927
return split_suite_by_condition(suite, condition_id_re(pattern))
2930
def run_suite(suite, name='test', verbose=False, pattern=".*",
2931
stop_on_failure=False,
2932
transport=None, lsprof_timed=None, bench_history=None,
2933
matching_tests_first=None,
2936
exclude_pattern=None,
2939
suite_decorators=None,
2941
result_decorators=None,
2943
"""Run a test suite for bzr selftest.
2945
:param runner_class: The class of runner to use. Must support the
2946
constructor arguments passed by run_suite which are more than standard
2948
:return: A boolean indicating success.
2950
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2955
if runner_class is None:
2956
runner_class = TextTestRunner
2959
runner = runner_class(stream=stream,
2961
verbosity=verbosity,
2962
bench_history=bench_history,
2964
result_decorators=result_decorators,
2966
runner.stop_on_failure=stop_on_failure
2967
# built in decorator factories:
2969
random_order(random_seed, runner),
2970
exclude_tests(exclude_pattern),
2972
if matching_tests_first:
2973
decorators.append(tests_first(pattern))
2975
decorators.append(filter_tests(pattern))
2976
if suite_decorators:
2977
decorators.extend(suite_decorators)
2978
# tell the result object how many tests will be running: (except if
2979
# --parallel=fork is being used. Robert said he will provide a better
2980
# progress design later -- vila 20090817)
2981
if fork_decorator not in decorators:
2982
decorators.append(CountingDecorator)
2983
for decorator in decorators:
2984
suite = decorator(suite)
2986
# Done after test suite decoration to allow randomisation etc
2987
# to take effect, though that is of marginal benefit.
2989
stream.write("Listing tests only ...\n")
2990
for t in iter_suite_tests(suite):
2991
stream.write("%s\n" % (t.id()))
2993
result = runner.run(suite)
2995
return result.wasStrictlySuccessful()
2997
return result.wasSuccessful()
3000
# A registry where get() returns a suite decorator.
3001
parallel_registry = registry.Registry()
3004
def fork_decorator(suite):
3005
concurrency = osutils.local_concurrency()
3006
if concurrency == 1:
3008
from testtools import ConcurrentTestSuite
3009
return ConcurrentTestSuite(suite, fork_for_tests)
3010
parallel_registry.register('fork', fork_decorator)
3013
def subprocess_decorator(suite):
3014
concurrency = osutils.local_concurrency()
3015
if concurrency == 1:
3017
from testtools import ConcurrentTestSuite
3018
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3019
parallel_registry.register('subprocess', subprocess_decorator)
3022
def exclude_tests(exclude_pattern):
3023
"""Return a test suite decorator that excludes tests."""
3024
if exclude_pattern is None:
3025
return identity_decorator
3026
def decorator(suite):
3027
return ExcludeDecorator(suite, exclude_pattern)
3031
def filter_tests(pattern):
3033
return identity_decorator
3034
def decorator(suite):
3035
return FilterTestsDecorator(suite, pattern)
3039
def random_order(random_seed, runner):
3040
"""Return a test suite decorator factory for randomising tests order.
3042
:param random_seed: now, a string which casts to a long, or a long.
3043
:param runner: A test runner with a stream attribute to report on.
3045
if random_seed is None:
3046
return identity_decorator
3047
def decorator(suite):
3048
return RandomDecorator(suite, random_seed, runner.stream)
3052
def tests_first(pattern):
3054
return identity_decorator
3055
def decorator(suite):
3056
return TestFirstDecorator(suite, pattern)
3060
def identity_decorator(suite):
3065
class TestDecorator(TestSuite):
3066
"""A decorator for TestCase/TestSuite objects.
3068
Usually, subclasses should override __iter__(used when flattening test
3069
suites), which we do to filter, reorder, parallelise and so on, run() and
3073
def __init__(self, suite):
3074
TestSuite.__init__(self)
3077
def countTestCases(self):
3080
cases += test.countTestCases()
3087
def run(self, result):
3088
# Use iteration on self, not self._tests, to allow subclasses to hook
3091
if result.shouldStop:
3097
class CountingDecorator(TestDecorator):
3098
"""A decorator which calls result.progress(self.countTestCases)."""
3100
def run(self, result):
3101
progress_method = getattr(result, 'progress', None)
3102
if callable(progress_method):
3103
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3104
return super(CountingDecorator, self).run(result)
3107
class ExcludeDecorator(TestDecorator):
3108
"""A decorator which excludes test matching an exclude pattern."""
3110
def __init__(self, suite, exclude_pattern):
3111
TestDecorator.__init__(self, suite)
3112
self.exclude_pattern = exclude_pattern
3113
self.excluded = False
3117
return iter(self._tests)
3118
self.excluded = True
3119
suite = exclude_tests_by_re(self, self.exclude_pattern)
3121
self.addTests(suite)
3122
return iter(self._tests)
3125
class FilterTestsDecorator(TestDecorator):
3126
"""A decorator which filters tests to those matching a pattern."""
3128
def __init__(self, suite, pattern):
3129
TestDecorator.__init__(self, suite)
3130
self.pattern = pattern
3131
self.filtered = False
3135
return iter(self._tests)
3136
self.filtered = True
3137
suite = filter_suite_by_re(self, self.pattern)
3139
self.addTests(suite)
3140
return iter(self._tests)
3143
class RandomDecorator(TestDecorator):
3144
"""A decorator which randomises the order of its tests."""
3146
def __init__(self, suite, random_seed, stream):
3147
TestDecorator.__init__(self, suite)
3148
self.random_seed = random_seed
3149
self.randomised = False
3150
self.stream = stream
3154
return iter(self._tests)
3155
self.randomised = True
3156
self.stream.write("Randomizing test order using seed %s\n\n" %
3157
(self.actual_seed()))
3158
# Initialise the random number generator.
3159
random.seed(self.actual_seed())
3160
suite = randomize_suite(self)
3162
self.addTests(suite)
3163
return iter(self._tests)
3165
def actual_seed(self):
3166
if self.random_seed == "now":
3167
# We convert the seed to a long to make it reuseable across
3168
# invocations (because the user can reenter it).
3169
self.random_seed = long(time.time())
3171
# Convert the seed to a long if we can
3173
self.random_seed = long(self.random_seed)
3176
return self.random_seed
3179
class TestFirstDecorator(TestDecorator):
3180
"""A decorator which moves named tests to the front."""
3182
def __init__(self, suite, pattern):
3183
TestDecorator.__init__(self, suite)
3184
self.pattern = pattern
3185
self.filtered = False
3189
return iter(self._tests)
3190
self.filtered = True
3191
suites = split_suite_by_re(self, self.pattern)
3193
self.addTests(suites)
3194
return iter(self._tests)
3197
def partition_tests(suite, count):
3198
"""Partition suite into count lists of tests."""
3200
tests = list(iter_suite_tests(suite))
3201
tests_per_process = int(math.ceil(float(len(tests)) / count))
3202
for block in range(count):
3203
low_test = block * tests_per_process
3204
high_test = low_test + tests_per_process
3205
process_tests = tests[low_test:high_test]
3206
result.append(process_tests)
3210
def workaround_zealous_crypto_random():
3211
"""Crypto.Random want to help us being secure, but we don't care here.
3213
This workaround some test failure related to the sftp server. Once paramiko
3214
stop using the controversial API in Crypto.Random, we may get rid of it.
3217
from Crypto.Random import atfork
3223
def fork_for_tests(suite):
3224
"""Take suite and start up one runner per CPU by forking()
3226
:return: An iterable of TestCase-like objects which can each have
3227
run(result) called on them to feed tests to result.
3229
concurrency = osutils.local_concurrency()
3231
from subunit import TestProtocolClient, ProtocolTestCase
3232
from subunit.test_results import AutoTimingTestResultDecorator
3233
class TestInOtherProcess(ProtocolTestCase):
3234
# Should be in subunit, I think. RBC.
3235
def __init__(self, stream, pid):
3236
ProtocolTestCase.__init__(self, stream)
3239
def run(self, result):
3241
ProtocolTestCase.run(self, result)
3243
os.waitpid(self.pid, 0)
3245
test_blocks = partition_tests(suite, concurrency)
3246
for process_tests in test_blocks:
3247
process_suite = TestSuite()
3248
process_suite.addTests(process_tests)
3249
c2pread, c2pwrite = os.pipe()
3252
workaround_zealous_crypto_random()
3255
# Leave stderr and stdout open so we can see test noise
3256
# Close stdin so that the child goes away if it decides to
3257
# read from stdin (otherwise its a roulette to see what
3258
# child actually gets keystrokes for pdb etc).
3261
stream = os.fdopen(c2pwrite, 'wb', 1)
3262
subunit_result = AutoTimingTestResultDecorator(
3263
TestProtocolClient(stream))
3264
process_suite.run(subunit_result)
3269
stream = os.fdopen(c2pread, 'rb', 1)
3270
test = TestInOtherProcess(stream, pid)
3275
def reinvoke_for_tests(suite):
3276
"""Take suite and start up one runner per CPU using subprocess().
3278
:return: An iterable of TestCase-like objects which can each have
3279
run(result) called on them to feed tests to result.
3281
concurrency = osutils.local_concurrency()
3283
from subunit import ProtocolTestCase
3284
class TestInSubprocess(ProtocolTestCase):
3285
def __init__(self, process, name):
3286
ProtocolTestCase.__init__(self, process.stdout)
3287
self.process = process
3288
self.process.stdin.close()
3291
def run(self, result):
3293
ProtocolTestCase.run(self, result)
3296
os.unlink(self.name)
3297
# print "pid %d finished" % finished_process
3298
test_blocks = partition_tests(suite, concurrency)
3299
for process_tests in test_blocks:
3300
# ugly; currently reimplement rather than reuses TestCase methods.
3301
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3302
if not os.path.isfile(bzr_path):
3303
# We are probably installed. Assume sys.argv is the right file
3304
bzr_path = sys.argv[0]
3305
bzr_path = [bzr_path]
3306
if sys.platform == "win32":
3307
# if we're on windows, we can't execute the bzr script directly
3308
bzr_path = [sys.executable] + bzr_path
3309
fd, test_list_file_name = tempfile.mkstemp()
3310
test_list_file = os.fdopen(fd, 'wb', 1)
3311
for test in process_tests:
3312
test_list_file.write(test.id() + '\n')
3313
test_list_file.close()
3315
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3317
if '--no-plugins' in sys.argv:
3318
argv.append('--no-plugins')
3319
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3320
# noise on stderr it can interrupt the subunit protocol.
3321
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3322
stdout=subprocess.PIPE,
3323
stderr=subprocess.PIPE,
3325
test = TestInSubprocess(process, test_list_file_name)
3328
os.unlink(test_list_file_name)
3333
class ForwardingResult(unittest.TestResult):
3335
def __init__(self, target):
3336
unittest.TestResult.__init__(self)
3337
self.result = target
3339
def startTest(self, test):
3340
self.result.startTest(test)
3342
def stopTest(self, test):
3343
self.result.stopTest(test)
3345
def startTestRun(self):
3346
self.result.startTestRun()
3348
def stopTestRun(self):
3349
self.result.stopTestRun()
3351
def addSkip(self, test, reason):
3352
self.result.addSkip(test, reason)
3354
def addSuccess(self, test):
3355
self.result.addSuccess(test)
3357
def addError(self, test, err):
3358
self.result.addError(test, err)
3360
def addFailure(self, test, err):
3361
self.result.addFailure(test, err)
3362
ForwardingResult = testtools.ExtendedToOriginalDecorator
3365
class ProfileResult(ForwardingResult):
3366
"""Generate profiling data for all activity between start and success.
3368
The profile data is appended to the test's _benchcalls attribute and can
3369
be accessed by the forwarded-to TestResult.
3371
While it might be cleaner do accumulate this in stopTest, addSuccess is
3372
where our existing output support for lsprof is, and this class aims to
3373
fit in with that: while it could be moved it's not necessary to accomplish
3374
test profiling, nor would it be dramatically cleaner.
3377
def startTest(self, test):
3378
self.profiler = bzrlib.lsprof.BzrProfiler()
3379
# Prevent deadlocks in tests that use lsprof: those tests will
3381
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3382
self.profiler.start()
3383
ForwardingResult.startTest(self, test)
3385
def addSuccess(self, test):
3386
stats = self.profiler.stop()
3388
calls = test._benchcalls
3389
except AttributeError:
3390
test._benchcalls = []
3391
calls = test._benchcalls
3392
calls.append(((test.id(), "", ""), stats))
3393
ForwardingResult.addSuccess(self, test)
3395
def stopTest(self, test):
3396
ForwardingResult.stopTest(self, test)
3397
self.profiler = None
3400
# Controlled by "bzr selftest -E=..." option
3401
# Currently supported:
3402
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3403
# preserves any flags supplied at the command line.
3404
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3405
# rather than failing tests. And no longer raise
3406
# LockContention when fctnl locks are not being used
3407
# with proper exclusion rules.
3408
selftest_debug_flags = set()
3411
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3413
test_suite_factory=None,
3416
matching_tests_first=None,
3419
exclude_pattern=None,
3425
suite_decorators=None,
3429
"""Run the whole test suite under the enhanced runner"""
3430
# XXX: Very ugly way to do this...
3431
# Disable warning about old formats because we don't want it to disturb
3432
# any blackbox tests.
3433
from bzrlib import repository
3434
repository._deprecation_warning_done = True
3436
global default_transport
3437
if transport is None:
3438
transport = default_transport
3439
old_transport = default_transport
3440
default_transport = transport
3441
global selftest_debug_flags
3442
old_debug_flags = selftest_debug_flags
3443
if debug_flags is not None:
3444
selftest_debug_flags = set(debug_flags)
3446
if load_list is None:
3449
keep_only = load_test_id_list(load_list)
3451
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3452
for start in starting_with]
3453
if test_suite_factory is None:
3454
# Reduce loading time by loading modules based on the starting_with
3456
suite = test_suite(keep_only, starting_with)
3458
suite = test_suite_factory()
3460
# But always filter as requested.
3461
suite = filter_suite_by_id_startswith(suite, starting_with)
3462
result_decorators = []
3464
result_decorators.append(ProfileResult)
3465
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3466
stop_on_failure=stop_on_failure,
3467
transport=transport,
3468
lsprof_timed=lsprof_timed,
3469
bench_history=bench_history,
3470
matching_tests_first=matching_tests_first,
3471
list_only=list_only,
3472
random_seed=random_seed,
3473
exclude_pattern=exclude_pattern,
3475
runner_class=runner_class,
3476
suite_decorators=suite_decorators,
3478
result_decorators=result_decorators,
3481
default_transport = old_transport
3482
selftest_debug_flags = old_debug_flags
3485
def load_test_id_list(file_name):
3486
"""Load a test id list from a text file.
3488
The format is one test id by line. No special care is taken to impose
3489
strict rules, these test ids are used to filter the test suite so a test id
3490
that do not match an existing test will do no harm. This allows user to add
3491
comments, leave blank lines, etc.
3495
ftest = open(file_name, 'rt')
3497
if e.errno != errno.ENOENT:
3500
raise errors.NoSuchFile(file_name)
3502
for test_name in ftest.readlines():
3503
test_list.append(test_name.strip())
3508
def suite_matches_id_list(test_suite, id_list):
3509
"""Warns about tests not appearing or appearing more than once.
3511
:param test_suite: A TestSuite object.
3512
:param test_id_list: The list of test ids that should be found in
3515
:return: (absents, duplicates) absents is a list containing the test found
3516
in id_list but not in test_suite, duplicates is a list containing the
3517
test found multiple times in test_suite.
3519
When using a prefined test id list, it may occurs that some tests do not
3520
exist anymore or that some tests use the same id. This function warns the
3521
tester about potential problems in his workflow (test lists are volatile)
3522
or in the test suite itself (using the same id for several tests does not
3523
help to localize defects).
3525
# Build a dict counting id occurrences
3527
for test in iter_suite_tests(test_suite):
3529
tests[id] = tests.get(id, 0) + 1
3534
occurs = tests.get(id, 0)
3536
not_found.append(id)
3538
duplicates.append(id)
3540
return not_found, duplicates
3543
class TestIdList(object):
3544
"""Test id list to filter a test suite.
3546
Relying on the assumption that test ids are built as:
3547
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3548
notation, this class offers methods to :
3549
- avoid building a test suite for modules not refered to in the test list,
3550
- keep only the tests listed from the module test suite.
3553
def __init__(self, test_id_list):
3554
# When a test suite needs to be filtered against us we compare test ids
3555
# for equality, so a simple dict offers a quick and simple solution.
3556
self.tests = dict().fromkeys(test_id_list, True)
3558
# While unittest.TestCase have ids like:
3559
# <module>.<class>.<method>[(<param+)],
3560
# doctest.DocTestCase can have ids like:
3563
# <module>.<function>
3564
# <module>.<class>.<method>
3566
# Since we can't predict a test class from its name only, we settle on
3567
# a simple constraint: a test id always begins with its module name.
3570
for test_id in test_id_list:
3571
parts = test_id.split('.')
3572
mod_name = parts.pop(0)
3573
modules[mod_name] = True
3575
mod_name += '.' + part
3576
modules[mod_name] = True
3577
self.modules = modules
3579
def refers_to(self, module_name):
3580
"""Is there tests for the module or one of its sub modules."""
3581
return self.modules.has_key(module_name)
3583
def includes(self, test_id):
3584
return self.tests.has_key(test_id)
3587
class TestPrefixAliasRegistry(registry.Registry):
3588
"""A registry for test prefix aliases.
3590
This helps implement shorcuts for the --starting-with selftest
3591
option. Overriding existing prefixes is not allowed but not fatal (a
3592
warning will be emitted).
3595
def register(self, key, obj, help=None, info=None,
3596
override_existing=False):
3597
"""See Registry.register.
3599
Trying to override an existing alias causes a warning to be emitted,
3600
not a fatal execption.
3603
super(TestPrefixAliasRegistry, self).register(
3604
key, obj, help=help, info=info, override_existing=False)
3606
actual = self.get(key)
3607
note('Test prefix alias %s is already used for %s, ignoring %s'
3608
% (key, actual, obj))
3610
def resolve_alias(self, id_start):
3611
"""Replace the alias by the prefix in the given string.
3613
Using an unknown prefix is an error to help catching typos.
3615
parts = id_start.split('.')
3617
parts[0] = self.get(parts[0])
3619
raise errors.BzrCommandError(
3620
'%s is not a known test prefix alias' % parts[0])
3621
return '.'.join(parts)
3624
test_prefix_alias_registry = TestPrefixAliasRegistry()
3625
"""Registry of test prefix aliases."""
3628
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3629
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3630
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3632
# Obvious highest levels prefixes, feel free to add your own via a plugin
3633
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3634
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3635
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3636
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3637
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3640
def _test_suite_testmod_names():
3641
"""Return the standard list of test module names to test."""
3644
'bzrlib.tests.blackbox',
3645
'bzrlib.tests.commands',
3646
'bzrlib.tests.per_branch',
3647
'bzrlib.tests.per_bzrdir',
3648
'bzrlib.tests.per_bzrdir_colo',
3649
'bzrlib.tests.per_foreign_vcs',
3650
'bzrlib.tests.per_interrepository',
3651
'bzrlib.tests.per_intertree',
3652
'bzrlib.tests.per_inventory',
3653
'bzrlib.tests.per_interbranch',
3654
'bzrlib.tests.per_lock',
3655
'bzrlib.tests.per_merger',
3656
'bzrlib.tests.per_transport',
3657
'bzrlib.tests.per_tree',
3658
'bzrlib.tests.per_pack_repository',
3659
'bzrlib.tests.per_repository',
3660
'bzrlib.tests.per_repository_chk',
3661
'bzrlib.tests.per_repository_reference',
3662
'bzrlib.tests.per_uifactory',
3663
'bzrlib.tests.per_versionedfile',
3664
'bzrlib.tests.per_workingtree',
3665
'bzrlib.tests.test__annotator',
3666
'bzrlib.tests.test__bencode',
3667
'bzrlib.tests.test__chk_map',
3668
'bzrlib.tests.test__dirstate_helpers',
3669
'bzrlib.tests.test__groupcompress',
3670
'bzrlib.tests.test__known_graph',
3671
'bzrlib.tests.test__rio',
3672
'bzrlib.tests.test__simple_set',
3673
'bzrlib.tests.test__static_tuple',
3674
'bzrlib.tests.test__walkdirs_win32',
3675
'bzrlib.tests.test_ancestry',
3676
'bzrlib.tests.test_annotate',
3677
'bzrlib.tests.test_api',
3678
'bzrlib.tests.test_atomicfile',
3679
'bzrlib.tests.test_bad_files',
3680
'bzrlib.tests.test_bisect_multi',
3681
'bzrlib.tests.test_branch',
3682
'bzrlib.tests.test_branchbuilder',
3683
'bzrlib.tests.test_btree_index',
3684
'bzrlib.tests.test_bugtracker',
3685
'bzrlib.tests.test_bundle',
3686
'bzrlib.tests.test_bzrdir',
3687
'bzrlib.tests.test__chunks_to_lines',
3688
'bzrlib.tests.test_cache_utf8',
3689
'bzrlib.tests.test_chk_map',
3690
'bzrlib.tests.test_chk_serializer',
3691
'bzrlib.tests.test_chunk_writer',
3692
'bzrlib.tests.test_clean_tree',
3693
'bzrlib.tests.test_cleanup',
3694
'bzrlib.tests.test_cmdline',
3695
'bzrlib.tests.test_commands',
3696
'bzrlib.tests.test_commit',
3697
'bzrlib.tests.test_commit_merge',
3698
'bzrlib.tests.test_config',
3699
'bzrlib.tests.test_conflicts',
3700
'bzrlib.tests.test_counted_lock',
3701
'bzrlib.tests.test_crash',
3702
'bzrlib.tests.test_decorators',
3703
'bzrlib.tests.test_delta',
3704
'bzrlib.tests.test_debug',
3705
'bzrlib.tests.test_deprecated_graph',
3706
'bzrlib.tests.test_diff',
3707
'bzrlib.tests.test_directory_service',
3708
'bzrlib.tests.test_dirstate',
3709
'bzrlib.tests.test_email_message',
3710
'bzrlib.tests.test_eol_filters',
3711
'bzrlib.tests.test_errors',
3712
'bzrlib.tests.test_export',
3713
'bzrlib.tests.test_extract',
3714
'bzrlib.tests.test_fetch',
3715
'bzrlib.tests.test_fixtures',
3716
'bzrlib.tests.test_fifo_cache',
3717
'bzrlib.tests.test_filters',
3718
'bzrlib.tests.test_ftp_transport',
3719
'bzrlib.tests.test_foreign',
3720
'bzrlib.tests.test_generate_docs',
3721
'bzrlib.tests.test_generate_ids',
3722
'bzrlib.tests.test_globbing',
3723
'bzrlib.tests.test_gpg',
3724
'bzrlib.tests.test_graph',
3725
'bzrlib.tests.test_groupcompress',
3726
'bzrlib.tests.test_hashcache',
3727
'bzrlib.tests.test_help',
3728
'bzrlib.tests.test_hooks',
3729
'bzrlib.tests.test_http',
3730
'bzrlib.tests.test_http_response',
3731
'bzrlib.tests.test_https_ca_bundle',
3732
'bzrlib.tests.test_identitymap',
3733
'bzrlib.tests.test_ignores',
3734
'bzrlib.tests.test_index',
3735
'bzrlib.tests.test_import_tariff',
3736
'bzrlib.tests.test_info',
3737
'bzrlib.tests.test_inv',
3738
'bzrlib.tests.test_inventory_delta',
3739
'bzrlib.tests.test_knit',
3740
'bzrlib.tests.test_lazy_import',
3741
'bzrlib.tests.test_lazy_regex',
3742
'bzrlib.tests.test_library_state',
3743
'bzrlib.tests.test_lock',
3744
'bzrlib.tests.test_lockable_files',
3745
'bzrlib.tests.test_lockdir',
3746
'bzrlib.tests.test_log',
3747
'bzrlib.tests.test_lru_cache',
3748
'bzrlib.tests.test_lsprof',
3749
'bzrlib.tests.test_mail_client',
3750
'bzrlib.tests.test_matchers',
3751
'bzrlib.tests.test_memorytree',
3752
'bzrlib.tests.test_merge',
3753
'bzrlib.tests.test_merge3',
3754
'bzrlib.tests.test_merge_core',
3755
'bzrlib.tests.test_merge_directive',
3756
'bzrlib.tests.test_missing',
3757
'bzrlib.tests.test_msgeditor',
3758
'bzrlib.tests.test_multiparent',
3759
'bzrlib.tests.test_mutabletree',
3760
'bzrlib.tests.test_nonascii',
3761
'bzrlib.tests.test_options',
3762
'bzrlib.tests.test_osutils',
3763
'bzrlib.tests.test_osutils_encodings',
3764
'bzrlib.tests.test_pack',
3765
'bzrlib.tests.test_patch',
3766
'bzrlib.tests.test_patches',
3767
'bzrlib.tests.test_permissions',
3768
'bzrlib.tests.test_plugins',
3769
'bzrlib.tests.test_progress',
3770
'bzrlib.tests.test_read_bundle',
3771
'bzrlib.tests.test_reconcile',
3772
'bzrlib.tests.test_reconfigure',
3773
'bzrlib.tests.test_registry',
3774
'bzrlib.tests.test_remote',
3775
'bzrlib.tests.test_rename_map',
3776
'bzrlib.tests.test_repository',
3777
'bzrlib.tests.test_revert',
3778
'bzrlib.tests.test_revision',
3779
'bzrlib.tests.test_revisionspec',
3780
'bzrlib.tests.test_revisiontree',
3781
'bzrlib.tests.test_rio',
3782
'bzrlib.tests.test_rules',
3783
'bzrlib.tests.test_sampler',
3784
'bzrlib.tests.test_script',
3785
'bzrlib.tests.test_selftest',
3786
'bzrlib.tests.test_serializer',
3787
'bzrlib.tests.test_setup',
3788
'bzrlib.tests.test_sftp_transport',
3789
'bzrlib.tests.test_shelf',
3790
'bzrlib.tests.test_shelf_ui',
3791
'bzrlib.tests.test_smart',
3792
'bzrlib.tests.test_smart_add',
3793
'bzrlib.tests.test_smart_request',
3794
'bzrlib.tests.test_smart_transport',
3795
'bzrlib.tests.test_smtp_connection',
3796
'bzrlib.tests.test_source',
3797
'bzrlib.tests.test_ssh_transport',
3798
'bzrlib.tests.test_status',
3799
'bzrlib.tests.test_store',
3800
'bzrlib.tests.test_strace',
3801
'bzrlib.tests.test_subsume',
3802
'bzrlib.tests.test_switch',
3803
'bzrlib.tests.test_symbol_versioning',
3804
'bzrlib.tests.test_tag',
3805
'bzrlib.tests.test_testament',
3806
'bzrlib.tests.test_textfile',
3807
'bzrlib.tests.test_textmerge',
3808
'bzrlib.tests.test_timestamp',
3809
'bzrlib.tests.test_trace',
3810
'bzrlib.tests.test_transactions',
3811
'bzrlib.tests.test_transform',
3812
'bzrlib.tests.test_transport',
3813
'bzrlib.tests.test_transport_log',
3814
'bzrlib.tests.test_tree',
3815
'bzrlib.tests.test_treebuilder',
3816
'bzrlib.tests.test_tsort',
3817
'bzrlib.tests.test_tuned_gzip',
3818
'bzrlib.tests.test_ui',
3819
'bzrlib.tests.test_uncommit',
3820
'bzrlib.tests.test_upgrade',
3821
'bzrlib.tests.test_upgrade_stacked',
3822
'bzrlib.tests.test_urlutils',
3823
'bzrlib.tests.test_version',
3824
'bzrlib.tests.test_version_info',
3825
'bzrlib.tests.test_weave',
3826
'bzrlib.tests.test_whitebox',
3827
'bzrlib.tests.test_win32utils',
3828
'bzrlib.tests.test_workingtree',
3829
'bzrlib.tests.test_workingtree_4',
3830
'bzrlib.tests.test_wsgi',
3831
'bzrlib.tests.test_xml',
3835
def _test_suite_modules_to_doctest():
3836
"""Return the list of modules to doctest."""
3838
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3842
'bzrlib.branchbuilder',
3843
'bzrlib.decorators',
3846
'bzrlib.iterablefile',
3850
'bzrlib.symbol_versioning',
3852
'bzrlib.tests.fixtures',
3854
'bzrlib.version_info_formats.format_custom',
3858
def test_suite(keep_only=None, starting_with=None):
3859
"""Build and return TestSuite for the whole of bzrlib.
3861
:param keep_only: A list of test ids limiting the suite returned.
3863
:param starting_with: An id limiting the suite returned to the tests
3866
This function can be replaced if you need to change the default test
3867
suite on a global basis, but it is not encouraged.
3870
loader = TestUtil.TestLoader()
3872
if keep_only is not None:
3873
id_filter = TestIdList(keep_only)
3875
# We take precedence over keep_only because *at loading time* using
3876
# both options means we will load less tests for the same final result.
3877
def interesting_module(name):
3878
for start in starting_with:
3880
# Either the module name starts with the specified string
3881
name.startswith(start)
3882
# or it may contain tests starting with the specified string
3883
or start.startswith(name)
3887
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3889
elif keep_only is not None:
3890
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3891
def interesting_module(name):
3892
return id_filter.refers_to(name)
3895
loader = TestUtil.TestLoader()
3896
def interesting_module(name):
3897
# No filtering, all modules are interesting
3900
suite = loader.suiteClass()
3902
# modules building their suite with loadTestsFromModuleNames
3903
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3905
for mod in _test_suite_modules_to_doctest():
3906
if not interesting_module(mod):
3907
# No tests to keep here, move along
3910
# note that this really does mean "report only" -- doctest
3911
# still runs the rest of the examples
3912
doc_suite = doctest.DocTestSuite(mod,
3913
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3914
except ValueError, e:
3915
print '**failed to get doctest for: %s\n%s' % (mod, e)
3917
if len(doc_suite._tests) == 0:
3918
raise errors.BzrError("no doctests found in %s" % (mod,))
3919
suite.addTest(doc_suite)
3921
default_encoding = sys.getdefaultencoding()
3922
for name, plugin in bzrlib.plugin.plugins().items():
3923
if not interesting_module(plugin.module.__name__):
3925
plugin_suite = plugin.test_suite()
3926
# We used to catch ImportError here and turn it into just a warning,
3927
# but really if you don't have --no-plugins this should be a failure.
3928
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3929
if plugin_suite is None:
3930
plugin_suite = plugin.load_plugin_tests(loader)
3931
if plugin_suite is not None:
3932
suite.addTest(plugin_suite)
3933
if default_encoding != sys.getdefaultencoding():
3934
bzrlib.trace.warning(
3935
'Plugin "%s" tried to reset default encoding to: %s', name,
3936
sys.getdefaultencoding())
3938
sys.setdefaultencoding(default_encoding)
3940
if keep_only is not None:
3941
# Now that the referred modules have loaded their tests, keep only the
3943
suite = filter_suite_by_id_list(suite, id_filter)
3944
# Do some sanity checks on the id_list filtering
3945
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3947
# The tester has used both keep_only and starting_with, so he is
3948
# already aware that some tests are excluded from the list, there
3949
# is no need to tell him which.
3952
# Some tests mentioned in the list are not in the test suite. The
3953
# list may be out of date, report to the tester.
3954
for id in not_found:
3955
bzrlib.trace.warning('"%s" not found in the test suite', id)
3956
for id in duplicates:
3957
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3962
def multiply_scenarios(scenarios_left, scenarios_right):
3963
"""Multiply two sets of scenarios.
3965
:returns: the cartesian product of the two sets of scenarios, that is
3966
a scenario for every possible combination of a left scenario and a
3970
('%s,%s' % (left_name, right_name),
3971
dict(left_dict.items() + right_dict.items()))
3972
for left_name, left_dict in scenarios_left
3973
for right_name, right_dict in scenarios_right]
3976
def multiply_tests(tests, scenarios, result):
3977
"""Multiply tests_list by scenarios into result.
3979
This is the core workhorse for test parameterisation.
3981
Typically the load_tests() method for a per-implementation test suite will
3982
call multiply_tests and return the result.
3984
:param tests: The tests to parameterise.
3985
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3986
scenario_param_dict).
3987
:param result: A TestSuite to add created tests to.
3989
This returns the passed in result TestSuite with the cross product of all
3990
the tests repeated once for each scenario. Each test is adapted by adding
3991
the scenario name at the end of its id(), and updating the test object's
3992
__dict__ with the scenario_param_dict.
3994
>>> import bzrlib.tests.test_sampler
3995
>>> r = multiply_tests(
3996
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3997
... [('one', dict(param=1)),
3998
... ('two', dict(param=2))],
4000
>>> tests = list(iter_suite_tests(r))
4004
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4010
for test in iter_suite_tests(tests):
4011
apply_scenarios(test, scenarios, result)
4015
def apply_scenarios(test, scenarios, result):
4016
"""Apply the scenarios in scenarios to test and add to result.
4018
:param test: The test to apply scenarios to.
4019
:param scenarios: An iterable of scenarios to apply to test.
4021
:seealso: apply_scenario
4023
for scenario in scenarios:
4024
result.addTest(apply_scenario(test, scenario))
4028
def apply_scenario(test, scenario):
4029
"""Copy test and apply scenario to it.
4031
:param test: A test to adapt.
4032
:param scenario: A tuple describing the scenarion.
4033
The first element of the tuple is the new test id.
4034
The second element is a dict containing attributes to set on the
4036
:return: The adapted test.
4038
new_id = "%s(%s)" % (test.id(), scenario[0])
4039
new_test = clone_test(test, new_id)
4040
for name, value in scenario[1].items():
4041
setattr(new_test, name, value)
4045
def clone_test(test, new_id):
4046
"""Clone a test giving it a new id.
4048
:param test: The test to clone.
4049
:param new_id: The id to assign to it.
4050
:return: The new test.
4052
new_test = copy.copy(test)
4053
new_test.id = lambda: new_id
4057
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4059
"""Helper for permutating tests against an extension module.
4061
This is meant to be used inside a modules 'load_tests()' function. It will
4062
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4063
against both implementations. Setting 'test.module' to the appropriate
4064
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4066
:param standard_tests: A test suite to permute
4067
:param loader: A TestLoader
4068
:param py_module_name: The python path to a python module that can always
4069
be loaded, and will be considered the 'python' implementation. (eg
4070
'bzrlib._chk_map_py')
4071
:param ext_module_name: The python path to an extension module. If the
4072
module cannot be loaded, a single test will be added, which notes that
4073
the module is not available. If it can be loaded, all standard_tests
4074
will be run against that module.
4075
:return: (suite, feature) suite is a test-suite that has all the permuted
4076
tests. feature is the Feature object that can be used to determine if
4077
the module is available.
4080
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4082
('python', {'module': py_module}),
4084
suite = loader.suiteClass()
4085
feature = ModuleAvailableFeature(ext_module_name)
4086
if feature.available():
4087
scenarios.append(('C', {'module': feature.module}))
4089
# the compiled module isn't available, so we add a failing test
4090
class FailWithoutFeature(TestCase):
4091
def test_fail(self):
4092
self.requireFeature(feature)
4093
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4094
result = multiply_tests(standard_tests, scenarios, suite)
4095
return result, feature
4098
def _rmtree_temp_dir(dirname, test_id=None):
4099
# If LANG=C we probably have created some bogus paths
4100
# which rmtree(unicode) will fail to delete
4101
# so make sure we are using rmtree(str) to delete everything
4102
# except on win32, where rmtree(str) will fail
4103
# since it doesn't have the property of byte-stream paths
4104
# (they are either ascii or mbcs)
4105
if sys.platform == 'win32':
4106
# make sure we are using the unicode win32 api
4107
dirname = unicode(dirname)
4109
dirname = dirname.encode(sys.getfilesystemencoding())
4111
osutils.rmtree(dirname)
4113
# We don't want to fail here because some useful display will be lost
4114
# otherwise. Polluting the tmp dir is bad, but not giving all the
4115
# possible info to the test runner is even worse.
4117
ui.ui_factory.clear_term()
4118
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4119
# Ugly, but the last thing we want here is fail, so bear with it.
4120
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4121
).encode('ascii', 'replace')
4122
sys.stderr.write('Unable to remove testing dir %s\n%s'
4123
% (os.path.basename(dirname), printable_e))
4126
class Feature(object):
4127
"""An operating system Feature."""
4130
self._available = None
4132
def available(self):
4133
"""Is the feature available?
4135
:return: True if the feature is available.
4137
if self._available is None:
4138
self._available = self._probe()
4139
return self._available
4142
"""Implement this method in concrete features.
4144
:return: True if the feature is available.
4146
raise NotImplementedError
4149
if getattr(self, 'feature_name', None):
4150
return self.feature_name()
4151
return self.__class__.__name__
4154
class _SymlinkFeature(Feature):
4157
return osutils.has_symlinks()
4159
def feature_name(self):
4162
SymlinkFeature = _SymlinkFeature()
4165
class _HardlinkFeature(Feature):
4168
return osutils.has_hardlinks()
4170
def feature_name(self):
4173
HardlinkFeature = _HardlinkFeature()
4176
class _OsFifoFeature(Feature):
4179
return getattr(os, 'mkfifo', None)
4181
def feature_name(self):
4182
return 'filesystem fifos'
4184
OsFifoFeature = _OsFifoFeature()
4187
class _UnicodeFilenameFeature(Feature):
4188
"""Does the filesystem support Unicode filenames?"""
4192
# Check for character combinations unlikely to be covered by any
4193
# single non-unicode encoding. We use the characters
4194
# - greek small letter alpha (U+03B1) and
4195
# - braille pattern dots-123456 (U+283F).
4196
os.stat(u'\u03b1\u283f')
4197
except UnicodeEncodeError:
4199
except (IOError, OSError):
4200
# The filesystem allows the Unicode filename but the file doesn't
4204
# The filesystem allows the Unicode filename and the file exists,
4208
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4211
class _CompatabilityThunkFeature(Feature):
4212
"""This feature is just a thunk to another feature.
4214
It issues a deprecation warning if it is accessed, to let you know that you
4215
should really use a different feature.
4218
def __init__(self, dep_version, module, name,
4219
replacement_name, replacement_module=None):
4220
super(_CompatabilityThunkFeature, self).__init__()
4221
self._module = module
4222
if replacement_module is None:
4223
replacement_module = module
4224
self._replacement_module = replacement_module
4226
self._replacement_name = replacement_name
4227
self._dep_version = dep_version
4228
self._feature = None
4231
if self._feature is None:
4232
depr_msg = self._dep_version % ('%s.%s'
4233
% (self._module, self._name))
4234
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4235
self._replacement_name)
4236
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4237
# Import the new feature and use it as a replacement for the
4239
mod = __import__(self._replacement_module, {}, {},
4240
[self._replacement_name])
4241
self._feature = getattr(mod, self._replacement_name)
4245
return self._feature._probe()
4248
class ModuleAvailableFeature(Feature):
4249
"""This is a feature than describes a module we want to be available.
4251
Declare the name of the module in __init__(), and then after probing, the
4252
module will be available as 'self.module'.
4254
:ivar module: The module if it is available, else None.
4257
def __init__(self, module_name):
4258
super(ModuleAvailableFeature, self).__init__()
4259
self.module_name = module_name
4263
self._module = __import__(self.module_name, {}, {}, [''])
4270
if self.available(): # Make sure the probe has been done
4274
def feature_name(self):
4275
return self.module_name
4278
# This is kept here for compatibility, it is recommended to use
4279
# 'bzrlib.tests.feature.paramiko' instead
4280
ParamikoFeature = _CompatabilityThunkFeature(
4281
deprecated_in((2,1,0)),
4282
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4285
def probe_unicode_in_user_encoding():
4286
"""Try to encode several unicode strings to use in unicode-aware tests.
4287
Return first successfull match.
4289
:return: (unicode value, encoded plain string value) or (None, None)
4291
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4292
for uni_val in possible_vals:
4294
str_val = uni_val.encode(osutils.get_user_encoding())
4295
except UnicodeEncodeError:
4296
# Try a different character
4299
return uni_val, str_val
4303
def probe_bad_non_ascii(encoding):
4304
"""Try to find [bad] character with code [128..255]
4305
that cannot be decoded to unicode in some encoding.
4306
Return None if all non-ascii characters is valid
4309
for i in xrange(128, 256):
4312
char.decode(encoding)
4313
except UnicodeDecodeError:
4318
class _HTTPSServerFeature(Feature):
4319
"""Some tests want an https Server, check if one is available.
4321
Right now, the only way this is available is under python2.6 which provides
4332
def feature_name(self):
4333
return 'HTTPSServer'
4336
HTTPSServerFeature = _HTTPSServerFeature()
4339
class _UnicodeFilename(Feature):
4340
"""Does the filesystem support Unicode filenames?"""
4345
except UnicodeEncodeError:
4347
except (IOError, OSError):
4348
# The filesystem allows the Unicode filename but the file doesn't
4352
# The filesystem allows the Unicode filename and the file exists,
4356
UnicodeFilename = _UnicodeFilename()
4359
class _ByteStringNamedFilesystem(Feature):
4360
"""Is the filesystem based on bytes?"""
4363
if os.name == "posix":
4367
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
4370
class _UTF8Filesystem(Feature):
4371
"""Is the filesystem UTF-8?"""
4374
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4378
UTF8Filesystem = _UTF8Filesystem()
4381
class _BreakinFeature(Feature):
4382
"""Does this platform support the breakin feature?"""
4385
from bzrlib import breakin
4386
if breakin.determine_signal() is None:
4388
if sys.platform == 'win32':
4389
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4390
# We trigger SIGBREAK via a Console api so we need ctypes to
4391
# access the function
4398
def feature_name(self):
4399
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4402
BreakinFeature = _BreakinFeature()
4405
class _CaseInsCasePresFilenameFeature(Feature):
4406
"""Is the file-system case insensitive, but case-preserving?"""
4409
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4411
# first check truly case-preserving for created files, then check
4412
# case insensitive when opening existing files.
4413
name = osutils.normpath(name)
4414
base, rel = osutils.split(name)
4415
found_rel = osutils.canonical_relpath(base, name)
4416
return (found_rel == rel
4417
and os.path.isfile(name.upper())
4418
and os.path.isfile(name.lower()))
4423
def feature_name(self):
4424
return "case-insensitive case-preserving filesystem"
4426
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4429
class _CaseInsensitiveFilesystemFeature(Feature):
4430
"""Check if underlying filesystem is case-insensitive but *not* case
4433
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4434
# more likely to be case preserving, so this case is rare.
4437
if CaseInsCasePresFilenameFeature.available():
4440
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4441
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4442
TestCaseWithMemoryTransport.TEST_ROOT = root
4444
root = TestCaseWithMemoryTransport.TEST_ROOT
4445
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4447
name_a = osutils.pathjoin(tdir, 'a')
4448
name_A = osutils.pathjoin(tdir, 'A')
4450
result = osutils.isdir(name_A)
4451
_rmtree_temp_dir(tdir)
4454
def feature_name(self):
4455
return 'case-insensitive filesystem'
4457
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4460
class _CaseSensitiveFilesystemFeature(Feature):
4463
if CaseInsCasePresFilenameFeature.available():
4465
elif CaseInsensitiveFilesystemFeature.available():
4470
def feature_name(self):
4471
return 'case-sensitive filesystem'
4473
# new coding style is for feature instances to be lowercase
4474
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4477
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4478
SubUnitFeature = _CompatabilityThunkFeature(
4479
deprecated_in((2,1,0)),
4480
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4481
# Only define SubUnitBzrRunner if subunit is available.
4483
from subunit import TestProtocolClient
4484
from subunit.test_results import AutoTimingTestResultDecorator
4485
class SubUnitBzrRunner(TextTestRunner):
4486
def run(self, test):
4487
result = AutoTimingTestResultDecorator(
4488
TestProtocolClient(self.stream))
4494
class _PosixPermissionsFeature(Feature):
4498
# create temporary file and check if specified perms are maintained.
4501
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4502
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4505
os.chmod(name, write_perms)
4507
read_perms = os.stat(name).st_mode & 0777
4509
return (write_perms == read_perms)
4511
return (os.name == 'posix') and has_perms()
4513
def feature_name(self):
4514
return 'POSIX permissions support'
4516
posix_permissions_feature = _PosixPermissionsFeature()
added
removed
bzrlib/tests/__init__.py
