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 (
95
from bzrlib.transport import get_transport, pathfilter
96
import bzrlib.transport
97
from bzrlib.transport.local import LocalURLServer
98
from bzrlib.transport.memory import MemoryServer
99
from bzrlib.transport.readonly import ReadonlyServer
100
from bzrlib.trace import mutter, note
101
from bzrlib.tests import TestUtil
102
from bzrlib.tests.http_server import HttpServer
103
from bzrlib.tests.TestUtil import (
107
from bzrlib.tests.treeshape import build_tree_contents
108
from bzrlib.ui import NullProgressView
109
from bzrlib.ui.text import TextUIFactory
110
import bzrlib.version_info_formats.format_custom
111
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
113
# Mark this python module as being part of the implementation
114
# of unittest: this gives us better tracebacks where the last
115
# shown frame is the test code, not our assertXYZ.
118
default_transport = LocalURLServer
120
# Subunit result codes, defined here to prevent a hard dependency on subunit.
125
class ExtendedTestResult(unittest._TextTestResult):
126
"""Accepts, reports and accumulates the results of running tests.
128
Compared to the unittest version this class adds support for
129
profiling, benchmarking, stopping as soon as a test fails, and
130
skipping tests. There are further-specialized subclasses for
131
different types of display.
133
When a test finishes, in whatever way, it calls one of the addSuccess,
134
addFailure or addError classes. These in turn may redirect to a more
135
specific case for the special test results supported by our extended
138
Note that just one of these objects is fed the results from many tests.
143
def __init__(self, stream, descriptions, verbosity,
147
"""Construct new TestResult.
149
:param bench_history: Optionally, a writable file object to accumulate
152
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
153
if bench_history is not None:
154
from bzrlib.version import _get_bzr_source_tree
155
src_tree = _get_bzr_source_tree()
158
revision_id = src_tree.get_parent_ids()[0]
160
# XXX: if this is a brand new tree, do the same as if there
164
# XXX: If there's no branch, what should we do?
166
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
167
self._bench_history = bench_history
168
self.ui = ui.ui_factory
171
self.failure_count = 0
172
self.known_failure_count = 0
174
self.not_applicable_count = 0
175
self.unsupported = {}
177
self._overall_start_time = time.time()
178
self._strict = strict
180
def stopTestRun(self):
183
stopTime = time.time()
184
timeTaken = stopTime - self.startTime
186
self.stream.writeln(self.separator2)
187
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
188
run, run != 1 and "s" or "", timeTaken))
189
self.stream.writeln()
190
if not self.wasSuccessful():
191
self.stream.write("FAILED (")
192
failed, errored = map(len, (self.failures, self.errors))
194
self.stream.write("failures=%d" % failed)
196
if failed: self.stream.write(", ")
197
self.stream.write("errors=%d" % errored)
198
if self.known_failure_count:
199
if failed or errored: self.stream.write(", ")
200
self.stream.write("known_failure_count=%d" %
201
self.known_failure_count)
202
self.stream.writeln(")")
204
if self.known_failure_count:
205
self.stream.writeln("OK (known_failures=%d)" %
206
self.known_failure_count)
208
self.stream.writeln("OK")
209
if self.skip_count > 0:
210
skipped = self.skip_count
211
self.stream.writeln('%d test%s skipped' %
212
(skipped, skipped != 1 and "s" or ""))
214
for feature, count in sorted(self.unsupported.items()):
215
self.stream.writeln("Missing feature '%s' skipped %d tests." %
218
ok = self.wasStrictlySuccessful()
220
ok = self.wasSuccessful()
221
if TestCase._first_thread_leaker_id:
223
'%s is leaking threads among %d leaking tests.\n' % (
224
TestCase._first_thread_leaker_id,
225
TestCase._leaking_threads_tests))
226
# We don't report the main thread as an active one.
228
'%d non-main threads were left active in the end.\n'
229
% (TestCase._active_threads - 1))
231
def _extractBenchmarkTime(self, testCase):
232
"""Add a benchmark time for the current test case."""
233
return getattr(testCase, "_benchtime", None)
235
def _elapsedTestTimeString(self):
236
"""Return a time string for the overall time the current test has taken."""
237
return self._formatTime(time.time() - self._start_time)
239
def _testTimeString(self, testCase):
240
benchmark_time = self._extractBenchmarkTime(testCase)
241
if benchmark_time is not None:
242
return self._formatTime(benchmark_time) + "*"
244
return self._elapsedTestTimeString()
246
def _formatTime(self, seconds):
247
"""Format seconds as milliseconds with leading spaces."""
248
# some benchmarks can take thousands of seconds to run, so we need 8
250
return "%8dms" % (1000 * seconds)
252
def _shortened_test_description(self, test):
254
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
257
def startTest(self, test):
258
unittest.TestResult.startTest(self, test)
261
self.report_test_start(test)
262
test.number = self.count
263
self._recordTestStartTime()
265
def startTests(self):
267
if getattr(sys, 'frozen', None) is None:
268
bzr_path = osutils.realpath(sys.argv[0])
270
bzr_path = sys.executable
272
'testing: %s\n' % (bzr_path,))
275
bzrlib.__path__[0],))
277
' bzr-%s python-%s %s\n' % (
278
bzrlib.version_string,
279
bzrlib._format_version_tuple(sys.version_info),
280
platform.platform(aliased=1),
282
self.stream.write('\n')
284
def _recordTestStartTime(self):
285
"""Record that a test has started."""
286
self._start_time = time.time()
288
def _cleanupLogFile(self, test):
289
# We can only do this if we have one of our TestCases, not if
291
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
292
if setKeepLogfile is not None:
295
def addError(self, test, err):
296
"""Tell result that test finished with an error.
298
Called from the TestCase run() method when the test
299
fails with an unexpected error.
302
unittest.TestResult.addError(self, test, err)
303
self.error_count += 1
304
self.report_error(test, err)
307
self._cleanupLogFile(test)
309
def addFailure(self, test, err):
310
"""Tell result that test failed.
312
Called from the TestCase run() method when the test
313
fails because e.g. an assert() method failed.
316
unittest.TestResult.addFailure(self, test, err)
317
self.failure_count += 1
318
self.report_failure(test, err)
321
self._cleanupLogFile(test)
323
def addSuccess(self, test):
324
"""Tell result that test completed successfully.
326
Called from the TestCase run()
328
if self._bench_history is not None:
329
benchmark_time = self._extractBenchmarkTime(test)
330
if benchmark_time is not None:
331
self._bench_history.write("%s %s\n" % (
332
self._formatTime(benchmark_time),
334
self.report_success(test)
335
self._cleanupLogFile(test)
336
unittest.TestResult.addSuccess(self, test)
337
test._log_contents = ''
339
def addExpectedFailure(self, test, err):
340
self.known_failure_count += 1
341
self.report_known_failure(test, err)
343
def addNotSupported(self, test, feature):
344
"""The test will not be run because of a missing feature.
346
# this can be called in two different ways: it may be that the
347
# test started running, and then raised (through requireFeature)
348
# UnavailableFeature. Alternatively this method can be called
349
# while probing for features before running the test code proper; in
350
# that case we will see startTest and stopTest, but the test will
351
# never actually run.
352
self.unsupported.setdefault(str(feature), 0)
353
self.unsupported[str(feature)] += 1
354
self.report_unsupported(test, feature)
356
def addSkip(self, test, reason):
357
"""A test has not run for 'reason'."""
359
self.report_skip(test, reason)
361
def addNotApplicable(self, test, reason):
362
self.not_applicable_count += 1
363
self.report_not_applicable(test, reason)
365
def printErrorList(self, flavour, errors):
366
for test, err in errors:
367
self.stream.writeln(self.separator1)
368
self.stream.write("%s: " % flavour)
369
self.stream.writeln(self.getDescription(test))
370
if getattr(test, '_get_log', None) is not None:
371
log_contents = test._get_log()
373
self.stream.write('\n')
375
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
376
self.stream.write('\n')
377
self.stream.write(log_contents)
378
self.stream.write('\n')
380
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
381
self.stream.write('\n')
382
self.stream.writeln(self.separator2)
383
self.stream.writeln("%s" % err)
385
def _post_mortem(self):
386
"""Start a PDB post mortem session."""
387
if os.environ.get('BZR_TEST_PDB', None):
388
import pdb;pdb.post_mortem()
390
def progress(self, offset, whence):
391
"""The test is adjusting the count of tests to run."""
392
if whence == SUBUNIT_SEEK_SET:
393
self.num_tests = offset
394
elif whence == SUBUNIT_SEEK_CUR:
395
self.num_tests += offset
397
raise errors.BzrError("Unknown whence %r" % whence)
399
def report_cleaning_up(self):
402
def startTestRun(self):
403
self.startTime = time.time()
405
def report_success(self, test):
408
def wasStrictlySuccessful(self):
409
if self.unsupported or self.known_failure_count:
411
return self.wasSuccessful()
414
class TextTestResult(ExtendedTestResult):
415
"""Displays progress and results of tests in text form"""
417
def __init__(self, stream, descriptions, verbosity,
422
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
423
bench_history, strict)
424
# We no longer pass them around, but just rely on the UIFactory stack
427
warnings.warn("Passing pb to TextTestResult is deprecated")
428
self.pb = self.ui.nested_progress_bar()
429
self.pb.show_pct = False
430
self.pb.show_spinner = False
431
self.pb.show_eta = False,
432
self.pb.show_count = False
433
self.pb.show_bar = False
434
self.pb.update_latency = 0
435
self.pb.show_transport_activity = False
437
def stopTestRun(self):
438
# called when the tests that are going to run have run
441
super(TextTestResult, self).stopTestRun()
443
def startTestRun(self):
444
super(TextTestResult, self).startTestRun()
445
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
447
def printErrors(self):
448
# clear the pb to make room for the error listing
450
super(TextTestResult, self).printErrors()
452
def _progress_prefix_text(self):
453
# the longer this text, the less space we have to show the test
455
a = '[%d' % self.count # total that have been run
456
# tests skipped as known not to be relevant are not important enough
458
## if self.skip_count:
459
## a += ', %d skip' % self.skip_count
460
## if self.known_failure_count:
461
## a += '+%dX' % self.known_failure_count
463
a +='/%d' % self.num_tests
465
runtime = time.time() - self._overall_start_time
467
a += '%dm%ds' % (runtime / 60, runtime % 60)
471
a += ', %d err' % self.error_count
472
if self.failure_count:
473
a += ', %d fail' % self.failure_count
474
# if self.unsupported:
475
# a += ', %d missing' % len(self.unsupported)
479
def report_test_start(self, test):
482
self._progress_prefix_text()
484
+ self._shortened_test_description(test))
486
def _test_description(self, test):
487
return self._shortened_test_description(test)
489
def report_error(self, test, err):
490
ui.ui_factory.note('ERROR: %s\n %s\n' % (
491
self._test_description(test),
495
def report_failure(self, test, err):
496
ui.ui_factory.note('FAIL: %s\n %s\n' % (
497
self._test_description(test),
501
def report_known_failure(self, test, err):
502
ui.ui_factory.note('XFAIL: %s\n%s\n' % (
503
self._test_description(test), err[1]))
505
def report_skip(self, test, reason):
508
def report_not_applicable(self, test, reason):
511
def report_unsupported(self, test, feature):
512
"""test cannot be run because feature is missing."""
514
def report_cleaning_up(self):
515
self.pb.update('Cleaning up')
518
class VerboseTestResult(ExtendedTestResult):
519
"""Produce long output, with one line per test run plus times"""
521
def _ellipsize_to_right(self, a_string, final_width):
522
"""Truncate and pad a string, keeping the right hand side"""
523
if len(a_string) > final_width:
524
result = '...' + a_string[3-final_width:]
527
return result.ljust(final_width)
529
def startTestRun(self):
530
super(VerboseTestResult, self).startTestRun()
531
self.stream.write('running %d tests...\n' % self.num_tests)
533
def report_test_start(self, test):
535
name = self._shortened_test_description(test)
536
# width needs space for 6 char status, plus 1 for slash, plus an
537
# 11-char time string, plus a trailing blank
538
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
539
self.stream.write(self._ellipsize_to_right(name,
540
osutils.terminal_width()-18))
543
def _error_summary(self, err):
545
return '%s%s' % (indent, err[1])
547
def report_error(self, test, err):
548
self.stream.writeln('ERROR %s\n%s'
549
% (self._testTimeString(test),
550
self._error_summary(err)))
552
def report_failure(self, test, err):
553
self.stream.writeln(' FAIL %s\n%s'
554
% (self._testTimeString(test),
555
self._error_summary(err)))
557
def report_known_failure(self, test, err):
558
self.stream.writeln('XFAIL %s\n%s'
559
% (self._testTimeString(test),
560
self._error_summary(err)))
562
def report_success(self, test):
563
self.stream.writeln(' OK %s' % self._testTimeString(test))
564
for bench_called, stats in getattr(test, '_benchcalls', []):
565
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
566
stats.pprint(file=self.stream)
567
# flush the stream so that we get smooth output. This verbose mode is
568
# used to show the output in PQM.
571
def report_skip(self, test, reason):
572
self.stream.writeln(' SKIP %s\n%s'
573
% (self._testTimeString(test), reason))
575
def report_not_applicable(self, test, reason):
576
self.stream.writeln(' N/A %s\n %s'
577
% (self._testTimeString(test), reason))
579
def report_unsupported(self, test, feature):
580
"""test cannot be run because feature is missing."""
581
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
582
%(self._testTimeString(test), feature))
585
class TextTestRunner(object):
586
stop_on_failure = False
594
result_decorators=None,
596
"""Create a TextTestRunner.
598
:param result_decorators: An optional list of decorators to apply
599
to the result object being used by the runner. Decorators are
600
applied left to right - the first element in the list is the
603
self.stream = unittest._WritelnDecorator(stream)
604
self.descriptions = descriptions
605
self.verbosity = verbosity
606
self._bench_history = bench_history
607
self._strict = strict
608
self._result_decorators = result_decorators or []
611
"Run the given test case or test suite."
612
if self.verbosity == 1:
613
result_class = TextTestResult
614
elif self.verbosity >= 2:
615
result_class = VerboseTestResult
616
original_result = result_class(self.stream,
619
bench_history=self._bench_history,
622
# Signal to result objects that look at stop early policy to stop,
623
original_result.stop_early = self.stop_on_failure
624
result = original_result
625
for decorator in self._result_decorators:
626
result = decorator(result)
627
result.stop_early = self.stop_on_failure
633
if isinstance(test, testtools.ConcurrentTestSuite):
634
# We need to catch bzr specific behaviors
635
result = BZRTransformingResult(result)
636
result.startTestRun()
641
# higher level code uses our extended protocol to determine
642
# what exit code to give.
643
return original_result
646
def iter_suite_tests(suite):
647
"""Return all tests in a suite, recursing through nested suites"""
648
if isinstance(suite, unittest.TestCase):
650
elif isinstance(suite, unittest.TestSuite):
652
for r in iter_suite_tests(item):
655
raise Exception('unknown type %r for object %r'
656
% (type(suite), suite))
659
class TestSkipped(Exception):
660
"""Indicates that a test was intentionally skipped, rather than failing."""
663
class TestNotApplicable(TestSkipped):
664
"""A test is not applicable to the situation where it was run.
666
This is only normally raised by parameterized tests, if they find that
667
the instance they're constructed upon does not support one aspect
672
class KnownFailure(AssertionError):
673
"""Indicates that a test failed in a precisely expected manner.
675
Such failures dont block the whole test suite from passing because they are
676
indicators of partially completed code or of future work. We have an
677
explicit error for them so that we can ensure that they are always visible:
678
KnownFailures are always shown in the output of bzr selftest.
682
class UnavailableFeature(Exception):
683
"""A feature required for this test was not available.
685
This can be considered a specialised form of SkippedTest.
687
The feature should be used to construct the exception.
691
class CommandFailed(Exception):
695
class StringIOWrapper(object):
696
"""A wrapper around cStringIO which just adds an encoding attribute.
698
Internally we can check sys.stdout to see what the output encoding
699
should be. However, cStringIO has no encoding attribute that we can
700
set. So we wrap it instead.
705
def __init__(self, s=None):
707
self.__dict__['_cstring'] = StringIO(s)
709
self.__dict__['_cstring'] = StringIO()
711
def __getattr__(self, name, getattr=getattr):
712
return getattr(self.__dict__['_cstring'], name)
714
def __setattr__(self, name, val):
715
if name == 'encoding':
716
self.__dict__['encoding'] = val
718
return setattr(self._cstring, name, val)
721
class TestUIFactory(TextUIFactory):
722
"""A UI Factory for testing.
724
Hide the progress bar but emit note()s.
726
Allows get_password to be tested without real tty attached.
728
See also CannedInputUIFactory which lets you provide programmatic input in
731
# TODO: Capture progress events at the model level and allow them to be
732
# observed by tests that care.
734
# XXX: Should probably unify more with CannedInputUIFactory or a
735
# particular configuration of TextUIFactory, or otherwise have a clearer
736
# idea of how they're supposed to be different.
737
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
739
def __init__(self, stdout=None, stderr=None, stdin=None):
740
if stdin is not None:
741
# We use a StringIOWrapper to be able to test various
742
# encodings, but the user is still responsible to
743
# encode the string and to set the encoding attribute
744
# of StringIOWrapper.
745
stdin = StringIOWrapper(stdin)
746
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
748
def get_non_echoed_password(self):
749
"""Get password from stdin without trying to handle the echo mode"""
750
password = self.stdin.readline()
753
if password[-1] == '\n':
754
password = password[:-1]
757
def make_progress_view(self):
758
return NullProgressView()
761
class TestCase(unittest.TestCase):
762
"""Base class for bzr unit tests.
764
Tests that need access to disk resources should subclass
765
TestCaseInTempDir not TestCase.
767
Error and debug log messages are redirected from their usual
768
location into a temporary file, the contents of which can be
769
retrieved by _get_log(). We use a real OS file, not an in-memory object,
770
so that it can also capture file IO. When the test completes this file
771
is read into memory and removed from disk.
773
There are also convenience functions to invoke bzr's command-line
774
routine, and to build and check bzr trees.
776
In addition to the usual method of overriding tearDown(), this class also
777
allows subclasses to register functions into the _cleanups list, which is
778
run in order as the object is torn down. It's less likely this will be
779
accidentally overlooked.
782
_active_threads = None
783
_leaking_threads_tests = 0
784
_first_thread_leaker_id = None
785
_log_file_name = None
787
_keep_log_file = False
788
# record lsprof data when performing benchmark calls.
789
_gather_lsprof_in_benchmarks = False
790
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
791
'_log_contents', '_log_file_name', '_benchtime',
792
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
794
def __init__(self, methodName='testMethod'):
795
super(TestCase, self).__init__(methodName)
797
self._bzr_test_setUp_run = False
798
self._bzr_test_tearDown_run = False
799
self._directory_isolation = True
802
unittest.TestCase.setUp(self)
803
self._bzr_test_setUp_run = True
804
self._cleanEnvironment()
807
self._benchcalls = []
808
self._benchtime = None
810
self._track_transports()
812
self._clear_debug_flags()
813
TestCase._active_threads = threading.activeCount()
814
self.addCleanup(self._check_leaked_threads)
819
pdb.Pdb().set_trace(sys._getframe().f_back)
821
def _check_leaked_threads(self):
822
active = threading.activeCount()
823
leaked_threads = active - TestCase._active_threads
824
TestCase._active_threads = active
825
# If some tests make the number of threads *decrease*, we'll consider
826
# that they are just observing old threads dieing, not agressively kill
827
# random threads. So we don't report these tests as leaking. The risk
828
# is that we have false positives that way (the test see 2 threads
829
# going away but leak one) but it seems less likely than the actual
830
# false positives (the test see threads going away and does not leak).
831
if leaked_threads > 0:
832
TestCase._leaking_threads_tests += 1
833
if TestCase._first_thread_leaker_id is None:
834
TestCase._first_thread_leaker_id = self.id()
836
def _clear_debug_flags(self):
837
"""Prevent externally set debug flags affecting tests.
839
Tests that want to use debug flags can just set them in the
840
debug_flags set during setup/teardown.
842
self._preserved_debug_flags = set(debug.debug_flags)
843
if 'allow_debug' not in selftest_debug_flags:
844
debug.debug_flags.clear()
845
if 'disable_lock_checks' not in selftest_debug_flags:
846
debug.debug_flags.add('strict_locks')
847
self.addCleanup(self._restore_debug_flags)
849
def _clear_hooks(self):
850
# prevent hooks affecting tests
851
self._preserved_hooks = {}
852
for key, factory in hooks.known_hooks.items():
853
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
854
current_hooks = hooks.known_hooks_key_to_object(key)
855
self._preserved_hooks[parent] = (name, current_hooks)
856
self.addCleanup(self._restoreHooks)
857
for key, factory in hooks.known_hooks.items():
858
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
859
setattr(parent, name, factory())
860
# this hook should always be installed
861
request._install_hook()
863
def disable_directory_isolation(self):
864
"""Turn off directory isolation checks."""
865
self._directory_isolation = False
867
def enable_directory_isolation(self):
868
"""Enable directory isolation checks."""
869
self._directory_isolation = True
871
def _silenceUI(self):
872
"""Turn off UI for duration of test"""
873
# by default the UI is off; tests can turn it on if they want it.
874
saved = ui.ui_factory
876
ui.ui_factory = saved
877
ui.ui_factory = ui.SilentUIFactory()
878
self.addCleanup(_restore)
880
def _check_locks(self):
881
"""Check that all lock take/release actions have been paired."""
882
# We always check for mismatched locks. If a mismatch is found, we
883
# fail unless -Edisable_lock_checks is supplied to selftest, in which
884
# case we just print a warning.
886
acquired_locks = [lock for action, lock in self._lock_actions
887
if action == 'acquired']
888
released_locks = [lock for action, lock in self._lock_actions
889
if action == 'released']
890
broken_locks = [lock for action, lock in self._lock_actions
891
if action == 'broken']
892
# trivially, given the tests for lock acquistion and release, if we
893
# have as many in each list, it should be ok. Some lock tests also
894
# break some locks on purpose and should be taken into account by
895
# considering that breaking a lock is just a dirty way of releasing it.
896
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
897
message = ('Different number of acquired and '
898
'released or broken locks. (%s, %s + %s)' %
899
(acquired_locks, released_locks, broken_locks))
900
if not self._lock_check_thorough:
901
# Rather than fail, just warn
902
print "Broken test %s: %s" % (self, message)
906
def _track_locks(self):
907
"""Track lock activity during tests."""
908
self._lock_actions = []
909
if 'disable_lock_checks' in selftest_debug_flags:
910
self._lock_check_thorough = False
912
self._lock_check_thorough = True
914
self.addCleanup(self._check_locks)
915
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
916
self._lock_acquired, None)
917
_mod_lock.Lock.hooks.install_named_hook('lock_released',
918
self._lock_released, None)
919
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
920
self._lock_broken, None)
922
def _lock_acquired(self, result):
923
self._lock_actions.append(('acquired', result))
925
def _lock_released(self, result):
926
self._lock_actions.append(('released', result))
928
def _lock_broken(self, result):
929
self._lock_actions.append(('broken', result))
931
def permit_dir(self, name):
932
"""Permit a directory to be used by this test. See permit_url."""
933
name_transport = get_transport(name)
934
self.permit_url(name)
935
self.permit_url(name_transport.base)
937
def permit_url(self, url):
938
"""Declare that url is an ok url to use in this test.
940
Do this for memory transports, temporary test directory etc.
942
Do not do this for the current working directory, /tmp, or any other
943
preexisting non isolated url.
945
if not url.endswith('/'):
947
self._bzr_selftest_roots.append(url)
949
def permit_source_tree_branch_repo(self):
950
"""Permit the source tree bzr is running from to be opened.
952
Some code such as bzrlib.version attempts to read from the bzr branch
953
that bzr is executing from (if any). This method permits that directory
954
to be used in the test suite.
956
path = self.get_source_path()
957
self.record_directory_isolation()
960
workingtree.WorkingTree.open(path)
961
except (errors.NotBranchError, errors.NoWorkingTree):
964
self.enable_directory_isolation()
966
def _preopen_isolate_transport(self, transport):
967
"""Check that all transport openings are done in the test work area."""
968
while isinstance(transport, pathfilter.PathFilteringTransport):
969
# Unwrap pathfiltered transports
970
transport = transport.server.backing_transport.clone(
971
transport._filter('.'))
973
# ReadonlySmartTCPServer_for_testing decorates the backing transport
974
# urls it is given by prepending readonly+. This is appropriate as the
975
# client shouldn't know that the server is readonly (or not readonly).
976
# We could register all servers twice, with readonly+ prepending, but
977
# that makes for a long list; this is about the same but easier to
979
if url.startswith('readonly+'):
980
url = url[len('readonly+'):]
981
self._preopen_isolate_url(url)
983
def _preopen_isolate_url(self, url):
984
if not self._directory_isolation:
986
if self._directory_isolation == 'record':
987
self._bzr_selftest_roots.append(url)
989
# This prevents all transports, including e.g. sftp ones backed on disk
990
# from working unless they are explicitly granted permission. We then
991
# depend on the code that sets up test transports to check that they are
992
# appropriately isolated and enable their use by calling
993
# self.permit_transport()
994
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
995
raise errors.BzrError("Attempt to escape test isolation: %r %r"
996
% (url, self._bzr_selftest_roots))
998
def record_directory_isolation(self):
999
"""Gather accessed directories to permit later access.
1001
This is used for tests that access the branch bzr is running from.
1003
self._directory_isolation = "record"
1005
def start_server(self, transport_server, backing_server=None):
1006
"""Start transport_server for this test.
1008
This starts the server, registers a cleanup for it and permits the
1009
server's urls to be used.
1011
if backing_server is None:
1012
transport_server.setUp()
1014
transport_server.setUp(backing_server)
1015
self.addCleanup(transport_server.tearDown)
1016
# Obtain a real transport because if the server supplies a password, it
1017
# will be hidden from the base on the client side.
1018
t = get_transport(transport_server.get_url())
1019
# Some transport servers effectively chroot the backing transport;
1020
# others like SFTPServer don't - users of the transport can walk up the
1021
# transport to read the entire backing transport. This wouldn't matter
1022
# except that the workdir tests are given - and that they expect the
1023
# server's url to point at - is one directory under the safety net. So
1024
# Branch operations into the transport will attempt to walk up one
1025
# directory. Chrooting all servers would avoid this but also mean that
1026
# we wouldn't be testing directly against non-root urls. Alternatively
1027
# getting the test framework to start the server with a backing server
1028
# at the actual safety net directory would work too, but this then
1029
# means that the self.get_url/self.get_transport methods would need
1030
# to transform all their results. On balance its cleaner to handle it
1031
# here, and permit a higher url when we have one of these transports.
1032
if t.base.endswith('/work/'):
1033
# we have safety net/test root/work
1034
t = t.clone('../..')
1035
elif isinstance(transport_server, server.SmartTCPServer_for_testing):
1036
# The smart server adds a path similar to work, which is traversed
1037
# up from by the client. But the server is chrooted - the actual
1038
# backing transport is not escaped from, and VFS requests to the
1039
# root will error (because they try to escape the chroot).
1041
while t2.base != t.base:
1044
self.permit_url(t.base)
1046
def _track_transports(self):
1047
"""Install checks for transport usage."""
1048
# TestCase has no safe place it can write to.
1049
self._bzr_selftest_roots = []
1050
# Currently the easiest way to be sure that nothing is going on is to
1051
# hook into bzr dir opening. This leaves a small window of error for
1052
# transport tests, but they are well known, and we can improve on this
1054
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1055
self._preopen_isolate_transport, "Check bzr directories are safe.")
1057
def _ndiff_strings(self, a, b):
1058
"""Return ndiff between two strings containing lines.
1060
A trailing newline is added if missing to make the strings
1062
if b and b[-1] != '\n':
1064
if a and a[-1] != '\n':
1066
difflines = difflib.ndiff(a.splitlines(True),
1068
linejunk=lambda x: False,
1069
charjunk=lambda x: False)
1070
return ''.join(difflines)
1072
def assertEqual(self, a, b, message=''):
1076
except UnicodeError, e:
1077
# If we can't compare without getting a UnicodeError, then
1078
# obviously they are different
1079
mutter('UnicodeError: %s', e)
1082
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1084
pformat(a), pformat(b)))
1086
assertEquals = assertEqual
1088
def assertEqualDiff(self, a, b, message=None):
1089
"""Assert two texts are equal, if not raise an exception.
1091
This is intended for use with multi-line strings where it can
1092
be hard to find the differences by eye.
1094
# TODO: perhaps override assertEquals to call this for strings?
1098
message = "texts not equal:\n"
1100
message = 'first string is missing a final newline.\n'
1102
message = 'second string is missing a final newline.\n'
1103
raise AssertionError(message +
1104
self._ndiff_strings(a, b))
1106
def assertEqualMode(self, mode, mode_test):
1107
self.assertEqual(mode, mode_test,
1108
'mode mismatch %o != %o' % (mode, mode_test))
1110
def assertEqualStat(self, expected, actual):
1111
"""assert that expected and actual are the same stat result.
1113
:param expected: A stat result.
1114
:param actual: A stat result.
1115
:raises AssertionError: If the expected and actual stat values differ
1116
other than by atime.
1118
self.assertEqual(expected.st_size, actual.st_size)
1119
self.assertEqual(expected.st_mtime, actual.st_mtime)
1120
self.assertEqual(expected.st_ctime, actual.st_ctime)
1121
self.assertEqual(expected.st_dev, actual.st_dev)
1122
self.assertEqual(expected.st_ino, actual.st_ino)
1123
self.assertEqual(expected.st_mode, actual.st_mode)
1125
def assertLength(self, length, obj_with_len):
1126
"""Assert that obj_with_len is of length length."""
1127
if len(obj_with_len) != length:
1128
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1129
length, len(obj_with_len), obj_with_len))
1131
def assertLogsError(self, exception_class, func, *args, **kwargs):
1132
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1134
from bzrlib import trace
1136
orig_log_exception_quietly = trace.log_exception_quietly
1139
orig_log_exception_quietly()
1140
captured.append(sys.exc_info())
1141
trace.log_exception_quietly = capture
1142
func(*args, **kwargs)
1144
trace.log_exception_quietly = orig_log_exception_quietly
1145
self.assertLength(1, captured)
1146
err = captured[0][1]
1147
self.assertIsInstance(err, exception_class)
1150
def assertPositive(self, val):
1151
"""Assert that val is greater than 0."""
1152
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1154
def assertNegative(self, val):
1155
"""Assert that val is less than 0."""
1156
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1158
def assertStartsWith(self, s, prefix):
1159
if not s.startswith(prefix):
1160
raise AssertionError('string %r does not start with %r' % (s, prefix))
1162
def assertEndsWith(self, s, suffix):
1163
"""Asserts that s ends with suffix."""
1164
if not s.endswith(suffix):
1165
raise AssertionError('string %r does not end with %r' % (s, suffix))
1167
def assertContainsRe(self, haystack, needle_re, flags=0):
1168
"""Assert that a contains something matching a regular expression."""
1169
if not re.search(needle_re, haystack, flags):
1170
if '\n' in haystack or len(haystack) > 60:
1171
# a long string, format it in a more readable way
1172
raise AssertionError(
1173
'pattern "%s" not found in\n"""\\\n%s"""\n'
1174
% (needle_re, haystack))
1176
raise AssertionError('pattern "%s" not found in "%s"'
1177
% (needle_re, haystack))
1179
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1180
"""Assert that a does not match a regular expression"""
1181
if re.search(needle_re, haystack, flags):
1182
raise AssertionError('pattern "%s" found in "%s"'
1183
% (needle_re, haystack))
1185
def assertSubset(self, sublist, superlist):
1186
"""Assert that every entry in sublist is present in superlist."""
1187
missing = set(sublist) - set(superlist)
1188
if len(missing) > 0:
1189
raise AssertionError("value(s) %r not present in container %r" %
1190
(missing, superlist))
1192
def assertListRaises(self, excClass, func, *args, **kwargs):
1193
"""Fail unless excClass is raised when the iterator from func is used.
1195
Many functions can return generators this makes sure
1196
to wrap them in a list() call to make sure the whole generator
1197
is run, and that the proper exception is raised.
1200
list(func(*args, **kwargs))
1204
if getattr(excClass,'__name__', None) is not None:
1205
excName = excClass.__name__
1207
excName = str(excClass)
1208
raise self.failureException, "%s not raised" % excName
1210
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1211
"""Assert that a callable raises a particular exception.
1213
:param excClass: As for the except statement, this may be either an
1214
exception class, or a tuple of classes.
1215
:param callableObj: A callable, will be passed ``*args`` and
1218
Returns the exception so that you can examine it.
1221
callableObj(*args, **kwargs)
1225
if getattr(excClass,'__name__', None) is not None:
1226
excName = excClass.__name__
1229
excName = str(excClass)
1230
raise self.failureException, "%s not raised" % excName
1232
def assertIs(self, left, right, message=None):
1233
if not (left is right):
1234
if message is not None:
1235
raise AssertionError(message)
1237
raise AssertionError("%r is not %r." % (left, right))
1239
def assertIsNot(self, left, right, message=None):
1241
if message is not None:
1242
raise AssertionError(message)
1244
raise AssertionError("%r is %r." % (left, right))
1246
def assertTransportMode(self, transport, path, mode):
1247
"""Fail if a path does not have mode "mode".
1249
If modes are not supported on this transport, the assertion is ignored.
1251
if not transport._can_roundtrip_unix_modebits():
1253
path_stat = transport.stat(path)
1254
actual_mode = stat.S_IMODE(path_stat.st_mode)
1255
self.assertEqual(mode, actual_mode,
1256
'mode of %r incorrect (%s != %s)'
1257
% (path, oct(mode), oct(actual_mode)))
1259
def assertIsSameRealPath(self, path1, path2):
1260
"""Fail if path1 and path2 points to different files"""
1261
self.assertEqual(osutils.realpath(path1),
1262
osutils.realpath(path2),
1263
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1265
def assertIsInstance(self, obj, kls, msg=None):
1266
"""Fail if obj is not an instance of kls
1268
:param msg: Supplementary message to show if the assertion fails.
1270
if not isinstance(obj, kls):
1271
m = "%r is an instance of %s rather than %s" % (
1272
obj, obj.__class__, kls)
1277
def expectFailure(self, reason, assertion, *args, **kwargs):
1278
"""Invoke a test, expecting it to fail for the given reason.
1280
This is for assertions that ought to succeed, but currently fail.
1281
(The failure is *expected* but not *wanted*.) Please be very precise
1282
about the failure you're expecting. If a new bug is introduced,
1283
AssertionError should be raised, not KnownFailure.
1285
Frequently, expectFailure should be followed by an opposite assertion.
1288
Intended to be used with a callable that raises AssertionError as the
1289
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1291
Raises KnownFailure if the test fails. Raises AssertionError if the
1296
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1298
self.assertEqual(42, dynamic_val)
1300
This means that a dynamic_val of 54 will cause the test to raise
1301
a KnownFailure. Once math is fixed and the expectFailure is removed,
1302
only a dynamic_val of 42 will allow the test to pass. Anything other
1303
than 54 or 42 will cause an AssertionError.
1306
assertion(*args, **kwargs)
1307
except AssertionError:
1308
raise KnownFailure(reason)
1310
self.fail('Unexpected success. Should have failed: %s' % reason)
1312
def assertFileEqual(self, content, path):
1313
"""Fail if path does not contain 'content'."""
1314
self.failUnlessExists(path)
1315
f = file(path, 'rb')
1320
self.assertEqualDiff(content, s)
1322
def failUnlessExists(self, path):
1323
"""Fail unless path or paths, which may be abs or relative, exist."""
1324
if not isinstance(path, basestring):
1326
self.failUnlessExists(p)
1328
self.failUnless(osutils.lexists(path),path+" does not exist")
1330
def failIfExists(self, path):
1331
"""Fail if path or paths, which may be abs or relative, exist."""
1332
if not isinstance(path, basestring):
1334
self.failIfExists(p)
1336
self.failIf(osutils.lexists(path),path+" exists")
1338
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1339
"""A helper for callDeprecated and applyDeprecated.
1341
:param a_callable: A callable to call.
1342
:param args: The positional arguments for the callable
1343
:param kwargs: The keyword arguments for the callable
1344
:return: A tuple (warnings, result). result is the result of calling
1345
a_callable(``*args``, ``**kwargs``).
1348
def capture_warnings(msg, cls=None, stacklevel=None):
1349
# we've hooked into a deprecation specific callpath,
1350
# only deprecations should getting sent via it.
1351
self.assertEqual(cls, DeprecationWarning)
1352
local_warnings.append(msg)
1353
original_warning_method = symbol_versioning.warn
1354
symbol_versioning.set_warning_method(capture_warnings)
1356
result = a_callable(*args, **kwargs)
1358
symbol_versioning.set_warning_method(original_warning_method)
1359
return (local_warnings, result)
1361
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1362
"""Call a deprecated callable without warning the user.
1364
Note that this only captures warnings raised by symbol_versioning.warn,
1365
not other callers that go direct to the warning module.
1367
To test that a deprecated method raises an error, do something like
1370
self.assertRaises(errors.ReservedId,
1371
self.applyDeprecated,
1372
deprecated_in((1, 5, 0)),
1376
:param deprecation_format: The deprecation format that the callable
1377
should have been deprecated with. This is the same type as the
1378
parameter to deprecated_method/deprecated_function. If the
1379
callable is not deprecated with this format, an assertion error
1381
:param a_callable: A callable to call. This may be a bound method or
1382
a regular function. It will be called with ``*args`` and
1384
:param args: The positional arguments for the callable
1385
:param kwargs: The keyword arguments for the callable
1386
:return: The result of a_callable(``*args``, ``**kwargs``)
1388
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1390
expected_first_warning = symbol_versioning.deprecation_string(
1391
a_callable, deprecation_format)
1392
if len(call_warnings) == 0:
1393
self.fail("No deprecation warning generated by call to %s" %
1395
self.assertEqual(expected_first_warning, call_warnings[0])
1398
def callCatchWarnings(self, fn, *args, **kw):
1399
"""Call a callable that raises python warnings.
1401
The caller's responsible for examining the returned warnings.
1403
If the callable raises an exception, the exception is not
1404
caught and propagates up to the caller. In that case, the list
1405
of warnings is not available.
1407
:returns: ([warning_object, ...], fn_result)
1409
# XXX: This is not perfect, because it completely overrides the
1410
# warnings filters, and some code may depend on suppressing particular
1411
# warnings. It's the easiest way to insulate ourselves from -Werror,
1412
# though. -- Andrew, 20071062
1414
def _catcher(message, category, filename, lineno, file=None, line=None):
1415
# despite the name, 'message' is normally(?) a Warning subclass
1417
wlist.append(message)
1418
saved_showwarning = warnings.showwarning
1419
saved_filters = warnings.filters
1421
warnings.showwarning = _catcher
1422
warnings.filters = []
1423
result = fn(*args, **kw)
1425
warnings.showwarning = saved_showwarning
1426
warnings.filters = saved_filters
1427
return wlist, result
1429
def callDeprecated(self, expected, callable, *args, **kwargs):
1430
"""Assert that a callable is deprecated in a particular way.
1432
This is a very precise test for unusual requirements. The
1433
applyDeprecated helper function is probably more suited for most tests
1434
as it allows you to simply specify the deprecation format being used
1435
and will ensure that that is issued for the function being called.
1437
Note that this only captures warnings raised by symbol_versioning.warn,
1438
not other callers that go direct to the warning module. To catch
1439
general warnings, use callCatchWarnings.
1441
:param expected: a list of the deprecation warnings expected, in order
1442
:param callable: The callable to call
1443
:param args: The positional arguments for the callable
1444
:param kwargs: The keyword arguments for the callable
1446
call_warnings, result = self._capture_deprecation_warnings(callable,
1448
self.assertEqual(expected, call_warnings)
1451
def _startLogFile(self):
1452
"""Send bzr and test log messages to a temporary file.
1454
The file is removed as the test is torn down.
1456
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1457
self._log_file = os.fdopen(fileno, 'w+')
1458
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1459
self._log_file_name = name
1460
self.addCleanup(self._finishLogFile)
1462
def _finishLogFile(self):
1463
"""Finished with the log file.
1465
Close the file and delete it, unless setKeepLogfile was called.
1467
if self._log_file is None:
1469
bzrlib.trace.pop_log_file(self._log_memento)
1470
self._log_file.close()
1471
self._log_file = None
1472
if not self._keep_log_file:
1473
os.remove(self._log_file_name)
1474
self._log_file_name = None
1476
def setKeepLogfile(self):
1477
"""Make the logfile not be deleted when _finishLogFile is called."""
1478
self._keep_log_file = True
1480
def thisFailsStrictLockCheck(self):
1481
"""It is known that this test would fail with -Dstrict_locks.
1483
By default, all tests are run with strict lock checking unless
1484
-Edisable_lock_checks is supplied. However there are some tests which
1485
we know fail strict locks at this point that have not been fixed.
1486
They should call this function to disable the strict checking.
1488
This should be used sparingly, it is much better to fix the locking
1489
issues rather than papering over the problem by calling this function.
1491
debug.debug_flags.discard('strict_locks')
1493
def addCleanup(self, callable, *args, **kwargs):
1494
"""Arrange to run a callable when this case is torn down.
1496
Callables are run in the reverse of the order they are registered,
1497
ie last-in first-out.
1499
self._cleanups.append((callable, args, kwargs))
1501
def _cleanEnvironment(self):
1503
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1504
'HOME': os.getcwd(),
1505
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1506
# tests do check our impls match APPDATA
1507
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1511
'BZREMAIL': None, # may still be present in the environment
1513
'BZR_PROGRESS_BAR': None,
1515
'BZR_PLUGIN_PATH': None,
1516
# Make sure that any text ui tests are consistent regardless of
1517
# the environment the test case is run in; you may want tests that
1518
# test other combinations. 'dumb' is a reasonable guess for tests
1519
# going to a pipe or a StringIO.
1524
'SSH_AUTH_SOCK': None,
1528
'https_proxy': None,
1529
'HTTPS_PROXY': None,
1534
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1535
# least. If you do (care), please update this comment
1539
'BZR_REMOTE_PATH': None,
1542
self.addCleanup(self._restoreEnvironment)
1543
for name, value in new_env.iteritems():
1544
self._captureVar(name, value)
1546
def _captureVar(self, name, newvalue):
1547
"""Set an environment variable, and reset it when finished."""
1548
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1550
def _restore_debug_flags(self):
1551
debug.debug_flags.clear()
1552
debug.debug_flags.update(self._preserved_debug_flags)
1554
def _restoreEnvironment(self):
1555
for name, value in self.__old_env.iteritems():
1556
osutils.set_or_unset_env(name, value)
1558
def _restoreHooks(self):
1559
for klass, (name, hooks) in self._preserved_hooks.items():
1560
setattr(klass, name, hooks)
1562
def knownFailure(self, reason):
1563
"""This test has failed for some known reason."""
1564
raise KnownFailure(reason)
1566
def _do_skip(self, result, reason):
1567
addSkip = getattr(result, 'addSkip', None)
1568
if not callable(addSkip):
1569
result.addSuccess(result)
1571
addSkip(self, reason)
1573
def _do_known_failure(self, result):
1574
err = sys.exc_info()
1575
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1576
if addExpectedFailure is not None:
1577
addExpectedFailure(self, err)
1579
result.addSuccess(self)
1581
def _do_not_applicable(self, result, e):
1583
reason = 'No reason given'
1586
addNotApplicable = getattr(result, 'addNotApplicable', None)
1587
if addNotApplicable is not None:
1588
result.addNotApplicable(self, reason)
1590
self._do_skip(result, reason)
1592
def _do_unsupported_or_skip(self, result, reason):
1593
addNotSupported = getattr(result, 'addNotSupported', None)
1594
if addNotSupported is not None:
1595
result.addNotSupported(self, reason)
1597
self._do_skip(result, reason)
1599
def run(self, result=None):
1600
if result is None: result = self.defaultTestResult()
1601
result.startTest(self)
1606
result.stopTest(self)
1608
def _run(self, result):
1609
for feature in getattr(self, '_test_needs_features', []):
1610
if not feature.available():
1611
return self._do_unsupported_or_skip(result, feature)
1613
absent_attr = object()
1615
method_name = getattr(self, '_testMethodName', absent_attr)
1616
if method_name is absent_attr:
1618
method_name = getattr(self, '_TestCase__testMethodName')
1619
testMethod = getattr(self, method_name)
1623
if not self._bzr_test_setUp_run:
1625
"test setUp did not invoke "
1626
"bzrlib.tests.TestCase's setUp")
1627
except KeyboardInterrupt:
1630
except KnownFailure:
1631
self._do_known_failure(result)
1634
except TestNotApplicable, e:
1635
self._do_not_applicable(result, e)
1638
except TestSkipped, e:
1639
self._do_skip(result, e.args[0])
1642
except UnavailableFeature, e:
1643
self._do_unsupported_or_skip(result, e.args[0])
1647
result.addError(self, sys.exc_info())
1655
except KnownFailure:
1656
self._do_known_failure(result)
1657
except self.failureException:
1658
result.addFailure(self, sys.exc_info())
1659
except TestNotApplicable, e:
1660
self._do_not_applicable(result, e)
1661
except TestSkipped, e:
1663
reason = "No reason given."
1666
self._do_skip(result, reason)
1667
except UnavailableFeature, e:
1668
self._do_unsupported_or_skip(result, e.args[0])
1669
except KeyboardInterrupt:
1673
result.addError(self, sys.exc_info())
1677
if not self._bzr_test_tearDown_run:
1679
"test tearDown did not invoke "
1680
"bzrlib.tests.TestCase's tearDown")
1681
except KeyboardInterrupt:
1685
result.addError(self, sys.exc_info())
1688
if ok: result.addSuccess(self)
1690
except KeyboardInterrupt:
1695
for attr_name in self.attrs_to_keep:
1696
if attr_name in self.__dict__:
1697
saved_attrs[attr_name] = self.__dict__[attr_name]
1698
self.__dict__ = saved_attrs
1702
self._log_contents = ''
1703
self._bzr_test_tearDown_run = True
1704
unittest.TestCase.tearDown(self)
1706
def time(self, callable, *args, **kwargs):
1707
"""Run callable and accrue the time it takes to the benchmark time.
1709
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1710
this will cause lsprofile statistics to be gathered and stored in
1713
if self._benchtime is None:
1717
if not self._gather_lsprof_in_benchmarks:
1718
return callable(*args, **kwargs)
1720
# record this benchmark
1721
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1723
self._benchcalls.append(((callable, args, kwargs), stats))
1726
self._benchtime += time.time() - start
1728
def _runCleanups(self):
1729
"""Run registered cleanup functions.
1731
This should only be called from TestCase.tearDown.
1733
# TODO: Perhaps this should keep running cleanups even if
1734
# one of them fails?
1736
# Actually pop the cleanups from the list so tearDown running
1737
# twice is safe (this happens for skipped tests).
1738
while self._cleanups:
1739
cleanup, args, kwargs = self._cleanups.pop()
1740
cleanup(*args, **kwargs)
1742
def log(self, *args):
1745
def _get_log(self, keep_log_file=False):
1746
"""Get the log from bzrlib.trace calls from this test.
1748
:param keep_log_file: When True, if the log is still a file on disk
1749
leave it as a file on disk. When False, if the log is still a file
1750
on disk, the log file is deleted and the log preserved as
1752
:return: A string containing the log.
1754
# flush the log file, to get all content
1756
if bzrlib.trace._trace_file:
1757
bzrlib.trace._trace_file.flush()
1758
if self._log_contents:
1759
# XXX: this can hardly contain the content flushed above --vila
1761
return self._log_contents
1762
if self._log_file_name is not None:
1763
logfile = open(self._log_file_name)
1765
log_contents = logfile.read()
1768
if not keep_log_file:
1769
self._log_contents = log_contents
1771
os.remove(self._log_file_name)
1773
if sys.platform == 'win32' and e.errno == errno.EACCES:
1774
sys.stderr.write(('Unable to delete log file '
1775
' %r\n' % self._log_file_name))
1780
return "DELETED log file to reduce memory footprint"
1782
def requireFeature(self, feature):
1783
"""This test requires a specific feature is available.
1785
:raises UnavailableFeature: When feature is not available.
1787
if not feature.available():
1788
raise UnavailableFeature(feature)
1790
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1792
"""Run bazaar command line, splitting up a string command line."""
1793
if isinstance(args, basestring):
1794
# shlex don't understand unicode strings,
1795
# so args should be plain string (bialix 20070906)
1796
args = list(shlex.split(str(args)))
1797
return self._run_bzr_core(args, retcode=retcode,
1798
encoding=encoding, stdin=stdin, working_dir=working_dir,
1801
def _run_bzr_core(self, args, retcode, encoding, stdin,
1803
# Clear chk_map page cache, because the contents are likely to mask
1805
chk_map.clear_cache()
1806
if encoding is None:
1807
encoding = osutils.get_user_encoding()
1808
stdout = StringIOWrapper()
1809
stderr = StringIOWrapper()
1810
stdout.encoding = encoding
1811
stderr.encoding = encoding
1813
self.log('run bzr: %r', args)
1814
# FIXME: don't call into logging here
1815
handler = logging.StreamHandler(stderr)
1816
handler.setLevel(logging.INFO)
1817
logger = logging.getLogger('')
1818
logger.addHandler(handler)
1819
old_ui_factory = ui.ui_factory
1820
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1823
if working_dir is not None:
1824
cwd = osutils.getcwd()
1825
os.chdir(working_dir)
1828
result = self.apply_redirected(ui.ui_factory.stdin,
1830
bzrlib.commands.run_bzr_catch_user_errors,
1833
logger.removeHandler(handler)
1834
ui.ui_factory = old_ui_factory
1838
out = stdout.getvalue()
1839
err = stderr.getvalue()
1841
self.log('output:\n%r', out)
1843
self.log('errors:\n%r', err)
1844
if retcode is not None:
1845
self.assertEquals(retcode, result,
1846
message='Unexpected return code')
1847
return result, out, err
1849
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1850
working_dir=None, error_regexes=[], output_encoding=None):
1851
"""Invoke bzr, as if it were run from the command line.
1853
The argument list should not include the bzr program name - the
1854
first argument is normally the bzr command. Arguments may be
1855
passed in three ways:
1857
1- A list of strings, eg ["commit", "a"]. This is recommended
1858
when the command contains whitespace or metacharacters, or
1859
is built up at run time.
1861
2- A single string, eg "add a". This is the most convenient
1862
for hardcoded commands.
1864
This runs bzr through the interface that catches and reports
1865
errors, and with logging set to something approximating the
1866
default, so that error reporting can be checked.
1868
This should be the main method for tests that want to exercise the
1869
overall behavior of the bzr application (rather than a unit test
1870
or a functional test of the library.)
1872
This sends the stdout/stderr results into the test's log,
1873
where it may be useful for debugging. See also run_captured.
1875
:keyword stdin: A string to be used as stdin for the command.
1876
:keyword retcode: The status code the command should return;
1878
:keyword working_dir: The directory to run the command in
1879
:keyword error_regexes: A list of expected error messages. If
1880
specified they must be seen in the error output of the command.
1882
retcode, out, err = self._run_bzr_autosplit(
1887
working_dir=working_dir,
1889
self.assertIsInstance(error_regexes, (list, tuple))
1890
for regex in error_regexes:
1891
self.assertContainsRe(err, regex)
1894
def run_bzr_error(self, error_regexes, *args, **kwargs):
1895
"""Run bzr, and check that stderr contains the supplied regexes
1897
:param error_regexes: Sequence of regular expressions which
1898
must each be found in the error output. The relative ordering
1900
:param args: command-line arguments for bzr
1901
:param kwargs: Keyword arguments which are interpreted by run_bzr
1902
This function changes the default value of retcode to be 3,
1903
since in most cases this is run when you expect bzr to fail.
1905
:return: (out, err) The actual output of running the command (in case
1906
you want to do more inspection)
1910
# Make sure that commit is failing because there is nothing to do
1911
self.run_bzr_error(['no changes to commit'],
1912
['commit', '-m', 'my commit comment'])
1913
# Make sure --strict is handling an unknown file, rather than
1914
# giving us the 'nothing to do' error
1915
self.build_tree(['unknown'])
1916
self.run_bzr_error(['Commit refused because there are unknown files'],
1917
['commit', --strict', '-m', 'my commit comment'])
1919
kwargs.setdefault('retcode', 3)
1920
kwargs['error_regexes'] = error_regexes
1921
out, err = self.run_bzr(*args, **kwargs)
1924
def run_bzr_subprocess(self, *args, **kwargs):
1925
"""Run bzr in a subprocess for testing.
1927
This starts a new Python interpreter and runs bzr in there.
1928
This should only be used for tests that have a justifiable need for
1929
this isolation: e.g. they are testing startup time, or signal
1930
handling, or early startup code, etc. Subprocess code can't be
1931
profiled or debugged so easily.
1933
:keyword retcode: The status code that is expected. Defaults to 0. If
1934
None is supplied, the status code is not checked.
1935
:keyword env_changes: A dictionary which lists changes to environment
1936
variables. A value of None will unset the env variable.
1937
The values must be strings. The change will only occur in the
1938
child, so you don't need to fix the environment after running.
1939
:keyword universal_newlines: Convert CRLF => LF
1940
:keyword allow_plugins: By default the subprocess is run with
1941
--no-plugins to ensure test reproducibility. Also, it is possible
1942
for system-wide plugins to create unexpected output on stderr,
1943
which can cause unnecessary test failures.
1945
env_changes = kwargs.get('env_changes', {})
1946
working_dir = kwargs.get('working_dir', None)
1947
allow_plugins = kwargs.get('allow_plugins', False)
1949
if isinstance(args[0], list):
1951
elif isinstance(args[0], basestring):
1952
args = list(shlex.split(args[0]))
1954
raise ValueError("passing varargs to run_bzr_subprocess")
1955
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1956
working_dir=working_dir,
1957
allow_plugins=allow_plugins)
1958
# We distinguish between retcode=None and retcode not passed.
1959
supplied_retcode = kwargs.get('retcode', 0)
1960
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1961
universal_newlines=kwargs.get('universal_newlines', False),
1964
def start_bzr_subprocess(self, process_args, env_changes=None,
1965
skip_if_plan_to_signal=False,
1967
allow_plugins=False):
1968
"""Start bzr in a subprocess for testing.
1970
This starts a new Python interpreter and runs bzr in there.
1971
This should only be used for tests that have a justifiable need for
1972
this isolation: e.g. they are testing startup time, or signal
1973
handling, or early startup code, etc. Subprocess code can't be
1974
profiled or debugged so easily.
1976
:param process_args: a list of arguments to pass to the bzr executable,
1977
for example ``['--version']``.
1978
:param env_changes: A dictionary which lists changes to environment
1979
variables. A value of None will unset the env variable.
1980
The values must be strings. The change will only occur in the
1981
child, so you don't need to fix the environment after running.
1982
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1984
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1986
:returns: Popen object for the started process.
1988
if skip_if_plan_to_signal:
1989
if not getattr(os, 'kill', None):
1990
raise TestSkipped("os.kill not available.")
1992
if env_changes is None:
1996
def cleanup_environment():
1997
for env_var, value in env_changes.iteritems():
1998
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2000
def restore_environment():
2001
for env_var, value in old_env.iteritems():
2002
osutils.set_or_unset_env(env_var, value)
2004
bzr_path = self.get_bzr_path()
2007
if working_dir is not None:
2008
cwd = osutils.getcwd()
2009
os.chdir(working_dir)
2012
# win32 subprocess doesn't support preexec_fn
2013
# so we will avoid using it on all platforms, just to
2014
# make sure the code path is used, and we don't break on win32
2015
cleanup_environment()
2016
command = [sys.executable]
2017
# frozen executables don't need the path to bzr
2018
if getattr(sys, "frozen", None) is None:
2019
command.append(bzr_path)
2020
if not allow_plugins:
2021
command.append('--no-plugins')
2022
command.extend(process_args)
2023
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
2025
restore_environment()
2031
def _popen(self, *args, **kwargs):
2032
"""Place a call to Popen.
2034
Allows tests to override this method to intercept the calls made to
2035
Popen for introspection.
2037
return Popen(*args, **kwargs)
2039
def get_source_path(self):
2040
"""Return the path of the directory containing bzrlib."""
2041
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2043
def get_bzr_path(self):
2044
"""Return the path of the 'bzr' executable for this test suite."""
2045
bzr_path = self.get_source_path()+'/bzr'
2046
if not os.path.isfile(bzr_path):
2047
# We are probably installed. Assume sys.argv is the right file
2048
bzr_path = sys.argv[0]
2051
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2052
universal_newlines=False, process_args=None):
2053
"""Finish the execution of process.
2055
:param process: the Popen object returned from start_bzr_subprocess.
2056
:param retcode: The status code that is expected. Defaults to 0. If
2057
None is supplied, the status code is not checked.
2058
:param send_signal: an optional signal to send to the process.
2059
:param universal_newlines: Convert CRLF => LF
2060
:returns: (stdout, stderr)
2062
if send_signal is not None:
2063
os.kill(process.pid, send_signal)
2064
out, err = process.communicate()
2066
if universal_newlines:
2067
out = out.replace('\r\n', '\n')
2068
err = err.replace('\r\n', '\n')
2070
if retcode is not None and retcode != process.returncode:
2071
if process_args is None:
2072
process_args = "(unknown args)"
2073
mutter('Output of bzr %s:\n%s', process_args, out)
2074
mutter('Error for bzr %s:\n%s', process_args, err)
2075
self.fail('Command bzr %s failed with retcode %s != %s'
2076
% (process_args, retcode, process.returncode))
2079
def check_inventory_shape(self, inv, shape):
2080
"""Compare an inventory to a list of expected names.
2082
Fail if they are not precisely equal.
2085
shape = list(shape) # copy
2086
for path, ie in inv.entries():
2087
name = path.replace('\\', '/')
2088
if ie.kind == 'directory':
2095
self.fail("expected paths not found in inventory: %r" % shape)
2097
self.fail("unexpected paths found in inventory: %r" % extras)
2099
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2100
a_callable=None, *args, **kwargs):
2101
"""Call callable with redirected std io pipes.
2103
Returns the return code."""
2104
if not callable(a_callable):
2105
raise ValueError("a_callable must be callable.")
2107
stdin = StringIO("")
2109
if getattr(self, "_log_file", None) is not None:
2110
stdout = self._log_file
2114
if getattr(self, "_log_file", None is not None):
2115
stderr = self._log_file
2118
real_stdin = sys.stdin
2119
real_stdout = sys.stdout
2120
real_stderr = sys.stderr
2125
return a_callable(*args, **kwargs)
2127
sys.stdout = real_stdout
2128
sys.stderr = real_stderr
2129
sys.stdin = real_stdin
2131
def reduceLockdirTimeout(self):
2132
"""Reduce the default lock timeout for the duration of the test, so that
2133
if LockContention occurs during a test, it does so quickly.
2135
Tests that expect to provoke LockContention errors should call this.
2137
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
2139
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
2140
self.addCleanup(resetTimeout)
2141
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2143
def make_utf8_encoded_stringio(self, encoding_type=None):
2144
"""Return a StringIOWrapper instance, that will encode Unicode
2147
if encoding_type is None:
2148
encoding_type = 'strict'
2150
output_encoding = 'utf-8'
2151
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2152
sio.encoding = output_encoding
2155
def disable_verb(self, verb):
2156
"""Disable a smart server verb for one test."""
2157
from bzrlib.smart import request
2158
request_handlers = request.request_handlers
2159
orig_method = request_handlers.get(verb)
2160
request_handlers.remove(verb)
2162
request_handlers.register(verb, orig_method)
2163
self.addCleanup(restoreVerb)
2166
class CapturedCall(object):
2167
"""A helper for capturing smart server calls for easy debug analysis."""
2169
def __init__(self, params, prefix_length):
2170
"""Capture the call with params and skip prefix_length stack frames."""
2173
# The last 5 frames are the __init__, the hook frame, and 3 smart
2174
# client frames. Beyond this we could get more clever, but this is good
2176
stack = traceback.extract_stack()[prefix_length:-5]
2177
self.stack = ''.join(traceback.format_list(stack))
2180
return self.call.method
2183
return self.call.method
2189
class TestCaseWithMemoryTransport(TestCase):
2190
"""Common test class for tests that do not need disk resources.
2192
Tests that need disk resources should derive from TestCaseWithTransport.
2194
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2196
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2197
a directory which does not exist. This serves to help ensure test isolation
2198
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2199
must exist. However, TestCaseWithMemoryTransport does not offer local
2200
file defaults for the transport in tests, nor does it obey the command line
2201
override, so tests that accidentally write to the common directory should
2204
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2205
a .bzr directory that stops us ascending higher into the filesystem.
2211
def __init__(self, methodName='runTest'):
2212
# allow test parameterization after test construction and before test
2213
# execution. Variables that the parameterizer sets need to be
2214
# ones that are not set by setUp, or setUp will trash them.
2215
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2216
self.vfs_transport_factory = default_transport
2217
self.transport_server = None
2218
self.transport_readonly_server = None
2219
self.__vfs_server = None
2221
def get_transport(self, relpath=None):
2222
"""Return a writeable transport.
2224
This transport is for the test scratch space relative to
2227
:param relpath: a path relative to the base url.
2229
t = get_transport(self.get_url(relpath))
2230
self.assertFalse(t.is_readonly())
2233
def get_readonly_transport(self, relpath=None):
2234
"""Return a readonly transport for the test scratch space
2236
This can be used to test that operations which should only need
2237
readonly access in fact do not try to write.
2239
:param relpath: a path relative to the base url.
2241
t = get_transport(self.get_readonly_url(relpath))
2242
self.assertTrue(t.is_readonly())
2245
def create_transport_readonly_server(self):
2246
"""Create a transport server from class defined at init.
2248
This is mostly a hook for daughter classes.
2250
return self.transport_readonly_server()
2252
def get_readonly_server(self):
2253
"""Get the server instance for the readonly transport
2255
This is useful for some tests with specific servers to do diagnostics.
2257
if self.__readonly_server is None:
2258
if self.transport_readonly_server is None:
2259
# readonly decorator requested
2260
self.__readonly_server = ReadonlyServer()
2262
# explicit readonly transport.
2263
self.__readonly_server = self.create_transport_readonly_server()
2264
self.start_server(self.__readonly_server,
2265
self.get_vfs_only_server())
2266
return self.__readonly_server
2268
def get_readonly_url(self, relpath=None):
2269
"""Get a URL for the readonly transport.
2271
This will either be backed by '.' or a decorator to the transport
2272
used by self.get_url()
2273
relpath provides for clients to get a path relative to the base url.
2274
These should only be downwards relative, not upwards.
2276
base = self.get_readonly_server().get_url()
2277
return self._adjust_url(base, relpath)
2279
def get_vfs_only_server(self):
2280
"""Get the vfs only read/write server instance.
2282
This is useful for some tests with specific servers that need
2285
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2286
is no means to override it.
2288
if self.__vfs_server is None:
2289
self.__vfs_server = MemoryServer()
2290
self.start_server(self.__vfs_server)
2291
return self.__vfs_server
2293
def get_server(self):
2294
"""Get the read/write server instance.
2296
This is useful for some tests with specific servers that need
2299
This is built from the self.transport_server factory. If that is None,
2300
then the self.get_vfs_server is returned.
2302
if self.__server is None:
2303
if (self.transport_server is None or self.transport_server is
2304
self.vfs_transport_factory):
2305
self.__server = self.get_vfs_only_server()
2307
# bring up a decorated means of access to the vfs only server.
2308
self.__server = self.transport_server()
2309
self.start_server(self.__server, self.get_vfs_only_server())
2310
return self.__server
2312
def _adjust_url(self, base, relpath):
2313
"""Get a URL (or maybe a path) for the readwrite transport.
2315
This will either be backed by '.' or to an equivalent non-file based
2317
relpath provides for clients to get a path relative to the base url.
2318
These should only be downwards relative, not upwards.
2320
if relpath is not None and relpath != '.':
2321
if not base.endswith('/'):
2323
# XXX: Really base should be a url; we did after all call
2324
# get_url()! But sometimes it's just a path (from
2325
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2326
# to a non-escaped local path.
2327
if base.startswith('./') or base.startswith('/'):
2330
base += urlutils.escape(relpath)
2333
def get_url(self, relpath=None):
2334
"""Get a URL (or maybe a path) for the readwrite transport.
2336
This will either be backed by '.' or to an equivalent non-file based
2338
relpath provides for clients to get a path relative to the base url.
2339
These should only be downwards relative, not upwards.
2341
base = self.get_server().get_url()
2342
return self._adjust_url(base, relpath)
2344
def get_vfs_only_url(self, relpath=None):
2345
"""Get a URL (or maybe a path for the plain old vfs transport.
2347
This will never be a smart protocol. It always has all the
2348
capabilities of the local filesystem, but it might actually be a
2349
MemoryTransport or some other similar virtual filesystem.
2351
This is the backing transport (if any) of the server returned by
2352
get_url and get_readonly_url.
2354
:param relpath: provides for clients to get a path relative to the base
2355
url. These should only be downwards relative, not upwards.
2358
base = self.get_vfs_only_server().get_url()
2359
return self._adjust_url(base, relpath)
2361
def _create_safety_net(self):
2362
"""Make a fake bzr directory.
2364
This prevents any tests propagating up onto the TEST_ROOT directory's
2367
root = TestCaseWithMemoryTransport.TEST_ROOT
2368
bzrdir.BzrDir.create_standalone_workingtree(root)
2370
def _check_safety_net(self):
2371
"""Check that the safety .bzr directory have not been touched.
2373
_make_test_root have created a .bzr directory to prevent tests from
2374
propagating. This method ensures than a test did not leaked.
2376
root = TestCaseWithMemoryTransport.TEST_ROOT
2377
self.permit_url(get_transport(root).base)
2378
wt = workingtree.WorkingTree.open(root)
2379
last_rev = wt.last_revision()
2380
if last_rev != 'null:':
2381
# The current test have modified the /bzr directory, we need to
2382
# recreate a new one or all the followng tests will fail.
2383
# If you need to inspect its content uncomment the following line
2384
# import pdb; pdb.set_trace()
2385
_rmtree_temp_dir(root + '/.bzr')
2386
self._create_safety_net()
2387
raise AssertionError('%s/.bzr should not be modified' % root)
2389
def _make_test_root(self):
2390
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2391
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2392
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2394
TestCaseWithMemoryTransport.TEST_ROOT = root
2396
self._create_safety_net()
2398
# The same directory is used by all tests, and we're not
2399
# specifically told when all tests are finished. This will do.
2400
atexit.register(_rmtree_temp_dir, root)
2402
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2403
self.addCleanup(self._check_safety_net)
2405
def makeAndChdirToTestDir(self):
2406
"""Create a temporary directories for this one test.
2408
This must set self.test_home_dir and self.test_dir and chdir to
2411
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2413
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2414
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2415
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2416
self.permit_dir(self.test_dir)
2418
def make_branch(self, relpath, format=None):
2419
"""Create a branch on the transport at relpath."""
2420
repo = self.make_repository(relpath, format=format)
2421
return repo.bzrdir.create_branch()
2423
def make_bzrdir(self, relpath, format=None):
2425
# might be a relative or absolute path
2426
maybe_a_url = self.get_url(relpath)
2427
segments = maybe_a_url.rsplit('/', 1)
2428
t = get_transport(maybe_a_url)
2429
if len(segments) > 1 and segments[-1] not in ('', '.'):
2433
if isinstance(format, basestring):
2434
format = bzrdir.format_registry.make_bzrdir(format)
2435
return format.initialize_on_transport(t)
2436
except errors.UninitializableFormat:
2437
raise TestSkipped("Format %s is not initializable." % format)
2439
def make_repository(self, relpath, shared=False, format=None):
2440
"""Create a repository on our default transport at relpath.
2442
Note that relpath must be a relative path, not a full url.
2444
# FIXME: If you create a remoterepository this returns the underlying
2445
# real format, which is incorrect. Actually we should make sure that
2446
# RemoteBzrDir returns a RemoteRepository.
2447
# maybe mbp 20070410
2448
made_control = self.make_bzrdir(relpath, format=format)
2449
return made_control.create_repository(shared=shared)
2451
def make_smart_server(self, path):
2452
smart_server = server.SmartTCPServer_for_testing()
2453
self.start_server(smart_server, self.get_server())
2454
remote_transport = get_transport(smart_server.get_url()).clone(path)
2455
return remote_transport
2457
def make_branch_and_memory_tree(self, relpath, format=None):
2458
"""Create a branch on the default transport and a MemoryTree for it."""
2459
b = self.make_branch(relpath, format=format)
2460
return memorytree.MemoryTree.create_on_branch(b)
2462
def make_branch_builder(self, relpath, format=None):
2463
branch = self.make_branch(relpath, format=format)
2464
return branchbuilder.BranchBuilder(branch=branch)
2466
def overrideEnvironmentForTesting(self):
2467
os.environ['HOME'] = self.test_home_dir
2468
os.environ['BZR_HOME'] = self.test_home_dir
2471
super(TestCaseWithMemoryTransport, self).setUp()
2472
self._make_test_root()
2473
_currentdir = os.getcwdu()
2474
def _leaveDirectory():
2475
os.chdir(_currentdir)
2476
self.addCleanup(_leaveDirectory)
2477
self.makeAndChdirToTestDir()
2478
self.overrideEnvironmentForTesting()
2479
self.__readonly_server = None
2480
self.__server = None
2481
self.reduceLockdirTimeout()
2483
def setup_smart_server_with_call_log(self):
2484
"""Sets up a smart server as the transport server with a call log."""
2485
self.transport_server = server.SmartTCPServer_for_testing
2486
self.hpss_calls = []
2488
# Skip the current stack down to the caller of
2489
# setup_smart_server_with_call_log
2490
prefix_length = len(traceback.extract_stack()) - 2
2491
def capture_hpss_call(params):
2492
self.hpss_calls.append(
2493
CapturedCall(params, prefix_length))
2494
client._SmartClient.hooks.install_named_hook(
2495
'call', capture_hpss_call, None)
2497
def reset_smart_call_log(self):
2498
self.hpss_calls = []
2501
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2502
"""Derived class that runs a test within a temporary directory.
2504
This is useful for tests that need to create a branch, etc.
2506
The directory is created in a slightly complex way: for each
2507
Python invocation, a new temporary top-level directory is created.
2508
All test cases create their own directory within that. If the
2509
tests complete successfully, the directory is removed.
2511
:ivar test_base_dir: The path of the top-level directory for this
2512
test, which contains a home directory and a work directory.
2514
:ivar test_home_dir: An initially empty directory under test_base_dir
2515
which is used as $HOME for this test.
2517
:ivar test_dir: A directory under test_base_dir used as the current
2518
directory when the test proper is run.
2521
OVERRIDE_PYTHON = 'python'
2523
def check_file_contents(self, filename, expect):
2524
self.log("check contents of file %s" % filename)
2525
contents = file(filename, 'r').read()
2526
if contents != expect:
2527
self.log("expected: %r" % expect)
2528
self.log("actually: %r" % contents)
2529
self.fail("contents of %s not as expected" % filename)
2531
def _getTestDirPrefix(self):
2532
# create a directory within the top level test directory
2533
if sys.platform in ('win32', 'cygwin'):
2534
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2535
# windows is likely to have path-length limits so use a short name
2536
name_prefix = name_prefix[-30:]
2538
name_prefix = re.sub('[/]', '_', self.id())
2541
def makeAndChdirToTestDir(self):
2542
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2544
For TestCaseInTempDir we create a temporary directory based on the test
2545
name and then create two subdirs - test and home under it.
2547
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2548
self._getTestDirPrefix())
2550
for i in range(100):
2551
if os.path.exists(name):
2552
name = name_prefix + '_' + str(i)
2554
# now create test and home directories within this dir
2555
self.test_base_dir = name
2556
self.addCleanup(self.deleteTestDir)
2557
os.mkdir(self.test_base_dir)
2559
self.permit_dir(self.test_base_dir)
2560
# 'sprouting' and 'init' of a branch both walk up the tree to find
2561
# stacking policy to honour; create a bzr dir with an unshared
2562
# repository (but not a branch - our code would be trying to escape
2563
# then!) to stop them, and permit it to be read.
2564
# control = bzrdir.BzrDir.create(self.test_base_dir)
2565
# control.create_repository()
2566
self.test_home_dir = self.test_base_dir + '/home'
2567
os.mkdir(self.test_home_dir)
2568
self.test_dir = self.test_base_dir + '/work'
2569
os.mkdir(self.test_dir)
2570
os.chdir(self.test_dir)
2571
# put name of test inside
2572
f = file(self.test_base_dir + '/name', 'w')
2578
def deleteTestDir(self):
2579
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2580
_rmtree_temp_dir(self.test_base_dir)
2582
def build_tree(self, shape, line_endings='binary', transport=None):
2583
"""Build a test tree according to a pattern.
2585
shape is a sequence of file specifications. If the final
2586
character is '/', a directory is created.
2588
This assumes that all the elements in the tree being built are new.
2590
This doesn't add anything to a branch.
2592
:type shape: list or tuple.
2593
:param line_endings: Either 'binary' or 'native'
2594
in binary mode, exact contents are written in native mode, the
2595
line endings match the default platform endings.
2596
:param transport: A transport to write to, for building trees on VFS's.
2597
If the transport is readonly or None, "." is opened automatically.
2600
if type(shape) not in (list, tuple):
2601
raise AssertionError("Parameter 'shape' should be "
2602
"a list or a tuple. Got %r instead" % (shape,))
2603
# It's OK to just create them using forward slashes on windows.
2604
if transport is None or transport.is_readonly():
2605
transport = get_transport(".")
2607
self.assertIsInstance(name, basestring)
2609
transport.mkdir(urlutils.escape(name[:-1]))
2611
if line_endings == 'binary':
2613
elif line_endings == 'native':
2616
raise errors.BzrError(
2617
'Invalid line ending request %r' % line_endings)
2618
content = "contents of %s%s" % (name.encode('utf-8'), end)
2619
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2621
def build_tree_contents(self, shape):
2622
build_tree_contents(shape)
2624
def assertInWorkingTree(self, path, root_path='.', tree=None):
2625
"""Assert whether path or paths are in the WorkingTree"""
2627
tree = workingtree.WorkingTree.open(root_path)
2628
if not isinstance(path, basestring):
2630
self.assertInWorkingTree(p, tree=tree)
2632
self.assertIsNot(tree.path2id(path), None,
2633
path+' not in working tree.')
2635
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2636
"""Assert whether path or paths are not in the WorkingTree"""
2638
tree = workingtree.WorkingTree.open(root_path)
2639
if not isinstance(path, basestring):
2641
self.assertNotInWorkingTree(p,tree=tree)
2643
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2646
class TestCaseWithTransport(TestCaseInTempDir):
2647
"""A test case that provides get_url and get_readonly_url facilities.
2649
These back onto two transport servers, one for readonly access and one for
2652
If no explicit class is provided for readonly access, a
2653
ReadonlyTransportDecorator is used instead which allows the use of non disk
2654
based read write transports.
2656
If an explicit class is provided for readonly access, that server and the
2657
readwrite one must both define get_url() as resolving to os.getcwd().
2660
def get_vfs_only_server(self):
2661
"""See TestCaseWithMemoryTransport.
2663
This is useful for some tests with specific servers that need
2666
if self.__vfs_server is None:
2667
self.__vfs_server = self.vfs_transport_factory()
2668
self.start_server(self.__vfs_server)
2669
return self.__vfs_server
2671
def make_branch_and_tree(self, relpath, format=None):
2672
"""Create a branch on the transport and a tree locally.
2674
If the transport is not a LocalTransport, the Tree can't be created on
2675
the transport. In that case if the vfs_transport_factory is
2676
LocalURLServer the working tree is created in the local
2677
directory backing the transport, and the returned tree's branch and
2678
repository will also be accessed locally. Otherwise a lightweight
2679
checkout is created and returned.
2681
We do this because we can't physically create a tree in the local
2682
path, with a branch reference to the transport_factory url, and
2683
a branch + repository in the vfs_transport, unless the vfs_transport
2684
namespace is distinct from the local disk - the two branch objects
2685
would collide. While we could construct a tree with its branch object
2686
pointing at the transport_factory transport in memory, reopening it
2687
would behaving unexpectedly, and has in the past caused testing bugs
2688
when we tried to do it that way.
2690
:param format: The BzrDirFormat.
2691
:returns: the WorkingTree.
2693
# TODO: always use the local disk path for the working tree,
2694
# this obviously requires a format that supports branch references
2695
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2697
b = self.make_branch(relpath, format=format)
2699
return b.bzrdir.create_workingtree()
2700
except errors.NotLocalUrl:
2701
# We can only make working trees locally at the moment. If the
2702
# transport can't support them, then we keep the non-disk-backed
2703
# branch and create a local checkout.
2704
if self.vfs_transport_factory is LocalURLServer:
2705
# the branch is colocated on disk, we cannot create a checkout.
2706
# hopefully callers will expect this.
2707
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2708
wt = local_controldir.create_workingtree()
2709
if wt.branch._format != b._format:
2711
# Make sure that assigning to wt._branch fixes wt.branch,
2712
# in case the implementation details of workingtree objects
2714
self.assertIs(b, wt.branch)
2717
return b.create_checkout(relpath, lightweight=True)
2719
def assertIsDirectory(self, relpath, transport):
2720
"""Assert that relpath within transport is a directory.
2722
This may not be possible on all transports; in that case it propagates
2723
a TransportNotPossible.
2726
mode = transport.stat(relpath).st_mode
2727
except errors.NoSuchFile:
2728
self.fail("path %s is not a directory; no such file"
2730
if not stat.S_ISDIR(mode):
2731
self.fail("path %s is not a directory; has mode %#o"
2734
def assertTreesEqual(self, left, right):
2735
"""Check that left and right have the same content and properties."""
2736
# we use a tree delta to check for equality of the content, and we
2737
# manually check for equality of other things such as the parents list.
2738
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2739
differences = left.changes_from(right)
2740
self.assertFalse(differences.has_changed(),
2741
"Trees %r and %r are different: %r" % (left, right, differences))
2744
super(TestCaseWithTransport, self).setUp()
2745
self.__vfs_server = None
2747
def disable_missing_extensions_warning(self):
2748
"""Some tests expect a precise stderr content.
2750
There is no point in forcing them to duplicate the extension related
2753
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2756
class ChrootedTestCase(TestCaseWithTransport):
2757
"""A support class that provides readonly urls outside the local namespace.
2759
This is done by checking if self.transport_server is a MemoryServer. if it
2760
is then we are chrooted already, if it is not then an HttpServer is used
2763
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2764
be used without needed to redo it when a different
2765
subclass is in use ?
2769
super(ChrootedTestCase, self).setUp()
2770
if not self.vfs_transport_factory == MemoryServer:
2771
self.transport_readonly_server = HttpServer
2774
def condition_id_re(pattern):
2775
"""Create a condition filter which performs a re check on a test's id.
2777
:param pattern: A regular expression string.
2778
:return: A callable that returns True if the re matches.
2780
filter_re = osutils.re_compile_checked(pattern, 0,
2782
def condition(test):
2784
return filter_re.search(test_id)
2788
def condition_isinstance(klass_or_klass_list):
2789
"""Create a condition filter which returns isinstance(param, klass).
2791
:return: A callable which when called with one parameter obj return the
2792
result of isinstance(obj, klass_or_klass_list).
2795
return isinstance(obj, klass_or_klass_list)
2799
def condition_id_in_list(id_list):
2800
"""Create a condition filter which verify that test's id in a list.
2802
:param id_list: A TestIdList object.
2803
:return: A callable that returns True if the test's id appears in the list.
2805
def condition(test):
2806
return id_list.includes(test.id())
2810
def condition_id_startswith(starts):
2811
"""Create a condition filter verifying that test's id starts with a string.
2813
:param starts: A list of string.
2814
:return: A callable that returns True if the test's id starts with one of
2817
def condition(test):
2818
for start in starts:
2819
if test.id().startswith(start):
2825
def exclude_tests_by_condition(suite, condition):
2826
"""Create a test suite which excludes some tests from suite.
2828
:param suite: The suite to get tests from.
2829
:param condition: A callable whose result evaluates True when called with a
2830
test case which should be excluded from the result.
2831
:return: A suite which contains the tests found in suite that fail
2835
for test in iter_suite_tests(suite):
2836
if not condition(test):
2838
return TestUtil.TestSuite(result)
2841
def filter_suite_by_condition(suite, condition):
2842
"""Create a test suite by filtering another one.
2844
:param suite: The source suite.
2845
:param condition: A callable whose result evaluates True when called with a
2846
test case which should be included in the result.
2847
:return: A suite which contains the tests found in suite that pass
2851
for test in iter_suite_tests(suite):
2854
return TestUtil.TestSuite(result)
2857
def filter_suite_by_re(suite, pattern):
2858
"""Create a test suite by filtering another one.
2860
:param suite: the source suite
2861
:param pattern: pattern that names must match
2862
:returns: the newly created suite
2864
condition = condition_id_re(pattern)
2865
result_suite = filter_suite_by_condition(suite, condition)
2869
def filter_suite_by_id_list(suite, test_id_list):
2870
"""Create a test suite by filtering another one.
2872
:param suite: The source suite.
2873
:param test_id_list: A list of the test ids to keep as strings.
2874
:returns: the newly created suite
2876
condition = condition_id_in_list(test_id_list)
2877
result_suite = filter_suite_by_condition(suite, condition)
2881
def filter_suite_by_id_startswith(suite, start):
2882
"""Create a test suite by filtering another one.
2884
:param suite: The source suite.
2885
:param start: A list of string the test id must start with one of.
2886
:returns: the newly created suite
2888
condition = condition_id_startswith(start)
2889
result_suite = filter_suite_by_condition(suite, condition)
2893
def exclude_tests_by_re(suite, pattern):
2894
"""Create a test suite which excludes some tests from suite.
2896
:param suite: The suite to get tests from.
2897
:param pattern: A regular expression string. Test ids that match this
2898
pattern will be excluded from the result.
2899
:return: A TestSuite that contains all the tests from suite without the
2900
tests that matched pattern. The order of tests is the same as it was in
2903
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2906
def preserve_input(something):
2907
"""A helper for performing test suite transformation chains.
2909
:param something: Anything you want to preserve.
2915
def randomize_suite(suite):
2916
"""Return a new TestSuite with suite's tests in random order.
2918
The tests in the input suite are flattened into a single suite in order to
2919
accomplish this. Any nested TestSuites are removed to provide global
2922
tests = list(iter_suite_tests(suite))
2923
random.shuffle(tests)
2924
return TestUtil.TestSuite(tests)
2927
def split_suite_by_condition(suite, condition):
2928
"""Split a test suite into two by a condition.
2930
:param suite: The suite to split.
2931
:param condition: The condition to match on. Tests that match this
2932
condition are returned in the first test suite, ones that do not match
2933
are in the second suite.
2934
:return: A tuple of two test suites, where the first contains tests from
2935
suite matching the condition, and the second contains the remainder
2936
from suite. The order within each output suite is the same as it was in
2941
for test in iter_suite_tests(suite):
2943
matched.append(test)
2945
did_not_match.append(test)
2946
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2949
def split_suite_by_re(suite, pattern):
2950
"""Split a test suite into two by a regular expression.
2952
:param suite: The suite to split.
2953
:param pattern: A regular expression string. Test ids that match this
2954
pattern will be in the first test suite returned, and the others in the
2955
second test suite returned.
2956
:return: A tuple of two test suites, where the first contains tests from
2957
suite matching pattern, and the second contains the remainder from
2958
suite. The order within each output suite is the same as it was in
2961
return split_suite_by_condition(suite, condition_id_re(pattern))
2964
def run_suite(suite, name='test', verbose=False, pattern=".*",
2965
stop_on_failure=False,
2966
transport=None, lsprof_timed=None, bench_history=None,
2967
matching_tests_first=None,
2970
exclude_pattern=None,
2973
suite_decorators=None,
2975
result_decorators=None,
2977
"""Run a test suite for bzr selftest.
2979
:param runner_class: The class of runner to use. Must support the
2980
constructor arguments passed by run_suite which are more than standard
2982
:return: A boolean indicating success.
2984
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2989
if runner_class is None:
2990
runner_class = TextTestRunner
2993
runner = runner_class(stream=stream,
2995
verbosity=verbosity,
2996
bench_history=bench_history,
2998
result_decorators=result_decorators,
3000
runner.stop_on_failure=stop_on_failure
3001
# built in decorator factories:
3003
random_order(random_seed, runner),
3004
exclude_tests(exclude_pattern),
3006
if matching_tests_first:
3007
decorators.append(tests_first(pattern))
3009
decorators.append(filter_tests(pattern))
3010
if suite_decorators:
3011
decorators.extend(suite_decorators)
3012
# tell the result object how many tests will be running: (except if
3013
# --parallel=fork is being used. Robert said he will provide a better
3014
# progress design later -- vila 20090817)
3015
if fork_decorator not in decorators:
3016
decorators.append(CountingDecorator)
3017
for decorator in decorators:
3018
suite = decorator(suite)
3020
# Done after test suite decoration to allow randomisation etc
3021
# to take effect, though that is of marginal benefit.
3023
stream.write("Listing tests only ...\n")
3024
for t in iter_suite_tests(suite):
3025
stream.write("%s\n" % (t.id()))
3027
result = runner.run(suite)
3029
return result.wasStrictlySuccessful()
3031
return result.wasSuccessful()
3034
# A registry where get() returns a suite decorator.
3035
parallel_registry = registry.Registry()
3038
def fork_decorator(suite):
3039
concurrency = osutils.local_concurrency()
3040
if concurrency == 1:
3042
from testtools import ConcurrentTestSuite
3043
return ConcurrentTestSuite(suite, fork_for_tests)
3044
parallel_registry.register('fork', fork_decorator)
3047
def subprocess_decorator(suite):
3048
concurrency = osutils.local_concurrency()
3049
if concurrency == 1:
3051
from testtools import ConcurrentTestSuite
3052
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3053
parallel_registry.register('subprocess', subprocess_decorator)
3056
def exclude_tests(exclude_pattern):
3057
"""Return a test suite decorator that excludes tests."""
3058
if exclude_pattern is None:
3059
return identity_decorator
3060
def decorator(suite):
3061
return ExcludeDecorator(suite, exclude_pattern)
3065
def filter_tests(pattern):
3067
return identity_decorator
3068
def decorator(suite):
3069
return FilterTestsDecorator(suite, pattern)
3073
def random_order(random_seed, runner):
3074
"""Return a test suite decorator factory for randomising tests order.
3076
:param random_seed: now, a string which casts to a long, or a long.
3077
:param runner: A test runner with a stream attribute to report on.
3079
if random_seed is None:
3080
return identity_decorator
3081
def decorator(suite):
3082
return RandomDecorator(suite, random_seed, runner.stream)
3086
def tests_first(pattern):
3088
return identity_decorator
3089
def decorator(suite):
3090
return TestFirstDecorator(suite, pattern)
3094
def identity_decorator(suite):
3099
class TestDecorator(TestSuite):
3100
"""A decorator for TestCase/TestSuite objects.
3102
Usually, subclasses should override __iter__(used when flattening test
3103
suites), which we do to filter, reorder, parallelise and so on, run() and
3107
def __init__(self, suite):
3108
TestSuite.__init__(self)
3111
def countTestCases(self):
3114
cases += test.countTestCases()
3121
def run(self, result):
3122
# Use iteration on self, not self._tests, to allow subclasses to hook
3125
if result.shouldStop:
3131
class CountingDecorator(TestDecorator):
3132
"""A decorator which calls result.progress(self.countTestCases)."""
3134
def run(self, result):
3135
progress_method = getattr(result, 'progress', None)
3136
if callable(progress_method):
3137
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3138
return super(CountingDecorator, self).run(result)
3141
class ExcludeDecorator(TestDecorator):
3142
"""A decorator which excludes test matching an exclude pattern."""
3144
def __init__(self, suite, exclude_pattern):
3145
TestDecorator.__init__(self, suite)
3146
self.exclude_pattern = exclude_pattern
3147
self.excluded = False
3151
return iter(self._tests)
3152
self.excluded = True
3153
suite = exclude_tests_by_re(self, self.exclude_pattern)
3155
self.addTests(suite)
3156
return iter(self._tests)
3159
class FilterTestsDecorator(TestDecorator):
3160
"""A decorator which filters tests to those matching a pattern."""
3162
def __init__(self, suite, pattern):
3163
TestDecorator.__init__(self, suite)
3164
self.pattern = pattern
3165
self.filtered = False
3169
return iter(self._tests)
3170
self.filtered = True
3171
suite = filter_suite_by_re(self, self.pattern)
3173
self.addTests(suite)
3174
return iter(self._tests)
3177
class RandomDecorator(TestDecorator):
3178
"""A decorator which randomises the order of its tests."""
3180
def __init__(self, suite, random_seed, stream):
3181
TestDecorator.__init__(self, suite)
3182
self.random_seed = random_seed
3183
self.randomised = False
3184
self.stream = stream
3188
return iter(self._tests)
3189
self.randomised = True
3190
self.stream.writeln("Randomizing test order using seed %s\n" %
3191
(self.actual_seed()))
3192
# Initialise the random number generator.
3193
random.seed(self.actual_seed())
3194
suite = randomize_suite(self)
3196
self.addTests(suite)
3197
return iter(self._tests)
3199
def actual_seed(self):
3200
if self.random_seed == "now":
3201
# We convert the seed to a long to make it reuseable across
3202
# invocations (because the user can reenter it).
3203
self.random_seed = long(time.time())
3205
# Convert the seed to a long if we can
3207
self.random_seed = long(self.random_seed)
3210
return self.random_seed
3213
class TestFirstDecorator(TestDecorator):
3214
"""A decorator which moves named tests to the front."""
3216
def __init__(self, suite, pattern):
3217
TestDecorator.__init__(self, suite)
3218
self.pattern = pattern
3219
self.filtered = False
3223
return iter(self._tests)
3224
self.filtered = True
3225
suites = split_suite_by_re(self, self.pattern)
3227
self.addTests(suites)
3228
return iter(self._tests)
3231
def partition_tests(suite, count):
3232
"""Partition suite into count lists of tests."""
3234
tests = list(iter_suite_tests(suite))
3235
tests_per_process = int(math.ceil(float(len(tests)) / count))
3236
for block in range(count):
3237
low_test = block * tests_per_process
3238
high_test = low_test + tests_per_process
3239
process_tests = tests[low_test:high_test]
3240
result.append(process_tests)
3244
def fork_for_tests(suite):
3245
"""Take suite and start up one runner per CPU by forking()
3247
:return: An iterable of TestCase-like objects which can each have
3248
run(result) called on them to feed tests to result.
3250
concurrency = osutils.local_concurrency()
3252
from subunit import TestProtocolClient, ProtocolTestCase
3254
from subunit.test_results import AutoTimingTestResultDecorator
3256
AutoTimingTestResultDecorator = lambda x:x
3257
class TestInOtherProcess(ProtocolTestCase):
3258
# Should be in subunit, I think. RBC.
3259
def __init__(self, stream, pid):
3260
ProtocolTestCase.__init__(self, stream)
3263
def run(self, result):
3265
ProtocolTestCase.run(self, result)
3267
os.waitpid(self.pid, os.WNOHANG)
3269
test_blocks = partition_tests(suite, concurrency)
3270
for process_tests in test_blocks:
3271
process_suite = TestSuite()
3272
process_suite.addTests(process_tests)
3273
c2pread, c2pwrite = os.pipe()
3278
# Leave stderr and stdout open so we can see test noise
3279
# Close stdin so that the child goes away if it decides to
3280
# read from stdin (otherwise its a roulette to see what
3281
# child actually gets keystrokes for pdb etc).
3284
stream = os.fdopen(c2pwrite, 'wb', 1)
3285
subunit_result = AutoTimingTestResultDecorator(
3286
TestProtocolClient(stream))
3287
process_suite.run(subunit_result)
3292
stream = os.fdopen(c2pread, 'rb', 1)
3293
test = TestInOtherProcess(stream, pid)
3298
def reinvoke_for_tests(suite):
3299
"""Take suite and start up one runner per CPU using subprocess().
3301
:return: An iterable of TestCase-like objects which can each have
3302
run(result) called on them to feed tests to result.
3304
concurrency = osutils.local_concurrency()
3306
from subunit import ProtocolTestCase
3307
class TestInSubprocess(ProtocolTestCase):
3308
def __init__(self, process, name):
3309
ProtocolTestCase.__init__(self, process.stdout)
3310
self.process = process
3311
self.process.stdin.close()
3314
def run(self, result):
3316
ProtocolTestCase.run(self, result)
3319
os.unlink(self.name)
3320
# print "pid %d finished" % finished_process
3321
test_blocks = partition_tests(suite, concurrency)
3322
for process_tests in test_blocks:
3323
# ugly; currently reimplement rather than reuses TestCase methods.
3324
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3325
if not os.path.isfile(bzr_path):
3326
# We are probably installed. Assume sys.argv is the right file
3327
bzr_path = sys.argv[0]
3328
fd, test_list_file_name = tempfile.mkstemp()
3329
test_list_file = os.fdopen(fd, 'wb', 1)
3330
for test in process_tests:
3331
test_list_file.write(test.id() + '\n')
3332
test_list_file.close()
3334
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3336
if '--no-plugins' in sys.argv:
3337
argv.append('--no-plugins')
3338
# stderr=STDOUT would be ideal, but until we prevent noise on
3339
# stderr it can interrupt the subunit protocol.
3340
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3342
test = TestInSubprocess(process, test_list_file_name)
3345
os.unlink(test_list_file_name)
3350
class ForwardingResult(unittest.TestResult):
3352
def __init__(self, target):
3353
unittest.TestResult.__init__(self)
3354
self.result = target
3356
def startTest(self, test):
3357
self.result.startTest(test)
3359
def stopTest(self, test):
3360
self.result.stopTest(test)
3362
def startTestRun(self):
3363
self.result.startTestRun()
3365
def stopTestRun(self):
3366
self.result.stopTestRun()
3368
def addSkip(self, test, reason):
3369
self.result.addSkip(test, reason)
3371
def addSuccess(self, test):
3372
self.result.addSuccess(test)
3374
def addError(self, test, err):
3375
self.result.addError(test, err)
3377
def addFailure(self, test, err):
3378
self.result.addFailure(test, err)
3381
class BZRTransformingResult(ForwardingResult):
3383
def addError(self, test, err):
3384
feature = self._error_looks_like('UnavailableFeature: ', err)
3385
if feature is not None:
3386
self.result.addNotSupported(test, feature)
3388
self.result.addError(test, err)
3390
def addFailure(self, test, err):
3391
known = self._error_looks_like('KnownFailure: ', err)
3392
if known is not None:
3393
self.result.addExpectedFailure(test,
3394
[KnownFailure, KnownFailure(known), None])
3396
self.result.addFailure(test, err)
3398
def _error_looks_like(self, prefix, err):
3399
"""Deserialize exception and returns the stringify value."""
3403
if isinstance(exc, subunit.RemoteException):
3404
# stringify the exception gives access to the remote traceback
3405
# We search the last line for 'prefix'
3406
lines = str(exc).split('\n')
3407
while lines and not lines[-1]:
3410
if lines[-1].startswith(prefix):
3411
value = lines[-1][len(prefix):]
3415
class ProfileResult(ForwardingResult):
3416
"""Generate profiling data for all activity between start and success.
3418
The profile data is appended to the test's _benchcalls attribute and can
3419
be accessed by the forwarded-to TestResult.
3421
While it might be cleaner do accumulate this in stopTest, addSuccess is
3422
where our existing output support for lsprof is, and this class aims to
3423
fit in with that: while it could be moved it's not necessary to accomplish
3424
test profiling, nor would it be dramatically cleaner.
3427
def startTest(self, test):
3428
self.profiler = bzrlib.lsprof.BzrProfiler()
3429
self.profiler.start()
3430
ForwardingResult.startTest(self, test)
3432
def addSuccess(self, test):
3433
stats = self.profiler.stop()
3435
calls = test._benchcalls
3436
except AttributeError:
3437
test._benchcalls = []
3438
calls = test._benchcalls
3439
calls.append(((test.id(), "", ""), stats))
3440
ForwardingResult.addSuccess(self, test)
3442
def stopTest(self, test):
3443
ForwardingResult.stopTest(self, test)
3444
self.profiler = None
3447
# Controlled by "bzr selftest -E=..." option
3448
# Currently supported:
3449
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3450
# preserves any flags supplied at the command line.
3451
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3452
# rather than failing tests. And no longer raise
3453
# LockContention when fctnl locks are not being used
3454
# with proper exclusion rules.
3455
selftest_debug_flags = set()
3458
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3460
test_suite_factory=None,
3463
matching_tests_first=None,
3466
exclude_pattern=None,
3472
suite_decorators=None,
3476
"""Run the whole test suite under the enhanced runner"""
3477
# XXX: Very ugly way to do this...
3478
# Disable warning about old formats because we don't want it to disturb
3479
# any blackbox tests.
3480
from bzrlib import repository
3481
repository._deprecation_warning_done = True
3483
global default_transport
3484
if transport is None:
3485
transport = default_transport
3486
old_transport = default_transport
3487
default_transport = transport
3488
global selftest_debug_flags
3489
old_debug_flags = selftest_debug_flags
3490
if debug_flags is not None:
3491
selftest_debug_flags = set(debug_flags)
3493
if load_list is None:
3496
keep_only = load_test_id_list(load_list)
3498
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3499
for start in starting_with]
3500
if test_suite_factory is None:
3501
# Reduce loading time by loading modules based on the starting_with
3503
suite = test_suite(keep_only, starting_with)
3505
suite = test_suite_factory()
3507
# But always filter as requested.
3508
suite = filter_suite_by_id_startswith(suite, starting_with)
3509
result_decorators = []
3511
result_decorators.append(ProfileResult)
3512
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3513
stop_on_failure=stop_on_failure,
3514
transport=transport,
3515
lsprof_timed=lsprof_timed,
3516
bench_history=bench_history,
3517
matching_tests_first=matching_tests_first,
3518
list_only=list_only,
3519
random_seed=random_seed,
3520
exclude_pattern=exclude_pattern,
3522
runner_class=runner_class,
3523
suite_decorators=suite_decorators,
3525
result_decorators=result_decorators,
3528
default_transport = old_transport
3529
selftest_debug_flags = old_debug_flags
3532
def load_test_id_list(file_name):
3533
"""Load a test id list from a text file.
3535
The format is one test id by line. No special care is taken to impose
3536
strict rules, these test ids are used to filter the test suite so a test id
3537
that do not match an existing test will do no harm. This allows user to add
3538
comments, leave blank lines, etc.
3542
ftest = open(file_name, 'rt')
3544
if e.errno != errno.ENOENT:
3547
raise errors.NoSuchFile(file_name)
3549
for test_name in ftest.readlines():
3550
test_list.append(test_name.strip())
3555
def suite_matches_id_list(test_suite, id_list):
3556
"""Warns about tests not appearing or appearing more than once.
3558
:param test_suite: A TestSuite object.
3559
:param test_id_list: The list of test ids that should be found in
3562
:return: (absents, duplicates) absents is a list containing the test found
3563
in id_list but not in test_suite, duplicates is a list containing the
3564
test found multiple times in test_suite.
3566
When using a prefined test id list, it may occurs that some tests do not
3567
exist anymore or that some tests use the same id. This function warns the
3568
tester about potential problems in his workflow (test lists are volatile)
3569
or in the test suite itself (using the same id for several tests does not
3570
help to localize defects).
3572
# Build a dict counting id occurrences
3574
for test in iter_suite_tests(test_suite):
3576
tests[id] = tests.get(id, 0) + 1
3581
occurs = tests.get(id, 0)
3583
not_found.append(id)
3585
duplicates.append(id)
3587
return not_found, duplicates
3590
class TestIdList(object):
3591
"""Test id list to filter a test suite.
3593
Relying on the assumption that test ids are built as:
3594
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3595
notation, this class offers methods to :
3596
- avoid building a test suite for modules not refered to in the test list,
3597
- keep only the tests listed from the module test suite.
3600
def __init__(self, test_id_list):
3601
# When a test suite needs to be filtered against us we compare test ids
3602
# for equality, so a simple dict offers a quick and simple solution.
3603
self.tests = dict().fromkeys(test_id_list, True)
3605
# While unittest.TestCase have ids like:
3606
# <module>.<class>.<method>[(<param+)],
3607
# doctest.DocTestCase can have ids like:
3610
# <module>.<function>
3611
# <module>.<class>.<method>
3613
# Since we can't predict a test class from its name only, we settle on
3614
# a simple constraint: a test id always begins with its module name.
3617
for test_id in test_id_list:
3618
parts = test_id.split('.')
3619
mod_name = parts.pop(0)
3620
modules[mod_name] = True
3622
mod_name += '.' + part
3623
modules[mod_name] = True
3624
self.modules = modules
3626
def refers_to(self, module_name):
3627
"""Is there tests for the module or one of its sub modules."""
3628
return self.modules.has_key(module_name)
3630
def includes(self, test_id):
3631
return self.tests.has_key(test_id)
3634
class TestPrefixAliasRegistry(registry.Registry):
3635
"""A registry for test prefix aliases.
3637
This helps implement shorcuts for the --starting-with selftest
3638
option. Overriding existing prefixes is not allowed but not fatal (a
3639
warning will be emitted).
3642
def register(self, key, obj, help=None, info=None,
3643
override_existing=False):
3644
"""See Registry.register.
3646
Trying to override an existing alias causes a warning to be emitted,
3647
not a fatal execption.
3650
super(TestPrefixAliasRegistry, self).register(
3651
key, obj, help=help, info=info, override_existing=False)
3653
actual = self.get(key)
3654
note('Test prefix alias %s is already used for %s, ignoring %s'
3655
% (key, actual, obj))
3657
def resolve_alias(self, id_start):
3658
"""Replace the alias by the prefix in the given string.
3660
Using an unknown prefix is an error to help catching typos.
3662
parts = id_start.split('.')
3664
parts[0] = self.get(parts[0])
3666
raise errors.BzrCommandError(
3667
'%s is not a known test prefix alias' % parts[0])
3668
return '.'.join(parts)
3671
test_prefix_alias_registry = TestPrefixAliasRegistry()
3672
"""Registry of test prefix aliases."""
3675
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3676
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3677
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3679
# Obvious higest levels prefixes, feel free to add your own via a plugin
3680
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3681
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3682
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3683
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3684
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3687
def _test_suite_testmod_names():
3688
"""Return the standard list of test module names to test."""
3691
'bzrlib.tests.blackbox',
3692
'bzrlib.tests.commands',
3693
'bzrlib.tests.per_branch',
3694
'bzrlib.tests.per_bzrdir',
3695
'bzrlib.tests.per_foreign_vcs',
3696
'bzrlib.tests.per_interrepository',
3697
'bzrlib.tests.per_intertree',
3698
'bzrlib.tests.per_inventory',
3699
'bzrlib.tests.per_interbranch',
3700
'bzrlib.tests.per_lock',
3701
'bzrlib.tests.per_transport',
3702
'bzrlib.tests.per_tree',
3703
'bzrlib.tests.per_pack_repository',
3704
'bzrlib.tests.per_repository',
3705
'bzrlib.tests.per_repository_chk',
3706
'bzrlib.tests.per_repository_reference',
3707
'bzrlib.tests.per_uifactory',
3708
'bzrlib.tests.per_versionedfile',
3709
'bzrlib.tests.per_workingtree',
3710
'bzrlib.tests.test__annotator',
3711
'bzrlib.tests.test__chk_map',
3712
'bzrlib.tests.test__dirstate_helpers',
3713
'bzrlib.tests.test__groupcompress',
3714
'bzrlib.tests.test__known_graph',
3715
'bzrlib.tests.test__rio',
3716
'bzrlib.tests.test__simple_set',
3717
'bzrlib.tests.test__static_tuple',
3718
'bzrlib.tests.test__walkdirs_win32',
3719
'bzrlib.tests.test_ancestry',
3720
'bzrlib.tests.test_annotate',
3721
'bzrlib.tests.test_api',
3722
'bzrlib.tests.test_atomicfile',
3723
'bzrlib.tests.test_bad_files',
3724
'bzrlib.tests.test_bencode',
3725
'bzrlib.tests.test_bisect_multi',
3726
'bzrlib.tests.test_branch',
3727
'bzrlib.tests.test_branchbuilder',
3728
'bzrlib.tests.test_btree_index',
3729
'bzrlib.tests.test_bugtracker',
3730
'bzrlib.tests.test_bundle',
3731
'bzrlib.tests.test_bzrdir',
3732
'bzrlib.tests.test__chunks_to_lines',
3733
'bzrlib.tests.test_cache_utf8',
3734
'bzrlib.tests.test_chk_map',
3735
'bzrlib.tests.test_chk_serializer',
3736
'bzrlib.tests.test_chunk_writer',
3737
'bzrlib.tests.test_clean_tree',
3738
'bzrlib.tests.test_cleanup',
3739
'bzrlib.tests.test_commands',
3740
'bzrlib.tests.test_commit',
3741
'bzrlib.tests.test_commit_merge',
3742
'bzrlib.tests.test_config',
3743
'bzrlib.tests.test_conflicts',
3744
'bzrlib.tests.test_counted_lock',
3745
'bzrlib.tests.test_crash',
3746
'bzrlib.tests.test_decorators',
3747
'bzrlib.tests.test_delta',
3748
'bzrlib.tests.test_debug',
3749
'bzrlib.tests.test_deprecated_graph',
3750
'bzrlib.tests.test_diff',
3751
'bzrlib.tests.test_directory_service',
3752
'bzrlib.tests.test_dirstate',
3753
'bzrlib.tests.test_email_message',
3754
'bzrlib.tests.test_eol_filters',
3755
'bzrlib.tests.test_errors',
3756
'bzrlib.tests.test_export',
3757
'bzrlib.tests.test_extract',
3758
'bzrlib.tests.test_fetch',
3759
'bzrlib.tests.test_fifo_cache',
3760
'bzrlib.tests.test_filters',
3761
'bzrlib.tests.test_ftp_transport',
3762
'bzrlib.tests.test_foreign',
3763
'bzrlib.tests.test_generate_docs',
3764
'bzrlib.tests.test_generate_ids',
3765
'bzrlib.tests.test_globbing',
3766
'bzrlib.tests.test_gpg',
3767
'bzrlib.tests.test_graph',
3768
'bzrlib.tests.test_groupcompress',
3769
'bzrlib.tests.test_hashcache',
3770
'bzrlib.tests.test_help',
3771
'bzrlib.tests.test_hooks',
3772
'bzrlib.tests.test_http',
3773
'bzrlib.tests.test_http_response',
3774
'bzrlib.tests.test_https_ca_bundle',
3775
'bzrlib.tests.test_identitymap',
3776
'bzrlib.tests.test_ignores',
3777
'bzrlib.tests.test_index',
3778
'bzrlib.tests.test_info',
3779
'bzrlib.tests.test_inv',
3780
'bzrlib.tests.test_inventory_delta',
3781
'bzrlib.tests.test_knit',
3782
'bzrlib.tests.test_lazy_import',
3783
'bzrlib.tests.test_lazy_regex',
3784
'bzrlib.tests.test_lock',
3785
'bzrlib.tests.test_lockable_files',
3786
'bzrlib.tests.test_lockdir',
3787
'bzrlib.tests.test_log',
3788
'bzrlib.tests.test_lru_cache',
3789
'bzrlib.tests.test_lsprof',
3790
'bzrlib.tests.test_mail_client',
3791
'bzrlib.tests.test_memorytree',
3792
'bzrlib.tests.test_merge',
3793
'bzrlib.tests.test_merge3',
3794
'bzrlib.tests.test_merge_core',
3795
'bzrlib.tests.test_merge_directive',
3796
'bzrlib.tests.test_missing',
3797
'bzrlib.tests.test_msgeditor',
3798
'bzrlib.tests.test_multiparent',
3799
'bzrlib.tests.test_mutabletree',
3800
'bzrlib.tests.test_nonascii',
3801
'bzrlib.tests.test_options',
3802
'bzrlib.tests.test_osutils',
3803
'bzrlib.tests.test_osutils_encodings',
3804
'bzrlib.tests.test_pack',
3805
'bzrlib.tests.test_patch',
3806
'bzrlib.tests.test_patches',
3807
'bzrlib.tests.test_permissions',
3808
'bzrlib.tests.test_plugins',
3809
'bzrlib.tests.test_progress',
3810
'bzrlib.tests.test_read_bundle',
3811
'bzrlib.tests.test_reconcile',
3812
'bzrlib.tests.test_reconfigure',
3813
'bzrlib.tests.test_registry',
3814
'bzrlib.tests.test_remote',
3815
'bzrlib.tests.test_rename_map',
3816
'bzrlib.tests.test_repository',
3817
'bzrlib.tests.test_revert',
3818
'bzrlib.tests.test_revision',
3819
'bzrlib.tests.test_revisionspec',
3820
'bzrlib.tests.test_revisiontree',
3821
'bzrlib.tests.test_rio',
3822
'bzrlib.tests.test_rules',
3823
'bzrlib.tests.test_sampler',
3824
'bzrlib.tests.test_script',
3825
'bzrlib.tests.test_selftest',
3826
'bzrlib.tests.test_serializer',
3827
'bzrlib.tests.test_setup',
3828
'bzrlib.tests.test_sftp_transport',
3829
'bzrlib.tests.test_shelf',
3830
'bzrlib.tests.test_shelf_ui',
3831
'bzrlib.tests.test_smart',
3832
'bzrlib.tests.test_smart_add',
3833
'bzrlib.tests.test_smart_request',
3834
'bzrlib.tests.test_smart_transport',
3835
'bzrlib.tests.test_smtp_connection',
3836
'bzrlib.tests.test_source',
3837
'bzrlib.tests.test_ssh_transport',
3838
'bzrlib.tests.test_status',
3839
'bzrlib.tests.test_store',
3840
'bzrlib.tests.test_strace',
3841
'bzrlib.tests.test_subsume',
3842
'bzrlib.tests.test_switch',
3843
'bzrlib.tests.test_symbol_versioning',
3844
'bzrlib.tests.test_tag',
3845
'bzrlib.tests.test_testament',
3846
'bzrlib.tests.test_textfile',
3847
'bzrlib.tests.test_textmerge',
3848
'bzrlib.tests.test_timestamp',
3849
'bzrlib.tests.test_trace',
3850
'bzrlib.tests.test_transactions',
3851
'bzrlib.tests.test_transform',
3852
'bzrlib.tests.test_transport',
3853
'bzrlib.tests.test_transport_log',
3854
'bzrlib.tests.test_tree',
3855
'bzrlib.tests.test_treebuilder',
3856
'bzrlib.tests.test_tsort',
3857
'bzrlib.tests.test_tuned_gzip',
3858
'bzrlib.tests.test_ui',
3859
'bzrlib.tests.test_uncommit',
3860
'bzrlib.tests.test_upgrade',
3861
'bzrlib.tests.test_upgrade_stacked',
3862
'bzrlib.tests.test_urlutils',
3863
'bzrlib.tests.test_version',
3864
'bzrlib.tests.test_version_info',
3865
'bzrlib.tests.test_weave',
3866
'bzrlib.tests.test_whitebox',
3867
'bzrlib.tests.test_win32utils',
3868
'bzrlib.tests.test_workingtree',
3869
'bzrlib.tests.test_workingtree_4',
3870
'bzrlib.tests.test_wsgi',
3871
'bzrlib.tests.test_xml',
3875
def _test_suite_modules_to_doctest():
3876
"""Return the list of modules to doctest."""
3879
'bzrlib.branchbuilder',
3882
'bzrlib.iterablefile',
3886
'bzrlib.symbol_versioning',
3889
'bzrlib.version_info_formats.format_custom',
3893
def test_suite(keep_only=None, starting_with=None):
3894
"""Build and return TestSuite for the whole of bzrlib.
3896
:param keep_only: A list of test ids limiting the suite returned.
3898
:param starting_with: An id limiting the suite returned to the tests
3901
This function can be replaced if you need to change the default test
3902
suite on a global basis, but it is not encouraged.
3905
loader = TestUtil.TestLoader()
3907
if keep_only is not None:
3908
id_filter = TestIdList(keep_only)
3910
# We take precedence over keep_only because *at loading time* using
3911
# both options means we will load less tests for the same final result.
3912
def interesting_module(name):
3913
for start in starting_with:
3915
# Either the module name starts with the specified string
3916
name.startswith(start)
3917
# or it may contain tests starting with the specified string
3918
or start.startswith(name)
3922
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3924
elif keep_only is not None:
3925
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3926
def interesting_module(name):
3927
return id_filter.refers_to(name)
3930
loader = TestUtil.TestLoader()
3931
def interesting_module(name):
3932
# No filtering, all modules are interesting
3935
suite = loader.suiteClass()
3937
# modules building their suite with loadTestsFromModuleNames
3938
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3940
for mod in _test_suite_modules_to_doctest():
3941
if not interesting_module(mod):
3942
# No tests to keep here, move along
3945
# note that this really does mean "report only" -- doctest
3946
# still runs the rest of the examples
3947
doc_suite = doctest.DocTestSuite(mod,
3948
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3949
except ValueError, e:
3950
print '**failed to get doctest for: %s\n%s' % (mod, e)
3952
if len(doc_suite._tests) == 0:
3953
raise errors.BzrError("no doctests found in %s" % (mod,))
3954
suite.addTest(doc_suite)
3956
default_encoding = sys.getdefaultencoding()
3957
for name, plugin in bzrlib.plugin.plugins().items():
3958
if not interesting_module(plugin.module.__name__):
3960
plugin_suite = plugin.test_suite()
3961
# We used to catch ImportError here and turn it into just a warning,
3962
# but really if you don't have --no-plugins this should be a failure.
3963
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3964
if plugin_suite is None:
3965
plugin_suite = plugin.load_plugin_tests(loader)
3966
if plugin_suite is not None:
3967
suite.addTest(plugin_suite)
3968
if default_encoding != sys.getdefaultencoding():
3969
bzrlib.trace.warning(
3970
'Plugin "%s" tried to reset default encoding to: %s', name,
3971
sys.getdefaultencoding())
3973
sys.setdefaultencoding(default_encoding)
3975
if keep_only is not None:
3976
# Now that the referred modules have loaded their tests, keep only the
3978
suite = filter_suite_by_id_list(suite, id_filter)
3979
# Do some sanity checks on the id_list filtering
3980
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3982
# The tester has used both keep_only and starting_with, so he is
3983
# already aware that some tests are excluded from the list, there
3984
# is no need to tell him which.
3987
# Some tests mentioned in the list are not in the test suite. The
3988
# list may be out of date, report to the tester.
3989
for id in not_found:
3990
bzrlib.trace.warning('"%s" not found in the test suite', id)
3991
for id in duplicates:
3992
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3997
def multiply_scenarios(scenarios_left, scenarios_right):
3998
"""Multiply two sets of scenarios.
4000
:returns: the cartesian product of the two sets of scenarios, that is
4001
a scenario for every possible combination of a left scenario and a
4005
('%s,%s' % (left_name, right_name),
4006
dict(left_dict.items() + right_dict.items()))
4007
for left_name, left_dict in scenarios_left
4008
for right_name, right_dict in scenarios_right]
4011
def multiply_tests(tests, scenarios, result):
4012
"""Multiply tests_list by scenarios into result.
4014
This is the core workhorse for test parameterisation.
4016
Typically the load_tests() method for a per-implementation test suite will
4017
call multiply_tests and return the result.
4019
:param tests: The tests to parameterise.
4020
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4021
scenario_param_dict).
4022
:param result: A TestSuite to add created tests to.
4024
This returns the passed in result TestSuite with the cross product of all
4025
the tests repeated once for each scenario. Each test is adapted by adding
4026
the scenario name at the end of its id(), and updating the test object's
4027
__dict__ with the scenario_param_dict.
4029
>>> import bzrlib.tests.test_sampler
4030
>>> r = multiply_tests(
4031
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4032
... [('one', dict(param=1)),
4033
... ('two', dict(param=2))],
4035
>>> tests = list(iter_suite_tests(r))
4039
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4045
for test in iter_suite_tests(tests):
4046
apply_scenarios(test, scenarios, result)
4050
def apply_scenarios(test, scenarios, result):
4051
"""Apply the scenarios in scenarios to test and add to result.
4053
:param test: The test to apply scenarios to.
4054
:param scenarios: An iterable of scenarios to apply to test.
4056
:seealso: apply_scenario
4058
for scenario in scenarios:
4059
result.addTest(apply_scenario(test, scenario))
4063
def apply_scenario(test, scenario):
4064
"""Copy test and apply scenario to it.
4066
:param test: A test to adapt.
4067
:param scenario: A tuple describing the scenarion.
4068
The first element of the tuple is the new test id.
4069
The second element is a dict containing attributes to set on the
4071
:return: The adapted test.
4073
new_id = "%s(%s)" % (test.id(), scenario[0])
4074
new_test = clone_test(test, new_id)
4075
for name, value in scenario[1].items():
4076
setattr(new_test, name, value)
4080
def clone_test(test, new_id):
4081
"""Clone a test giving it a new id.
4083
:param test: The test to clone.
4084
:param new_id: The id to assign to it.
4085
:return: The new test.
4087
new_test = copy(test)
4088
new_test.id = lambda: new_id
4092
def _rmtree_temp_dir(dirname):
4093
# If LANG=C we probably have created some bogus paths
4094
# which rmtree(unicode) will fail to delete
4095
# so make sure we are using rmtree(str) to delete everything
4096
# except on win32, where rmtree(str) will fail
4097
# since it doesn't have the property of byte-stream paths
4098
# (they are either ascii or mbcs)
4099
if sys.platform == 'win32':
4100
# make sure we are using the unicode win32 api
4101
dirname = unicode(dirname)
4103
dirname = dirname.encode(sys.getfilesystemencoding())
4105
osutils.rmtree(dirname)
4107
# We don't want to fail here because some useful display will be lost
4108
# otherwise. Polluting the tmp dir is bad, but not giving all the
4109
# possible info to the test runner is even worse.
4110
sys.stderr.write('Unable to remove testing dir %s\n%s'
4111
% (os.path.basename(dirname), e))
4114
class Feature(object):
4115
"""An operating system Feature."""
4118
self._available = None
4120
def available(self):
4121
"""Is the feature available?
4123
:return: True if the feature is available.
4125
if self._available is None:
4126
self._available = self._probe()
4127
return self._available
4130
"""Implement this method in concrete features.
4132
:return: True if the feature is available.
4134
raise NotImplementedError
4137
if getattr(self, 'feature_name', None):
4138
return self.feature_name()
4139
return self.__class__.__name__
4142
class _SymlinkFeature(Feature):
4145
return osutils.has_symlinks()
4147
def feature_name(self):
4150
SymlinkFeature = _SymlinkFeature()
4153
class _HardlinkFeature(Feature):
4156
return osutils.has_hardlinks()
4158
def feature_name(self):
4161
HardlinkFeature = _HardlinkFeature()
4164
class _OsFifoFeature(Feature):
4167
return getattr(os, 'mkfifo', None)
4169
def feature_name(self):
4170
return 'filesystem fifos'
4172
OsFifoFeature = _OsFifoFeature()
4175
class _UnicodeFilenameFeature(Feature):
4176
"""Does the filesystem support Unicode filenames?"""
4180
# Check for character combinations unlikely to be covered by any
4181
# single non-unicode encoding. We use the characters
4182
# - greek small letter alpha (U+03B1) and
4183
# - braille pattern dots-123456 (U+283F).
4184
os.stat(u'\u03b1\u283f')
4185
except UnicodeEncodeError:
4187
except (IOError, OSError):
4188
# The filesystem allows the Unicode filename but the file doesn't
4192
# The filesystem allows the Unicode filename and the file exists,
4196
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4199
def probe_unicode_in_user_encoding():
4200
"""Try to encode several unicode strings to use in unicode-aware tests.
4201
Return first successfull match.
4203
:return: (unicode value, encoded plain string value) or (None, None)
4205
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4206
for uni_val in possible_vals:
4208
str_val = uni_val.encode(osutils.get_user_encoding())
4209
except UnicodeEncodeError:
4210
# Try a different character
4213
return uni_val, str_val
4217
def probe_bad_non_ascii(encoding):
4218
"""Try to find [bad] character with code [128..255]
4219
that cannot be decoded to unicode in some encoding.
4220
Return None if all non-ascii characters is valid
4223
for i in xrange(128, 256):
4226
char.decode(encoding)
4227
except UnicodeDecodeError:
4232
class _HTTPSServerFeature(Feature):
4233
"""Some tests want an https Server, check if one is available.
4235
Right now, the only way this is available is under python2.6 which provides
4246
def feature_name(self):
4247
return 'HTTPSServer'
4250
HTTPSServerFeature = _HTTPSServerFeature()
4253
class _ParamikoFeature(Feature):
4254
"""Is paramiko available?"""
4258
from bzrlib.transport.sftp import SFTPAbsoluteServer
4260
except errors.ParamikoNotPresent:
4263
def feature_name(self):
4267
ParamikoFeature = _ParamikoFeature()
4270
class _UnicodeFilename(Feature):
4271
"""Does the filesystem support Unicode filenames?"""
4276
except UnicodeEncodeError:
4278
except (IOError, OSError):
4279
# The filesystem allows the Unicode filename but the file doesn't
4283
# The filesystem allows the Unicode filename and the file exists,
4287
UnicodeFilename = _UnicodeFilename()
4290
class _UTF8Filesystem(Feature):
4291
"""Is the filesystem UTF-8?"""
4294
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4298
UTF8Filesystem = _UTF8Filesystem()
4301
class _BreakinFeature(Feature):
4302
"""Does this platform support the breakin feature?"""
4305
from bzrlib import breakin
4306
if breakin.determine_signal() is None:
4308
if sys.platform == 'win32':
4309
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4310
# We trigger SIGBREAK via a Console api so we need ctypes to
4311
# access the function
4316
def feature_name(self):
4317
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4320
BreakinFeature = _BreakinFeature()
4323
class _CaseInsCasePresFilenameFeature(Feature):
4324
"""Is the file-system case insensitive, but case-preserving?"""
4327
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4329
# first check truly case-preserving for created files, then check
4330
# case insensitive when opening existing files.
4331
name = osutils.normpath(name)
4332
base, rel = osutils.split(name)
4333
found_rel = osutils.canonical_relpath(base, name)
4334
return (found_rel == rel
4335
and os.path.isfile(name.upper())
4336
and os.path.isfile(name.lower()))
4341
def feature_name(self):
4342
return "case-insensitive case-preserving filesystem"
4344
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4347
class _CaseInsensitiveFilesystemFeature(Feature):
4348
"""Check if underlying filesystem is case-insensitive but *not* case
4351
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4352
# more likely to be case preserving, so this case is rare.
4355
if CaseInsCasePresFilenameFeature.available():
4358
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4359
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4360
TestCaseWithMemoryTransport.TEST_ROOT = root
4362
root = TestCaseWithMemoryTransport.TEST_ROOT
4363
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4365
name_a = osutils.pathjoin(tdir, 'a')
4366
name_A = osutils.pathjoin(tdir, 'A')
4368
result = osutils.isdir(name_A)
4369
_rmtree_temp_dir(tdir)
4372
def feature_name(self):
4373
return 'case-insensitive filesystem'
4375
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4378
class _SubUnitFeature(Feature):
4379
"""Check if subunit is available."""
4388
def feature_name(self):
4391
SubUnitFeature = _SubUnitFeature()
4392
# Only define SubUnitBzrRunner if subunit is available.
4394
from subunit import TestProtocolClient
4396
from subunit.test_results import AutoTimingTestResultDecorator
4398
AutoTimingTestResultDecorator = lambda x:x
4399
class SubUnitBzrRunner(TextTestRunner):
4400
def run(self, test):
4401
result = AutoTimingTestResultDecorator(
4402
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
