1
# Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 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
54
# nb: check this before importing anything else from within it
55
_testtools_version = getattr(testtools, '__version__', ())
56
if _testtools_version < (0, 9, 2):
57
raise ImportError("need at least testtools 0.9.2: %s is %r"
58
% (testtools.__file__, _testtools_version))
59
from testtools import content
79
import bzrlib.commands
80
import bzrlib.timestamp
82
import bzrlib.inventory
83
import bzrlib.iterablefile
88
# lsprof not available
90
from bzrlib.merge import merge_inner
93
from bzrlib.smart import client, request, server
95
from bzrlib import symbol_versioning
96
from bzrlib.symbol_versioning import (
104
from bzrlib.transport import get_transport, pathfilter
105
import bzrlib.transport
106
from bzrlib.transport.local import LocalURLServer
107
from bzrlib.transport.memory import MemoryServer
108
from bzrlib.transport.readonly import ReadonlyServer
109
from bzrlib.trace import mutter, note
110
from bzrlib.tests import TestUtil
111
from bzrlib.tests.http_server import HttpServer
112
from bzrlib.tests.TestUtil import (
116
from bzrlib.tests.treeshape import build_tree_contents
117
from bzrlib.ui import NullProgressView
118
from bzrlib.ui.text import TextUIFactory
119
import bzrlib.version_info_formats.format_custom
120
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
122
# Mark this python module as being part of the implementation
123
# of unittest: this gives us better tracebacks where the last
124
# shown frame is the test code, not our assertXYZ.
127
default_transport = LocalURLServer
130
_unitialized_attr = object()
131
"""A sentinel needed to act as a default value in a method signature."""
134
# Subunit result codes, defined here to prevent a hard dependency on subunit.
139
class ExtendedTestResult(unittest._TextTestResult):
140
"""Accepts, reports and accumulates the results of running tests.
142
Compared to the unittest version this class adds support for
143
profiling, benchmarking, stopping as soon as a test fails, and
144
skipping tests. There are further-specialized subclasses for
145
different types of display.
147
When a test finishes, in whatever way, it calls one of the addSuccess,
148
addFailure or addError classes. These in turn may redirect to a more
149
specific case for the special test results supported by our extended
152
Note that just one of these objects is fed the results from many tests.
157
def __init__(self, stream, descriptions, verbosity,
161
"""Construct new TestResult.
163
:param bench_history: Optionally, a writable file object to accumulate
166
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
167
if bench_history is not None:
168
from bzrlib.version import _get_bzr_source_tree
169
src_tree = _get_bzr_source_tree()
172
revision_id = src_tree.get_parent_ids()[0]
174
# XXX: if this is a brand new tree, do the same as if there
178
# XXX: If there's no branch, what should we do?
180
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
181
self._bench_history = bench_history
182
self.ui = ui.ui_factory
185
self.failure_count = 0
186
self.known_failure_count = 0
188
self.not_applicable_count = 0
189
self.unsupported = {}
191
self._overall_start_time = time.time()
192
self._strict = strict
194
def stopTestRun(self):
197
stopTime = time.time()
198
timeTaken = stopTime - self.startTime
200
self.stream.writeln(self.separator2)
201
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
202
run, run != 1 and "s" or "", timeTaken))
203
self.stream.writeln()
204
if not self.wasSuccessful():
205
self.stream.write("FAILED (")
206
failed, errored = map(len, (self.failures, self.errors))
208
self.stream.write("failures=%d" % failed)
210
if failed: self.stream.write(", ")
211
self.stream.write("errors=%d" % errored)
212
if self.known_failure_count:
213
if failed or errored: self.stream.write(", ")
214
self.stream.write("known_failure_count=%d" %
215
self.known_failure_count)
216
self.stream.writeln(")")
218
if self.known_failure_count:
219
self.stream.writeln("OK (known_failures=%d)" %
220
self.known_failure_count)
222
self.stream.writeln("OK")
223
if self.skip_count > 0:
224
skipped = self.skip_count
225
self.stream.writeln('%d test%s skipped' %
226
(skipped, skipped != 1 and "s" or ""))
228
for feature, count in sorted(self.unsupported.items()):
229
self.stream.writeln("Missing feature '%s' skipped %d tests." %
232
ok = self.wasStrictlySuccessful()
234
ok = self.wasSuccessful()
235
if TestCase._first_thread_leaker_id:
237
'%s is leaking threads among %d leaking tests.\n' % (
238
TestCase._first_thread_leaker_id,
239
TestCase._leaking_threads_tests))
240
# We don't report the main thread as an active one.
242
'%d non-main threads were left active in the end.\n'
243
% (TestCase._active_threads - 1))
245
def getDescription(self, test):
248
def _extractBenchmarkTime(self, testCase, details=None):
249
"""Add a benchmark time for the current test case."""
250
if details and 'benchtime' in details:
251
return float(''.join(details['benchtime'].iter_bytes()))
252
return getattr(testCase, "_benchtime", None)
254
def _elapsedTestTimeString(self):
255
"""Return a time string for the overall time the current test has taken."""
256
return self._formatTime(time.time() - self._start_time)
258
def _testTimeString(self, testCase):
259
benchmark_time = self._extractBenchmarkTime(testCase)
260
if benchmark_time is not None:
261
return self._formatTime(benchmark_time) + "*"
263
return self._elapsedTestTimeString()
265
def _formatTime(self, seconds):
266
"""Format seconds as milliseconds with leading spaces."""
267
# some benchmarks can take thousands of seconds to run, so we need 8
269
return "%8dms" % (1000 * seconds)
271
def _shortened_test_description(self, test):
273
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
276
def startTest(self, test):
277
unittest.TestResult.startTest(self, test)
280
self.report_test_start(test)
281
test.number = self.count
282
self._recordTestStartTime()
284
def startTests(self):
286
if getattr(sys, 'frozen', None) is None:
287
bzr_path = osutils.realpath(sys.argv[0])
289
bzr_path = sys.executable
291
'bzr selftest: %s\n' % (bzr_path,))
294
bzrlib.__path__[0],))
296
' bzr-%s python-%s %s\n' % (
297
bzrlib.version_string,
298
bzrlib._format_version_tuple(sys.version_info),
299
platform.platform(aliased=1),
301
self.stream.write('\n')
303
def _recordTestStartTime(self):
304
"""Record that a test has started."""
305
self._start_time = time.time()
307
def _cleanupLogFile(self, test):
308
# We can only do this if we have one of our TestCases, not if
310
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
311
if setKeepLogfile is not None:
314
def addError(self, test, err):
315
"""Tell result that test finished with an error.
317
Called from the TestCase run() method when the test
318
fails with an unexpected error.
321
unittest.TestResult.addError(self, test, err)
322
self.error_count += 1
323
self.report_error(test, err)
326
self._cleanupLogFile(test)
328
def addFailure(self, test, err):
329
"""Tell result that test failed.
331
Called from the TestCase run() method when the test
332
fails because e.g. an assert() method failed.
335
unittest.TestResult.addFailure(self, test, err)
336
self.failure_count += 1
337
self.report_failure(test, err)
340
self._cleanupLogFile(test)
342
def addSuccess(self, test, details=None):
343
"""Tell result that test completed successfully.
345
Called from the TestCase run()
347
if self._bench_history is not None:
348
benchmark_time = self._extractBenchmarkTime(test, details)
349
if benchmark_time is not None:
350
self._bench_history.write("%s %s\n" % (
351
self._formatTime(benchmark_time),
353
self.report_success(test)
354
self._cleanupLogFile(test)
355
unittest.TestResult.addSuccess(self, test)
356
test._log_contents = ''
358
def addExpectedFailure(self, test, err):
359
self.known_failure_count += 1
360
self.report_known_failure(test, err)
362
def addNotSupported(self, test, feature):
363
"""The test will not be run because of a missing feature.
365
# this can be called in two different ways: it may be that the
366
# test started running, and then raised (through requireFeature)
367
# UnavailableFeature. Alternatively this method can be called
368
# while probing for features before running the test code proper; in
369
# that case we will see startTest and stopTest, but the test will
370
# never actually run.
371
self.unsupported.setdefault(str(feature), 0)
372
self.unsupported[str(feature)] += 1
373
self.report_unsupported(test, feature)
375
def addSkip(self, test, reason):
376
"""A test has not run for 'reason'."""
378
self.report_skip(test, reason)
380
def addNotApplicable(self, test, reason):
381
self.not_applicable_count += 1
382
self.report_not_applicable(test, reason)
384
def _post_mortem(self):
385
"""Start a PDB post mortem session."""
386
if os.environ.get('BZR_TEST_PDB', None):
387
import pdb;pdb.post_mortem()
389
def progress(self, offset, whence):
390
"""The test is adjusting the count of tests to run."""
391
if whence == SUBUNIT_SEEK_SET:
392
self.num_tests = offset
393
elif whence == SUBUNIT_SEEK_CUR:
394
self.num_tests += offset
396
raise errors.BzrError("Unknown whence %r" % whence)
398
def report_cleaning_up(self):
401
def startTestRun(self):
402
self.startTime = time.time()
404
def report_success(self, test):
407
def wasStrictlySuccessful(self):
408
if self.unsupported or self.known_failure_count:
410
return self.wasSuccessful()
413
class TextTestResult(ExtendedTestResult):
414
"""Displays progress and results of tests in text form"""
416
def __init__(self, stream, descriptions, verbosity,
421
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
422
bench_history, strict)
423
# We no longer pass them around, but just rely on the UIFactory stack
426
warnings.warn("Passing pb to TextTestResult is deprecated")
427
self.pb = self.ui.nested_progress_bar()
428
self.pb.show_pct = False
429
self.pb.show_spinner = False
430
self.pb.show_eta = False,
431
self.pb.show_count = False
432
self.pb.show_bar = False
433
self.pb.update_latency = 0
434
self.pb.show_transport_activity = False
436
def stopTestRun(self):
437
# called when the tests that are going to run have run
440
super(TextTestResult, self).stopTestRun()
442
def startTestRun(self):
443
super(TextTestResult, self).startTestRun()
444
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
446
def printErrors(self):
447
# clear the pb to make room for the error listing
449
super(TextTestResult, self).printErrors()
451
def _progress_prefix_text(self):
452
# the longer this text, the less space we have to show the test
454
a = '[%d' % self.count # total that have been run
455
# tests skipped as known not to be relevant are not important enough
457
## if self.skip_count:
458
## a += ', %d skip' % self.skip_count
459
## if self.known_failure_count:
460
## a += '+%dX' % self.known_failure_count
462
a +='/%d' % self.num_tests
464
runtime = time.time() - self._overall_start_time
466
a += '%dm%ds' % (runtime / 60, runtime % 60)
469
total_fail_count = self.error_count + self.failure_count
471
a += ', %d failed' % total_fail_count
472
# if self.unsupported:
473
# a += ', %d missing' % len(self.unsupported)
477
def report_test_start(self, test):
480
self._progress_prefix_text()
482
+ self._shortened_test_description(test))
484
def _test_description(self, test):
485
return self._shortened_test_description(test)
487
def report_error(self, test, err):
488
self.ui.note('ERROR: %s\n %s\n' % (
489
self._test_description(test),
493
def report_failure(self, test, err):
494
self.ui.note('FAIL: %s\n %s\n' % (
495
self._test_description(test),
499
def report_known_failure(self, test, err):
502
def report_skip(self, test, reason):
505
def report_not_applicable(self, test, reason):
508
def report_unsupported(self, test, feature):
509
"""test cannot be run because feature is missing."""
511
def report_cleaning_up(self):
512
self.pb.update('Cleaning up')
515
class VerboseTestResult(ExtendedTestResult):
516
"""Produce long output, with one line per test run plus times"""
518
def _ellipsize_to_right(self, a_string, final_width):
519
"""Truncate and pad a string, keeping the right hand side"""
520
if len(a_string) > final_width:
521
result = '...' + a_string[3-final_width:]
524
return result.ljust(final_width)
526
def startTestRun(self):
527
super(VerboseTestResult, self).startTestRun()
528
self.stream.write('running %d tests...\n' % self.num_tests)
530
def report_test_start(self, test):
532
name = self._shortened_test_description(test)
533
width = osutils.terminal_width()
534
if width is not None:
535
# width needs space for 6 char status, plus 1 for slash, plus an
536
# 11-char time string, plus a trailing blank
537
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
539
self.stream.write(self._ellipsize_to_right(name, width-18))
541
self.stream.write(name)
544
def _error_summary(self, err):
546
return '%s%s' % (indent, err[1])
548
def report_error(self, test, err):
549
self.stream.writeln('ERROR %s\n%s'
550
% (self._testTimeString(test),
551
self._error_summary(err)))
553
def report_failure(self, test, err):
554
self.stream.writeln(' FAIL %s\n%s'
555
% (self._testTimeString(test),
556
self._error_summary(err)))
558
def report_known_failure(self, test, err):
559
self.stream.writeln('XFAIL %s\n%s'
560
% (self._testTimeString(test),
561
self._error_summary(err)))
563
def report_success(self, test):
564
self.stream.writeln(' OK %s' % self._testTimeString(test))
565
for bench_called, stats in getattr(test, '_benchcalls', []):
566
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
567
stats.pprint(file=self.stream)
568
# flush the stream so that we get smooth output. This verbose mode is
569
# used to show the output in PQM.
572
def report_skip(self, test, reason):
573
self.stream.writeln(' SKIP %s\n%s'
574
% (self._testTimeString(test), reason))
576
def report_not_applicable(self, test, reason):
577
self.stream.writeln(' N/A %s\n %s'
578
% (self._testTimeString(test), reason))
580
def report_unsupported(self, test, feature):
581
"""test cannot be run because feature is missing."""
582
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
583
%(self._testTimeString(test), feature))
586
class TextTestRunner(object):
587
stop_on_failure = False
595
result_decorators=None,
597
"""Create a TextTestRunner.
599
:param result_decorators: An optional list of decorators to apply
600
to the result object being used by the runner. Decorators are
601
applied left to right - the first element in the list is the
604
# stream may know claim to know to write unicode strings, but in older
605
# pythons this goes sufficiently wrong that it is a bad idea. (
606
# specifically a built in file with encoding 'UTF-8' will still try
607
# to encode using ascii.
608
new_encoding = osutils.get_terminal_encoding()
609
codec = codecs.lookup(new_encoding)
610
if type(codec) is tuple:
614
encode = codec.encode
615
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
616
stream.encoding = new_encoding
617
self.stream = unittest._WritelnDecorator(stream)
618
self.descriptions = descriptions
619
self.verbosity = verbosity
620
self._bench_history = bench_history
621
self._strict = strict
622
self._result_decorators = result_decorators or []
625
"Run the given test case or test suite."
626
if self.verbosity == 1:
627
result_class = TextTestResult
628
elif self.verbosity >= 2:
629
result_class = VerboseTestResult
630
original_result = result_class(self.stream,
633
bench_history=self._bench_history,
636
# Signal to result objects that look at stop early policy to stop,
637
original_result.stop_early = self.stop_on_failure
638
result = original_result
639
for decorator in self._result_decorators:
640
result = decorator(result)
641
result.stop_early = self.stop_on_failure
642
result.startTestRun()
647
# higher level code uses our extended protocol to determine
648
# what exit code to give.
649
return original_result
652
def iter_suite_tests(suite):
653
"""Return all tests in a suite, recursing through nested suites"""
654
if isinstance(suite, unittest.TestCase):
656
elif isinstance(suite, unittest.TestSuite):
658
for r in iter_suite_tests(item):
661
raise Exception('unknown type %r for object %r'
662
% (type(suite), suite))
665
TestSkipped = testtools.testcase.TestSkipped
668
class TestNotApplicable(TestSkipped):
669
"""A test is not applicable to the situation where it was run.
671
This is only normally raised by parameterized tests, if they find that
672
the instance they're constructed upon does not support one aspect
677
# traceback._some_str fails to format exceptions that have the default
678
# __str__ which does an implicit ascii conversion. However, repr() on those
679
# objects works, for all that its not quite what the doctor may have ordered.
680
def _clever_some_str(value):
685
return repr(value).replace('\\n', '\n')
687
return '<unprintable %s object>' % type(value).__name__
689
traceback._some_str = _clever_some_str
692
# deprecated - use self.knownFailure(), or self.expectFailure.
693
KnownFailure = testtools.testcase._ExpectedFailure
696
class UnavailableFeature(Exception):
697
"""A feature required for this test was not available.
699
This can be considered a specialised form of SkippedTest.
701
The feature should be used to construct the exception.
705
class StringIOWrapper(object):
706
"""A wrapper around cStringIO which just adds an encoding attribute.
708
Internally we can check sys.stdout to see what the output encoding
709
should be. However, cStringIO has no encoding attribute that we can
710
set. So we wrap it instead.
715
def __init__(self, s=None):
717
self.__dict__['_cstring'] = StringIO(s)
719
self.__dict__['_cstring'] = StringIO()
721
def __getattr__(self, name, getattr=getattr):
722
return getattr(self.__dict__['_cstring'], name)
724
def __setattr__(self, name, val):
725
if name == 'encoding':
726
self.__dict__['encoding'] = val
728
return setattr(self._cstring, name, val)
731
class TestUIFactory(TextUIFactory):
732
"""A UI Factory for testing.
734
Hide the progress bar but emit note()s.
736
Allows get_password to be tested without real tty attached.
738
See also CannedInputUIFactory which lets you provide programmatic input in
741
# TODO: Capture progress events at the model level and allow them to be
742
# observed by tests that care.
744
# XXX: Should probably unify more with CannedInputUIFactory or a
745
# particular configuration of TextUIFactory, or otherwise have a clearer
746
# idea of how they're supposed to be different.
747
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
749
def __init__(self, stdout=None, stderr=None, stdin=None):
750
if stdin is not None:
751
# We use a StringIOWrapper to be able to test various
752
# encodings, but the user is still responsible to
753
# encode the string and to set the encoding attribute
754
# of StringIOWrapper.
755
stdin = StringIOWrapper(stdin)
756
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
758
def get_non_echoed_password(self):
759
"""Get password from stdin without trying to handle the echo mode"""
760
password = self.stdin.readline()
763
if password[-1] == '\n':
764
password = password[:-1]
767
def make_progress_view(self):
768
return NullProgressView()
771
class TestCase(testtools.TestCase):
772
"""Base class for bzr unit tests.
774
Tests that need access to disk resources should subclass
775
TestCaseInTempDir not TestCase.
777
Error and debug log messages are redirected from their usual
778
location into a temporary file, the contents of which can be
779
retrieved by _get_log(). We use a real OS file, not an in-memory object,
780
so that it can also capture file IO. When the test completes this file
781
is read into memory and removed from disk.
783
There are also convenience functions to invoke bzr's command-line
784
routine, and to build and check bzr trees.
786
In addition to the usual method of overriding tearDown(), this class also
787
allows subclasses to register functions into the _cleanups list, which is
788
run in order as the object is torn down. It's less likely this will be
789
accidentally overlooked.
792
_active_threads = None
793
_leaking_threads_tests = 0
794
_first_thread_leaker_id = None
795
_log_file_name = None
796
# record lsprof data when performing benchmark calls.
797
_gather_lsprof_in_benchmarks = False
799
def __init__(self, methodName='testMethod'):
800
super(TestCase, self).__init__(methodName)
802
self._directory_isolation = True
803
self.exception_handlers.insert(0,
804
(UnavailableFeature, self._do_unsupported_or_skip))
805
self.exception_handlers.insert(0,
806
(TestNotApplicable, self._do_not_applicable))
809
super(TestCase, self).setUp()
810
for feature in getattr(self, '_test_needs_features', []):
811
self.requireFeature(feature)
812
self._log_contents = None
813
self.addDetail("log", content.Content(content.ContentType("text",
814
"plain", {"charset": "utf8"}),
815
lambda:[self._get_log(keep_log_file=True)]))
816
self._cleanEnvironment()
819
self._benchcalls = []
820
self._benchtime = None
822
self._track_transports()
824
self._clear_debug_flags()
825
TestCase._active_threads = threading.activeCount()
826
self.addCleanup(self._check_leaked_threads)
831
pdb.Pdb().set_trace(sys._getframe().f_back)
833
def _check_leaked_threads(self):
834
active = threading.activeCount()
835
leaked_threads = active - TestCase._active_threads
836
TestCase._active_threads = active
837
# If some tests make the number of threads *decrease*, we'll consider
838
# that they are just observing old threads dieing, not agressively kill
839
# random threads. So we don't report these tests as leaking. The risk
840
# is that we have false positives that way (the test see 2 threads
841
# going away but leak one) but it seems less likely than the actual
842
# false positives (the test see threads going away and does not leak).
843
if leaked_threads > 0:
844
TestCase._leaking_threads_tests += 1
845
if TestCase._first_thread_leaker_id is None:
846
TestCase._first_thread_leaker_id = self.id()
848
def _clear_debug_flags(self):
849
"""Prevent externally set debug flags affecting tests.
851
Tests that want to use debug flags can just set them in the
852
debug_flags set during setup/teardown.
854
# Start with a copy of the current debug flags we can safely modify.
855
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
856
if 'allow_debug' not in selftest_debug_flags:
857
debug.debug_flags.clear()
858
if 'disable_lock_checks' not in selftest_debug_flags:
859
debug.debug_flags.add('strict_locks')
861
def _clear_hooks(self):
862
# prevent hooks affecting tests
863
self._preserved_hooks = {}
864
for key, factory in hooks.known_hooks.items():
865
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
866
current_hooks = hooks.known_hooks_key_to_object(key)
867
self._preserved_hooks[parent] = (name, current_hooks)
868
self.addCleanup(self._restoreHooks)
869
for key, factory in hooks.known_hooks.items():
870
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
871
setattr(parent, name, factory())
872
# this hook should always be installed
873
request._install_hook()
875
def disable_directory_isolation(self):
876
"""Turn off directory isolation checks."""
877
self._directory_isolation = False
879
def enable_directory_isolation(self):
880
"""Enable directory isolation checks."""
881
self._directory_isolation = True
883
def _silenceUI(self):
884
"""Turn off UI for duration of test"""
885
# by default the UI is off; tests can turn it on if they want it.
886
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
888
def _check_locks(self):
889
"""Check that all lock take/release actions have been paired."""
890
# We always check for mismatched locks. If a mismatch is found, we
891
# fail unless -Edisable_lock_checks is supplied to selftest, in which
892
# case we just print a warning.
894
acquired_locks = [lock for action, lock in self._lock_actions
895
if action == 'acquired']
896
released_locks = [lock for action, lock in self._lock_actions
897
if action == 'released']
898
broken_locks = [lock for action, lock in self._lock_actions
899
if action == 'broken']
900
# trivially, given the tests for lock acquistion and release, if we
901
# have as many in each list, it should be ok. Some lock tests also
902
# break some locks on purpose and should be taken into account by
903
# considering that breaking a lock is just a dirty way of releasing it.
904
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
905
message = ('Different number of acquired and '
906
'released or broken locks. (%s, %s + %s)' %
907
(acquired_locks, released_locks, broken_locks))
908
if not self._lock_check_thorough:
909
# Rather than fail, just warn
910
print "Broken test %s: %s" % (self, message)
914
def _track_locks(self):
915
"""Track lock activity during tests."""
916
self._lock_actions = []
917
if 'disable_lock_checks' in selftest_debug_flags:
918
self._lock_check_thorough = False
920
self._lock_check_thorough = True
922
self.addCleanup(self._check_locks)
923
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
924
self._lock_acquired, None)
925
_mod_lock.Lock.hooks.install_named_hook('lock_released',
926
self._lock_released, None)
927
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
928
self._lock_broken, None)
930
def _lock_acquired(self, result):
931
self._lock_actions.append(('acquired', result))
933
def _lock_released(self, result):
934
self._lock_actions.append(('released', result))
936
def _lock_broken(self, result):
937
self._lock_actions.append(('broken', result))
939
def permit_dir(self, name):
940
"""Permit a directory to be used by this test. See permit_url."""
941
name_transport = get_transport(name)
942
self.permit_url(name)
943
self.permit_url(name_transport.base)
945
def permit_url(self, url):
946
"""Declare that url is an ok url to use in this test.
948
Do this for memory transports, temporary test directory etc.
950
Do not do this for the current working directory, /tmp, or any other
951
preexisting non isolated url.
953
if not url.endswith('/'):
955
self._bzr_selftest_roots.append(url)
957
def permit_source_tree_branch_repo(self):
958
"""Permit the source tree bzr is running from to be opened.
960
Some code such as bzrlib.version attempts to read from the bzr branch
961
that bzr is executing from (if any). This method permits that directory
962
to be used in the test suite.
964
path = self.get_source_path()
965
self.record_directory_isolation()
968
workingtree.WorkingTree.open(path)
969
except (errors.NotBranchError, errors.NoWorkingTree):
972
self.enable_directory_isolation()
974
def _preopen_isolate_transport(self, transport):
975
"""Check that all transport openings are done in the test work area."""
976
while isinstance(transport, pathfilter.PathFilteringTransport):
977
# Unwrap pathfiltered transports
978
transport = transport.server.backing_transport.clone(
979
transport._filter('.'))
981
# ReadonlySmartTCPServer_for_testing decorates the backing transport
982
# urls it is given by prepending readonly+. This is appropriate as the
983
# client shouldn't know that the server is readonly (or not readonly).
984
# We could register all servers twice, with readonly+ prepending, but
985
# that makes for a long list; this is about the same but easier to
987
if url.startswith('readonly+'):
988
url = url[len('readonly+'):]
989
self._preopen_isolate_url(url)
991
def _preopen_isolate_url(self, url):
992
if not self._directory_isolation:
994
if self._directory_isolation == 'record':
995
self._bzr_selftest_roots.append(url)
997
# This prevents all transports, including e.g. sftp ones backed on disk
998
# from working unless they are explicitly granted permission. We then
999
# depend on the code that sets up test transports to check that they are
1000
# appropriately isolated and enable their use by calling
1001
# self.permit_transport()
1002
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1003
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1004
% (url, self._bzr_selftest_roots))
1006
def record_directory_isolation(self):
1007
"""Gather accessed directories to permit later access.
1009
This is used for tests that access the branch bzr is running from.
1011
self._directory_isolation = "record"
1013
def start_server(self, transport_server, backing_server=None):
1014
"""Start transport_server for this test.
1016
This starts the server, registers a cleanup for it and permits the
1017
server's urls to be used.
1019
if backing_server is None:
1020
transport_server.start_server()
1022
transport_server.start_server(backing_server)
1023
self.addCleanup(transport_server.stop_server)
1024
# Obtain a real transport because if the server supplies a password, it
1025
# will be hidden from the base on the client side.
1026
t = get_transport(transport_server.get_url())
1027
# Some transport servers effectively chroot the backing transport;
1028
# others like SFTPServer don't - users of the transport can walk up the
1029
# transport to read the entire backing transport. This wouldn't matter
1030
# except that the workdir tests are given - and that they expect the
1031
# server's url to point at - is one directory under the safety net. So
1032
# Branch operations into the transport will attempt to walk up one
1033
# directory. Chrooting all servers would avoid this but also mean that
1034
# we wouldn't be testing directly against non-root urls. Alternatively
1035
# getting the test framework to start the server with a backing server
1036
# at the actual safety net directory would work too, but this then
1037
# means that the self.get_url/self.get_transport methods would need
1038
# to transform all their results. On balance its cleaner to handle it
1039
# here, and permit a higher url when we have one of these transports.
1040
if t.base.endswith('/work/'):
1041
# we have safety net/test root/work
1042
t = t.clone('../..')
1043
elif isinstance(transport_server, server.SmartTCPServer_for_testing):
1044
# The smart server adds a path similar to work, which is traversed
1045
# up from by the client. But the server is chrooted - the actual
1046
# backing transport is not escaped from, and VFS requests to the
1047
# root will error (because they try to escape the chroot).
1049
while t2.base != t.base:
1052
self.permit_url(t.base)
1054
def _track_transports(self):
1055
"""Install checks for transport usage."""
1056
# TestCase has no safe place it can write to.
1057
self._bzr_selftest_roots = []
1058
# Currently the easiest way to be sure that nothing is going on is to
1059
# hook into bzr dir opening. This leaves a small window of error for
1060
# transport tests, but they are well known, and we can improve on this
1062
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1063
self._preopen_isolate_transport, "Check bzr directories are safe.")
1065
def _ndiff_strings(self, a, b):
1066
"""Return ndiff between two strings containing lines.
1068
A trailing newline is added if missing to make the strings
1070
if b and b[-1] != '\n':
1072
if a and a[-1] != '\n':
1074
difflines = difflib.ndiff(a.splitlines(True),
1076
linejunk=lambda x: False,
1077
charjunk=lambda x: False)
1078
return ''.join(difflines)
1080
def assertEqual(self, a, b, message=''):
1084
except UnicodeError, e:
1085
# If we can't compare without getting a UnicodeError, then
1086
# obviously they are different
1087
mutter('UnicodeError: %s', e)
1090
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1092
pformat(a), pformat(b)))
1094
assertEquals = assertEqual
1096
def assertEqualDiff(self, a, b, message=None):
1097
"""Assert two texts are equal, if not raise an exception.
1099
This is intended for use with multi-line strings where it can
1100
be hard to find the differences by eye.
1102
# TODO: perhaps override assertEquals to call this for strings?
1106
message = "texts not equal:\n"
1108
message = 'first string is missing a final newline.\n'
1110
message = 'second string is missing a final newline.\n'
1111
raise AssertionError(message +
1112
self._ndiff_strings(a, b))
1114
def assertEqualMode(self, mode, mode_test):
1115
self.assertEqual(mode, mode_test,
1116
'mode mismatch %o != %o' % (mode, mode_test))
1118
def assertEqualStat(self, expected, actual):
1119
"""assert that expected and actual are the same stat result.
1121
:param expected: A stat result.
1122
:param actual: A stat result.
1123
:raises AssertionError: If the expected and actual stat values differ
1124
other than by atime.
1126
self.assertEqual(expected.st_size, actual.st_size,
1127
'st_size did not match')
1128
self.assertEqual(expected.st_mtime, actual.st_mtime,
1129
'st_mtime did not match')
1130
self.assertEqual(expected.st_ctime, actual.st_ctime,
1131
'st_ctime did not match')
1132
if sys.platform != 'win32':
1133
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1134
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1135
# odd. Regardless we shouldn't actually try to assert anything
1136
# about their values
1137
self.assertEqual(expected.st_dev, actual.st_dev,
1138
'st_dev did not match')
1139
self.assertEqual(expected.st_ino, actual.st_ino,
1140
'st_ino did not match')
1141
self.assertEqual(expected.st_mode, actual.st_mode,
1142
'st_mode did not match')
1144
def assertLength(self, length, obj_with_len):
1145
"""Assert that obj_with_len is of length length."""
1146
if len(obj_with_len) != length:
1147
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1148
length, len(obj_with_len), obj_with_len))
1150
def assertLogsError(self, exception_class, func, *args, **kwargs):
1151
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1153
from bzrlib import trace
1155
orig_log_exception_quietly = trace.log_exception_quietly
1158
orig_log_exception_quietly()
1159
captured.append(sys.exc_info())
1160
trace.log_exception_quietly = capture
1161
func(*args, **kwargs)
1163
trace.log_exception_quietly = orig_log_exception_quietly
1164
self.assertLength(1, captured)
1165
err = captured[0][1]
1166
self.assertIsInstance(err, exception_class)
1169
def assertPositive(self, val):
1170
"""Assert that val is greater than 0."""
1171
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1173
def assertNegative(self, val):
1174
"""Assert that val is less than 0."""
1175
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1177
def assertStartsWith(self, s, prefix):
1178
if not s.startswith(prefix):
1179
raise AssertionError('string %r does not start with %r' % (s, prefix))
1181
def assertEndsWith(self, s, suffix):
1182
"""Asserts that s ends with suffix."""
1183
if not s.endswith(suffix):
1184
raise AssertionError('string %r does not end with %r' % (s, suffix))
1186
def assertContainsRe(self, haystack, needle_re, flags=0):
1187
"""Assert that a contains something matching a regular expression."""
1188
if not re.search(needle_re, haystack, flags):
1189
if '\n' in haystack or len(haystack) > 60:
1190
# a long string, format it in a more readable way
1191
raise AssertionError(
1192
'pattern "%s" not found in\n"""\\\n%s"""\n'
1193
% (needle_re, haystack))
1195
raise AssertionError('pattern "%s" not found in "%s"'
1196
% (needle_re, haystack))
1198
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1199
"""Assert that a does not match a regular expression"""
1200
if re.search(needle_re, haystack, flags):
1201
raise AssertionError('pattern "%s" found in "%s"'
1202
% (needle_re, haystack))
1204
def assertSubset(self, sublist, superlist):
1205
"""Assert that every entry in sublist is present in superlist."""
1206
missing = set(sublist) - set(superlist)
1207
if len(missing) > 0:
1208
raise AssertionError("value(s) %r not present in container %r" %
1209
(missing, superlist))
1211
def assertListRaises(self, excClass, func, *args, **kwargs):
1212
"""Fail unless excClass is raised when the iterator from func is used.
1214
Many functions can return generators this makes sure
1215
to wrap them in a list() call to make sure the whole generator
1216
is run, and that the proper exception is raised.
1219
list(func(*args, **kwargs))
1223
if getattr(excClass,'__name__', None) is not None:
1224
excName = excClass.__name__
1226
excName = str(excClass)
1227
raise self.failureException, "%s not raised" % excName
1229
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1230
"""Assert that a callable raises a particular exception.
1232
:param excClass: As for the except statement, this may be either an
1233
exception class, or a tuple of classes.
1234
:param callableObj: A callable, will be passed ``*args`` and
1237
Returns the exception so that you can examine it.
1240
callableObj(*args, **kwargs)
1244
if getattr(excClass,'__name__', None) is not None:
1245
excName = excClass.__name__
1248
excName = str(excClass)
1249
raise self.failureException, "%s not raised" % excName
1251
def assertIs(self, left, right, message=None):
1252
if not (left is right):
1253
if message is not None:
1254
raise AssertionError(message)
1256
raise AssertionError("%r is not %r." % (left, right))
1258
def assertIsNot(self, left, right, message=None):
1260
if message is not None:
1261
raise AssertionError(message)
1263
raise AssertionError("%r is %r." % (left, right))
1265
def assertTransportMode(self, transport, path, mode):
1266
"""Fail if a path does not have mode "mode".
1268
If modes are not supported on this transport, the assertion is ignored.
1270
if not transport._can_roundtrip_unix_modebits():
1272
path_stat = transport.stat(path)
1273
actual_mode = stat.S_IMODE(path_stat.st_mode)
1274
self.assertEqual(mode, actual_mode,
1275
'mode of %r incorrect (%s != %s)'
1276
% (path, oct(mode), oct(actual_mode)))
1278
def assertIsSameRealPath(self, path1, path2):
1279
"""Fail if path1 and path2 points to different files"""
1280
self.assertEqual(osutils.realpath(path1),
1281
osutils.realpath(path2),
1282
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1284
def assertIsInstance(self, obj, kls, msg=None):
1285
"""Fail if obj is not an instance of kls
1287
:param msg: Supplementary message to show if the assertion fails.
1289
if not isinstance(obj, kls):
1290
m = "%r is an instance of %s rather than %s" % (
1291
obj, obj.__class__, kls)
1296
def assertFileEqual(self, content, path):
1297
"""Fail if path does not contain 'content'."""
1298
self.failUnlessExists(path)
1299
f = file(path, 'rb')
1304
self.assertEqualDiff(content, s)
1306
def failUnlessExists(self, path):
1307
"""Fail unless path or paths, which may be abs or relative, exist."""
1308
if not isinstance(path, basestring):
1310
self.failUnlessExists(p)
1312
self.failUnless(osutils.lexists(path),path+" does not exist")
1314
def failIfExists(self, path):
1315
"""Fail if path or paths, which may be abs or relative, exist."""
1316
if not isinstance(path, basestring):
1318
self.failIfExists(p)
1320
self.failIf(osutils.lexists(path),path+" exists")
1322
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1323
"""A helper for callDeprecated and applyDeprecated.
1325
:param a_callable: A callable to call.
1326
:param args: The positional arguments for the callable
1327
:param kwargs: The keyword arguments for the callable
1328
:return: A tuple (warnings, result). result is the result of calling
1329
a_callable(``*args``, ``**kwargs``).
1332
def capture_warnings(msg, cls=None, stacklevel=None):
1333
# we've hooked into a deprecation specific callpath,
1334
# only deprecations should getting sent via it.
1335
self.assertEqual(cls, DeprecationWarning)
1336
local_warnings.append(msg)
1337
original_warning_method = symbol_versioning.warn
1338
symbol_versioning.set_warning_method(capture_warnings)
1340
result = a_callable(*args, **kwargs)
1342
symbol_versioning.set_warning_method(original_warning_method)
1343
return (local_warnings, result)
1345
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1346
"""Call a deprecated callable without warning the user.
1348
Note that this only captures warnings raised by symbol_versioning.warn,
1349
not other callers that go direct to the warning module.
1351
To test that a deprecated method raises an error, do something like
1354
self.assertRaises(errors.ReservedId,
1355
self.applyDeprecated,
1356
deprecated_in((1, 5, 0)),
1360
:param deprecation_format: The deprecation format that the callable
1361
should have been deprecated with. This is the same type as the
1362
parameter to deprecated_method/deprecated_function. If the
1363
callable is not deprecated with this format, an assertion error
1365
:param a_callable: A callable to call. This may be a bound method or
1366
a regular function. It will be called with ``*args`` and
1368
:param args: The positional arguments for the callable
1369
:param kwargs: The keyword arguments for the callable
1370
:return: The result of a_callable(``*args``, ``**kwargs``)
1372
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1374
expected_first_warning = symbol_versioning.deprecation_string(
1375
a_callable, deprecation_format)
1376
if len(call_warnings) == 0:
1377
self.fail("No deprecation warning generated by call to %s" %
1379
self.assertEqual(expected_first_warning, call_warnings[0])
1382
def callCatchWarnings(self, fn, *args, **kw):
1383
"""Call a callable that raises python warnings.
1385
The caller's responsible for examining the returned warnings.
1387
If the callable raises an exception, the exception is not
1388
caught and propagates up to the caller. In that case, the list
1389
of warnings is not available.
1391
:returns: ([warning_object, ...], fn_result)
1393
# XXX: This is not perfect, because it completely overrides the
1394
# warnings filters, and some code may depend on suppressing particular
1395
# warnings. It's the easiest way to insulate ourselves from -Werror,
1396
# though. -- Andrew, 20071062
1398
def _catcher(message, category, filename, lineno, file=None, line=None):
1399
# despite the name, 'message' is normally(?) a Warning subclass
1401
wlist.append(message)
1402
saved_showwarning = warnings.showwarning
1403
saved_filters = warnings.filters
1405
warnings.showwarning = _catcher
1406
warnings.filters = []
1407
result = fn(*args, **kw)
1409
warnings.showwarning = saved_showwarning
1410
warnings.filters = saved_filters
1411
return wlist, result
1413
def callDeprecated(self, expected, callable, *args, **kwargs):
1414
"""Assert that a callable is deprecated in a particular way.
1416
This is a very precise test for unusual requirements. The
1417
applyDeprecated helper function is probably more suited for most tests
1418
as it allows you to simply specify the deprecation format being used
1419
and will ensure that that is issued for the function being called.
1421
Note that this only captures warnings raised by symbol_versioning.warn,
1422
not other callers that go direct to the warning module. To catch
1423
general warnings, use callCatchWarnings.
1425
:param expected: a list of the deprecation warnings expected, in order
1426
:param callable: The callable to call
1427
:param args: The positional arguments for the callable
1428
:param kwargs: The keyword arguments for the callable
1430
call_warnings, result = self._capture_deprecation_warnings(callable,
1432
self.assertEqual(expected, call_warnings)
1435
def _startLogFile(self):
1436
"""Send bzr and test log messages to a temporary file.
1438
The file is removed as the test is torn down.
1440
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1441
self._log_file = os.fdopen(fileno, 'w+')
1442
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1443
self._log_file_name = name
1444
self.addCleanup(self._finishLogFile)
1446
def _finishLogFile(self):
1447
"""Finished with the log file.
1449
Close the file and delete it, unless setKeepLogfile was called.
1451
if bzrlib.trace._trace_file:
1452
# flush the log file, to get all content
1453
bzrlib.trace._trace_file.flush()
1454
bzrlib.trace.pop_log_file(self._log_memento)
1455
# Cache the log result and delete the file on disk
1456
self._get_log(False)
1458
def thisFailsStrictLockCheck(self):
1459
"""It is known that this test would fail with -Dstrict_locks.
1461
By default, all tests are run with strict lock checking unless
1462
-Edisable_lock_checks is supplied. However there are some tests which
1463
we know fail strict locks at this point that have not been fixed.
1464
They should call this function to disable the strict checking.
1466
This should be used sparingly, it is much better to fix the locking
1467
issues rather than papering over the problem by calling this function.
1469
debug.debug_flags.discard('strict_locks')
1471
def addCleanup(self, callable, *args, **kwargs):
1472
"""Arrange to run a callable when this case is torn down.
1474
Callables are run in the reverse of the order they are registered,
1475
ie last-in first-out.
1477
self._cleanups.append((callable, args, kwargs))
1479
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1480
"""Overrides an object attribute restoring it after the test.
1482
:param obj: The object that will be mutated.
1484
:param attr_name: The attribute name we want to preserve/override in
1487
:param new: The optional value we want to set the attribute to.
1489
:returns: The actual attr value.
1491
value = getattr(obj, attr_name)
1492
# The actual value is captured by the call below
1493
self.addCleanup(setattr, obj, attr_name, value)
1494
if new is not _unitialized_attr:
1495
setattr(obj, attr_name, new)
1498
def _cleanEnvironment(self):
1500
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1501
'HOME': os.getcwd(),
1502
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1503
# tests do check our impls match APPDATA
1504
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1508
'BZREMAIL': None, # may still be present in the environment
1510
'BZR_PROGRESS_BAR': None,
1512
'BZR_PLUGIN_PATH': None,
1513
'BZR_CONCURRENCY': None,
1514
# Make sure that any text ui tests are consistent regardless of
1515
# the environment the test case is run in; you may want tests that
1516
# test other combinations. 'dumb' is a reasonable guess for tests
1517
# going to a pipe or a StringIO.
1521
'BZR_COLUMNS': '80',
1523
'SSH_AUTH_SOCK': None,
1527
'https_proxy': None,
1528
'HTTPS_PROXY': None,
1533
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1534
# least. If you do (care), please update this comment
1538
'BZR_REMOTE_PATH': None,
1539
# Generally speaking, we don't want apport reporting on crashes in
1540
# the test envirnoment unless we're specifically testing apport,
1541
# so that it doesn't leak into the real system environment. We
1542
# use an env var so it propagates to subprocesses.
1543
'APPORT_DISABLE': '1',
1546
self.addCleanup(self._restoreEnvironment)
1547
for name, value in new_env.iteritems():
1548
self._captureVar(name, value)
1550
def _captureVar(self, name, newvalue):
1551
"""Set an environment variable, and reset it when finished."""
1552
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1554
def _restoreEnvironment(self):
1555
for name, value in self.__old_env.iteritems():
1556
osutils.set_or_unset_env(name, value)
1558
def _restoreHooks(self):
1559
for klass, (name, hooks) in self._preserved_hooks.items():
1560
setattr(klass, name, hooks)
1562
def knownFailure(self, reason):
1563
"""This test has failed for some known reason."""
1564
raise KnownFailure(reason)
1566
def _do_skip(self, result, reason):
1567
addSkip = getattr(result, 'addSkip', None)
1568
if not callable(addSkip):
1569
result.addSuccess(result)
1571
addSkip(self, reason)
1574
def _do_known_failure(self, result, e):
1575
err = sys.exc_info()
1576
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1577
if addExpectedFailure is not None:
1578
addExpectedFailure(self, err)
1580
result.addSuccess(self)
1583
def _do_not_applicable(self, result, e):
1585
reason = 'No reason given'
1588
addNotApplicable = getattr(result, 'addNotApplicable', None)
1589
if addNotApplicable is not None:
1590
result.addNotApplicable(self, reason)
1592
self._do_skip(result, reason)
1595
def _do_unsupported_or_skip(self, result, e):
1597
addNotSupported = getattr(result, 'addNotSupported', None)
1598
if addNotSupported is not None:
1599
result.addNotSupported(self, reason)
1601
self._do_skip(result, reason)
1603
def time(self, callable, *args, **kwargs):
1604
"""Run callable and accrue the time it takes to the benchmark time.
1606
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1607
this will cause lsprofile statistics to be gathered and stored in
1610
if self._benchtime is None:
1611
self.addDetail('benchtime', content.Content(content.ContentType(
1612
"text", "plain"), lambda:[str(self._benchtime)]))
1616
if not self._gather_lsprof_in_benchmarks:
1617
return callable(*args, **kwargs)
1619
# record this benchmark
1620
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1622
self._benchcalls.append(((callable, args, kwargs), stats))
1625
self._benchtime += time.time() - start
1627
def log(self, *args):
1630
def _get_log(self, keep_log_file=False):
1631
"""Internal helper to get the log from bzrlib.trace for this test.
1633
Please use self.getDetails, or self.get_log to access this in test case
1636
:param keep_log_file: When True, if the log is still a file on disk
1637
leave it as a file on disk. When False, if the log is still a file
1638
on disk, the log file is deleted and the log preserved as
1640
:return: A string containing the log.
1642
if self._log_contents is not None:
1644
self._log_contents.decode('utf8')
1645
except UnicodeDecodeError:
1646
unicodestr = self._log_contents.decode('utf8', 'replace')
1647
self._log_contents = unicodestr.encode('utf8')
1648
return self._log_contents
1650
if bzrlib.trace._trace_file:
1651
# flush the log file, to get all content
1652
bzrlib.trace._trace_file.flush()
1653
if self._log_file_name is not None:
1654
logfile = open(self._log_file_name)
1656
log_contents = logfile.read()
1660
log_contents.decode('utf8')
1661
except UnicodeDecodeError:
1662
unicodestr = log_contents.decode('utf8', 'replace')
1663
log_contents = unicodestr.encode('utf8')
1664
if not keep_log_file:
1665
self._log_file.close()
1666
self._log_file = None
1667
# Permit multiple calls to get_log until we clean it up in
1669
self._log_contents = log_contents
1671
os.remove(self._log_file_name)
1673
if sys.platform == 'win32' and e.errno == errno.EACCES:
1674
sys.stderr.write(('Unable to delete log file '
1675
' %r\n' % self._log_file_name))
1678
self._log_file_name = None
1681
return "No log file content and no log file name."
1684
"""Get a unicode string containing the log from bzrlib.trace.
1686
Undecodable characters are replaced.
1688
return u"".join(self.getDetails()['log'].iter_text())
1690
def requireFeature(self, feature):
1691
"""This test requires a specific feature is available.
1693
:raises UnavailableFeature: When feature is not available.
1695
if not feature.available():
1696
raise UnavailableFeature(feature)
1698
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1700
"""Run bazaar command line, splitting up a string command line."""
1701
if isinstance(args, basestring):
1702
# shlex don't understand unicode strings,
1703
# so args should be plain string (bialix 20070906)
1704
args = list(shlex.split(str(args)))
1705
return self._run_bzr_core(args, retcode=retcode,
1706
encoding=encoding, stdin=stdin, working_dir=working_dir,
1709
def _run_bzr_core(self, args, retcode, encoding, stdin,
1711
# Clear chk_map page cache, because the contents are likely to mask
1713
chk_map.clear_cache()
1714
if encoding is None:
1715
encoding = osutils.get_user_encoding()
1716
stdout = StringIOWrapper()
1717
stderr = StringIOWrapper()
1718
stdout.encoding = encoding
1719
stderr.encoding = encoding
1721
self.log('run bzr: %r', args)
1722
# FIXME: don't call into logging here
1723
handler = logging.StreamHandler(stderr)
1724
handler.setLevel(logging.INFO)
1725
logger = logging.getLogger('')
1726
logger.addHandler(handler)
1727
old_ui_factory = ui.ui_factory
1728
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1731
if working_dir is not None:
1732
cwd = osutils.getcwd()
1733
os.chdir(working_dir)
1737
result = self.apply_redirected(ui.ui_factory.stdin,
1739
bzrlib.commands.run_bzr_catch_user_errors,
1741
except KeyboardInterrupt:
1742
# Reraise KeyboardInterrupt with contents of redirected stdout
1743
# and stderr as arguments, for tests which are interested in
1744
# stdout and stderr and are expecting the exception.
1745
out = stdout.getvalue()
1746
err = stderr.getvalue()
1748
self.log('output:\n%r', out)
1750
self.log('errors:\n%r', err)
1751
raise KeyboardInterrupt(out, err)
1753
logger.removeHandler(handler)
1754
ui.ui_factory = old_ui_factory
1758
out = stdout.getvalue()
1759
err = stderr.getvalue()
1761
self.log('output:\n%r', out)
1763
self.log('errors:\n%r', err)
1764
if retcode is not None:
1765
self.assertEquals(retcode, result,
1766
message='Unexpected return code')
1767
return result, out, err
1769
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1770
working_dir=None, error_regexes=[], output_encoding=None):
1771
"""Invoke bzr, as if it were run from the command line.
1773
The argument list should not include the bzr program name - the
1774
first argument is normally the bzr command. Arguments may be
1775
passed in three ways:
1777
1- A list of strings, eg ["commit", "a"]. This is recommended
1778
when the command contains whitespace or metacharacters, or
1779
is built up at run time.
1781
2- A single string, eg "add a". This is the most convenient
1782
for hardcoded commands.
1784
This runs bzr through the interface that catches and reports
1785
errors, and with logging set to something approximating the
1786
default, so that error reporting can be checked.
1788
This should be the main method for tests that want to exercise the
1789
overall behavior of the bzr application (rather than a unit test
1790
or a functional test of the library.)
1792
This sends the stdout/stderr results into the test's log,
1793
where it may be useful for debugging. See also run_captured.
1795
:keyword stdin: A string to be used as stdin for the command.
1796
:keyword retcode: The status code the command should return;
1798
:keyword working_dir: The directory to run the command in
1799
:keyword error_regexes: A list of expected error messages. If
1800
specified they must be seen in the error output of the command.
1802
retcode, out, err = self._run_bzr_autosplit(
1807
working_dir=working_dir,
1809
self.assertIsInstance(error_regexes, (list, tuple))
1810
for regex in error_regexes:
1811
self.assertContainsRe(err, regex)
1814
def run_bzr_error(self, error_regexes, *args, **kwargs):
1815
"""Run bzr, and check that stderr contains the supplied regexes
1817
:param error_regexes: Sequence of regular expressions which
1818
must each be found in the error output. The relative ordering
1820
:param args: command-line arguments for bzr
1821
:param kwargs: Keyword arguments which are interpreted by run_bzr
1822
This function changes the default value of retcode to be 3,
1823
since in most cases this is run when you expect bzr to fail.
1825
:return: (out, err) The actual output of running the command (in case
1826
you want to do more inspection)
1830
# Make sure that commit is failing because there is nothing to do
1831
self.run_bzr_error(['no changes to commit'],
1832
['commit', '-m', 'my commit comment'])
1833
# Make sure --strict is handling an unknown file, rather than
1834
# giving us the 'nothing to do' error
1835
self.build_tree(['unknown'])
1836
self.run_bzr_error(['Commit refused because there are unknown files'],
1837
['commit', --strict', '-m', 'my commit comment'])
1839
kwargs.setdefault('retcode', 3)
1840
kwargs['error_regexes'] = error_regexes
1841
out, err = self.run_bzr(*args, **kwargs)
1844
def run_bzr_subprocess(self, *args, **kwargs):
1845
"""Run bzr in a subprocess for testing.
1847
This starts a new Python interpreter and runs bzr in there.
1848
This should only be used for tests that have a justifiable need for
1849
this isolation: e.g. they are testing startup time, or signal
1850
handling, or early startup code, etc. Subprocess code can't be
1851
profiled or debugged so easily.
1853
:keyword retcode: The status code that is expected. Defaults to 0. If
1854
None is supplied, the status code is not checked.
1855
:keyword env_changes: A dictionary which lists changes to environment
1856
variables. A value of None will unset the env variable.
1857
The values must be strings. The change will only occur in the
1858
child, so you don't need to fix the environment after running.
1859
:keyword universal_newlines: Convert CRLF => LF
1860
:keyword allow_plugins: By default the subprocess is run with
1861
--no-plugins to ensure test reproducibility. Also, it is possible
1862
for system-wide plugins to create unexpected output on stderr,
1863
which can cause unnecessary test failures.
1865
env_changes = kwargs.get('env_changes', {})
1866
working_dir = kwargs.get('working_dir', None)
1867
allow_plugins = kwargs.get('allow_plugins', False)
1869
if isinstance(args[0], list):
1871
elif isinstance(args[0], basestring):
1872
args = list(shlex.split(args[0]))
1874
raise ValueError("passing varargs to run_bzr_subprocess")
1875
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1876
working_dir=working_dir,
1877
allow_plugins=allow_plugins)
1878
# We distinguish between retcode=None and retcode not passed.
1879
supplied_retcode = kwargs.get('retcode', 0)
1880
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1881
universal_newlines=kwargs.get('universal_newlines', False),
1884
def start_bzr_subprocess(self, process_args, env_changes=None,
1885
skip_if_plan_to_signal=False,
1887
allow_plugins=False):
1888
"""Start bzr in a subprocess for testing.
1890
This starts a new Python interpreter and runs bzr in there.
1891
This should only be used for tests that have a justifiable need for
1892
this isolation: e.g. they are testing startup time, or signal
1893
handling, or early startup code, etc. Subprocess code can't be
1894
profiled or debugged so easily.
1896
:param process_args: a list of arguments to pass to the bzr executable,
1897
for example ``['--version']``.
1898
:param env_changes: A dictionary which lists changes to environment
1899
variables. A value of None will unset the env variable.
1900
The values must be strings. The change will only occur in the
1901
child, so you don't need to fix the environment after running.
1902
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1904
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1906
:returns: Popen object for the started process.
1908
if skip_if_plan_to_signal:
1909
if not getattr(os, 'kill', None):
1910
raise TestSkipped("os.kill not available.")
1912
if env_changes is None:
1916
def cleanup_environment():
1917
for env_var, value in env_changes.iteritems():
1918
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1920
def restore_environment():
1921
for env_var, value in old_env.iteritems():
1922
osutils.set_or_unset_env(env_var, value)
1924
bzr_path = self.get_bzr_path()
1927
if working_dir is not None:
1928
cwd = osutils.getcwd()
1929
os.chdir(working_dir)
1932
# win32 subprocess doesn't support preexec_fn
1933
# so we will avoid using it on all platforms, just to
1934
# make sure the code path is used, and we don't break on win32
1935
cleanup_environment()
1936
command = [sys.executable]
1937
# frozen executables don't need the path to bzr
1938
if getattr(sys, "frozen", None) is None:
1939
command.append(bzr_path)
1940
if not allow_plugins:
1941
command.append('--no-plugins')
1942
command.extend(process_args)
1943
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1945
restore_environment()
1951
def _popen(self, *args, **kwargs):
1952
"""Place a call to Popen.
1954
Allows tests to override this method to intercept the calls made to
1955
Popen for introspection.
1957
return Popen(*args, **kwargs)
1959
def get_source_path(self):
1960
"""Return the path of the directory containing bzrlib."""
1961
return os.path.dirname(os.path.dirname(bzrlib.__file__))
1963
def get_bzr_path(self):
1964
"""Return the path of the 'bzr' executable for this test suite."""
1965
bzr_path = self.get_source_path()+'/bzr'
1966
if not os.path.isfile(bzr_path):
1967
# We are probably installed. Assume sys.argv is the right file
1968
bzr_path = sys.argv[0]
1971
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1972
universal_newlines=False, process_args=None):
1973
"""Finish the execution of process.
1975
:param process: the Popen object returned from start_bzr_subprocess.
1976
:param retcode: The status code that is expected. Defaults to 0. If
1977
None is supplied, the status code is not checked.
1978
:param send_signal: an optional signal to send to the process.
1979
:param universal_newlines: Convert CRLF => LF
1980
:returns: (stdout, stderr)
1982
if send_signal is not None:
1983
os.kill(process.pid, send_signal)
1984
out, err = process.communicate()
1986
if universal_newlines:
1987
out = out.replace('\r\n', '\n')
1988
err = err.replace('\r\n', '\n')
1990
if retcode is not None and retcode != process.returncode:
1991
if process_args is None:
1992
process_args = "(unknown args)"
1993
mutter('Output of bzr %s:\n%s', process_args, out)
1994
mutter('Error for bzr %s:\n%s', process_args, err)
1995
self.fail('Command bzr %s failed with retcode %s != %s'
1996
% (process_args, retcode, process.returncode))
1999
def check_inventory_shape(self, inv, shape):
2000
"""Compare an inventory to a list of expected names.
2002
Fail if they are not precisely equal.
2005
shape = list(shape) # copy
2006
for path, ie in inv.entries():
2007
name = path.replace('\\', '/')
2008
if ie.kind == 'directory':
2015
self.fail("expected paths not found in inventory: %r" % shape)
2017
self.fail("unexpected paths found in inventory: %r" % extras)
2019
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2020
a_callable=None, *args, **kwargs):
2021
"""Call callable with redirected std io pipes.
2023
Returns the return code."""
2024
if not callable(a_callable):
2025
raise ValueError("a_callable must be callable.")
2027
stdin = StringIO("")
2029
if getattr(self, "_log_file", None) is not None:
2030
stdout = self._log_file
2034
if getattr(self, "_log_file", None is not None):
2035
stderr = self._log_file
2038
real_stdin = sys.stdin
2039
real_stdout = sys.stdout
2040
real_stderr = sys.stderr
2045
return a_callable(*args, **kwargs)
2047
sys.stdout = real_stdout
2048
sys.stderr = real_stderr
2049
sys.stdin = real_stdin
2051
def reduceLockdirTimeout(self):
2052
"""Reduce the default lock timeout for the duration of the test, so that
2053
if LockContention occurs during a test, it does so quickly.
2055
Tests that expect to provoke LockContention errors should call this.
2057
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2059
def make_utf8_encoded_stringio(self, encoding_type=None):
2060
"""Return a StringIOWrapper instance, that will encode Unicode
2063
if encoding_type is None:
2064
encoding_type = 'strict'
2066
output_encoding = 'utf-8'
2067
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2068
sio.encoding = output_encoding
2071
def disable_verb(self, verb):
2072
"""Disable a smart server verb for one test."""
2073
from bzrlib.smart import request
2074
request_handlers = request.request_handlers
2075
orig_method = request_handlers.get(verb)
2076
request_handlers.remove(verb)
2077
self.addCleanup(request_handlers.register, verb, orig_method)
2080
class CapturedCall(object):
2081
"""A helper for capturing smart server calls for easy debug analysis."""
2083
def __init__(self, params, prefix_length):
2084
"""Capture the call with params and skip prefix_length stack frames."""
2087
# The last 5 frames are the __init__, the hook frame, and 3 smart
2088
# client frames. Beyond this we could get more clever, but this is good
2090
stack = traceback.extract_stack()[prefix_length:-5]
2091
self.stack = ''.join(traceback.format_list(stack))
2094
return self.call.method
2097
return self.call.method
2103
class TestCaseWithMemoryTransport(TestCase):
2104
"""Common test class for tests that do not need disk resources.
2106
Tests that need disk resources should derive from TestCaseWithTransport.
2108
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2110
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2111
a directory which does not exist. This serves to help ensure test isolation
2112
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2113
must exist. However, TestCaseWithMemoryTransport does not offer local
2114
file defaults for the transport in tests, nor does it obey the command line
2115
override, so tests that accidentally write to the common directory should
2118
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2119
a .bzr directory that stops us ascending higher into the filesystem.
2125
def __init__(self, methodName='runTest'):
2126
# allow test parameterization after test construction and before test
2127
# execution. Variables that the parameterizer sets need to be
2128
# ones that are not set by setUp, or setUp will trash them.
2129
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2130
self.vfs_transport_factory = default_transport
2131
self.transport_server = None
2132
self.transport_readonly_server = None
2133
self.__vfs_server = None
2135
def get_transport(self, relpath=None):
2136
"""Return a writeable transport.
2138
This transport is for the test scratch space relative to
2141
:param relpath: a path relative to the base url.
2143
t = get_transport(self.get_url(relpath))
2144
self.assertFalse(t.is_readonly())
2147
def get_readonly_transport(self, relpath=None):
2148
"""Return a readonly transport for the test scratch space
2150
This can be used to test that operations which should only need
2151
readonly access in fact do not try to write.
2153
:param relpath: a path relative to the base url.
2155
t = get_transport(self.get_readonly_url(relpath))
2156
self.assertTrue(t.is_readonly())
2159
def create_transport_readonly_server(self):
2160
"""Create a transport server from class defined at init.
2162
This is mostly a hook for daughter classes.
2164
return self.transport_readonly_server()
2166
def get_readonly_server(self):
2167
"""Get the server instance for the readonly transport
2169
This is useful for some tests with specific servers to do diagnostics.
2171
if self.__readonly_server is None:
2172
if self.transport_readonly_server is None:
2173
# readonly decorator requested
2174
self.__readonly_server = ReadonlyServer()
2176
# explicit readonly transport.
2177
self.__readonly_server = self.create_transport_readonly_server()
2178
self.start_server(self.__readonly_server,
2179
self.get_vfs_only_server())
2180
return self.__readonly_server
2182
def get_readonly_url(self, relpath=None):
2183
"""Get a URL for the readonly transport.
2185
This will either be backed by '.' or a decorator to the transport
2186
used by self.get_url()
2187
relpath provides for clients to get a path relative to the base url.
2188
These should only be downwards relative, not upwards.
2190
base = self.get_readonly_server().get_url()
2191
return self._adjust_url(base, relpath)
2193
def get_vfs_only_server(self):
2194
"""Get the vfs only read/write server instance.
2196
This is useful for some tests with specific servers that need
2199
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2200
is no means to override it.
2202
if self.__vfs_server is None:
2203
self.__vfs_server = MemoryServer()
2204
self.start_server(self.__vfs_server)
2205
return self.__vfs_server
2207
def get_server(self):
2208
"""Get the read/write server instance.
2210
This is useful for some tests with specific servers that need
2213
This is built from the self.transport_server factory. If that is None,
2214
then the self.get_vfs_server is returned.
2216
if self.__server is None:
2217
if (self.transport_server is None or self.transport_server is
2218
self.vfs_transport_factory):
2219
self.__server = self.get_vfs_only_server()
2221
# bring up a decorated means of access to the vfs only server.
2222
self.__server = self.transport_server()
2223
self.start_server(self.__server, self.get_vfs_only_server())
2224
return self.__server
2226
def _adjust_url(self, base, relpath):
2227
"""Get a URL (or maybe a path) for the readwrite transport.
2229
This will either be backed by '.' or to an equivalent non-file based
2231
relpath provides for clients to get a path relative to the base url.
2232
These should only be downwards relative, not upwards.
2234
if relpath is not None and relpath != '.':
2235
if not base.endswith('/'):
2237
# XXX: Really base should be a url; we did after all call
2238
# get_url()! But sometimes it's just a path (from
2239
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2240
# to a non-escaped local path.
2241
if base.startswith('./') or base.startswith('/'):
2244
base += urlutils.escape(relpath)
2247
def get_url(self, relpath=None):
2248
"""Get a URL (or maybe a path) for the readwrite transport.
2250
This will either be backed by '.' or to an equivalent non-file based
2252
relpath provides for clients to get a path relative to the base url.
2253
These should only be downwards relative, not upwards.
2255
base = self.get_server().get_url()
2256
return self._adjust_url(base, relpath)
2258
def get_vfs_only_url(self, relpath=None):
2259
"""Get a URL (or maybe a path for the plain old vfs transport.
2261
This will never be a smart protocol. It always has all the
2262
capabilities of the local filesystem, but it might actually be a
2263
MemoryTransport or some other similar virtual filesystem.
2265
This is the backing transport (if any) of the server returned by
2266
get_url and get_readonly_url.
2268
:param relpath: provides for clients to get a path relative to the base
2269
url. These should only be downwards relative, not upwards.
2272
base = self.get_vfs_only_server().get_url()
2273
return self._adjust_url(base, relpath)
2275
def _create_safety_net(self):
2276
"""Make a fake bzr directory.
2278
This prevents any tests propagating up onto the TEST_ROOT directory's
2281
root = TestCaseWithMemoryTransport.TEST_ROOT
2282
bzrdir.BzrDir.create_standalone_workingtree(root)
2284
def _check_safety_net(self):
2285
"""Check that the safety .bzr directory have not been touched.
2287
_make_test_root have created a .bzr directory to prevent tests from
2288
propagating. This method ensures than a test did not leaked.
2290
root = TestCaseWithMemoryTransport.TEST_ROOT
2291
self.permit_url(get_transport(root).base)
2292
wt = workingtree.WorkingTree.open(root)
2293
last_rev = wt.last_revision()
2294
if last_rev != 'null:':
2295
# The current test have modified the /bzr directory, we need to
2296
# recreate a new one or all the followng tests will fail.
2297
# If you need to inspect its content uncomment the following line
2298
# import pdb; pdb.set_trace()
2299
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2300
self._create_safety_net()
2301
raise AssertionError('%s/.bzr should not be modified' % root)
2303
def _make_test_root(self):
2304
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2305
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2306
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2308
TestCaseWithMemoryTransport.TEST_ROOT = root
2310
self._create_safety_net()
2312
# The same directory is used by all tests, and we're not
2313
# specifically told when all tests are finished. This will do.
2314
atexit.register(_rmtree_temp_dir, root)
2316
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2317
self.addCleanup(self._check_safety_net)
2319
def makeAndChdirToTestDir(self):
2320
"""Create a temporary directories for this one test.
2322
This must set self.test_home_dir and self.test_dir and chdir to
2325
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2327
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2328
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2329
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2330
self.permit_dir(self.test_dir)
2332
def make_branch(self, relpath, format=None):
2333
"""Create a branch on the transport at relpath."""
2334
repo = self.make_repository(relpath, format=format)
2335
return repo.bzrdir.create_branch()
2337
def make_bzrdir(self, relpath, format=None):
2339
# might be a relative or absolute path
2340
maybe_a_url = self.get_url(relpath)
2341
segments = maybe_a_url.rsplit('/', 1)
2342
t = get_transport(maybe_a_url)
2343
if len(segments) > 1 and segments[-1] not in ('', '.'):
2347
if isinstance(format, basestring):
2348
format = bzrdir.format_registry.make_bzrdir(format)
2349
return format.initialize_on_transport(t)
2350
except errors.UninitializableFormat:
2351
raise TestSkipped("Format %s is not initializable." % format)
2353
def make_repository(self, relpath, shared=False, format=None):
2354
"""Create a repository on our default transport at relpath.
2356
Note that relpath must be a relative path, not a full url.
2358
# FIXME: If you create a remoterepository this returns the underlying
2359
# real format, which is incorrect. Actually we should make sure that
2360
# RemoteBzrDir returns a RemoteRepository.
2361
# maybe mbp 20070410
2362
made_control = self.make_bzrdir(relpath, format=format)
2363
return made_control.create_repository(shared=shared)
2365
def make_smart_server(self, path):
2366
smart_server = server.SmartTCPServer_for_testing()
2367
self.start_server(smart_server, self.get_server())
2368
remote_transport = get_transport(smart_server.get_url()).clone(path)
2369
return remote_transport
2371
def make_branch_and_memory_tree(self, relpath, format=None):
2372
"""Create a branch on the default transport and a MemoryTree for it."""
2373
b = self.make_branch(relpath, format=format)
2374
return memorytree.MemoryTree.create_on_branch(b)
2376
def make_branch_builder(self, relpath, format=None):
2377
branch = self.make_branch(relpath, format=format)
2378
return branchbuilder.BranchBuilder(branch=branch)
2380
def overrideEnvironmentForTesting(self):
2381
test_home_dir = self.test_home_dir
2382
if isinstance(test_home_dir, unicode):
2383
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2384
os.environ['HOME'] = test_home_dir
2385
os.environ['BZR_HOME'] = test_home_dir
2388
super(TestCaseWithMemoryTransport, self).setUp()
2389
self._make_test_root()
2390
self.addCleanup(os.chdir, os.getcwdu())
2391
self.makeAndChdirToTestDir()
2392
self.overrideEnvironmentForTesting()
2393
self.__readonly_server = None
2394
self.__server = None
2395
self.reduceLockdirTimeout()
2397
def setup_smart_server_with_call_log(self):
2398
"""Sets up a smart server as the transport server with a call log."""
2399
self.transport_server = server.SmartTCPServer_for_testing
2400
self.hpss_calls = []
2402
# Skip the current stack down to the caller of
2403
# setup_smart_server_with_call_log
2404
prefix_length = len(traceback.extract_stack()) - 2
2405
def capture_hpss_call(params):
2406
self.hpss_calls.append(
2407
CapturedCall(params, prefix_length))
2408
client._SmartClient.hooks.install_named_hook(
2409
'call', capture_hpss_call, None)
2411
def reset_smart_call_log(self):
2412
self.hpss_calls = []
2415
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2416
"""Derived class that runs a test within a temporary directory.
2418
This is useful for tests that need to create a branch, etc.
2420
The directory is created in a slightly complex way: for each
2421
Python invocation, a new temporary top-level directory is created.
2422
All test cases create their own directory within that. If the
2423
tests complete successfully, the directory is removed.
2425
:ivar test_base_dir: The path of the top-level directory for this
2426
test, which contains a home directory and a work directory.
2428
:ivar test_home_dir: An initially empty directory under test_base_dir
2429
which is used as $HOME for this test.
2431
:ivar test_dir: A directory under test_base_dir used as the current
2432
directory when the test proper is run.
2435
OVERRIDE_PYTHON = 'python'
2437
def check_file_contents(self, filename, expect):
2438
self.log("check contents of file %s" % filename)
2439
contents = file(filename, 'r').read()
2440
if contents != expect:
2441
self.log("expected: %r" % expect)
2442
self.log("actually: %r" % contents)
2443
self.fail("contents of %s not as expected" % filename)
2445
def _getTestDirPrefix(self):
2446
# create a directory within the top level test directory
2447
if sys.platform in ('win32', 'cygwin'):
2448
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2449
# windows is likely to have path-length limits so use a short name
2450
name_prefix = name_prefix[-30:]
2452
name_prefix = re.sub('[/]', '_', self.id())
2455
def makeAndChdirToTestDir(self):
2456
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2458
For TestCaseInTempDir we create a temporary directory based on the test
2459
name and then create two subdirs - test and home under it.
2461
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2462
self._getTestDirPrefix())
2464
for i in range(100):
2465
if os.path.exists(name):
2466
name = name_prefix + '_' + str(i)
2468
# now create test and home directories within this dir
2469
self.test_base_dir = name
2470
self.addCleanup(self.deleteTestDir)
2471
os.mkdir(self.test_base_dir)
2473
self.permit_dir(self.test_base_dir)
2474
# 'sprouting' and 'init' of a branch both walk up the tree to find
2475
# stacking policy to honour; create a bzr dir with an unshared
2476
# repository (but not a branch - our code would be trying to escape
2477
# then!) to stop them, and permit it to be read.
2478
# control = bzrdir.BzrDir.create(self.test_base_dir)
2479
# control.create_repository()
2480
self.test_home_dir = self.test_base_dir + '/home'
2481
os.mkdir(self.test_home_dir)
2482
self.test_dir = self.test_base_dir + '/work'
2483
os.mkdir(self.test_dir)
2484
os.chdir(self.test_dir)
2485
# put name of test inside
2486
f = file(self.test_base_dir + '/name', 'w')
2492
def deleteTestDir(self):
2493
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2494
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2496
def build_tree(self, shape, line_endings='binary', transport=None):
2497
"""Build a test tree according to a pattern.
2499
shape is a sequence of file specifications. If the final
2500
character is '/', a directory is created.
2502
This assumes that all the elements in the tree being built are new.
2504
This doesn't add anything to a branch.
2506
:type shape: list or tuple.
2507
:param line_endings: Either 'binary' or 'native'
2508
in binary mode, exact contents are written in native mode, the
2509
line endings match the default platform endings.
2510
:param transport: A transport to write to, for building trees on VFS's.
2511
If the transport is readonly or None, "." is opened automatically.
2514
if type(shape) not in (list, tuple):
2515
raise AssertionError("Parameter 'shape' should be "
2516
"a list or a tuple. Got %r instead" % (shape,))
2517
# It's OK to just create them using forward slashes on windows.
2518
if transport is None or transport.is_readonly():
2519
transport = get_transport(".")
2521
self.assertIsInstance(name, basestring)
2523
transport.mkdir(urlutils.escape(name[:-1]))
2525
if line_endings == 'binary':
2527
elif line_endings == 'native':
2530
raise errors.BzrError(
2531
'Invalid line ending request %r' % line_endings)
2532
content = "contents of %s%s" % (name.encode('utf-8'), end)
2533
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2535
def build_tree_contents(self, shape):
2536
build_tree_contents(shape)
2538
def assertInWorkingTree(self, path, root_path='.', tree=None):
2539
"""Assert whether path or paths are in the WorkingTree"""
2541
tree = workingtree.WorkingTree.open(root_path)
2542
if not isinstance(path, basestring):
2544
self.assertInWorkingTree(p, tree=tree)
2546
self.assertIsNot(tree.path2id(path), None,
2547
path+' not in working tree.')
2549
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2550
"""Assert whether path or paths are not in the WorkingTree"""
2552
tree = workingtree.WorkingTree.open(root_path)
2553
if not isinstance(path, basestring):
2555
self.assertNotInWorkingTree(p,tree=tree)
2557
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2560
class TestCaseWithTransport(TestCaseInTempDir):
2561
"""A test case that provides get_url and get_readonly_url facilities.
2563
These back onto two transport servers, one for readonly access and one for
2566
If no explicit class is provided for readonly access, a
2567
ReadonlyTransportDecorator is used instead which allows the use of non disk
2568
based read write transports.
2570
If an explicit class is provided for readonly access, that server and the
2571
readwrite one must both define get_url() as resolving to os.getcwd().
2574
def get_vfs_only_server(self):
2575
"""See TestCaseWithMemoryTransport.
2577
This is useful for some tests with specific servers that need
2580
if self.__vfs_server is None:
2581
self.__vfs_server = self.vfs_transport_factory()
2582
self.start_server(self.__vfs_server)
2583
return self.__vfs_server
2585
def make_branch_and_tree(self, relpath, format=None):
2586
"""Create a branch on the transport and a tree locally.
2588
If the transport is not a LocalTransport, the Tree can't be created on
2589
the transport. In that case if the vfs_transport_factory is
2590
LocalURLServer the working tree is created in the local
2591
directory backing the transport, and the returned tree's branch and
2592
repository will also be accessed locally. Otherwise a lightweight
2593
checkout is created and returned.
2595
We do this because we can't physically create a tree in the local
2596
path, with a branch reference to the transport_factory url, and
2597
a branch + repository in the vfs_transport, unless the vfs_transport
2598
namespace is distinct from the local disk - the two branch objects
2599
would collide. While we could construct a tree with its branch object
2600
pointing at the transport_factory transport in memory, reopening it
2601
would behaving unexpectedly, and has in the past caused testing bugs
2602
when we tried to do it that way.
2604
:param format: The BzrDirFormat.
2605
:returns: the WorkingTree.
2607
# TODO: always use the local disk path for the working tree,
2608
# this obviously requires a format that supports branch references
2609
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2611
b = self.make_branch(relpath, format=format)
2613
return b.bzrdir.create_workingtree()
2614
except errors.NotLocalUrl:
2615
# We can only make working trees locally at the moment. If the
2616
# transport can't support them, then we keep the non-disk-backed
2617
# branch and create a local checkout.
2618
if self.vfs_transport_factory is LocalURLServer:
2619
# the branch is colocated on disk, we cannot create a checkout.
2620
# hopefully callers will expect this.
2621
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2622
wt = local_controldir.create_workingtree()
2623
if wt.branch._format != b._format:
2625
# Make sure that assigning to wt._branch fixes wt.branch,
2626
# in case the implementation details of workingtree objects
2628
self.assertIs(b, wt.branch)
2631
return b.create_checkout(relpath, lightweight=True)
2633
def assertIsDirectory(self, relpath, transport):
2634
"""Assert that relpath within transport is a directory.
2636
This may not be possible on all transports; in that case it propagates
2637
a TransportNotPossible.
2640
mode = transport.stat(relpath).st_mode
2641
except errors.NoSuchFile:
2642
self.fail("path %s is not a directory; no such file"
2644
if not stat.S_ISDIR(mode):
2645
self.fail("path %s is not a directory; has mode %#o"
2648
def assertTreesEqual(self, left, right):
2649
"""Check that left and right have the same content and properties."""
2650
# we use a tree delta to check for equality of the content, and we
2651
# manually check for equality of other things such as the parents list.
2652
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2653
differences = left.changes_from(right)
2654
self.assertFalse(differences.has_changed(),
2655
"Trees %r and %r are different: %r" % (left, right, differences))
2658
super(TestCaseWithTransport, self).setUp()
2659
self.__vfs_server = None
2661
def disable_missing_extensions_warning(self):
2662
"""Some tests expect a precise stderr content.
2664
There is no point in forcing them to duplicate the extension related
2667
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2670
class ChrootedTestCase(TestCaseWithTransport):
2671
"""A support class that provides readonly urls outside the local namespace.
2673
This is done by checking if self.transport_server is a MemoryServer. if it
2674
is then we are chrooted already, if it is not then an HttpServer is used
2677
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2678
be used without needed to redo it when a different
2679
subclass is in use ?
2683
super(ChrootedTestCase, self).setUp()
2684
if not self.vfs_transport_factory == MemoryServer:
2685
self.transport_readonly_server = HttpServer
2688
def condition_id_re(pattern):
2689
"""Create a condition filter which performs a re check on a test's id.
2691
:param pattern: A regular expression string.
2692
:return: A callable that returns True if the re matches.
2694
filter_re = osutils.re_compile_checked(pattern, 0,
2696
def condition(test):
2698
return filter_re.search(test_id)
2702
def condition_isinstance(klass_or_klass_list):
2703
"""Create a condition filter which returns isinstance(param, klass).
2705
:return: A callable which when called with one parameter obj return the
2706
result of isinstance(obj, klass_or_klass_list).
2709
return isinstance(obj, klass_or_klass_list)
2713
def condition_id_in_list(id_list):
2714
"""Create a condition filter which verify that test's id in a list.
2716
:param id_list: A TestIdList object.
2717
:return: A callable that returns True if the test's id appears in the list.
2719
def condition(test):
2720
return id_list.includes(test.id())
2724
def condition_id_startswith(starts):
2725
"""Create a condition filter verifying that test's id starts with a string.
2727
:param starts: A list of string.
2728
:return: A callable that returns True if the test's id starts with one of
2731
def condition(test):
2732
for start in starts:
2733
if test.id().startswith(start):
2739
def exclude_tests_by_condition(suite, condition):
2740
"""Create a test suite which excludes some tests from suite.
2742
:param suite: The suite to get tests from.
2743
:param condition: A callable whose result evaluates True when called with a
2744
test case which should be excluded from the result.
2745
:return: A suite which contains the tests found in suite that fail
2749
for test in iter_suite_tests(suite):
2750
if not condition(test):
2752
return TestUtil.TestSuite(result)
2755
def filter_suite_by_condition(suite, condition):
2756
"""Create a test suite by filtering another one.
2758
:param suite: The source suite.
2759
:param condition: A callable whose result evaluates True when called with a
2760
test case which should be included in the result.
2761
:return: A suite which contains the tests found in suite that pass
2765
for test in iter_suite_tests(suite):
2768
return TestUtil.TestSuite(result)
2771
def filter_suite_by_re(suite, pattern):
2772
"""Create a test suite by filtering another one.
2774
:param suite: the source suite
2775
:param pattern: pattern that names must match
2776
:returns: the newly created suite
2778
condition = condition_id_re(pattern)
2779
result_suite = filter_suite_by_condition(suite, condition)
2783
def filter_suite_by_id_list(suite, test_id_list):
2784
"""Create a test suite by filtering another one.
2786
:param suite: The source suite.
2787
:param test_id_list: A list of the test ids to keep as strings.
2788
:returns: the newly created suite
2790
condition = condition_id_in_list(test_id_list)
2791
result_suite = filter_suite_by_condition(suite, condition)
2795
def filter_suite_by_id_startswith(suite, start):
2796
"""Create a test suite by filtering another one.
2798
:param suite: The source suite.
2799
:param start: A list of string the test id must start with one of.
2800
:returns: the newly created suite
2802
condition = condition_id_startswith(start)
2803
result_suite = filter_suite_by_condition(suite, condition)
2807
def exclude_tests_by_re(suite, pattern):
2808
"""Create a test suite which excludes some tests from suite.
2810
:param suite: The suite to get tests from.
2811
:param pattern: A regular expression string. Test ids that match this
2812
pattern will be excluded from the result.
2813
:return: A TestSuite that contains all the tests from suite without the
2814
tests that matched pattern. The order of tests is the same as it was in
2817
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2820
def preserve_input(something):
2821
"""A helper for performing test suite transformation chains.
2823
:param something: Anything you want to preserve.
2829
def randomize_suite(suite):
2830
"""Return a new TestSuite with suite's tests in random order.
2832
The tests in the input suite are flattened into a single suite in order to
2833
accomplish this. Any nested TestSuites are removed to provide global
2836
tests = list(iter_suite_tests(suite))
2837
random.shuffle(tests)
2838
return TestUtil.TestSuite(tests)
2841
def split_suite_by_condition(suite, condition):
2842
"""Split a test suite into two by a condition.
2844
:param suite: The suite to split.
2845
:param condition: The condition to match on. Tests that match this
2846
condition are returned in the first test suite, ones that do not match
2847
are in the second suite.
2848
:return: A tuple of two test suites, where the first contains tests from
2849
suite matching the condition, and the second contains the remainder
2850
from suite. The order within each output suite is the same as it was in
2855
for test in iter_suite_tests(suite):
2857
matched.append(test)
2859
did_not_match.append(test)
2860
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2863
def split_suite_by_re(suite, pattern):
2864
"""Split a test suite into two by a regular expression.
2866
:param suite: The suite to split.
2867
:param pattern: A regular expression string. Test ids that match this
2868
pattern will be in the first test suite returned, and the others in the
2869
second test suite returned.
2870
:return: A tuple of two test suites, where the first contains tests from
2871
suite matching pattern, and the second contains the remainder from
2872
suite. The order within each output suite is the same as it was in
2875
return split_suite_by_condition(suite, condition_id_re(pattern))
2878
def run_suite(suite, name='test', verbose=False, pattern=".*",
2879
stop_on_failure=False,
2880
transport=None, lsprof_timed=None, bench_history=None,
2881
matching_tests_first=None,
2884
exclude_pattern=None,
2887
suite_decorators=None,
2889
result_decorators=None,
2891
"""Run a test suite for bzr selftest.
2893
:param runner_class: The class of runner to use. Must support the
2894
constructor arguments passed by run_suite which are more than standard
2896
:return: A boolean indicating success.
2898
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2903
if runner_class is None:
2904
runner_class = TextTestRunner
2907
runner = runner_class(stream=stream,
2909
verbosity=verbosity,
2910
bench_history=bench_history,
2912
result_decorators=result_decorators,
2914
runner.stop_on_failure=stop_on_failure
2915
# built in decorator factories:
2917
random_order(random_seed, runner),
2918
exclude_tests(exclude_pattern),
2920
if matching_tests_first:
2921
decorators.append(tests_first(pattern))
2923
decorators.append(filter_tests(pattern))
2924
if suite_decorators:
2925
decorators.extend(suite_decorators)
2926
# tell the result object how many tests will be running: (except if
2927
# --parallel=fork is being used. Robert said he will provide a better
2928
# progress design later -- vila 20090817)
2929
if fork_decorator not in decorators:
2930
decorators.append(CountingDecorator)
2931
for decorator in decorators:
2932
suite = decorator(suite)
2934
# Done after test suite decoration to allow randomisation etc
2935
# to take effect, though that is of marginal benefit.
2937
stream.write("Listing tests only ...\n")
2938
for t in iter_suite_tests(suite):
2939
stream.write("%s\n" % (t.id()))
2941
result = runner.run(suite)
2943
return result.wasStrictlySuccessful()
2945
return result.wasSuccessful()
2948
# A registry where get() returns a suite decorator.
2949
parallel_registry = registry.Registry()
2952
def fork_decorator(suite):
2953
concurrency = osutils.local_concurrency()
2954
if concurrency == 1:
2956
from testtools import ConcurrentTestSuite
2957
return ConcurrentTestSuite(suite, fork_for_tests)
2958
parallel_registry.register('fork', fork_decorator)
2961
def subprocess_decorator(suite):
2962
concurrency = osutils.local_concurrency()
2963
if concurrency == 1:
2965
from testtools import ConcurrentTestSuite
2966
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2967
parallel_registry.register('subprocess', subprocess_decorator)
2970
def exclude_tests(exclude_pattern):
2971
"""Return a test suite decorator that excludes tests."""
2972
if exclude_pattern is None:
2973
return identity_decorator
2974
def decorator(suite):
2975
return ExcludeDecorator(suite, exclude_pattern)
2979
def filter_tests(pattern):
2981
return identity_decorator
2982
def decorator(suite):
2983
return FilterTestsDecorator(suite, pattern)
2987
def random_order(random_seed, runner):
2988
"""Return a test suite decorator factory for randomising tests order.
2990
:param random_seed: now, a string which casts to a long, or a long.
2991
:param runner: A test runner with a stream attribute to report on.
2993
if random_seed is None:
2994
return identity_decorator
2995
def decorator(suite):
2996
return RandomDecorator(suite, random_seed, runner.stream)
3000
def tests_first(pattern):
3002
return identity_decorator
3003
def decorator(suite):
3004
return TestFirstDecorator(suite, pattern)
3008
def identity_decorator(suite):
3013
class TestDecorator(TestSuite):
3014
"""A decorator for TestCase/TestSuite objects.
3016
Usually, subclasses should override __iter__(used when flattening test
3017
suites), which we do to filter, reorder, parallelise and so on, run() and
3021
def __init__(self, suite):
3022
TestSuite.__init__(self)
3025
def countTestCases(self):
3028
cases += test.countTestCases()
3035
def run(self, result):
3036
# Use iteration on self, not self._tests, to allow subclasses to hook
3039
if result.shouldStop:
3045
class CountingDecorator(TestDecorator):
3046
"""A decorator which calls result.progress(self.countTestCases)."""
3048
def run(self, result):
3049
progress_method = getattr(result, 'progress', None)
3050
if callable(progress_method):
3051
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3052
return super(CountingDecorator, self).run(result)
3055
class ExcludeDecorator(TestDecorator):
3056
"""A decorator which excludes test matching an exclude pattern."""
3058
def __init__(self, suite, exclude_pattern):
3059
TestDecorator.__init__(self, suite)
3060
self.exclude_pattern = exclude_pattern
3061
self.excluded = False
3065
return iter(self._tests)
3066
self.excluded = True
3067
suite = exclude_tests_by_re(self, self.exclude_pattern)
3069
self.addTests(suite)
3070
return iter(self._tests)
3073
class FilterTestsDecorator(TestDecorator):
3074
"""A decorator which filters tests to those matching a pattern."""
3076
def __init__(self, suite, pattern):
3077
TestDecorator.__init__(self, suite)
3078
self.pattern = pattern
3079
self.filtered = False
3083
return iter(self._tests)
3084
self.filtered = True
3085
suite = filter_suite_by_re(self, self.pattern)
3087
self.addTests(suite)
3088
return iter(self._tests)
3091
class RandomDecorator(TestDecorator):
3092
"""A decorator which randomises the order of its tests."""
3094
def __init__(self, suite, random_seed, stream):
3095
TestDecorator.__init__(self, suite)
3096
self.random_seed = random_seed
3097
self.randomised = False
3098
self.stream = stream
3102
return iter(self._tests)
3103
self.randomised = True
3104
self.stream.write("Randomizing test order using seed %s\n\n" %
3105
(self.actual_seed()))
3106
# Initialise the random number generator.
3107
random.seed(self.actual_seed())
3108
suite = randomize_suite(self)
3110
self.addTests(suite)
3111
return iter(self._tests)
3113
def actual_seed(self):
3114
if self.random_seed == "now":
3115
# We convert the seed to a long to make it reuseable across
3116
# invocations (because the user can reenter it).
3117
self.random_seed = long(time.time())
3119
# Convert the seed to a long if we can
3121
self.random_seed = long(self.random_seed)
3124
return self.random_seed
3127
class TestFirstDecorator(TestDecorator):
3128
"""A decorator which moves named tests to the front."""
3130
def __init__(self, suite, pattern):
3131
TestDecorator.__init__(self, suite)
3132
self.pattern = pattern
3133
self.filtered = False
3137
return iter(self._tests)
3138
self.filtered = True
3139
suites = split_suite_by_re(self, self.pattern)
3141
self.addTests(suites)
3142
return iter(self._tests)
3145
def partition_tests(suite, count):
3146
"""Partition suite into count lists of tests."""
3148
tests = list(iter_suite_tests(suite))
3149
tests_per_process = int(math.ceil(float(len(tests)) / count))
3150
for block in range(count):
3151
low_test = block * tests_per_process
3152
high_test = low_test + tests_per_process
3153
process_tests = tests[low_test:high_test]
3154
result.append(process_tests)
3158
def fork_for_tests(suite):
3159
"""Take suite and start up one runner per CPU by forking()
3161
:return: An iterable of TestCase-like objects which can each have
3162
run(result) called on them to feed tests to result.
3164
concurrency = osutils.local_concurrency()
3166
from subunit import TestProtocolClient, ProtocolTestCase
3167
from subunit.test_results import AutoTimingTestResultDecorator
3168
class TestInOtherProcess(ProtocolTestCase):
3169
# Should be in subunit, I think. RBC.
3170
def __init__(self, stream, pid):
3171
ProtocolTestCase.__init__(self, stream)
3174
def run(self, result):
3176
ProtocolTestCase.run(self, result)
3178
os.waitpid(self.pid, os.WNOHANG)
3180
test_blocks = partition_tests(suite, concurrency)
3181
for process_tests in test_blocks:
3182
process_suite = TestSuite()
3183
process_suite.addTests(process_tests)
3184
c2pread, c2pwrite = os.pipe()
3189
# Leave stderr and stdout open so we can see test noise
3190
# Close stdin so that the child goes away if it decides to
3191
# read from stdin (otherwise its a roulette to see what
3192
# child actually gets keystrokes for pdb etc).
3195
stream = os.fdopen(c2pwrite, 'wb', 1)
3196
subunit_result = AutoTimingTestResultDecorator(
3197
TestProtocolClient(stream))
3198
process_suite.run(subunit_result)
3203
stream = os.fdopen(c2pread, 'rb', 1)
3204
test = TestInOtherProcess(stream, pid)
3209
def reinvoke_for_tests(suite):
3210
"""Take suite and start up one runner per CPU using subprocess().
3212
:return: An iterable of TestCase-like objects which can each have
3213
run(result) called on them to feed tests to result.
3215
concurrency = osutils.local_concurrency()
3217
from subunit import ProtocolTestCase
3218
class TestInSubprocess(ProtocolTestCase):
3219
def __init__(self, process, name):
3220
ProtocolTestCase.__init__(self, process.stdout)
3221
self.process = process
3222
self.process.stdin.close()
3225
def run(self, result):
3227
ProtocolTestCase.run(self, result)
3230
os.unlink(self.name)
3231
# print "pid %d finished" % finished_process
3232
test_blocks = partition_tests(suite, concurrency)
3233
for process_tests in test_blocks:
3234
# ugly; currently reimplement rather than reuses TestCase methods.
3235
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3236
if not os.path.isfile(bzr_path):
3237
# We are probably installed. Assume sys.argv is the right file
3238
bzr_path = sys.argv[0]
3239
bzr_path = [bzr_path]
3240
if sys.platform == "win32":
3241
# if we're on windows, we can't execute the bzr script directly
3242
bzr_path = [sys.executable] + bzr_path
3243
fd, test_list_file_name = tempfile.mkstemp()
3244
test_list_file = os.fdopen(fd, 'wb', 1)
3245
for test in process_tests:
3246
test_list_file.write(test.id() + '\n')
3247
test_list_file.close()
3249
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3251
if '--no-plugins' in sys.argv:
3252
argv.append('--no-plugins')
3253
# stderr=STDOUT would be ideal, but until we prevent noise on
3254
# stderr it can interrupt the subunit protocol.
3255
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3257
test = TestInSubprocess(process, test_list_file_name)
3260
os.unlink(test_list_file_name)
3265
class ForwardingResult(unittest.TestResult):
3267
def __init__(self, target):
3268
unittest.TestResult.__init__(self)
3269
self.result = target
3271
def startTest(self, test):
3272
self.result.startTest(test)
3274
def stopTest(self, test):
3275
self.result.stopTest(test)
3277
def startTestRun(self):
3278
self.result.startTestRun()
3280
def stopTestRun(self):
3281
self.result.stopTestRun()
3283
def addSkip(self, test, reason):
3284
self.result.addSkip(test, reason)
3286
def addSuccess(self, test):
3287
self.result.addSuccess(test)
3289
def addError(self, test, err):
3290
self.result.addError(test, err)
3292
def addFailure(self, test, err):
3293
self.result.addFailure(test, err)
3294
ForwardingResult = testtools.ExtendedToOriginalDecorator
3297
class ProfileResult(ForwardingResult):
3298
"""Generate profiling data for all activity between start and success.
3300
The profile data is appended to the test's _benchcalls attribute and can
3301
be accessed by the forwarded-to TestResult.
3303
While it might be cleaner do accumulate this in stopTest, addSuccess is
3304
where our existing output support for lsprof is, and this class aims to
3305
fit in with that: while it could be moved it's not necessary to accomplish
3306
test profiling, nor would it be dramatically cleaner.
3309
def startTest(self, test):
3310
self.profiler = bzrlib.lsprof.BzrProfiler()
3311
self.profiler.start()
3312
ForwardingResult.startTest(self, test)
3314
def addSuccess(self, test):
3315
stats = self.profiler.stop()
3317
calls = test._benchcalls
3318
except AttributeError:
3319
test._benchcalls = []
3320
calls = test._benchcalls
3321
calls.append(((test.id(), "", ""), stats))
3322
ForwardingResult.addSuccess(self, test)
3324
def stopTest(self, test):
3325
ForwardingResult.stopTest(self, test)
3326
self.profiler = None
3329
# Controlled by "bzr selftest -E=..." option
3330
# Currently supported:
3331
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3332
# preserves any flags supplied at the command line.
3333
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3334
# rather than failing tests. And no longer raise
3335
# LockContention when fctnl locks are not being used
3336
# with proper exclusion rules.
3337
selftest_debug_flags = set()
3340
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3342
test_suite_factory=None,
3345
matching_tests_first=None,
3348
exclude_pattern=None,
3354
suite_decorators=None,
3358
"""Run the whole test suite under the enhanced runner"""
3359
# XXX: Very ugly way to do this...
3360
# Disable warning about old formats because we don't want it to disturb
3361
# any blackbox tests.
3362
from bzrlib import repository
3363
repository._deprecation_warning_done = True
3365
global default_transport
3366
if transport is None:
3367
transport = default_transport
3368
old_transport = default_transport
3369
default_transport = transport
3370
global selftest_debug_flags
3371
old_debug_flags = selftest_debug_flags
3372
if debug_flags is not None:
3373
selftest_debug_flags = set(debug_flags)
3375
if load_list is None:
3378
keep_only = load_test_id_list(load_list)
3380
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3381
for start in starting_with]
3382
if test_suite_factory is None:
3383
# Reduce loading time by loading modules based on the starting_with
3385
suite = test_suite(keep_only, starting_with)
3387
suite = test_suite_factory()
3389
# But always filter as requested.
3390
suite = filter_suite_by_id_startswith(suite, starting_with)
3391
result_decorators = []
3393
result_decorators.append(ProfileResult)
3394
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3395
stop_on_failure=stop_on_failure,
3396
transport=transport,
3397
lsprof_timed=lsprof_timed,
3398
bench_history=bench_history,
3399
matching_tests_first=matching_tests_first,
3400
list_only=list_only,
3401
random_seed=random_seed,
3402
exclude_pattern=exclude_pattern,
3404
runner_class=runner_class,
3405
suite_decorators=suite_decorators,
3407
result_decorators=result_decorators,
3410
default_transport = old_transport
3411
selftest_debug_flags = old_debug_flags
3414
def load_test_id_list(file_name):
3415
"""Load a test id list from a text file.
3417
The format is one test id by line. No special care is taken to impose
3418
strict rules, these test ids are used to filter the test suite so a test id
3419
that do not match an existing test will do no harm. This allows user to add
3420
comments, leave blank lines, etc.
3424
ftest = open(file_name, 'rt')
3426
if e.errno != errno.ENOENT:
3429
raise errors.NoSuchFile(file_name)
3431
for test_name in ftest.readlines():
3432
test_list.append(test_name.strip())
3437
def suite_matches_id_list(test_suite, id_list):
3438
"""Warns about tests not appearing or appearing more than once.
3440
:param test_suite: A TestSuite object.
3441
:param test_id_list: The list of test ids that should be found in
3444
:return: (absents, duplicates) absents is a list containing the test found
3445
in id_list but not in test_suite, duplicates is a list containing the
3446
test found multiple times in test_suite.
3448
When using a prefined test id list, it may occurs that some tests do not
3449
exist anymore or that some tests use the same id. This function warns the
3450
tester about potential problems in his workflow (test lists are volatile)
3451
or in the test suite itself (using the same id for several tests does not
3452
help to localize defects).
3454
# Build a dict counting id occurrences
3456
for test in iter_suite_tests(test_suite):
3458
tests[id] = tests.get(id, 0) + 1
3463
occurs = tests.get(id, 0)
3465
not_found.append(id)
3467
duplicates.append(id)
3469
return not_found, duplicates
3472
class TestIdList(object):
3473
"""Test id list to filter a test suite.
3475
Relying on the assumption that test ids are built as:
3476
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3477
notation, this class offers methods to :
3478
- avoid building a test suite for modules not refered to in the test list,
3479
- keep only the tests listed from the module test suite.
3482
def __init__(self, test_id_list):
3483
# When a test suite needs to be filtered against us we compare test ids
3484
# for equality, so a simple dict offers a quick and simple solution.
3485
self.tests = dict().fromkeys(test_id_list, True)
3487
# While unittest.TestCase have ids like:
3488
# <module>.<class>.<method>[(<param+)],
3489
# doctest.DocTestCase can have ids like:
3492
# <module>.<function>
3493
# <module>.<class>.<method>
3495
# Since we can't predict a test class from its name only, we settle on
3496
# a simple constraint: a test id always begins with its module name.
3499
for test_id in test_id_list:
3500
parts = test_id.split('.')
3501
mod_name = parts.pop(0)
3502
modules[mod_name] = True
3504
mod_name += '.' + part
3505
modules[mod_name] = True
3506
self.modules = modules
3508
def refers_to(self, module_name):
3509
"""Is there tests for the module or one of its sub modules."""
3510
return self.modules.has_key(module_name)
3512
def includes(self, test_id):
3513
return self.tests.has_key(test_id)
3516
class TestPrefixAliasRegistry(registry.Registry):
3517
"""A registry for test prefix aliases.
3519
This helps implement shorcuts for the --starting-with selftest
3520
option. Overriding existing prefixes is not allowed but not fatal (a
3521
warning will be emitted).
3524
def register(self, key, obj, help=None, info=None,
3525
override_existing=False):
3526
"""See Registry.register.
3528
Trying to override an existing alias causes a warning to be emitted,
3529
not a fatal execption.
3532
super(TestPrefixAliasRegistry, self).register(
3533
key, obj, help=help, info=info, override_existing=False)
3535
actual = self.get(key)
3536
note('Test prefix alias %s is already used for %s, ignoring %s'
3537
% (key, actual, obj))
3539
def resolve_alias(self, id_start):
3540
"""Replace the alias by the prefix in the given string.
3542
Using an unknown prefix is an error to help catching typos.
3544
parts = id_start.split('.')
3546
parts[0] = self.get(parts[0])
3548
raise errors.BzrCommandError(
3549
'%s is not a known test prefix alias' % parts[0])
3550
return '.'.join(parts)
3553
test_prefix_alias_registry = TestPrefixAliasRegistry()
3554
"""Registry of test prefix aliases."""
3557
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3558
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3559
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3561
# Obvious highest levels prefixes, feel free to add your own via a plugin
3562
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3563
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3564
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3565
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3566
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3569
def _test_suite_testmod_names():
3570
"""Return the standard list of test module names to test."""
3573
'bzrlib.tests.blackbox',
3574
'bzrlib.tests.commands',
3575
'bzrlib.tests.per_branch',
3576
'bzrlib.tests.per_bzrdir',
3577
'bzrlib.tests.per_foreign_vcs',
3578
'bzrlib.tests.per_interrepository',
3579
'bzrlib.tests.per_intertree',
3580
'bzrlib.tests.per_inventory',
3581
'bzrlib.tests.per_interbranch',
3582
'bzrlib.tests.per_lock',
3583
'bzrlib.tests.per_merger',
3584
'bzrlib.tests.per_transport',
3585
'bzrlib.tests.per_tree',
3586
'bzrlib.tests.per_pack_repository',
3587
'bzrlib.tests.per_repository',
3588
'bzrlib.tests.per_repository_chk',
3589
'bzrlib.tests.per_repository_reference',
3590
'bzrlib.tests.per_uifactory',
3591
'bzrlib.tests.per_versionedfile',
3592
'bzrlib.tests.per_workingtree',
3593
'bzrlib.tests.test__annotator',
3594
'bzrlib.tests.test__bencode',
3595
'bzrlib.tests.test__chk_map',
3596
'bzrlib.tests.test__dirstate_helpers',
3597
'bzrlib.tests.test__groupcompress',
3598
'bzrlib.tests.test__known_graph',
3599
'bzrlib.tests.test__rio',
3600
'bzrlib.tests.test__simple_set',
3601
'bzrlib.tests.test__static_tuple',
3602
'bzrlib.tests.test__walkdirs_win32',
3603
'bzrlib.tests.test_ancestry',
3604
'bzrlib.tests.test_annotate',
3605
'bzrlib.tests.test_api',
3606
'bzrlib.tests.test_atomicfile',
3607
'bzrlib.tests.test_bad_files',
3608
'bzrlib.tests.test_bisect_multi',
3609
'bzrlib.tests.test_branch',
3610
'bzrlib.tests.test_branchbuilder',
3611
'bzrlib.tests.test_btree_index',
3612
'bzrlib.tests.test_bugtracker',
3613
'bzrlib.tests.test_bundle',
3614
'bzrlib.tests.test_bzrdir',
3615
'bzrlib.tests.test__chunks_to_lines',
3616
'bzrlib.tests.test_cache_utf8',
3617
'bzrlib.tests.test_chk_map',
3618
'bzrlib.tests.test_chk_serializer',
3619
'bzrlib.tests.test_chunk_writer',
3620
'bzrlib.tests.test_clean_tree',
3621
'bzrlib.tests.test_cleanup',
3622
'bzrlib.tests.test_commands',
3623
'bzrlib.tests.test_commit',
3624
'bzrlib.tests.test_commit_merge',
3625
'bzrlib.tests.test_config',
3626
'bzrlib.tests.test_conflicts',
3627
'bzrlib.tests.test_counted_lock',
3628
'bzrlib.tests.test_crash',
3629
'bzrlib.tests.test_decorators',
3630
'bzrlib.tests.test_delta',
3631
'bzrlib.tests.test_debug',
3632
'bzrlib.tests.test_deprecated_graph',
3633
'bzrlib.tests.test_diff',
3634
'bzrlib.tests.test_directory_service',
3635
'bzrlib.tests.test_dirstate',
3636
'bzrlib.tests.test_email_message',
3637
'bzrlib.tests.test_eol_filters',
3638
'bzrlib.tests.test_errors',
3639
'bzrlib.tests.test_export',
3640
'bzrlib.tests.test_extract',
3641
'bzrlib.tests.test_fetch',
3642
'bzrlib.tests.test_fifo_cache',
3643
'bzrlib.tests.test_filters',
3644
'bzrlib.tests.test_ftp_transport',
3645
'bzrlib.tests.test_foreign',
3646
'bzrlib.tests.test_generate_docs',
3647
'bzrlib.tests.test_generate_ids',
3648
'bzrlib.tests.test_globbing',
3649
'bzrlib.tests.test_gpg',
3650
'bzrlib.tests.test_graph',
3651
'bzrlib.tests.test_groupcompress',
3652
'bzrlib.tests.test_hashcache',
3653
'bzrlib.tests.test_help',
3654
'bzrlib.tests.test_hooks',
3655
'bzrlib.tests.test_http',
3656
'bzrlib.tests.test_http_response',
3657
'bzrlib.tests.test_https_ca_bundle',
3658
'bzrlib.tests.test_identitymap',
3659
'bzrlib.tests.test_ignores',
3660
'bzrlib.tests.test_index',
3661
'bzrlib.tests.test_info',
3662
'bzrlib.tests.test_inv',
3663
'bzrlib.tests.test_inventory_delta',
3664
'bzrlib.tests.test_knit',
3665
'bzrlib.tests.test_lazy_import',
3666
'bzrlib.tests.test_lazy_regex',
3667
'bzrlib.tests.test_lock',
3668
'bzrlib.tests.test_lockable_files',
3669
'bzrlib.tests.test_lockdir',
3670
'bzrlib.tests.test_log',
3671
'bzrlib.tests.test_lru_cache',
3672
'bzrlib.tests.test_lsprof',
3673
'bzrlib.tests.test_mail_client',
3674
'bzrlib.tests.test_memorytree',
3675
'bzrlib.tests.test_merge',
3676
'bzrlib.tests.test_merge3',
3677
'bzrlib.tests.test_merge_core',
3678
'bzrlib.tests.test_merge_directive',
3679
'bzrlib.tests.test_missing',
3680
'bzrlib.tests.test_msgeditor',
3681
'bzrlib.tests.test_multiparent',
3682
'bzrlib.tests.test_mutabletree',
3683
'bzrlib.tests.test_nonascii',
3684
'bzrlib.tests.test_options',
3685
'bzrlib.tests.test_osutils',
3686
'bzrlib.tests.test_osutils_encodings',
3687
'bzrlib.tests.test_pack',
3688
'bzrlib.tests.test_patch',
3689
'bzrlib.tests.test_patches',
3690
'bzrlib.tests.test_permissions',
3691
'bzrlib.tests.test_plugins',
3692
'bzrlib.tests.test_progress',
3693
'bzrlib.tests.test_read_bundle',
3694
'bzrlib.tests.test_reconcile',
3695
'bzrlib.tests.test_reconfigure',
3696
'bzrlib.tests.test_registry',
3697
'bzrlib.tests.test_remote',
3698
'bzrlib.tests.test_rename_map',
3699
'bzrlib.tests.test_repository',
3700
'bzrlib.tests.test_revert',
3701
'bzrlib.tests.test_revision',
3702
'bzrlib.tests.test_revisionspec',
3703
'bzrlib.tests.test_revisiontree',
3704
'bzrlib.tests.test_rio',
3705
'bzrlib.tests.test_rules',
3706
'bzrlib.tests.test_sampler',
3707
'bzrlib.tests.test_script',
3708
'bzrlib.tests.test_selftest',
3709
'bzrlib.tests.test_serializer',
3710
'bzrlib.tests.test_setup',
3711
'bzrlib.tests.test_sftp_transport',
3712
'bzrlib.tests.test_shelf',
3713
'bzrlib.tests.test_shelf_ui',
3714
'bzrlib.tests.test_smart',
3715
'bzrlib.tests.test_smart_add',
3716
'bzrlib.tests.test_smart_request',
3717
'bzrlib.tests.test_smart_transport',
3718
'bzrlib.tests.test_smtp_connection',
3719
'bzrlib.tests.test_source',
3720
'bzrlib.tests.test_ssh_transport',
3721
'bzrlib.tests.test_status',
3722
'bzrlib.tests.test_store',
3723
'bzrlib.tests.test_strace',
3724
'bzrlib.tests.test_subsume',
3725
'bzrlib.tests.test_switch',
3726
'bzrlib.tests.test_symbol_versioning',
3727
'bzrlib.tests.test_tag',
3728
'bzrlib.tests.test_testament',
3729
'bzrlib.tests.test_textfile',
3730
'bzrlib.tests.test_textmerge',
3731
'bzrlib.tests.test_timestamp',
3732
'bzrlib.tests.test_trace',
3733
'bzrlib.tests.test_transactions',
3734
'bzrlib.tests.test_transform',
3735
'bzrlib.tests.test_transport',
3736
'bzrlib.tests.test_transport_log',
3737
'bzrlib.tests.test_tree',
3738
'bzrlib.tests.test_treebuilder',
3739
'bzrlib.tests.test_tsort',
3740
'bzrlib.tests.test_tuned_gzip',
3741
'bzrlib.tests.test_ui',
3742
'bzrlib.tests.test_uncommit',
3743
'bzrlib.tests.test_upgrade',
3744
'bzrlib.tests.test_upgrade_stacked',
3745
'bzrlib.tests.test_urlutils',
3746
'bzrlib.tests.test_version',
3747
'bzrlib.tests.test_version_info',
3748
'bzrlib.tests.test_weave',
3749
'bzrlib.tests.test_whitebox',
3750
'bzrlib.tests.test_win32utils',
3751
'bzrlib.tests.test_workingtree',
3752
'bzrlib.tests.test_workingtree_4',
3753
'bzrlib.tests.test_wsgi',
3754
'bzrlib.tests.test_xml',
3758
def _test_suite_modules_to_doctest():
3759
"""Return the list of modules to doctest."""
3762
'bzrlib.branchbuilder',
3763
'bzrlib.decorators',
3766
'bzrlib.iterablefile',
3770
'bzrlib.symbol_versioning',
3773
'bzrlib.version_info_formats.format_custom',
3777
def test_suite(keep_only=None, starting_with=None):
3778
"""Build and return TestSuite for the whole of bzrlib.
3780
:param keep_only: A list of test ids limiting the suite returned.
3782
:param starting_with: An id limiting the suite returned to the tests
3785
This function can be replaced if you need to change the default test
3786
suite on a global basis, but it is not encouraged.
3789
loader = TestUtil.TestLoader()
3791
if keep_only is not None:
3792
id_filter = TestIdList(keep_only)
3794
# We take precedence over keep_only because *at loading time* using
3795
# both options means we will load less tests for the same final result.
3796
def interesting_module(name):
3797
for start in starting_with:
3799
# Either the module name starts with the specified string
3800
name.startswith(start)
3801
# or it may contain tests starting with the specified string
3802
or start.startswith(name)
3806
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3808
elif keep_only is not None:
3809
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3810
def interesting_module(name):
3811
return id_filter.refers_to(name)
3814
loader = TestUtil.TestLoader()
3815
def interesting_module(name):
3816
# No filtering, all modules are interesting
3819
suite = loader.suiteClass()
3821
# modules building their suite with loadTestsFromModuleNames
3822
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3824
for mod in _test_suite_modules_to_doctest():
3825
if not interesting_module(mod):
3826
# No tests to keep here, move along
3829
# note that this really does mean "report only" -- doctest
3830
# still runs the rest of the examples
3831
doc_suite = doctest.DocTestSuite(mod,
3832
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3833
except ValueError, e:
3834
print '**failed to get doctest for: %s\n%s' % (mod, e)
3836
if len(doc_suite._tests) == 0:
3837
raise errors.BzrError("no doctests found in %s" % (mod,))
3838
suite.addTest(doc_suite)
3840
default_encoding = sys.getdefaultencoding()
3841
for name, plugin in bzrlib.plugin.plugins().items():
3842
if not interesting_module(plugin.module.__name__):
3844
plugin_suite = plugin.test_suite()
3845
# We used to catch ImportError here and turn it into just a warning,
3846
# but really if you don't have --no-plugins this should be a failure.
3847
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3848
if plugin_suite is None:
3849
plugin_suite = plugin.load_plugin_tests(loader)
3850
if plugin_suite is not None:
3851
suite.addTest(plugin_suite)
3852
if default_encoding != sys.getdefaultencoding():
3853
bzrlib.trace.warning(
3854
'Plugin "%s" tried to reset default encoding to: %s', name,
3855
sys.getdefaultencoding())
3857
sys.setdefaultencoding(default_encoding)
3859
if keep_only is not None:
3860
# Now that the referred modules have loaded their tests, keep only the
3862
suite = filter_suite_by_id_list(suite, id_filter)
3863
# Do some sanity checks on the id_list filtering
3864
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3866
# The tester has used both keep_only and starting_with, so he is
3867
# already aware that some tests are excluded from the list, there
3868
# is no need to tell him which.
3871
# Some tests mentioned in the list are not in the test suite. The
3872
# list may be out of date, report to the tester.
3873
for id in not_found:
3874
bzrlib.trace.warning('"%s" not found in the test suite', id)
3875
for id in duplicates:
3876
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3881
def multiply_scenarios(scenarios_left, scenarios_right):
3882
"""Multiply two sets of scenarios.
3884
:returns: the cartesian product of the two sets of scenarios, that is
3885
a scenario for every possible combination of a left scenario and a
3889
('%s,%s' % (left_name, right_name),
3890
dict(left_dict.items() + right_dict.items()))
3891
for left_name, left_dict in scenarios_left
3892
for right_name, right_dict in scenarios_right]
3895
def multiply_tests(tests, scenarios, result):
3896
"""Multiply tests_list by scenarios into result.
3898
This is the core workhorse for test parameterisation.
3900
Typically the load_tests() method for a per-implementation test suite will
3901
call multiply_tests and return the result.
3903
:param tests: The tests to parameterise.
3904
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3905
scenario_param_dict).
3906
:param result: A TestSuite to add created tests to.
3908
This returns the passed in result TestSuite with the cross product of all
3909
the tests repeated once for each scenario. Each test is adapted by adding
3910
the scenario name at the end of its id(), and updating the test object's
3911
__dict__ with the scenario_param_dict.
3913
>>> import bzrlib.tests.test_sampler
3914
>>> r = multiply_tests(
3915
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3916
... [('one', dict(param=1)),
3917
... ('two', dict(param=2))],
3919
>>> tests = list(iter_suite_tests(r))
3923
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3929
for test in iter_suite_tests(tests):
3930
apply_scenarios(test, scenarios, result)
3934
def apply_scenarios(test, scenarios, result):
3935
"""Apply the scenarios in scenarios to test and add to result.
3937
:param test: The test to apply scenarios to.
3938
:param scenarios: An iterable of scenarios to apply to test.
3940
:seealso: apply_scenario
3942
for scenario in scenarios:
3943
result.addTest(apply_scenario(test, scenario))
3947
def apply_scenario(test, scenario):
3948
"""Copy test and apply scenario to it.
3950
:param test: A test to adapt.
3951
:param scenario: A tuple describing the scenarion.
3952
The first element of the tuple is the new test id.
3953
The second element is a dict containing attributes to set on the
3955
:return: The adapted test.
3957
new_id = "%s(%s)" % (test.id(), scenario[0])
3958
new_test = clone_test(test, new_id)
3959
for name, value in scenario[1].items():
3960
setattr(new_test, name, value)
3964
def clone_test(test, new_id):
3965
"""Clone a test giving it a new id.
3967
:param test: The test to clone.
3968
:param new_id: The id to assign to it.
3969
:return: The new test.
3971
new_test = copy(test)
3972
new_test.id = lambda: new_id
3976
def permute_tests_for_extension(standard_tests, loader, py_module_name,
3978
"""Helper for permutating tests against an extension module.
3980
This is meant to be used inside a modules 'load_tests()' function. It will
3981
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
3982
against both implementations. Setting 'test.module' to the appropriate
3983
module. See bzrlib.tests.test__chk_map.load_tests as an example.
3985
:param standard_tests: A test suite to permute
3986
:param loader: A TestLoader
3987
:param py_module_name: The python path to a python module that can always
3988
be loaded, and will be considered the 'python' implementation. (eg
3989
'bzrlib._chk_map_py')
3990
:param ext_module_name: The python path to an extension module. If the
3991
module cannot be loaded, a single test will be added, which notes that
3992
the module is not available. If it can be loaded, all standard_tests
3993
will be run against that module.
3994
:return: (suite, feature) suite is a test-suite that has all the permuted
3995
tests. feature is the Feature object that can be used to determine if
3996
the module is available.
3999
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4001
('python', {'module': py_module}),
4003
suite = loader.suiteClass()
4004
feature = ModuleAvailableFeature(ext_module_name)
4005
if feature.available():
4006
scenarios.append(('C', {'module': feature.module}))
4008
# the compiled module isn't available, so we add a failing test
4009
class FailWithoutFeature(TestCase):
4010
def test_fail(self):
4011
self.requireFeature(feature)
4012
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4013
result = multiply_tests(standard_tests, scenarios, suite)
4014
return result, feature
4017
def _rmtree_temp_dir(dirname, test_id=None):
4018
# If LANG=C we probably have created some bogus paths
4019
# which rmtree(unicode) will fail to delete
4020
# so make sure we are using rmtree(str) to delete everything
4021
# except on win32, where rmtree(str) will fail
4022
# since it doesn't have the property of byte-stream paths
4023
# (they are either ascii or mbcs)
4024
if sys.platform == 'win32':
4025
# make sure we are using the unicode win32 api
4026
dirname = unicode(dirname)
4028
dirname = dirname.encode(sys.getfilesystemencoding())
4030
osutils.rmtree(dirname)
4032
# We don't want to fail here because some useful display will be lost
4033
# otherwise. Polluting the tmp dir is bad, but not giving all the
4034
# possible info to the test runner is even worse.
4036
ui.ui_factory.clear_term()
4037
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4038
sys.stderr.write('Unable to remove testing dir %s\n%s'
4039
% (os.path.basename(dirname), e))
4042
class Feature(object):
4043
"""An operating system Feature."""
4046
self._available = None
4048
def available(self):
4049
"""Is the feature available?
4051
:return: True if the feature is available.
4053
if self._available is None:
4054
self._available = self._probe()
4055
return self._available
4058
"""Implement this method in concrete features.
4060
:return: True if the feature is available.
4062
raise NotImplementedError
4065
if getattr(self, 'feature_name', None):
4066
return self.feature_name()
4067
return self.__class__.__name__
4070
class _SymlinkFeature(Feature):
4073
return osutils.has_symlinks()
4075
def feature_name(self):
4078
SymlinkFeature = _SymlinkFeature()
4081
class _HardlinkFeature(Feature):
4084
return osutils.has_hardlinks()
4086
def feature_name(self):
4089
HardlinkFeature = _HardlinkFeature()
4092
class _OsFifoFeature(Feature):
4095
return getattr(os, 'mkfifo', None)
4097
def feature_name(self):
4098
return 'filesystem fifos'
4100
OsFifoFeature = _OsFifoFeature()
4103
class _UnicodeFilenameFeature(Feature):
4104
"""Does the filesystem support Unicode filenames?"""
4108
# Check for character combinations unlikely to be covered by any
4109
# single non-unicode encoding. We use the characters
4110
# - greek small letter alpha (U+03B1) and
4111
# - braille pattern dots-123456 (U+283F).
4112
os.stat(u'\u03b1\u283f')
4113
except UnicodeEncodeError:
4115
except (IOError, OSError):
4116
# The filesystem allows the Unicode filename but the file doesn't
4120
# The filesystem allows the Unicode filename and the file exists,
4124
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4127
class _CompatabilityThunkFeature(Feature):
4128
"""This feature is just a thunk to another feature.
4130
It issues a deprecation warning if it is accessed, to let you know that you
4131
should really use a different feature.
4134
def __init__(self, dep_version, module, name,
4135
replacement_name, replacement_module=None):
4136
super(_CompatabilityThunkFeature, self).__init__()
4137
self._module = module
4138
if replacement_module is None:
4139
replacement_module = module
4140
self._replacement_module = replacement_module
4142
self._replacement_name = replacement_name
4143
self._dep_version = dep_version
4144
self._feature = None
4147
if self._feature is None:
4148
depr_msg = self._dep_version % ('%s.%s'
4149
% (self._module, self._name))
4150
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4151
self._replacement_name)
4152
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4153
# Import the new feature and use it as a replacement for the
4155
mod = __import__(self._replacement_module, {}, {},
4156
[self._replacement_name])
4157
self._feature = getattr(mod, self._replacement_name)
4161
return self._feature._probe()
4164
class ModuleAvailableFeature(Feature):
4165
"""This is a feature than describes a module we want to be available.
4167
Declare the name of the module in __init__(), and then after probing, the
4168
module will be available as 'self.module'.
4170
:ivar module: The module if it is available, else None.
4173
def __init__(self, module_name):
4174
super(ModuleAvailableFeature, self).__init__()
4175
self.module_name = module_name
4179
self._module = __import__(self.module_name, {}, {}, [''])
4186
if self.available(): # Make sure the probe has been done
4190
def feature_name(self):
4191
return self.module_name
4194
# This is kept here for compatibility, it is recommended to use
4195
# 'bzrlib.tests.feature.paramiko' instead
4196
ParamikoFeature = _CompatabilityThunkFeature(
4197
deprecated_in((2,1,0)),
4198
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4201
def probe_unicode_in_user_encoding():
4202
"""Try to encode several unicode strings to use in unicode-aware tests.
4203
Return first successfull match.
4205
:return: (unicode value, encoded plain string value) or (None, None)
4207
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4208
for uni_val in possible_vals:
4210
str_val = uni_val.encode(osutils.get_user_encoding())
4211
except UnicodeEncodeError:
4212
# Try a different character
4215
return uni_val, str_val
4219
def probe_bad_non_ascii(encoding):
4220
"""Try to find [bad] character with code [128..255]
4221
that cannot be decoded to unicode in some encoding.
4222
Return None if all non-ascii characters is valid
4225
for i in xrange(128, 256):
4228
char.decode(encoding)
4229
except UnicodeDecodeError:
4234
class _HTTPSServerFeature(Feature):
4235
"""Some tests want an https Server, check if one is available.
4237
Right now, the only way this is available is under python2.6 which provides
4248
def feature_name(self):
4249
return 'HTTPSServer'
4252
HTTPSServerFeature = _HTTPSServerFeature()
4255
class _UnicodeFilename(Feature):
4256
"""Does the filesystem support Unicode filenames?"""
4261
except UnicodeEncodeError:
4263
except (IOError, OSError):
4264
# The filesystem allows the Unicode filename but the file doesn't
4268
# The filesystem allows the Unicode filename and the file exists,
4272
UnicodeFilename = _UnicodeFilename()
4275
class _UTF8Filesystem(Feature):
4276
"""Is the filesystem UTF-8?"""
4279
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4283
UTF8Filesystem = _UTF8Filesystem()
4286
class _BreakinFeature(Feature):
4287
"""Does this platform support the breakin feature?"""
4290
from bzrlib import breakin
4291
if breakin.determine_signal() is None:
4293
if sys.platform == 'win32':
4294
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4295
# We trigger SIGBREAK via a Console api so we need ctypes to
4296
# access the function
4303
def feature_name(self):
4304
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4307
BreakinFeature = _BreakinFeature()
4310
class _CaseInsCasePresFilenameFeature(Feature):
4311
"""Is the file-system case insensitive, but case-preserving?"""
4314
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4316
# first check truly case-preserving for created files, then check
4317
# case insensitive when opening existing files.
4318
name = osutils.normpath(name)
4319
base, rel = osutils.split(name)
4320
found_rel = osutils.canonical_relpath(base, name)
4321
return (found_rel == rel
4322
and os.path.isfile(name.upper())
4323
and os.path.isfile(name.lower()))
4328
def feature_name(self):
4329
return "case-insensitive case-preserving filesystem"
4331
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4334
class _CaseInsensitiveFilesystemFeature(Feature):
4335
"""Check if underlying filesystem is case-insensitive but *not* case
4338
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4339
# more likely to be case preserving, so this case is rare.
4342
if CaseInsCasePresFilenameFeature.available():
4345
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4346
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4347
TestCaseWithMemoryTransport.TEST_ROOT = root
4349
root = TestCaseWithMemoryTransport.TEST_ROOT
4350
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4352
name_a = osutils.pathjoin(tdir, 'a')
4353
name_A = osutils.pathjoin(tdir, 'A')
4355
result = osutils.isdir(name_A)
4356
_rmtree_temp_dir(tdir)
4359
def feature_name(self):
4360
return 'case-insensitive filesystem'
4362
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4365
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4366
SubUnitFeature = _CompatabilityThunkFeature(
4367
deprecated_in((2,1,0)),
4368
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4369
# Only define SubUnitBzrRunner if subunit is available.
4371
from subunit import TestProtocolClient
4372
from subunit.test_results import AutoTimingTestResultDecorator
4373
class SubUnitBzrRunner(TextTestRunner):
4374
def run(self, test):
4375
result = AutoTimingTestResultDecorator(
4376
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
