1
# Copyright (C) 2005-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 (
109
import bzrlib.transport
110
from bzrlib.trace import mutter, note
111
from bzrlib.tests import (
115
from bzrlib.tests.http_server import HttpServer
116
from bzrlib.tests.TestUtil import (
120
from bzrlib.tests.treeshape import build_tree_contents
121
from bzrlib.ui import NullProgressView
122
from bzrlib.ui.text import TextUIFactory
123
import bzrlib.version_info_formats.format_custom
124
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
126
# Mark this python module as being part of the implementation
127
# of unittest: this gives us better tracebacks where the last
128
# shown frame is the test code, not our assertXYZ.
131
default_transport = test_server.LocalURLServer
134
_unitialized_attr = object()
135
"""A sentinel needed to act as a default value in a method signature."""
138
# Subunit result codes, defined here to prevent a hard dependency on subunit.
143
class ExtendedTestResult(unittest._TextTestResult):
144
"""Accepts, reports and accumulates the results of running tests.
146
Compared to the unittest version this class adds support for
147
profiling, benchmarking, stopping as soon as a test fails, and
148
skipping tests. There are further-specialized subclasses for
149
different types of display.
151
When a test finishes, in whatever way, it calls one of the addSuccess,
152
addFailure or addError classes. These in turn may redirect to a more
153
specific case for the special test results supported by our extended
156
Note that just one of these objects is fed the results from many tests.
161
def __init__(self, stream, descriptions, verbosity,
165
"""Construct new TestResult.
167
:param bench_history: Optionally, a writable file object to accumulate
170
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
171
if bench_history is not None:
172
from bzrlib.version import _get_bzr_source_tree
173
src_tree = _get_bzr_source_tree()
176
revision_id = src_tree.get_parent_ids()[0]
178
# XXX: if this is a brand new tree, do the same as if there
182
# XXX: If there's no branch, what should we do?
184
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
185
self._bench_history = bench_history
186
self.ui = ui.ui_factory
189
self.failure_count = 0
190
self.known_failure_count = 0
192
self.not_applicable_count = 0
193
self.unsupported = {}
195
self._overall_start_time = time.time()
196
self._strict = strict
198
def stopTestRun(self):
201
stopTime = time.time()
202
timeTaken = stopTime - self.startTime
204
self.stream.writeln(self.separator2)
205
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
206
run, run != 1 and "s" or "", timeTaken))
207
self.stream.writeln()
208
if not self.wasSuccessful():
209
self.stream.write("FAILED (")
210
failed, errored = map(len, (self.failures, self.errors))
212
self.stream.write("failures=%d" % failed)
214
if failed: self.stream.write(", ")
215
self.stream.write("errors=%d" % errored)
216
if self.known_failure_count:
217
if failed or errored: self.stream.write(", ")
218
self.stream.write("known_failure_count=%d" %
219
self.known_failure_count)
220
self.stream.writeln(")")
222
if self.known_failure_count:
223
self.stream.writeln("OK (known_failures=%d)" %
224
self.known_failure_count)
226
self.stream.writeln("OK")
227
if self.skip_count > 0:
228
skipped = self.skip_count
229
self.stream.writeln('%d test%s skipped' %
230
(skipped, skipped != 1 and "s" or ""))
232
for feature, count in sorted(self.unsupported.items()):
233
self.stream.writeln("Missing feature '%s' skipped %d tests." %
236
ok = self.wasStrictlySuccessful()
238
ok = self.wasSuccessful()
239
if TestCase._first_thread_leaker_id:
241
'%s is leaking threads among %d leaking tests.\n' % (
242
TestCase._first_thread_leaker_id,
243
TestCase._leaking_threads_tests))
244
# We don't report the main thread as an active one.
246
'%d non-main threads were left active in the end.\n'
247
% (TestCase._active_threads - 1))
249
def getDescription(self, test):
252
def _extractBenchmarkTime(self, testCase, details=None):
253
"""Add a benchmark time for the current test case."""
254
if details and 'benchtime' in details:
255
return float(''.join(details['benchtime'].iter_bytes()))
256
return getattr(testCase, "_benchtime", None)
258
def _elapsedTestTimeString(self):
259
"""Return a time string for the overall time the current test has taken."""
260
return self._formatTime(time.time() - self._start_time)
262
def _testTimeString(self, testCase):
263
benchmark_time = self._extractBenchmarkTime(testCase)
264
if benchmark_time is not None:
265
return self._formatTime(benchmark_time) + "*"
267
return self._elapsedTestTimeString()
269
def _formatTime(self, seconds):
270
"""Format seconds as milliseconds with leading spaces."""
271
# some benchmarks can take thousands of seconds to run, so we need 8
273
return "%8dms" % (1000 * seconds)
275
def _shortened_test_description(self, test):
277
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
280
def startTest(self, test):
281
unittest.TestResult.startTest(self, test)
284
self.report_test_start(test)
285
test.number = self.count
286
self._recordTestStartTime()
288
def startTests(self):
290
if getattr(sys, 'frozen', None) is None:
291
bzr_path = osutils.realpath(sys.argv[0])
293
bzr_path = sys.executable
295
'bzr selftest: %s\n' % (bzr_path,))
298
bzrlib.__path__[0],))
300
' bzr-%s python-%s %s\n' % (
301
bzrlib.version_string,
302
bzrlib._format_version_tuple(sys.version_info),
303
platform.platform(aliased=1),
305
self.stream.write('\n')
307
def _recordTestStartTime(self):
308
"""Record that a test has started."""
309
self._start_time = time.time()
311
def _cleanupLogFile(self, test):
312
# We can only do this if we have one of our TestCases, not if
314
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
315
if setKeepLogfile is not None:
318
def addError(self, test, err):
319
"""Tell result that test finished with an error.
321
Called from the TestCase run() method when the test
322
fails with an unexpected error.
325
unittest.TestResult.addError(self, test, err)
326
self.error_count += 1
327
self.report_error(test, err)
330
self._cleanupLogFile(test)
332
def addFailure(self, test, err):
333
"""Tell result that test failed.
335
Called from the TestCase run() method when the test
336
fails because e.g. an assert() method failed.
339
unittest.TestResult.addFailure(self, test, err)
340
self.failure_count += 1
341
self.report_failure(test, err)
344
self._cleanupLogFile(test)
346
def addSuccess(self, test, details=None):
347
"""Tell result that test completed successfully.
349
Called from the TestCase run()
351
if self._bench_history is not None:
352
benchmark_time = self._extractBenchmarkTime(test, details)
353
if benchmark_time is not None:
354
self._bench_history.write("%s %s\n" % (
355
self._formatTime(benchmark_time),
357
self.report_success(test)
358
self._cleanupLogFile(test)
359
unittest.TestResult.addSuccess(self, test)
360
test._log_contents = ''
362
def addExpectedFailure(self, test, err):
363
self.known_failure_count += 1
364
self.report_known_failure(test, err)
366
def addNotSupported(self, test, feature):
367
"""The test will not be run because of a missing feature.
369
# this can be called in two different ways: it may be that the
370
# test started running, and then raised (through requireFeature)
371
# UnavailableFeature. Alternatively this method can be called
372
# while probing for features before running the test code proper; in
373
# that case we will see startTest and stopTest, but the test will
374
# never actually run.
375
self.unsupported.setdefault(str(feature), 0)
376
self.unsupported[str(feature)] += 1
377
self.report_unsupported(test, feature)
379
def addSkip(self, test, reason):
380
"""A test has not run for 'reason'."""
382
self.report_skip(test, reason)
384
def addNotApplicable(self, test, reason):
385
self.not_applicable_count += 1
386
self.report_not_applicable(test, reason)
388
def _post_mortem(self):
389
"""Start a PDB post mortem session."""
390
if os.environ.get('BZR_TEST_PDB', None):
391
import pdb;pdb.post_mortem()
393
def progress(self, offset, whence):
394
"""The test is adjusting the count of tests to run."""
395
if whence == SUBUNIT_SEEK_SET:
396
self.num_tests = offset
397
elif whence == SUBUNIT_SEEK_CUR:
398
self.num_tests += offset
400
raise errors.BzrError("Unknown whence %r" % whence)
402
def report_cleaning_up(self):
405
def startTestRun(self):
406
self.startTime = time.time()
408
def report_success(self, test):
411
def wasStrictlySuccessful(self):
412
if self.unsupported or self.known_failure_count:
414
return self.wasSuccessful()
417
class TextTestResult(ExtendedTestResult):
418
"""Displays progress and results of tests in text form"""
420
def __init__(self, stream, descriptions, verbosity,
425
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
426
bench_history, strict)
427
# We no longer pass them around, but just rely on the UIFactory stack
430
warnings.warn("Passing pb to TextTestResult is deprecated")
431
self.pb = self.ui.nested_progress_bar()
432
self.pb.show_pct = False
433
self.pb.show_spinner = False
434
self.pb.show_eta = False,
435
self.pb.show_count = False
436
self.pb.show_bar = False
437
self.pb.update_latency = 0
438
self.pb.show_transport_activity = False
440
def stopTestRun(self):
441
# called when the tests that are going to run have run
444
super(TextTestResult, self).stopTestRun()
446
def startTestRun(self):
447
super(TextTestResult, self).startTestRun()
448
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
450
def printErrors(self):
451
# clear the pb to make room for the error listing
453
super(TextTestResult, self).printErrors()
455
def _progress_prefix_text(self):
456
# the longer this text, the less space we have to show the test
458
a = '[%d' % self.count # total that have been run
459
# tests skipped as known not to be relevant are not important enough
461
## if self.skip_count:
462
## a += ', %d skip' % self.skip_count
463
## if self.known_failure_count:
464
## a += '+%dX' % self.known_failure_count
466
a +='/%d' % self.num_tests
468
runtime = time.time() - self._overall_start_time
470
a += '%dm%ds' % (runtime / 60, runtime % 60)
473
total_fail_count = self.error_count + self.failure_count
475
a += ', %d failed' % total_fail_count
476
# if self.unsupported:
477
# a += ', %d missing' % len(self.unsupported)
481
def report_test_start(self, test):
484
self._progress_prefix_text()
486
+ self._shortened_test_description(test))
488
def _test_description(self, test):
489
return self._shortened_test_description(test)
491
def report_error(self, test, err):
492
self.ui.note('ERROR: %s\n %s\n' % (
493
self._test_description(test),
497
def report_failure(self, test, err):
498
self.ui.note('FAIL: %s\n %s\n' % (
499
self._test_description(test),
503
def report_known_failure(self, test, err):
506
def report_skip(self, test, reason):
509
def report_not_applicable(self, test, reason):
512
def report_unsupported(self, test, feature):
513
"""test cannot be run because feature is missing."""
515
def report_cleaning_up(self):
516
self.pb.update('Cleaning up')
519
class VerboseTestResult(ExtendedTestResult):
520
"""Produce long output, with one line per test run plus times"""
522
def _ellipsize_to_right(self, a_string, final_width):
523
"""Truncate and pad a string, keeping the right hand side"""
524
if len(a_string) > final_width:
525
result = '...' + a_string[3-final_width:]
528
return result.ljust(final_width)
530
def startTestRun(self):
531
super(VerboseTestResult, self).startTestRun()
532
self.stream.write('running %d tests...\n' % self.num_tests)
534
def report_test_start(self, test):
536
name = self._shortened_test_description(test)
537
width = osutils.terminal_width()
538
if width is not None:
539
# width needs space for 6 char status, plus 1 for slash, plus an
540
# 11-char time string, plus a trailing blank
541
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
543
self.stream.write(self._ellipsize_to_right(name, width-18))
545
self.stream.write(name)
548
def _error_summary(self, err):
550
return '%s%s' % (indent, err[1])
552
def report_error(self, test, err):
553
self.stream.writeln('ERROR %s\n%s'
554
% (self._testTimeString(test),
555
self._error_summary(err)))
557
def report_failure(self, test, err):
558
self.stream.writeln(' FAIL %s\n%s'
559
% (self._testTimeString(test),
560
self._error_summary(err)))
562
def report_known_failure(self, test, err):
563
self.stream.writeln('XFAIL %s\n%s'
564
% (self._testTimeString(test),
565
self._error_summary(err)))
567
def report_success(self, test):
568
self.stream.writeln(' OK %s' % self._testTimeString(test))
569
for bench_called, stats in getattr(test, '_benchcalls', []):
570
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
571
stats.pprint(file=self.stream)
572
# flush the stream so that we get smooth output. This verbose mode is
573
# used to show the output in PQM.
576
def report_skip(self, test, reason):
577
self.stream.writeln(' SKIP %s\n%s'
578
% (self._testTimeString(test), reason))
580
def report_not_applicable(self, test, reason):
581
self.stream.writeln(' N/A %s\n %s'
582
% (self._testTimeString(test), reason))
584
def report_unsupported(self, test, feature):
585
"""test cannot be run because feature is missing."""
586
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
587
%(self._testTimeString(test), feature))
590
class TextTestRunner(object):
591
stop_on_failure = False
599
result_decorators=None,
601
"""Create a TextTestRunner.
603
:param result_decorators: An optional list of decorators to apply
604
to the result object being used by the runner. Decorators are
605
applied left to right - the first element in the list is the
608
# stream may know claim to know to write unicode strings, but in older
609
# pythons this goes sufficiently wrong that it is a bad idea. (
610
# specifically a built in file with encoding 'UTF-8' will still try
611
# to encode using ascii.
612
new_encoding = osutils.get_terminal_encoding()
613
codec = codecs.lookup(new_encoding)
614
if type(codec) is tuple:
618
encode = codec.encode
619
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
620
stream.encoding = new_encoding
621
self.stream = unittest._WritelnDecorator(stream)
622
self.descriptions = descriptions
623
self.verbosity = verbosity
624
self._bench_history = bench_history
625
self._strict = strict
626
self._result_decorators = result_decorators or []
629
"Run the given test case or test suite."
630
if self.verbosity == 1:
631
result_class = TextTestResult
632
elif self.verbosity >= 2:
633
result_class = VerboseTestResult
634
original_result = result_class(self.stream,
637
bench_history=self._bench_history,
640
# Signal to result objects that look at stop early policy to stop,
641
original_result.stop_early = self.stop_on_failure
642
result = original_result
643
for decorator in self._result_decorators:
644
result = decorator(result)
645
result.stop_early = self.stop_on_failure
646
result.startTestRun()
651
# higher level code uses our extended protocol to determine
652
# what exit code to give.
653
return original_result
656
def iter_suite_tests(suite):
657
"""Return all tests in a suite, recursing through nested suites"""
658
if isinstance(suite, unittest.TestCase):
660
elif isinstance(suite, unittest.TestSuite):
662
for r in iter_suite_tests(item):
665
raise Exception('unknown type %r for object %r'
666
% (type(suite), suite))
669
TestSkipped = testtools.testcase.TestSkipped
672
class TestNotApplicable(TestSkipped):
673
"""A test is not applicable to the situation where it was run.
675
This is only normally raised by parameterized tests, if they find that
676
the instance they're constructed upon does not support one aspect
681
# traceback._some_str fails to format exceptions that have the default
682
# __str__ which does an implicit ascii conversion. However, repr() on those
683
# objects works, for all that its not quite what the doctor may have ordered.
684
def _clever_some_str(value):
689
return repr(value).replace('\\n', '\n')
691
return '<unprintable %s object>' % type(value).__name__
693
traceback._some_str = _clever_some_str
696
# deprecated - use self.knownFailure(), or self.expectFailure.
697
KnownFailure = testtools.testcase._ExpectedFailure
700
class UnavailableFeature(Exception):
701
"""A feature required for this test was not available.
703
This can be considered a specialised form of SkippedTest.
705
The feature should be used to construct the exception.
709
class StringIOWrapper(object):
710
"""A wrapper around cStringIO which just adds an encoding attribute.
712
Internally we can check sys.stdout to see what the output encoding
713
should be. However, cStringIO has no encoding attribute that we can
714
set. So we wrap it instead.
719
def __init__(self, s=None):
721
self.__dict__['_cstring'] = StringIO(s)
723
self.__dict__['_cstring'] = StringIO()
725
def __getattr__(self, name, getattr=getattr):
726
return getattr(self.__dict__['_cstring'], name)
728
def __setattr__(self, name, val):
729
if name == 'encoding':
730
self.__dict__['encoding'] = val
732
return setattr(self._cstring, name, val)
735
class TestUIFactory(TextUIFactory):
736
"""A UI Factory for testing.
738
Hide the progress bar but emit note()s.
740
Allows get_password to be tested without real tty attached.
742
See also CannedInputUIFactory which lets you provide programmatic input in
745
# TODO: Capture progress events at the model level and allow them to be
746
# observed by tests that care.
748
# XXX: Should probably unify more with CannedInputUIFactory or a
749
# particular configuration of TextUIFactory, or otherwise have a clearer
750
# idea of how they're supposed to be different.
751
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
753
def __init__(self, stdout=None, stderr=None, stdin=None):
754
if stdin is not None:
755
# We use a StringIOWrapper to be able to test various
756
# encodings, but the user is still responsible to
757
# encode the string and to set the encoding attribute
758
# of StringIOWrapper.
759
stdin = StringIOWrapper(stdin)
760
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
762
def get_non_echoed_password(self):
763
"""Get password from stdin without trying to handle the echo mode"""
764
password = self.stdin.readline()
767
if password[-1] == '\n':
768
password = password[:-1]
771
def make_progress_view(self):
772
return NullProgressView()
775
class TestCase(testtools.TestCase):
776
"""Base class for bzr unit tests.
778
Tests that need access to disk resources should subclass
779
TestCaseInTempDir not TestCase.
781
Error and debug log messages are redirected from their usual
782
location into a temporary file, the contents of which can be
783
retrieved by _get_log(). We use a real OS file, not an in-memory object,
784
so that it can also capture file IO. When the test completes this file
785
is read into memory and removed from disk.
787
There are also convenience functions to invoke bzr's command-line
788
routine, and to build and check bzr trees.
790
In addition to the usual method of overriding tearDown(), this class also
791
allows subclasses to register functions into the _cleanups list, which is
792
run in order as the object is torn down. It's less likely this will be
793
accidentally overlooked.
796
_active_threads = None
797
_leaking_threads_tests = 0
798
_first_thread_leaker_id = None
799
_log_file_name = None
800
# record lsprof data when performing benchmark calls.
801
_gather_lsprof_in_benchmarks = False
803
def __init__(self, methodName='testMethod'):
804
super(TestCase, self).__init__(methodName)
806
self._directory_isolation = True
807
self.exception_handlers.insert(0,
808
(UnavailableFeature, self._do_unsupported_or_skip))
809
self.exception_handlers.insert(0,
810
(TestNotApplicable, self._do_not_applicable))
813
super(TestCase, self).setUp()
814
for feature in getattr(self, '_test_needs_features', []):
815
self.requireFeature(feature)
816
self._log_contents = None
817
self.addDetail("log", content.Content(content.ContentType("text",
818
"plain", {"charset": "utf8"}),
819
lambda:[self._get_log(keep_log_file=True)]))
820
self._cleanEnvironment()
823
self._benchcalls = []
824
self._benchtime = None
826
self._track_transports()
828
self._clear_debug_flags()
829
TestCase._active_threads = threading.activeCount()
830
self.addCleanup(self._check_leaked_threads)
835
pdb.Pdb().set_trace(sys._getframe().f_back)
837
def _check_leaked_threads(self):
838
active = threading.activeCount()
839
leaked_threads = active - TestCase._active_threads
840
TestCase._active_threads = active
841
# If some tests make the number of threads *decrease*, we'll consider
842
# that they are just observing old threads dieing, not agressively kill
843
# random threads. So we don't report these tests as leaking. The risk
844
# is that we have false positives that way (the test see 2 threads
845
# going away but leak one) but it seems less likely than the actual
846
# false positives (the test see threads going away and does not leak).
847
if leaked_threads > 0:
848
TestCase._leaking_threads_tests += 1
849
if TestCase._first_thread_leaker_id is None:
850
TestCase._first_thread_leaker_id = self.id()
852
def _clear_debug_flags(self):
853
"""Prevent externally set debug flags affecting tests.
855
Tests that want to use debug flags can just set them in the
856
debug_flags set during setup/teardown.
858
# Start with a copy of the current debug flags we can safely modify.
859
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
860
if 'allow_debug' not in selftest_debug_flags:
861
debug.debug_flags.clear()
862
if 'disable_lock_checks' not in selftest_debug_flags:
863
debug.debug_flags.add('strict_locks')
865
def _clear_hooks(self):
866
# prevent hooks affecting tests
867
self._preserved_hooks = {}
868
for key, factory in hooks.known_hooks.items():
869
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
870
current_hooks = hooks.known_hooks_key_to_object(key)
871
self._preserved_hooks[parent] = (name, current_hooks)
872
self.addCleanup(self._restoreHooks)
873
for key, factory in hooks.known_hooks.items():
874
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
875
setattr(parent, name, factory())
876
# this hook should always be installed
877
request._install_hook()
879
def disable_directory_isolation(self):
880
"""Turn off directory isolation checks."""
881
self._directory_isolation = False
883
def enable_directory_isolation(self):
884
"""Enable directory isolation checks."""
885
self._directory_isolation = True
887
def _silenceUI(self):
888
"""Turn off UI for duration of test"""
889
# by default the UI is off; tests can turn it on if they want it.
890
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
892
def _check_locks(self):
893
"""Check that all lock take/release actions have been paired."""
894
# We always check for mismatched locks. If a mismatch is found, we
895
# fail unless -Edisable_lock_checks is supplied to selftest, in which
896
# case we just print a warning.
898
acquired_locks = [lock for action, lock in self._lock_actions
899
if action == 'acquired']
900
released_locks = [lock for action, lock in self._lock_actions
901
if action == 'released']
902
broken_locks = [lock for action, lock in self._lock_actions
903
if action == 'broken']
904
# trivially, given the tests for lock acquistion and release, if we
905
# have as many in each list, it should be ok. Some lock tests also
906
# break some locks on purpose and should be taken into account by
907
# considering that breaking a lock is just a dirty way of releasing it.
908
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
909
message = ('Different number of acquired and '
910
'released or broken locks. (%s, %s + %s)' %
911
(acquired_locks, released_locks, broken_locks))
912
if not self._lock_check_thorough:
913
# Rather than fail, just warn
914
print "Broken test %s: %s" % (self, message)
918
def _track_locks(self):
919
"""Track lock activity during tests."""
920
self._lock_actions = []
921
if 'disable_lock_checks' in selftest_debug_flags:
922
self._lock_check_thorough = False
924
self._lock_check_thorough = True
926
self.addCleanup(self._check_locks)
927
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
928
self._lock_acquired, None)
929
_mod_lock.Lock.hooks.install_named_hook('lock_released',
930
self._lock_released, None)
931
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
932
self._lock_broken, None)
934
def _lock_acquired(self, result):
935
self._lock_actions.append(('acquired', result))
937
def _lock_released(self, result):
938
self._lock_actions.append(('released', result))
940
def _lock_broken(self, result):
941
self._lock_actions.append(('broken', result))
943
def permit_dir(self, name):
944
"""Permit a directory to be used by this test. See permit_url."""
945
name_transport = get_transport(name)
946
self.permit_url(name)
947
self.permit_url(name_transport.base)
949
def permit_url(self, url):
950
"""Declare that url is an ok url to use in this test.
952
Do this for memory transports, temporary test directory etc.
954
Do not do this for the current working directory, /tmp, or any other
955
preexisting non isolated url.
957
if not url.endswith('/'):
959
self._bzr_selftest_roots.append(url)
961
def permit_source_tree_branch_repo(self):
962
"""Permit the source tree bzr is running from to be opened.
964
Some code such as bzrlib.version attempts to read from the bzr branch
965
that bzr is executing from (if any). This method permits that directory
966
to be used in the test suite.
968
path = self.get_source_path()
969
self.record_directory_isolation()
972
workingtree.WorkingTree.open(path)
973
except (errors.NotBranchError, errors.NoWorkingTree):
976
self.enable_directory_isolation()
978
def _preopen_isolate_transport(self, transport):
979
"""Check that all transport openings are done in the test work area."""
980
while isinstance(transport, pathfilter.PathFilteringTransport):
981
# Unwrap pathfiltered transports
982
transport = transport.server.backing_transport.clone(
983
transport._filter('.'))
985
# ReadonlySmartTCPServer_for_testing decorates the backing transport
986
# urls it is given by prepending readonly+. This is appropriate as the
987
# client shouldn't know that the server is readonly (or not readonly).
988
# We could register all servers twice, with readonly+ prepending, but
989
# that makes for a long list; this is about the same but easier to
991
if url.startswith('readonly+'):
992
url = url[len('readonly+'):]
993
self._preopen_isolate_url(url)
995
def _preopen_isolate_url(self, url):
996
if not self._directory_isolation:
998
if self._directory_isolation == 'record':
999
self._bzr_selftest_roots.append(url)
1001
# This prevents all transports, including e.g. sftp ones backed on disk
1002
# from working unless they are explicitly granted permission. We then
1003
# depend on the code that sets up test transports to check that they are
1004
# appropriately isolated and enable their use by calling
1005
# self.permit_transport()
1006
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1007
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1008
% (url, self._bzr_selftest_roots))
1010
def record_directory_isolation(self):
1011
"""Gather accessed directories to permit later access.
1013
This is used for tests that access the branch bzr is running from.
1015
self._directory_isolation = "record"
1017
def start_server(self, transport_server, backing_server=None):
1018
"""Start transport_server for this test.
1020
This starts the server, registers a cleanup for it and permits the
1021
server's urls to be used.
1023
if backing_server is None:
1024
transport_server.start_server()
1026
transport_server.start_server(backing_server)
1027
self.addCleanup(transport_server.stop_server)
1028
# Obtain a real transport because if the server supplies a password, it
1029
# will be hidden from the base on the client side.
1030
t = get_transport(transport_server.get_url())
1031
# Some transport servers effectively chroot the backing transport;
1032
# others like SFTPServer don't - users of the transport can walk up the
1033
# transport to read the entire backing transport. This wouldn't matter
1034
# except that the workdir tests are given - and that they expect the
1035
# server's url to point at - is one directory under the safety net. So
1036
# Branch operations into the transport will attempt to walk up one
1037
# directory. Chrooting all servers would avoid this but also mean that
1038
# we wouldn't be testing directly against non-root urls. Alternatively
1039
# getting the test framework to start the server with a backing server
1040
# at the actual safety net directory would work too, but this then
1041
# means that the self.get_url/self.get_transport methods would need
1042
# to transform all their results. On balance its cleaner to handle it
1043
# here, and permit a higher url when we have one of these transports.
1044
if t.base.endswith('/work/'):
1045
# we have safety net/test root/work
1046
t = t.clone('../..')
1047
elif isinstance(transport_server,
1048
test_server.SmartTCPServer_for_testing):
1049
# The smart server adds a path similar to work, which is traversed
1050
# up from by the client. But the server is chrooted - the actual
1051
# backing transport is not escaped from, and VFS requests to the
1052
# root will error (because they try to escape the chroot).
1054
while t2.base != t.base:
1057
self.permit_url(t.base)
1059
def _track_transports(self):
1060
"""Install checks for transport usage."""
1061
# TestCase has no safe place it can write to.
1062
self._bzr_selftest_roots = []
1063
# Currently the easiest way to be sure that nothing is going on is to
1064
# hook into bzr dir opening. This leaves a small window of error for
1065
# transport tests, but they are well known, and we can improve on this
1067
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1068
self._preopen_isolate_transport, "Check bzr directories are safe.")
1070
def _ndiff_strings(self, a, b):
1071
"""Return ndiff between two strings containing lines.
1073
A trailing newline is added if missing to make the strings
1075
if b and b[-1] != '\n':
1077
if a and a[-1] != '\n':
1079
difflines = difflib.ndiff(a.splitlines(True),
1081
linejunk=lambda x: False,
1082
charjunk=lambda x: False)
1083
return ''.join(difflines)
1085
def assertEqual(self, a, b, message=''):
1089
except UnicodeError, e:
1090
# If we can't compare without getting a UnicodeError, then
1091
# obviously they are different
1092
mutter('UnicodeError: %s', e)
1095
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1097
pformat(a), pformat(b)))
1099
assertEquals = assertEqual
1101
def assertEqualDiff(self, a, b, message=None):
1102
"""Assert two texts are equal, if not raise an exception.
1104
This is intended for use with multi-line strings where it can
1105
be hard to find the differences by eye.
1107
# TODO: perhaps override assertEquals to call this for strings?
1111
message = "texts not equal:\n"
1113
message = 'first string is missing a final newline.\n'
1115
message = 'second string is missing a final newline.\n'
1116
raise AssertionError(message +
1117
self._ndiff_strings(a, b))
1119
def assertEqualMode(self, mode, mode_test):
1120
self.assertEqual(mode, mode_test,
1121
'mode mismatch %o != %o' % (mode, mode_test))
1123
def assertEqualStat(self, expected, actual):
1124
"""assert that expected and actual are the same stat result.
1126
:param expected: A stat result.
1127
:param actual: A stat result.
1128
:raises AssertionError: If the expected and actual stat values differ
1129
other than by atime.
1131
self.assertEqual(expected.st_size, actual.st_size,
1132
'st_size did not match')
1133
self.assertEqual(expected.st_mtime, actual.st_mtime,
1134
'st_mtime did not match')
1135
self.assertEqual(expected.st_ctime, actual.st_ctime,
1136
'st_ctime did not match')
1137
if sys.platform != 'win32':
1138
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1139
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1140
# odd. Regardless we shouldn't actually try to assert anything
1141
# about their values
1142
self.assertEqual(expected.st_dev, actual.st_dev,
1143
'st_dev did not match')
1144
self.assertEqual(expected.st_ino, actual.st_ino,
1145
'st_ino did not match')
1146
self.assertEqual(expected.st_mode, actual.st_mode,
1147
'st_mode did not match')
1149
def assertLength(self, length, obj_with_len):
1150
"""Assert that obj_with_len is of length length."""
1151
if len(obj_with_len) != length:
1152
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1153
length, len(obj_with_len), obj_with_len))
1155
def assertLogsError(self, exception_class, func, *args, **kwargs):
1156
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1158
from bzrlib import trace
1160
orig_log_exception_quietly = trace.log_exception_quietly
1163
orig_log_exception_quietly()
1164
captured.append(sys.exc_info())
1165
trace.log_exception_quietly = capture
1166
func(*args, **kwargs)
1168
trace.log_exception_quietly = orig_log_exception_quietly
1169
self.assertLength(1, captured)
1170
err = captured[0][1]
1171
self.assertIsInstance(err, exception_class)
1174
def assertPositive(self, val):
1175
"""Assert that val is greater than 0."""
1176
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1178
def assertNegative(self, val):
1179
"""Assert that val is less than 0."""
1180
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1182
def assertStartsWith(self, s, prefix):
1183
if not s.startswith(prefix):
1184
raise AssertionError('string %r does not start with %r' % (s, prefix))
1186
def assertEndsWith(self, s, suffix):
1187
"""Asserts that s ends with suffix."""
1188
if not s.endswith(suffix):
1189
raise AssertionError('string %r does not end with %r' % (s, suffix))
1191
def assertContainsRe(self, haystack, needle_re, flags=0):
1192
"""Assert that a contains something matching a regular expression."""
1193
if not re.search(needle_re, haystack, flags):
1194
if '\n' in haystack or len(haystack) > 60:
1195
# a long string, format it in a more readable way
1196
raise AssertionError(
1197
'pattern "%s" not found in\n"""\\\n%s"""\n'
1198
% (needle_re, haystack))
1200
raise AssertionError('pattern "%s" not found in "%s"'
1201
% (needle_re, haystack))
1203
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1204
"""Assert that a does not match a regular expression"""
1205
if re.search(needle_re, haystack, flags):
1206
raise AssertionError('pattern "%s" found in "%s"'
1207
% (needle_re, haystack))
1209
def assertContainsString(self, haystack, needle):
1210
if haystack.find(needle) == -1:
1211
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1213
def assertSubset(self, sublist, superlist):
1214
"""Assert that every entry in sublist is present in superlist."""
1215
missing = set(sublist) - set(superlist)
1216
if len(missing) > 0:
1217
raise AssertionError("value(s) %r not present in container %r" %
1218
(missing, superlist))
1220
def assertListRaises(self, excClass, func, *args, **kwargs):
1221
"""Fail unless excClass is raised when the iterator from func is used.
1223
Many functions can return generators this makes sure
1224
to wrap them in a list() call to make sure the whole generator
1225
is run, and that the proper exception is raised.
1228
list(func(*args, **kwargs))
1232
if getattr(excClass,'__name__', None) is not None:
1233
excName = excClass.__name__
1235
excName = str(excClass)
1236
raise self.failureException, "%s not raised" % excName
1238
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1239
"""Assert that a callable raises a particular exception.
1241
:param excClass: As for the except statement, this may be either an
1242
exception class, or a tuple of classes.
1243
:param callableObj: A callable, will be passed ``*args`` and
1246
Returns the exception so that you can examine it.
1249
callableObj(*args, **kwargs)
1253
if getattr(excClass,'__name__', None) is not None:
1254
excName = excClass.__name__
1257
excName = str(excClass)
1258
raise self.failureException, "%s not raised" % excName
1260
def assertIs(self, left, right, message=None):
1261
if not (left is right):
1262
if message is not None:
1263
raise AssertionError(message)
1265
raise AssertionError("%r is not %r." % (left, right))
1267
def assertIsNot(self, left, right, message=None):
1269
if message is not None:
1270
raise AssertionError(message)
1272
raise AssertionError("%r is %r." % (left, right))
1274
def assertTransportMode(self, transport, path, mode):
1275
"""Fail if a path does not have mode "mode".
1277
If modes are not supported on this transport, the assertion is ignored.
1279
if not transport._can_roundtrip_unix_modebits():
1281
path_stat = transport.stat(path)
1282
actual_mode = stat.S_IMODE(path_stat.st_mode)
1283
self.assertEqual(mode, actual_mode,
1284
'mode of %r incorrect (%s != %s)'
1285
% (path, oct(mode), oct(actual_mode)))
1287
def assertIsSameRealPath(self, path1, path2):
1288
"""Fail if path1 and path2 points to different files"""
1289
self.assertEqual(osutils.realpath(path1),
1290
osutils.realpath(path2),
1291
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1293
def assertIsInstance(self, obj, kls, msg=None):
1294
"""Fail if obj is not an instance of kls
1296
:param msg: Supplementary message to show if the assertion fails.
1298
if not isinstance(obj, kls):
1299
m = "%r is an instance of %s rather than %s" % (
1300
obj, obj.__class__, kls)
1305
def assertFileEqual(self, content, path):
1306
"""Fail if path does not contain 'content'."""
1307
self.failUnlessExists(path)
1308
f = file(path, 'rb')
1313
self.assertEqualDiff(content, s)
1315
def failUnlessExists(self, path):
1316
"""Fail unless path or paths, which may be abs or relative, exist."""
1317
if not isinstance(path, basestring):
1319
self.failUnlessExists(p)
1321
self.failUnless(osutils.lexists(path),path+" does not exist")
1323
def failIfExists(self, path):
1324
"""Fail if path or paths, which may be abs or relative, exist."""
1325
if not isinstance(path, basestring):
1327
self.failIfExists(p)
1329
self.failIf(osutils.lexists(path),path+" exists")
1331
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1332
"""A helper for callDeprecated and applyDeprecated.
1334
:param a_callable: A callable to call.
1335
:param args: The positional arguments for the callable
1336
:param kwargs: The keyword arguments for the callable
1337
:return: A tuple (warnings, result). result is the result of calling
1338
a_callable(``*args``, ``**kwargs``).
1341
def capture_warnings(msg, cls=None, stacklevel=None):
1342
# we've hooked into a deprecation specific callpath,
1343
# only deprecations should getting sent via it.
1344
self.assertEqual(cls, DeprecationWarning)
1345
local_warnings.append(msg)
1346
original_warning_method = symbol_versioning.warn
1347
symbol_versioning.set_warning_method(capture_warnings)
1349
result = a_callable(*args, **kwargs)
1351
symbol_versioning.set_warning_method(original_warning_method)
1352
return (local_warnings, result)
1354
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1355
"""Call a deprecated callable without warning the user.
1357
Note that this only captures warnings raised by symbol_versioning.warn,
1358
not other callers that go direct to the warning module.
1360
To test that a deprecated method raises an error, do something like
1363
self.assertRaises(errors.ReservedId,
1364
self.applyDeprecated,
1365
deprecated_in((1, 5, 0)),
1369
:param deprecation_format: The deprecation format that the callable
1370
should have been deprecated with. This is the same type as the
1371
parameter to deprecated_method/deprecated_function. If the
1372
callable is not deprecated with this format, an assertion error
1374
:param a_callable: A callable to call. This may be a bound method or
1375
a regular function. It will be called with ``*args`` and
1377
:param args: The positional arguments for the callable
1378
:param kwargs: The keyword arguments for the callable
1379
:return: The result of a_callable(``*args``, ``**kwargs``)
1381
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1383
expected_first_warning = symbol_versioning.deprecation_string(
1384
a_callable, deprecation_format)
1385
if len(call_warnings) == 0:
1386
self.fail("No deprecation warning generated by call to %s" %
1388
self.assertEqual(expected_first_warning, call_warnings[0])
1391
def callCatchWarnings(self, fn, *args, **kw):
1392
"""Call a callable that raises python warnings.
1394
The caller's responsible for examining the returned warnings.
1396
If the callable raises an exception, the exception is not
1397
caught and propagates up to the caller. In that case, the list
1398
of warnings is not available.
1400
:returns: ([warning_object, ...], fn_result)
1402
# XXX: This is not perfect, because it completely overrides the
1403
# warnings filters, and some code may depend on suppressing particular
1404
# warnings. It's the easiest way to insulate ourselves from -Werror,
1405
# though. -- Andrew, 20071062
1407
def _catcher(message, category, filename, lineno, file=None, line=None):
1408
# despite the name, 'message' is normally(?) a Warning subclass
1410
wlist.append(message)
1411
saved_showwarning = warnings.showwarning
1412
saved_filters = warnings.filters
1414
warnings.showwarning = _catcher
1415
warnings.filters = []
1416
result = fn(*args, **kw)
1418
warnings.showwarning = saved_showwarning
1419
warnings.filters = saved_filters
1420
return wlist, result
1422
def callDeprecated(self, expected, callable, *args, **kwargs):
1423
"""Assert that a callable is deprecated in a particular way.
1425
This is a very precise test for unusual requirements. The
1426
applyDeprecated helper function is probably more suited for most tests
1427
as it allows you to simply specify the deprecation format being used
1428
and will ensure that that is issued for the function being called.
1430
Note that this only captures warnings raised by symbol_versioning.warn,
1431
not other callers that go direct to the warning module. To catch
1432
general warnings, use callCatchWarnings.
1434
:param expected: a list of the deprecation warnings expected, in order
1435
:param callable: The callable to call
1436
:param args: The positional arguments for the callable
1437
:param kwargs: The keyword arguments for the callable
1439
call_warnings, result = self._capture_deprecation_warnings(callable,
1441
self.assertEqual(expected, call_warnings)
1444
def _startLogFile(self):
1445
"""Send bzr and test log messages to a temporary file.
1447
The file is removed as the test is torn down.
1449
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1450
self._log_file = os.fdopen(fileno, 'w+')
1451
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1452
self._log_file_name = name
1453
self.addCleanup(self._finishLogFile)
1455
def _finishLogFile(self):
1456
"""Finished with the log file.
1458
Close the file and delete it, unless setKeepLogfile was called.
1460
if bzrlib.trace._trace_file:
1461
# flush the log file, to get all content
1462
bzrlib.trace._trace_file.flush()
1463
bzrlib.trace.pop_log_file(self._log_memento)
1464
# Cache the log result and delete the file on disk
1465
self._get_log(False)
1467
def thisFailsStrictLockCheck(self):
1468
"""It is known that this test would fail with -Dstrict_locks.
1470
By default, all tests are run with strict lock checking unless
1471
-Edisable_lock_checks is supplied. However there are some tests which
1472
we know fail strict locks at this point that have not been fixed.
1473
They should call this function to disable the strict checking.
1475
This should be used sparingly, it is much better to fix the locking
1476
issues rather than papering over the problem by calling this function.
1478
debug.debug_flags.discard('strict_locks')
1480
def addCleanup(self, callable, *args, **kwargs):
1481
"""Arrange to run a callable when this case is torn down.
1483
Callables are run in the reverse of the order they are registered,
1484
ie last-in first-out.
1486
self._cleanups.append((callable, args, kwargs))
1488
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1489
"""Overrides an object attribute restoring it after the test.
1491
:param obj: The object that will be mutated.
1493
:param attr_name: The attribute name we want to preserve/override in
1496
:param new: The optional value we want to set the attribute to.
1498
:returns: The actual attr value.
1500
value = getattr(obj, attr_name)
1501
# The actual value is captured by the call below
1502
self.addCleanup(setattr, obj, attr_name, value)
1503
if new is not _unitialized_attr:
1504
setattr(obj, attr_name, new)
1507
def _cleanEnvironment(self):
1509
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1510
'HOME': os.getcwd(),
1511
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1512
# tests do check our impls match APPDATA
1513
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1517
'BZREMAIL': None, # may still be present in the environment
1519
'BZR_PROGRESS_BAR': None,
1521
'BZR_PLUGIN_PATH': None,
1522
'BZR_DISABLE_PLUGINS': None,
1523
'BZR_PLUGINS_AT': None,
1524
'BZR_CONCURRENCY': None,
1525
# Make sure that any text ui tests are consistent regardless of
1526
# the environment the test case is run in; you may want tests that
1527
# test other combinations. 'dumb' is a reasonable guess for tests
1528
# going to a pipe or a StringIO.
1532
'BZR_COLUMNS': '80',
1534
'SSH_AUTH_SOCK': None,
1538
'https_proxy': None,
1539
'HTTPS_PROXY': None,
1544
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1545
# least. If you do (care), please update this comment
1549
'BZR_REMOTE_PATH': None,
1550
# Generally speaking, we don't want apport reporting on crashes in
1551
# the test envirnoment unless we're specifically testing apport,
1552
# so that it doesn't leak into the real system environment. We
1553
# use an env var so it propagates to subprocesses.
1554
'APPORT_DISABLE': '1',
1557
self.addCleanup(self._restoreEnvironment)
1558
for name, value in new_env.iteritems():
1559
self._captureVar(name, value)
1561
def _captureVar(self, name, newvalue):
1562
"""Set an environment variable, and reset it when finished."""
1563
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1565
def _restoreEnvironment(self):
1566
for name, value in self._old_env.iteritems():
1567
osutils.set_or_unset_env(name, value)
1569
def _restoreHooks(self):
1570
for klass, (name, hooks) in self._preserved_hooks.items():
1571
setattr(klass, name, hooks)
1573
def knownFailure(self, reason):
1574
"""This test has failed for some known reason."""
1575
raise KnownFailure(reason)
1577
def _do_skip(self, result, reason):
1578
addSkip = getattr(result, 'addSkip', None)
1579
if not callable(addSkip):
1580
result.addSuccess(result)
1582
addSkip(self, reason)
1585
def _do_known_failure(self, result, e):
1586
err = sys.exc_info()
1587
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1588
if addExpectedFailure is not None:
1589
addExpectedFailure(self, err)
1591
result.addSuccess(self)
1594
def _do_not_applicable(self, result, e):
1596
reason = 'No reason given'
1599
addNotApplicable = getattr(result, 'addNotApplicable', None)
1600
if addNotApplicable is not None:
1601
result.addNotApplicable(self, reason)
1603
self._do_skip(result, reason)
1606
def _do_unsupported_or_skip(self, result, e):
1608
addNotSupported = getattr(result, 'addNotSupported', None)
1609
if addNotSupported is not None:
1610
result.addNotSupported(self, reason)
1612
self._do_skip(result, reason)
1614
def time(self, callable, *args, **kwargs):
1615
"""Run callable and accrue the time it takes to the benchmark time.
1617
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1618
this will cause lsprofile statistics to be gathered and stored in
1621
if self._benchtime is None:
1622
self.addDetail('benchtime', content.Content(content.ContentType(
1623
"text", "plain"), lambda:[str(self._benchtime)]))
1627
if not self._gather_lsprof_in_benchmarks:
1628
return callable(*args, **kwargs)
1630
# record this benchmark
1631
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1633
self._benchcalls.append(((callable, args, kwargs), stats))
1636
self._benchtime += time.time() - start
1638
def log(self, *args):
1641
def _get_log(self, keep_log_file=False):
1642
"""Internal helper to get the log from bzrlib.trace for this test.
1644
Please use self.getDetails, or self.get_log to access this in test case
1647
:param keep_log_file: When True, if the log is still a file on disk
1648
leave it as a file on disk. When False, if the log is still a file
1649
on disk, the log file is deleted and the log preserved as
1651
:return: A string containing the log.
1653
if self._log_contents is not None:
1655
self._log_contents.decode('utf8')
1656
except UnicodeDecodeError:
1657
unicodestr = self._log_contents.decode('utf8', 'replace')
1658
self._log_contents = unicodestr.encode('utf8')
1659
return self._log_contents
1661
if bzrlib.trace._trace_file:
1662
# flush the log file, to get all content
1663
bzrlib.trace._trace_file.flush()
1664
if self._log_file_name is not None:
1665
logfile = open(self._log_file_name)
1667
log_contents = logfile.read()
1671
log_contents.decode('utf8')
1672
except UnicodeDecodeError:
1673
unicodestr = log_contents.decode('utf8', 'replace')
1674
log_contents = unicodestr.encode('utf8')
1675
if not keep_log_file:
1677
max_close_attempts = 100
1678
first_close_error = None
1679
while close_attempts < max_close_attempts:
1682
self._log_file.close()
1683
except IOError, ioe:
1684
if ioe.errno is None:
1685
# No errno implies 'close() called during
1686
# concurrent operation on the same file object', so
1687
# retry. Probably a thread is trying to write to
1689
if first_close_error is None:
1690
first_close_error = ioe
1695
if close_attempts > 1:
1697
'Unable to close log file on first attempt, '
1698
'will retry: %s\n' % (first_close_error,))
1699
if close_attempts == max_close_attempts:
1701
'Unable to close log file after %d attempts.\n'
1702
% (max_close_attempts,))
1703
self._log_file = None
1704
# Permit multiple calls to get_log until we clean it up in
1706
self._log_contents = log_contents
1708
os.remove(self._log_file_name)
1710
if sys.platform == 'win32' and e.errno == errno.EACCES:
1711
sys.stderr.write(('Unable to delete log file '
1712
' %r\n' % self._log_file_name))
1715
self._log_file_name = None
1718
return "No log file content and no log file name."
1721
"""Get a unicode string containing the log from bzrlib.trace.
1723
Undecodable characters are replaced.
1725
return u"".join(self.getDetails()['log'].iter_text())
1727
def requireFeature(self, feature):
1728
"""This test requires a specific feature is available.
1730
:raises UnavailableFeature: When feature is not available.
1732
if not feature.available():
1733
raise UnavailableFeature(feature)
1735
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1737
"""Run bazaar command line, splitting up a string command line."""
1738
if isinstance(args, basestring):
1739
# shlex don't understand unicode strings,
1740
# so args should be plain string (bialix 20070906)
1741
args = list(shlex.split(str(args)))
1742
return self._run_bzr_core(args, retcode=retcode,
1743
encoding=encoding, stdin=stdin, working_dir=working_dir,
1746
def _run_bzr_core(self, args, retcode, encoding, stdin,
1748
# Clear chk_map page cache, because the contents are likely to mask
1750
chk_map.clear_cache()
1751
if encoding is None:
1752
encoding = osutils.get_user_encoding()
1753
stdout = StringIOWrapper()
1754
stderr = StringIOWrapper()
1755
stdout.encoding = encoding
1756
stderr.encoding = encoding
1758
self.log('run bzr: %r', args)
1759
# FIXME: don't call into logging here
1760
handler = logging.StreamHandler(stderr)
1761
handler.setLevel(logging.INFO)
1762
logger = logging.getLogger('')
1763
logger.addHandler(handler)
1764
old_ui_factory = ui.ui_factory
1765
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1768
if working_dir is not None:
1769
cwd = osutils.getcwd()
1770
os.chdir(working_dir)
1774
result = self.apply_redirected(ui.ui_factory.stdin,
1776
bzrlib.commands.run_bzr_catch_user_errors,
1778
except KeyboardInterrupt:
1779
# Reraise KeyboardInterrupt with contents of redirected stdout
1780
# and stderr as arguments, for tests which are interested in
1781
# stdout and stderr and are expecting the exception.
1782
out = stdout.getvalue()
1783
err = stderr.getvalue()
1785
self.log('output:\n%r', out)
1787
self.log('errors:\n%r', err)
1788
raise KeyboardInterrupt(out, err)
1790
logger.removeHandler(handler)
1791
ui.ui_factory = old_ui_factory
1795
out = stdout.getvalue()
1796
err = stderr.getvalue()
1798
self.log('output:\n%r', out)
1800
self.log('errors:\n%r', err)
1801
if retcode is not None:
1802
self.assertEquals(retcode, result,
1803
message='Unexpected return code')
1804
return result, out, err
1806
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1807
working_dir=None, error_regexes=[], output_encoding=None):
1808
"""Invoke bzr, as if it were run from the command line.
1810
The argument list should not include the bzr program name - the
1811
first argument is normally the bzr command. Arguments may be
1812
passed in three ways:
1814
1- A list of strings, eg ["commit", "a"]. This is recommended
1815
when the command contains whitespace or metacharacters, or
1816
is built up at run time.
1818
2- A single string, eg "add a". This is the most convenient
1819
for hardcoded commands.
1821
This runs bzr through the interface that catches and reports
1822
errors, and with logging set to something approximating the
1823
default, so that error reporting can be checked.
1825
This should be the main method for tests that want to exercise the
1826
overall behavior of the bzr application (rather than a unit test
1827
or a functional test of the library.)
1829
This sends the stdout/stderr results into the test's log,
1830
where it may be useful for debugging. See also run_captured.
1832
:keyword stdin: A string to be used as stdin for the command.
1833
:keyword retcode: The status code the command should return;
1835
:keyword working_dir: The directory to run the command in
1836
:keyword error_regexes: A list of expected error messages. If
1837
specified they must be seen in the error output of the command.
1839
retcode, out, err = self._run_bzr_autosplit(
1844
working_dir=working_dir,
1846
self.assertIsInstance(error_regexes, (list, tuple))
1847
for regex in error_regexes:
1848
self.assertContainsRe(err, regex)
1851
def run_bzr_error(self, error_regexes, *args, **kwargs):
1852
"""Run bzr, and check that stderr contains the supplied regexes
1854
:param error_regexes: Sequence of regular expressions which
1855
must each be found in the error output. The relative ordering
1857
:param args: command-line arguments for bzr
1858
:param kwargs: Keyword arguments which are interpreted by run_bzr
1859
This function changes the default value of retcode to be 3,
1860
since in most cases this is run when you expect bzr to fail.
1862
:return: (out, err) The actual output of running the command (in case
1863
you want to do more inspection)
1867
# Make sure that commit is failing because there is nothing to do
1868
self.run_bzr_error(['no changes to commit'],
1869
['commit', '-m', 'my commit comment'])
1870
# Make sure --strict is handling an unknown file, rather than
1871
# giving us the 'nothing to do' error
1872
self.build_tree(['unknown'])
1873
self.run_bzr_error(['Commit refused because there are unknown files'],
1874
['commit', --strict', '-m', 'my commit comment'])
1876
kwargs.setdefault('retcode', 3)
1877
kwargs['error_regexes'] = error_regexes
1878
out, err = self.run_bzr(*args, **kwargs)
1881
def run_bzr_subprocess(self, *args, **kwargs):
1882
"""Run bzr in a subprocess for testing.
1884
This starts a new Python interpreter and runs bzr in there.
1885
This should only be used for tests that have a justifiable need for
1886
this isolation: e.g. they are testing startup time, or signal
1887
handling, or early startup code, etc. Subprocess code can't be
1888
profiled or debugged so easily.
1890
:keyword retcode: The status code that is expected. Defaults to 0. If
1891
None is supplied, the status code is not checked.
1892
:keyword env_changes: A dictionary which lists changes to environment
1893
variables. A value of None will unset the env variable.
1894
The values must be strings. The change will only occur in the
1895
child, so you don't need to fix the environment after running.
1896
:keyword universal_newlines: Convert CRLF => LF
1897
:keyword allow_plugins: By default the subprocess is run with
1898
--no-plugins to ensure test reproducibility. Also, it is possible
1899
for system-wide plugins to create unexpected output on stderr,
1900
which can cause unnecessary test failures.
1902
env_changes = kwargs.get('env_changes', {})
1903
working_dir = kwargs.get('working_dir', None)
1904
allow_plugins = kwargs.get('allow_plugins', False)
1906
if isinstance(args[0], list):
1908
elif isinstance(args[0], basestring):
1909
args = list(shlex.split(args[0]))
1911
raise ValueError("passing varargs to run_bzr_subprocess")
1912
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1913
working_dir=working_dir,
1914
allow_plugins=allow_plugins)
1915
# We distinguish between retcode=None and retcode not passed.
1916
supplied_retcode = kwargs.get('retcode', 0)
1917
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1918
universal_newlines=kwargs.get('universal_newlines', False),
1921
def start_bzr_subprocess(self, process_args, env_changes=None,
1922
skip_if_plan_to_signal=False,
1924
allow_plugins=False):
1925
"""Start bzr in a subprocess for testing.
1927
This starts a new Python interpreter and runs bzr in there.
1928
This should only be used for tests that have a justifiable need for
1929
this isolation: e.g. they are testing startup time, or signal
1930
handling, or early startup code, etc. Subprocess code can't be
1931
profiled or debugged so easily.
1933
:param process_args: a list of arguments to pass to the bzr executable,
1934
for example ``['--version']``.
1935
:param env_changes: A dictionary which lists changes to environment
1936
variables. A value of None will unset the env variable.
1937
The values must be strings. The change will only occur in the
1938
child, so you don't need to fix the environment after running.
1939
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1941
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1943
:returns: Popen object for the started process.
1945
if skip_if_plan_to_signal:
1946
if not getattr(os, 'kill', None):
1947
raise TestSkipped("os.kill not available.")
1949
if env_changes is None:
1953
def cleanup_environment():
1954
for env_var, value in env_changes.iteritems():
1955
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1957
def restore_environment():
1958
for env_var, value in old_env.iteritems():
1959
osutils.set_or_unset_env(env_var, value)
1961
bzr_path = self.get_bzr_path()
1964
if working_dir is not None:
1965
cwd = osutils.getcwd()
1966
os.chdir(working_dir)
1969
# win32 subprocess doesn't support preexec_fn
1970
# so we will avoid using it on all platforms, just to
1971
# make sure the code path is used, and we don't break on win32
1972
cleanup_environment()
1973
command = [sys.executable]
1974
# frozen executables don't need the path to bzr
1975
if getattr(sys, "frozen", None) is None:
1976
command.append(bzr_path)
1977
if not allow_plugins:
1978
command.append('--no-plugins')
1979
command.extend(process_args)
1980
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1982
restore_environment()
1988
def _popen(self, *args, **kwargs):
1989
"""Place a call to Popen.
1991
Allows tests to override this method to intercept the calls made to
1992
Popen for introspection.
1994
return Popen(*args, **kwargs)
1996
def get_source_path(self):
1997
"""Return the path of the directory containing bzrlib."""
1998
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2000
def get_bzr_path(self):
2001
"""Return the path of the 'bzr' executable for this test suite."""
2002
bzr_path = self.get_source_path()+'/bzr'
2003
if not os.path.isfile(bzr_path):
2004
# We are probably installed. Assume sys.argv is the right file
2005
bzr_path = sys.argv[0]
2008
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2009
universal_newlines=False, process_args=None):
2010
"""Finish the execution of process.
2012
:param process: the Popen object returned from start_bzr_subprocess.
2013
:param retcode: The status code that is expected. Defaults to 0. If
2014
None is supplied, the status code is not checked.
2015
:param send_signal: an optional signal to send to the process.
2016
:param universal_newlines: Convert CRLF => LF
2017
:returns: (stdout, stderr)
2019
if send_signal is not None:
2020
os.kill(process.pid, send_signal)
2021
out, err = process.communicate()
2023
if universal_newlines:
2024
out = out.replace('\r\n', '\n')
2025
err = err.replace('\r\n', '\n')
2027
if retcode is not None and retcode != process.returncode:
2028
if process_args is None:
2029
process_args = "(unknown args)"
2030
mutter('Output of bzr %s:\n%s', process_args, out)
2031
mutter('Error for bzr %s:\n%s', process_args, err)
2032
self.fail('Command bzr %s failed with retcode %s != %s'
2033
% (process_args, retcode, process.returncode))
2036
def check_inventory_shape(self, inv, shape):
2037
"""Compare an inventory to a list of expected names.
2039
Fail if they are not precisely equal.
2042
shape = list(shape) # copy
2043
for path, ie in inv.entries():
2044
name = path.replace('\\', '/')
2045
if ie.kind == 'directory':
2052
self.fail("expected paths not found in inventory: %r" % shape)
2054
self.fail("unexpected paths found in inventory: %r" % extras)
2056
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2057
a_callable=None, *args, **kwargs):
2058
"""Call callable with redirected std io pipes.
2060
Returns the return code."""
2061
if not callable(a_callable):
2062
raise ValueError("a_callable must be callable.")
2064
stdin = StringIO("")
2066
if getattr(self, "_log_file", None) is not None:
2067
stdout = self._log_file
2071
if getattr(self, "_log_file", None is not None):
2072
stderr = self._log_file
2075
real_stdin = sys.stdin
2076
real_stdout = sys.stdout
2077
real_stderr = sys.stderr
2082
return a_callable(*args, **kwargs)
2084
sys.stdout = real_stdout
2085
sys.stderr = real_stderr
2086
sys.stdin = real_stdin
2088
def reduceLockdirTimeout(self):
2089
"""Reduce the default lock timeout for the duration of the test, so that
2090
if LockContention occurs during a test, it does so quickly.
2092
Tests that expect to provoke LockContention errors should call this.
2094
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2096
def make_utf8_encoded_stringio(self, encoding_type=None):
2097
"""Return a StringIOWrapper instance, that will encode Unicode
2100
if encoding_type is None:
2101
encoding_type = 'strict'
2103
output_encoding = 'utf-8'
2104
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2105
sio.encoding = output_encoding
2108
def disable_verb(self, verb):
2109
"""Disable a smart server verb for one test."""
2110
from bzrlib.smart import request
2111
request_handlers = request.request_handlers
2112
orig_method = request_handlers.get(verb)
2113
request_handlers.remove(verb)
2114
self.addCleanup(request_handlers.register, verb, orig_method)
2117
class CapturedCall(object):
2118
"""A helper for capturing smart server calls for easy debug analysis."""
2120
def __init__(self, params, prefix_length):
2121
"""Capture the call with params and skip prefix_length stack frames."""
2124
# The last 5 frames are the __init__, the hook frame, and 3 smart
2125
# client frames. Beyond this we could get more clever, but this is good
2127
stack = traceback.extract_stack()[prefix_length:-5]
2128
self.stack = ''.join(traceback.format_list(stack))
2131
return self.call.method
2134
return self.call.method
2140
class TestCaseWithMemoryTransport(TestCase):
2141
"""Common test class for tests that do not need disk resources.
2143
Tests that need disk resources should derive from TestCaseWithTransport.
2145
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2147
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2148
a directory which does not exist. This serves to help ensure test isolation
2149
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2150
must exist. However, TestCaseWithMemoryTransport does not offer local
2151
file defaults for the transport in tests, nor does it obey the command line
2152
override, so tests that accidentally write to the common directory should
2155
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2156
a .bzr directory that stops us ascending higher into the filesystem.
2162
def __init__(self, methodName='runTest'):
2163
# allow test parameterization after test construction and before test
2164
# execution. Variables that the parameterizer sets need to be
2165
# ones that are not set by setUp, or setUp will trash them.
2166
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2167
self.vfs_transport_factory = default_transport
2168
self.transport_server = None
2169
self.transport_readonly_server = None
2170
self.__vfs_server = None
2172
def get_transport(self, relpath=None):
2173
"""Return a writeable transport.
2175
This transport is for the test scratch space relative to
2178
:param relpath: a path relative to the base url.
2180
t = get_transport(self.get_url(relpath))
2181
self.assertFalse(t.is_readonly())
2184
def get_readonly_transport(self, relpath=None):
2185
"""Return a readonly transport for the test scratch space
2187
This can be used to test that operations which should only need
2188
readonly access in fact do not try to write.
2190
:param relpath: a path relative to the base url.
2192
t = get_transport(self.get_readonly_url(relpath))
2193
self.assertTrue(t.is_readonly())
2196
def create_transport_readonly_server(self):
2197
"""Create a transport server from class defined at init.
2199
This is mostly a hook for daughter classes.
2201
return self.transport_readonly_server()
2203
def get_readonly_server(self):
2204
"""Get the server instance for the readonly transport
2206
This is useful for some tests with specific servers to do diagnostics.
2208
if self.__readonly_server is None:
2209
if self.transport_readonly_server is None:
2210
# readonly decorator requested
2211
self.__readonly_server = test_server.ReadonlyServer()
2213
# explicit readonly transport.
2214
self.__readonly_server = self.create_transport_readonly_server()
2215
self.start_server(self.__readonly_server,
2216
self.get_vfs_only_server())
2217
return self.__readonly_server
2219
def get_readonly_url(self, relpath=None):
2220
"""Get a URL for the readonly transport.
2222
This will either be backed by '.' or a decorator to the transport
2223
used by self.get_url()
2224
relpath provides for clients to get a path relative to the base url.
2225
These should only be downwards relative, not upwards.
2227
base = self.get_readonly_server().get_url()
2228
return self._adjust_url(base, relpath)
2230
def get_vfs_only_server(self):
2231
"""Get the vfs only read/write server instance.
2233
This is useful for some tests with specific servers that need
2236
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2237
is no means to override it.
2239
if self.__vfs_server is None:
2240
self.__vfs_server = memory.MemoryServer()
2241
self.start_server(self.__vfs_server)
2242
return self.__vfs_server
2244
def get_server(self):
2245
"""Get the read/write server instance.
2247
This is useful for some tests with specific servers that need
2250
This is built from the self.transport_server factory. If that is None,
2251
then the self.get_vfs_server is returned.
2253
if self.__server is None:
2254
if (self.transport_server is None or self.transport_server is
2255
self.vfs_transport_factory):
2256
self.__server = self.get_vfs_only_server()
2258
# bring up a decorated means of access to the vfs only server.
2259
self.__server = self.transport_server()
2260
self.start_server(self.__server, self.get_vfs_only_server())
2261
return self.__server
2263
def _adjust_url(self, base, relpath):
2264
"""Get a URL (or maybe a path) for the readwrite transport.
2266
This will either be backed by '.' or to an equivalent non-file based
2268
relpath provides for clients to get a path relative to the base url.
2269
These should only be downwards relative, not upwards.
2271
if relpath is not None and relpath != '.':
2272
if not base.endswith('/'):
2274
# XXX: Really base should be a url; we did after all call
2275
# get_url()! But sometimes it's just a path (from
2276
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2277
# to a non-escaped local path.
2278
if base.startswith('./') or base.startswith('/'):
2281
base += urlutils.escape(relpath)
2284
def get_url(self, relpath=None):
2285
"""Get a URL (or maybe a path) for the readwrite transport.
2287
This will either be backed by '.' or to an equivalent non-file based
2289
relpath provides for clients to get a path relative to the base url.
2290
These should only be downwards relative, not upwards.
2292
base = self.get_server().get_url()
2293
return self._adjust_url(base, relpath)
2295
def get_vfs_only_url(self, relpath=None):
2296
"""Get a URL (or maybe a path for the plain old vfs transport.
2298
This will never be a smart protocol. It always has all the
2299
capabilities of the local filesystem, but it might actually be a
2300
MemoryTransport or some other similar virtual filesystem.
2302
This is the backing transport (if any) of the server returned by
2303
get_url and get_readonly_url.
2305
:param relpath: provides for clients to get a path relative to the base
2306
url. These should only be downwards relative, not upwards.
2309
base = self.get_vfs_only_server().get_url()
2310
return self._adjust_url(base, relpath)
2312
def _create_safety_net(self):
2313
"""Make a fake bzr directory.
2315
This prevents any tests propagating up onto the TEST_ROOT directory's
2318
root = TestCaseWithMemoryTransport.TEST_ROOT
2319
bzrdir.BzrDir.create_standalone_workingtree(root)
2321
def _check_safety_net(self):
2322
"""Check that the safety .bzr directory have not been touched.
2324
_make_test_root have created a .bzr directory to prevent tests from
2325
propagating. This method ensures than a test did not leaked.
2327
root = TestCaseWithMemoryTransport.TEST_ROOT
2328
self.permit_url(get_transport(root).base)
2329
wt = workingtree.WorkingTree.open(root)
2330
last_rev = wt.last_revision()
2331
if last_rev != 'null:':
2332
# The current test have modified the /bzr directory, we need to
2333
# recreate a new one or all the followng tests will fail.
2334
# If you need to inspect its content uncomment the following line
2335
# import pdb; pdb.set_trace()
2336
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2337
self._create_safety_net()
2338
raise AssertionError('%s/.bzr should not be modified' % root)
2340
def _make_test_root(self):
2341
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2342
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2343
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2345
TestCaseWithMemoryTransport.TEST_ROOT = root
2347
self._create_safety_net()
2349
# The same directory is used by all tests, and we're not
2350
# specifically told when all tests are finished. This will do.
2351
atexit.register(_rmtree_temp_dir, root)
2353
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2354
self.addCleanup(self._check_safety_net)
2356
def makeAndChdirToTestDir(self):
2357
"""Create a temporary directories for this one test.
2359
This must set self.test_home_dir and self.test_dir and chdir to
2362
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2364
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2365
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2366
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2367
self.permit_dir(self.test_dir)
2369
def make_branch(self, relpath, format=None):
2370
"""Create a branch on the transport at relpath."""
2371
repo = self.make_repository(relpath, format=format)
2372
return repo.bzrdir.create_branch()
2374
def make_bzrdir(self, relpath, format=None):
2376
# might be a relative or absolute path
2377
maybe_a_url = self.get_url(relpath)
2378
segments = maybe_a_url.rsplit('/', 1)
2379
t = get_transport(maybe_a_url)
2380
if len(segments) > 1 and segments[-1] not in ('', '.'):
2384
if isinstance(format, basestring):
2385
format = bzrdir.format_registry.make_bzrdir(format)
2386
return format.initialize_on_transport(t)
2387
except errors.UninitializableFormat:
2388
raise TestSkipped("Format %s is not initializable." % format)
2390
def make_repository(self, relpath, shared=False, format=None):
2391
"""Create a repository on our default transport at relpath.
2393
Note that relpath must be a relative path, not a full url.
2395
# FIXME: If you create a remoterepository this returns the underlying
2396
# real format, which is incorrect. Actually we should make sure that
2397
# RemoteBzrDir returns a RemoteRepository.
2398
# maybe mbp 20070410
2399
made_control = self.make_bzrdir(relpath, format=format)
2400
return made_control.create_repository(shared=shared)
2402
def make_smart_server(self, path):
2403
smart_server = test_server.SmartTCPServer_for_testing()
2404
self.start_server(smart_server, self.get_server())
2405
remote_transport = get_transport(smart_server.get_url()).clone(path)
2406
return remote_transport
2408
def make_branch_and_memory_tree(self, relpath, format=None):
2409
"""Create a branch on the default transport and a MemoryTree for it."""
2410
b = self.make_branch(relpath, format=format)
2411
return memorytree.MemoryTree.create_on_branch(b)
2413
def make_branch_builder(self, relpath, format=None):
2414
branch = self.make_branch(relpath, format=format)
2415
return branchbuilder.BranchBuilder(branch=branch)
2417
def overrideEnvironmentForTesting(self):
2418
test_home_dir = self.test_home_dir
2419
if isinstance(test_home_dir, unicode):
2420
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2421
os.environ['HOME'] = test_home_dir
2422
os.environ['BZR_HOME'] = test_home_dir
2425
super(TestCaseWithMemoryTransport, self).setUp()
2426
self._make_test_root()
2427
self.addCleanup(os.chdir, os.getcwdu())
2428
self.makeAndChdirToTestDir()
2429
self.overrideEnvironmentForTesting()
2430
self.__readonly_server = None
2431
self.__server = None
2432
self.reduceLockdirTimeout()
2434
def setup_smart_server_with_call_log(self):
2435
"""Sets up a smart server as the transport server with a call log."""
2436
self.transport_server = test_server.SmartTCPServer_for_testing
2437
self.hpss_calls = []
2439
# Skip the current stack down to the caller of
2440
# setup_smart_server_with_call_log
2441
prefix_length = len(traceback.extract_stack()) - 2
2442
def capture_hpss_call(params):
2443
self.hpss_calls.append(
2444
CapturedCall(params, prefix_length))
2445
client._SmartClient.hooks.install_named_hook(
2446
'call', capture_hpss_call, None)
2448
def reset_smart_call_log(self):
2449
self.hpss_calls = []
2452
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2453
"""Derived class that runs a test within a temporary directory.
2455
This is useful for tests that need to create a branch, etc.
2457
The directory is created in a slightly complex way: for each
2458
Python invocation, a new temporary top-level directory is created.
2459
All test cases create their own directory within that. If the
2460
tests complete successfully, the directory is removed.
2462
:ivar test_base_dir: The path of the top-level directory for this
2463
test, which contains a home directory and a work directory.
2465
:ivar test_home_dir: An initially empty directory under test_base_dir
2466
which is used as $HOME for this test.
2468
:ivar test_dir: A directory under test_base_dir used as the current
2469
directory when the test proper is run.
2472
OVERRIDE_PYTHON = 'python'
2474
def check_file_contents(self, filename, expect):
2475
self.log("check contents of file %s" % filename)
2476
contents = file(filename, 'r').read()
2477
if contents != expect:
2478
self.log("expected: %r" % expect)
2479
self.log("actually: %r" % contents)
2480
self.fail("contents of %s not as expected" % filename)
2482
def _getTestDirPrefix(self):
2483
# create a directory within the top level test directory
2484
if sys.platform in ('win32', 'cygwin'):
2485
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2486
# windows is likely to have path-length limits so use a short name
2487
name_prefix = name_prefix[-30:]
2489
name_prefix = re.sub('[/]', '_', self.id())
2492
def makeAndChdirToTestDir(self):
2493
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2495
For TestCaseInTempDir we create a temporary directory based on the test
2496
name and then create two subdirs - test and home under it.
2498
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2499
self._getTestDirPrefix())
2501
for i in range(100):
2502
if os.path.exists(name):
2503
name = name_prefix + '_' + str(i)
2505
# now create test and home directories within this dir
2506
self.test_base_dir = name
2507
self.addCleanup(self.deleteTestDir)
2508
os.mkdir(self.test_base_dir)
2510
self.permit_dir(self.test_base_dir)
2511
# 'sprouting' and 'init' of a branch both walk up the tree to find
2512
# stacking policy to honour; create a bzr dir with an unshared
2513
# repository (but not a branch - our code would be trying to escape
2514
# then!) to stop them, and permit it to be read.
2515
# control = bzrdir.BzrDir.create(self.test_base_dir)
2516
# control.create_repository()
2517
self.test_home_dir = self.test_base_dir + '/home'
2518
os.mkdir(self.test_home_dir)
2519
self.test_dir = self.test_base_dir + '/work'
2520
os.mkdir(self.test_dir)
2521
os.chdir(self.test_dir)
2522
# put name of test inside
2523
f = file(self.test_base_dir + '/name', 'w')
2529
def deleteTestDir(self):
2530
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2531
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2533
def build_tree(self, shape, line_endings='binary', transport=None):
2534
"""Build a test tree according to a pattern.
2536
shape is a sequence of file specifications. If the final
2537
character is '/', a directory is created.
2539
This assumes that all the elements in the tree being built are new.
2541
This doesn't add anything to a branch.
2543
:type shape: list or tuple.
2544
:param line_endings: Either 'binary' or 'native'
2545
in binary mode, exact contents are written in native mode, the
2546
line endings match the default platform endings.
2547
:param transport: A transport to write to, for building trees on VFS's.
2548
If the transport is readonly or None, "." is opened automatically.
2551
if type(shape) not in (list, tuple):
2552
raise AssertionError("Parameter 'shape' should be "
2553
"a list or a tuple. Got %r instead" % (shape,))
2554
# It's OK to just create them using forward slashes on windows.
2555
if transport is None or transport.is_readonly():
2556
transport = get_transport(".")
2558
self.assertIsInstance(name, basestring)
2560
transport.mkdir(urlutils.escape(name[:-1]))
2562
if line_endings == 'binary':
2564
elif line_endings == 'native':
2567
raise errors.BzrError(
2568
'Invalid line ending request %r' % line_endings)
2569
content = "contents of %s%s" % (name.encode('utf-8'), end)
2570
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2572
def build_tree_contents(self, shape):
2573
build_tree_contents(shape)
2575
def assertInWorkingTree(self, path, root_path='.', tree=None):
2576
"""Assert whether path or paths are in the WorkingTree"""
2578
tree = workingtree.WorkingTree.open(root_path)
2579
if not isinstance(path, basestring):
2581
self.assertInWorkingTree(p, tree=tree)
2583
self.assertIsNot(tree.path2id(path), None,
2584
path+' not in working tree.')
2586
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2587
"""Assert whether path or paths are not in the WorkingTree"""
2589
tree = workingtree.WorkingTree.open(root_path)
2590
if not isinstance(path, basestring):
2592
self.assertNotInWorkingTree(p,tree=tree)
2594
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2597
class TestCaseWithTransport(TestCaseInTempDir):
2598
"""A test case that provides get_url and get_readonly_url facilities.
2600
These back onto two transport servers, one for readonly access and one for
2603
If no explicit class is provided for readonly access, a
2604
ReadonlyTransportDecorator is used instead which allows the use of non disk
2605
based read write transports.
2607
If an explicit class is provided for readonly access, that server and the
2608
readwrite one must both define get_url() as resolving to os.getcwd().
2611
def get_vfs_only_server(self):
2612
"""See TestCaseWithMemoryTransport.
2614
This is useful for some tests with specific servers that need
2617
if self.__vfs_server is None:
2618
self.__vfs_server = self.vfs_transport_factory()
2619
self.start_server(self.__vfs_server)
2620
return self.__vfs_server
2622
def make_branch_and_tree(self, relpath, format=None):
2623
"""Create a branch on the transport and a tree locally.
2625
If the transport is not a LocalTransport, the Tree can't be created on
2626
the transport. In that case if the vfs_transport_factory is
2627
LocalURLServer the working tree is created in the local
2628
directory backing the transport, and the returned tree's branch and
2629
repository will also be accessed locally. Otherwise a lightweight
2630
checkout is created and returned.
2632
We do this because we can't physically create a tree in the local
2633
path, with a branch reference to the transport_factory url, and
2634
a branch + repository in the vfs_transport, unless the vfs_transport
2635
namespace is distinct from the local disk - the two branch objects
2636
would collide. While we could construct a tree with its branch object
2637
pointing at the transport_factory transport in memory, reopening it
2638
would behaving unexpectedly, and has in the past caused testing bugs
2639
when we tried to do it that way.
2641
:param format: The BzrDirFormat.
2642
:returns: the WorkingTree.
2644
# TODO: always use the local disk path for the working tree,
2645
# this obviously requires a format that supports branch references
2646
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2648
b = self.make_branch(relpath, format=format)
2650
return b.bzrdir.create_workingtree()
2651
except errors.NotLocalUrl:
2652
# We can only make working trees locally at the moment. If the
2653
# transport can't support them, then we keep the non-disk-backed
2654
# branch and create a local checkout.
2655
if self.vfs_transport_factory is test_server.LocalURLServer:
2656
# the branch is colocated on disk, we cannot create a checkout.
2657
# hopefully callers will expect this.
2658
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2659
wt = local_controldir.create_workingtree()
2660
if wt.branch._format != b._format:
2662
# Make sure that assigning to wt._branch fixes wt.branch,
2663
# in case the implementation details of workingtree objects
2665
self.assertIs(b, wt.branch)
2668
return b.create_checkout(relpath, lightweight=True)
2670
def assertIsDirectory(self, relpath, transport):
2671
"""Assert that relpath within transport is a directory.
2673
This may not be possible on all transports; in that case it propagates
2674
a TransportNotPossible.
2677
mode = transport.stat(relpath).st_mode
2678
except errors.NoSuchFile:
2679
self.fail("path %s is not a directory; no such file"
2681
if not stat.S_ISDIR(mode):
2682
self.fail("path %s is not a directory; has mode %#o"
2685
def assertTreesEqual(self, left, right):
2686
"""Check that left and right have the same content and properties."""
2687
# we use a tree delta to check for equality of the content, and we
2688
# manually check for equality of other things such as the parents list.
2689
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2690
differences = left.changes_from(right)
2691
self.assertFalse(differences.has_changed(),
2692
"Trees %r and %r are different: %r" % (left, right, differences))
2695
super(TestCaseWithTransport, self).setUp()
2696
self.__vfs_server = None
2698
def disable_missing_extensions_warning(self):
2699
"""Some tests expect a precise stderr content.
2701
There is no point in forcing them to duplicate the extension related
2704
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2707
class ChrootedTestCase(TestCaseWithTransport):
2708
"""A support class that provides readonly urls outside the local namespace.
2710
This is done by checking if self.transport_server is a MemoryServer. if it
2711
is then we are chrooted already, if it is not then an HttpServer is used
2714
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2715
be used without needed to redo it when a different
2716
subclass is in use ?
2720
super(ChrootedTestCase, self).setUp()
2721
if not self.vfs_transport_factory == memory.MemoryServer:
2722
self.transport_readonly_server = HttpServer
2725
def condition_id_re(pattern):
2726
"""Create a condition filter which performs a re check on a test's id.
2728
:param pattern: A regular expression string.
2729
:return: A callable that returns True if the re matches.
2731
filter_re = osutils.re_compile_checked(pattern, 0,
2733
def condition(test):
2735
return filter_re.search(test_id)
2739
def condition_isinstance(klass_or_klass_list):
2740
"""Create a condition filter which returns isinstance(param, klass).
2742
:return: A callable which when called with one parameter obj return the
2743
result of isinstance(obj, klass_or_klass_list).
2746
return isinstance(obj, klass_or_klass_list)
2750
def condition_id_in_list(id_list):
2751
"""Create a condition filter which verify that test's id in a list.
2753
:param id_list: A TestIdList object.
2754
:return: A callable that returns True if the test's id appears in the list.
2756
def condition(test):
2757
return id_list.includes(test.id())
2761
def condition_id_startswith(starts):
2762
"""Create a condition filter verifying that test's id starts with a string.
2764
:param starts: A list of string.
2765
:return: A callable that returns True if the test's id starts with one of
2768
def condition(test):
2769
for start in starts:
2770
if test.id().startswith(start):
2776
def exclude_tests_by_condition(suite, condition):
2777
"""Create a test suite which excludes some tests from suite.
2779
:param suite: The suite to get tests from.
2780
:param condition: A callable whose result evaluates True when called with a
2781
test case which should be excluded from the result.
2782
:return: A suite which contains the tests found in suite that fail
2786
for test in iter_suite_tests(suite):
2787
if not condition(test):
2789
return TestUtil.TestSuite(result)
2792
def filter_suite_by_condition(suite, condition):
2793
"""Create a test suite by filtering another one.
2795
:param suite: The source suite.
2796
:param condition: A callable whose result evaluates True when called with a
2797
test case which should be included in the result.
2798
:return: A suite which contains the tests found in suite that pass
2802
for test in iter_suite_tests(suite):
2805
return TestUtil.TestSuite(result)
2808
def filter_suite_by_re(suite, pattern):
2809
"""Create a test suite by filtering another one.
2811
:param suite: the source suite
2812
:param pattern: pattern that names must match
2813
:returns: the newly created suite
2815
condition = condition_id_re(pattern)
2816
result_suite = filter_suite_by_condition(suite, condition)
2820
def filter_suite_by_id_list(suite, test_id_list):
2821
"""Create a test suite by filtering another one.
2823
:param suite: The source suite.
2824
:param test_id_list: A list of the test ids to keep as strings.
2825
:returns: the newly created suite
2827
condition = condition_id_in_list(test_id_list)
2828
result_suite = filter_suite_by_condition(suite, condition)
2832
def filter_suite_by_id_startswith(suite, start):
2833
"""Create a test suite by filtering another one.
2835
:param suite: The source suite.
2836
:param start: A list of string the test id must start with one of.
2837
:returns: the newly created suite
2839
condition = condition_id_startswith(start)
2840
result_suite = filter_suite_by_condition(suite, condition)
2844
def exclude_tests_by_re(suite, pattern):
2845
"""Create a test suite which excludes some tests from suite.
2847
:param suite: The suite to get tests from.
2848
:param pattern: A regular expression string. Test ids that match this
2849
pattern will be excluded from the result.
2850
:return: A TestSuite that contains all the tests from suite without the
2851
tests that matched pattern. The order of tests is the same as it was in
2854
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2857
def preserve_input(something):
2858
"""A helper for performing test suite transformation chains.
2860
:param something: Anything you want to preserve.
2866
def randomize_suite(suite):
2867
"""Return a new TestSuite with suite's tests in random order.
2869
The tests in the input suite are flattened into a single suite in order to
2870
accomplish this. Any nested TestSuites are removed to provide global
2873
tests = list(iter_suite_tests(suite))
2874
random.shuffle(tests)
2875
return TestUtil.TestSuite(tests)
2878
def split_suite_by_condition(suite, condition):
2879
"""Split a test suite into two by a condition.
2881
:param suite: The suite to split.
2882
:param condition: The condition to match on. Tests that match this
2883
condition are returned in the first test suite, ones that do not match
2884
are in the second suite.
2885
:return: A tuple of two test suites, where the first contains tests from
2886
suite matching the condition, and the second contains the remainder
2887
from suite. The order within each output suite is the same as it was in
2892
for test in iter_suite_tests(suite):
2894
matched.append(test)
2896
did_not_match.append(test)
2897
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2900
def split_suite_by_re(suite, pattern):
2901
"""Split a test suite into two by a regular expression.
2903
:param suite: The suite to split.
2904
:param pattern: A regular expression string. Test ids that match this
2905
pattern will be in the first test suite returned, and the others in the
2906
second test suite returned.
2907
:return: A tuple of two test suites, where the first contains tests from
2908
suite matching pattern, and the second contains the remainder from
2909
suite. The order within each output suite is the same as it was in
2912
return split_suite_by_condition(suite, condition_id_re(pattern))
2915
def run_suite(suite, name='test', verbose=False, pattern=".*",
2916
stop_on_failure=False,
2917
transport=None, lsprof_timed=None, bench_history=None,
2918
matching_tests_first=None,
2921
exclude_pattern=None,
2924
suite_decorators=None,
2926
result_decorators=None,
2928
"""Run a test suite for bzr selftest.
2930
:param runner_class: The class of runner to use. Must support the
2931
constructor arguments passed by run_suite which are more than standard
2933
:return: A boolean indicating success.
2935
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2940
if runner_class is None:
2941
runner_class = TextTestRunner
2944
runner = runner_class(stream=stream,
2946
verbosity=verbosity,
2947
bench_history=bench_history,
2949
result_decorators=result_decorators,
2951
runner.stop_on_failure=stop_on_failure
2952
# built in decorator factories:
2954
random_order(random_seed, runner),
2955
exclude_tests(exclude_pattern),
2957
if matching_tests_first:
2958
decorators.append(tests_first(pattern))
2960
decorators.append(filter_tests(pattern))
2961
if suite_decorators:
2962
decorators.extend(suite_decorators)
2963
# tell the result object how many tests will be running: (except if
2964
# --parallel=fork is being used. Robert said he will provide a better
2965
# progress design later -- vila 20090817)
2966
if fork_decorator not in decorators:
2967
decorators.append(CountingDecorator)
2968
for decorator in decorators:
2969
suite = decorator(suite)
2971
# Done after test suite decoration to allow randomisation etc
2972
# to take effect, though that is of marginal benefit.
2974
stream.write("Listing tests only ...\n")
2975
for t in iter_suite_tests(suite):
2976
stream.write("%s\n" % (t.id()))
2978
result = runner.run(suite)
2980
return result.wasStrictlySuccessful()
2982
return result.wasSuccessful()
2985
# A registry where get() returns a suite decorator.
2986
parallel_registry = registry.Registry()
2989
def fork_decorator(suite):
2990
concurrency = osutils.local_concurrency()
2991
if concurrency == 1:
2993
from testtools import ConcurrentTestSuite
2994
return ConcurrentTestSuite(suite, fork_for_tests)
2995
parallel_registry.register('fork', fork_decorator)
2998
def subprocess_decorator(suite):
2999
concurrency = osutils.local_concurrency()
3000
if concurrency == 1:
3002
from testtools import ConcurrentTestSuite
3003
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3004
parallel_registry.register('subprocess', subprocess_decorator)
3007
def exclude_tests(exclude_pattern):
3008
"""Return a test suite decorator that excludes tests."""
3009
if exclude_pattern is None:
3010
return identity_decorator
3011
def decorator(suite):
3012
return ExcludeDecorator(suite, exclude_pattern)
3016
def filter_tests(pattern):
3018
return identity_decorator
3019
def decorator(suite):
3020
return FilterTestsDecorator(suite, pattern)
3024
def random_order(random_seed, runner):
3025
"""Return a test suite decorator factory for randomising tests order.
3027
:param random_seed: now, a string which casts to a long, or a long.
3028
:param runner: A test runner with a stream attribute to report on.
3030
if random_seed is None:
3031
return identity_decorator
3032
def decorator(suite):
3033
return RandomDecorator(suite, random_seed, runner.stream)
3037
def tests_first(pattern):
3039
return identity_decorator
3040
def decorator(suite):
3041
return TestFirstDecorator(suite, pattern)
3045
def identity_decorator(suite):
3050
class TestDecorator(TestSuite):
3051
"""A decorator for TestCase/TestSuite objects.
3053
Usually, subclasses should override __iter__(used when flattening test
3054
suites), which we do to filter, reorder, parallelise and so on, run() and
3058
def __init__(self, suite):
3059
TestSuite.__init__(self)
3062
def countTestCases(self):
3065
cases += test.countTestCases()
3072
def run(self, result):
3073
# Use iteration on self, not self._tests, to allow subclasses to hook
3076
if result.shouldStop:
3082
class CountingDecorator(TestDecorator):
3083
"""A decorator which calls result.progress(self.countTestCases)."""
3085
def run(self, result):
3086
progress_method = getattr(result, 'progress', None)
3087
if callable(progress_method):
3088
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3089
return super(CountingDecorator, self).run(result)
3092
class ExcludeDecorator(TestDecorator):
3093
"""A decorator which excludes test matching an exclude pattern."""
3095
def __init__(self, suite, exclude_pattern):
3096
TestDecorator.__init__(self, suite)
3097
self.exclude_pattern = exclude_pattern
3098
self.excluded = False
3102
return iter(self._tests)
3103
self.excluded = True
3104
suite = exclude_tests_by_re(self, self.exclude_pattern)
3106
self.addTests(suite)
3107
return iter(self._tests)
3110
class FilterTestsDecorator(TestDecorator):
3111
"""A decorator which filters tests to those matching a pattern."""
3113
def __init__(self, suite, pattern):
3114
TestDecorator.__init__(self, suite)
3115
self.pattern = pattern
3116
self.filtered = False
3120
return iter(self._tests)
3121
self.filtered = True
3122
suite = filter_suite_by_re(self, self.pattern)
3124
self.addTests(suite)
3125
return iter(self._tests)
3128
class RandomDecorator(TestDecorator):
3129
"""A decorator which randomises the order of its tests."""
3131
def __init__(self, suite, random_seed, stream):
3132
TestDecorator.__init__(self, suite)
3133
self.random_seed = random_seed
3134
self.randomised = False
3135
self.stream = stream
3139
return iter(self._tests)
3140
self.randomised = True
3141
self.stream.write("Randomizing test order using seed %s\n\n" %
3142
(self.actual_seed()))
3143
# Initialise the random number generator.
3144
random.seed(self.actual_seed())
3145
suite = randomize_suite(self)
3147
self.addTests(suite)
3148
return iter(self._tests)
3150
def actual_seed(self):
3151
if self.random_seed == "now":
3152
# We convert the seed to a long to make it reuseable across
3153
# invocations (because the user can reenter it).
3154
self.random_seed = long(time.time())
3156
# Convert the seed to a long if we can
3158
self.random_seed = long(self.random_seed)
3161
return self.random_seed
3164
class TestFirstDecorator(TestDecorator):
3165
"""A decorator which moves named tests to the front."""
3167
def __init__(self, suite, pattern):
3168
TestDecorator.__init__(self, suite)
3169
self.pattern = pattern
3170
self.filtered = False
3174
return iter(self._tests)
3175
self.filtered = True
3176
suites = split_suite_by_re(self, self.pattern)
3178
self.addTests(suites)
3179
return iter(self._tests)
3182
def partition_tests(suite, count):
3183
"""Partition suite into count lists of tests."""
3185
tests = list(iter_suite_tests(suite))
3186
tests_per_process = int(math.ceil(float(len(tests)) / count))
3187
for block in range(count):
3188
low_test = block * tests_per_process
3189
high_test = low_test + tests_per_process
3190
process_tests = tests[low_test:high_test]
3191
result.append(process_tests)
3195
def fork_for_tests(suite):
3196
"""Take suite and start up one runner per CPU by forking()
3198
:return: An iterable of TestCase-like objects which can each have
3199
run(result) called on them to feed tests to result.
3201
concurrency = osutils.local_concurrency()
3203
from subunit import TestProtocolClient, ProtocolTestCase
3204
from subunit.test_results import AutoTimingTestResultDecorator
3205
class TestInOtherProcess(ProtocolTestCase):
3206
# Should be in subunit, I think. RBC.
3207
def __init__(self, stream, pid):
3208
ProtocolTestCase.__init__(self, stream)
3211
def run(self, result):
3213
ProtocolTestCase.run(self, result)
3215
os.waitpid(self.pid, os.WNOHANG)
3217
test_blocks = partition_tests(suite, concurrency)
3218
for process_tests in test_blocks:
3219
process_suite = TestSuite()
3220
process_suite.addTests(process_tests)
3221
c2pread, c2pwrite = os.pipe()
3226
# Leave stderr and stdout open so we can see test noise
3227
# Close stdin so that the child goes away if it decides to
3228
# read from stdin (otherwise its a roulette to see what
3229
# child actually gets keystrokes for pdb etc).
3232
stream = os.fdopen(c2pwrite, 'wb', 1)
3233
subunit_result = AutoTimingTestResultDecorator(
3234
TestProtocolClient(stream))
3235
process_suite.run(subunit_result)
3240
stream = os.fdopen(c2pread, 'rb', 1)
3241
test = TestInOtherProcess(stream, pid)
3246
def reinvoke_for_tests(suite):
3247
"""Take suite and start up one runner per CPU using subprocess().
3249
:return: An iterable of TestCase-like objects which can each have
3250
run(result) called on them to feed tests to result.
3252
concurrency = osutils.local_concurrency()
3254
from subunit import ProtocolTestCase
3255
class TestInSubprocess(ProtocolTestCase):
3256
def __init__(self, process, name):
3257
ProtocolTestCase.__init__(self, process.stdout)
3258
self.process = process
3259
self.process.stdin.close()
3262
def run(self, result):
3264
ProtocolTestCase.run(self, result)
3267
os.unlink(self.name)
3268
# print "pid %d finished" % finished_process
3269
test_blocks = partition_tests(suite, concurrency)
3270
for process_tests in test_blocks:
3271
# ugly; currently reimplement rather than reuses TestCase methods.
3272
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3273
if not os.path.isfile(bzr_path):
3274
# We are probably installed. Assume sys.argv is the right file
3275
bzr_path = sys.argv[0]
3276
bzr_path = [bzr_path]
3277
if sys.platform == "win32":
3278
# if we're on windows, we can't execute the bzr script directly
3279
bzr_path = [sys.executable] + bzr_path
3280
fd, test_list_file_name = tempfile.mkstemp()
3281
test_list_file = os.fdopen(fd, 'wb', 1)
3282
for test in process_tests:
3283
test_list_file.write(test.id() + '\n')
3284
test_list_file.close()
3286
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3288
if '--no-plugins' in sys.argv:
3289
argv.append('--no-plugins')
3290
# stderr=STDOUT would be ideal, but until we prevent noise on
3291
# stderr it can interrupt the subunit protocol.
3292
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3294
test = TestInSubprocess(process, test_list_file_name)
3297
os.unlink(test_list_file_name)
3302
class ForwardingResult(unittest.TestResult):
3304
def __init__(self, target):
3305
unittest.TestResult.__init__(self)
3306
self.result = target
3308
def startTest(self, test):
3309
self.result.startTest(test)
3311
def stopTest(self, test):
3312
self.result.stopTest(test)
3314
def startTestRun(self):
3315
self.result.startTestRun()
3317
def stopTestRun(self):
3318
self.result.stopTestRun()
3320
def addSkip(self, test, reason):
3321
self.result.addSkip(test, reason)
3323
def addSuccess(self, test):
3324
self.result.addSuccess(test)
3326
def addError(self, test, err):
3327
self.result.addError(test, err)
3329
def addFailure(self, test, err):
3330
self.result.addFailure(test, err)
3331
ForwardingResult = testtools.ExtendedToOriginalDecorator
3334
class ProfileResult(ForwardingResult):
3335
"""Generate profiling data for all activity between start and success.
3337
The profile data is appended to the test's _benchcalls attribute and can
3338
be accessed by the forwarded-to TestResult.
3340
While it might be cleaner do accumulate this in stopTest, addSuccess is
3341
where our existing output support for lsprof is, and this class aims to
3342
fit in with that: while it could be moved it's not necessary to accomplish
3343
test profiling, nor would it be dramatically cleaner.
3346
def startTest(self, test):
3347
self.profiler = bzrlib.lsprof.BzrProfiler()
3348
self.profiler.start()
3349
ForwardingResult.startTest(self, test)
3351
def addSuccess(self, test):
3352
stats = self.profiler.stop()
3354
calls = test._benchcalls
3355
except AttributeError:
3356
test._benchcalls = []
3357
calls = test._benchcalls
3358
calls.append(((test.id(), "", ""), stats))
3359
ForwardingResult.addSuccess(self, test)
3361
def stopTest(self, test):
3362
ForwardingResult.stopTest(self, test)
3363
self.profiler = None
3366
# Controlled by "bzr selftest -E=..." option
3367
# Currently supported:
3368
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3369
# preserves any flags supplied at the command line.
3370
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3371
# rather than failing tests. And no longer raise
3372
# LockContention when fctnl locks are not being used
3373
# with proper exclusion rules.
3374
selftest_debug_flags = set()
3377
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3379
test_suite_factory=None,
3382
matching_tests_first=None,
3385
exclude_pattern=None,
3391
suite_decorators=None,
3395
"""Run the whole test suite under the enhanced runner"""
3396
# XXX: Very ugly way to do this...
3397
# Disable warning about old formats because we don't want it to disturb
3398
# any blackbox tests.
3399
from bzrlib import repository
3400
repository._deprecation_warning_done = True
3402
global default_transport
3403
if transport is None:
3404
transport = default_transport
3405
old_transport = default_transport
3406
default_transport = transport
3407
global selftest_debug_flags
3408
old_debug_flags = selftest_debug_flags
3409
if debug_flags is not None:
3410
selftest_debug_flags = set(debug_flags)
3412
if load_list is None:
3415
keep_only = load_test_id_list(load_list)
3417
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3418
for start in starting_with]
3419
if test_suite_factory is None:
3420
# Reduce loading time by loading modules based on the starting_with
3422
suite = test_suite(keep_only, starting_with)
3424
suite = test_suite_factory()
3426
# But always filter as requested.
3427
suite = filter_suite_by_id_startswith(suite, starting_with)
3428
result_decorators = []
3430
result_decorators.append(ProfileResult)
3431
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3432
stop_on_failure=stop_on_failure,
3433
transport=transport,
3434
lsprof_timed=lsprof_timed,
3435
bench_history=bench_history,
3436
matching_tests_first=matching_tests_first,
3437
list_only=list_only,
3438
random_seed=random_seed,
3439
exclude_pattern=exclude_pattern,
3441
runner_class=runner_class,
3442
suite_decorators=suite_decorators,
3444
result_decorators=result_decorators,
3447
default_transport = old_transport
3448
selftest_debug_flags = old_debug_flags
3451
def load_test_id_list(file_name):
3452
"""Load a test id list from a text file.
3454
The format is one test id by line. No special care is taken to impose
3455
strict rules, these test ids are used to filter the test suite so a test id
3456
that do not match an existing test will do no harm. This allows user to add
3457
comments, leave blank lines, etc.
3461
ftest = open(file_name, 'rt')
3463
if e.errno != errno.ENOENT:
3466
raise errors.NoSuchFile(file_name)
3468
for test_name in ftest.readlines():
3469
test_list.append(test_name.strip())
3474
def suite_matches_id_list(test_suite, id_list):
3475
"""Warns about tests not appearing or appearing more than once.
3477
:param test_suite: A TestSuite object.
3478
:param test_id_list: The list of test ids that should be found in
3481
:return: (absents, duplicates) absents is a list containing the test found
3482
in id_list but not in test_suite, duplicates is a list containing the
3483
test found multiple times in test_suite.
3485
When using a prefined test id list, it may occurs that some tests do not
3486
exist anymore or that some tests use the same id. This function warns the
3487
tester about potential problems in his workflow (test lists are volatile)
3488
or in the test suite itself (using the same id for several tests does not
3489
help to localize defects).
3491
# Build a dict counting id occurrences
3493
for test in iter_suite_tests(test_suite):
3495
tests[id] = tests.get(id, 0) + 1
3500
occurs = tests.get(id, 0)
3502
not_found.append(id)
3504
duplicates.append(id)
3506
return not_found, duplicates
3509
class TestIdList(object):
3510
"""Test id list to filter a test suite.
3512
Relying on the assumption that test ids are built as:
3513
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3514
notation, this class offers methods to :
3515
- avoid building a test suite for modules not refered to in the test list,
3516
- keep only the tests listed from the module test suite.
3519
def __init__(self, test_id_list):
3520
# When a test suite needs to be filtered against us we compare test ids
3521
# for equality, so a simple dict offers a quick and simple solution.
3522
self.tests = dict().fromkeys(test_id_list, True)
3524
# While unittest.TestCase have ids like:
3525
# <module>.<class>.<method>[(<param+)],
3526
# doctest.DocTestCase can have ids like:
3529
# <module>.<function>
3530
# <module>.<class>.<method>
3532
# Since we can't predict a test class from its name only, we settle on
3533
# a simple constraint: a test id always begins with its module name.
3536
for test_id in test_id_list:
3537
parts = test_id.split('.')
3538
mod_name = parts.pop(0)
3539
modules[mod_name] = True
3541
mod_name += '.' + part
3542
modules[mod_name] = True
3543
self.modules = modules
3545
def refers_to(self, module_name):
3546
"""Is there tests for the module or one of its sub modules."""
3547
return self.modules.has_key(module_name)
3549
def includes(self, test_id):
3550
return self.tests.has_key(test_id)
3553
class TestPrefixAliasRegistry(registry.Registry):
3554
"""A registry for test prefix aliases.
3556
This helps implement shorcuts for the --starting-with selftest
3557
option. Overriding existing prefixes is not allowed but not fatal (a
3558
warning will be emitted).
3561
def register(self, key, obj, help=None, info=None,
3562
override_existing=False):
3563
"""See Registry.register.
3565
Trying to override an existing alias causes a warning to be emitted,
3566
not a fatal execption.
3569
super(TestPrefixAliasRegistry, self).register(
3570
key, obj, help=help, info=info, override_existing=False)
3572
actual = self.get(key)
3573
note('Test prefix alias %s is already used for %s, ignoring %s'
3574
% (key, actual, obj))
3576
def resolve_alias(self, id_start):
3577
"""Replace the alias by the prefix in the given string.
3579
Using an unknown prefix is an error to help catching typos.
3581
parts = id_start.split('.')
3583
parts[0] = self.get(parts[0])
3585
raise errors.BzrCommandError(
3586
'%s is not a known test prefix alias' % parts[0])
3587
return '.'.join(parts)
3590
test_prefix_alias_registry = TestPrefixAliasRegistry()
3591
"""Registry of test prefix aliases."""
3594
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3595
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3596
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3598
# Obvious highest levels prefixes, feel free to add your own via a plugin
3599
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3600
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3601
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3602
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3603
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3606
def _test_suite_testmod_names():
3607
"""Return the standard list of test module names to test."""
3610
'bzrlib.tests.blackbox',
3611
'bzrlib.tests.commands',
3612
'bzrlib.tests.per_branch',
3613
'bzrlib.tests.per_bzrdir',
3614
'bzrlib.tests.per_bzrdir_colo',
3615
'bzrlib.tests.per_foreign_vcs',
3616
'bzrlib.tests.per_interrepository',
3617
'bzrlib.tests.per_intertree',
3618
'bzrlib.tests.per_inventory',
3619
'bzrlib.tests.per_interbranch',
3620
'bzrlib.tests.per_lock',
3621
'bzrlib.tests.per_merger',
3622
'bzrlib.tests.per_transport',
3623
'bzrlib.tests.per_tree',
3624
'bzrlib.tests.per_pack_repository',
3625
'bzrlib.tests.per_repository',
3626
'bzrlib.tests.per_repository_chk',
3627
'bzrlib.tests.per_repository_reference',
3628
'bzrlib.tests.per_uifactory',
3629
'bzrlib.tests.per_versionedfile',
3630
'bzrlib.tests.per_workingtree',
3631
'bzrlib.tests.test__annotator',
3632
'bzrlib.tests.test__bencode',
3633
'bzrlib.tests.test__chk_map',
3634
'bzrlib.tests.test__dirstate_helpers',
3635
'bzrlib.tests.test__groupcompress',
3636
'bzrlib.tests.test__known_graph',
3637
'bzrlib.tests.test__rio',
3638
'bzrlib.tests.test__simple_set',
3639
'bzrlib.tests.test__static_tuple',
3640
'bzrlib.tests.test__walkdirs_win32',
3641
'bzrlib.tests.test_ancestry',
3642
'bzrlib.tests.test_annotate',
3643
'bzrlib.tests.test_api',
3644
'bzrlib.tests.test_atomicfile',
3645
'bzrlib.tests.test_bad_files',
3646
'bzrlib.tests.test_bisect_multi',
3647
'bzrlib.tests.test_branch',
3648
'bzrlib.tests.test_branchbuilder',
3649
'bzrlib.tests.test_btree_index',
3650
'bzrlib.tests.test_bugtracker',
3651
'bzrlib.tests.test_bundle',
3652
'bzrlib.tests.test_bzrdir',
3653
'bzrlib.tests.test__chunks_to_lines',
3654
'bzrlib.tests.test_cache_utf8',
3655
'bzrlib.tests.test_chk_map',
3656
'bzrlib.tests.test_chk_serializer',
3657
'bzrlib.tests.test_chunk_writer',
3658
'bzrlib.tests.test_clean_tree',
3659
'bzrlib.tests.test_cleanup',
3660
'bzrlib.tests.test_cmdline',
3661
'bzrlib.tests.test_commands',
3662
'bzrlib.tests.test_commit',
3663
'bzrlib.tests.test_commit_merge',
3664
'bzrlib.tests.test_config',
3665
'bzrlib.tests.test_conflicts',
3666
'bzrlib.tests.test_counted_lock',
3667
'bzrlib.tests.test_crash',
3668
'bzrlib.tests.test_decorators',
3669
'bzrlib.tests.test_delta',
3670
'bzrlib.tests.test_debug',
3671
'bzrlib.tests.test_deprecated_graph',
3672
'bzrlib.tests.test_diff',
3673
'bzrlib.tests.test_directory_service',
3674
'bzrlib.tests.test_dirstate',
3675
'bzrlib.tests.test_email_message',
3676
'bzrlib.tests.test_eol_filters',
3677
'bzrlib.tests.test_errors',
3678
'bzrlib.tests.test_export',
3679
'bzrlib.tests.test_extract',
3680
'bzrlib.tests.test_fetch',
3681
'bzrlib.tests.test_fifo_cache',
3682
'bzrlib.tests.test_filters',
3683
'bzrlib.tests.test_ftp_transport',
3684
'bzrlib.tests.test_foreign',
3685
'bzrlib.tests.test_generate_docs',
3686
'bzrlib.tests.test_generate_ids',
3687
'bzrlib.tests.test_globbing',
3688
'bzrlib.tests.test_gpg',
3689
'bzrlib.tests.test_graph',
3690
'bzrlib.tests.test_groupcompress',
3691
'bzrlib.tests.test_hashcache',
3692
'bzrlib.tests.test_help',
3693
'bzrlib.tests.test_hooks',
3694
'bzrlib.tests.test_http',
3695
'bzrlib.tests.test_http_response',
3696
'bzrlib.tests.test_https_ca_bundle',
3697
'bzrlib.tests.test_identitymap',
3698
'bzrlib.tests.test_ignores',
3699
'bzrlib.tests.test_index',
3700
'bzrlib.tests.test_import_tariff',
3701
'bzrlib.tests.test_info',
3702
'bzrlib.tests.test_inv',
3703
'bzrlib.tests.test_inventory_delta',
3704
'bzrlib.tests.test_knit',
3705
'bzrlib.tests.test_lazy_import',
3706
'bzrlib.tests.test_lazy_regex',
3707
'bzrlib.tests.test_lock',
3708
'bzrlib.tests.test_lockable_files',
3709
'bzrlib.tests.test_lockdir',
3710
'bzrlib.tests.test_log',
3711
'bzrlib.tests.test_lru_cache',
3712
'bzrlib.tests.test_lsprof',
3713
'bzrlib.tests.test_mail_client',
3714
'bzrlib.tests.test_memorytree',
3715
'bzrlib.tests.test_merge',
3716
'bzrlib.tests.test_merge3',
3717
'bzrlib.tests.test_merge_core',
3718
'bzrlib.tests.test_merge_directive',
3719
'bzrlib.tests.test_missing',
3720
'bzrlib.tests.test_msgeditor',
3721
'bzrlib.tests.test_multiparent',
3722
'bzrlib.tests.test_mutabletree',
3723
'bzrlib.tests.test_nonascii',
3724
'bzrlib.tests.test_options',
3725
'bzrlib.tests.test_osutils',
3726
'bzrlib.tests.test_osutils_encodings',
3727
'bzrlib.tests.test_pack',
3728
'bzrlib.tests.test_patch',
3729
'bzrlib.tests.test_patches',
3730
'bzrlib.tests.test_permissions',
3731
'bzrlib.tests.test_plugins',
3732
'bzrlib.tests.test_progress',
3733
'bzrlib.tests.test_read_bundle',
3734
'bzrlib.tests.test_reconcile',
3735
'bzrlib.tests.test_reconfigure',
3736
'bzrlib.tests.test_registry',
3737
'bzrlib.tests.test_remote',
3738
'bzrlib.tests.test_rename_map',
3739
'bzrlib.tests.test_repository',
3740
'bzrlib.tests.test_revert',
3741
'bzrlib.tests.test_revision',
3742
'bzrlib.tests.test_revisionspec',
3743
'bzrlib.tests.test_revisiontree',
3744
'bzrlib.tests.test_rio',
3745
'bzrlib.tests.test_rules',
3746
'bzrlib.tests.test_sampler',
3747
'bzrlib.tests.test_script',
3748
'bzrlib.tests.test_selftest',
3749
'bzrlib.tests.test_serializer',
3750
'bzrlib.tests.test_setup',
3751
'bzrlib.tests.test_sftp_transport',
3752
'bzrlib.tests.test_shelf',
3753
'bzrlib.tests.test_shelf_ui',
3754
'bzrlib.tests.test_smart',
3755
'bzrlib.tests.test_smart_add',
3756
'bzrlib.tests.test_smart_request',
3757
'bzrlib.tests.test_smart_transport',
3758
'bzrlib.tests.test_smtp_connection',
3759
'bzrlib.tests.test_source',
3760
'bzrlib.tests.test_ssh_transport',
3761
'bzrlib.tests.test_status',
3762
'bzrlib.tests.test_store',
3763
'bzrlib.tests.test_strace',
3764
'bzrlib.tests.test_subsume',
3765
'bzrlib.tests.test_switch',
3766
'bzrlib.tests.test_symbol_versioning',
3767
'bzrlib.tests.test_tag',
3768
'bzrlib.tests.test_testament',
3769
'bzrlib.tests.test_textfile',
3770
'bzrlib.tests.test_textmerge',
3771
'bzrlib.tests.test_timestamp',
3772
'bzrlib.tests.test_trace',
3773
'bzrlib.tests.test_transactions',
3774
'bzrlib.tests.test_transform',
3775
'bzrlib.tests.test_transport',
3776
'bzrlib.tests.test_transport_log',
3777
'bzrlib.tests.test_tree',
3778
'bzrlib.tests.test_treebuilder',
3779
'bzrlib.tests.test_tsort',
3780
'bzrlib.tests.test_tuned_gzip',
3781
'bzrlib.tests.test_ui',
3782
'bzrlib.tests.test_uncommit',
3783
'bzrlib.tests.test_upgrade',
3784
'bzrlib.tests.test_upgrade_stacked',
3785
'bzrlib.tests.test_urlutils',
3786
'bzrlib.tests.test_version',
3787
'bzrlib.tests.test_version_info',
3788
'bzrlib.tests.test_weave',
3789
'bzrlib.tests.test_whitebox',
3790
'bzrlib.tests.test_win32utils',
3791
'bzrlib.tests.test_workingtree',
3792
'bzrlib.tests.test_workingtree_4',
3793
'bzrlib.tests.test_wsgi',
3794
'bzrlib.tests.test_xml',
3798
def _test_suite_modules_to_doctest():
3799
"""Return the list of modules to doctest."""
3802
'bzrlib.branchbuilder',
3803
'bzrlib.decorators',
3806
'bzrlib.iterablefile',
3810
'bzrlib.symbol_versioning',
3813
'bzrlib.version_info_formats.format_custom',
3817
def test_suite(keep_only=None, starting_with=None):
3818
"""Build and return TestSuite for the whole of bzrlib.
3820
:param keep_only: A list of test ids limiting the suite returned.
3822
:param starting_with: An id limiting the suite returned to the tests
3825
This function can be replaced if you need to change the default test
3826
suite on a global basis, but it is not encouraged.
3829
loader = TestUtil.TestLoader()
3831
if keep_only is not None:
3832
id_filter = TestIdList(keep_only)
3834
# We take precedence over keep_only because *at loading time* using
3835
# both options means we will load less tests for the same final result.
3836
def interesting_module(name):
3837
for start in starting_with:
3839
# Either the module name starts with the specified string
3840
name.startswith(start)
3841
# or it may contain tests starting with the specified string
3842
or start.startswith(name)
3846
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3848
elif keep_only is not None:
3849
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3850
def interesting_module(name):
3851
return id_filter.refers_to(name)
3854
loader = TestUtil.TestLoader()
3855
def interesting_module(name):
3856
# No filtering, all modules are interesting
3859
suite = loader.suiteClass()
3861
# modules building their suite with loadTestsFromModuleNames
3862
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3864
for mod in _test_suite_modules_to_doctest():
3865
if not interesting_module(mod):
3866
# No tests to keep here, move along
3869
# note that this really does mean "report only" -- doctest
3870
# still runs the rest of the examples
3871
doc_suite = doctest.DocTestSuite(mod,
3872
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3873
except ValueError, e:
3874
print '**failed to get doctest for: %s\n%s' % (mod, e)
3876
if len(doc_suite._tests) == 0:
3877
raise errors.BzrError("no doctests found in %s" % (mod,))
3878
suite.addTest(doc_suite)
3880
default_encoding = sys.getdefaultencoding()
3881
for name, plugin in bzrlib.plugin.plugins().items():
3882
if not interesting_module(plugin.module.__name__):
3884
plugin_suite = plugin.test_suite()
3885
# We used to catch ImportError here and turn it into just a warning,
3886
# but really if you don't have --no-plugins this should be a failure.
3887
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3888
if plugin_suite is None:
3889
plugin_suite = plugin.load_plugin_tests(loader)
3890
if plugin_suite is not None:
3891
suite.addTest(plugin_suite)
3892
if default_encoding != sys.getdefaultencoding():
3893
bzrlib.trace.warning(
3894
'Plugin "%s" tried to reset default encoding to: %s', name,
3895
sys.getdefaultencoding())
3897
sys.setdefaultencoding(default_encoding)
3899
if keep_only is not None:
3900
# Now that the referred modules have loaded their tests, keep only the
3902
suite = filter_suite_by_id_list(suite, id_filter)
3903
# Do some sanity checks on the id_list filtering
3904
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3906
# The tester has used both keep_only and starting_with, so he is
3907
# already aware that some tests are excluded from the list, there
3908
# is no need to tell him which.
3911
# Some tests mentioned in the list are not in the test suite. The
3912
# list may be out of date, report to the tester.
3913
for id in not_found:
3914
bzrlib.trace.warning('"%s" not found in the test suite', id)
3915
for id in duplicates:
3916
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3921
def multiply_scenarios(scenarios_left, scenarios_right):
3922
"""Multiply two sets of scenarios.
3924
:returns: the cartesian product of the two sets of scenarios, that is
3925
a scenario for every possible combination of a left scenario and a
3929
('%s,%s' % (left_name, right_name),
3930
dict(left_dict.items() + right_dict.items()))
3931
for left_name, left_dict in scenarios_left
3932
for right_name, right_dict in scenarios_right]
3935
def multiply_tests(tests, scenarios, result):
3936
"""Multiply tests_list by scenarios into result.
3938
This is the core workhorse for test parameterisation.
3940
Typically the load_tests() method for a per-implementation test suite will
3941
call multiply_tests and return the result.
3943
:param tests: The tests to parameterise.
3944
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3945
scenario_param_dict).
3946
:param result: A TestSuite to add created tests to.
3948
This returns the passed in result TestSuite with the cross product of all
3949
the tests repeated once for each scenario. Each test is adapted by adding
3950
the scenario name at the end of its id(), and updating the test object's
3951
__dict__ with the scenario_param_dict.
3953
>>> import bzrlib.tests.test_sampler
3954
>>> r = multiply_tests(
3955
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3956
... [('one', dict(param=1)),
3957
... ('two', dict(param=2))],
3959
>>> tests = list(iter_suite_tests(r))
3963
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3969
for test in iter_suite_tests(tests):
3970
apply_scenarios(test, scenarios, result)
3974
def apply_scenarios(test, scenarios, result):
3975
"""Apply the scenarios in scenarios to test and add to result.
3977
:param test: The test to apply scenarios to.
3978
:param scenarios: An iterable of scenarios to apply to test.
3980
:seealso: apply_scenario
3982
for scenario in scenarios:
3983
result.addTest(apply_scenario(test, scenario))
3987
def apply_scenario(test, scenario):
3988
"""Copy test and apply scenario to it.
3990
:param test: A test to adapt.
3991
:param scenario: A tuple describing the scenarion.
3992
The first element of the tuple is the new test id.
3993
The second element is a dict containing attributes to set on the
3995
:return: The adapted test.
3997
new_id = "%s(%s)" % (test.id(), scenario[0])
3998
new_test = clone_test(test, new_id)
3999
for name, value in scenario[1].items():
4000
setattr(new_test, name, value)
4004
def clone_test(test, new_id):
4005
"""Clone a test giving it a new id.
4007
:param test: The test to clone.
4008
:param new_id: The id to assign to it.
4009
:return: The new test.
4011
new_test = copy(test)
4012
new_test.id = lambda: new_id
4016
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4018
"""Helper for permutating tests against an extension module.
4020
This is meant to be used inside a modules 'load_tests()' function. It will
4021
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4022
against both implementations. Setting 'test.module' to the appropriate
4023
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4025
:param standard_tests: A test suite to permute
4026
:param loader: A TestLoader
4027
:param py_module_name: The python path to a python module that can always
4028
be loaded, and will be considered the 'python' implementation. (eg
4029
'bzrlib._chk_map_py')
4030
:param ext_module_name: The python path to an extension module. If the
4031
module cannot be loaded, a single test will be added, which notes that
4032
the module is not available. If it can be loaded, all standard_tests
4033
will be run against that module.
4034
:return: (suite, feature) suite is a test-suite that has all the permuted
4035
tests. feature is the Feature object that can be used to determine if
4036
the module is available.
4039
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4041
('python', {'module': py_module}),
4043
suite = loader.suiteClass()
4044
feature = ModuleAvailableFeature(ext_module_name)
4045
if feature.available():
4046
scenarios.append(('C', {'module': feature.module}))
4048
# the compiled module isn't available, so we add a failing test
4049
class FailWithoutFeature(TestCase):
4050
def test_fail(self):
4051
self.requireFeature(feature)
4052
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4053
result = multiply_tests(standard_tests, scenarios, suite)
4054
return result, feature
4057
def _rmtree_temp_dir(dirname, test_id=None):
4058
# If LANG=C we probably have created some bogus paths
4059
# which rmtree(unicode) will fail to delete
4060
# so make sure we are using rmtree(str) to delete everything
4061
# except on win32, where rmtree(str) will fail
4062
# since it doesn't have the property of byte-stream paths
4063
# (they are either ascii or mbcs)
4064
if sys.platform == 'win32':
4065
# make sure we are using the unicode win32 api
4066
dirname = unicode(dirname)
4068
dirname = dirname.encode(sys.getfilesystemencoding())
4070
osutils.rmtree(dirname)
4072
# We don't want to fail here because some useful display will be lost
4073
# otherwise. Polluting the tmp dir is bad, but not giving all the
4074
# possible info to the test runner is even worse.
4076
ui.ui_factory.clear_term()
4077
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4078
sys.stderr.write('Unable to remove testing dir %s\n%s'
4079
% (os.path.basename(dirname), e))
4082
class Feature(object):
4083
"""An operating system Feature."""
4086
self._available = None
4088
def available(self):
4089
"""Is the feature available?
4091
:return: True if the feature is available.
4093
if self._available is None:
4094
self._available = self._probe()
4095
return self._available
4098
"""Implement this method in concrete features.
4100
:return: True if the feature is available.
4102
raise NotImplementedError
4105
if getattr(self, 'feature_name', None):
4106
return self.feature_name()
4107
return self.__class__.__name__
4110
class _SymlinkFeature(Feature):
4113
return osutils.has_symlinks()
4115
def feature_name(self):
4118
SymlinkFeature = _SymlinkFeature()
4121
class _HardlinkFeature(Feature):
4124
return osutils.has_hardlinks()
4126
def feature_name(self):
4129
HardlinkFeature = _HardlinkFeature()
4132
class _OsFifoFeature(Feature):
4135
return getattr(os, 'mkfifo', None)
4137
def feature_name(self):
4138
return 'filesystem fifos'
4140
OsFifoFeature = _OsFifoFeature()
4143
class _UnicodeFilenameFeature(Feature):
4144
"""Does the filesystem support Unicode filenames?"""
4148
# Check for character combinations unlikely to be covered by any
4149
# single non-unicode encoding. We use the characters
4150
# - greek small letter alpha (U+03B1) and
4151
# - braille pattern dots-123456 (U+283F).
4152
os.stat(u'\u03b1\u283f')
4153
except UnicodeEncodeError:
4155
except (IOError, OSError):
4156
# The filesystem allows the Unicode filename but the file doesn't
4160
# The filesystem allows the Unicode filename and the file exists,
4164
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4167
class _CompatabilityThunkFeature(Feature):
4168
"""This feature is just a thunk to another feature.
4170
It issues a deprecation warning if it is accessed, to let you know that you
4171
should really use a different feature.
4174
def __init__(self, dep_version, module, name,
4175
replacement_name, replacement_module=None):
4176
super(_CompatabilityThunkFeature, self).__init__()
4177
self._module = module
4178
if replacement_module is None:
4179
replacement_module = module
4180
self._replacement_module = replacement_module
4182
self._replacement_name = replacement_name
4183
self._dep_version = dep_version
4184
self._feature = None
4187
if self._feature is None:
4188
depr_msg = self._dep_version % ('%s.%s'
4189
% (self._module, self._name))
4190
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4191
self._replacement_name)
4192
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4193
# Import the new feature and use it as a replacement for the
4195
mod = __import__(self._replacement_module, {}, {},
4196
[self._replacement_name])
4197
self._feature = getattr(mod, self._replacement_name)
4201
return self._feature._probe()
4204
class ModuleAvailableFeature(Feature):
4205
"""This is a feature than describes a module we want to be available.
4207
Declare the name of the module in __init__(), and then after probing, the
4208
module will be available as 'self.module'.
4210
:ivar module: The module if it is available, else None.
4213
def __init__(self, module_name):
4214
super(ModuleAvailableFeature, self).__init__()
4215
self.module_name = module_name
4219
self._module = __import__(self.module_name, {}, {}, [''])
4226
if self.available(): # Make sure the probe has been done
4230
def feature_name(self):
4231
return self.module_name
4234
# This is kept here for compatibility, it is recommended to use
4235
# 'bzrlib.tests.feature.paramiko' instead
4236
ParamikoFeature = _CompatabilityThunkFeature(
4237
deprecated_in((2,1,0)),
4238
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4241
def probe_unicode_in_user_encoding():
4242
"""Try to encode several unicode strings to use in unicode-aware tests.
4243
Return first successfull match.
4245
:return: (unicode value, encoded plain string value) or (None, None)
4247
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4248
for uni_val in possible_vals:
4250
str_val = uni_val.encode(osutils.get_user_encoding())
4251
except UnicodeEncodeError:
4252
# Try a different character
4255
return uni_val, str_val
4259
def probe_bad_non_ascii(encoding):
4260
"""Try to find [bad] character with code [128..255]
4261
that cannot be decoded to unicode in some encoding.
4262
Return None if all non-ascii characters is valid
4265
for i in xrange(128, 256):
4268
char.decode(encoding)
4269
except UnicodeDecodeError:
4274
class _HTTPSServerFeature(Feature):
4275
"""Some tests want an https Server, check if one is available.
4277
Right now, the only way this is available is under python2.6 which provides
4288
def feature_name(self):
4289
return 'HTTPSServer'
4292
HTTPSServerFeature = _HTTPSServerFeature()
4295
class _UnicodeFilename(Feature):
4296
"""Does the filesystem support Unicode filenames?"""
4301
except UnicodeEncodeError:
4303
except (IOError, OSError):
4304
# The filesystem allows the Unicode filename but the file doesn't
4308
# The filesystem allows the Unicode filename and the file exists,
4312
UnicodeFilename = _UnicodeFilename()
4315
class _UTF8Filesystem(Feature):
4316
"""Is the filesystem UTF-8?"""
4319
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4323
UTF8Filesystem = _UTF8Filesystem()
4326
class _BreakinFeature(Feature):
4327
"""Does this platform support the breakin feature?"""
4330
from bzrlib import breakin
4331
if breakin.determine_signal() is None:
4333
if sys.platform == 'win32':
4334
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4335
# We trigger SIGBREAK via a Console api so we need ctypes to
4336
# access the function
4343
def feature_name(self):
4344
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4347
BreakinFeature = _BreakinFeature()
4350
class _CaseInsCasePresFilenameFeature(Feature):
4351
"""Is the file-system case insensitive, but case-preserving?"""
4354
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4356
# first check truly case-preserving for created files, then check
4357
# case insensitive when opening existing files.
4358
name = osutils.normpath(name)
4359
base, rel = osutils.split(name)
4360
found_rel = osutils.canonical_relpath(base, name)
4361
return (found_rel == rel
4362
and os.path.isfile(name.upper())
4363
and os.path.isfile(name.lower()))
4368
def feature_name(self):
4369
return "case-insensitive case-preserving filesystem"
4371
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4374
class _CaseInsensitiveFilesystemFeature(Feature):
4375
"""Check if underlying filesystem is case-insensitive but *not* case
4378
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4379
# more likely to be case preserving, so this case is rare.
4382
if CaseInsCasePresFilenameFeature.available():
4385
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4386
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4387
TestCaseWithMemoryTransport.TEST_ROOT = root
4389
root = TestCaseWithMemoryTransport.TEST_ROOT
4390
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4392
name_a = osutils.pathjoin(tdir, 'a')
4393
name_A = osutils.pathjoin(tdir, 'A')
4395
result = osutils.isdir(name_A)
4396
_rmtree_temp_dir(tdir)
4399
def feature_name(self):
4400
return 'case-insensitive filesystem'
4402
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4405
class _CaseSensitiveFilesystemFeature(Feature):
4408
if CaseInsCasePresFilenameFeature.available():
4410
elif CaseInsensitiveFilesystemFeature.available():
4415
def feature_name(self):
4416
return 'case-sensitive filesystem'
4418
# new coding style is for feature instances to be lowercase
4419
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4422
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4423
SubUnitFeature = _CompatabilityThunkFeature(
4424
deprecated_in((2,1,0)),
4425
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4426
# Only define SubUnitBzrRunner if subunit is available.
4428
from subunit import TestProtocolClient
4429
from subunit.test_results import AutoTimingTestResultDecorator
4430
class SubUnitBzrRunner(TextTestRunner):
4431
def run(self, test):
4432
result = AutoTimingTestResultDecorator(
4433
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
