1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
32
from cStringIO import StringIO
39
from pprint import pformat
44
from subprocess import Popen, PIPE, STDOUT
71
import bzrlib.commands
72
import bzrlib.timestamp
74
import bzrlib.inventory
75
import bzrlib.iterablefile
80
# lsprof not available
82
from bzrlib.merge import merge_inner
85
from bzrlib.smart import client, request, server
87
from bzrlib import symbol_versioning
88
from bzrlib.symbol_versioning import (
96
from bzrlib.transport import get_transport, pathfilter
97
import bzrlib.transport
98
from bzrlib.transport.local import LocalURLServer
99
from bzrlib.transport.memory import MemoryServer
100
from bzrlib.transport.readonly import ReadonlyServer
101
from bzrlib.trace import mutter, note
102
from bzrlib.tests import TestUtil
103
from bzrlib.tests.http_server import HttpServer
104
from bzrlib.tests.TestUtil import (
108
from bzrlib.tests.treeshape import build_tree_contents
109
from bzrlib.ui import NullProgressView
110
from bzrlib.ui.text import TextUIFactory
111
import bzrlib.version_info_formats.format_custom
112
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
114
# Mark this python module as being part of the implementation
115
# of unittest: this gives us better tracebacks where the last
116
# shown frame is the test code, not our assertXYZ.
119
default_transport = LocalURLServer
121
# Subunit result codes, defined here to prevent a hard dependency on subunit.
126
class ExtendedTestResult(unittest._TextTestResult):
127
"""Accepts, reports and accumulates the results of running tests.
129
Compared to the unittest version this class adds support for
130
profiling, benchmarking, stopping as soon as a test fails, and
131
skipping tests. There are further-specialized subclasses for
132
different types of display.
134
When a test finishes, in whatever way, it calls one of the addSuccess,
135
addFailure or addError classes. These in turn may redirect to a more
136
specific case for the special test results supported by our extended
139
Note that just one of these objects is fed the results from many tests.
144
def __init__(self, stream, descriptions, verbosity,
148
"""Construct new TestResult.
150
:param bench_history: Optionally, a writable file object to accumulate
153
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
154
if bench_history is not None:
155
from bzrlib.version import _get_bzr_source_tree
156
src_tree = _get_bzr_source_tree()
159
revision_id = src_tree.get_parent_ids()[0]
161
# XXX: if this is a brand new tree, do the same as if there
165
# XXX: If there's no branch, what should we do?
167
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
168
self._bench_history = bench_history
169
self.ui = ui.ui_factory
172
self.failure_count = 0
173
self.known_failure_count = 0
175
self.not_applicable_count = 0
176
self.unsupported = {}
178
self._overall_start_time = time.time()
179
self._strict = strict
181
def stopTestRun(self):
184
stopTime = time.time()
185
timeTaken = stopTime - self.startTime
187
self.stream.writeln(self.separator2)
188
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
189
run, run != 1 and "s" or "", timeTaken))
190
self.stream.writeln()
191
if not self.wasSuccessful():
192
self.stream.write("FAILED (")
193
failed, errored = map(len, (self.failures, self.errors))
195
self.stream.write("failures=%d" % failed)
197
if failed: self.stream.write(", ")
198
self.stream.write("errors=%d" % errored)
199
if self.known_failure_count:
200
if failed or errored: self.stream.write(", ")
201
self.stream.write("known_failure_count=%d" %
202
self.known_failure_count)
203
self.stream.writeln(")")
205
if self.known_failure_count:
206
self.stream.writeln("OK (known_failures=%d)" %
207
self.known_failure_count)
209
self.stream.writeln("OK")
210
if self.skip_count > 0:
211
skipped = self.skip_count
212
self.stream.writeln('%d test%s skipped' %
213
(skipped, skipped != 1 and "s" or ""))
215
for feature, count in sorted(self.unsupported.items()):
216
self.stream.writeln("Missing feature '%s' skipped %d tests." %
219
ok = self.wasStrictlySuccessful()
221
ok = self.wasSuccessful()
222
if TestCase._first_thread_leaker_id:
224
'%s is leaking threads among %d leaking tests.\n' % (
225
TestCase._first_thread_leaker_id,
226
TestCase._leaking_threads_tests))
227
# We don't report the main thread as an active one.
229
'%d non-main threads were left active in the end.\n'
230
% (TestCase._active_threads - 1))
232
def _extractBenchmarkTime(self, testCase):
233
"""Add a benchmark time for the current test case."""
234
return getattr(testCase, "_benchtime", None)
236
def _elapsedTestTimeString(self):
237
"""Return a time string for the overall time the current test has taken."""
238
return self._formatTime(time.time() - self._start_time)
240
def _testTimeString(self, testCase):
241
benchmark_time = self._extractBenchmarkTime(testCase)
242
if benchmark_time is not None:
243
return self._formatTime(benchmark_time) + "*"
245
return self._elapsedTestTimeString()
247
def _formatTime(self, seconds):
248
"""Format seconds as milliseconds with leading spaces."""
249
# some benchmarks can take thousands of seconds to run, so we need 8
251
return "%8dms" % (1000 * seconds)
253
def _shortened_test_description(self, test):
255
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
258
def startTest(self, test):
259
unittest.TestResult.startTest(self, test)
262
self.report_test_start(test)
263
test.number = self.count
264
self._recordTestStartTime()
266
def startTests(self):
268
if getattr(sys, 'frozen', None) is None:
269
bzr_path = osutils.realpath(sys.argv[0])
271
bzr_path = sys.executable
273
'testing: %s\n' % (bzr_path,))
276
bzrlib.__path__[0],))
278
' bzr-%s python-%s %s\n' % (
279
bzrlib.version_string,
280
bzrlib._format_version_tuple(sys.version_info),
281
platform.platform(aliased=1),
283
self.stream.write('\n')
285
def _recordTestStartTime(self):
286
"""Record that a test has started."""
287
self._start_time = time.time()
289
def _cleanupLogFile(self, test):
290
# We can only do this if we have one of our TestCases, not if
292
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
293
if setKeepLogfile is not None:
296
def addError(self, test, err):
297
"""Tell result that test finished with an error.
299
Called from the TestCase run() method when the test
300
fails with an unexpected error.
303
unittest.TestResult.addError(self, test, err)
304
self.error_count += 1
305
self.report_error(test, err)
308
self._cleanupLogFile(test)
310
def addFailure(self, test, err):
311
"""Tell result that test failed.
313
Called from the TestCase run() method when the test
314
fails because e.g. an assert() method failed.
317
unittest.TestResult.addFailure(self, test, err)
318
self.failure_count += 1
319
self.report_failure(test, err)
322
self._cleanupLogFile(test)
324
def addSuccess(self, test):
325
"""Tell result that test completed successfully.
327
Called from the TestCase run()
329
if self._bench_history is not None:
330
benchmark_time = self._extractBenchmarkTime(test)
331
if benchmark_time is not None:
332
self._bench_history.write("%s %s\n" % (
333
self._formatTime(benchmark_time),
335
self.report_success(test)
336
self._cleanupLogFile(test)
337
unittest.TestResult.addSuccess(self, test)
338
test._log_contents = ''
340
def addExpectedFailure(self, test, err):
341
self.known_failure_count += 1
342
self.report_known_failure(test, err)
344
def addNotSupported(self, test, feature):
345
"""The test will not be run because of a missing feature.
347
# this can be called in two different ways: it may be that the
348
# test started running, and then raised (through requireFeature)
349
# UnavailableFeature. Alternatively this method can be called
350
# while probing for features before running the test code proper; in
351
# that case we will see startTest and stopTest, but the test will
352
# never actually run.
353
self.unsupported.setdefault(str(feature), 0)
354
self.unsupported[str(feature)] += 1
355
self.report_unsupported(test, feature)
357
def addSkip(self, test, reason):
358
"""A test has not run for 'reason'."""
360
self.report_skip(test, reason)
362
def addNotApplicable(self, test, reason):
363
self.not_applicable_count += 1
364
self.report_not_applicable(test, reason)
366
def printErrorList(self, flavour, errors):
367
for test, err in errors:
368
self.stream.writeln(self.separator1)
369
self.stream.write("%s: " % flavour)
370
self.stream.writeln(self.getDescription(test))
371
if getattr(test, '_get_log', None) is not None:
372
log_contents = test._get_log()
374
self.stream.write('\n')
376
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
377
self.stream.write('\n')
378
self.stream.write(log_contents)
379
self.stream.write('\n')
381
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
382
self.stream.write('\n')
383
self.stream.writeln(self.separator2)
384
self.stream.writeln("%s" % err)
386
def _post_mortem(self):
387
"""Start a PDB post mortem session."""
388
if os.environ.get('BZR_TEST_PDB', None):
389
import pdb;pdb.post_mortem()
391
def progress(self, offset, whence):
392
"""The test is adjusting the count of tests to run."""
393
if whence == SUBUNIT_SEEK_SET:
394
self.num_tests = offset
395
elif whence == SUBUNIT_SEEK_CUR:
396
self.num_tests += offset
398
raise errors.BzrError("Unknown whence %r" % whence)
400
def report_cleaning_up(self):
403
def startTestRun(self):
404
self.startTime = time.time()
406
def report_success(self, test):
409
def wasStrictlySuccessful(self):
410
if self.unsupported or self.known_failure_count:
412
return self.wasSuccessful()
415
class TextTestResult(ExtendedTestResult):
416
"""Displays progress and results of tests in text form"""
418
def __init__(self, stream, descriptions, verbosity,
423
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
424
bench_history, strict)
425
# We no longer pass them around, but just rely on the UIFactory stack
428
warnings.warn("Passing pb to TextTestResult is deprecated")
429
self.pb = self.ui.nested_progress_bar()
430
self.pb.show_pct = False
431
self.pb.show_spinner = False
432
self.pb.show_eta = False,
433
self.pb.show_count = False
434
self.pb.show_bar = False
435
self.pb.update_latency = 0
436
self.pb.show_transport_activity = False
438
def stopTestRun(self):
439
# called when the tests that are going to run have run
442
super(TextTestResult, self).stopTestRun()
444
def startTestRun(self):
445
super(TextTestResult, self).startTestRun()
446
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
448
def printErrors(self):
449
# clear the pb to make room for the error listing
451
super(TextTestResult, self).printErrors()
453
def _progress_prefix_text(self):
454
# the longer this text, the less space we have to show the test
456
a = '[%d' % self.count # total that have been run
457
# tests skipped as known not to be relevant are not important enough
459
## if self.skip_count:
460
## a += ', %d skip' % self.skip_count
461
## if self.known_failure_count:
462
## a += '+%dX' % self.known_failure_count
464
a +='/%d' % self.num_tests
466
runtime = time.time() - self._overall_start_time
468
a += '%dm%ds' % (runtime / 60, runtime % 60)
472
a += ', %d err' % self.error_count
473
if self.failure_count:
474
a += ', %d fail' % self.failure_count
475
# if self.unsupported:
476
# a += ', %d missing' % len(self.unsupported)
480
def report_test_start(self, test):
483
self._progress_prefix_text()
485
+ self._shortened_test_description(test))
487
def _test_description(self, test):
488
return self._shortened_test_description(test)
490
def report_error(self, test, err):
491
ui.ui_factory.note('ERROR: %s\n %s\n' % (
492
self._test_description(test),
496
def report_failure(self, test, err):
497
ui.ui_factory.note('FAIL: %s\n %s\n' % (
498
self._test_description(test),
502
def report_known_failure(self, test, err):
503
ui.ui_factory.note('XFAIL: %s\n%s\n' % (
504
self._test_description(test), err[1]))
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
self.stream = unittest._WritelnDecorator(stream)
609
self.descriptions = descriptions
610
self.verbosity = verbosity
611
self._bench_history = bench_history
612
self._strict = strict
613
self._result_decorators = result_decorators or []
616
"Run the given test case or test suite."
617
if self.verbosity == 1:
618
result_class = TextTestResult
619
elif self.verbosity >= 2:
620
result_class = VerboseTestResult
621
original_result = result_class(self.stream,
624
bench_history=self._bench_history,
627
# Signal to result objects that look at stop early policy to stop,
628
original_result.stop_early = self.stop_on_failure
629
result = original_result
630
for decorator in self._result_decorators:
631
result = decorator(result)
632
result.stop_early = self.stop_on_failure
638
if isinstance(test, testtools.ConcurrentTestSuite):
639
# We need to catch bzr specific behaviors
640
result = BZRTransformingResult(result)
641
result.startTestRun()
646
# higher level code uses our extended protocol to determine
647
# what exit code to give.
648
return original_result
651
def iter_suite_tests(suite):
652
"""Return all tests in a suite, recursing through nested suites"""
653
if isinstance(suite, unittest.TestCase):
655
elif isinstance(suite, unittest.TestSuite):
657
for r in iter_suite_tests(item):
660
raise Exception('unknown type %r for object %r'
661
% (type(suite), suite))
664
class TestSkipped(Exception):
665
"""Indicates that a test was intentionally skipped, rather than failing."""
668
class TestNotApplicable(TestSkipped):
669
"""A test is not applicable to the situation where it was run.
671
This is only normally raised by parameterized tests, if they find that
672
the instance they're constructed upon does not support one aspect
677
class KnownFailure(AssertionError):
678
"""Indicates that a test failed in a precisely expected manner.
680
Such failures dont block the whole test suite from passing because they are
681
indicators of partially completed code or of future work. We have an
682
explicit error for them so that we can ensure that they are always visible:
683
KnownFailures are always shown in the output of bzr selftest.
687
class UnavailableFeature(Exception):
688
"""A feature required for this test was not available.
690
This can be considered a specialised form of SkippedTest.
692
The feature should be used to construct the exception.
696
class CommandFailed(Exception):
700
class StringIOWrapper(object):
701
"""A wrapper around cStringIO which just adds an encoding attribute.
703
Internally we can check sys.stdout to see what the output encoding
704
should be. However, cStringIO has no encoding attribute that we can
705
set. So we wrap it instead.
710
def __init__(self, s=None):
712
self.__dict__['_cstring'] = StringIO(s)
714
self.__dict__['_cstring'] = StringIO()
716
def __getattr__(self, name, getattr=getattr):
717
return getattr(self.__dict__['_cstring'], name)
719
def __setattr__(self, name, val):
720
if name == 'encoding':
721
self.__dict__['encoding'] = val
723
return setattr(self._cstring, name, val)
726
class TestUIFactory(TextUIFactory):
727
"""A UI Factory for testing.
729
Hide the progress bar but emit note()s.
731
Allows get_password to be tested without real tty attached.
733
See also CannedInputUIFactory which lets you provide programmatic input in
736
# TODO: Capture progress events at the model level and allow them to be
737
# observed by tests that care.
739
# XXX: Should probably unify more with CannedInputUIFactory or a
740
# particular configuration of TextUIFactory, or otherwise have a clearer
741
# idea of how they're supposed to be different.
742
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
744
def __init__(self, stdout=None, stderr=None, stdin=None):
745
if stdin is not None:
746
# We use a StringIOWrapper to be able to test various
747
# encodings, but the user is still responsible to
748
# encode the string and to set the encoding attribute
749
# of StringIOWrapper.
750
stdin = StringIOWrapper(stdin)
751
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
753
def get_non_echoed_password(self):
754
"""Get password from stdin without trying to handle the echo mode"""
755
password = self.stdin.readline()
758
if password[-1] == '\n':
759
password = password[:-1]
762
def make_progress_view(self):
763
return NullProgressView()
766
class TestCase(unittest.TestCase):
767
"""Base class for bzr unit tests.
769
Tests that need access to disk resources should subclass
770
TestCaseInTempDir not TestCase.
772
Error and debug log messages are redirected from their usual
773
location into a temporary file, the contents of which can be
774
retrieved by _get_log(). We use a real OS file, not an in-memory object,
775
so that it can also capture file IO. When the test completes this file
776
is read into memory and removed from disk.
778
There are also convenience functions to invoke bzr's command-line
779
routine, and to build and check bzr trees.
781
In addition to the usual method of overriding tearDown(), this class also
782
allows subclasses to register functions into the _cleanups list, which is
783
run in order as the object is torn down. It's less likely this will be
784
accidentally overlooked.
787
_active_threads = None
788
_leaking_threads_tests = 0
789
_first_thread_leaker_id = None
790
_log_file_name = None
792
_keep_log_file = False
793
# record lsprof data when performing benchmark calls.
794
_gather_lsprof_in_benchmarks = False
795
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
796
'_log_contents', '_log_file_name', '_benchtime',
797
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
799
def __init__(self, methodName='testMethod'):
800
super(TestCase, self).__init__(methodName)
802
self._bzr_test_setUp_run = False
803
self._bzr_test_tearDown_run = False
804
self._directory_isolation = True
807
unittest.TestCase.setUp(self)
808
self._bzr_test_setUp_run = True
809
self._cleanEnvironment()
812
self._benchcalls = []
813
self._benchtime = None
815
self._track_transports()
817
self._clear_debug_flags()
818
TestCase._active_threads = threading.activeCount()
819
self.addCleanup(self._check_leaked_threads)
824
pdb.Pdb().set_trace(sys._getframe().f_back)
826
def _check_leaked_threads(self):
827
active = threading.activeCount()
828
leaked_threads = active - TestCase._active_threads
829
TestCase._active_threads = active
830
# If some tests make the number of threads *decrease*, we'll consider
831
# that they are just observing old threads dieing, not agressively kill
832
# random threads. So we don't report these tests as leaking. The risk
833
# is that we have false positives that way (the test see 2 threads
834
# going away but leak one) but it seems less likely than the actual
835
# false positives (the test see threads going away and does not leak).
836
if leaked_threads > 0:
837
TestCase._leaking_threads_tests += 1
838
if TestCase._first_thread_leaker_id is None:
839
TestCase._first_thread_leaker_id = self.id()
841
def _clear_debug_flags(self):
842
"""Prevent externally set debug flags affecting tests.
844
Tests that want to use debug flags can just set them in the
845
debug_flags set during setup/teardown.
847
self._preserved_debug_flags = set(debug.debug_flags)
848
if 'allow_debug' not in selftest_debug_flags:
849
debug.debug_flags.clear()
850
if 'disable_lock_checks' not in selftest_debug_flags:
851
debug.debug_flags.add('strict_locks')
852
self.addCleanup(self._restore_debug_flags)
854
def _clear_hooks(self):
855
# prevent hooks affecting tests
856
self._preserved_hooks = {}
857
for key, factory in hooks.known_hooks.items():
858
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
859
current_hooks = hooks.known_hooks_key_to_object(key)
860
self._preserved_hooks[parent] = (name, current_hooks)
861
self.addCleanup(self._restoreHooks)
862
for key, factory in hooks.known_hooks.items():
863
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
864
setattr(parent, name, factory())
865
# this hook should always be installed
866
request._install_hook()
868
def disable_directory_isolation(self):
869
"""Turn off directory isolation checks."""
870
self._directory_isolation = False
872
def enable_directory_isolation(self):
873
"""Enable directory isolation checks."""
874
self._directory_isolation = True
876
def _silenceUI(self):
877
"""Turn off UI for duration of test"""
878
# by default the UI is off; tests can turn it on if they want it.
879
saved = ui.ui_factory
881
ui.ui_factory = saved
882
ui.ui_factory = ui.SilentUIFactory()
883
self.addCleanup(_restore)
885
def _check_locks(self):
886
"""Check that all lock take/release actions have been paired."""
887
# We always check for mismatched locks. If a mismatch is found, we
888
# fail unless -Edisable_lock_checks is supplied to selftest, in which
889
# case we just print a warning.
891
acquired_locks = [lock for action, lock in self._lock_actions
892
if action == 'acquired']
893
released_locks = [lock for action, lock in self._lock_actions
894
if action == 'released']
895
broken_locks = [lock for action, lock in self._lock_actions
896
if action == 'broken']
897
# trivially, given the tests for lock acquistion and release, if we
898
# have as many in each list, it should be ok. Some lock tests also
899
# break some locks on purpose and should be taken into account by
900
# considering that breaking a lock is just a dirty way of releasing it.
901
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
902
message = ('Different number of acquired and '
903
'released or broken locks. (%s, %s + %s)' %
904
(acquired_locks, released_locks, broken_locks))
905
if not self._lock_check_thorough:
906
# Rather than fail, just warn
907
print "Broken test %s: %s" % (self, message)
911
def _track_locks(self):
912
"""Track lock activity during tests."""
913
self._lock_actions = []
914
if 'disable_lock_checks' in selftest_debug_flags:
915
self._lock_check_thorough = False
917
self._lock_check_thorough = True
919
self.addCleanup(self._check_locks)
920
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
921
self._lock_acquired, None)
922
_mod_lock.Lock.hooks.install_named_hook('lock_released',
923
self._lock_released, None)
924
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
925
self._lock_broken, None)
927
def _lock_acquired(self, result):
928
self._lock_actions.append(('acquired', result))
930
def _lock_released(self, result):
931
self._lock_actions.append(('released', result))
933
def _lock_broken(self, result):
934
self._lock_actions.append(('broken', result))
936
def permit_dir(self, name):
937
"""Permit a directory to be used by this test. See permit_url."""
938
name_transport = get_transport(name)
939
self.permit_url(name)
940
self.permit_url(name_transport.base)
942
def permit_url(self, url):
943
"""Declare that url is an ok url to use in this test.
945
Do this for memory transports, temporary test directory etc.
947
Do not do this for the current working directory, /tmp, or any other
948
preexisting non isolated url.
950
if not url.endswith('/'):
952
self._bzr_selftest_roots.append(url)
954
def permit_source_tree_branch_repo(self):
955
"""Permit the source tree bzr is running from to be opened.
957
Some code such as bzrlib.version attempts to read from the bzr branch
958
that bzr is executing from (if any). This method permits that directory
959
to be used in the test suite.
961
path = self.get_source_path()
962
self.record_directory_isolation()
965
workingtree.WorkingTree.open(path)
966
except (errors.NotBranchError, errors.NoWorkingTree):
969
self.enable_directory_isolation()
971
def _preopen_isolate_transport(self, transport):
972
"""Check that all transport openings are done in the test work area."""
973
while isinstance(transport, pathfilter.PathFilteringTransport):
974
# Unwrap pathfiltered transports
975
transport = transport.server.backing_transport.clone(
976
transport._filter('.'))
978
# ReadonlySmartTCPServer_for_testing decorates the backing transport
979
# urls it is given by prepending readonly+. This is appropriate as the
980
# client shouldn't know that the server is readonly (or not readonly).
981
# We could register all servers twice, with readonly+ prepending, but
982
# that makes for a long list; this is about the same but easier to
984
if url.startswith('readonly+'):
985
url = url[len('readonly+'):]
986
self._preopen_isolate_url(url)
988
def _preopen_isolate_url(self, url):
989
if not self._directory_isolation:
991
if self._directory_isolation == 'record':
992
self._bzr_selftest_roots.append(url)
994
# This prevents all transports, including e.g. sftp ones backed on disk
995
# from working unless they are explicitly granted permission. We then
996
# depend on the code that sets up test transports to check that they are
997
# appropriately isolated and enable their use by calling
998
# self.permit_transport()
999
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1000
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1001
% (url, self._bzr_selftest_roots))
1003
def record_directory_isolation(self):
1004
"""Gather accessed directories to permit later access.
1006
This is used for tests that access the branch bzr is running from.
1008
self._directory_isolation = "record"
1010
def start_server(self, transport_server, backing_server=None):
1011
"""Start transport_server for this test.
1013
This starts the server, registers a cleanup for it and permits the
1014
server's urls to be used.
1016
if backing_server is None:
1017
transport_server.setUp()
1019
transport_server.setUp(backing_server)
1020
self.addCleanup(transport_server.tearDown)
1021
# Obtain a real transport because if the server supplies a password, it
1022
# will be hidden from the base on the client side.
1023
t = get_transport(transport_server.get_url())
1024
# Some transport servers effectively chroot the backing transport;
1025
# others like SFTPServer don't - users of the transport can walk up the
1026
# transport to read the entire backing transport. This wouldn't matter
1027
# except that the workdir tests are given - and that they expect the
1028
# server's url to point at - is one directory under the safety net. So
1029
# Branch operations into the transport will attempt to walk up one
1030
# directory. Chrooting all servers would avoid this but also mean that
1031
# we wouldn't be testing directly against non-root urls. Alternatively
1032
# getting the test framework to start the server with a backing server
1033
# at the actual safety net directory would work too, but this then
1034
# means that the self.get_url/self.get_transport methods would need
1035
# to transform all their results. On balance its cleaner to handle it
1036
# here, and permit a higher url when we have one of these transports.
1037
if t.base.endswith('/work/'):
1038
# we have safety net/test root/work
1039
t = t.clone('../..')
1040
elif isinstance(transport_server, server.SmartTCPServer_for_testing):
1041
# The smart server adds a path similar to work, which is traversed
1042
# up from by the client. But the server is chrooted - the actual
1043
# backing transport is not escaped from, and VFS requests to the
1044
# root will error (because they try to escape the chroot).
1046
while t2.base != t.base:
1049
self.permit_url(t.base)
1051
def _track_transports(self):
1052
"""Install checks for transport usage."""
1053
# TestCase has no safe place it can write to.
1054
self._bzr_selftest_roots = []
1055
# Currently the easiest way to be sure that nothing is going on is to
1056
# hook into bzr dir opening. This leaves a small window of error for
1057
# transport tests, but they are well known, and we can improve on this
1059
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1060
self._preopen_isolate_transport, "Check bzr directories are safe.")
1062
def _ndiff_strings(self, a, b):
1063
"""Return ndiff between two strings containing lines.
1065
A trailing newline is added if missing to make the strings
1067
if b and b[-1] != '\n':
1069
if a and a[-1] != '\n':
1071
difflines = difflib.ndiff(a.splitlines(True),
1073
linejunk=lambda x: False,
1074
charjunk=lambda x: False)
1075
return ''.join(difflines)
1077
def assertEqual(self, a, b, message=''):
1081
except UnicodeError, e:
1082
# If we can't compare without getting a UnicodeError, then
1083
# obviously they are different
1084
mutter('UnicodeError: %s', e)
1087
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1089
pformat(a), pformat(b)))
1091
assertEquals = assertEqual
1093
def assertEqualDiff(self, a, b, message=None):
1094
"""Assert two texts are equal, if not raise an exception.
1096
This is intended for use with multi-line strings where it can
1097
be hard to find the differences by eye.
1099
# TODO: perhaps override assertEquals to call this for strings?
1103
message = "texts not equal:\n"
1105
message = 'first string is missing a final newline.\n'
1107
message = 'second string is missing a final newline.\n'
1108
raise AssertionError(message +
1109
self._ndiff_strings(a, b))
1111
def assertEqualMode(self, mode, mode_test):
1112
self.assertEqual(mode, mode_test,
1113
'mode mismatch %o != %o' % (mode, mode_test))
1115
def assertEqualStat(self, expected, actual):
1116
"""assert that expected and actual are the same stat result.
1118
:param expected: A stat result.
1119
:param actual: A stat result.
1120
:raises AssertionError: If the expected and actual stat values differ
1121
other than by atime.
1123
self.assertEqual(expected.st_size, actual.st_size,
1124
'st_size did not match')
1125
self.assertEqual(expected.st_mtime, actual.st_mtime,
1126
'st_mtime did not match')
1127
self.assertEqual(expected.st_ctime, actual.st_ctime,
1128
'st_ctime did not match')
1129
if sys.platform != 'win32':
1130
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1131
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1132
# odd. Regardless we shouldn't actually try to assert anything
1133
# about their values
1134
self.assertEqual(expected.st_dev, actual.st_dev,
1135
'st_dev did not match')
1136
self.assertEqual(expected.st_ino, actual.st_ino,
1137
'st_ino did not match')
1138
self.assertEqual(expected.st_mode, actual.st_mode,
1139
'st_mode did not match')
1141
def assertLength(self, length, obj_with_len):
1142
"""Assert that obj_with_len is of length length."""
1143
if len(obj_with_len) != length:
1144
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1145
length, len(obj_with_len), obj_with_len))
1147
def assertLogsError(self, exception_class, func, *args, **kwargs):
1148
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1150
from bzrlib import trace
1152
orig_log_exception_quietly = trace.log_exception_quietly
1155
orig_log_exception_quietly()
1156
captured.append(sys.exc_info())
1157
trace.log_exception_quietly = capture
1158
func(*args, **kwargs)
1160
trace.log_exception_quietly = orig_log_exception_quietly
1161
self.assertLength(1, captured)
1162
err = captured[0][1]
1163
self.assertIsInstance(err, exception_class)
1166
def assertPositive(self, val):
1167
"""Assert that val is greater than 0."""
1168
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1170
def assertNegative(self, val):
1171
"""Assert that val is less than 0."""
1172
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1174
def assertStartsWith(self, s, prefix):
1175
if not s.startswith(prefix):
1176
raise AssertionError('string %r does not start with %r' % (s, prefix))
1178
def assertEndsWith(self, s, suffix):
1179
"""Asserts that s ends with suffix."""
1180
if not s.endswith(suffix):
1181
raise AssertionError('string %r does not end with %r' % (s, suffix))
1183
def assertContainsRe(self, haystack, needle_re, flags=0):
1184
"""Assert that a contains something matching a regular expression."""
1185
if not re.search(needle_re, haystack, flags):
1186
if '\n' in haystack or len(haystack) > 60:
1187
# a long string, format it in a more readable way
1188
raise AssertionError(
1189
'pattern "%s" not found in\n"""\\\n%s"""\n'
1190
% (needle_re, haystack))
1192
raise AssertionError('pattern "%s" not found in "%s"'
1193
% (needle_re, haystack))
1195
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1196
"""Assert that a does not match a regular expression"""
1197
if re.search(needle_re, haystack, flags):
1198
raise AssertionError('pattern "%s" found in "%s"'
1199
% (needle_re, haystack))
1201
def assertSubset(self, sublist, superlist):
1202
"""Assert that every entry in sublist is present in superlist."""
1203
missing = set(sublist) - set(superlist)
1204
if len(missing) > 0:
1205
raise AssertionError("value(s) %r not present in container %r" %
1206
(missing, superlist))
1208
def assertListRaises(self, excClass, func, *args, **kwargs):
1209
"""Fail unless excClass is raised when the iterator from func is used.
1211
Many functions can return generators this makes sure
1212
to wrap them in a list() call to make sure the whole generator
1213
is run, and that the proper exception is raised.
1216
list(func(*args, **kwargs))
1220
if getattr(excClass,'__name__', None) is not None:
1221
excName = excClass.__name__
1223
excName = str(excClass)
1224
raise self.failureException, "%s not raised" % excName
1226
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1227
"""Assert that a callable raises a particular exception.
1229
:param excClass: As for the except statement, this may be either an
1230
exception class, or a tuple of classes.
1231
:param callableObj: A callable, will be passed ``*args`` and
1234
Returns the exception so that you can examine it.
1237
callableObj(*args, **kwargs)
1241
if getattr(excClass,'__name__', None) is not None:
1242
excName = excClass.__name__
1245
excName = str(excClass)
1246
raise self.failureException, "%s not raised" % excName
1248
def assertIs(self, left, right, message=None):
1249
if not (left is right):
1250
if message is not None:
1251
raise AssertionError(message)
1253
raise AssertionError("%r is not %r." % (left, right))
1255
def assertIsNot(self, left, right, message=None):
1257
if message is not None:
1258
raise AssertionError(message)
1260
raise AssertionError("%r is %r." % (left, right))
1262
def assertTransportMode(self, transport, path, mode):
1263
"""Fail if a path does not have mode "mode".
1265
If modes are not supported on this transport, the assertion is ignored.
1267
if not transport._can_roundtrip_unix_modebits():
1269
path_stat = transport.stat(path)
1270
actual_mode = stat.S_IMODE(path_stat.st_mode)
1271
self.assertEqual(mode, actual_mode,
1272
'mode of %r incorrect (%s != %s)'
1273
% (path, oct(mode), oct(actual_mode)))
1275
def assertIsSameRealPath(self, path1, path2):
1276
"""Fail if path1 and path2 points to different files"""
1277
self.assertEqual(osutils.realpath(path1),
1278
osutils.realpath(path2),
1279
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1281
def assertIsInstance(self, obj, kls, msg=None):
1282
"""Fail if obj is not an instance of kls
1284
:param msg: Supplementary message to show if the assertion fails.
1286
if not isinstance(obj, kls):
1287
m = "%r is an instance of %s rather than %s" % (
1288
obj, obj.__class__, kls)
1293
def expectFailure(self, reason, assertion, *args, **kwargs):
1294
"""Invoke a test, expecting it to fail for the given reason.
1296
This is for assertions that ought to succeed, but currently fail.
1297
(The failure is *expected* but not *wanted*.) Please be very precise
1298
about the failure you're expecting. If a new bug is introduced,
1299
AssertionError should be raised, not KnownFailure.
1301
Frequently, expectFailure should be followed by an opposite assertion.
1304
Intended to be used with a callable that raises AssertionError as the
1305
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1307
Raises KnownFailure if the test fails. Raises AssertionError if the
1312
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1314
self.assertEqual(42, dynamic_val)
1316
This means that a dynamic_val of 54 will cause the test to raise
1317
a KnownFailure. Once math is fixed and the expectFailure is removed,
1318
only a dynamic_val of 42 will allow the test to pass. Anything other
1319
than 54 or 42 will cause an AssertionError.
1322
assertion(*args, **kwargs)
1323
except AssertionError:
1324
raise KnownFailure(reason)
1326
self.fail('Unexpected success. Should have failed: %s' % reason)
1328
def assertFileEqual(self, content, path):
1329
"""Fail if path does not contain 'content'."""
1330
self.failUnlessExists(path)
1331
f = file(path, 'rb')
1336
self.assertEqualDiff(content, s)
1338
def failUnlessExists(self, path):
1339
"""Fail unless path or paths, which may be abs or relative, exist."""
1340
if not isinstance(path, basestring):
1342
self.failUnlessExists(p)
1344
self.failUnless(osutils.lexists(path),path+" does not exist")
1346
def failIfExists(self, path):
1347
"""Fail if path or paths, which may be abs or relative, exist."""
1348
if not isinstance(path, basestring):
1350
self.failIfExists(p)
1352
self.failIf(osutils.lexists(path),path+" exists")
1354
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1355
"""A helper for callDeprecated and applyDeprecated.
1357
:param a_callable: A callable to call.
1358
:param args: The positional arguments for the callable
1359
:param kwargs: The keyword arguments for the callable
1360
:return: A tuple (warnings, result). result is the result of calling
1361
a_callable(``*args``, ``**kwargs``).
1364
def capture_warnings(msg, cls=None, stacklevel=None):
1365
# we've hooked into a deprecation specific callpath,
1366
# only deprecations should getting sent via it.
1367
self.assertEqual(cls, DeprecationWarning)
1368
local_warnings.append(msg)
1369
original_warning_method = symbol_versioning.warn
1370
symbol_versioning.set_warning_method(capture_warnings)
1372
result = a_callable(*args, **kwargs)
1374
symbol_versioning.set_warning_method(original_warning_method)
1375
return (local_warnings, result)
1377
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1378
"""Call a deprecated callable without warning the user.
1380
Note that this only captures warnings raised by symbol_versioning.warn,
1381
not other callers that go direct to the warning module.
1383
To test that a deprecated method raises an error, do something like
1386
self.assertRaises(errors.ReservedId,
1387
self.applyDeprecated,
1388
deprecated_in((1, 5, 0)),
1392
:param deprecation_format: The deprecation format that the callable
1393
should have been deprecated with. This is the same type as the
1394
parameter to deprecated_method/deprecated_function. If the
1395
callable is not deprecated with this format, an assertion error
1397
:param a_callable: A callable to call. This may be a bound method or
1398
a regular function. It will be called with ``*args`` and
1400
:param args: The positional arguments for the callable
1401
:param kwargs: The keyword arguments for the callable
1402
:return: The result of a_callable(``*args``, ``**kwargs``)
1404
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1406
expected_first_warning = symbol_versioning.deprecation_string(
1407
a_callable, deprecation_format)
1408
if len(call_warnings) == 0:
1409
self.fail("No deprecation warning generated by call to %s" %
1411
self.assertEqual(expected_first_warning, call_warnings[0])
1414
def callCatchWarnings(self, fn, *args, **kw):
1415
"""Call a callable that raises python warnings.
1417
The caller's responsible for examining the returned warnings.
1419
If the callable raises an exception, the exception is not
1420
caught and propagates up to the caller. In that case, the list
1421
of warnings is not available.
1423
:returns: ([warning_object, ...], fn_result)
1425
# XXX: This is not perfect, because it completely overrides the
1426
# warnings filters, and some code may depend on suppressing particular
1427
# warnings. It's the easiest way to insulate ourselves from -Werror,
1428
# though. -- Andrew, 20071062
1430
def _catcher(message, category, filename, lineno, file=None, line=None):
1431
# despite the name, 'message' is normally(?) a Warning subclass
1433
wlist.append(message)
1434
saved_showwarning = warnings.showwarning
1435
saved_filters = warnings.filters
1437
warnings.showwarning = _catcher
1438
warnings.filters = []
1439
result = fn(*args, **kw)
1441
warnings.showwarning = saved_showwarning
1442
warnings.filters = saved_filters
1443
return wlist, result
1445
def callDeprecated(self, expected, callable, *args, **kwargs):
1446
"""Assert that a callable is deprecated in a particular way.
1448
This is a very precise test for unusual requirements. The
1449
applyDeprecated helper function is probably more suited for most tests
1450
as it allows you to simply specify the deprecation format being used
1451
and will ensure that that is issued for the function being called.
1453
Note that this only captures warnings raised by symbol_versioning.warn,
1454
not other callers that go direct to the warning module. To catch
1455
general warnings, use callCatchWarnings.
1457
:param expected: a list of the deprecation warnings expected, in order
1458
:param callable: The callable to call
1459
:param args: The positional arguments for the callable
1460
:param kwargs: The keyword arguments for the callable
1462
call_warnings, result = self._capture_deprecation_warnings(callable,
1464
self.assertEqual(expected, call_warnings)
1467
def _startLogFile(self):
1468
"""Send bzr and test log messages to a temporary file.
1470
The file is removed as the test is torn down.
1472
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1473
self._log_file = os.fdopen(fileno, 'w+')
1474
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1475
self._log_file_name = name
1476
self.addCleanup(self._finishLogFile)
1478
def _finishLogFile(self):
1479
"""Finished with the log file.
1481
Close the file and delete it, unless setKeepLogfile was called.
1483
if self._log_file is None:
1485
bzrlib.trace.pop_log_file(self._log_memento)
1486
self._log_file.close()
1487
self._log_file = None
1488
if not self._keep_log_file:
1489
os.remove(self._log_file_name)
1490
self._log_file_name = None
1492
def setKeepLogfile(self):
1493
"""Make the logfile not be deleted when _finishLogFile is called."""
1494
self._keep_log_file = True
1496
def thisFailsStrictLockCheck(self):
1497
"""It is known that this test would fail with -Dstrict_locks.
1499
By default, all tests are run with strict lock checking unless
1500
-Edisable_lock_checks is supplied. However there are some tests which
1501
we know fail strict locks at this point that have not been fixed.
1502
They should call this function to disable the strict checking.
1504
This should be used sparingly, it is much better to fix the locking
1505
issues rather than papering over the problem by calling this function.
1507
debug.debug_flags.discard('strict_locks')
1509
def addCleanup(self, callable, *args, **kwargs):
1510
"""Arrange to run a callable when this case is torn down.
1512
Callables are run in the reverse of the order they are registered,
1513
ie last-in first-out.
1515
self._cleanups.append((callable, args, kwargs))
1517
def _cleanEnvironment(self):
1519
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1520
'HOME': os.getcwd(),
1521
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1522
# tests do check our impls match APPDATA
1523
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1527
'BZREMAIL': None, # may still be present in the environment
1529
'BZR_PROGRESS_BAR': None,
1531
'BZR_PLUGIN_PATH': 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,
1560
self.addCleanup(self._restoreEnvironment)
1561
for name, value in new_env.iteritems():
1562
self._captureVar(name, value)
1564
def _captureVar(self, name, newvalue):
1565
"""Set an environment variable, and reset it when finished."""
1566
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1568
def _restore_debug_flags(self):
1569
debug.debug_flags.clear()
1570
debug.debug_flags.update(self._preserved_debug_flags)
1572
def _restoreEnvironment(self):
1573
for name, value in self.__old_env.iteritems():
1574
osutils.set_or_unset_env(name, value)
1576
def _restoreHooks(self):
1577
for klass, (name, hooks) in self._preserved_hooks.items():
1578
setattr(klass, name, hooks)
1580
def knownFailure(self, reason):
1581
"""This test has failed for some known reason."""
1582
raise KnownFailure(reason)
1584
def _do_skip(self, result, reason):
1585
addSkip = getattr(result, 'addSkip', None)
1586
if not callable(addSkip):
1587
result.addSuccess(result)
1589
addSkip(self, reason)
1591
def _do_known_failure(self, result):
1592
err = sys.exc_info()
1593
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1594
if addExpectedFailure is not None:
1595
addExpectedFailure(self, err)
1597
result.addSuccess(self)
1599
def _do_not_applicable(self, result, e):
1601
reason = 'No reason given'
1604
addNotApplicable = getattr(result, 'addNotApplicable', None)
1605
if addNotApplicable is not None:
1606
result.addNotApplicable(self, reason)
1608
self._do_skip(result, reason)
1610
def _do_unsupported_or_skip(self, result, reason):
1611
addNotSupported = getattr(result, 'addNotSupported', None)
1612
if addNotSupported is not None:
1613
result.addNotSupported(self, reason)
1615
self._do_skip(result, reason)
1617
def run(self, result=None):
1618
if result is None: result = self.defaultTestResult()
1619
result.startTest(self)
1624
result.stopTest(self)
1626
def _run(self, result):
1627
for feature in getattr(self, '_test_needs_features', []):
1628
if not feature.available():
1629
return self._do_unsupported_or_skip(result, feature)
1631
absent_attr = object()
1633
method_name = getattr(self, '_testMethodName', absent_attr)
1634
if method_name is absent_attr:
1636
method_name = getattr(self, '_TestCase__testMethodName')
1637
testMethod = getattr(self, method_name)
1641
if not self._bzr_test_setUp_run:
1643
"test setUp did not invoke "
1644
"bzrlib.tests.TestCase's setUp")
1645
except KeyboardInterrupt:
1648
except KnownFailure:
1649
self._do_known_failure(result)
1652
except TestNotApplicable, e:
1653
self._do_not_applicable(result, e)
1656
except TestSkipped, e:
1657
self._do_skip(result, e.args[0])
1660
except UnavailableFeature, e:
1661
self._do_unsupported_or_skip(result, e.args[0])
1665
result.addError(self, sys.exc_info())
1673
except KnownFailure:
1674
self._do_known_failure(result)
1675
except self.failureException:
1676
result.addFailure(self, sys.exc_info())
1677
except TestNotApplicable, e:
1678
self._do_not_applicable(result, e)
1679
except TestSkipped, e:
1681
reason = "No reason given."
1684
self._do_skip(result, reason)
1685
except UnavailableFeature, e:
1686
self._do_unsupported_or_skip(result, e.args[0])
1687
except KeyboardInterrupt:
1691
result.addError(self, sys.exc_info())
1695
if not self._bzr_test_tearDown_run:
1697
"test tearDown did not invoke "
1698
"bzrlib.tests.TestCase's tearDown")
1699
except KeyboardInterrupt:
1703
result.addError(self, sys.exc_info())
1706
if ok: result.addSuccess(self)
1708
except KeyboardInterrupt:
1713
for attr_name in self.attrs_to_keep:
1714
if attr_name in self.__dict__:
1715
saved_attrs[attr_name] = self.__dict__[attr_name]
1716
self.__dict__ = saved_attrs
1720
self._log_contents = ''
1721
self._bzr_test_tearDown_run = True
1722
unittest.TestCase.tearDown(self)
1724
def time(self, callable, *args, **kwargs):
1725
"""Run callable and accrue the time it takes to the benchmark time.
1727
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1728
this will cause lsprofile statistics to be gathered and stored in
1731
if self._benchtime is None:
1735
if not self._gather_lsprof_in_benchmarks:
1736
return callable(*args, **kwargs)
1738
# record this benchmark
1739
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1741
self._benchcalls.append(((callable, args, kwargs), stats))
1744
self._benchtime += time.time() - start
1746
def _runCleanups(self):
1747
"""Run registered cleanup functions.
1749
This should only be called from TestCase.tearDown.
1751
# TODO: Perhaps this should keep running cleanups even if
1752
# one of them fails?
1754
# Actually pop the cleanups from the list so tearDown running
1755
# twice is safe (this happens for skipped tests).
1756
while self._cleanups:
1757
cleanup, args, kwargs = self._cleanups.pop()
1758
cleanup(*args, **kwargs)
1760
def log(self, *args):
1763
def _get_log(self, keep_log_file=False):
1764
"""Get the log from bzrlib.trace calls from this test.
1766
:param keep_log_file: When True, if the log is still a file on disk
1767
leave it as a file on disk. When False, if the log is still a file
1768
on disk, the log file is deleted and the log preserved as
1770
:return: A string containing the log.
1772
# flush the log file, to get all content
1774
if bzrlib.trace._trace_file:
1775
bzrlib.trace._trace_file.flush()
1776
if self._log_contents:
1777
# XXX: this can hardly contain the content flushed above --vila
1779
return self._log_contents
1780
if self._log_file_name is not None:
1781
logfile = open(self._log_file_name)
1783
log_contents = logfile.read()
1786
if not keep_log_file:
1787
self._log_contents = log_contents
1789
os.remove(self._log_file_name)
1791
if sys.platform == 'win32' and e.errno == errno.EACCES:
1792
sys.stderr.write(('Unable to delete log file '
1793
' %r\n' % self._log_file_name))
1798
return "DELETED log file to reduce memory footprint"
1800
def requireFeature(self, feature):
1801
"""This test requires a specific feature is available.
1803
:raises UnavailableFeature: When feature is not available.
1805
if not feature.available():
1806
raise UnavailableFeature(feature)
1808
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1810
"""Run bazaar command line, splitting up a string command line."""
1811
if isinstance(args, basestring):
1812
# shlex don't understand unicode strings,
1813
# so args should be plain string (bialix 20070906)
1814
args = list(shlex.split(str(args)))
1815
return self._run_bzr_core(args, retcode=retcode,
1816
encoding=encoding, stdin=stdin, working_dir=working_dir,
1819
def _run_bzr_core(self, args, retcode, encoding, stdin,
1821
# Clear chk_map page cache, because the contents are likely to mask
1823
chk_map.clear_cache()
1824
if encoding is None:
1825
encoding = osutils.get_user_encoding()
1826
stdout = StringIOWrapper()
1827
stderr = StringIOWrapper()
1828
stdout.encoding = encoding
1829
stderr.encoding = encoding
1831
self.log('run bzr: %r', args)
1832
# FIXME: don't call into logging here
1833
handler = logging.StreamHandler(stderr)
1834
handler.setLevel(logging.INFO)
1835
logger = logging.getLogger('')
1836
logger.addHandler(handler)
1837
old_ui_factory = ui.ui_factory
1838
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1841
if working_dir is not None:
1842
cwd = osutils.getcwd()
1843
os.chdir(working_dir)
1847
result = self.apply_redirected(ui.ui_factory.stdin,
1849
bzrlib.commands.run_bzr_catch_user_errors,
1851
except KeyboardInterrupt:
1852
# Reraise KeyboardInterrupt with contents of redirected stdout
1853
# and stderr as arguments, for tests which are interested in
1854
# stdout and stderr and are expecting the exception.
1855
out = stdout.getvalue()
1856
err = stderr.getvalue()
1858
self.log('output:\n%r', out)
1860
self.log('errors:\n%r', err)
1861
raise KeyboardInterrupt(out, err)
1863
logger.removeHandler(handler)
1864
ui.ui_factory = old_ui_factory
1868
out = stdout.getvalue()
1869
err = stderr.getvalue()
1871
self.log('output:\n%r', out)
1873
self.log('errors:\n%r', err)
1874
if retcode is not None:
1875
self.assertEquals(retcode, result,
1876
message='Unexpected return code')
1877
return result, out, err
1879
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1880
working_dir=None, error_regexes=[], output_encoding=None):
1881
"""Invoke bzr, as if it were run from the command line.
1883
The argument list should not include the bzr program name - the
1884
first argument is normally the bzr command. Arguments may be
1885
passed in three ways:
1887
1- A list of strings, eg ["commit", "a"]. This is recommended
1888
when the command contains whitespace or metacharacters, or
1889
is built up at run time.
1891
2- A single string, eg "add a". This is the most convenient
1892
for hardcoded commands.
1894
This runs bzr through the interface that catches and reports
1895
errors, and with logging set to something approximating the
1896
default, so that error reporting can be checked.
1898
This should be the main method for tests that want to exercise the
1899
overall behavior of the bzr application (rather than a unit test
1900
or a functional test of the library.)
1902
This sends the stdout/stderr results into the test's log,
1903
where it may be useful for debugging. See also run_captured.
1905
:keyword stdin: A string to be used as stdin for the command.
1906
:keyword retcode: The status code the command should return;
1908
:keyword working_dir: The directory to run the command in
1909
:keyword error_regexes: A list of expected error messages. If
1910
specified they must be seen in the error output of the command.
1912
retcode, out, err = self._run_bzr_autosplit(
1917
working_dir=working_dir,
1919
self.assertIsInstance(error_regexes, (list, tuple))
1920
for regex in error_regexes:
1921
self.assertContainsRe(err, regex)
1924
def run_bzr_error(self, error_regexes, *args, **kwargs):
1925
"""Run bzr, and check that stderr contains the supplied regexes
1927
:param error_regexes: Sequence of regular expressions which
1928
must each be found in the error output. The relative ordering
1930
:param args: command-line arguments for bzr
1931
:param kwargs: Keyword arguments which are interpreted by run_bzr
1932
This function changes the default value of retcode to be 3,
1933
since in most cases this is run when you expect bzr to fail.
1935
:return: (out, err) The actual output of running the command (in case
1936
you want to do more inspection)
1940
# Make sure that commit is failing because there is nothing to do
1941
self.run_bzr_error(['no changes to commit'],
1942
['commit', '-m', 'my commit comment'])
1943
# Make sure --strict is handling an unknown file, rather than
1944
# giving us the 'nothing to do' error
1945
self.build_tree(['unknown'])
1946
self.run_bzr_error(['Commit refused because there are unknown files'],
1947
['commit', --strict', '-m', 'my commit comment'])
1949
kwargs.setdefault('retcode', 3)
1950
kwargs['error_regexes'] = error_regexes
1951
out, err = self.run_bzr(*args, **kwargs)
1954
def run_bzr_subprocess(self, *args, **kwargs):
1955
"""Run bzr in a subprocess for testing.
1957
This starts a new Python interpreter and runs bzr in there.
1958
This should only be used for tests that have a justifiable need for
1959
this isolation: e.g. they are testing startup time, or signal
1960
handling, or early startup code, etc. Subprocess code can't be
1961
profiled or debugged so easily.
1963
:keyword retcode: The status code that is expected. Defaults to 0. If
1964
None is supplied, the status code is not checked.
1965
:keyword env_changes: A dictionary which lists changes to environment
1966
variables. A value of None will unset the env variable.
1967
The values must be strings. The change will only occur in the
1968
child, so you don't need to fix the environment after running.
1969
:keyword universal_newlines: Convert CRLF => LF
1970
:keyword allow_plugins: By default the subprocess is run with
1971
--no-plugins to ensure test reproducibility. Also, it is possible
1972
for system-wide plugins to create unexpected output on stderr,
1973
which can cause unnecessary test failures.
1975
env_changes = kwargs.get('env_changes', {})
1976
working_dir = kwargs.get('working_dir', None)
1977
allow_plugins = kwargs.get('allow_plugins', False)
1979
if isinstance(args[0], list):
1981
elif isinstance(args[0], basestring):
1982
args = list(shlex.split(args[0]))
1984
raise ValueError("passing varargs to run_bzr_subprocess")
1985
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1986
working_dir=working_dir,
1987
allow_plugins=allow_plugins)
1988
# We distinguish between retcode=None and retcode not passed.
1989
supplied_retcode = kwargs.get('retcode', 0)
1990
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1991
universal_newlines=kwargs.get('universal_newlines', False),
1994
def start_bzr_subprocess(self, process_args, env_changes=None,
1995
skip_if_plan_to_signal=False,
1997
allow_plugins=False):
1998
"""Start bzr in a subprocess for testing.
2000
This starts a new Python interpreter and runs bzr in there.
2001
This should only be used for tests that have a justifiable need for
2002
this isolation: e.g. they are testing startup time, or signal
2003
handling, or early startup code, etc. Subprocess code can't be
2004
profiled or debugged so easily.
2006
:param process_args: a list of arguments to pass to the bzr executable,
2007
for example ``['--version']``.
2008
:param env_changes: A dictionary which lists changes to environment
2009
variables. A value of None will unset the env variable.
2010
The values must be strings. The change will only occur in the
2011
child, so you don't need to fix the environment after running.
2012
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
2014
:param allow_plugins: If False (default) pass --no-plugins to bzr.
2016
:returns: Popen object for the started process.
2018
if skip_if_plan_to_signal:
2019
if not getattr(os, 'kill', None):
2020
raise TestSkipped("os.kill not available.")
2022
if env_changes is None:
2026
def cleanup_environment():
2027
for env_var, value in env_changes.iteritems():
2028
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2030
def restore_environment():
2031
for env_var, value in old_env.iteritems():
2032
osutils.set_or_unset_env(env_var, value)
2034
bzr_path = self.get_bzr_path()
2037
if working_dir is not None:
2038
cwd = osutils.getcwd()
2039
os.chdir(working_dir)
2042
# win32 subprocess doesn't support preexec_fn
2043
# so we will avoid using it on all platforms, just to
2044
# make sure the code path is used, and we don't break on win32
2045
cleanup_environment()
2046
command = [sys.executable]
2047
# frozen executables don't need the path to bzr
2048
if getattr(sys, "frozen", None) is None:
2049
command.append(bzr_path)
2050
if not allow_plugins:
2051
command.append('--no-plugins')
2052
command.extend(process_args)
2053
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
2055
restore_environment()
2061
def _popen(self, *args, **kwargs):
2062
"""Place a call to Popen.
2064
Allows tests to override this method to intercept the calls made to
2065
Popen for introspection.
2067
return Popen(*args, **kwargs)
2069
def get_source_path(self):
2070
"""Return the path of the directory containing bzrlib."""
2071
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2073
def get_bzr_path(self):
2074
"""Return the path of the 'bzr' executable for this test suite."""
2075
bzr_path = self.get_source_path()+'/bzr'
2076
if not os.path.isfile(bzr_path):
2077
# We are probably installed. Assume sys.argv is the right file
2078
bzr_path = sys.argv[0]
2081
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2082
universal_newlines=False, process_args=None):
2083
"""Finish the execution of process.
2085
:param process: the Popen object returned from start_bzr_subprocess.
2086
:param retcode: The status code that is expected. Defaults to 0. If
2087
None is supplied, the status code is not checked.
2088
:param send_signal: an optional signal to send to the process.
2089
:param universal_newlines: Convert CRLF => LF
2090
:returns: (stdout, stderr)
2092
if send_signal is not None:
2093
os.kill(process.pid, send_signal)
2094
out, err = process.communicate()
2096
if universal_newlines:
2097
out = out.replace('\r\n', '\n')
2098
err = err.replace('\r\n', '\n')
2100
if retcode is not None and retcode != process.returncode:
2101
if process_args is None:
2102
process_args = "(unknown args)"
2103
mutter('Output of bzr %s:\n%s', process_args, out)
2104
mutter('Error for bzr %s:\n%s', process_args, err)
2105
self.fail('Command bzr %s failed with retcode %s != %s'
2106
% (process_args, retcode, process.returncode))
2109
def check_inventory_shape(self, inv, shape):
2110
"""Compare an inventory to a list of expected names.
2112
Fail if they are not precisely equal.
2115
shape = list(shape) # copy
2116
for path, ie in inv.entries():
2117
name = path.replace('\\', '/')
2118
if ie.kind == 'directory':
2125
self.fail("expected paths not found in inventory: %r" % shape)
2127
self.fail("unexpected paths found in inventory: %r" % extras)
2129
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2130
a_callable=None, *args, **kwargs):
2131
"""Call callable with redirected std io pipes.
2133
Returns the return code."""
2134
if not callable(a_callable):
2135
raise ValueError("a_callable must be callable.")
2137
stdin = StringIO("")
2139
if getattr(self, "_log_file", None) is not None:
2140
stdout = self._log_file
2144
if getattr(self, "_log_file", None is not None):
2145
stderr = self._log_file
2148
real_stdin = sys.stdin
2149
real_stdout = sys.stdout
2150
real_stderr = sys.stderr
2155
return a_callable(*args, **kwargs)
2157
sys.stdout = real_stdout
2158
sys.stderr = real_stderr
2159
sys.stdin = real_stdin
2161
def reduceLockdirTimeout(self):
2162
"""Reduce the default lock timeout for the duration of the test, so that
2163
if LockContention occurs during a test, it does so quickly.
2165
Tests that expect to provoke LockContention errors should call this.
2167
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
2169
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
2170
self.addCleanup(resetTimeout)
2171
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2173
def make_utf8_encoded_stringio(self, encoding_type=None):
2174
"""Return a StringIOWrapper instance, that will encode Unicode
2177
if encoding_type is None:
2178
encoding_type = 'strict'
2180
output_encoding = 'utf-8'
2181
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2182
sio.encoding = output_encoding
2185
def disable_verb(self, verb):
2186
"""Disable a smart server verb for one test."""
2187
from bzrlib.smart import request
2188
request_handlers = request.request_handlers
2189
orig_method = request_handlers.get(verb)
2190
request_handlers.remove(verb)
2192
request_handlers.register(verb, orig_method)
2193
self.addCleanup(restoreVerb)
2196
class CapturedCall(object):
2197
"""A helper for capturing smart server calls for easy debug analysis."""
2199
def __init__(self, params, prefix_length):
2200
"""Capture the call with params and skip prefix_length stack frames."""
2203
# The last 5 frames are the __init__, the hook frame, and 3 smart
2204
# client frames. Beyond this we could get more clever, but this is good
2206
stack = traceback.extract_stack()[prefix_length:-5]
2207
self.stack = ''.join(traceback.format_list(stack))
2210
return self.call.method
2213
return self.call.method
2219
class TestCaseWithMemoryTransport(TestCase):
2220
"""Common test class for tests that do not need disk resources.
2222
Tests that need disk resources should derive from TestCaseWithTransport.
2224
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2226
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2227
a directory which does not exist. This serves to help ensure test isolation
2228
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2229
must exist. However, TestCaseWithMemoryTransport does not offer local
2230
file defaults for the transport in tests, nor does it obey the command line
2231
override, so tests that accidentally write to the common directory should
2234
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2235
a .bzr directory that stops us ascending higher into the filesystem.
2241
def __init__(self, methodName='runTest'):
2242
# allow test parameterization after test construction and before test
2243
# execution. Variables that the parameterizer sets need to be
2244
# ones that are not set by setUp, or setUp will trash them.
2245
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2246
self.vfs_transport_factory = default_transport
2247
self.transport_server = None
2248
self.transport_readonly_server = None
2249
self.__vfs_server = None
2251
def get_transport(self, relpath=None):
2252
"""Return a writeable transport.
2254
This transport is for the test scratch space relative to
2257
:param relpath: a path relative to the base url.
2259
t = get_transport(self.get_url(relpath))
2260
self.assertFalse(t.is_readonly())
2263
def get_readonly_transport(self, relpath=None):
2264
"""Return a readonly transport for the test scratch space
2266
This can be used to test that operations which should only need
2267
readonly access in fact do not try to write.
2269
:param relpath: a path relative to the base url.
2271
t = get_transport(self.get_readonly_url(relpath))
2272
self.assertTrue(t.is_readonly())
2275
def create_transport_readonly_server(self):
2276
"""Create a transport server from class defined at init.
2278
This is mostly a hook for daughter classes.
2280
return self.transport_readonly_server()
2282
def get_readonly_server(self):
2283
"""Get the server instance for the readonly transport
2285
This is useful for some tests with specific servers to do diagnostics.
2287
if self.__readonly_server is None:
2288
if self.transport_readonly_server is None:
2289
# readonly decorator requested
2290
self.__readonly_server = ReadonlyServer()
2292
# explicit readonly transport.
2293
self.__readonly_server = self.create_transport_readonly_server()
2294
self.start_server(self.__readonly_server,
2295
self.get_vfs_only_server())
2296
return self.__readonly_server
2298
def get_readonly_url(self, relpath=None):
2299
"""Get a URL for the readonly transport.
2301
This will either be backed by '.' or a decorator to the transport
2302
used by self.get_url()
2303
relpath provides for clients to get a path relative to the base url.
2304
These should only be downwards relative, not upwards.
2306
base = self.get_readonly_server().get_url()
2307
return self._adjust_url(base, relpath)
2309
def get_vfs_only_server(self):
2310
"""Get the vfs only read/write server instance.
2312
This is useful for some tests with specific servers that need
2315
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2316
is no means to override it.
2318
if self.__vfs_server is None:
2319
self.__vfs_server = MemoryServer()
2320
self.start_server(self.__vfs_server)
2321
return self.__vfs_server
2323
def get_server(self):
2324
"""Get the read/write server instance.
2326
This is useful for some tests with specific servers that need
2329
This is built from the self.transport_server factory. If that is None,
2330
then the self.get_vfs_server is returned.
2332
if self.__server is None:
2333
if (self.transport_server is None or self.transport_server is
2334
self.vfs_transport_factory):
2335
self.__server = self.get_vfs_only_server()
2337
# bring up a decorated means of access to the vfs only server.
2338
self.__server = self.transport_server()
2339
self.start_server(self.__server, self.get_vfs_only_server())
2340
return self.__server
2342
def _adjust_url(self, base, relpath):
2343
"""Get a URL (or maybe a path) for the readwrite transport.
2345
This will either be backed by '.' or to an equivalent non-file based
2347
relpath provides for clients to get a path relative to the base url.
2348
These should only be downwards relative, not upwards.
2350
if relpath is not None and relpath != '.':
2351
if not base.endswith('/'):
2353
# XXX: Really base should be a url; we did after all call
2354
# get_url()! But sometimes it's just a path (from
2355
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2356
# to a non-escaped local path.
2357
if base.startswith('./') or base.startswith('/'):
2360
base += urlutils.escape(relpath)
2363
def get_url(self, relpath=None):
2364
"""Get a URL (or maybe a path) for the readwrite transport.
2366
This will either be backed by '.' or to an equivalent non-file based
2368
relpath provides for clients to get a path relative to the base url.
2369
These should only be downwards relative, not upwards.
2371
base = self.get_server().get_url()
2372
return self._adjust_url(base, relpath)
2374
def get_vfs_only_url(self, relpath=None):
2375
"""Get a URL (or maybe a path for the plain old vfs transport.
2377
This will never be a smart protocol. It always has all the
2378
capabilities of the local filesystem, but it might actually be a
2379
MemoryTransport or some other similar virtual filesystem.
2381
This is the backing transport (if any) of the server returned by
2382
get_url and get_readonly_url.
2384
:param relpath: provides for clients to get a path relative to the base
2385
url. These should only be downwards relative, not upwards.
2388
base = self.get_vfs_only_server().get_url()
2389
return self._adjust_url(base, relpath)
2391
def _create_safety_net(self):
2392
"""Make a fake bzr directory.
2394
This prevents any tests propagating up onto the TEST_ROOT directory's
2397
root = TestCaseWithMemoryTransport.TEST_ROOT
2398
bzrdir.BzrDir.create_standalone_workingtree(root)
2400
def _check_safety_net(self):
2401
"""Check that the safety .bzr directory have not been touched.
2403
_make_test_root have created a .bzr directory to prevent tests from
2404
propagating. This method ensures than a test did not leaked.
2406
root = TestCaseWithMemoryTransport.TEST_ROOT
2407
self.permit_url(get_transport(root).base)
2408
wt = workingtree.WorkingTree.open(root)
2409
last_rev = wt.last_revision()
2410
if last_rev != 'null:':
2411
# The current test have modified the /bzr directory, we need to
2412
# recreate a new one or all the followng tests will fail.
2413
# If you need to inspect its content uncomment the following line
2414
# import pdb; pdb.set_trace()
2415
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2416
self._create_safety_net()
2417
raise AssertionError('%s/.bzr should not be modified' % root)
2419
def _make_test_root(self):
2420
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2421
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2422
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2424
TestCaseWithMemoryTransport.TEST_ROOT = root
2426
self._create_safety_net()
2428
# The same directory is used by all tests, and we're not
2429
# specifically told when all tests are finished. This will do.
2430
atexit.register(_rmtree_temp_dir, root)
2432
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2433
self.addCleanup(self._check_safety_net)
2435
def makeAndChdirToTestDir(self):
2436
"""Create a temporary directories for this one test.
2438
This must set self.test_home_dir and self.test_dir and chdir to
2441
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2443
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2444
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2445
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2446
self.permit_dir(self.test_dir)
2448
def make_branch(self, relpath, format=None):
2449
"""Create a branch on the transport at relpath."""
2450
repo = self.make_repository(relpath, format=format)
2451
return repo.bzrdir.create_branch()
2453
def make_bzrdir(self, relpath, format=None):
2455
# might be a relative or absolute path
2456
maybe_a_url = self.get_url(relpath)
2457
segments = maybe_a_url.rsplit('/', 1)
2458
t = get_transport(maybe_a_url)
2459
if len(segments) > 1 and segments[-1] not in ('', '.'):
2463
if isinstance(format, basestring):
2464
format = bzrdir.format_registry.make_bzrdir(format)
2465
return format.initialize_on_transport(t)
2466
except errors.UninitializableFormat:
2467
raise TestSkipped("Format %s is not initializable." % format)
2469
def make_repository(self, relpath, shared=False, format=None):
2470
"""Create a repository on our default transport at relpath.
2472
Note that relpath must be a relative path, not a full url.
2474
# FIXME: If you create a remoterepository this returns the underlying
2475
# real format, which is incorrect. Actually we should make sure that
2476
# RemoteBzrDir returns a RemoteRepository.
2477
# maybe mbp 20070410
2478
made_control = self.make_bzrdir(relpath, format=format)
2479
return made_control.create_repository(shared=shared)
2481
def make_smart_server(self, path):
2482
smart_server = server.SmartTCPServer_for_testing()
2483
self.start_server(smart_server, self.get_server())
2484
remote_transport = get_transport(smart_server.get_url()).clone(path)
2485
return remote_transport
2487
def make_branch_and_memory_tree(self, relpath, format=None):
2488
"""Create a branch on the default transport and a MemoryTree for it."""
2489
b = self.make_branch(relpath, format=format)
2490
return memorytree.MemoryTree.create_on_branch(b)
2492
def make_branch_builder(self, relpath, format=None):
2493
branch = self.make_branch(relpath, format=format)
2494
return branchbuilder.BranchBuilder(branch=branch)
2496
def overrideEnvironmentForTesting(self):
2497
test_home_dir = self.test_home_dir
2498
if isinstance(test_home_dir, unicode):
2499
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2500
os.environ['HOME'] = test_home_dir
2501
os.environ['BZR_HOME'] = test_home_dir
2504
super(TestCaseWithMemoryTransport, self).setUp()
2505
self._make_test_root()
2506
_currentdir = os.getcwdu()
2507
def _leaveDirectory():
2508
os.chdir(_currentdir)
2509
self.addCleanup(_leaveDirectory)
2510
self.makeAndChdirToTestDir()
2511
self.overrideEnvironmentForTesting()
2512
self.__readonly_server = None
2513
self.__server = None
2514
self.reduceLockdirTimeout()
2516
def setup_smart_server_with_call_log(self):
2517
"""Sets up a smart server as the transport server with a call log."""
2518
self.transport_server = server.SmartTCPServer_for_testing
2519
self.hpss_calls = []
2521
# Skip the current stack down to the caller of
2522
# setup_smart_server_with_call_log
2523
prefix_length = len(traceback.extract_stack()) - 2
2524
def capture_hpss_call(params):
2525
self.hpss_calls.append(
2526
CapturedCall(params, prefix_length))
2527
client._SmartClient.hooks.install_named_hook(
2528
'call', capture_hpss_call, None)
2530
def reset_smart_call_log(self):
2531
self.hpss_calls = []
2534
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2535
"""Derived class that runs a test within a temporary directory.
2537
This is useful for tests that need to create a branch, etc.
2539
The directory is created in a slightly complex way: for each
2540
Python invocation, a new temporary top-level directory is created.
2541
All test cases create their own directory within that. If the
2542
tests complete successfully, the directory is removed.
2544
:ivar test_base_dir: The path of the top-level directory for this
2545
test, which contains a home directory and a work directory.
2547
:ivar test_home_dir: An initially empty directory under test_base_dir
2548
which is used as $HOME for this test.
2550
:ivar test_dir: A directory under test_base_dir used as the current
2551
directory when the test proper is run.
2554
OVERRIDE_PYTHON = 'python'
2556
def check_file_contents(self, filename, expect):
2557
self.log("check contents of file %s" % filename)
2558
contents = file(filename, 'r').read()
2559
if contents != expect:
2560
self.log("expected: %r" % expect)
2561
self.log("actually: %r" % contents)
2562
self.fail("contents of %s not as expected" % filename)
2564
def _getTestDirPrefix(self):
2565
# create a directory within the top level test directory
2566
if sys.platform in ('win32', 'cygwin'):
2567
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2568
# windows is likely to have path-length limits so use a short name
2569
name_prefix = name_prefix[-30:]
2571
name_prefix = re.sub('[/]', '_', self.id())
2574
def makeAndChdirToTestDir(self):
2575
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2577
For TestCaseInTempDir we create a temporary directory based on the test
2578
name and then create two subdirs - test and home under it.
2580
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2581
self._getTestDirPrefix())
2583
for i in range(100):
2584
if os.path.exists(name):
2585
name = name_prefix + '_' + str(i)
2587
# now create test and home directories within this dir
2588
self.test_base_dir = name
2589
self.addCleanup(self.deleteTestDir)
2590
os.mkdir(self.test_base_dir)
2592
self.permit_dir(self.test_base_dir)
2593
# 'sprouting' and 'init' of a branch both walk up the tree to find
2594
# stacking policy to honour; create a bzr dir with an unshared
2595
# repository (but not a branch - our code would be trying to escape
2596
# then!) to stop them, and permit it to be read.
2597
# control = bzrdir.BzrDir.create(self.test_base_dir)
2598
# control.create_repository()
2599
self.test_home_dir = self.test_base_dir + '/home'
2600
os.mkdir(self.test_home_dir)
2601
self.test_dir = self.test_base_dir + '/work'
2602
os.mkdir(self.test_dir)
2603
os.chdir(self.test_dir)
2604
# put name of test inside
2605
f = file(self.test_base_dir + '/name', 'w')
2611
def deleteTestDir(self):
2612
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2613
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2615
def build_tree(self, shape, line_endings='binary', transport=None):
2616
"""Build a test tree according to a pattern.
2618
shape is a sequence of file specifications. If the final
2619
character is '/', a directory is created.
2621
This assumes that all the elements in the tree being built are new.
2623
This doesn't add anything to a branch.
2625
:type shape: list or tuple.
2626
:param line_endings: Either 'binary' or 'native'
2627
in binary mode, exact contents are written in native mode, the
2628
line endings match the default platform endings.
2629
:param transport: A transport to write to, for building trees on VFS's.
2630
If the transport is readonly or None, "." is opened automatically.
2633
if type(shape) not in (list, tuple):
2634
raise AssertionError("Parameter 'shape' should be "
2635
"a list or a tuple. Got %r instead" % (shape,))
2636
# It's OK to just create them using forward slashes on windows.
2637
if transport is None or transport.is_readonly():
2638
transport = get_transport(".")
2640
self.assertIsInstance(name, basestring)
2642
transport.mkdir(urlutils.escape(name[:-1]))
2644
if line_endings == 'binary':
2646
elif line_endings == 'native':
2649
raise errors.BzrError(
2650
'Invalid line ending request %r' % line_endings)
2651
content = "contents of %s%s" % (name.encode('utf-8'), end)
2652
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2654
def build_tree_contents(self, shape):
2655
build_tree_contents(shape)
2657
def assertInWorkingTree(self, path, root_path='.', tree=None):
2658
"""Assert whether path or paths are in the WorkingTree"""
2660
tree = workingtree.WorkingTree.open(root_path)
2661
if not isinstance(path, basestring):
2663
self.assertInWorkingTree(p, tree=tree)
2665
self.assertIsNot(tree.path2id(path), None,
2666
path+' not in working tree.')
2668
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2669
"""Assert whether path or paths are not in the WorkingTree"""
2671
tree = workingtree.WorkingTree.open(root_path)
2672
if not isinstance(path, basestring):
2674
self.assertNotInWorkingTree(p,tree=tree)
2676
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2679
class TestCaseWithTransport(TestCaseInTempDir):
2680
"""A test case that provides get_url and get_readonly_url facilities.
2682
These back onto two transport servers, one for readonly access and one for
2685
If no explicit class is provided for readonly access, a
2686
ReadonlyTransportDecorator is used instead which allows the use of non disk
2687
based read write transports.
2689
If an explicit class is provided for readonly access, that server and the
2690
readwrite one must both define get_url() as resolving to os.getcwd().
2693
def get_vfs_only_server(self):
2694
"""See TestCaseWithMemoryTransport.
2696
This is useful for some tests with specific servers that need
2699
if self.__vfs_server is None:
2700
self.__vfs_server = self.vfs_transport_factory()
2701
self.start_server(self.__vfs_server)
2702
return self.__vfs_server
2704
def make_branch_and_tree(self, relpath, format=None):
2705
"""Create a branch on the transport and a tree locally.
2707
If the transport is not a LocalTransport, the Tree can't be created on
2708
the transport. In that case if the vfs_transport_factory is
2709
LocalURLServer the working tree is created in the local
2710
directory backing the transport, and the returned tree's branch and
2711
repository will also be accessed locally. Otherwise a lightweight
2712
checkout is created and returned.
2714
We do this because we can't physically create a tree in the local
2715
path, with a branch reference to the transport_factory url, and
2716
a branch + repository in the vfs_transport, unless the vfs_transport
2717
namespace is distinct from the local disk - the two branch objects
2718
would collide. While we could construct a tree with its branch object
2719
pointing at the transport_factory transport in memory, reopening it
2720
would behaving unexpectedly, and has in the past caused testing bugs
2721
when we tried to do it that way.
2723
:param format: The BzrDirFormat.
2724
:returns: the WorkingTree.
2726
# TODO: always use the local disk path for the working tree,
2727
# this obviously requires a format that supports branch references
2728
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2730
b = self.make_branch(relpath, format=format)
2732
return b.bzrdir.create_workingtree()
2733
except errors.NotLocalUrl:
2734
# We can only make working trees locally at the moment. If the
2735
# transport can't support them, then we keep the non-disk-backed
2736
# branch and create a local checkout.
2737
if self.vfs_transport_factory is LocalURLServer:
2738
# the branch is colocated on disk, we cannot create a checkout.
2739
# hopefully callers will expect this.
2740
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2741
wt = local_controldir.create_workingtree()
2742
if wt.branch._format != b._format:
2744
# Make sure that assigning to wt._branch fixes wt.branch,
2745
# in case the implementation details of workingtree objects
2747
self.assertIs(b, wt.branch)
2750
return b.create_checkout(relpath, lightweight=True)
2752
def assertIsDirectory(self, relpath, transport):
2753
"""Assert that relpath within transport is a directory.
2755
This may not be possible on all transports; in that case it propagates
2756
a TransportNotPossible.
2759
mode = transport.stat(relpath).st_mode
2760
except errors.NoSuchFile:
2761
self.fail("path %s is not a directory; no such file"
2763
if not stat.S_ISDIR(mode):
2764
self.fail("path %s is not a directory; has mode %#o"
2767
def assertTreesEqual(self, left, right):
2768
"""Check that left and right have the same content and properties."""
2769
# we use a tree delta to check for equality of the content, and we
2770
# manually check for equality of other things such as the parents list.
2771
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2772
differences = left.changes_from(right)
2773
self.assertFalse(differences.has_changed(),
2774
"Trees %r and %r are different: %r" % (left, right, differences))
2777
super(TestCaseWithTransport, self).setUp()
2778
self.__vfs_server = None
2780
def disable_missing_extensions_warning(self):
2781
"""Some tests expect a precise stderr content.
2783
There is no point in forcing them to duplicate the extension related
2786
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2789
class ChrootedTestCase(TestCaseWithTransport):
2790
"""A support class that provides readonly urls outside the local namespace.
2792
This is done by checking if self.transport_server is a MemoryServer. if it
2793
is then we are chrooted already, if it is not then an HttpServer is used
2796
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2797
be used without needed to redo it when a different
2798
subclass is in use ?
2802
super(ChrootedTestCase, self).setUp()
2803
if not self.vfs_transport_factory == MemoryServer:
2804
self.transport_readonly_server = HttpServer
2807
def condition_id_re(pattern):
2808
"""Create a condition filter which performs a re check on a test's id.
2810
:param pattern: A regular expression string.
2811
:return: A callable that returns True if the re matches.
2813
filter_re = osutils.re_compile_checked(pattern, 0,
2815
def condition(test):
2817
return filter_re.search(test_id)
2821
def condition_isinstance(klass_or_klass_list):
2822
"""Create a condition filter which returns isinstance(param, klass).
2824
:return: A callable which when called with one parameter obj return the
2825
result of isinstance(obj, klass_or_klass_list).
2828
return isinstance(obj, klass_or_klass_list)
2832
def condition_id_in_list(id_list):
2833
"""Create a condition filter which verify that test's id in a list.
2835
:param id_list: A TestIdList object.
2836
:return: A callable that returns True if the test's id appears in the list.
2838
def condition(test):
2839
return id_list.includes(test.id())
2843
def condition_id_startswith(starts):
2844
"""Create a condition filter verifying that test's id starts with a string.
2846
:param starts: A list of string.
2847
:return: A callable that returns True if the test's id starts with one of
2850
def condition(test):
2851
for start in starts:
2852
if test.id().startswith(start):
2858
def exclude_tests_by_condition(suite, condition):
2859
"""Create a test suite which excludes some tests from suite.
2861
:param suite: The suite to get tests from.
2862
:param condition: A callable whose result evaluates True when called with a
2863
test case which should be excluded from the result.
2864
:return: A suite which contains the tests found in suite that fail
2868
for test in iter_suite_tests(suite):
2869
if not condition(test):
2871
return TestUtil.TestSuite(result)
2874
def filter_suite_by_condition(suite, condition):
2875
"""Create a test suite by filtering another one.
2877
:param suite: The source suite.
2878
:param condition: A callable whose result evaluates True when called with a
2879
test case which should be included in the result.
2880
:return: A suite which contains the tests found in suite that pass
2884
for test in iter_suite_tests(suite):
2887
return TestUtil.TestSuite(result)
2890
def filter_suite_by_re(suite, pattern):
2891
"""Create a test suite by filtering another one.
2893
:param suite: the source suite
2894
:param pattern: pattern that names must match
2895
:returns: the newly created suite
2897
condition = condition_id_re(pattern)
2898
result_suite = filter_suite_by_condition(suite, condition)
2902
def filter_suite_by_id_list(suite, test_id_list):
2903
"""Create a test suite by filtering another one.
2905
:param suite: The source suite.
2906
:param test_id_list: A list of the test ids to keep as strings.
2907
:returns: the newly created suite
2909
condition = condition_id_in_list(test_id_list)
2910
result_suite = filter_suite_by_condition(suite, condition)
2914
def filter_suite_by_id_startswith(suite, start):
2915
"""Create a test suite by filtering another one.
2917
:param suite: The source suite.
2918
:param start: A list of string the test id must start with one of.
2919
:returns: the newly created suite
2921
condition = condition_id_startswith(start)
2922
result_suite = filter_suite_by_condition(suite, condition)
2926
def exclude_tests_by_re(suite, pattern):
2927
"""Create a test suite which excludes some tests from suite.
2929
:param suite: The suite to get tests from.
2930
:param pattern: A regular expression string. Test ids that match this
2931
pattern will be excluded from the result.
2932
:return: A TestSuite that contains all the tests from suite without the
2933
tests that matched pattern. The order of tests is the same as it was in
2936
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2939
def preserve_input(something):
2940
"""A helper for performing test suite transformation chains.
2942
:param something: Anything you want to preserve.
2948
def randomize_suite(suite):
2949
"""Return a new TestSuite with suite's tests in random order.
2951
The tests in the input suite are flattened into a single suite in order to
2952
accomplish this. Any nested TestSuites are removed to provide global
2955
tests = list(iter_suite_tests(suite))
2956
random.shuffle(tests)
2957
return TestUtil.TestSuite(tests)
2960
def split_suite_by_condition(suite, condition):
2961
"""Split a test suite into two by a condition.
2963
:param suite: The suite to split.
2964
:param condition: The condition to match on. Tests that match this
2965
condition are returned in the first test suite, ones that do not match
2966
are in the second suite.
2967
:return: A tuple of two test suites, where the first contains tests from
2968
suite matching the condition, and the second contains the remainder
2969
from suite. The order within each output suite is the same as it was in
2974
for test in iter_suite_tests(suite):
2976
matched.append(test)
2978
did_not_match.append(test)
2979
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2982
def split_suite_by_re(suite, pattern):
2983
"""Split a test suite into two by a regular expression.
2985
:param suite: The suite to split.
2986
:param pattern: A regular expression string. Test ids that match this
2987
pattern will be in the first test suite returned, and the others in the
2988
second test suite returned.
2989
:return: A tuple of two test suites, where the first contains tests from
2990
suite matching pattern, and the second contains the remainder from
2991
suite. The order within each output suite is the same as it was in
2994
return split_suite_by_condition(suite, condition_id_re(pattern))
2997
def run_suite(suite, name='test', verbose=False, pattern=".*",
2998
stop_on_failure=False,
2999
transport=None, lsprof_timed=None, bench_history=None,
3000
matching_tests_first=None,
3003
exclude_pattern=None,
3006
suite_decorators=None,
3008
result_decorators=None,
3010
"""Run a test suite for bzr selftest.
3012
:param runner_class: The class of runner to use. Must support the
3013
constructor arguments passed by run_suite which are more than standard
3015
:return: A boolean indicating success.
3017
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3022
if runner_class is None:
3023
runner_class = TextTestRunner
3026
runner = runner_class(stream=stream,
3028
verbosity=verbosity,
3029
bench_history=bench_history,
3031
result_decorators=result_decorators,
3033
runner.stop_on_failure=stop_on_failure
3034
# built in decorator factories:
3036
random_order(random_seed, runner),
3037
exclude_tests(exclude_pattern),
3039
if matching_tests_first:
3040
decorators.append(tests_first(pattern))
3042
decorators.append(filter_tests(pattern))
3043
if suite_decorators:
3044
decorators.extend(suite_decorators)
3045
# tell the result object how many tests will be running: (except if
3046
# --parallel=fork is being used. Robert said he will provide a better
3047
# progress design later -- vila 20090817)
3048
if fork_decorator not in decorators:
3049
decorators.append(CountingDecorator)
3050
for decorator in decorators:
3051
suite = decorator(suite)
3053
# Done after test suite decoration to allow randomisation etc
3054
# to take effect, though that is of marginal benefit.
3056
stream.write("Listing tests only ...\n")
3057
for t in iter_suite_tests(suite):
3058
stream.write("%s\n" % (t.id()))
3060
result = runner.run(suite)
3062
return result.wasStrictlySuccessful()
3064
return result.wasSuccessful()
3067
# A registry where get() returns a suite decorator.
3068
parallel_registry = registry.Registry()
3071
def fork_decorator(suite):
3072
concurrency = osutils.local_concurrency()
3073
if concurrency == 1:
3075
from testtools import ConcurrentTestSuite
3076
return ConcurrentTestSuite(suite, fork_for_tests)
3077
parallel_registry.register('fork', fork_decorator)
3080
def subprocess_decorator(suite):
3081
concurrency = osutils.local_concurrency()
3082
if concurrency == 1:
3084
from testtools import ConcurrentTestSuite
3085
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3086
parallel_registry.register('subprocess', subprocess_decorator)
3089
def exclude_tests(exclude_pattern):
3090
"""Return a test suite decorator that excludes tests."""
3091
if exclude_pattern is None:
3092
return identity_decorator
3093
def decorator(suite):
3094
return ExcludeDecorator(suite, exclude_pattern)
3098
def filter_tests(pattern):
3100
return identity_decorator
3101
def decorator(suite):
3102
return FilterTestsDecorator(suite, pattern)
3106
def random_order(random_seed, runner):
3107
"""Return a test suite decorator factory for randomising tests order.
3109
:param random_seed: now, a string which casts to a long, or a long.
3110
:param runner: A test runner with a stream attribute to report on.
3112
if random_seed is None:
3113
return identity_decorator
3114
def decorator(suite):
3115
return RandomDecorator(suite, random_seed, runner.stream)
3119
def tests_first(pattern):
3121
return identity_decorator
3122
def decorator(suite):
3123
return TestFirstDecorator(suite, pattern)
3127
def identity_decorator(suite):
3132
class TestDecorator(TestSuite):
3133
"""A decorator for TestCase/TestSuite objects.
3135
Usually, subclasses should override __iter__(used when flattening test
3136
suites), which we do to filter, reorder, parallelise and so on, run() and
3140
def __init__(self, suite):
3141
TestSuite.__init__(self)
3144
def countTestCases(self):
3147
cases += test.countTestCases()
3154
def run(self, result):
3155
# Use iteration on self, not self._tests, to allow subclasses to hook
3158
if result.shouldStop:
3164
class CountingDecorator(TestDecorator):
3165
"""A decorator which calls result.progress(self.countTestCases)."""
3167
def run(self, result):
3168
progress_method = getattr(result, 'progress', None)
3169
if callable(progress_method):
3170
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3171
return super(CountingDecorator, self).run(result)
3174
class ExcludeDecorator(TestDecorator):
3175
"""A decorator which excludes test matching an exclude pattern."""
3177
def __init__(self, suite, exclude_pattern):
3178
TestDecorator.__init__(self, suite)
3179
self.exclude_pattern = exclude_pattern
3180
self.excluded = False
3184
return iter(self._tests)
3185
self.excluded = True
3186
suite = exclude_tests_by_re(self, self.exclude_pattern)
3188
self.addTests(suite)
3189
return iter(self._tests)
3192
class FilterTestsDecorator(TestDecorator):
3193
"""A decorator which filters tests to those matching a pattern."""
3195
def __init__(self, suite, pattern):
3196
TestDecorator.__init__(self, suite)
3197
self.pattern = pattern
3198
self.filtered = False
3202
return iter(self._tests)
3203
self.filtered = True
3204
suite = filter_suite_by_re(self, self.pattern)
3206
self.addTests(suite)
3207
return iter(self._tests)
3210
class RandomDecorator(TestDecorator):
3211
"""A decorator which randomises the order of its tests."""
3213
def __init__(self, suite, random_seed, stream):
3214
TestDecorator.__init__(self, suite)
3215
self.random_seed = random_seed
3216
self.randomised = False
3217
self.stream = stream
3221
return iter(self._tests)
3222
self.randomised = True
3223
self.stream.writeln("Randomizing test order using seed %s\n" %
3224
(self.actual_seed()))
3225
# Initialise the random number generator.
3226
random.seed(self.actual_seed())
3227
suite = randomize_suite(self)
3229
self.addTests(suite)
3230
return iter(self._tests)
3232
def actual_seed(self):
3233
if self.random_seed == "now":
3234
# We convert the seed to a long to make it reuseable across
3235
# invocations (because the user can reenter it).
3236
self.random_seed = long(time.time())
3238
# Convert the seed to a long if we can
3240
self.random_seed = long(self.random_seed)
3243
return self.random_seed
3246
class TestFirstDecorator(TestDecorator):
3247
"""A decorator which moves named tests to the front."""
3249
def __init__(self, suite, pattern):
3250
TestDecorator.__init__(self, suite)
3251
self.pattern = pattern
3252
self.filtered = False
3256
return iter(self._tests)
3257
self.filtered = True
3258
suites = split_suite_by_re(self, self.pattern)
3260
self.addTests(suites)
3261
return iter(self._tests)
3264
def partition_tests(suite, count):
3265
"""Partition suite into count lists of tests."""
3267
tests = list(iter_suite_tests(suite))
3268
tests_per_process = int(math.ceil(float(len(tests)) / count))
3269
for block in range(count):
3270
low_test = block * tests_per_process
3271
high_test = low_test + tests_per_process
3272
process_tests = tests[low_test:high_test]
3273
result.append(process_tests)
3277
def fork_for_tests(suite):
3278
"""Take suite and start up one runner per CPU by forking()
3280
:return: An iterable of TestCase-like objects which can each have
3281
run(result) called on them to feed tests to result.
3283
concurrency = osutils.local_concurrency()
3285
from subunit import TestProtocolClient, ProtocolTestCase
3286
class TestInOtherProcess(ProtocolTestCase):
3287
# Should be in subunit, I think. RBC.
3288
def __init__(self, stream, pid):
3289
ProtocolTestCase.__init__(self, stream)
3292
def run(self, result):
3294
ProtocolTestCase.run(self, result)
3296
os.waitpid(self.pid, os.WNOHANG)
3298
test_blocks = partition_tests(suite, concurrency)
3299
for process_tests in test_blocks:
3300
process_suite = TestSuite()
3301
process_suite.addTests(process_tests)
3302
c2pread, c2pwrite = os.pipe()
3307
# Leave stderr and stdout open so we can see test noise
3308
# Close stdin so that the child goes away if it decides to
3309
# read from stdin (otherwise its a roulette to see what
3310
# child actually gets keystrokes for pdb etc).
3313
stream = os.fdopen(c2pwrite, 'wb', 1)
3314
subunit_result = BzrAutoTimingTestResultDecorator(
3315
TestProtocolClient(stream))
3316
process_suite.run(subunit_result)
3321
stream = os.fdopen(c2pread, 'rb', 1)
3322
test = TestInOtherProcess(stream, pid)
3327
def reinvoke_for_tests(suite):
3328
"""Take suite and start up one runner per CPU using subprocess().
3330
:return: An iterable of TestCase-like objects which can each have
3331
run(result) called on them to feed tests to result.
3333
concurrency = osutils.local_concurrency()
3335
from subunit import ProtocolTestCase
3336
class TestInSubprocess(ProtocolTestCase):
3337
def __init__(self, process, name):
3338
ProtocolTestCase.__init__(self, process.stdout)
3339
self.process = process
3340
self.process.stdin.close()
3343
def run(self, result):
3345
ProtocolTestCase.run(self, result)
3348
os.unlink(self.name)
3349
# print "pid %d finished" % finished_process
3350
test_blocks = partition_tests(suite, concurrency)
3351
for process_tests in test_blocks:
3352
# ugly; currently reimplement rather than reuses TestCase methods.
3353
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3354
if not os.path.isfile(bzr_path):
3355
# We are probably installed. Assume sys.argv is the right file
3356
bzr_path = sys.argv[0]
3357
bzr_path = [bzr_path]
3358
if sys.platform == "win32":
3359
# if we're on windows, we can't execute the bzr script directly
3360
bzr_path = [sys.executable] + bzr_path
3361
fd, test_list_file_name = tempfile.mkstemp()
3362
test_list_file = os.fdopen(fd, 'wb', 1)
3363
for test in process_tests:
3364
test_list_file.write(test.id() + '\n')
3365
test_list_file.close()
3367
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3369
if '--no-plugins' in sys.argv:
3370
argv.append('--no-plugins')
3371
# stderr=STDOUT would be ideal, but until we prevent noise on
3372
# stderr it can interrupt the subunit protocol.
3373
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3375
test = TestInSubprocess(process, test_list_file_name)
3378
os.unlink(test_list_file_name)
3383
class ForwardingResult(unittest.TestResult):
3385
def __init__(self, target):
3386
unittest.TestResult.__init__(self)
3387
self.result = target
3389
def startTest(self, test):
3390
self.result.startTest(test)
3392
def stopTest(self, test):
3393
self.result.stopTest(test)
3395
def startTestRun(self):
3396
self.result.startTestRun()
3398
def stopTestRun(self):
3399
self.result.stopTestRun()
3401
def addSkip(self, test, reason):
3402
self.result.addSkip(test, reason)
3404
def addSuccess(self, test):
3405
self.result.addSuccess(test)
3407
def addError(self, test, err):
3408
self.result.addError(test, err)
3410
def addFailure(self, test, err):
3411
self.result.addFailure(test, err)
3414
class BZRTransformingResult(ForwardingResult):
3416
def addError(self, test, err):
3417
feature = self._error_looks_like('UnavailableFeature: ', err)
3418
if feature is not None:
3419
self.result.addNotSupported(test, feature)
3421
self.result.addError(test, err)
3423
def addFailure(self, test, err):
3424
known = self._error_looks_like('KnownFailure: ', err)
3425
if known is not None:
3426
self.result.addExpectedFailure(test,
3427
[KnownFailure, KnownFailure(known), None])
3429
self.result.addFailure(test, err)
3431
def _error_looks_like(self, prefix, err):
3432
"""Deserialize exception and returns the stringify value."""
3436
if isinstance(exc, subunit.RemoteException):
3437
# stringify the exception gives access to the remote traceback
3438
# We search the last line for 'prefix'
3439
lines = str(exc).split('\n')
3440
while lines and not lines[-1]:
3443
if lines[-1].startswith(prefix):
3444
value = lines[-1][len(prefix):]
3449
from subunit.test_results import AutoTimingTestResultDecorator
3450
# Expected failure should be seen as a success not a failure Once subunit
3451
# provide native support for that, BZRTransformingResult and this class
3452
# will become useless.
3453
class BzrAutoTimingTestResultDecorator(AutoTimingTestResultDecorator):
3455
def addExpectedFailure(self, test, err):
3456
self._before_event()
3457
return self._call_maybe("addExpectedFailure", self._degrade_skip,
3460
# Let's just define a no-op decorator
3461
BzrAutoTimingTestResultDecorator = lambda x:x
3464
class ProfileResult(ForwardingResult):
3465
"""Generate profiling data for all activity between start and success.
3467
The profile data is appended to the test's _benchcalls attribute and can
3468
be accessed by the forwarded-to TestResult.
3470
While it might be cleaner do accumulate this in stopTest, addSuccess is
3471
where our existing output support for lsprof is, and this class aims to
3472
fit in with that: while it could be moved it's not necessary to accomplish
3473
test profiling, nor would it be dramatically cleaner.
3476
def startTest(self, test):
3477
self.profiler = bzrlib.lsprof.BzrProfiler()
3478
self.profiler.start()
3479
ForwardingResult.startTest(self, test)
3481
def addSuccess(self, test):
3482
stats = self.profiler.stop()
3484
calls = test._benchcalls
3485
except AttributeError:
3486
test._benchcalls = []
3487
calls = test._benchcalls
3488
calls.append(((test.id(), "", ""), stats))
3489
ForwardingResult.addSuccess(self, test)
3491
def stopTest(self, test):
3492
ForwardingResult.stopTest(self, test)
3493
self.profiler = None
3496
# Controlled by "bzr selftest -E=..." option
3497
# Currently supported:
3498
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3499
# preserves any flags supplied at the command line.
3500
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3501
# rather than failing tests. And no longer raise
3502
# LockContention when fctnl locks are not being used
3503
# with proper exclusion rules.
3504
selftest_debug_flags = set()
3507
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3509
test_suite_factory=None,
3512
matching_tests_first=None,
3515
exclude_pattern=None,
3521
suite_decorators=None,
3525
"""Run the whole test suite under the enhanced runner"""
3526
# XXX: Very ugly way to do this...
3527
# Disable warning about old formats because we don't want it to disturb
3528
# any blackbox tests.
3529
from bzrlib import repository
3530
repository._deprecation_warning_done = True
3532
global default_transport
3533
if transport is None:
3534
transport = default_transport
3535
old_transport = default_transport
3536
default_transport = transport
3537
global selftest_debug_flags
3538
old_debug_flags = selftest_debug_flags
3539
if debug_flags is not None:
3540
selftest_debug_flags = set(debug_flags)
3542
if load_list is None:
3545
keep_only = load_test_id_list(load_list)
3547
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3548
for start in starting_with]
3549
if test_suite_factory is None:
3550
# Reduce loading time by loading modules based on the starting_with
3552
suite = test_suite(keep_only, starting_with)
3554
suite = test_suite_factory()
3556
# But always filter as requested.
3557
suite = filter_suite_by_id_startswith(suite, starting_with)
3558
result_decorators = []
3560
result_decorators.append(ProfileResult)
3561
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3562
stop_on_failure=stop_on_failure,
3563
transport=transport,
3564
lsprof_timed=lsprof_timed,
3565
bench_history=bench_history,
3566
matching_tests_first=matching_tests_first,
3567
list_only=list_only,
3568
random_seed=random_seed,
3569
exclude_pattern=exclude_pattern,
3571
runner_class=runner_class,
3572
suite_decorators=suite_decorators,
3574
result_decorators=result_decorators,
3577
default_transport = old_transport
3578
selftest_debug_flags = old_debug_flags
3581
def load_test_id_list(file_name):
3582
"""Load a test id list from a text file.
3584
The format is one test id by line. No special care is taken to impose
3585
strict rules, these test ids are used to filter the test suite so a test id
3586
that do not match an existing test will do no harm. This allows user to add
3587
comments, leave blank lines, etc.
3591
ftest = open(file_name, 'rt')
3593
if e.errno != errno.ENOENT:
3596
raise errors.NoSuchFile(file_name)
3598
for test_name in ftest.readlines():
3599
test_list.append(test_name.strip())
3604
def suite_matches_id_list(test_suite, id_list):
3605
"""Warns about tests not appearing or appearing more than once.
3607
:param test_suite: A TestSuite object.
3608
:param test_id_list: The list of test ids that should be found in
3611
:return: (absents, duplicates) absents is a list containing the test found
3612
in id_list but not in test_suite, duplicates is a list containing the
3613
test found multiple times in test_suite.
3615
When using a prefined test id list, it may occurs that some tests do not
3616
exist anymore or that some tests use the same id. This function warns the
3617
tester about potential problems in his workflow (test lists are volatile)
3618
or in the test suite itself (using the same id for several tests does not
3619
help to localize defects).
3621
# Build a dict counting id occurrences
3623
for test in iter_suite_tests(test_suite):
3625
tests[id] = tests.get(id, 0) + 1
3630
occurs = tests.get(id, 0)
3632
not_found.append(id)
3634
duplicates.append(id)
3636
return not_found, duplicates
3639
class TestIdList(object):
3640
"""Test id list to filter a test suite.
3642
Relying on the assumption that test ids are built as:
3643
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3644
notation, this class offers methods to :
3645
- avoid building a test suite for modules not refered to in the test list,
3646
- keep only the tests listed from the module test suite.
3649
def __init__(self, test_id_list):
3650
# When a test suite needs to be filtered against us we compare test ids
3651
# for equality, so a simple dict offers a quick and simple solution.
3652
self.tests = dict().fromkeys(test_id_list, True)
3654
# While unittest.TestCase have ids like:
3655
# <module>.<class>.<method>[(<param+)],
3656
# doctest.DocTestCase can have ids like:
3659
# <module>.<function>
3660
# <module>.<class>.<method>
3662
# Since we can't predict a test class from its name only, we settle on
3663
# a simple constraint: a test id always begins with its module name.
3666
for test_id in test_id_list:
3667
parts = test_id.split('.')
3668
mod_name = parts.pop(0)
3669
modules[mod_name] = True
3671
mod_name += '.' + part
3672
modules[mod_name] = True
3673
self.modules = modules
3675
def refers_to(self, module_name):
3676
"""Is there tests for the module or one of its sub modules."""
3677
return self.modules.has_key(module_name)
3679
def includes(self, test_id):
3680
return self.tests.has_key(test_id)
3683
class TestPrefixAliasRegistry(registry.Registry):
3684
"""A registry for test prefix aliases.
3686
This helps implement shorcuts for the --starting-with selftest
3687
option. Overriding existing prefixes is not allowed but not fatal (a
3688
warning will be emitted).
3691
def register(self, key, obj, help=None, info=None,
3692
override_existing=False):
3693
"""See Registry.register.
3695
Trying to override an existing alias causes a warning to be emitted,
3696
not a fatal execption.
3699
super(TestPrefixAliasRegistry, self).register(
3700
key, obj, help=help, info=info, override_existing=False)
3702
actual = self.get(key)
3703
note('Test prefix alias %s is already used for %s, ignoring %s'
3704
% (key, actual, obj))
3706
def resolve_alias(self, id_start):
3707
"""Replace the alias by the prefix in the given string.
3709
Using an unknown prefix is an error to help catching typos.
3711
parts = id_start.split('.')
3713
parts[0] = self.get(parts[0])
3715
raise errors.BzrCommandError(
3716
'%s is not a known test prefix alias' % parts[0])
3717
return '.'.join(parts)
3720
test_prefix_alias_registry = TestPrefixAliasRegistry()
3721
"""Registry of test prefix aliases."""
3724
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3725
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3726
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3728
# Obvious higest levels prefixes, feel free to add your own via a plugin
3729
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3730
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3731
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3732
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3733
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3736
def _test_suite_testmod_names():
3737
"""Return the standard list of test module names to test."""
3740
'bzrlib.tests.blackbox',
3741
'bzrlib.tests.commands',
3742
'bzrlib.tests.per_branch',
3743
'bzrlib.tests.per_bzrdir',
3744
'bzrlib.tests.per_foreign_vcs',
3745
'bzrlib.tests.per_interrepository',
3746
'bzrlib.tests.per_intertree',
3747
'bzrlib.tests.per_inventory',
3748
'bzrlib.tests.per_interbranch',
3749
'bzrlib.tests.per_lock',
3750
'bzrlib.tests.per_merger',
3751
'bzrlib.tests.per_transport',
3752
'bzrlib.tests.per_tree',
3753
'bzrlib.tests.per_pack_repository',
3754
'bzrlib.tests.per_repository',
3755
'bzrlib.tests.per_repository_chk',
3756
'bzrlib.tests.per_repository_reference',
3757
'bzrlib.tests.per_uifactory',
3758
'bzrlib.tests.per_versionedfile',
3759
'bzrlib.tests.per_workingtree',
3760
'bzrlib.tests.test__annotator',
3761
'bzrlib.tests.test__chk_map',
3762
'bzrlib.tests.test__dirstate_helpers',
3763
'bzrlib.tests.test__groupcompress',
3764
'bzrlib.tests.test__known_graph',
3765
'bzrlib.tests.test__rio',
3766
'bzrlib.tests.test__simple_set',
3767
'bzrlib.tests.test__static_tuple',
3768
'bzrlib.tests.test__walkdirs_win32',
3769
'bzrlib.tests.test_ancestry',
3770
'bzrlib.tests.test_annotate',
3771
'bzrlib.tests.test_api',
3772
'bzrlib.tests.test_atomicfile',
3773
'bzrlib.tests.test_bad_files',
3774
'bzrlib.tests.test_bencode',
3775
'bzrlib.tests.test_bisect_multi',
3776
'bzrlib.tests.test_branch',
3777
'bzrlib.tests.test_branchbuilder',
3778
'bzrlib.tests.test_btree_index',
3779
'bzrlib.tests.test_bugtracker',
3780
'bzrlib.tests.test_bundle',
3781
'bzrlib.tests.test_bzrdir',
3782
'bzrlib.tests.test__chunks_to_lines',
3783
'bzrlib.tests.test_cache_utf8',
3784
'bzrlib.tests.test_chk_map',
3785
'bzrlib.tests.test_chk_serializer',
3786
'bzrlib.tests.test_chunk_writer',
3787
'bzrlib.tests.test_clean_tree',
3788
'bzrlib.tests.test_cleanup',
3789
'bzrlib.tests.test_commands',
3790
'bzrlib.tests.test_commit',
3791
'bzrlib.tests.test_commit_merge',
3792
'bzrlib.tests.test_config',
3793
'bzrlib.tests.test_conflicts',
3794
'bzrlib.tests.test_counted_lock',
3795
'bzrlib.tests.test_crash',
3796
'bzrlib.tests.test_decorators',
3797
'bzrlib.tests.test_delta',
3798
'bzrlib.tests.test_debug',
3799
'bzrlib.tests.test_deprecated_graph',
3800
'bzrlib.tests.test_diff',
3801
'bzrlib.tests.test_directory_service',
3802
'bzrlib.tests.test_dirstate',
3803
'bzrlib.tests.test_email_message',
3804
'bzrlib.tests.test_eol_filters',
3805
'bzrlib.tests.test_errors',
3806
'bzrlib.tests.test_export',
3807
'bzrlib.tests.test_extract',
3808
'bzrlib.tests.test_fetch',
3809
'bzrlib.tests.test_fifo_cache',
3810
'bzrlib.tests.test_filters',
3811
'bzrlib.tests.test_ftp_transport',
3812
'bzrlib.tests.test_foreign',
3813
'bzrlib.tests.test_generate_docs',
3814
'bzrlib.tests.test_generate_ids',
3815
'bzrlib.tests.test_globbing',
3816
'bzrlib.tests.test_gpg',
3817
'bzrlib.tests.test_graph',
3818
'bzrlib.tests.test_groupcompress',
3819
'bzrlib.tests.test_hashcache',
3820
'bzrlib.tests.test_help',
3821
'bzrlib.tests.test_hooks',
3822
'bzrlib.tests.test_http',
3823
'bzrlib.tests.test_http_response',
3824
'bzrlib.tests.test_https_ca_bundle',
3825
'bzrlib.tests.test_identitymap',
3826
'bzrlib.tests.test_ignores',
3827
'bzrlib.tests.test_index',
3828
'bzrlib.tests.test_info',
3829
'bzrlib.tests.test_inv',
3830
'bzrlib.tests.test_inventory_delta',
3831
'bzrlib.tests.test_knit',
3832
'bzrlib.tests.test_lazy_import',
3833
'bzrlib.tests.test_lazy_regex',
3834
'bzrlib.tests.test_lock',
3835
'bzrlib.tests.test_lockable_files',
3836
'bzrlib.tests.test_lockdir',
3837
'bzrlib.tests.test_log',
3838
'bzrlib.tests.test_lru_cache',
3839
'bzrlib.tests.test_lsprof',
3840
'bzrlib.tests.test_mail_client',
3841
'bzrlib.tests.test_memorytree',
3842
'bzrlib.tests.test_merge',
3843
'bzrlib.tests.test_merge3',
3844
'bzrlib.tests.test_merge_core',
3845
'bzrlib.tests.test_merge_directive',
3846
'bzrlib.tests.test_missing',
3847
'bzrlib.tests.test_msgeditor',
3848
'bzrlib.tests.test_multiparent',
3849
'bzrlib.tests.test_mutabletree',
3850
'bzrlib.tests.test_nonascii',
3851
'bzrlib.tests.test_options',
3852
'bzrlib.tests.test_osutils',
3853
'bzrlib.tests.test_osutils_encodings',
3854
'bzrlib.tests.test_pack',
3855
'bzrlib.tests.test_patch',
3856
'bzrlib.tests.test_patches',
3857
'bzrlib.tests.test_permissions',
3858
'bzrlib.tests.test_plugins',
3859
'bzrlib.tests.test_progress',
3860
'bzrlib.tests.test_read_bundle',
3861
'bzrlib.tests.test_reconcile',
3862
'bzrlib.tests.test_reconfigure',
3863
'bzrlib.tests.test_registry',
3864
'bzrlib.tests.test_remote',
3865
'bzrlib.tests.test_rename_map',
3866
'bzrlib.tests.test_repository',
3867
'bzrlib.tests.test_revert',
3868
'bzrlib.tests.test_revision',
3869
'bzrlib.tests.test_revisionspec',
3870
'bzrlib.tests.test_revisiontree',
3871
'bzrlib.tests.test_rio',
3872
'bzrlib.tests.test_rules',
3873
'bzrlib.tests.test_sampler',
3874
'bzrlib.tests.test_script',
3875
'bzrlib.tests.test_selftest',
3876
'bzrlib.tests.test_serializer',
3877
'bzrlib.tests.test_setup',
3878
'bzrlib.tests.test_sftp_transport',
3879
'bzrlib.tests.test_shelf',
3880
'bzrlib.tests.test_shelf_ui',
3881
'bzrlib.tests.test_smart',
3882
'bzrlib.tests.test_smart_add',
3883
'bzrlib.tests.test_smart_request',
3884
'bzrlib.tests.test_smart_transport',
3885
'bzrlib.tests.test_smtp_connection',
3886
'bzrlib.tests.test_source',
3887
'bzrlib.tests.test_ssh_transport',
3888
'bzrlib.tests.test_status',
3889
'bzrlib.tests.test_store',
3890
'bzrlib.tests.test_strace',
3891
'bzrlib.tests.test_subsume',
3892
'bzrlib.tests.test_switch',
3893
'bzrlib.tests.test_symbol_versioning',
3894
'bzrlib.tests.test_tag',
3895
'bzrlib.tests.test_testament',
3896
'bzrlib.tests.test_textfile',
3897
'bzrlib.tests.test_textmerge',
3898
'bzrlib.tests.test_timestamp',
3899
'bzrlib.tests.test_trace',
3900
'bzrlib.tests.test_transactions',
3901
'bzrlib.tests.test_transform',
3902
'bzrlib.tests.test_transport',
3903
'bzrlib.tests.test_transport_log',
3904
'bzrlib.tests.test_tree',
3905
'bzrlib.tests.test_treebuilder',
3906
'bzrlib.tests.test_tsort',
3907
'bzrlib.tests.test_tuned_gzip',
3908
'bzrlib.tests.test_ui',
3909
'bzrlib.tests.test_uncommit',
3910
'bzrlib.tests.test_upgrade',
3911
'bzrlib.tests.test_upgrade_stacked',
3912
'bzrlib.tests.test_urlutils',
3913
'bzrlib.tests.test_version',
3914
'bzrlib.tests.test_version_info',
3915
'bzrlib.tests.test_weave',
3916
'bzrlib.tests.test_whitebox',
3917
'bzrlib.tests.test_win32utils',
3918
'bzrlib.tests.test_workingtree',
3919
'bzrlib.tests.test_workingtree_4',
3920
'bzrlib.tests.test_wsgi',
3921
'bzrlib.tests.test_xml',
3925
def _test_suite_modules_to_doctest():
3926
"""Return the list of modules to doctest."""
3929
'bzrlib.branchbuilder',
3932
'bzrlib.iterablefile',
3936
'bzrlib.symbol_versioning',
3939
'bzrlib.version_info_formats.format_custom',
3943
def test_suite(keep_only=None, starting_with=None):
3944
"""Build and return TestSuite for the whole of bzrlib.
3946
:param keep_only: A list of test ids limiting the suite returned.
3948
:param starting_with: An id limiting the suite returned to the tests
3951
This function can be replaced if you need to change the default test
3952
suite on a global basis, but it is not encouraged.
3955
loader = TestUtil.TestLoader()
3957
if keep_only is not None:
3958
id_filter = TestIdList(keep_only)
3960
# We take precedence over keep_only because *at loading time* using
3961
# both options means we will load less tests for the same final result.
3962
def interesting_module(name):
3963
for start in starting_with:
3965
# Either the module name starts with the specified string
3966
name.startswith(start)
3967
# or it may contain tests starting with the specified string
3968
or start.startswith(name)
3972
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3974
elif keep_only is not None:
3975
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3976
def interesting_module(name):
3977
return id_filter.refers_to(name)
3980
loader = TestUtil.TestLoader()
3981
def interesting_module(name):
3982
# No filtering, all modules are interesting
3985
suite = loader.suiteClass()
3987
# modules building their suite with loadTestsFromModuleNames
3988
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3990
for mod in _test_suite_modules_to_doctest():
3991
if not interesting_module(mod):
3992
# No tests to keep here, move along
3995
# note that this really does mean "report only" -- doctest
3996
# still runs the rest of the examples
3997
doc_suite = doctest.DocTestSuite(mod,
3998
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3999
except ValueError, e:
4000
print '**failed to get doctest for: %s\n%s' % (mod, e)
4002
if len(doc_suite._tests) == 0:
4003
raise errors.BzrError("no doctests found in %s" % (mod,))
4004
suite.addTest(doc_suite)
4006
default_encoding = sys.getdefaultencoding()
4007
for name, plugin in bzrlib.plugin.plugins().items():
4008
if not interesting_module(plugin.module.__name__):
4010
plugin_suite = plugin.test_suite()
4011
# We used to catch ImportError here and turn it into just a warning,
4012
# but really if you don't have --no-plugins this should be a failure.
4013
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4014
if plugin_suite is None:
4015
plugin_suite = plugin.load_plugin_tests(loader)
4016
if plugin_suite is not None:
4017
suite.addTest(plugin_suite)
4018
if default_encoding != sys.getdefaultencoding():
4019
bzrlib.trace.warning(
4020
'Plugin "%s" tried to reset default encoding to: %s', name,
4021
sys.getdefaultencoding())
4023
sys.setdefaultencoding(default_encoding)
4025
if keep_only is not None:
4026
# Now that the referred modules have loaded their tests, keep only the
4028
suite = filter_suite_by_id_list(suite, id_filter)
4029
# Do some sanity checks on the id_list filtering
4030
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4032
# The tester has used both keep_only and starting_with, so he is
4033
# already aware that some tests are excluded from the list, there
4034
# is no need to tell him which.
4037
# Some tests mentioned in the list are not in the test suite. The
4038
# list may be out of date, report to the tester.
4039
for id in not_found:
4040
bzrlib.trace.warning('"%s" not found in the test suite', id)
4041
for id in duplicates:
4042
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
4047
def multiply_scenarios(scenarios_left, scenarios_right):
4048
"""Multiply two sets of scenarios.
4050
:returns: the cartesian product of the two sets of scenarios, that is
4051
a scenario for every possible combination of a left scenario and a
4055
('%s,%s' % (left_name, right_name),
4056
dict(left_dict.items() + right_dict.items()))
4057
for left_name, left_dict in scenarios_left
4058
for right_name, right_dict in scenarios_right]
4061
def multiply_tests(tests, scenarios, result):
4062
"""Multiply tests_list by scenarios into result.
4064
This is the core workhorse for test parameterisation.
4066
Typically the load_tests() method for a per-implementation test suite will
4067
call multiply_tests and return the result.
4069
:param tests: The tests to parameterise.
4070
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4071
scenario_param_dict).
4072
:param result: A TestSuite to add created tests to.
4074
This returns the passed in result TestSuite with the cross product of all
4075
the tests repeated once for each scenario. Each test is adapted by adding
4076
the scenario name at the end of its id(), and updating the test object's
4077
__dict__ with the scenario_param_dict.
4079
>>> import bzrlib.tests.test_sampler
4080
>>> r = multiply_tests(
4081
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4082
... [('one', dict(param=1)),
4083
... ('two', dict(param=2))],
4085
>>> tests = list(iter_suite_tests(r))
4089
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4095
for test in iter_suite_tests(tests):
4096
apply_scenarios(test, scenarios, result)
4100
def apply_scenarios(test, scenarios, result):
4101
"""Apply the scenarios in scenarios to test and add to result.
4103
:param test: The test to apply scenarios to.
4104
:param scenarios: An iterable of scenarios to apply to test.
4106
:seealso: apply_scenario
4108
for scenario in scenarios:
4109
result.addTest(apply_scenario(test, scenario))
4113
def apply_scenario(test, scenario):
4114
"""Copy test and apply scenario to it.
4116
:param test: A test to adapt.
4117
:param scenario: A tuple describing the scenarion.
4118
The first element of the tuple is the new test id.
4119
The second element is a dict containing attributes to set on the
4121
:return: The adapted test.
4123
new_id = "%s(%s)" % (test.id(), scenario[0])
4124
new_test = clone_test(test, new_id)
4125
for name, value in scenario[1].items():
4126
setattr(new_test, name, value)
4130
def clone_test(test, new_id):
4131
"""Clone a test giving it a new id.
4133
:param test: The test to clone.
4134
:param new_id: The id to assign to it.
4135
:return: The new test.
4137
new_test = copy(test)
4138
new_test.id = lambda: new_id
4142
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4144
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4146
('python', {'module': py_module}),
4148
suite = loader.suiteClass()
4149
feature = ModuleAvailableFeature(ext_module_name)
4150
if feature.available():
4151
scenarios.append(('C', {'module': feature.module}))
4153
# the compiled module isn't available, so we add a failing test
4154
class FailWithoutFeature(TestCase):
4155
def test_fail(self):
4156
self.requireFeature(feature)
4157
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4158
result = multiply_tests(standard_tests, scenarios, suite)
4159
return result, feature
4162
def _rmtree_temp_dir(dirname, test_id=None):
4163
# If LANG=C we probably have created some bogus paths
4164
# which rmtree(unicode) will fail to delete
4165
# so make sure we are using rmtree(str) to delete everything
4166
# except on win32, where rmtree(str) will fail
4167
# since it doesn't have the property of byte-stream paths
4168
# (they are either ascii or mbcs)
4169
if sys.platform == 'win32':
4170
# make sure we are using the unicode win32 api
4171
dirname = unicode(dirname)
4173
dirname = dirname.encode(sys.getfilesystemencoding())
4175
osutils.rmtree(dirname)
4177
# We don't want to fail here because some useful display will be lost
4178
# otherwise. Polluting the tmp dir is bad, but not giving all the
4179
# possible info to the test runner is even worse.
4181
ui.ui_factory.clear_term()
4182
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4183
sys.stderr.write('Unable to remove testing dir %s\n%s'
4184
% (os.path.basename(dirname), e))
4187
class Feature(object):
4188
"""An operating system Feature."""
4191
self._available = None
4193
def available(self):
4194
"""Is the feature available?
4196
:return: True if the feature is available.
4198
if self._available is None:
4199
self._available = self._probe()
4200
return self._available
4203
"""Implement this method in concrete features.
4205
:return: True if the feature is available.
4207
raise NotImplementedError
4210
if getattr(self, 'feature_name', None):
4211
return self.feature_name()
4212
return self.__class__.__name__
4215
class _SymlinkFeature(Feature):
4218
return osutils.has_symlinks()
4220
def feature_name(self):
4223
SymlinkFeature = _SymlinkFeature()
4226
class _HardlinkFeature(Feature):
4229
return osutils.has_hardlinks()
4231
def feature_name(self):
4234
HardlinkFeature = _HardlinkFeature()
4237
class _OsFifoFeature(Feature):
4240
return getattr(os, 'mkfifo', None)
4242
def feature_name(self):
4243
return 'filesystem fifos'
4245
OsFifoFeature = _OsFifoFeature()
4248
class _UnicodeFilenameFeature(Feature):
4249
"""Does the filesystem support Unicode filenames?"""
4253
# Check for character combinations unlikely to be covered by any
4254
# single non-unicode encoding. We use the characters
4255
# - greek small letter alpha (U+03B1) and
4256
# - braille pattern dots-123456 (U+283F).
4257
os.stat(u'\u03b1\u283f')
4258
except UnicodeEncodeError:
4260
except (IOError, OSError):
4261
# The filesystem allows the Unicode filename but the file doesn't
4265
# The filesystem allows the Unicode filename and the file exists,
4269
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4272
class _CompatabilityThunkFeature(Feature):
4273
"""This feature is just a thunk to another feature.
4275
It issues a deprecation warning if it is accessed, to let you know that you
4276
should really use a different feature.
4279
def __init__(self, module, name, this_name, dep_version):
4280
super(_CompatabilityThunkFeature, self).__init__()
4281
self._module = module
4283
self._this_name = this_name
4284
self._dep_version = dep_version
4285
self._feature = None
4288
if self._feature is None:
4289
msg = (self._dep_version % self._this_name) + (
4290
' Use %s.%s instead.' % (self._module, self._name))
4291
symbol_versioning.warn(msg, DeprecationWarning)
4292
mod = __import__(self._module, {}, {}, [self._name])
4293
self._feature = getattr(mod, self._name)
4297
return self._feature._probe()
4300
class ModuleAvailableFeature(Feature):
4301
"""This is a feature than describes a module we want to be available.
4303
Declare the name of the module in __init__(), and then after probing, the
4304
module will be available as 'self.module'.
4306
:ivar module: The module if it is available, else None.
4309
def __init__(self, module_name):
4310
super(ModuleAvailableFeature, self).__init__()
4311
self.module_name = module_name
4315
self._module = __import__(self.module_name, {}, {}, [''])
4322
if self.available(): # Make sure the probe has been done
4326
def feature_name(self):
4327
return self.module_name
4330
# This is kept here for compatibility, it is recommended to use
4331
# 'bzrlib.tests.feature.paramiko' instead
4332
ParamikoFeature = _CompatabilityThunkFeature('bzrlib.tests.features',
4333
'paramiko', 'bzrlib.tests.ParamikoFeature', deprecated_in((2,1,0)))
4336
def probe_unicode_in_user_encoding():
4337
"""Try to encode several unicode strings to use in unicode-aware tests.
4338
Return first successfull match.
4340
:return: (unicode value, encoded plain string value) or (None, None)
4342
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4343
for uni_val in possible_vals:
4345
str_val = uni_val.encode(osutils.get_user_encoding())
4346
except UnicodeEncodeError:
4347
# Try a different character
4350
return uni_val, str_val
4354
def probe_bad_non_ascii(encoding):
4355
"""Try to find [bad] character with code [128..255]
4356
that cannot be decoded to unicode in some encoding.
4357
Return None if all non-ascii characters is valid
4360
for i in xrange(128, 256):
4363
char.decode(encoding)
4364
except UnicodeDecodeError:
4369
class _HTTPSServerFeature(Feature):
4370
"""Some tests want an https Server, check if one is available.
4372
Right now, the only way this is available is under python2.6 which provides
4383
def feature_name(self):
4384
return 'HTTPSServer'
4387
HTTPSServerFeature = _HTTPSServerFeature()
4390
class _UnicodeFilename(Feature):
4391
"""Does the filesystem support Unicode filenames?"""
4396
except UnicodeEncodeError:
4398
except (IOError, OSError):
4399
# The filesystem allows the Unicode filename but the file doesn't
4403
# The filesystem allows the Unicode filename and the file exists,
4407
UnicodeFilename = _UnicodeFilename()
4410
class _UTF8Filesystem(Feature):
4411
"""Is the filesystem UTF-8?"""
4414
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4418
UTF8Filesystem = _UTF8Filesystem()
4421
class _BreakinFeature(Feature):
4422
"""Does this platform support the breakin feature?"""
4425
from bzrlib import breakin
4426
if breakin.determine_signal() is None:
4428
if sys.platform == 'win32':
4429
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4430
# We trigger SIGBREAK via a Console api so we need ctypes to
4431
# access the function
4438
def feature_name(self):
4439
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4442
BreakinFeature = _BreakinFeature()
4445
class _CaseInsCasePresFilenameFeature(Feature):
4446
"""Is the file-system case insensitive, but case-preserving?"""
4449
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4451
# first check truly case-preserving for created files, then check
4452
# case insensitive when opening existing files.
4453
name = osutils.normpath(name)
4454
base, rel = osutils.split(name)
4455
found_rel = osutils.canonical_relpath(base, name)
4456
return (found_rel == rel
4457
and os.path.isfile(name.upper())
4458
and os.path.isfile(name.lower()))
4463
def feature_name(self):
4464
return "case-insensitive case-preserving filesystem"
4466
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4469
class _CaseInsensitiveFilesystemFeature(Feature):
4470
"""Check if underlying filesystem is case-insensitive but *not* case
4473
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4474
# more likely to be case preserving, so this case is rare.
4477
if CaseInsCasePresFilenameFeature.available():
4480
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4481
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4482
TestCaseWithMemoryTransport.TEST_ROOT = root
4484
root = TestCaseWithMemoryTransport.TEST_ROOT
4485
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4487
name_a = osutils.pathjoin(tdir, 'a')
4488
name_A = osutils.pathjoin(tdir, 'A')
4490
result = osutils.isdir(name_A)
4491
_rmtree_temp_dir(tdir)
4494
def feature_name(self):
4495
return 'case-insensitive filesystem'
4497
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4500
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4501
SubUnitFeature = _CompatabilityThunkFeature('bzrlib.tests.features', 'subunit',
4502
'bzrlib.tests.SubUnitFeature', deprecated_in((2,1,0)))
4503
# Only define SubUnitBzrRunner if subunit is available.
4505
from subunit import TestProtocolClient
4506
class SubUnitBzrRunner(TextTestRunner):
4507
def run(self, test):
4508
result = BzrAutoTimingTestResultDecorator(
4509
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
