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
'st_size did not match')
1120
self.assertEqual(expected.st_mtime, actual.st_mtime,
1121
'st_mtime did not match')
1122
self.assertEqual(expected.st_ctime, actual.st_ctime,
1123
'st_ctime did not match')
1124
if sys.platform != 'win32':
1125
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1126
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1127
# odd. Regardless we shouldn't actually try to assert anything
1128
# about their values
1129
self.assertEqual(expected.st_dev, actual.st_dev,
1130
'st_dev did not match')
1131
self.assertEqual(expected.st_ino, actual.st_ino,
1132
'st_ino did not match')
1133
self.assertEqual(expected.st_mode, actual.st_mode,
1134
'st_mode did not match')
1136
def assertLength(self, length, obj_with_len):
1137
"""Assert that obj_with_len is of length length."""
1138
if len(obj_with_len) != length:
1139
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1140
length, len(obj_with_len), obj_with_len))
1142
def assertLogsError(self, exception_class, func, *args, **kwargs):
1143
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1145
from bzrlib import trace
1147
orig_log_exception_quietly = trace.log_exception_quietly
1150
orig_log_exception_quietly()
1151
captured.append(sys.exc_info())
1152
trace.log_exception_quietly = capture
1153
func(*args, **kwargs)
1155
trace.log_exception_quietly = orig_log_exception_quietly
1156
self.assertLength(1, captured)
1157
err = captured[0][1]
1158
self.assertIsInstance(err, exception_class)
1161
def assertPositive(self, val):
1162
"""Assert that val is greater than 0."""
1163
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1165
def assertNegative(self, val):
1166
"""Assert that val is less than 0."""
1167
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1169
def assertStartsWith(self, s, prefix):
1170
if not s.startswith(prefix):
1171
raise AssertionError('string %r does not start with %r' % (s, prefix))
1173
def assertEndsWith(self, s, suffix):
1174
"""Asserts that s ends with suffix."""
1175
if not s.endswith(suffix):
1176
raise AssertionError('string %r does not end with %r' % (s, suffix))
1178
def assertContainsRe(self, haystack, needle_re, flags=0):
1179
"""Assert that a contains something matching a regular expression."""
1180
if not re.search(needle_re, haystack, flags):
1181
if '\n' in haystack or len(haystack) > 60:
1182
# a long string, format it in a more readable way
1183
raise AssertionError(
1184
'pattern "%s" not found in\n"""\\\n%s"""\n'
1185
% (needle_re, haystack))
1187
raise AssertionError('pattern "%s" not found in "%s"'
1188
% (needle_re, haystack))
1190
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1191
"""Assert that a does not match a regular expression"""
1192
if re.search(needle_re, haystack, flags):
1193
raise AssertionError('pattern "%s" found in "%s"'
1194
% (needle_re, haystack))
1196
def assertSubset(self, sublist, superlist):
1197
"""Assert that every entry in sublist is present in superlist."""
1198
missing = set(sublist) - set(superlist)
1199
if len(missing) > 0:
1200
raise AssertionError("value(s) %r not present in container %r" %
1201
(missing, superlist))
1203
def assertListRaises(self, excClass, func, *args, **kwargs):
1204
"""Fail unless excClass is raised when the iterator from func is used.
1206
Many functions can return generators this makes sure
1207
to wrap them in a list() call to make sure the whole generator
1208
is run, and that the proper exception is raised.
1211
list(func(*args, **kwargs))
1215
if getattr(excClass,'__name__', None) is not None:
1216
excName = excClass.__name__
1218
excName = str(excClass)
1219
raise self.failureException, "%s not raised" % excName
1221
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1222
"""Assert that a callable raises a particular exception.
1224
:param excClass: As for the except statement, this may be either an
1225
exception class, or a tuple of classes.
1226
:param callableObj: A callable, will be passed ``*args`` and
1229
Returns the exception so that you can examine it.
1232
callableObj(*args, **kwargs)
1236
if getattr(excClass,'__name__', None) is not None:
1237
excName = excClass.__name__
1240
excName = str(excClass)
1241
raise self.failureException, "%s not raised" % excName
1243
def assertIs(self, left, right, message=None):
1244
if not (left is right):
1245
if message is not None:
1246
raise AssertionError(message)
1248
raise AssertionError("%r is not %r." % (left, right))
1250
def assertIsNot(self, left, right, message=None):
1252
if message is not None:
1253
raise AssertionError(message)
1255
raise AssertionError("%r is %r." % (left, right))
1257
def assertTransportMode(self, transport, path, mode):
1258
"""Fail if a path does not have mode "mode".
1260
If modes are not supported on this transport, the assertion is ignored.
1262
if not transport._can_roundtrip_unix_modebits():
1264
path_stat = transport.stat(path)
1265
actual_mode = stat.S_IMODE(path_stat.st_mode)
1266
self.assertEqual(mode, actual_mode,
1267
'mode of %r incorrect (%s != %s)'
1268
% (path, oct(mode), oct(actual_mode)))
1270
def assertIsSameRealPath(self, path1, path2):
1271
"""Fail if path1 and path2 points to different files"""
1272
self.assertEqual(osutils.realpath(path1),
1273
osutils.realpath(path2),
1274
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1276
def assertIsInstance(self, obj, kls, msg=None):
1277
"""Fail if obj is not an instance of kls
1279
:param msg: Supplementary message to show if the assertion fails.
1281
if not isinstance(obj, kls):
1282
m = "%r is an instance of %s rather than %s" % (
1283
obj, obj.__class__, kls)
1288
def expectFailure(self, reason, assertion, *args, **kwargs):
1289
"""Invoke a test, expecting it to fail for the given reason.
1291
This is for assertions that ought to succeed, but currently fail.
1292
(The failure is *expected* but not *wanted*.) Please be very precise
1293
about the failure you're expecting. If a new bug is introduced,
1294
AssertionError should be raised, not KnownFailure.
1296
Frequently, expectFailure should be followed by an opposite assertion.
1299
Intended to be used with a callable that raises AssertionError as the
1300
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1302
Raises KnownFailure if the test fails. Raises AssertionError if the
1307
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1309
self.assertEqual(42, dynamic_val)
1311
This means that a dynamic_val of 54 will cause the test to raise
1312
a KnownFailure. Once math is fixed and the expectFailure is removed,
1313
only a dynamic_val of 42 will allow the test to pass. Anything other
1314
than 54 or 42 will cause an AssertionError.
1317
assertion(*args, **kwargs)
1318
except AssertionError:
1319
raise KnownFailure(reason)
1321
self.fail('Unexpected success. Should have failed: %s' % reason)
1323
def assertFileEqual(self, content, path):
1324
"""Fail if path does not contain 'content'."""
1325
self.failUnlessExists(path)
1326
f = file(path, 'rb')
1331
self.assertEqualDiff(content, s)
1333
def failUnlessExists(self, path):
1334
"""Fail unless path or paths, which may be abs or relative, exist."""
1335
if not isinstance(path, basestring):
1337
self.failUnlessExists(p)
1339
self.failUnless(osutils.lexists(path),path+" does not exist")
1341
def failIfExists(self, path):
1342
"""Fail if path or paths, which may be abs or relative, exist."""
1343
if not isinstance(path, basestring):
1345
self.failIfExists(p)
1347
self.failIf(osutils.lexists(path),path+" exists")
1349
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1350
"""A helper for callDeprecated and applyDeprecated.
1352
:param a_callable: A callable to call.
1353
:param args: The positional arguments for the callable
1354
:param kwargs: The keyword arguments for the callable
1355
:return: A tuple (warnings, result). result is the result of calling
1356
a_callable(``*args``, ``**kwargs``).
1359
def capture_warnings(msg, cls=None, stacklevel=None):
1360
# we've hooked into a deprecation specific callpath,
1361
# only deprecations should getting sent via it.
1362
self.assertEqual(cls, DeprecationWarning)
1363
local_warnings.append(msg)
1364
original_warning_method = symbol_versioning.warn
1365
symbol_versioning.set_warning_method(capture_warnings)
1367
result = a_callable(*args, **kwargs)
1369
symbol_versioning.set_warning_method(original_warning_method)
1370
return (local_warnings, result)
1372
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1373
"""Call a deprecated callable without warning the user.
1375
Note that this only captures warnings raised by symbol_versioning.warn,
1376
not other callers that go direct to the warning module.
1378
To test that a deprecated method raises an error, do something like
1381
self.assertRaises(errors.ReservedId,
1382
self.applyDeprecated,
1383
deprecated_in((1, 5, 0)),
1387
:param deprecation_format: The deprecation format that the callable
1388
should have been deprecated with. This is the same type as the
1389
parameter to deprecated_method/deprecated_function. If the
1390
callable is not deprecated with this format, an assertion error
1392
:param a_callable: A callable to call. This may be a bound method or
1393
a regular function. It will be called with ``*args`` and
1395
:param args: The positional arguments for the callable
1396
:param kwargs: The keyword arguments for the callable
1397
:return: The result of a_callable(``*args``, ``**kwargs``)
1399
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1401
expected_first_warning = symbol_versioning.deprecation_string(
1402
a_callable, deprecation_format)
1403
if len(call_warnings) == 0:
1404
self.fail("No deprecation warning generated by call to %s" %
1406
self.assertEqual(expected_first_warning, call_warnings[0])
1409
def callCatchWarnings(self, fn, *args, **kw):
1410
"""Call a callable that raises python warnings.
1412
The caller's responsible for examining the returned warnings.
1414
If the callable raises an exception, the exception is not
1415
caught and propagates up to the caller. In that case, the list
1416
of warnings is not available.
1418
:returns: ([warning_object, ...], fn_result)
1420
# XXX: This is not perfect, because it completely overrides the
1421
# warnings filters, and some code may depend on suppressing particular
1422
# warnings. It's the easiest way to insulate ourselves from -Werror,
1423
# though. -- Andrew, 20071062
1425
def _catcher(message, category, filename, lineno, file=None, line=None):
1426
# despite the name, 'message' is normally(?) a Warning subclass
1428
wlist.append(message)
1429
saved_showwarning = warnings.showwarning
1430
saved_filters = warnings.filters
1432
warnings.showwarning = _catcher
1433
warnings.filters = []
1434
result = fn(*args, **kw)
1436
warnings.showwarning = saved_showwarning
1437
warnings.filters = saved_filters
1438
return wlist, result
1440
def callDeprecated(self, expected, callable, *args, **kwargs):
1441
"""Assert that a callable is deprecated in a particular way.
1443
This is a very precise test for unusual requirements. The
1444
applyDeprecated helper function is probably more suited for most tests
1445
as it allows you to simply specify the deprecation format being used
1446
and will ensure that that is issued for the function being called.
1448
Note that this only captures warnings raised by symbol_versioning.warn,
1449
not other callers that go direct to the warning module. To catch
1450
general warnings, use callCatchWarnings.
1452
:param expected: a list of the deprecation warnings expected, in order
1453
:param callable: The callable to call
1454
:param args: The positional arguments for the callable
1455
:param kwargs: The keyword arguments for the callable
1457
call_warnings, result = self._capture_deprecation_warnings(callable,
1459
self.assertEqual(expected, call_warnings)
1462
def _startLogFile(self):
1463
"""Send bzr and test log messages to a temporary file.
1465
The file is removed as the test is torn down.
1467
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1468
self._log_file = os.fdopen(fileno, 'w+')
1469
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1470
self._log_file_name = name
1471
self.addCleanup(self._finishLogFile)
1473
def _finishLogFile(self):
1474
"""Finished with the log file.
1476
Close the file and delete it, unless setKeepLogfile was called.
1478
if self._log_file is None:
1480
bzrlib.trace.pop_log_file(self._log_memento)
1481
self._log_file.close()
1482
self._log_file = None
1483
if not self._keep_log_file:
1484
os.remove(self._log_file_name)
1485
self._log_file_name = None
1487
def setKeepLogfile(self):
1488
"""Make the logfile not be deleted when _finishLogFile is called."""
1489
self._keep_log_file = True
1491
def thisFailsStrictLockCheck(self):
1492
"""It is known that this test would fail with -Dstrict_locks.
1494
By default, all tests are run with strict lock checking unless
1495
-Edisable_lock_checks is supplied. However there are some tests which
1496
we know fail strict locks at this point that have not been fixed.
1497
They should call this function to disable the strict checking.
1499
This should be used sparingly, it is much better to fix the locking
1500
issues rather than papering over the problem by calling this function.
1502
debug.debug_flags.discard('strict_locks')
1504
def addCleanup(self, callable, *args, **kwargs):
1505
"""Arrange to run a callable when this case is torn down.
1507
Callables are run in the reverse of the order they are registered,
1508
ie last-in first-out.
1510
self._cleanups.append((callable, args, kwargs))
1512
def _cleanEnvironment(self):
1514
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1515
'HOME': os.getcwd(),
1516
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1517
# tests do check our impls match APPDATA
1518
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1522
'BZREMAIL': None, # may still be present in the environment
1524
'BZR_PROGRESS_BAR': None,
1526
'BZR_PLUGIN_PATH': None,
1527
# Make sure that any text ui tests are consistent regardless of
1528
# the environment the test case is run in; you may want tests that
1529
# test other combinations. 'dumb' is a reasonable guess for tests
1530
# going to a pipe or a StringIO.
1535
'SSH_AUTH_SOCK': None,
1539
'https_proxy': None,
1540
'HTTPS_PROXY': None,
1545
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1546
# least. If you do (care), please update this comment
1550
'BZR_REMOTE_PATH': None,
1553
self.addCleanup(self._restoreEnvironment)
1554
for name, value in new_env.iteritems():
1555
self._captureVar(name, value)
1557
def _captureVar(self, name, newvalue):
1558
"""Set an environment variable, and reset it when finished."""
1559
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1561
def _restore_debug_flags(self):
1562
debug.debug_flags.clear()
1563
debug.debug_flags.update(self._preserved_debug_flags)
1565
def _restoreEnvironment(self):
1566
for name, value in self.__old_env.iteritems():
1567
osutils.set_or_unset_env(name, value)
1569
def _restoreHooks(self):
1570
for klass, (name, hooks) in self._preserved_hooks.items():
1571
setattr(klass, name, hooks)
1573
def knownFailure(self, reason):
1574
"""This test has failed for some known reason."""
1575
raise KnownFailure(reason)
1577
def _do_skip(self, result, reason):
1578
addSkip = getattr(result, 'addSkip', None)
1579
if not callable(addSkip):
1580
result.addSuccess(result)
1582
addSkip(self, reason)
1584
def _do_known_failure(self, result):
1585
err = sys.exc_info()
1586
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1587
if addExpectedFailure is not None:
1588
addExpectedFailure(self, err)
1590
result.addSuccess(self)
1592
def _do_not_applicable(self, result, e):
1594
reason = 'No reason given'
1597
addNotApplicable = getattr(result, 'addNotApplicable', None)
1598
if addNotApplicable is not None:
1599
result.addNotApplicable(self, reason)
1601
self._do_skip(result, reason)
1603
def _do_unsupported_or_skip(self, result, reason):
1604
addNotSupported = getattr(result, 'addNotSupported', None)
1605
if addNotSupported is not None:
1606
result.addNotSupported(self, reason)
1608
self._do_skip(result, reason)
1610
def run(self, result=None):
1611
if result is None: result = self.defaultTestResult()
1612
result.startTest(self)
1617
result.stopTest(self)
1619
def _run(self, result):
1620
for feature in getattr(self, '_test_needs_features', []):
1621
if not feature.available():
1622
return self._do_unsupported_or_skip(result, feature)
1624
absent_attr = object()
1626
method_name = getattr(self, '_testMethodName', absent_attr)
1627
if method_name is absent_attr:
1629
method_name = getattr(self, '_TestCase__testMethodName')
1630
testMethod = getattr(self, method_name)
1634
if not self._bzr_test_setUp_run:
1636
"test setUp did not invoke "
1637
"bzrlib.tests.TestCase's setUp")
1638
except KeyboardInterrupt:
1641
except KnownFailure:
1642
self._do_known_failure(result)
1645
except TestNotApplicable, e:
1646
self._do_not_applicable(result, e)
1649
except TestSkipped, e:
1650
self._do_skip(result, e.args[0])
1653
except UnavailableFeature, e:
1654
self._do_unsupported_or_skip(result, e.args[0])
1658
result.addError(self, sys.exc_info())
1666
except KnownFailure:
1667
self._do_known_failure(result)
1668
except self.failureException:
1669
result.addFailure(self, sys.exc_info())
1670
except TestNotApplicable, e:
1671
self._do_not_applicable(result, e)
1672
except TestSkipped, e:
1674
reason = "No reason given."
1677
self._do_skip(result, reason)
1678
except UnavailableFeature, e:
1679
self._do_unsupported_or_skip(result, e.args[0])
1680
except KeyboardInterrupt:
1684
result.addError(self, sys.exc_info())
1688
if not self._bzr_test_tearDown_run:
1690
"test tearDown did not invoke "
1691
"bzrlib.tests.TestCase's tearDown")
1692
except KeyboardInterrupt:
1696
result.addError(self, sys.exc_info())
1699
if ok: result.addSuccess(self)
1701
except KeyboardInterrupt:
1706
for attr_name in self.attrs_to_keep:
1707
if attr_name in self.__dict__:
1708
saved_attrs[attr_name] = self.__dict__[attr_name]
1709
self.__dict__ = saved_attrs
1713
self._log_contents = ''
1714
self._bzr_test_tearDown_run = True
1715
unittest.TestCase.tearDown(self)
1717
def time(self, callable, *args, **kwargs):
1718
"""Run callable and accrue the time it takes to the benchmark time.
1720
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1721
this will cause lsprofile statistics to be gathered and stored in
1724
if self._benchtime is None:
1728
if not self._gather_lsprof_in_benchmarks:
1729
return callable(*args, **kwargs)
1731
# record this benchmark
1732
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1734
self._benchcalls.append(((callable, args, kwargs), stats))
1737
self._benchtime += time.time() - start
1739
def _runCleanups(self):
1740
"""Run registered cleanup functions.
1742
This should only be called from TestCase.tearDown.
1744
# TODO: Perhaps this should keep running cleanups even if
1745
# one of them fails?
1747
# Actually pop the cleanups from the list so tearDown running
1748
# twice is safe (this happens for skipped tests).
1749
while self._cleanups:
1750
cleanup, args, kwargs = self._cleanups.pop()
1751
cleanup(*args, **kwargs)
1753
def log(self, *args):
1756
def _get_log(self, keep_log_file=False):
1757
"""Get the log from bzrlib.trace calls from this test.
1759
:param keep_log_file: When True, if the log is still a file on disk
1760
leave it as a file on disk. When False, if the log is still a file
1761
on disk, the log file is deleted and the log preserved as
1763
:return: A string containing the log.
1765
# flush the log file, to get all content
1767
if bzrlib.trace._trace_file:
1768
bzrlib.trace._trace_file.flush()
1769
if self._log_contents:
1770
# XXX: this can hardly contain the content flushed above --vila
1772
return self._log_contents
1773
if self._log_file_name is not None:
1774
logfile = open(self._log_file_name)
1776
log_contents = logfile.read()
1779
if not keep_log_file:
1780
self._log_contents = log_contents
1782
os.remove(self._log_file_name)
1784
if sys.platform == 'win32' and e.errno == errno.EACCES:
1785
sys.stderr.write(('Unable to delete log file '
1786
' %r\n' % self._log_file_name))
1791
return "DELETED log file to reduce memory footprint"
1793
def requireFeature(self, feature):
1794
"""This test requires a specific feature is available.
1796
:raises UnavailableFeature: When feature is not available.
1798
if not feature.available():
1799
raise UnavailableFeature(feature)
1801
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1803
"""Run bazaar command line, splitting up a string command line."""
1804
if isinstance(args, basestring):
1805
# shlex don't understand unicode strings,
1806
# so args should be plain string (bialix 20070906)
1807
args = list(shlex.split(str(args)))
1808
return self._run_bzr_core(args, retcode=retcode,
1809
encoding=encoding, stdin=stdin, working_dir=working_dir,
1812
def _run_bzr_core(self, args, retcode, encoding, stdin,
1814
# Clear chk_map page cache, because the contents are likely to mask
1816
chk_map.clear_cache()
1817
if encoding is None:
1818
encoding = osutils.get_user_encoding()
1819
stdout = StringIOWrapper()
1820
stderr = StringIOWrapper()
1821
stdout.encoding = encoding
1822
stderr.encoding = encoding
1824
self.log('run bzr: %r', args)
1825
# FIXME: don't call into logging here
1826
handler = logging.StreamHandler(stderr)
1827
handler.setLevel(logging.INFO)
1828
logger = logging.getLogger('')
1829
logger.addHandler(handler)
1830
old_ui_factory = ui.ui_factory
1831
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1834
if working_dir is not None:
1835
cwd = osutils.getcwd()
1836
os.chdir(working_dir)
1839
result = self.apply_redirected(ui.ui_factory.stdin,
1841
bzrlib.commands.run_bzr_catch_user_errors,
1844
logger.removeHandler(handler)
1845
ui.ui_factory = old_ui_factory
1849
out = stdout.getvalue()
1850
err = stderr.getvalue()
1852
self.log('output:\n%r', out)
1854
self.log('errors:\n%r', err)
1855
if retcode is not None:
1856
self.assertEquals(retcode, result,
1857
message='Unexpected return code')
1858
return result, out, err
1860
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1861
working_dir=None, error_regexes=[], output_encoding=None):
1862
"""Invoke bzr, as if it were run from the command line.
1864
The argument list should not include the bzr program name - the
1865
first argument is normally the bzr command. Arguments may be
1866
passed in three ways:
1868
1- A list of strings, eg ["commit", "a"]. This is recommended
1869
when the command contains whitespace or metacharacters, or
1870
is built up at run time.
1872
2- A single string, eg "add a". This is the most convenient
1873
for hardcoded commands.
1875
This runs bzr through the interface that catches and reports
1876
errors, and with logging set to something approximating the
1877
default, so that error reporting can be checked.
1879
This should be the main method for tests that want to exercise the
1880
overall behavior of the bzr application (rather than a unit test
1881
or a functional test of the library.)
1883
This sends the stdout/stderr results into the test's log,
1884
where it may be useful for debugging. See also run_captured.
1886
:keyword stdin: A string to be used as stdin for the command.
1887
:keyword retcode: The status code the command should return;
1889
:keyword working_dir: The directory to run the command in
1890
:keyword error_regexes: A list of expected error messages. If
1891
specified they must be seen in the error output of the command.
1893
retcode, out, err = self._run_bzr_autosplit(
1898
working_dir=working_dir,
1900
self.assertIsInstance(error_regexes, (list, tuple))
1901
for regex in error_regexes:
1902
self.assertContainsRe(err, regex)
1905
def run_bzr_error(self, error_regexes, *args, **kwargs):
1906
"""Run bzr, and check that stderr contains the supplied regexes
1908
:param error_regexes: Sequence of regular expressions which
1909
must each be found in the error output. The relative ordering
1911
:param args: command-line arguments for bzr
1912
:param kwargs: Keyword arguments which are interpreted by run_bzr
1913
This function changes the default value of retcode to be 3,
1914
since in most cases this is run when you expect bzr to fail.
1916
:return: (out, err) The actual output of running the command (in case
1917
you want to do more inspection)
1921
# Make sure that commit is failing because there is nothing to do
1922
self.run_bzr_error(['no changes to commit'],
1923
['commit', '-m', 'my commit comment'])
1924
# Make sure --strict is handling an unknown file, rather than
1925
# giving us the 'nothing to do' error
1926
self.build_tree(['unknown'])
1927
self.run_bzr_error(['Commit refused because there are unknown files'],
1928
['commit', --strict', '-m', 'my commit comment'])
1930
kwargs.setdefault('retcode', 3)
1931
kwargs['error_regexes'] = error_regexes
1932
out, err = self.run_bzr(*args, **kwargs)
1935
def run_bzr_subprocess(self, *args, **kwargs):
1936
"""Run bzr in a subprocess for testing.
1938
This starts a new Python interpreter and runs bzr in there.
1939
This should only be used for tests that have a justifiable need for
1940
this isolation: e.g. they are testing startup time, or signal
1941
handling, or early startup code, etc. Subprocess code can't be
1942
profiled or debugged so easily.
1944
:keyword retcode: The status code that is expected. Defaults to 0. If
1945
None is supplied, the status code is not checked.
1946
:keyword env_changes: A dictionary which lists changes to environment
1947
variables. A value of None will unset the env variable.
1948
The values must be strings. The change will only occur in the
1949
child, so you don't need to fix the environment after running.
1950
:keyword universal_newlines: Convert CRLF => LF
1951
:keyword allow_plugins: By default the subprocess is run with
1952
--no-plugins to ensure test reproducibility. Also, it is possible
1953
for system-wide plugins to create unexpected output on stderr,
1954
which can cause unnecessary test failures.
1956
env_changes = kwargs.get('env_changes', {})
1957
working_dir = kwargs.get('working_dir', None)
1958
allow_plugins = kwargs.get('allow_plugins', False)
1960
if isinstance(args[0], list):
1962
elif isinstance(args[0], basestring):
1963
args = list(shlex.split(args[0]))
1965
raise ValueError("passing varargs to run_bzr_subprocess")
1966
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1967
working_dir=working_dir,
1968
allow_plugins=allow_plugins)
1969
# We distinguish between retcode=None and retcode not passed.
1970
supplied_retcode = kwargs.get('retcode', 0)
1971
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1972
universal_newlines=kwargs.get('universal_newlines', False),
1975
def start_bzr_subprocess(self, process_args, env_changes=None,
1976
skip_if_plan_to_signal=False,
1978
allow_plugins=False):
1979
"""Start bzr in a subprocess for testing.
1981
This starts a new Python interpreter and runs bzr in there.
1982
This should only be used for tests that have a justifiable need for
1983
this isolation: e.g. they are testing startup time, or signal
1984
handling, or early startup code, etc. Subprocess code can't be
1985
profiled or debugged so easily.
1987
:param process_args: a list of arguments to pass to the bzr executable,
1988
for example ``['--version']``.
1989
:param env_changes: A dictionary which lists changes to environment
1990
variables. A value of None will unset the env variable.
1991
The values must be strings. The change will only occur in the
1992
child, so you don't need to fix the environment after running.
1993
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1995
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1997
:returns: Popen object for the started process.
1999
if skip_if_plan_to_signal:
2000
if not getattr(os, 'kill', None):
2001
raise TestSkipped("os.kill not available.")
2003
if env_changes is None:
2007
def cleanup_environment():
2008
for env_var, value in env_changes.iteritems():
2009
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2011
def restore_environment():
2012
for env_var, value in old_env.iteritems():
2013
osutils.set_or_unset_env(env_var, value)
2015
bzr_path = self.get_bzr_path()
2018
if working_dir is not None:
2019
cwd = osutils.getcwd()
2020
os.chdir(working_dir)
2023
# win32 subprocess doesn't support preexec_fn
2024
# so we will avoid using it on all platforms, just to
2025
# make sure the code path is used, and we don't break on win32
2026
cleanup_environment()
2027
command = [sys.executable]
2028
# frozen executables don't need the path to bzr
2029
if getattr(sys, "frozen", None) is None:
2030
command.append(bzr_path)
2031
if not allow_plugins:
2032
command.append('--no-plugins')
2033
command.extend(process_args)
2034
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
2036
restore_environment()
2042
def _popen(self, *args, **kwargs):
2043
"""Place a call to Popen.
2045
Allows tests to override this method to intercept the calls made to
2046
Popen for introspection.
2048
return Popen(*args, **kwargs)
2050
def get_source_path(self):
2051
"""Return the path of the directory containing bzrlib."""
2052
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2054
def get_bzr_path(self):
2055
"""Return the path of the 'bzr' executable for this test suite."""
2056
bzr_path = self.get_source_path()+'/bzr'
2057
if not os.path.isfile(bzr_path):
2058
# We are probably installed. Assume sys.argv is the right file
2059
bzr_path = sys.argv[0]
2062
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2063
universal_newlines=False, process_args=None):
2064
"""Finish the execution of process.
2066
:param process: the Popen object returned from start_bzr_subprocess.
2067
:param retcode: The status code that is expected. Defaults to 0. If
2068
None is supplied, the status code is not checked.
2069
:param send_signal: an optional signal to send to the process.
2070
:param universal_newlines: Convert CRLF => LF
2071
:returns: (stdout, stderr)
2073
if send_signal is not None:
2074
os.kill(process.pid, send_signal)
2075
out, err = process.communicate()
2077
if universal_newlines:
2078
out = out.replace('\r\n', '\n')
2079
err = err.replace('\r\n', '\n')
2081
if retcode is not None and retcode != process.returncode:
2082
if process_args is None:
2083
process_args = "(unknown args)"
2084
mutter('Output of bzr %s:\n%s', process_args, out)
2085
mutter('Error for bzr %s:\n%s', process_args, err)
2086
self.fail('Command bzr %s failed with retcode %s != %s'
2087
% (process_args, retcode, process.returncode))
2090
def check_inventory_shape(self, inv, shape):
2091
"""Compare an inventory to a list of expected names.
2093
Fail if they are not precisely equal.
2096
shape = list(shape) # copy
2097
for path, ie in inv.entries():
2098
name = path.replace('\\', '/')
2099
if ie.kind == 'directory':
2106
self.fail("expected paths not found in inventory: %r" % shape)
2108
self.fail("unexpected paths found in inventory: %r" % extras)
2110
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2111
a_callable=None, *args, **kwargs):
2112
"""Call callable with redirected std io pipes.
2114
Returns the return code."""
2115
if not callable(a_callable):
2116
raise ValueError("a_callable must be callable.")
2118
stdin = StringIO("")
2120
if getattr(self, "_log_file", None) is not None:
2121
stdout = self._log_file
2125
if getattr(self, "_log_file", None is not None):
2126
stderr = self._log_file
2129
real_stdin = sys.stdin
2130
real_stdout = sys.stdout
2131
real_stderr = sys.stderr
2136
return a_callable(*args, **kwargs)
2138
sys.stdout = real_stdout
2139
sys.stderr = real_stderr
2140
sys.stdin = real_stdin
2142
def reduceLockdirTimeout(self):
2143
"""Reduce the default lock timeout for the duration of the test, so that
2144
if LockContention occurs during a test, it does so quickly.
2146
Tests that expect to provoke LockContention errors should call this.
2148
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
2150
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
2151
self.addCleanup(resetTimeout)
2152
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2154
def make_utf8_encoded_stringio(self, encoding_type=None):
2155
"""Return a StringIOWrapper instance, that will encode Unicode
2158
if encoding_type is None:
2159
encoding_type = 'strict'
2161
output_encoding = 'utf-8'
2162
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2163
sio.encoding = output_encoding
2166
def disable_verb(self, verb):
2167
"""Disable a smart server verb for one test."""
2168
from bzrlib.smart import request
2169
request_handlers = request.request_handlers
2170
orig_method = request_handlers.get(verb)
2171
request_handlers.remove(verb)
2173
request_handlers.register(verb, orig_method)
2174
self.addCleanup(restoreVerb)
2177
class CapturedCall(object):
2178
"""A helper for capturing smart server calls for easy debug analysis."""
2180
def __init__(self, params, prefix_length):
2181
"""Capture the call with params and skip prefix_length stack frames."""
2184
# The last 5 frames are the __init__, the hook frame, and 3 smart
2185
# client frames. Beyond this we could get more clever, but this is good
2187
stack = traceback.extract_stack()[prefix_length:-5]
2188
self.stack = ''.join(traceback.format_list(stack))
2191
return self.call.method
2194
return self.call.method
2200
class TestCaseWithMemoryTransport(TestCase):
2201
"""Common test class for tests that do not need disk resources.
2203
Tests that need disk resources should derive from TestCaseWithTransport.
2205
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2207
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2208
a directory which does not exist. This serves to help ensure test isolation
2209
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2210
must exist. However, TestCaseWithMemoryTransport does not offer local
2211
file defaults for the transport in tests, nor does it obey the command line
2212
override, so tests that accidentally write to the common directory should
2215
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2216
a .bzr directory that stops us ascending higher into the filesystem.
2222
def __init__(self, methodName='runTest'):
2223
# allow test parameterization after test construction and before test
2224
# execution. Variables that the parameterizer sets need to be
2225
# ones that are not set by setUp, or setUp will trash them.
2226
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2227
self.vfs_transport_factory = default_transport
2228
self.transport_server = None
2229
self.transport_readonly_server = None
2230
self.__vfs_server = None
2232
def get_transport(self, relpath=None):
2233
"""Return a writeable transport.
2235
This transport is for the test scratch space relative to
2238
:param relpath: a path relative to the base url.
2240
t = get_transport(self.get_url(relpath))
2241
self.assertFalse(t.is_readonly())
2244
def get_readonly_transport(self, relpath=None):
2245
"""Return a readonly transport for the test scratch space
2247
This can be used to test that operations which should only need
2248
readonly access in fact do not try to write.
2250
:param relpath: a path relative to the base url.
2252
t = get_transport(self.get_readonly_url(relpath))
2253
self.assertTrue(t.is_readonly())
2256
def create_transport_readonly_server(self):
2257
"""Create a transport server from class defined at init.
2259
This is mostly a hook for daughter classes.
2261
return self.transport_readonly_server()
2263
def get_readonly_server(self):
2264
"""Get the server instance for the readonly transport
2266
This is useful for some tests with specific servers to do diagnostics.
2268
if self.__readonly_server is None:
2269
if self.transport_readonly_server is None:
2270
# readonly decorator requested
2271
self.__readonly_server = ReadonlyServer()
2273
# explicit readonly transport.
2274
self.__readonly_server = self.create_transport_readonly_server()
2275
self.start_server(self.__readonly_server,
2276
self.get_vfs_only_server())
2277
return self.__readonly_server
2279
def get_readonly_url(self, relpath=None):
2280
"""Get a URL for the readonly transport.
2282
This will either be backed by '.' or a decorator to the transport
2283
used by self.get_url()
2284
relpath provides for clients to get a path relative to the base url.
2285
These should only be downwards relative, not upwards.
2287
base = self.get_readonly_server().get_url()
2288
return self._adjust_url(base, relpath)
2290
def get_vfs_only_server(self):
2291
"""Get the vfs only read/write server instance.
2293
This is useful for some tests with specific servers that need
2296
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2297
is no means to override it.
2299
if self.__vfs_server is None:
2300
self.__vfs_server = MemoryServer()
2301
self.start_server(self.__vfs_server)
2302
return self.__vfs_server
2304
def get_server(self):
2305
"""Get the read/write server instance.
2307
This is useful for some tests with specific servers that need
2310
This is built from the self.transport_server factory. If that is None,
2311
then the self.get_vfs_server is returned.
2313
if self.__server is None:
2314
if (self.transport_server is None or self.transport_server is
2315
self.vfs_transport_factory):
2316
self.__server = self.get_vfs_only_server()
2318
# bring up a decorated means of access to the vfs only server.
2319
self.__server = self.transport_server()
2320
self.start_server(self.__server, self.get_vfs_only_server())
2321
return self.__server
2323
def _adjust_url(self, base, relpath):
2324
"""Get a URL (or maybe a path) for the readwrite transport.
2326
This will either be backed by '.' or to an equivalent non-file based
2328
relpath provides for clients to get a path relative to the base url.
2329
These should only be downwards relative, not upwards.
2331
if relpath is not None and relpath != '.':
2332
if not base.endswith('/'):
2334
# XXX: Really base should be a url; we did after all call
2335
# get_url()! But sometimes it's just a path (from
2336
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2337
# to a non-escaped local path.
2338
if base.startswith('./') or base.startswith('/'):
2341
base += urlutils.escape(relpath)
2344
def get_url(self, relpath=None):
2345
"""Get a URL (or maybe a path) for the readwrite transport.
2347
This will either be backed by '.' or to an equivalent non-file based
2349
relpath provides for clients to get a path relative to the base url.
2350
These should only be downwards relative, not upwards.
2352
base = self.get_server().get_url()
2353
return self._adjust_url(base, relpath)
2355
def get_vfs_only_url(self, relpath=None):
2356
"""Get a URL (or maybe a path for the plain old vfs transport.
2358
This will never be a smart protocol. It always has all the
2359
capabilities of the local filesystem, but it might actually be a
2360
MemoryTransport or some other similar virtual filesystem.
2362
This is the backing transport (if any) of the server returned by
2363
get_url and get_readonly_url.
2365
:param relpath: provides for clients to get a path relative to the base
2366
url. These should only be downwards relative, not upwards.
2369
base = self.get_vfs_only_server().get_url()
2370
return self._adjust_url(base, relpath)
2372
def _create_safety_net(self):
2373
"""Make a fake bzr directory.
2375
This prevents any tests propagating up onto the TEST_ROOT directory's
2378
root = TestCaseWithMemoryTransport.TEST_ROOT
2379
bzrdir.BzrDir.create_standalone_workingtree(root)
2381
def _check_safety_net(self):
2382
"""Check that the safety .bzr directory have not been touched.
2384
_make_test_root have created a .bzr directory to prevent tests from
2385
propagating. This method ensures than a test did not leaked.
2387
root = TestCaseWithMemoryTransport.TEST_ROOT
2388
self.permit_url(get_transport(root).base)
2389
wt = workingtree.WorkingTree.open(root)
2390
last_rev = wt.last_revision()
2391
if last_rev != 'null:':
2392
# The current test have modified the /bzr directory, we need to
2393
# recreate a new one or all the followng tests will fail.
2394
# If you need to inspect its content uncomment the following line
2395
# import pdb; pdb.set_trace()
2396
_rmtree_temp_dir(root + '/.bzr')
2397
self._create_safety_net()
2398
raise AssertionError('%s/.bzr should not be modified' % root)
2400
def _make_test_root(self):
2401
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2402
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2403
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2405
TestCaseWithMemoryTransport.TEST_ROOT = root
2407
self._create_safety_net()
2409
# The same directory is used by all tests, and we're not
2410
# specifically told when all tests are finished. This will do.
2411
atexit.register(_rmtree_temp_dir, root)
2413
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2414
self.addCleanup(self._check_safety_net)
2416
def makeAndChdirToTestDir(self):
2417
"""Create a temporary directories for this one test.
2419
This must set self.test_home_dir and self.test_dir and chdir to
2422
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2424
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2425
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2426
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2427
self.permit_dir(self.test_dir)
2429
def make_branch(self, relpath, format=None):
2430
"""Create a branch on the transport at relpath."""
2431
repo = self.make_repository(relpath, format=format)
2432
return repo.bzrdir.create_branch()
2434
def make_bzrdir(self, relpath, format=None):
2436
# might be a relative or absolute path
2437
maybe_a_url = self.get_url(relpath)
2438
segments = maybe_a_url.rsplit('/', 1)
2439
t = get_transport(maybe_a_url)
2440
if len(segments) > 1 and segments[-1] not in ('', '.'):
2444
if isinstance(format, basestring):
2445
format = bzrdir.format_registry.make_bzrdir(format)
2446
return format.initialize_on_transport(t)
2447
except errors.UninitializableFormat:
2448
raise TestSkipped("Format %s is not initializable." % format)
2450
def make_repository(self, relpath, shared=False, format=None):
2451
"""Create a repository on our default transport at relpath.
2453
Note that relpath must be a relative path, not a full url.
2455
# FIXME: If you create a remoterepository this returns the underlying
2456
# real format, which is incorrect. Actually we should make sure that
2457
# RemoteBzrDir returns a RemoteRepository.
2458
# maybe mbp 20070410
2459
made_control = self.make_bzrdir(relpath, format=format)
2460
return made_control.create_repository(shared=shared)
2462
def make_smart_server(self, path):
2463
smart_server = server.SmartTCPServer_for_testing()
2464
self.start_server(smart_server, self.get_server())
2465
remote_transport = get_transport(smart_server.get_url()).clone(path)
2466
return remote_transport
2468
def make_branch_and_memory_tree(self, relpath, format=None):
2469
"""Create a branch on the default transport and a MemoryTree for it."""
2470
b = self.make_branch(relpath, format=format)
2471
return memorytree.MemoryTree.create_on_branch(b)
2473
def make_branch_builder(self, relpath, format=None):
2474
branch = self.make_branch(relpath, format=format)
2475
return branchbuilder.BranchBuilder(branch=branch)
2477
def overrideEnvironmentForTesting(self):
2478
test_home_dir = self.test_home_dir
2479
if isinstance(test_home_dir, unicode):
2480
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2481
os.environ['HOME'] = test_home_dir
2482
os.environ['BZR_HOME'] = test_home_dir
2485
super(TestCaseWithMemoryTransport, self).setUp()
2486
self._make_test_root()
2487
_currentdir = os.getcwdu()
2488
def _leaveDirectory():
2489
os.chdir(_currentdir)
2490
self.addCleanup(_leaveDirectory)
2491
self.makeAndChdirToTestDir()
2492
self.overrideEnvironmentForTesting()
2493
self.__readonly_server = None
2494
self.__server = None
2495
self.reduceLockdirTimeout()
2497
def setup_smart_server_with_call_log(self):
2498
"""Sets up a smart server as the transport server with a call log."""
2499
self.transport_server = server.SmartTCPServer_for_testing
2500
self.hpss_calls = []
2502
# Skip the current stack down to the caller of
2503
# setup_smart_server_with_call_log
2504
prefix_length = len(traceback.extract_stack()) - 2
2505
def capture_hpss_call(params):
2506
self.hpss_calls.append(
2507
CapturedCall(params, prefix_length))
2508
client._SmartClient.hooks.install_named_hook(
2509
'call', capture_hpss_call, None)
2511
def reset_smart_call_log(self):
2512
self.hpss_calls = []
2515
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2516
"""Derived class that runs a test within a temporary directory.
2518
This is useful for tests that need to create a branch, etc.
2520
The directory is created in a slightly complex way: for each
2521
Python invocation, a new temporary top-level directory is created.
2522
All test cases create their own directory within that. If the
2523
tests complete successfully, the directory is removed.
2525
:ivar test_base_dir: The path of the top-level directory for this
2526
test, which contains a home directory and a work directory.
2528
:ivar test_home_dir: An initially empty directory under test_base_dir
2529
which is used as $HOME for this test.
2531
:ivar test_dir: A directory under test_base_dir used as the current
2532
directory when the test proper is run.
2535
OVERRIDE_PYTHON = 'python'
2537
def check_file_contents(self, filename, expect):
2538
self.log("check contents of file %s" % filename)
2539
contents = file(filename, 'r').read()
2540
if contents != expect:
2541
self.log("expected: %r" % expect)
2542
self.log("actually: %r" % contents)
2543
self.fail("contents of %s not as expected" % filename)
2545
def _getTestDirPrefix(self):
2546
# create a directory within the top level test directory
2547
if sys.platform in ('win32', 'cygwin'):
2548
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2549
# windows is likely to have path-length limits so use a short name
2550
name_prefix = name_prefix[-30:]
2552
name_prefix = re.sub('[/]', '_', self.id())
2555
def makeAndChdirToTestDir(self):
2556
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2558
For TestCaseInTempDir we create a temporary directory based on the test
2559
name and then create two subdirs - test and home under it.
2561
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2562
self._getTestDirPrefix())
2564
for i in range(100):
2565
if os.path.exists(name):
2566
name = name_prefix + '_' + str(i)
2568
# now create test and home directories within this dir
2569
self.test_base_dir = name
2570
self.addCleanup(self.deleteTestDir)
2571
os.mkdir(self.test_base_dir)
2573
self.permit_dir(self.test_base_dir)
2574
# 'sprouting' and 'init' of a branch both walk up the tree to find
2575
# stacking policy to honour; create a bzr dir with an unshared
2576
# repository (but not a branch - our code would be trying to escape
2577
# then!) to stop them, and permit it to be read.
2578
# control = bzrdir.BzrDir.create(self.test_base_dir)
2579
# control.create_repository()
2580
self.test_home_dir = self.test_base_dir + '/home'
2581
os.mkdir(self.test_home_dir)
2582
self.test_dir = self.test_base_dir + '/work'
2583
os.mkdir(self.test_dir)
2584
os.chdir(self.test_dir)
2585
# put name of test inside
2586
f = file(self.test_base_dir + '/name', 'w')
2592
def deleteTestDir(self):
2593
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2594
_rmtree_temp_dir(self.test_base_dir)
2596
def build_tree(self, shape, line_endings='binary', transport=None):
2597
"""Build a test tree according to a pattern.
2599
shape is a sequence of file specifications. If the final
2600
character is '/', a directory is created.
2602
This assumes that all the elements in the tree being built are new.
2604
This doesn't add anything to a branch.
2606
:type shape: list or tuple.
2607
:param line_endings: Either 'binary' or 'native'
2608
in binary mode, exact contents are written in native mode, the
2609
line endings match the default platform endings.
2610
:param transport: A transport to write to, for building trees on VFS's.
2611
If the transport is readonly or None, "." is opened automatically.
2614
if type(shape) not in (list, tuple):
2615
raise AssertionError("Parameter 'shape' should be "
2616
"a list or a tuple. Got %r instead" % (shape,))
2617
# It's OK to just create them using forward slashes on windows.
2618
if transport is None or transport.is_readonly():
2619
transport = get_transport(".")
2621
self.assertIsInstance(name, basestring)
2623
transport.mkdir(urlutils.escape(name[:-1]))
2625
if line_endings == 'binary':
2627
elif line_endings == 'native':
2630
raise errors.BzrError(
2631
'Invalid line ending request %r' % line_endings)
2632
content = "contents of %s%s" % (name.encode('utf-8'), end)
2633
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2635
def build_tree_contents(self, shape):
2636
build_tree_contents(shape)
2638
def assertInWorkingTree(self, path, root_path='.', tree=None):
2639
"""Assert whether path or paths are in the WorkingTree"""
2641
tree = workingtree.WorkingTree.open(root_path)
2642
if not isinstance(path, basestring):
2644
self.assertInWorkingTree(p, tree=tree)
2646
self.assertIsNot(tree.path2id(path), None,
2647
path+' not in working tree.')
2649
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2650
"""Assert whether path or paths are not in the WorkingTree"""
2652
tree = workingtree.WorkingTree.open(root_path)
2653
if not isinstance(path, basestring):
2655
self.assertNotInWorkingTree(p,tree=tree)
2657
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2660
class TestCaseWithTransport(TestCaseInTempDir):
2661
"""A test case that provides get_url and get_readonly_url facilities.
2663
These back onto two transport servers, one for readonly access and one for
2666
If no explicit class is provided for readonly access, a
2667
ReadonlyTransportDecorator is used instead which allows the use of non disk
2668
based read write transports.
2670
If an explicit class is provided for readonly access, that server and the
2671
readwrite one must both define get_url() as resolving to os.getcwd().
2674
def get_vfs_only_server(self):
2675
"""See TestCaseWithMemoryTransport.
2677
This is useful for some tests with specific servers that need
2680
if self.__vfs_server is None:
2681
self.__vfs_server = self.vfs_transport_factory()
2682
self.start_server(self.__vfs_server)
2683
return self.__vfs_server
2685
def make_branch_and_tree(self, relpath, format=None):
2686
"""Create a branch on the transport and a tree locally.
2688
If the transport is not a LocalTransport, the Tree can't be created on
2689
the transport. In that case if the vfs_transport_factory is
2690
LocalURLServer the working tree is created in the local
2691
directory backing the transport, and the returned tree's branch and
2692
repository will also be accessed locally. Otherwise a lightweight
2693
checkout is created and returned.
2695
We do this because we can't physically create a tree in the local
2696
path, with a branch reference to the transport_factory url, and
2697
a branch + repository in the vfs_transport, unless the vfs_transport
2698
namespace is distinct from the local disk - the two branch objects
2699
would collide. While we could construct a tree with its branch object
2700
pointing at the transport_factory transport in memory, reopening it
2701
would behaving unexpectedly, and has in the past caused testing bugs
2702
when we tried to do it that way.
2704
:param format: The BzrDirFormat.
2705
:returns: the WorkingTree.
2707
# TODO: always use the local disk path for the working tree,
2708
# this obviously requires a format that supports branch references
2709
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2711
b = self.make_branch(relpath, format=format)
2713
return b.bzrdir.create_workingtree()
2714
except errors.NotLocalUrl:
2715
# We can only make working trees locally at the moment. If the
2716
# transport can't support them, then we keep the non-disk-backed
2717
# branch and create a local checkout.
2718
if self.vfs_transport_factory is LocalURLServer:
2719
# the branch is colocated on disk, we cannot create a checkout.
2720
# hopefully callers will expect this.
2721
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2722
wt = local_controldir.create_workingtree()
2723
if wt.branch._format != b._format:
2725
# Make sure that assigning to wt._branch fixes wt.branch,
2726
# in case the implementation details of workingtree objects
2728
self.assertIs(b, wt.branch)
2731
return b.create_checkout(relpath, lightweight=True)
2733
def assertIsDirectory(self, relpath, transport):
2734
"""Assert that relpath within transport is a directory.
2736
This may not be possible on all transports; in that case it propagates
2737
a TransportNotPossible.
2740
mode = transport.stat(relpath).st_mode
2741
except errors.NoSuchFile:
2742
self.fail("path %s is not a directory; no such file"
2744
if not stat.S_ISDIR(mode):
2745
self.fail("path %s is not a directory; has mode %#o"
2748
def assertTreesEqual(self, left, right):
2749
"""Check that left and right have the same content and properties."""
2750
# we use a tree delta to check for equality of the content, and we
2751
# manually check for equality of other things such as the parents list.
2752
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2753
differences = left.changes_from(right)
2754
self.assertFalse(differences.has_changed(),
2755
"Trees %r and %r are different: %r" % (left, right, differences))
2758
super(TestCaseWithTransport, self).setUp()
2759
self.__vfs_server = None
2761
def disable_missing_extensions_warning(self):
2762
"""Some tests expect a precise stderr content.
2764
There is no point in forcing them to duplicate the extension related
2767
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2770
class ChrootedTestCase(TestCaseWithTransport):
2771
"""A support class that provides readonly urls outside the local namespace.
2773
This is done by checking if self.transport_server is a MemoryServer. if it
2774
is then we are chrooted already, if it is not then an HttpServer is used
2777
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2778
be used without needed to redo it when a different
2779
subclass is in use ?
2783
super(ChrootedTestCase, self).setUp()
2784
if not self.vfs_transport_factory == MemoryServer:
2785
self.transport_readonly_server = HttpServer
2788
def condition_id_re(pattern):
2789
"""Create a condition filter which performs a re check on a test's id.
2791
:param pattern: A regular expression string.
2792
:return: A callable that returns True if the re matches.
2794
filter_re = osutils.re_compile_checked(pattern, 0,
2796
def condition(test):
2798
return filter_re.search(test_id)
2802
def condition_isinstance(klass_or_klass_list):
2803
"""Create a condition filter which returns isinstance(param, klass).
2805
:return: A callable which when called with one parameter obj return the
2806
result of isinstance(obj, klass_or_klass_list).
2809
return isinstance(obj, klass_or_klass_list)
2813
def condition_id_in_list(id_list):
2814
"""Create a condition filter which verify that test's id in a list.
2816
:param id_list: A TestIdList object.
2817
:return: A callable that returns True if the test's id appears in the list.
2819
def condition(test):
2820
return id_list.includes(test.id())
2824
def condition_id_startswith(starts):
2825
"""Create a condition filter verifying that test's id starts with a string.
2827
:param starts: A list of string.
2828
:return: A callable that returns True if the test's id starts with one of
2831
def condition(test):
2832
for start in starts:
2833
if test.id().startswith(start):
2839
def exclude_tests_by_condition(suite, condition):
2840
"""Create a test suite which excludes some tests from suite.
2842
:param suite: The suite to get tests from.
2843
:param condition: A callable whose result evaluates True when called with a
2844
test case which should be excluded from the result.
2845
:return: A suite which contains the tests found in suite that fail
2849
for test in iter_suite_tests(suite):
2850
if not condition(test):
2852
return TestUtil.TestSuite(result)
2855
def filter_suite_by_condition(suite, condition):
2856
"""Create a test suite by filtering another one.
2858
:param suite: The source suite.
2859
:param condition: A callable whose result evaluates True when called with a
2860
test case which should be included in the result.
2861
:return: A suite which contains the tests found in suite that pass
2865
for test in iter_suite_tests(suite):
2868
return TestUtil.TestSuite(result)
2871
def filter_suite_by_re(suite, pattern):
2872
"""Create a test suite by filtering another one.
2874
:param suite: the source suite
2875
:param pattern: pattern that names must match
2876
:returns: the newly created suite
2878
condition = condition_id_re(pattern)
2879
result_suite = filter_suite_by_condition(suite, condition)
2883
def filter_suite_by_id_list(suite, test_id_list):
2884
"""Create a test suite by filtering another one.
2886
:param suite: The source suite.
2887
:param test_id_list: A list of the test ids to keep as strings.
2888
:returns: the newly created suite
2890
condition = condition_id_in_list(test_id_list)
2891
result_suite = filter_suite_by_condition(suite, condition)
2895
def filter_suite_by_id_startswith(suite, start):
2896
"""Create a test suite by filtering another one.
2898
:param suite: The source suite.
2899
:param start: A list of string the test id must start with one of.
2900
:returns: the newly created suite
2902
condition = condition_id_startswith(start)
2903
result_suite = filter_suite_by_condition(suite, condition)
2907
def exclude_tests_by_re(suite, pattern):
2908
"""Create a test suite which excludes some tests from suite.
2910
:param suite: The suite to get tests from.
2911
:param pattern: A regular expression string. Test ids that match this
2912
pattern will be excluded from the result.
2913
:return: A TestSuite that contains all the tests from suite without the
2914
tests that matched pattern. The order of tests is the same as it was in
2917
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2920
def preserve_input(something):
2921
"""A helper for performing test suite transformation chains.
2923
:param something: Anything you want to preserve.
2929
def randomize_suite(suite):
2930
"""Return a new TestSuite with suite's tests in random order.
2932
The tests in the input suite are flattened into a single suite in order to
2933
accomplish this. Any nested TestSuites are removed to provide global
2936
tests = list(iter_suite_tests(suite))
2937
random.shuffle(tests)
2938
return TestUtil.TestSuite(tests)
2941
def split_suite_by_condition(suite, condition):
2942
"""Split a test suite into two by a condition.
2944
:param suite: The suite to split.
2945
:param condition: The condition to match on. Tests that match this
2946
condition are returned in the first test suite, ones that do not match
2947
are in the second suite.
2948
:return: A tuple of two test suites, where the first contains tests from
2949
suite matching the condition, and the second contains the remainder
2950
from suite. The order within each output suite is the same as it was in
2955
for test in iter_suite_tests(suite):
2957
matched.append(test)
2959
did_not_match.append(test)
2960
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2963
def split_suite_by_re(suite, pattern):
2964
"""Split a test suite into two by a regular expression.
2966
:param suite: The suite to split.
2967
:param pattern: A regular expression string. Test ids that match this
2968
pattern will be in the first test suite returned, and the others in the
2969
second test suite returned.
2970
:return: A tuple of two test suites, where the first contains tests from
2971
suite matching pattern, and the second contains the remainder from
2972
suite. The order within each output suite is the same as it was in
2975
return split_suite_by_condition(suite, condition_id_re(pattern))
2978
def run_suite(suite, name='test', verbose=False, pattern=".*",
2979
stop_on_failure=False,
2980
transport=None, lsprof_timed=None, bench_history=None,
2981
matching_tests_first=None,
2984
exclude_pattern=None,
2987
suite_decorators=None,
2989
result_decorators=None,
2991
"""Run a test suite for bzr selftest.
2993
:param runner_class: The class of runner to use. Must support the
2994
constructor arguments passed by run_suite which are more than standard
2996
:return: A boolean indicating success.
2998
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3003
if runner_class is None:
3004
runner_class = TextTestRunner
3007
runner = runner_class(stream=stream,
3009
verbosity=verbosity,
3010
bench_history=bench_history,
3012
result_decorators=result_decorators,
3014
runner.stop_on_failure=stop_on_failure
3015
# built in decorator factories:
3017
random_order(random_seed, runner),
3018
exclude_tests(exclude_pattern),
3020
if matching_tests_first:
3021
decorators.append(tests_first(pattern))
3023
decorators.append(filter_tests(pattern))
3024
if suite_decorators:
3025
decorators.extend(suite_decorators)
3026
# tell the result object how many tests will be running: (except if
3027
# --parallel=fork is being used. Robert said he will provide a better
3028
# progress design later -- vila 20090817)
3029
if fork_decorator not in decorators:
3030
decorators.append(CountingDecorator)
3031
for decorator in decorators:
3032
suite = decorator(suite)
3034
# Done after test suite decoration to allow randomisation etc
3035
# to take effect, though that is of marginal benefit.
3037
stream.write("Listing tests only ...\n")
3038
for t in iter_suite_tests(suite):
3039
stream.write("%s\n" % (t.id()))
3041
result = runner.run(suite)
3043
return result.wasStrictlySuccessful()
3045
return result.wasSuccessful()
3048
# A registry where get() returns a suite decorator.
3049
parallel_registry = registry.Registry()
3052
def fork_decorator(suite):
3053
concurrency = osutils.local_concurrency()
3054
if concurrency == 1:
3056
from testtools import ConcurrentTestSuite
3057
return ConcurrentTestSuite(suite, fork_for_tests)
3058
parallel_registry.register('fork', fork_decorator)
3061
def subprocess_decorator(suite):
3062
concurrency = osutils.local_concurrency()
3063
if concurrency == 1:
3065
from testtools import ConcurrentTestSuite
3066
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3067
parallel_registry.register('subprocess', subprocess_decorator)
3070
def exclude_tests(exclude_pattern):
3071
"""Return a test suite decorator that excludes tests."""
3072
if exclude_pattern is None:
3073
return identity_decorator
3074
def decorator(suite):
3075
return ExcludeDecorator(suite, exclude_pattern)
3079
def filter_tests(pattern):
3081
return identity_decorator
3082
def decorator(suite):
3083
return FilterTestsDecorator(suite, pattern)
3087
def random_order(random_seed, runner):
3088
"""Return a test suite decorator factory for randomising tests order.
3090
:param random_seed: now, a string which casts to a long, or a long.
3091
:param runner: A test runner with a stream attribute to report on.
3093
if random_seed is None:
3094
return identity_decorator
3095
def decorator(suite):
3096
return RandomDecorator(suite, random_seed, runner.stream)
3100
def tests_first(pattern):
3102
return identity_decorator
3103
def decorator(suite):
3104
return TestFirstDecorator(suite, pattern)
3108
def identity_decorator(suite):
3113
class TestDecorator(TestSuite):
3114
"""A decorator for TestCase/TestSuite objects.
3116
Usually, subclasses should override __iter__(used when flattening test
3117
suites), which we do to filter, reorder, parallelise and so on, run() and
3121
def __init__(self, suite):
3122
TestSuite.__init__(self)
3125
def countTestCases(self):
3128
cases += test.countTestCases()
3135
def run(self, result):
3136
# Use iteration on self, not self._tests, to allow subclasses to hook
3139
if result.shouldStop:
3145
class CountingDecorator(TestDecorator):
3146
"""A decorator which calls result.progress(self.countTestCases)."""
3148
def run(self, result):
3149
progress_method = getattr(result, 'progress', None)
3150
if callable(progress_method):
3151
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3152
return super(CountingDecorator, self).run(result)
3155
class ExcludeDecorator(TestDecorator):
3156
"""A decorator which excludes test matching an exclude pattern."""
3158
def __init__(self, suite, exclude_pattern):
3159
TestDecorator.__init__(self, suite)
3160
self.exclude_pattern = exclude_pattern
3161
self.excluded = False
3165
return iter(self._tests)
3166
self.excluded = True
3167
suite = exclude_tests_by_re(self, self.exclude_pattern)
3169
self.addTests(suite)
3170
return iter(self._tests)
3173
class FilterTestsDecorator(TestDecorator):
3174
"""A decorator which filters tests to those matching a pattern."""
3176
def __init__(self, suite, pattern):
3177
TestDecorator.__init__(self, suite)
3178
self.pattern = pattern
3179
self.filtered = False
3183
return iter(self._tests)
3184
self.filtered = True
3185
suite = filter_suite_by_re(self, self.pattern)
3187
self.addTests(suite)
3188
return iter(self._tests)
3191
class RandomDecorator(TestDecorator):
3192
"""A decorator which randomises the order of its tests."""
3194
def __init__(self, suite, random_seed, stream):
3195
TestDecorator.__init__(self, suite)
3196
self.random_seed = random_seed
3197
self.randomised = False
3198
self.stream = stream
3202
return iter(self._tests)
3203
self.randomised = True
3204
self.stream.writeln("Randomizing test order using seed %s\n" %
3205
(self.actual_seed()))
3206
# Initialise the random number generator.
3207
random.seed(self.actual_seed())
3208
suite = randomize_suite(self)
3210
self.addTests(suite)
3211
return iter(self._tests)
3213
def actual_seed(self):
3214
if self.random_seed == "now":
3215
# We convert the seed to a long to make it reuseable across
3216
# invocations (because the user can reenter it).
3217
self.random_seed = long(time.time())
3219
# Convert the seed to a long if we can
3221
self.random_seed = long(self.random_seed)
3224
return self.random_seed
3227
class TestFirstDecorator(TestDecorator):
3228
"""A decorator which moves named tests to the front."""
3230
def __init__(self, suite, pattern):
3231
TestDecorator.__init__(self, suite)
3232
self.pattern = pattern
3233
self.filtered = False
3237
return iter(self._tests)
3238
self.filtered = True
3239
suites = split_suite_by_re(self, self.pattern)
3241
self.addTests(suites)
3242
return iter(self._tests)
3245
def partition_tests(suite, count):
3246
"""Partition suite into count lists of tests."""
3248
tests = list(iter_suite_tests(suite))
3249
tests_per_process = int(math.ceil(float(len(tests)) / count))
3250
for block in range(count):
3251
low_test = block * tests_per_process
3252
high_test = low_test + tests_per_process
3253
process_tests = tests[low_test:high_test]
3254
result.append(process_tests)
3258
def fork_for_tests(suite):
3259
"""Take suite and start up one runner per CPU by forking()
3261
:return: An iterable of TestCase-like objects which can each have
3262
run(result) called on them to feed tests to result.
3264
concurrency = osutils.local_concurrency()
3266
from subunit import TestProtocolClient, ProtocolTestCase
3267
class TestInOtherProcess(ProtocolTestCase):
3268
# Should be in subunit, I think. RBC.
3269
def __init__(self, stream, pid):
3270
ProtocolTestCase.__init__(self, stream)
3273
def run(self, result):
3275
ProtocolTestCase.run(self, result)
3277
os.waitpid(self.pid, os.WNOHANG)
3279
test_blocks = partition_tests(suite, concurrency)
3280
for process_tests in test_blocks:
3281
process_suite = TestSuite()
3282
process_suite.addTests(process_tests)
3283
c2pread, c2pwrite = os.pipe()
3288
# Leave stderr and stdout open so we can see test noise
3289
# Close stdin so that the child goes away if it decides to
3290
# read from stdin (otherwise its a roulette to see what
3291
# child actually gets keystrokes for pdb etc).
3294
stream = os.fdopen(c2pwrite, 'wb', 1)
3295
subunit_result = BzrAutoTimingTestResultDecorator(
3296
TestProtocolClient(stream))
3297
process_suite.run(subunit_result)
3302
stream = os.fdopen(c2pread, 'rb', 1)
3303
test = TestInOtherProcess(stream, pid)
3308
def reinvoke_for_tests(suite):
3309
"""Take suite and start up one runner per CPU using subprocess().
3311
:return: An iterable of TestCase-like objects which can each have
3312
run(result) called on them to feed tests to result.
3314
concurrency = osutils.local_concurrency()
3316
from subunit import ProtocolTestCase
3317
class TestInSubprocess(ProtocolTestCase):
3318
def __init__(self, process, name):
3319
ProtocolTestCase.__init__(self, process.stdout)
3320
self.process = process
3321
self.process.stdin.close()
3324
def run(self, result):
3326
ProtocolTestCase.run(self, result)
3329
os.unlink(self.name)
3330
# print "pid %d finished" % finished_process
3331
test_blocks = partition_tests(suite, concurrency)
3332
for process_tests in test_blocks:
3333
# ugly; currently reimplement rather than reuses TestCase methods.
3334
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3335
if not os.path.isfile(bzr_path):
3336
# We are probably installed. Assume sys.argv is the right file
3337
bzr_path = sys.argv[0]
3338
bzr_path = [bzr_path]
3339
if sys.platform == "win32":
3340
# if we're on windows, we can't execute the bzr script directly
3341
bzr_path = [sys.executable] + bzr_path
3342
fd, test_list_file_name = tempfile.mkstemp()
3343
test_list_file = os.fdopen(fd, 'wb', 1)
3344
for test in process_tests:
3345
test_list_file.write(test.id() + '\n')
3346
test_list_file.close()
3348
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3350
if '--no-plugins' in sys.argv:
3351
argv.append('--no-plugins')
3352
# stderr=STDOUT would be ideal, but until we prevent noise on
3353
# stderr it can interrupt the subunit protocol.
3354
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3356
test = TestInSubprocess(process, test_list_file_name)
3359
os.unlink(test_list_file_name)
3364
class ForwardingResult(unittest.TestResult):
3366
def __init__(self, target):
3367
unittest.TestResult.__init__(self)
3368
self.result = target
3370
def startTest(self, test):
3371
self.result.startTest(test)
3373
def stopTest(self, test):
3374
self.result.stopTest(test)
3376
def startTestRun(self):
3377
self.result.startTestRun()
3379
def stopTestRun(self):
3380
self.result.stopTestRun()
3382
def addSkip(self, test, reason):
3383
self.result.addSkip(test, reason)
3385
def addSuccess(self, test):
3386
self.result.addSuccess(test)
3388
def addError(self, test, err):
3389
self.result.addError(test, err)
3391
def addFailure(self, test, err):
3392
self.result.addFailure(test, err)
3395
class BZRTransformingResult(ForwardingResult):
3397
def addError(self, test, err):
3398
feature = self._error_looks_like('UnavailableFeature: ', err)
3399
if feature is not None:
3400
self.result.addNotSupported(test, feature)
3402
self.result.addError(test, err)
3404
def addFailure(self, test, err):
3405
known = self._error_looks_like('KnownFailure: ', err)
3406
if known is not None:
3407
self.result.addExpectedFailure(test,
3408
[KnownFailure, KnownFailure(known), None])
3410
self.result.addFailure(test, err)
3412
def _error_looks_like(self, prefix, err):
3413
"""Deserialize exception and returns the stringify value."""
3417
if isinstance(exc, subunit.RemoteException):
3418
# stringify the exception gives access to the remote traceback
3419
# We search the last line for 'prefix'
3420
lines = str(exc).split('\n')
3421
while lines and not lines[-1]:
3424
if lines[-1].startswith(prefix):
3425
value = lines[-1][len(prefix):]
3430
from subunit.test_results import AutoTimingTestResultDecorator
3431
# Expected failure should be seen as a success not a failure Once subunit
3432
# provide native support for that, BZRTransformingResult and this class
3433
# will become useless.
3434
class BzrAutoTimingTestResultDecorator(AutoTimingTestResultDecorator):
3436
def addExpectedFailure(self, test, err):
3437
self._before_event()
3438
return self._call_maybe("addExpectedFailure", self._degrade_skip,
3441
# Let's just define a no-op decorator
3442
BzrAutoTimingTestResultDecorator = lambda x:x
3445
class ProfileResult(ForwardingResult):
3446
"""Generate profiling data for all activity between start and success.
3448
The profile data is appended to the test's _benchcalls attribute and can
3449
be accessed by the forwarded-to TestResult.
3451
While it might be cleaner do accumulate this in stopTest, addSuccess is
3452
where our existing output support for lsprof is, and this class aims to
3453
fit in with that: while it could be moved it's not necessary to accomplish
3454
test profiling, nor would it be dramatically cleaner.
3457
def startTest(self, test):
3458
self.profiler = bzrlib.lsprof.BzrProfiler()
3459
self.profiler.start()
3460
ForwardingResult.startTest(self, test)
3462
def addSuccess(self, test):
3463
stats = self.profiler.stop()
3465
calls = test._benchcalls
3466
except AttributeError:
3467
test._benchcalls = []
3468
calls = test._benchcalls
3469
calls.append(((test.id(), "", ""), stats))
3470
ForwardingResult.addSuccess(self, test)
3472
def stopTest(self, test):
3473
ForwardingResult.stopTest(self, test)
3474
self.profiler = None
3477
# Controlled by "bzr selftest -E=..." option
3478
# Currently supported:
3479
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3480
# preserves any flags supplied at the command line.
3481
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3482
# rather than failing tests. And no longer raise
3483
# LockContention when fctnl locks are not being used
3484
# with proper exclusion rules.
3485
selftest_debug_flags = set()
3488
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3490
test_suite_factory=None,
3493
matching_tests_first=None,
3496
exclude_pattern=None,
3502
suite_decorators=None,
3506
"""Run the whole test suite under the enhanced runner"""
3507
# XXX: Very ugly way to do this...
3508
# Disable warning about old formats because we don't want it to disturb
3509
# any blackbox tests.
3510
from bzrlib import repository
3511
repository._deprecation_warning_done = True
3513
global default_transport
3514
if transport is None:
3515
transport = default_transport
3516
old_transport = default_transport
3517
default_transport = transport
3518
global selftest_debug_flags
3519
old_debug_flags = selftest_debug_flags
3520
if debug_flags is not None:
3521
selftest_debug_flags = set(debug_flags)
3523
if load_list is None:
3526
keep_only = load_test_id_list(load_list)
3528
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3529
for start in starting_with]
3530
if test_suite_factory is None:
3531
# Reduce loading time by loading modules based on the starting_with
3533
suite = test_suite(keep_only, starting_with)
3535
suite = test_suite_factory()
3537
# But always filter as requested.
3538
suite = filter_suite_by_id_startswith(suite, starting_with)
3539
result_decorators = []
3541
result_decorators.append(ProfileResult)
3542
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3543
stop_on_failure=stop_on_failure,
3544
transport=transport,
3545
lsprof_timed=lsprof_timed,
3546
bench_history=bench_history,
3547
matching_tests_first=matching_tests_first,
3548
list_only=list_only,
3549
random_seed=random_seed,
3550
exclude_pattern=exclude_pattern,
3552
runner_class=runner_class,
3553
suite_decorators=suite_decorators,
3555
result_decorators=result_decorators,
3558
default_transport = old_transport
3559
selftest_debug_flags = old_debug_flags
3562
def load_test_id_list(file_name):
3563
"""Load a test id list from a text file.
3565
The format is one test id by line. No special care is taken to impose
3566
strict rules, these test ids are used to filter the test suite so a test id
3567
that do not match an existing test will do no harm. This allows user to add
3568
comments, leave blank lines, etc.
3572
ftest = open(file_name, 'rt')
3574
if e.errno != errno.ENOENT:
3577
raise errors.NoSuchFile(file_name)
3579
for test_name in ftest.readlines():
3580
test_list.append(test_name.strip())
3585
def suite_matches_id_list(test_suite, id_list):
3586
"""Warns about tests not appearing or appearing more than once.
3588
:param test_suite: A TestSuite object.
3589
:param test_id_list: The list of test ids that should be found in
3592
:return: (absents, duplicates) absents is a list containing the test found
3593
in id_list but not in test_suite, duplicates is a list containing the
3594
test found multiple times in test_suite.
3596
When using a prefined test id list, it may occurs that some tests do not
3597
exist anymore or that some tests use the same id. This function warns the
3598
tester about potential problems in his workflow (test lists are volatile)
3599
or in the test suite itself (using the same id for several tests does not
3600
help to localize defects).
3602
# Build a dict counting id occurrences
3604
for test in iter_suite_tests(test_suite):
3606
tests[id] = tests.get(id, 0) + 1
3611
occurs = tests.get(id, 0)
3613
not_found.append(id)
3615
duplicates.append(id)
3617
return not_found, duplicates
3620
class TestIdList(object):
3621
"""Test id list to filter a test suite.
3623
Relying on the assumption that test ids are built as:
3624
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3625
notation, this class offers methods to :
3626
- avoid building a test suite for modules not refered to in the test list,
3627
- keep only the tests listed from the module test suite.
3630
def __init__(self, test_id_list):
3631
# When a test suite needs to be filtered against us we compare test ids
3632
# for equality, so a simple dict offers a quick and simple solution.
3633
self.tests = dict().fromkeys(test_id_list, True)
3635
# While unittest.TestCase have ids like:
3636
# <module>.<class>.<method>[(<param+)],
3637
# doctest.DocTestCase can have ids like:
3640
# <module>.<function>
3641
# <module>.<class>.<method>
3643
# Since we can't predict a test class from its name only, we settle on
3644
# a simple constraint: a test id always begins with its module name.
3647
for test_id in test_id_list:
3648
parts = test_id.split('.')
3649
mod_name = parts.pop(0)
3650
modules[mod_name] = True
3652
mod_name += '.' + part
3653
modules[mod_name] = True
3654
self.modules = modules
3656
def refers_to(self, module_name):
3657
"""Is there tests for the module or one of its sub modules."""
3658
return self.modules.has_key(module_name)
3660
def includes(self, test_id):
3661
return self.tests.has_key(test_id)
3664
class TestPrefixAliasRegistry(registry.Registry):
3665
"""A registry for test prefix aliases.
3667
This helps implement shorcuts for the --starting-with selftest
3668
option. Overriding existing prefixes is not allowed but not fatal (a
3669
warning will be emitted).
3672
def register(self, key, obj, help=None, info=None,
3673
override_existing=False):
3674
"""See Registry.register.
3676
Trying to override an existing alias causes a warning to be emitted,
3677
not a fatal execption.
3680
super(TestPrefixAliasRegistry, self).register(
3681
key, obj, help=help, info=info, override_existing=False)
3683
actual = self.get(key)
3684
note('Test prefix alias %s is already used for %s, ignoring %s'
3685
% (key, actual, obj))
3687
def resolve_alias(self, id_start):
3688
"""Replace the alias by the prefix in the given string.
3690
Using an unknown prefix is an error to help catching typos.
3692
parts = id_start.split('.')
3694
parts[0] = self.get(parts[0])
3696
raise errors.BzrCommandError(
3697
'%s is not a known test prefix alias' % parts[0])
3698
return '.'.join(parts)
3701
test_prefix_alias_registry = TestPrefixAliasRegistry()
3702
"""Registry of test prefix aliases."""
3705
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3706
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3707
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3709
# Obvious higest levels prefixes, feel free to add your own via a plugin
3710
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3711
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3712
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3713
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3714
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3717
def _test_suite_testmod_names():
3718
"""Return the standard list of test module names to test."""
3721
'bzrlib.tests.blackbox',
3722
'bzrlib.tests.commands',
3723
'bzrlib.tests.per_branch',
3724
'bzrlib.tests.per_bzrdir',
3725
'bzrlib.tests.per_foreign_vcs',
3726
'bzrlib.tests.per_interrepository',
3727
'bzrlib.tests.per_intertree',
3728
'bzrlib.tests.per_inventory',
3729
'bzrlib.tests.per_interbranch',
3730
'bzrlib.tests.per_lock',
3731
'bzrlib.tests.per_transport',
3732
'bzrlib.tests.per_tree',
3733
'bzrlib.tests.per_pack_repository',
3734
'bzrlib.tests.per_repository',
3735
'bzrlib.tests.per_repository_chk',
3736
'bzrlib.tests.per_repository_reference',
3737
'bzrlib.tests.per_uifactory',
3738
'bzrlib.tests.per_versionedfile',
3739
'bzrlib.tests.per_workingtree',
3740
'bzrlib.tests.test__annotator',
3741
'bzrlib.tests.test__chk_map',
3742
'bzrlib.tests.test__dirstate_helpers',
3743
'bzrlib.tests.test__groupcompress',
3744
'bzrlib.tests.test__known_graph',
3745
'bzrlib.tests.test__rio',
3746
'bzrlib.tests.test__simple_set',
3747
'bzrlib.tests.test__static_tuple',
3748
'bzrlib.tests.test__walkdirs_win32',
3749
'bzrlib.tests.test_ancestry',
3750
'bzrlib.tests.test_annotate',
3751
'bzrlib.tests.test_api',
3752
'bzrlib.tests.test_atomicfile',
3753
'bzrlib.tests.test_bad_files',
3754
'bzrlib.tests.test_bencode',
3755
'bzrlib.tests.test_bisect_multi',
3756
'bzrlib.tests.test_branch',
3757
'bzrlib.tests.test_branchbuilder',
3758
'bzrlib.tests.test_btree_index',
3759
'bzrlib.tests.test_bugtracker',
3760
'bzrlib.tests.test_bundle',
3761
'bzrlib.tests.test_bzrdir',
3762
'bzrlib.tests.test__chunks_to_lines',
3763
'bzrlib.tests.test_cache_utf8',
3764
'bzrlib.tests.test_chk_map',
3765
'bzrlib.tests.test_chk_serializer',
3766
'bzrlib.tests.test_chunk_writer',
3767
'bzrlib.tests.test_clean_tree',
3768
'bzrlib.tests.test_cleanup',
3769
'bzrlib.tests.test_commands',
3770
'bzrlib.tests.test_commit',
3771
'bzrlib.tests.test_commit_merge',
3772
'bzrlib.tests.test_config',
3773
'bzrlib.tests.test_conflicts',
3774
'bzrlib.tests.test_counted_lock',
3775
'bzrlib.tests.test_crash',
3776
'bzrlib.tests.test_decorators',
3777
'bzrlib.tests.test_delta',
3778
'bzrlib.tests.test_debug',
3779
'bzrlib.tests.test_deprecated_graph',
3780
'bzrlib.tests.test_diff',
3781
'bzrlib.tests.test_directory_service',
3782
'bzrlib.tests.test_dirstate',
3783
'bzrlib.tests.test_email_message',
3784
'bzrlib.tests.test_eol_filters',
3785
'bzrlib.tests.test_errors',
3786
'bzrlib.tests.test_export',
3787
'bzrlib.tests.test_extract',
3788
'bzrlib.tests.test_fetch',
3789
'bzrlib.tests.test_fifo_cache',
3790
'bzrlib.tests.test_filters',
3791
'bzrlib.tests.test_ftp_transport',
3792
'bzrlib.tests.test_foreign',
3793
'bzrlib.tests.test_generate_docs',
3794
'bzrlib.tests.test_generate_ids',
3795
'bzrlib.tests.test_globbing',
3796
'bzrlib.tests.test_gpg',
3797
'bzrlib.tests.test_graph',
3798
'bzrlib.tests.test_groupcompress',
3799
'bzrlib.tests.test_hashcache',
3800
'bzrlib.tests.test_help',
3801
'bzrlib.tests.test_hooks',
3802
'bzrlib.tests.test_http',
3803
'bzrlib.tests.test_http_response',
3804
'bzrlib.tests.test_https_ca_bundle',
3805
'bzrlib.tests.test_identitymap',
3806
'bzrlib.tests.test_ignores',
3807
'bzrlib.tests.test_index',
3808
'bzrlib.tests.test_info',
3809
'bzrlib.tests.test_inv',
3810
'bzrlib.tests.test_inventory_delta',
3811
'bzrlib.tests.test_knit',
3812
'bzrlib.tests.test_lazy_import',
3813
'bzrlib.tests.test_lazy_regex',
3814
'bzrlib.tests.test_lock',
3815
'bzrlib.tests.test_lockable_files',
3816
'bzrlib.tests.test_lockdir',
3817
'bzrlib.tests.test_log',
3818
'bzrlib.tests.test_lru_cache',
3819
'bzrlib.tests.test_lsprof',
3820
'bzrlib.tests.test_mail_client',
3821
'bzrlib.tests.test_memorytree',
3822
'bzrlib.tests.test_merge',
3823
'bzrlib.tests.test_merge3',
3824
'bzrlib.tests.test_merge_core',
3825
'bzrlib.tests.test_merge_directive',
3826
'bzrlib.tests.test_missing',
3827
'bzrlib.tests.test_msgeditor',
3828
'bzrlib.tests.test_multiparent',
3829
'bzrlib.tests.test_mutabletree',
3830
'bzrlib.tests.test_nonascii',
3831
'bzrlib.tests.test_options',
3832
'bzrlib.tests.test_osutils',
3833
'bzrlib.tests.test_osutils_encodings',
3834
'bzrlib.tests.test_pack',
3835
'bzrlib.tests.test_patch',
3836
'bzrlib.tests.test_patches',
3837
'bzrlib.tests.test_permissions',
3838
'bzrlib.tests.test_plugins',
3839
'bzrlib.tests.test_progress',
3840
'bzrlib.tests.test_read_bundle',
3841
'bzrlib.tests.test_reconcile',
3842
'bzrlib.tests.test_reconfigure',
3843
'bzrlib.tests.test_registry',
3844
'bzrlib.tests.test_remote',
3845
'bzrlib.tests.test_rename_map',
3846
'bzrlib.tests.test_repository',
3847
'bzrlib.tests.test_revert',
3848
'bzrlib.tests.test_revision',
3849
'bzrlib.tests.test_revisionspec',
3850
'bzrlib.tests.test_revisiontree',
3851
'bzrlib.tests.test_rio',
3852
'bzrlib.tests.test_rules',
3853
'bzrlib.tests.test_sampler',
3854
'bzrlib.tests.test_script',
3855
'bzrlib.tests.test_selftest',
3856
'bzrlib.tests.test_serializer',
3857
'bzrlib.tests.test_setup',
3858
'bzrlib.tests.test_sftp_transport',
3859
'bzrlib.tests.test_shelf',
3860
'bzrlib.tests.test_shelf_ui',
3861
'bzrlib.tests.test_smart',
3862
'bzrlib.tests.test_smart_add',
3863
'bzrlib.tests.test_smart_request',
3864
'bzrlib.tests.test_smart_transport',
3865
'bzrlib.tests.test_smtp_connection',
3866
'bzrlib.tests.test_source',
3867
'bzrlib.tests.test_ssh_transport',
3868
'bzrlib.tests.test_status',
3869
'bzrlib.tests.test_store',
3870
'bzrlib.tests.test_strace',
3871
'bzrlib.tests.test_subsume',
3872
'bzrlib.tests.test_switch',
3873
'bzrlib.tests.test_symbol_versioning',
3874
'bzrlib.tests.test_tag',
3875
'bzrlib.tests.test_testament',
3876
'bzrlib.tests.test_textfile',
3877
'bzrlib.tests.test_textmerge',
3878
'bzrlib.tests.test_timestamp',
3879
'bzrlib.tests.test_trace',
3880
'bzrlib.tests.test_transactions',
3881
'bzrlib.tests.test_transform',
3882
'bzrlib.tests.test_transport',
3883
'bzrlib.tests.test_transport_log',
3884
'bzrlib.tests.test_tree',
3885
'bzrlib.tests.test_treebuilder',
3886
'bzrlib.tests.test_tsort',
3887
'bzrlib.tests.test_tuned_gzip',
3888
'bzrlib.tests.test_ui',
3889
'bzrlib.tests.test_uncommit',
3890
'bzrlib.tests.test_upgrade',
3891
'bzrlib.tests.test_upgrade_stacked',
3892
'bzrlib.tests.test_urlutils',
3893
'bzrlib.tests.test_version',
3894
'bzrlib.tests.test_version_info',
3895
'bzrlib.tests.test_weave',
3896
'bzrlib.tests.test_whitebox',
3897
'bzrlib.tests.test_win32utils',
3898
'bzrlib.tests.test_workingtree',
3899
'bzrlib.tests.test_workingtree_4',
3900
'bzrlib.tests.test_wsgi',
3901
'bzrlib.tests.test_xml',
3905
def _test_suite_modules_to_doctest():
3906
"""Return the list of modules to doctest."""
3909
'bzrlib.branchbuilder',
3912
'bzrlib.iterablefile',
3916
'bzrlib.symbol_versioning',
3919
'bzrlib.version_info_formats.format_custom',
3923
def test_suite(keep_only=None, starting_with=None):
3924
"""Build and return TestSuite for the whole of bzrlib.
3926
:param keep_only: A list of test ids limiting the suite returned.
3928
:param starting_with: An id limiting the suite returned to the tests
3931
This function can be replaced if you need to change the default test
3932
suite on a global basis, but it is not encouraged.
3935
loader = TestUtil.TestLoader()
3937
if keep_only is not None:
3938
id_filter = TestIdList(keep_only)
3940
# We take precedence over keep_only because *at loading time* using
3941
# both options means we will load less tests for the same final result.
3942
def interesting_module(name):
3943
for start in starting_with:
3945
# Either the module name starts with the specified string
3946
name.startswith(start)
3947
# or it may contain tests starting with the specified string
3948
or start.startswith(name)
3952
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3954
elif keep_only is not None:
3955
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3956
def interesting_module(name):
3957
return id_filter.refers_to(name)
3960
loader = TestUtil.TestLoader()
3961
def interesting_module(name):
3962
# No filtering, all modules are interesting
3965
suite = loader.suiteClass()
3967
# modules building their suite with loadTestsFromModuleNames
3968
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3970
for mod in _test_suite_modules_to_doctest():
3971
if not interesting_module(mod):
3972
# No tests to keep here, move along
3975
# note that this really does mean "report only" -- doctest
3976
# still runs the rest of the examples
3977
doc_suite = doctest.DocTestSuite(mod,
3978
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3979
except ValueError, e:
3980
print '**failed to get doctest for: %s\n%s' % (mod, e)
3982
if len(doc_suite._tests) == 0:
3983
raise errors.BzrError("no doctests found in %s" % (mod,))
3984
suite.addTest(doc_suite)
3986
default_encoding = sys.getdefaultencoding()
3987
for name, plugin in bzrlib.plugin.plugins().items():
3988
if not interesting_module(plugin.module.__name__):
3990
plugin_suite = plugin.test_suite()
3991
# We used to catch ImportError here and turn it into just a warning,
3992
# but really if you don't have --no-plugins this should be a failure.
3993
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3994
if plugin_suite is None:
3995
plugin_suite = plugin.load_plugin_tests(loader)
3996
if plugin_suite is not None:
3997
suite.addTest(plugin_suite)
3998
if default_encoding != sys.getdefaultencoding():
3999
bzrlib.trace.warning(
4000
'Plugin "%s" tried to reset default encoding to: %s', name,
4001
sys.getdefaultencoding())
4003
sys.setdefaultencoding(default_encoding)
4005
if keep_only is not None:
4006
# Now that the referred modules have loaded their tests, keep only the
4008
suite = filter_suite_by_id_list(suite, id_filter)
4009
# Do some sanity checks on the id_list filtering
4010
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4012
# The tester has used both keep_only and starting_with, so he is
4013
# already aware that some tests are excluded from the list, there
4014
# is no need to tell him which.
4017
# Some tests mentioned in the list are not in the test suite. The
4018
# list may be out of date, report to the tester.
4019
for id in not_found:
4020
bzrlib.trace.warning('"%s" not found in the test suite', id)
4021
for id in duplicates:
4022
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
4027
def multiply_scenarios(scenarios_left, scenarios_right):
4028
"""Multiply two sets of scenarios.
4030
:returns: the cartesian product of the two sets of scenarios, that is
4031
a scenario for every possible combination of a left scenario and a
4035
('%s,%s' % (left_name, right_name),
4036
dict(left_dict.items() + right_dict.items()))
4037
for left_name, left_dict in scenarios_left
4038
for right_name, right_dict in scenarios_right]
4041
def multiply_tests(tests, scenarios, result):
4042
"""Multiply tests_list by scenarios into result.
4044
This is the core workhorse for test parameterisation.
4046
Typically the load_tests() method for a per-implementation test suite will
4047
call multiply_tests and return the result.
4049
:param tests: The tests to parameterise.
4050
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4051
scenario_param_dict).
4052
:param result: A TestSuite to add created tests to.
4054
This returns the passed in result TestSuite with the cross product of all
4055
the tests repeated once for each scenario. Each test is adapted by adding
4056
the scenario name at the end of its id(), and updating the test object's
4057
__dict__ with the scenario_param_dict.
4059
>>> import bzrlib.tests.test_sampler
4060
>>> r = multiply_tests(
4061
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4062
... [('one', dict(param=1)),
4063
... ('two', dict(param=2))],
4065
>>> tests = list(iter_suite_tests(r))
4069
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4075
for test in iter_suite_tests(tests):
4076
apply_scenarios(test, scenarios, result)
4080
def apply_scenarios(test, scenarios, result):
4081
"""Apply the scenarios in scenarios to test and add to result.
4083
:param test: The test to apply scenarios to.
4084
:param scenarios: An iterable of scenarios to apply to test.
4086
:seealso: apply_scenario
4088
for scenario in scenarios:
4089
result.addTest(apply_scenario(test, scenario))
4093
def apply_scenario(test, scenario):
4094
"""Copy test and apply scenario to it.
4096
:param test: A test to adapt.
4097
:param scenario: A tuple describing the scenarion.
4098
The first element of the tuple is the new test id.
4099
The second element is a dict containing attributes to set on the
4101
:return: The adapted test.
4103
new_id = "%s(%s)" % (test.id(), scenario[0])
4104
new_test = clone_test(test, new_id)
4105
for name, value in scenario[1].items():
4106
setattr(new_test, name, value)
4110
def clone_test(test, new_id):
4111
"""Clone a test giving it a new id.
4113
:param test: The test to clone.
4114
:param new_id: The id to assign to it.
4115
:return: The new test.
4117
new_test = copy(test)
4118
new_test.id = lambda: new_id
4122
def _rmtree_temp_dir(dirname):
4123
# If LANG=C we probably have created some bogus paths
4124
# which rmtree(unicode) will fail to delete
4125
# so make sure we are using rmtree(str) to delete everything
4126
# except on win32, where rmtree(str) will fail
4127
# since it doesn't have the property of byte-stream paths
4128
# (they are either ascii or mbcs)
4129
if sys.platform == 'win32':
4130
# make sure we are using the unicode win32 api
4131
dirname = unicode(dirname)
4133
dirname = dirname.encode(sys.getfilesystemencoding())
4135
osutils.rmtree(dirname)
4137
# We don't want to fail here because some useful display will be lost
4138
# otherwise. Polluting the tmp dir is bad, but not giving all the
4139
# possible info to the test runner is even worse.
4140
sys.stderr.write('Unable to remove testing dir %s\n%s'
4141
% (os.path.basename(dirname), e))
4144
class Feature(object):
4145
"""An operating system Feature."""
4148
self._available = None
4150
def available(self):
4151
"""Is the feature available?
4153
:return: True if the feature is available.
4155
if self._available is None:
4156
self._available = self._probe()
4157
return self._available
4160
"""Implement this method in concrete features.
4162
:return: True if the feature is available.
4164
raise NotImplementedError
4167
if getattr(self, 'feature_name', None):
4168
return self.feature_name()
4169
return self.__class__.__name__
4172
class _SymlinkFeature(Feature):
4175
return osutils.has_symlinks()
4177
def feature_name(self):
4180
SymlinkFeature = _SymlinkFeature()
4183
class _HardlinkFeature(Feature):
4186
return osutils.has_hardlinks()
4188
def feature_name(self):
4191
HardlinkFeature = _HardlinkFeature()
4194
class _OsFifoFeature(Feature):
4197
return getattr(os, 'mkfifo', None)
4199
def feature_name(self):
4200
return 'filesystem fifos'
4202
OsFifoFeature = _OsFifoFeature()
4205
class _UnicodeFilenameFeature(Feature):
4206
"""Does the filesystem support Unicode filenames?"""
4210
# Check for character combinations unlikely to be covered by any
4211
# single non-unicode encoding. We use the characters
4212
# - greek small letter alpha (U+03B1) and
4213
# - braille pattern dots-123456 (U+283F).
4214
os.stat(u'\u03b1\u283f')
4215
except UnicodeEncodeError:
4217
except (IOError, OSError):
4218
# The filesystem allows the Unicode filename but the file doesn't
4222
# The filesystem allows the Unicode filename and the file exists,
4226
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4229
def probe_unicode_in_user_encoding():
4230
"""Try to encode several unicode strings to use in unicode-aware tests.
4231
Return first successfull match.
4233
:return: (unicode value, encoded plain string value) or (None, None)
4235
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4236
for uni_val in possible_vals:
4238
str_val = uni_val.encode(osutils.get_user_encoding())
4239
except UnicodeEncodeError:
4240
# Try a different character
4243
return uni_val, str_val
4247
def probe_bad_non_ascii(encoding):
4248
"""Try to find [bad] character with code [128..255]
4249
that cannot be decoded to unicode in some encoding.
4250
Return None if all non-ascii characters is valid
4253
for i in xrange(128, 256):
4256
char.decode(encoding)
4257
except UnicodeDecodeError:
4262
class _HTTPSServerFeature(Feature):
4263
"""Some tests want an https Server, check if one is available.
4265
Right now, the only way this is available is under python2.6 which provides
4276
def feature_name(self):
4277
return 'HTTPSServer'
4280
HTTPSServerFeature = _HTTPSServerFeature()
4283
class _ParamikoFeature(Feature):
4284
"""Is paramiko available?"""
4288
from bzrlib.transport.sftp import SFTPAbsoluteServer
4290
except errors.ParamikoNotPresent:
4293
def feature_name(self):
4297
ParamikoFeature = _ParamikoFeature()
4300
class _UnicodeFilename(Feature):
4301
"""Does the filesystem support Unicode filenames?"""
4306
except UnicodeEncodeError:
4308
except (IOError, OSError):
4309
# The filesystem allows the Unicode filename but the file doesn't
4313
# The filesystem allows the Unicode filename and the file exists,
4317
UnicodeFilename = _UnicodeFilename()
4320
class _UTF8Filesystem(Feature):
4321
"""Is the filesystem UTF-8?"""
4324
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4328
UTF8Filesystem = _UTF8Filesystem()
4331
class _BreakinFeature(Feature):
4332
"""Does this platform support the breakin feature?"""
4335
from bzrlib import breakin
4336
if breakin.determine_signal() is None:
4338
if sys.platform == 'win32':
4339
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4340
# We trigger SIGBREAK via a Console api so we need ctypes to
4341
# access the function
4348
def feature_name(self):
4349
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4352
BreakinFeature = _BreakinFeature()
4355
class _CaseInsCasePresFilenameFeature(Feature):
4356
"""Is the file-system case insensitive, but case-preserving?"""
4359
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4361
# first check truly case-preserving for created files, then check
4362
# case insensitive when opening existing files.
4363
name = osutils.normpath(name)
4364
base, rel = osutils.split(name)
4365
found_rel = osutils.canonical_relpath(base, name)
4366
return (found_rel == rel
4367
and os.path.isfile(name.upper())
4368
and os.path.isfile(name.lower()))
4373
def feature_name(self):
4374
return "case-insensitive case-preserving filesystem"
4376
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4379
class _CaseInsensitiveFilesystemFeature(Feature):
4380
"""Check if underlying filesystem is case-insensitive but *not* case
4383
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4384
# more likely to be case preserving, so this case is rare.
4387
if CaseInsCasePresFilenameFeature.available():
4390
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4391
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4392
TestCaseWithMemoryTransport.TEST_ROOT = root
4394
root = TestCaseWithMemoryTransport.TEST_ROOT
4395
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4397
name_a = osutils.pathjoin(tdir, 'a')
4398
name_A = osutils.pathjoin(tdir, 'A')
4400
result = osutils.isdir(name_A)
4401
_rmtree_temp_dir(tdir)
4404
def feature_name(self):
4405
return 'case-insensitive filesystem'
4407
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4410
class _SubUnitFeature(Feature):
4411
"""Check if subunit is available."""
4420
def feature_name(self):
4423
SubUnitFeature = _SubUnitFeature()
4424
# Only define SubUnitBzrRunner if subunit is available.
4426
from subunit import TestProtocolClient
4427
class SubUnitBzrRunner(TextTestRunner):
4428
def run(self, test):
4429
result = BzrAutoTimingTestResultDecorator(
4430
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
