1
# Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
32
from cStringIO import StringIO
39
from pprint import pformat
44
from subprocess import Popen, PIPE, STDOUT
54
# nb: check this before importing anything else from within it
55
_testtools_version = getattr(testtools, '__version__', ())
56
if _testtools_version < (0, 9, 2):
57
raise ImportError("need at least testtools 0.9.2: %s is %r"
58
% (testtools.__file__, _testtools_version))
59
from testtools import content
79
import bzrlib.commands
80
import bzrlib.timestamp
82
import bzrlib.inventory
83
import bzrlib.iterablefile
88
# lsprof not available
90
from bzrlib.merge import merge_inner
93
from bzrlib.smart import client, request, server
95
from bzrlib import symbol_versioning
96
from bzrlib.symbol_versioning import (
104
from bzrlib.transport import get_transport, pathfilter
105
import bzrlib.transport
106
from bzrlib.transport.local import LocalURLServer
107
from bzrlib.transport.memory import MemoryServer
108
from bzrlib.transport.readonly import ReadonlyServer
109
from bzrlib.trace import mutter, note
110
from bzrlib.tests import TestUtil
111
from bzrlib.tests.http_server import HttpServer
112
from bzrlib.tests.TestUtil import (
116
from bzrlib.tests.treeshape import build_tree_contents
117
from bzrlib.ui import NullProgressView
118
from bzrlib.ui.text import TextUIFactory
119
import bzrlib.version_info_formats.format_custom
120
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
122
# Mark this python module as being part of the implementation
123
# of unittest: this gives us better tracebacks where the last
124
# shown frame is the test code, not our assertXYZ.
127
default_transport = LocalURLServer
130
_unitialized_attr = object()
131
"""A sentinel needed to act as a default value in a method signature."""
134
# Subunit result codes, defined here to prevent a hard dependency on subunit.
139
class ExtendedTestResult(unittest._TextTestResult):
140
"""Accepts, reports and accumulates the results of running tests.
142
Compared to the unittest version this class adds support for
143
profiling, benchmarking, stopping as soon as a test fails, and
144
skipping tests. There are further-specialized subclasses for
145
different types of display.
147
When a test finishes, in whatever way, it calls one of the addSuccess,
148
addFailure or addError classes. These in turn may redirect to a more
149
specific case for the special test results supported by our extended
152
Note that just one of these objects is fed the results from many tests.
157
def __init__(self, stream, descriptions, verbosity,
161
"""Construct new TestResult.
163
:param bench_history: Optionally, a writable file object to accumulate
166
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
167
if bench_history is not None:
168
from bzrlib.version import _get_bzr_source_tree
169
src_tree = _get_bzr_source_tree()
172
revision_id = src_tree.get_parent_ids()[0]
174
# XXX: if this is a brand new tree, do the same as if there
178
# XXX: If there's no branch, what should we do?
180
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
181
self._bench_history = bench_history
182
self.ui = ui.ui_factory
185
self.failure_count = 0
186
self.known_failure_count = 0
188
self.not_applicable_count = 0
189
self.unsupported = {}
191
self._overall_start_time = time.time()
192
self._strict = strict
194
def stopTestRun(self):
197
stopTime = time.time()
198
timeTaken = stopTime - self.startTime
200
self.stream.writeln(self.separator2)
201
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
202
run, run != 1 and "s" or "", timeTaken))
203
self.stream.writeln()
204
if not self.wasSuccessful():
205
self.stream.write("FAILED (")
206
failed, errored = map(len, (self.failures, self.errors))
208
self.stream.write("failures=%d" % failed)
210
if failed: self.stream.write(", ")
211
self.stream.write("errors=%d" % errored)
212
if self.known_failure_count:
213
if failed or errored: self.stream.write(", ")
214
self.stream.write("known_failure_count=%d" %
215
self.known_failure_count)
216
self.stream.writeln(")")
218
if self.known_failure_count:
219
self.stream.writeln("OK (known_failures=%d)" %
220
self.known_failure_count)
222
self.stream.writeln("OK")
223
if self.skip_count > 0:
224
skipped = self.skip_count
225
self.stream.writeln('%d test%s skipped' %
226
(skipped, skipped != 1 and "s" or ""))
228
for feature, count in sorted(self.unsupported.items()):
229
self.stream.writeln("Missing feature '%s' skipped %d tests." %
232
ok = self.wasStrictlySuccessful()
234
ok = self.wasSuccessful()
235
if TestCase._first_thread_leaker_id:
237
'%s is leaking threads among %d leaking tests.\n' % (
238
TestCase._first_thread_leaker_id,
239
TestCase._leaking_threads_tests))
240
# We don't report the main thread as an active one.
242
'%d non-main threads were left active in the end.\n'
243
% (TestCase._active_threads - 1))
245
def getDescription(self, test):
248
def _extractBenchmarkTime(self, testCase, details=None):
249
"""Add a benchmark time for the current test case."""
250
if details and 'benchtime' in details:
251
return float(''.join(details['benchtime'].iter_bytes()))
252
return getattr(testCase, "_benchtime", None)
254
def _elapsedTestTimeString(self):
255
"""Return a time string for the overall time the current test has taken."""
256
return self._formatTime(time.time() - self._start_time)
258
def _testTimeString(self, testCase):
259
benchmark_time = self._extractBenchmarkTime(testCase)
260
if benchmark_time is not None:
261
return self._formatTime(benchmark_time) + "*"
263
return self._elapsedTestTimeString()
265
def _formatTime(self, seconds):
266
"""Format seconds as milliseconds with leading spaces."""
267
# some benchmarks can take thousands of seconds to run, so we need 8
269
return "%8dms" % (1000 * seconds)
271
def _shortened_test_description(self, test):
273
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
276
def startTest(self, test):
277
unittest.TestResult.startTest(self, test)
280
self.report_test_start(test)
281
test.number = self.count
282
self._recordTestStartTime()
284
def startTests(self):
286
if getattr(sys, 'frozen', None) is None:
287
bzr_path = osutils.realpath(sys.argv[0])
289
bzr_path = sys.executable
291
'bzr selftest: %s\n' % (bzr_path,))
294
bzrlib.__path__[0],))
296
' bzr-%s python-%s %s\n' % (
297
bzrlib.version_string,
298
bzrlib._format_version_tuple(sys.version_info),
299
platform.platform(aliased=1),
301
self.stream.write('\n')
303
def _recordTestStartTime(self):
304
"""Record that a test has started."""
305
self._start_time = time.time()
307
def _cleanupLogFile(self, test):
308
# We can only do this if we have one of our TestCases, not if
310
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
311
if setKeepLogfile is not None:
314
def addError(self, test, err):
315
"""Tell result that test finished with an error.
317
Called from the TestCase run() method when the test
318
fails with an unexpected error.
321
unittest.TestResult.addError(self, test, err)
322
self.error_count += 1
323
self.report_error(test, err)
326
self._cleanupLogFile(test)
328
def addFailure(self, test, err):
329
"""Tell result that test failed.
331
Called from the TestCase run() method when the test
332
fails because e.g. an assert() method failed.
335
unittest.TestResult.addFailure(self, test, err)
336
self.failure_count += 1
337
self.report_failure(test, err)
340
self._cleanupLogFile(test)
342
def addSuccess(self, test, details=None):
343
"""Tell result that test completed successfully.
345
Called from the TestCase run()
347
if self._bench_history is not None:
348
benchmark_time = self._extractBenchmarkTime(test, details)
349
if benchmark_time is not None:
350
self._bench_history.write("%s %s\n" % (
351
self._formatTime(benchmark_time),
353
self.report_success(test)
354
self._cleanupLogFile(test)
355
unittest.TestResult.addSuccess(self, test)
356
test._log_contents = ''
358
def addExpectedFailure(self, test, err):
359
self.known_failure_count += 1
360
self.report_known_failure(test, err)
362
def addNotSupported(self, test, feature):
363
"""The test will not be run because of a missing feature.
365
# this can be called in two different ways: it may be that the
366
# test started running, and then raised (through requireFeature)
367
# UnavailableFeature. Alternatively this method can be called
368
# while probing for features before running the test code proper; in
369
# that case we will see startTest and stopTest, but the test will
370
# never actually run.
371
self.unsupported.setdefault(str(feature), 0)
372
self.unsupported[str(feature)] += 1
373
self.report_unsupported(test, feature)
375
def addSkip(self, test, reason):
376
"""A test has not run for 'reason'."""
378
self.report_skip(test, reason)
380
def addNotApplicable(self, test, reason):
381
self.not_applicable_count += 1
382
self.report_not_applicable(test, reason)
384
def _post_mortem(self):
385
"""Start a PDB post mortem session."""
386
if os.environ.get('BZR_TEST_PDB', None):
387
import pdb;pdb.post_mortem()
389
def progress(self, offset, whence):
390
"""The test is adjusting the count of tests to run."""
391
if whence == SUBUNIT_SEEK_SET:
392
self.num_tests = offset
393
elif whence == SUBUNIT_SEEK_CUR:
394
self.num_tests += offset
396
raise errors.BzrError("Unknown whence %r" % whence)
398
def report_cleaning_up(self):
401
def startTestRun(self):
402
self.startTime = time.time()
404
def report_success(self, test):
407
def wasStrictlySuccessful(self):
408
if self.unsupported or self.known_failure_count:
410
return self.wasSuccessful()
413
class TextTestResult(ExtendedTestResult):
414
"""Displays progress and results of tests in text form"""
416
def __init__(self, stream, descriptions, verbosity,
421
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
422
bench_history, strict)
423
# We no longer pass them around, but just rely on the UIFactory stack
426
warnings.warn("Passing pb to TextTestResult is deprecated")
427
self.pb = self.ui.nested_progress_bar()
428
self.pb.show_pct = False
429
self.pb.show_spinner = False
430
self.pb.show_eta = False,
431
self.pb.show_count = False
432
self.pb.show_bar = False
433
self.pb.update_latency = 0
434
self.pb.show_transport_activity = False
436
def stopTestRun(self):
437
# called when the tests that are going to run have run
440
super(TextTestResult, self).stopTestRun()
442
def startTestRun(self):
443
super(TextTestResult, self).startTestRun()
444
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
446
def printErrors(self):
447
# clear the pb to make room for the error listing
449
super(TextTestResult, self).printErrors()
451
def _progress_prefix_text(self):
452
# the longer this text, the less space we have to show the test
454
a = '[%d' % self.count # total that have been run
455
# tests skipped as known not to be relevant are not important enough
457
## if self.skip_count:
458
## a += ', %d skip' % self.skip_count
459
## if self.known_failure_count:
460
## a += '+%dX' % self.known_failure_count
462
a +='/%d' % self.num_tests
464
runtime = time.time() - self._overall_start_time
466
a += '%dm%ds' % (runtime / 60, runtime % 60)
469
total_fail_count = self.error_count + self.failure_count
471
a += ', %d failed' % total_fail_count
472
# if self.unsupported:
473
# a += ', %d missing' % len(self.unsupported)
477
def report_test_start(self, test):
480
self._progress_prefix_text()
482
+ self._shortened_test_description(test))
484
def _test_description(self, test):
485
return self._shortened_test_description(test)
487
def report_error(self, test, err):
488
ui.ui_factory.note('ERROR: %s\n %s\n' % (
489
self._test_description(test),
493
def report_failure(self, test, err):
494
ui.ui_factory.note('FAIL: %s\n %s\n' % (
495
self._test_description(test),
499
def report_known_failure(self, test, err):
502
def report_skip(self, test, reason):
505
def report_not_applicable(self, test, reason):
508
def report_unsupported(self, test, feature):
509
"""test cannot be run because feature is missing."""
511
def report_cleaning_up(self):
512
self.pb.update('Cleaning up')
515
class VerboseTestResult(ExtendedTestResult):
516
"""Produce long output, with one line per test run plus times"""
518
def _ellipsize_to_right(self, a_string, final_width):
519
"""Truncate and pad a string, keeping the right hand side"""
520
if len(a_string) > final_width:
521
result = '...' + a_string[3-final_width:]
524
return result.ljust(final_width)
526
def startTestRun(self):
527
super(VerboseTestResult, self).startTestRun()
528
self.stream.write('running %d tests...\n' % self.num_tests)
530
def report_test_start(self, test):
532
name = self._shortened_test_description(test)
533
width = osutils.terminal_width()
534
if width is not None:
535
# width needs space for 6 char status, plus 1 for slash, plus an
536
# 11-char time string, plus a trailing blank
537
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
539
self.stream.write(self._ellipsize_to_right(name, width-18))
541
self.stream.write(name)
544
def _error_summary(self, err):
546
return '%s%s' % (indent, err[1])
548
def report_error(self, test, err):
549
self.stream.writeln('ERROR %s\n%s'
550
% (self._testTimeString(test),
551
self._error_summary(err)))
553
def report_failure(self, test, err):
554
self.stream.writeln(' FAIL %s\n%s'
555
% (self._testTimeString(test),
556
self._error_summary(err)))
558
def report_known_failure(self, test, err):
559
self.stream.writeln('XFAIL %s\n%s'
560
% (self._testTimeString(test),
561
self._error_summary(err)))
563
def report_success(self, test):
564
self.stream.writeln(' OK %s' % self._testTimeString(test))
565
for bench_called, stats in getattr(test, '_benchcalls', []):
566
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
567
stats.pprint(file=self.stream)
568
# flush the stream so that we get smooth output. This verbose mode is
569
# used to show the output in PQM.
572
def report_skip(self, test, reason):
573
self.stream.writeln(' SKIP %s\n%s'
574
% (self._testTimeString(test), reason))
576
def report_not_applicable(self, test, reason):
577
self.stream.writeln(' N/A %s\n %s'
578
% (self._testTimeString(test), reason))
580
def report_unsupported(self, test, feature):
581
"""test cannot be run because feature is missing."""
582
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
583
%(self._testTimeString(test), feature))
586
class TextTestRunner(object):
587
stop_on_failure = False
595
result_decorators=None,
597
"""Create a TextTestRunner.
599
:param result_decorators: An optional list of decorators to apply
600
to the result object being used by the runner. Decorators are
601
applied left to right - the first element in the list is the
604
# stream may know claim to know to write unicode strings, but in older
605
# pythons this goes sufficiently wrong that it is a bad idea. (
606
# specifically a built in file with encoding 'UTF-8' will still try
607
# to encode using ascii.
608
new_encoding = osutils.get_terminal_encoding()
609
codec = codecs.lookup(new_encoding)
610
if type(codec) is tuple:
614
encode = codec.encode
615
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
616
stream.encoding = new_encoding
617
self.stream = unittest._WritelnDecorator(stream)
618
self.descriptions = descriptions
619
self.verbosity = verbosity
620
self._bench_history = bench_history
621
self._strict = strict
622
self._result_decorators = result_decorators or []
625
"Run the given test case or test suite."
626
if self.verbosity == 1:
627
result_class = TextTestResult
628
elif self.verbosity >= 2:
629
result_class = VerboseTestResult
630
original_result = result_class(self.stream,
633
bench_history=self._bench_history,
636
# Signal to result objects that look at stop early policy to stop,
637
original_result.stop_early = self.stop_on_failure
638
result = original_result
639
for decorator in self._result_decorators:
640
result = decorator(result)
641
result.stop_early = self.stop_on_failure
642
result.startTestRun()
647
# higher level code uses our extended protocol to determine
648
# what exit code to give.
649
return original_result
652
def iter_suite_tests(suite):
653
"""Return all tests in a suite, recursing through nested suites"""
654
if isinstance(suite, unittest.TestCase):
656
elif isinstance(suite, unittest.TestSuite):
658
for r in iter_suite_tests(item):
661
raise Exception('unknown type %r for object %r'
662
% (type(suite), suite))
665
TestSkipped = testtools.testcase.TestSkipped
668
class TestNotApplicable(TestSkipped):
669
"""A test is not applicable to the situation where it was run.
671
This is only normally raised by parameterized tests, if they find that
672
the instance they're constructed upon does not support one aspect
677
# traceback._some_str fails to format exceptions that have the default
678
# __str__ which does an implicit ascii conversion. However, repr() on those
679
# objects works, for all that its not quite what the doctor may have ordered.
680
def _clever_some_str(value):
685
return repr(value).replace('\\n', '\n')
687
return '<unprintable %s object>' % type(value).__name__
689
traceback._some_str = _clever_some_str
692
# deprecated - use self.knownFailure(), or self.expectFailure.
693
KnownFailure = testtools.testcase._ExpectedFailure
696
class UnavailableFeature(Exception):
697
"""A feature required for this test was not available.
699
This can be considered a specialised form of SkippedTest.
701
The feature should be used to construct the exception.
705
class CommandFailed(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, server.SmartTCPServer_for_testing):
1048
# The smart server adds a path similar to work, which is traversed
1049
# up from by the client. But the server is chrooted - the actual
1050
# backing transport is not escaped from, and VFS requests to the
1051
# root will error (because they try to escape the chroot).
1053
while t2.base != t.base:
1056
self.permit_url(t.base)
1058
def _track_transports(self):
1059
"""Install checks for transport usage."""
1060
# TestCase has no safe place it can write to.
1061
self._bzr_selftest_roots = []
1062
# Currently the easiest way to be sure that nothing is going on is to
1063
# hook into bzr dir opening. This leaves a small window of error for
1064
# transport tests, but they are well known, and we can improve on this
1066
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1067
self._preopen_isolate_transport, "Check bzr directories are safe.")
1069
def _ndiff_strings(self, a, b):
1070
"""Return ndiff between two strings containing lines.
1072
A trailing newline is added if missing to make the strings
1074
if b and b[-1] != '\n':
1076
if a and a[-1] != '\n':
1078
difflines = difflib.ndiff(a.splitlines(True),
1080
linejunk=lambda x: False,
1081
charjunk=lambda x: False)
1082
return ''.join(difflines)
1084
def assertEqual(self, a, b, message=''):
1088
except UnicodeError, e:
1089
# If we can't compare without getting a UnicodeError, then
1090
# obviously they are different
1091
mutter('UnicodeError: %s', e)
1094
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1096
pformat(a), pformat(b)))
1098
assertEquals = assertEqual
1100
def assertEqualDiff(self, a, b, message=None):
1101
"""Assert two texts are equal, if not raise an exception.
1103
This is intended for use with multi-line strings where it can
1104
be hard to find the differences by eye.
1106
# TODO: perhaps override assertEquals to call this for strings?
1110
message = "texts not equal:\n"
1112
message = 'first string is missing a final newline.\n'
1114
message = 'second string is missing a final newline.\n'
1115
raise AssertionError(message +
1116
self._ndiff_strings(a, b))
1118
def assertEqualMode(self, mode, mode_test):
1119
self.assertEqual(mode, mode_test,
1120
'mode mismatch %o != %o' % (mode, mode_test))
1122
def assertEqualStat(self, expected, actual):
1123
"""assert that expected and actual are the same stat result.
1125
:param expected: A stat result.
1126
:param actual: A stat result.
1127
:raises AssertionError: If the expected and actual stat values differ
1128
other than by atime.
1130
self.assertEqual(expected.st_size, actual.st_size,
1131
'st_size did not match')
1132
self.assertEqual(expected.st_mtime, actual.st_mtime,
1133
'st_mtime did not match')
1134
self.assertEqual(expected.st_ctime, actual.st_ctime,
1135
'st_ctime did not match')
1136
if sys.platform != 'win32':
1137
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1138
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1139
# odd. Regardless we shouldn't actually try to assert anything
1140
# about their values
1141
self.assertEqual(expected.st_dev, actual.st_dev,
1142
'st_dev did not match')
1143
self.assertEqual(expected.st_ino, actual.st_ino,
1144
'st_ino did not match')
1145
self.assertEqual(expected.st_mode, actual.st_mode,
1146
'st_mode did not match')
1148
def assertLength(self, length, obj_with_len):
1149
"""Assert that obj_with_len is of length length."""
1150
if len(obj_with_len) != length:
1151
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1152
length, len(obj_with_len), obj_with_len))
1154
def assertLogsError(self, exception_class, func, *args, **kwargs):
1155
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1157
from bzrlib import trace
1159
orig_log_exception_quietly = trace.log_exception_quietly
1162
orig_log_exception_quietly()
1163
captured.append(sys.exc_info())
1164
trace.log_exception_quietly = capture
1165
func(*args, **kwargs)
1167
trace.log_exception_quietly = orig_log_exception_quietly
1168
self.assertLength(1, captured)
1169
err = captured[0][1]
1170
self.assertIsInstance(err, exception_class)
1173
def assertPositive(self, val):
1174
"""Assert that val is greater than 0."""
1175
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1177
def assertNegative(self, val):
1178
"""Assert that val is less than 0."""
1179
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1181
def assertStartsWith(self, s, prefix):
1182
if not s.startswith(prefix):
1183
raise AssertionError('string %r does not start with %r' % (s, prefix))
1185
def assertEndsWith(self, s, suffix):
1186
"""Asserts that s ends with suffix."""
1187
if not s.endswith(suffix):
1188
raise AssertionError('string %r does not end with %r' % (s, suffix))
1190
def assertContainsRe(self, haystack, needle_re, flags=0):
1191
"""Assert that a contains something matching a regular expression."""
1192
if not re.search(needle_re, haystack, flags):
1193
if '\n' in haystack or len(haystack) > 60:
1194
# a long string, format it in a more readable way
1195
raise AssertionError(
1196
'pattern "%s" not found in\n"""\\\n%s"""\n'
1197
% (needle_re, haystack))
1199
raise AssertionError('pattern "%s" not found in "%s"'
1200
% (needle_re, haystack))
1202
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1203
"""Assert that a does not match a regular expression"""
1204
if re.search(needle_re, haystack, flags):
1205
raise AssertionError('pattern "%s" found in "%s"'
1206
% (needle_re, haystack))
1208
def assertSubset(self, sublist, superlist):
1209
"""Assert that every entry in sublist is present in superlist."""
1210
missing = set(sublist) - set(superlist)
1211
if len(missing) > 0:
1212
raise AssertionError("value(s) %r not present in container %r" %
1213
(missing, superlist))
1215
def assertListRaises(self, excClass, func, *args, **kwargs):
1216
"""Fail unless excClass is raised when the iterator from func is used.
1218
Many functions can return generators this makes sure
1219
to wrap them in a list() call to make sure the whole generator
1220
is run, and that the proper exception is raised.
1223
list(func(*args, **kwargs))
1227
if getattr(excClass,'__name__', None) is not None:
1228
excName = excClass.__name__
1230
excName = str(excClass)
1231
raise self.failureException, "%s not raised" % excName
1233
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1234
"""Assert that a callable raises a particular exception.
1236
:param excClass: As for the except statement, this may be either an
1237
exception class, or a tuple of classes.
1238
:param callableObj: A callable, will be passed ``*args`` and
1241
Returns the exception so that you can examine it.
1244
callableObj(*args, **kwargs)
1248
if getattr(excClass,'__name__', None) is not None:
1249
excName = excClass.__name__
1252
excName = str(excClass)
1253
raise self.failureException, "%s not raised" % excName
1255
def assertIs(self, left, right, message=None):
1256
if not (left is right):
1257
if message is not None:
1258
raise AssertionError(message)
1260
raise AssertionError("%r is not %r." % (left, right))
1262
def assertIsNot(self, left, right, message=None):
1264
if message is not None:
1265
raise AssertionError(message)
1267
raise AssertionError("%r is %r." % (left, right))
1269
def assertTransportMode(self, transport, path, mode):
1270
"""Fail if a path does not have mode "mode".
1272
If modes are not supported on this transport, the assertion is ignored.
1274
if not transport._can_roundtrip_unix_modebits():
1276
path_stat = transport.stat(path)
1277
actual_mode = stat.S_IMODE(path_stat.st_mode)
1278
self.assertEqual(mode, actual_mode,
1279
'mode of %r incorrect (%s != %s)'
1280
% (path, oct(mode), oct(actual_mode)))
1282
def assertIsSameRealPath(self, path1, path2):
1283
"""Fail if path1 and path2 points to different files"""
1284
self.assertEqual(osutils.realpath(path1),
1285
osutils.realpath(path2),
1286
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1288
def assertIsInstance(self, obj, kls, msg=None):
1289
"""Fail if obj is not an instance of kls
1291
:param msg: Supplementary message to show if the assertion fails.
1293
if not isinstance(obj, kls):
1294
m = "%r is an instance of %s rather than %s" % (
1295
obj, obj.__class__, kls)
1300
def assertFileEqual(self, content, path):
1301
"""Fail if path does not contain 'content'."""
1302
self.failUnlessExists(path)
1303
f = file(path, 'rb')
1308
self.assertEqualDiff(content, s)
1310
def failUnlessExists(self, path):
1311
"""Fail unless path or paths, which may be abs or relative, exist."""
1312
if not isinstance(path, basestring):
1314
self.failUnlessExists(p)
1316
self.failUnless(osutils.lexists(path),path+" does not exist")
1318
def failIfExists(self, path):
1319
"""Fail if path or paths, which may be abs or relative, exist."""
1320
if not isinstance(path, basestring):
1322
self.failIfExists(p)
1324
self.failIf(osutils.lexists(path),path+" exists")
1326
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1327
"""A helper for callDeprecated and applyDeprecated.
1329
:param a_callable: A callable to call.
1330
:param args: The positional arguments for the callable
1331
:param kwargs: The keyword arguments for the callable
1332
:return: A tuple (warnings, result). result is the result of calling
1333
a_callable(``*args``, ``**kwargs``).
1336
def capture_warnings(msg, cls=None, stacklevel=None):
1337
# we've hooked into a deprecation specific callpath,
1338
# only deprecations should getting sent via it.
1339
self.assertEqual(cls, DeprecationWarning)
1340
local_warnings.append(msg)
1341
original_warning_method = symbol_versioning.warn
1342
symbol_versioning.set_warning_method(capture_warnings)
1344
result = a_callable(*args, **kwargs)
1346
symbol_versioning.set_warning_method(original_warning_method)
1347
return (local_warnings, result)
1349
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1350
"""Call a deprecated callable without warning the user.
1352
Note that this only captures warnings raised by symbol_versioning.warn,
1353
not other callers that go direct to the warning module.
1355
To test that a deprecated method raises an error, do something like
1358
self.assertRaises(errors.ReservedId,
1359
self.applyDeprecated,
1360
deprecated_in((1, 5, 0)),
1364
:param deprecation_format: The deprecation format that the callable
1365
should have been deprecated with. This is the same type as the
1366
parameter to deprecated_method/deprecated_function. If the
1367
callable is not deprecated with this format, an assertion error
1369
:param a_callable: A callable to call. This may be a bound method or
1370
a regular function. It will be called with ``*args`` and
1372
:param args: The positional arguments for the callable
1373
:param kwargs: The keyword arguments for the callable
1374
:return: The result of a_callable(``*args``, ``**kwargs``)
1376
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1378
expected_first_warning = symbol_versioning.deprecation_string(
1379
a_callable, deprecation_format)
1380
if len(call_warnings) == 0:
1381
self.fail("No deprecation warning generated by call to %s" %
1383
self.assertEqual(expected_first_warning, call_warnings[0])
1386
def callCatchWarnings(self, fn, *args, **kw):
1387
"""Call a callable that raises python warnings.
1389
The caller's responsible for examining the returned warnings.
1391
If the callable raises an exception, the exception is not
1392
caught and propagates up to the caller. In that case, the list
1393
of warnings is not available.
1395
:returns: ([warning_object, ...], fn_result)
1397
# XXX: This is not perfect, because it completely overrides the
1398
# warnings filters, and some code may depend on suppressing particular
1399
# warnings. It's the easiest way to insulate ourselves from -Werror,
1400
# though. -- Andrew, 20071062
1402
def _catcher(message, category, filename, lineno, file=None, line=None):
1403
# despite the name, 'message' is normally(?) a Warning subclass
1405
wlist.append(message)
1406
saved_showwarning = warnings.showwarning
1407
saved_filters = warnings.filters
1409
warnings.showwarning = _catcher
1410
warnings.filters = []
1411
result = fn(*args, **kw)
1413
warnings.showwarning = saved_showwarning
1414
warnings.filters = saved_filters
1415
return wlist, result
1417
def callDeprecated(self, expected, callable, *args, **kwargs):
1418
"""Assert that a callable is deprecated in a particular way.
1420
This is a very precise test for unusual requirements. The
1421
applyDeprecated helper function is probably more suited for most tests
1422
as it allows you to simply specify the deprecation format being used
1423
and will ensure that that is issued for the function being called.
1425
Note that this only captures warnings raised by symbol_versioning.warn,
1426
not other callers that go direct to the warning module. To catch
1427
general warnings, use callCatchWarnings.
1429
:param expected: a list of the deprecation warnings expected, in order
1430
:param callable: The callable to call
1431
:param args: The positional arguments for the callable
1432
:param kwargs: The keyword arguments for the callable
1434
call_warnings, result = self._capture_deprecation_warnings(callable,
1436
self.assertEqual(expected, call_warnings)
1439
def _startLogFile(self):
1440
"""Send bzr and test log messages to a temporary file.
1442
The file is removed as the test is torn down.
1444
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1445
self._log_file = os.fdopen(fileno, 'w+')
1446
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1447
self._log_file_name = name
1448
self.addCleanup(self._finishLogFile)
1450
def _finishLogFile(self):
1451
"""Finished with the log file.
1453
Close the file and delete it, unless setKeepLogfile was called.
1455
if bzrlib.trace._trace_file:
1456
# flush the log file, to get all content
1457
bzrlib.trace._trace_file.flush()
1458
bzrlib.trace.pop_log_file(self._log_memento)
1459
# Cache the log result and delete the file on disk
1460
self._get_log(False)
1462
def thisFailsStrictLockCheck(self):
1463
"""It is known that this test would fail with -Dstrict_locks.
1465
By default, all tests are run with strict lock checking unless
1466
-Edisable_lock_checks is supplied. However there are some tests which
1467
we know fail strict locks at this point that have not been fixed.
1468
They should call this function to disable the strict checking.
1470
This should be used sparingly, it is much better to fix the locking
1471
issues rather than papering over the problem by calling this function.
1473
debug.debug_flags.discard('strict_locks')
1475
def addCleanup(self, callable, *args, **kwargs):
1476
"""Arrange to run a callable when this case is torn down.
1478
Callables are run in the reverse of the order they are registered,
1479
ie last-in first-out.
1481
self._cleanups.append((callable, args, kwargs))
1483
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1484
"""Overrides an object attribute restoring it after the test.
1486
:param obj: The object that will be mutated.
1488
:param attr_name: The attribute name we want to preserve/override in
1491
:param new: The optional value we want to set the attribute to.
1493
:returns: The actual attr value.
1495
value = getattr(obj, attr_name)
1496
# The actual value is captured by the call below
1497
self.addCleanup(setattr, obj, attr_name, value)
1498
if new is not _unitialized_attr:
1499
setattr(obj, attr_name, new)
1502
def _cleanEnvironment(self):
1504
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1505
'HOME': os.getcwd(),
1506
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1507
# tests do check our impls match APPDATA
1508
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1512
'BZREMAIL': None, # may still be present in the environment
1514
'BZR_PROGRESS_BAR': None,
1516
'BZR_PLUGIN_PATH': None,
1517
'BZR_CONCURRENCY': None,
1518
# Make sure that any text ui tests are consistent regardless of
1519
# the environment the test case is run in; you may want tests that
1520
# test other combinations. 'dumb' is a reasonable guess for tests
1521
# going to a pipe or a StringIO.
1525
'BZR_COLUMNS': '80',
1527
'SSH_AUTH_SOCK': None,
1531
'https_proxy': None,
1532
'HTTPS_PROXY': None,
1537
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1538
# least. If you do (care), please update this comment
1542
'BZR_REMOTE_PATH': None,
1543
# Generally speaking, we don't want apport reporting on crashes in
1544
# the test envirnoment unless we're specifically testing apport,
1545
# so that it doesn't leak into the real system environment. We
1546
# use an env var so it propagates to subprocesses.
1547
'APPORT_DISABLE': '1',
1550
self.addCleanup(self._restoreEnvironment)
1551
for name, value in new_env.iteritems():
1552
self._captureVar(name, value)
1554
def _captureVar(self, name, newvalue):
1555
"""Set an environment variable, and reset it when finished."""
1556
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1558
def _restoreEnvironment(self):
1559
for name, value in self.__old_env.iteritems():
1560
osutils.set_or_unset_env(name, value)
1562
def _restoreHooks(self):
1563
for klass, (name, hooks) in self._preserved_hooks.items():
1564
setattr(klass, name, hooks)
1566
def knownFailure(self, reason):
1567
"""This test has failed for some known reason."""
1568
raise KnownFailure(reason)
1570
def _do_skip(self, result, reason):
1571
addSkip = getattr(result, 'addSkip', None)
1572
if not callable(addSkip):
1573
result.addSuccess(result)
1575
addSkip(self, reason)
1578
def _do_known_failure(self, result, e):
1579
err = sys.exc_info()
1580
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1581
if addExpectedFailure is not None:
1582
addExpectedFailure(self, err)
1584
result.addSuccess(self)
1587
def _do_not_applicable(self, result, e):
1589
reason = 'No reason given'
1592
addNotApplicable = getattr(result, 'addNotApplicable', None)
1593
if addNotApplicable is not None:
1594
result.addNotApplicable(self, reason)
1596
self._do_skip(result, reason)
1599
def _do_unsupported_or_skip(self, result, e):
1601
addNotSupported = getattr(result, 'addNotSupported', None)
1602
if addNotSupported is not None:
1603
result.addNotSupported(self, reason)
1605
self._do_skip(result, reason)
1607
def time(self, callable, *args, **kwargs):
1608
"""Run callable and accrue the time it takes to the benchmark time.
1610
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1611
this will cause lsprofile statistics to be gathered and stored in
1614
if self._benchtime is None:
1615
self.addDetail('benchtime', content.Content(content.ContentType(
1616
"text", "plain"), lambda:[str(self._benchtime)]))
1620
if not self._gather_lsprof_in_benchmarks:
1621
return callable(*args, **kwargs)
1623
# record this benchmark
1624
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1626
self._benchcalls.append(((callable, args, kwargs), stats))
1629
self._benchtime += time.time() - start
1631
def log(self, *args):
1634
def _get_log(self, keep_log_file=False):
1635
"""Internal helper to get the log from bzrlib.trace for this test.
1637
Please use self.getDetails, or self.get_log to access this in test case
1640
:param keep_log_file: When True, if the log is still a file on disk
1641
leave it as a file on disk. When False, if the log is still a file
1642
on disk, the log file is deleted and the log preserved as
1644
:return: A string containing the log.
1646
if self._log_contents is not None:
1648
self._log_contents.decode('utf8')
1649
except UnicodeDecodeError:
1650
unicodestr = self._log_contents.decode('utf8', 'replace')
1651
self._log_contents = unicodestr.encode('utf8')
1652
return self._log_contents
1654
if bzrlib.trace._trace_file:
1655
# flush the log file, to get all content
1656
bzrlib.trace._trace_file.flush()
1657
if self._log_file_name is not None:
1658
logfile = open(self._log_file_name)
1660
log_contents = logfile.read()
1664
log_contents.decode('utf8')
1665
except UnicodeDecodeError:
1666
unicodestr = log_contents.decode('utf8', 'replace')
1667
log_contents = unicodestr.encode('utf8')
1668
if not keep_log_file:
1669
self._log_file.close()
1670
self._log_file = None
1671
# Permit multiple calls to get_log until we clean it up in
1673
self._log_contents = log_contents
1675
os.remove(self._log_file_name)
1677
if sys.platform == 'win32' and e.errno == errno.EACCES:
1678
sys.stderr.write(('Unable to delete log file '
1679
' %r\n' % self._log_file_name))
1682
self._log_file_name = None
1685
return "No log file content and no log file name."
1688
"""Get a unicode string containing the log from bzrlib.trace.
1690
Undecodable characters are replaced.
1692
return u"".join(self.getDetails()['log'].iter_text())
1694
def requireFeature(self, feature):
1695
"""This test requires a specific feature is available.
1697
:raises UnavailableFeature: When feature is not available.
1699
if not feature.available():
1700
raise UnavailableFeature(feature)
1702
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1704
"""Run bazaar command line, splitting up a string command line."""
1705
if isinstance(args, basestring):
1706
# shlex don't understand unicode strings,
1707
# so args should be plain string (bialix 20070906)
1708
args = list(shlex.split(str(args)))
1709
return self._run_bzr_core(args, retcode=retcode,
1710
encoding=encoding, stdin=stdin, working_dir=working_dir,
1713
def _run_bzr_core(self, args, retcode, encoding, stdin,
1715
# Clear chk_map page cache, because the contents are likely to mask
1717
chk_map.clear_cache()
1718
if encoding is None:
1719
encoding = osutils.get_user_encoding()
1720
stdout = StringIOWrapper()
1721
stderr = StringIOWrapper()
1722
stdout.encoding = encoding
1723
stderr.encoding = encoding
1725
self.log('run bzr: %r', args)
1726
# FIXME: don't call into logging here
1727
handler = logging.StreamHandler(stderr)
1728
handler.setLevel(logging.INFO)
1729
logger = logging.getLogger('')
1730
logger.addHandler(handler)
1731
old_ui_factory = ui.ui_factory
1732
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1735
if working_dir is not None:
1736
cwd = osutils.getcwd()
1737
os.chdir(working_dir)
1741
result = self.apply_redirected(ui.ui_factory.stdin,
1743
bzrlib.commands.run_bzr_catch_user_errors,
1745
except KeyboardInterrupt:
1746
# Reraise KeyboardInterrupt with contents of redirected stdout
1747
# and stderr as arguments, for tests which are interested in
1748
# stdout and stderr and are expecting the exception.
1749
out = stdout.getvalue()
1750
err = stderr.getvalue()
1752
self.log('output:\n%r', out)
1754
self.log('errors:\n%r', err)
1755
raise KeyboardInterrupt(out, err)
1757
logger.removeHandler(handler)
1758
ui.ui_factory = old_ui_factory
1762
out = stdout.getvalue()
1763
err = stderr.getvalue()
1765
self.log('output:\n%r', out)
1767
self.log('errors:\n%r', err)
1768
if retcode is not None:
1769
self.assertEquals(retcode, result,
1770
message='Unexpected return code')
1771
return result, out, err
1773
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1774
working_dir=None, error_regexes=[], output_encoding=None):
1775
"""Invoke bzr, as if it were run from the command line.
1777
The argument list should not include the bzr program name - the
1778
first argument is normally the bzr command. Arguments may be
1779
passed in three ways:
1781
1- A list of strings, eg ["commit", "a"]. This is recommended
1782
when the command contains whitespace or metacharacters, or
1783
is built up at run time.
1785
2- A single string, eg "add a". This is the most convenient
1786
for hardcoded commands.
1788
This runs bzr through the interface that catches and reports
1789
errors, and with logging set to something approximating the
1790
default, so that error reporting can be checked.
1792
This should be the main method for tests that want to exercise the
1793
overall behavior of the bzr application (rather than a unit test
1794
or a functional test of the library.)
1796
This sends the stdout/stderr results into the test's log,
1797
where it may be useful for debugging. See also run_captured.
1799
:keyword stdin: A string to be used as stdin for the command.
1800
:keyword retcode: The status code the command should return;
1802
:keyword working_dir: The directory to run the command in
1803
:keyword error_regexes: A list of expected error messages. If
1804
specified they must be seen in the error output of the command.
1806
retcode, out, err = self._run_bzr_autosplit(
1811
working_dir=working_dir,
1813
self.assertIsInstance(error_regexes, (list, tuple))
1814
for regex in error_regexes:
1815
self.assertContainsRe(err, regex)
1818
def run_bzr_error(self, error_regexes, *args, **kwargs):
1819
"""Run bzr, and check that stderr contains the supplied regexes
1821
:param error_regexes: Sequence of regular expressions which
1822
must each be found in the error output. The relative ordering
1824
:param args: command-line arguments for bzr
1825
:param kwargs: Keyword arguments which are interpreted by run_bzr
1826
This function changes the default value of retcode to be 3,
1827
since in most cases this is run when you expect bzr to fail.
1829
:return: (out, err) The actual output of running the command (in case
1830
you want to do more inspection)
1834
# Make sure that commit is failing because there is nothing to do
1835
self.run_bzr_error(['no changes to commit'],
1836
['commit', '-m', 'my commit comment'])
1837
# Make sure --strict is handling an unknown file, rather than
1838
# giving us the 'nothing to do' error
1839
self.build_tree(['unknown'])
1840
self.run_bzr_error(['Commit refused because there are unknown files'],
1841
['commit', --strict', '-m', 'my commit comment'])
1843
kwargs.setdefault('retcode', 3)
1844
kwargs['error_regexes'] = error_regexes
1845
out, err = self.run_bzr(*args, **kwargs)
1848
def run_bzr_subprocess(self, *args, **kwargs):
1849
"""Run bzr in a subprocess for testing.
1851
This starts a new Python interpreter and runs bzr in there.
1852
This should only be used for tests that have a justifiable need for
1853
this isolation: e.g. they are testing startup time, or signal
1854
handling, or early startup code, etc. Subprocess code can't be
1855
profiled or debugged so easily.
1857
:keyword retcode: The status code that is expected. Defaults to 0. If
1858
None is supplied, the status code is not checked.
1859
:keyword env_changes: A dictionary which lists changes to environment
1860
variables. A value of None will unset the env variable.
1861
The values must be strings. The change will only occur in the
1862
child, so you don't need to fix the environment after running.
1863
:keyword universal_newlines: Convert CRLF => LF
1864
:keyword allow_plugins: By default the subprocess is run with
1865
--no-plugins to ensure test reproducibility. Also, it is possible
1866
for system-wide plugins to create unexpected output on stderr,
1867
which can cause unnecessary test failures.
1869
env_changes = kwargs.get('env_changes', {})
1870
working_dir = kwargs.get('working_dir', None)
1871
allow_plugins = kwargs.get('allow_plugins', False)
1873
if isinstance(args[0], list):
1875
elif isinstance(args[0], basestring):
1876
args = list(shlex.split(args[0]))
1878
raise ValueError("passing varargs to run_bzr_subprocess")
1879
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1880
working_dir=working_dir,
1881
allow_plugins=allow_plugins)
1882
# We distinguish between retcode=None and retcode not passed.
1883
supplied_retcode = kwargs.get('retcode', 0)
1884
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1885
universal_newlines=kwargs.get('universal_newlines', False),
1888
def start_bzr_subprocess(self, process_args, env_changes=None,
1889
skip_if_plan_to_signal=False,
1891
allow_plugins=False):
1892
"""Start bzr in a subprocess for testing.
1894
This starts a new Python interpreter and runs bzr in there.
1895
This should only be used for tests that have a justifiable need for
1896
this isolation: e.g. they are testing startup time, or signal
1897
handling, or early startup code, etc. Subprocess code can't be
1898
profiled or debugged so easily.
1900
:param process_args: a list of arguments to pass to the bzr executable,
1901
for example ``['--version']``.
1902
:param env_changes: A dictionary which lists changes to environment
1903
variables. A value of None will unset the env variable.
1904
The values must be strings. The change will only occur in the
1905
child, so you don't need to fix the environment after running.
1906
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1908
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1910
:returns: Popen object for the started process.
1912
if skip_if_plan_to_signal:
1913
if not getattr(os, 'kill', None):
1914
raise TestSkipped("os.kill not available.")
1916
if env_changes is None:
1920
def cleanup_environment():
1921
for env_var, value in env_changes.iteritems():
1922
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1924
def restore_environment():
1925
for env_var, value in old_env.iteritems():
1926
osutils.set_or_unset_env(env_var, value)
1928
bzr_path = self.get_bzr_path()
1931
if working_dir is not None:
1932
cwd = osutils.getcwd()
1933
os.chdir(working_dir)
1936
# win32 subprocess doesn't support preexec_fn
1937
# so we will avoid using it on all platforms, just to
1938
# make sure the code path is used, and we don't break on win32
1939
cleanup_environment()
1940
command = [sys.executable]
1941
# frozen executables don't need the path to bzr
1942
if getattr(sys, "frozen", None) is None:
1943
command.append(bzr_path)
1944
if not allow_plugins:
1945
command.append('--no-plugins')
1946
command.extend(process_args)
1947
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1949
restore_environment()
1955
def _popen(self, *args, **kwargs):
1956
"""Place a call to Popen.
1958
Allows tests to override this method to intercept the calls made to
1959
Popen for introspection.
1961
return Popen(*args, **kwargs)
1963
def get_source_path(self):
1964
"""Return the path of the directory containing bzrlib."""
1965
return os.path.dirname(os.path.dirname(bzrlib.__file__))
1967
def get_bzr_path(self):
1968
"""Return the path of the 'bzr' executable for this test suite."""
1969
bzr_path = self.get_source_path()+'/bzr'
1970
if not os.path.isfile(bzr_path):
1971
# We are probably installed. Assume sys.argv is the right file
1972
bzr_path = sys.argv[0]
1975
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1976
universal_newlines=False, process_args=None):
1977
"""Finish the execution of process.
1979
:param process: the Popen object returned from start_bzr_subprocess.
1980
:param retcode: The status code that is expected. Defaults to 0. If
1981
None is supplied, the status code is not checked.
1982
:param send_signal: an optional signal to send to the process.
1983
:param universal_newlines: Convert CRLF => LF
1984
:returns: (stdout, stderr)
1986
if send_signal is not None:
1987
os.kill(process.pid, send_signal)
1988
out, err = process.communicate()
1990
if universal_newlines:
1991
out = out.replace('\r\n', '\n')
1992
err = err.replace('\r\n', '\n')
1994
if retcode is not None and retcode != process.returncode:
1995
if process_args is None:
1996
process_args = "(unknown args)"
1997
mutter('Output of bzr %s:\n%s', process_args, out)
1998
mutter('Error for bzr %s:\n%s', process_args, err)
1999
self.fail('Command bzr %s failed with retcode %s != %s'
2000
% (process_args, retcode, process.returncode))
2003
def check_inventory_shape(self, inv, shape):
2004
"""Compare an inventory to a list of expected names.
2006
Fail if they are not precisely equal.
2009
shape = list(shape) # copy
2010
for path, ie in inv.entries():
2011
name = path.replace('\\', '/')
2012
if ie.kind == 'directory':
2019
self.fail("expected paths not found in inventory: %r" % shape)
2021
self.fail("unexpected paths found in inventory: %r" % extras)
2023
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2024
a_callable=None, *args, **kwargs):
2025
"""Call callable with redirected std io pipes.
2027
Returns the return code."""
2028
if not callable(a_callable):
2029
raise ValueError("a_callable must be callable.")
2031
stdin = StringIO("")
2033
if getattr(self, "_log_file", None) is not None:
2034
stdout = self._log_file
2038
if getattr(self, "_log_file", None is not None):
2039
stderr = self._log_file
2042
real_stdin = sys.stdin
2043
real_stdout = sys.stdout
2044
real_stderr = sys.stderr
2049
return a_callable(*args, **kwargs)
2051
sys.stdout = real_stdout
2052
sys.stderr = real_stderr
2053
sys.stdin = real_stdin
2055
def reduceLockdirTimeout(self):
2056
"""Reduce the default lock timeout for the duration of the test, so that
2057
if LockContention occurs during a test, it does so quickly.
2059
Tests that expect to provoke LockContention errors should call this.
2061
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2063
def make_utf8_encoded_stringio(self, encoding_type=None):
2064
"""Return a StringIOWrapper instance, that will encode Unicode
2067
if encoding_type is None:
2068
encoding_type = 'strict'
2070
output_encoding = 'utf-8'
2071
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2072
sio.encoding = output_encoding
2075
def disable_verb(self, verb):
2076
"""Disable a smart server verb for one test."""
2077
from bzrlib.smart import request
2078
request_handlers = request.request_handlers
2079
orig_method = request_handlers.get(verb)
2080
request_handlers.remove(verb)
2081
self.addCleanup(request_handlers.register, verb, orig_method)
2084
class CapturedCall(object):
2085
"""A helper for capturing smart server calls for easy debug analysis."""
2087
def __init__(self, params, prefix_length):
2088
"""Capture the call with params and skip prefix_length stack frames."""
2091
# The last 5 frames are the __init__, the hook frame, and 3 smart
2092
# client frames. Beyond this we could get more clever, but this is good
2094
stack = traceback.extract_stack()[prefix_length:-5]
2095
self.stack = ''.join(traceback.format_list(stack))
2098
return self.call.method
2101
return self.call.method
2107
class TestCaseWithMemoryTransport(TestCase):
2108
"""Common test class for tests that do not need disk resources.
2110
Tests that need disk resources should derive from TestCaseWithTransport.
2112
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2114
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2115
a directory which does not exist. This serves to help ensure test isolation
2116
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2117
must exist. However, TestCaseWithMemoryTransport does not offer local
2118
file defaults for the transport in tests, nor does it obey the command line
2119
override, so tests that accidentally write to the common directory should
2122
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2123
a .bzr directory that stops us ascending higher into the filesystem.
2129
def __init__(self, methodName='runTest'):
2130
# allow test parameterization after test construction and before test
2131
# execution. Variables that the parameterizer sets need to be
2132
# ones that are not set by setUp, or setUp will trash them.
2133
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2134
self.vfs_transport_factory = default_transport
2135
self.transport_server = None
2136
self.transport_readonly_server = None
2137
self.__vfs_server = None
2139
def get_transport(self, relpath=None):
2140
"""Return a writeable transport.
2142
This transport is for the test scratch space relative to
2145
:param relpath: a path relative to the base url.
2147
t = get_transport(self.get_url(relpath))
2148
self.assertFalse(t.is_readonly())
2151
def get_readonly_transport(self, relpath=None):
2152
"""Return a readonly transport for the test scratch space
2154
This can be used to test that operations which should only need
2155
readonly access in fact do not try to write.
2157
:param relpath: a path relative to the base url.
2159
t = get_transport(self.get_readonly_url(relpath))
2160
self.assertTrue(t.is_readonly())
2163
def create_transport_readonly_server(self):
2164
"""Create a transport server from class defined at init.
2166
This is mostly a hook for daughter classes.
2168
return self.transport_readonly_server()
2170
def get_readonly_server(self):
2171
"""Get the server instance for the readonly transport
2173
This is useful for some tests with specific servers to do diagnostics.
2175
if self.__readonly_server is None:
2176
if self.transport_readonly_server is None:
2177
# readonly decorator requested
2178
self.__readonly_server = ReadonlyServer()
2180
# explicit readonly transport.
2181
self.__readonly_server = self.create_transport_readonly_server()
2182
self.start_server(self.__readonly_server,
2183
self.get_vfs_only_server())
2184
return self.__readonly_server
2186
def get_readonly_url(self, relpath=None):
2187
"""Get a URL for the readonly transport.
2189
This will either be backed by '.' or a decorator to the transport
2190
used by self.get_url()
2191
relpath provides for clients to get a path relative to the base url.
2192
These should only be downwards relative, not upwards.
2194
base = self.get_readonly_server().get_url()
2195
return self._adjust_url(base, relpath)
2197
def get_vfs_only_server(self):
2198
"""Get the vfs only read/write server instance.
2200
This is useful for some tests with specific servers that need
2203
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2204
is no means to override it.
2206
if self.__vfs_server is None:
2207
self.__vfs_server = MemoryServer()
2208
self.start_server(self.__vfs_server)
2209
return self.__vfs_server
2211
def get_server(self):
2212
"""Get the read/write server instance.
2214
This is useful for some tests with specific servers that need
2217
This is built from the self.transport_server factory. If that is None,
2218
then the self.get_vfs_server is returned.
2220
if self.__server is None:
2221
if (self.transport_server is None or self.transport_server is
2222
self.vfs_transport_factory):
2223
self.__server = self.get_vfs_only_server()
2225
# bring up a decorated means of access to the vfs only server.
2226
self.__server = self.transport_server()
2227
self.start_server(self.__server, self.get_vfs_only_server())
2228
return self.__server
2230
def _adjust_url(self, base, relpath):
2231
"""Get a URL (or maybe a path) for the readwrite transport.
2233
This will either be backed by '.' or to an equivalent non-file based
2235
relpath provides for clients to get a path relative to the base url.
2236
These should only be downwards relative, not upwards.
2238
if relpath is not None and relpath != '.':
2239
if not base.endswith('/'):
2241
# XXX: Really base should be a url; we did after all call
2242
# get_url()! But sometimes it's just a path (from
2243
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2244
# to a non-escaped local path.
2245
if base.startswith('./') or base.startswith('/'):
2248
base += urlutils.escape(relpath)
2251
def get_url(self, relpath=None):
2252
"""Get a URL (or maybe a path) for the readwrite transport.
2254
This will either be backed by '.' or to an equivalent non-file based
2256
relpath provides for clients to get a path relative to the base url.
2257
These should only be downwards relative, not upwards.
2259
base = self.get_server().get_url()
2260
return self._adjust_url(base, relpath)
2262
def get_vfs_only_url(self, relpath=None):
2263
"""Get a URL (or maybe a path for the plain old vfs transport.
2265
This will never be a smart protocol. It always has all the
2266
capabilities of the local filesystem, but it might actually be a
2267
MemoryTransport or some other similar virtual filesystem.
2269
This is the backing transport (if any) of the server returned by
2270
get_url and get_readonly_url.
2272
:param relpath: provides for clients to get a path relative to the base
2273
url. These should only be downwards relative, not upwards.
2276
base = self.get_vfs_only_server().get_url()
2277
return self._adjust_url(base, relpath)
2279
def _create_safety_net(self):
2280
"""Make a fake bzr directory.
2282
This prevents any tests propagating up onto the TEST_ROOT directory's
2285
root = TestCaseWithMemoryTransport.TEST_ROOT
2286
bzrdir.BzrDir.create_standalone_workingtree(root)
2288
def _check_safety_net(self):
2289
"""Check that the safety .bzr directory have not been touched.
2291
_make_test_root have created a .bzr directory to prevent tests from
2292
propagating. This method ensures than a test did not leaked.
2294
root = TestCaseWithMemoryTransport.TEST_ROOT
2295
self.permit_url(get_transport(root).base)
2296
wt = workingtree.WorkingTree.open(root)
2297
last_rev = wt.last_revision()
2298
if last_rev != 'null:':
2299
# The current test have modified the /bzr directory, we need to
2300
# recreate a new one or all the followng tests will fail.
2301
# If you need to inspect its content uncomment the following line
2302
# import pdb; pdb.set_trace()
2303
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2304
self._create_safety_net()
2305
raise AssertionError('%s/.bzr should not be modified' % root)
2307
def _make_test_root(self):
2308
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2309
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2310
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2312
TestCaseWithMemoryTransport.TEST_ROOT = root
2314
self._create_safety_net()
2316
# The same directory is used by all tests, and we're not
2317
# specifically told when all tests are finished. This will do.
2318
atexit.register(_rmtree_temp_dir, root)
2320
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2321
self.addCleanup(self._check_safety_net)
2323
def makeAndChdirToTestDir(self):
2324
"""Create a temporary directories for this one test.
2326
This must set self.test_home_dir and self.test_dir and chdir to
2329
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2331
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2332
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2333
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2334
self.permit_dir(self.test_dir)
2336
def make_branch(self, relpath, format=None):
2337
"""Create a branch on the transport at relpath."""
2338
repo = self.make_repository(relpath, format=format)
2339
return repo.bzrdir.create_branch()
2341
def make_bzrdir(self, relpath, format=None):
2343
# might be a relative or absolute path
2344
maybe_a_url = self.get_url(relpath)
2345
segments = maybe_a_url.rsplit('/', 1)
2346
t = get_transport(maybe_a_url)
2347
if len(segments) > 1 and segments[-1] not in ('', '.'):
2351
if isinstance(format, basestring):
2352
format = bzrdir.format_registry.make_bzrdir(format)
2353
return format.initialize_on_transport(t)
2354
except errors.UninitializableFormat:
2355
raise TestSkipped("Format %s is not initializable." % format)
2357
def make_repository(self, relpath, shared=False, format=None):
2358
"""Create a repository on our default transport at relpath.
2360
Note that relpath must be a relative path, not a full url.
2362
# FIXME: If you create a remoterepository this returns the underlying
2363
# real format, which is incorrect. Actually we should make sure that
2364
# RemoteBzrDir returns a RemoteRepository.
2365
# maybe mbp 20070410
2366
made_control = self.make_bzrdir(relpath, format=format)
2367
return made_control.create_repository(shared=shared)
2369
def make_smart_server(self, path):
2370
smart_server = server.SmartTCPServer_for_testing()
2371
self.start_server(smart_server, self.get_server())
2372
remote_transport = get_transport(smart_server.get_url()).clone(path)
2373
return remote_transport
2375
def make_branch_and_memory_tree(self, relpath, format=None):
2376
"""Create a branch on the default transport and a MemoryTree for it."""
2377
b = self.make_branch(relpath, format=format)
2378
return memorytree.MemoryTree.create_on_branch(b)
2380
def make_branch_builder(self, relpath, format=None):
2381
branch = self.make_branch(relpath, format=format)
2382
return branchbuilder.BranchBuilder(branch=branch)
2384
def overrideEnvironmentForTesting(self):
2385
test_home_dir = self.test_home_dir
2386
if isinstance(test_home_dir, unicode):
2387
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2388
os.environ['HOME'] = test_home_dir
2389
os.environ['BZR_HOME'] = test_home_dir
2392
super(TestCaseWithMemoryTransport, self).setUp()
2393
self._make_test_root()
2394
self.addCleanup(os.chdir, os.getcwdu())
2395
self.makeAndChdirToTestDir()
2396
self.overrideEnvironmentForTesting()
2397
self.__readonly_server = None
2398
self.__server = None
2399
self.reduceLockdirTimeout()
2401
def setup_smart_server_with_call_log(self):
2402
"""Sets up a smart server as the transport server with a call log."""
2403
self.transport_server = server.SmartTCPServer_for_testing
2404
self.hpss_calls = []
2406
# Skip the current stack down to the caller of
2407
# setup_smart_server_with_call_log
2408
prefix_length = len(traceback.extract_stack()) - 2
2409
def capture_hpss_call(params):
2410
self.hpss_calls.append(
2411
CapturedCall(params, prefix_length))
2412
client._SmartClient.hooks.install_named_hook(
2413
'call', capture_hpss_call, None)
2415
def reset_smart_call_log(self):
2416
self.hpss_calls = []
2419
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2420
"""Derived class that runs a test within a temporary directory.
2422
This is useful for tests that need to create a branch, etc.
2424
The directory is created in a slightly complex way: for each
2425
Python invocation, a new temporary top-level directory is created.
2426
All test cases create their own directory within that. If the
2427
tests complete successfully, the directory is removed.
2429
:ivar test_base_dir: The path of the top-level directory for this
2430
test, which contains a home directory and a work directory.
2432
:ivar test_home_dir: An initially empty directory under test_base_dir
2433
which is used as $HOME for this test.
2435
:ivar test_dir: A directory under test_base_dir used as the current
2436
directory when the test proper is run.
2439
OVERRIDE_PYTHON = 'python'
2441
def check_file_contents(self, filename, expect):
2442
self.log("check contents of file %s" % filename)
2443
contents = file(filename, 'r').read()
2444
if contents != expect:
2445
self.log("expected: %r" % expect)
2446
self.log("actually: %r" % contents)
2447
self.fail("contents of %s not as expected" % filename)
2449
def _getTestDirPrefix(self):
2450
# create a directory within the top level test directory
2451
if sys.platform in ('win32', 'cygwin'):
2452
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2453
# windows is likely to have path-length limits so use a short name
2454
name_prefix = name_prefix[-30:]
2456
name_prefix = re.sub('[/]', '_', self.id())
2459
def makeAndChdirToTestDir(self):
2460
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2462
For TestCaseInTempDir we create a temporary directory based on the test
2463
name and then create two subdirs - test and home under it.
2465
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2466
self._getTestDirPrefix())
2468
for i in range(100):
2469
if os.path.exists(name):
2470
name = name_prefix + '_' + str(i)
2472
# now create test and home directories within this dir
2473
self.test_base_dir = name
2474
self.addCleanup(self.deleteTestDir)
2475
os.mkdir(self.test_base_dir)
2477
self.permit_dir(self.test_base_dir)
2478
# 'sprouting' and 'init' of a branch both walk up the tree to find
2479
# stacking policy to honour; create a bzr dir with an unshared
2480
# repository (but not a branch - our code would be trying to escape
2481
# then!) to stop them, and permit it to be read.
2482
# control = bzrdir.BzrDir.create(self.test_base_dir)
2483
# control.create_repository()
2484
self.test_home_dir = self.test_base_dir + '/home'
2485
os.mkdir(self.test_home_dir)
2486
self.test_dir = self.test_base_dir + '/work'
2487
os.mkdir(self.test_dir)
2488
os.chdir(self.test_dir)
2489
# put name of test inside
2490
f = file(self.test_base_dir + '/name', 'w')
2496
def deleteTestDir(self):
2497
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2498
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2500
def build_tree(self, shape, line_endings='binary', transport=None):
2501
"""Build a test tree according to a pattern.
2503
shape is a sequence of file specifications. If the final
2504
character is '/', a directory is created.
2506
This assumes that all the elements in the tree being built are new.
2508
This doesn't add anything to a branch.
2510
:type shape: list or tuple.
2511
:param line_endings: Either 'binary' or 'native'
2512
in binary mode, exact contents are written in native mode, the
2513
line endings match the default platform endings.
2514
:param transport: A transport to write to, for building trees on VFS's.
2515
If the transport is readonly or None, "." is opened automatically.
2518
if type(shape) not in (list, tuple):
2519
raise AssertionError("Parameter 'shape' should be "
2520
"a list or a tuple. Got %r instead" % (shape,))
2521
# It's OK to just create them using forward slashes on windows.
2522
if transport is None or transport.is_readonly():
2523
transport = get_transport(".")
2525
self.assertIsInstance(name, basestring)
2527
transport.mkdir(urlutils.escape(name[:-1]))
2529
if line_endings == 'binary':
2531
elif line_endings == 'native':
2534
raise errors.BzrError(
2535
'Invalid line ending request %r' % line_endings)
2536
content = "contents of %s%s" % (name.encode('utf-8'), end)
2537
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2539
def build_tree_contents(self, shape):
2540
build_tree_contents(shape)
2542
def assertInWorkingTree(self, path, root_path='.', tree=None):
2543
"""Assert whether path or paths are in the WorkingTree"""
2545
tree = workingtree.WorkingTree.open(root_path)
2546
if not isinstance(path, basestring):
2548
self.assertInWorkingTree(p, tree=tree)
2550
self.assertIsNot(tree.path2id(path), None,
2551
path+' not in working tree.')
2553
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2554
"""Assert whether path or paths are not in the WorkingTree"""
2556
tree = workingtree.WorkingTree.open(root_path)
2557
if not isinstance(path, basestring):
2559
self.assertNotInWorkingTree(p,tree=tree)
2561
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2564
class TestCaseWithTransport(TestCaseInTempDir):
2565
"""A test case that provides get_url and get_readonly_url facilities.
2567
These back onto two transport servers, one for readonly access and one for
2570
If no explicit class is provided for readonly access, a
2571
ReadonlyTransportDecorator is used instead which allows the use of non disk
2572
based read write transports.
2574
If an explicit class is provided for readonly access, that server and the
2575
readwrite one must both define get_url() as resolving to os.getcwd().
2578
def get_vfs_only_server(self):
2579
"""See TestCaseWithMemoryTransport.
2581
This is useful for some tests with specific servers that need
2584
if self.__vfs_server is None:
2585
self.__vfs_server = self.vfs_transport_factory()
2586
self.start_server(self.__vfs_server)
2587
return self.__vfs_server
2589
def make_branch_and_tree(self, relpath, format=None):
2590
"""Create a branch on the transport and a tree locally.
2592
If the transport is not a LocalTransport, the Tree can't be created on
2593
the transport. In that case if the vfs_transport_factory is
2594
LocalURLServer the working tree is created in the local
2595
directory backing the transport, and the returned tree's branch and
2596
repository will also be accessed locally. Otherwise a lightweight
2597
checkout is created and returned.
2599
We do this because we can't physically create a tree in the local
2600
path, with a branch reference to the transport_factory url, and
2601
a branch + repository in the vfs_transport, unless the vfs_transport
2602
namespace is distinct from the local disk - the two branch objects
2603
would collide. While we could construct a tree with its branch object
2604
pointing at the transport_factory transport in memory, reopening it
2605
would behaving unexpectedly, and has in the past caused testing bugs
2606
when we tried to do it that way.
2608
:param format: The BzrDirFormat.
2609
:returns: the WorkingTree.
2611
# TODO: always use the local disk path for the working tree,
2612
# this obviously requires a format that supports branch references
2613
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2615
b = self.make_branch(relpath, format=format)
2617
return b.bzrdir.create_workingtree()
2618
except errors.NotLocalUrl:
2619
# We can only make working trees locally at the moment. If the
2620
# transport can't support them, then we keep the non-disk-backed
2621
# branch and create a local checkout.
2622
if self.vfs_transport_factory is LocalURLServer:
2623
# the branch is colocated on disk, we cannot create a checkout.
2624
# hopefully callers will expect this.
2625
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2626
wt = local_controldir.create_workingtree()
2627
if wt.branch._format != b._format:
2629
# Make sure that assigning to wt._branch fixes wt.branch,
2630
# in case the implementation details of workingtree objects
2632
self.assertIs(b, wt.branch)
2635
return b.create_checkout(relpath, lightweight=True)
2637
def assertIsDirectory(self, relpath, transport):
2638
"""Assert that relpath within transport is a directory.
2640
This may not be possible on all transports; in that case it propagates
2641
a TransportNotPossible.
2644
mode = transport.stat(relpath).st_mode
2645
except errors.NoSuchFile:
2646
self.fail("path %s is not a directory; no such file"
2648
if not stat.S_ISDIR(mode):
2649
self.fail("path %s is not a directory; has mode %#o"
2652
def assertTreesEqual(self, left, right):
2653
"""Check that left and right have the same content and properties."""
2654
# we use a tree delta to check for equality of the content, and we
2655
# manually check for equality of other things such as the parents list.
2656
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2657
differences = left.changes_from(right)
2658
self.assertFalse(differences.has_changed(),
2659
"Trees %r and %r are different: %r" % (left, right, differences))
2662
super(TestCaseWithTransport, self).setUp()
2663
self.__vfs_server = None
2665
def disable_missing_extensions_warning(self):
2666
"""Some tests expect a precise stderr content.
2668
There is no point in forcing them to duplicate the extension related
2671
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2674
class ChrootedTestCase(TestCaseWithTransport):
2675
"""A support class that provides readonly urls outside the local namespace.
2677
This is done by checking if self.transport_server is a MemoryServer. if it
2678
is then we are chrooted already, if it is not then an HttpServer is used
2681
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2682
be used without needed to redo it when a different
2683
subclass is in use ?
2687
super(ChrootedTestCase, self).setUp()
2688
if not self.vfs_transport_factory == MemoryServer:
2689
self.transport_readonly_server = HttpServer
2692
def condition_id_re(pattern):
2693
"""Create a condition filter which performs a re check on a test's id.
2695
:param pattern: A regular expression string.
2696
:return: A callable that returns True if the re matches.
2698
filter_re = osutils.re_compile_checked(pattern, 0,
2700
def condition(test):
2702
return filter_re.search(test_id)
2706
def condition_isinstance(klass_or_klass_list):
2707
"""Create a condition filter which returns isinstance(param, klass).
2709
:return: A callable which when called with one parameter obj return the
2710
result of isinstance(obj, klass_or_klass_list).
2713
return isinstance(obj, klass_or_klass_list)
2717
def condition_id_in_list(id_list):
2718
"""Create a condition filter which verify that test's id in a list.
2720
:param id_list: A TestIdList object.
2721
:return: A callable that returns True if the test's id appears in the list.
2723
def condition(test):
2724
return id_list.includes(test.id())
2728
def condition_id_startswith(starts):
2729
"""Create a condition filter verifying that test's id starts with a string.
2731
:param starts: A list of string.
2732
:return: A callable that returns True if the test's id starts with one of
2735
def condition(test):
2736
for start in starts:
2737
if test.id().startswith(start):
2743
def exclude_tests_by_condition(suite, condition):
2744
"""Create a test suite which excludes some tests from suite.
2746
:param suite: The suite to get tests from.
2747
:param condition: A callable whose result evaluates True when called with a
2748
test case which should be excluded from the result.
2749
:return: A suite which contains the tests found in suite that fail
2753
for test in iter_suite_tests(suite):
2754
if not condition(test):
2756
return TestUtil.TestSuite(result)
2759
def filter_suite_by_condition(suite, condition):
2760
"""Create a test suite by filtering another one.
2762
:param suite: The source suite.
2763
:param condition: A callable whose result evaluates True when called with a
2764
test case which should be included in the result.
2765
:return: A suite which contains the tests found in suite that pass
2769
for test in iter_suite_tests(suite):
2772
return TestUtil.TestSuite(result)
2775
def filter_suite_by_re(suite, pattern):
2776
"""Create a test suite by filtering another one.
2778
:param suite: the source suite
2779
:param pattern: pattern that names must match
2780
:returns: the newly created suite
2782
condition = condition_id_re(pattern)
2783
result_suite = filter_suite_by_condition(suite, condition)
2787
def filter_suite_by_id_list(suite, test_id_list):
2788
"""Create a test suite by filtering another one.
2790
:param suite: The source suite.
2791
:param test_id_list: A list of the test ids to keep as strings.
2792
:returns: the newly created suite
2794
condition = condition_id_in_list(test_id_list)
2795
result_suite = filter_suite_by_condition(suite, condition)
2799
def filter_suite_by_id_startswith(suite, start):
2800
"""Create a test suite by filtering another one.
2802
:param suite: The source suite.
2803
:param start: A list of string the test id must start with one of.
2804
:returns: the newly created suite
2806
condition = condition_id_startswith(start)
2807
result_suite = filter_suite_by_condition(suite, condition)
2811
def exclude_tests_by_re(suite, pattern):
2812
"""Create a test suite which excludes some tests from suite.
2814
:param suite: The suite to get tests from.
2815
:param pattern: A regular expression string. Test ids that match this
2816
pattern will be excluded from the result.
2817
:return: A TestSuite that contains all the tests from suite without the
2818
tests that matched pattern. The order of tests is the same as it was in
2821
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2824
def preserve_input(something):
2825
"""A helper for performing test suite transformation chains.
2827
:param something: Anything you want to preserve.
2833
def randomize_suite(suite):
2834
"""Return a new TestSuite with suite's tests in random order.
2836
The tests in the input suite are flattened into a single suite in order to
2837
accomplish this. Any nested TestSuites are removed to provide global
2840
tests = list(iter_suite_tests(suite))
2841
random.shuffle(tests)
2842
return TestUtil.TestSuite(tests)
2845
def split_suite_by_condition(suite, condition):
2846
"""Split a test suite into two by a condition.
2848
:param suite: The suite to split.
2849
:param condition: The condition to match on. Tests that match this
2850
condition are returned in the first test suite, ones that do not match
2851
are in the second suite.
2852
:return: A tuple of two test suites, where the first contains tests from
2853
suite matching the condition, and the second contains the remainder
2854
from suite. The order within each output suite is the same as it was in
2859
for test in iter_suite_tests(suite):
2861
matched.append(test)
2863
did_not_match.append(test)
2864
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2867
def split_suite_by_re(suite, pattern):
2868
"""Split a test suite into two by a regular expression.
2870
:param suite: The suite to split.
2871
:param pattern: A regular expression string. Test ids that match this
2872
pattern will be in the first test suite returned, and the others in the
2873
second test suite returned.
2874
:return: A tuple of two test suites, where the first contains tests from
2875
suite matching pattern, and the second contains the remainder from
2876
suite. The order within each output suite is the same as it was in
2879
return split_suite_by_condition(suite, condition_id_re(pattern))
2882
def run_suite(suite, name='test', verbose=False, pattern=".*",
2883
stop_on_failure=False,
2884
transport=None, lsprof_timed=None, bench_history=None,
2885
matching_tests_first=None,
2888
exclude_pattern=None,
2891
suite_decorators=None,
2893
result_decorators=None,
2895
"""Run a test suite for bzr selftest.
2897
:param runner_class: The class of runner to use. Must support the
2898
constructor arguments passed by run_suite which are more than standard
2900
:return: A boolean indicating success.
2902
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2907
if runner_class is None:
2908
runner_class = TextTestRunner
2911
runner = runner_class(stream=stream,
2913
verbosity=verbosity,
2914
bench_history=bench_history,
2916
result_decorators=result_decorators,
2918
runner.stop_on_failure=stop_on_failure
2919
# built in decorator factories:
2921
random_order(random_seed, runner),
2922
exclude_tests(exclude_pattern),
2924
if matching_tests_first:
2925
decorators.append(tests_first(pattern))
2927
decorators.append(filter_tests(pattern))
2928
if suite_decorators:
2929
decorators.extend(suite_decorators)
2930
# tell the result object how many tests will be running: (except if
2931
# --parallel=fork is being used. Robert said he will provide a better
2932
# progress design later -- vila 20090817)
2933
if fork_decorator not in decorators:
2934
decorators.append(CountingDecorator)
2935
for decorator in decorators:
2936
suite = decorator(suite)
2938
# Done after test suite decoration to allow randomisation etc
2939
# to take effect, though that is of marginal benefit.
2941
stream.write("Listing tests only ...\n")
2942
for t in iter_suite_tests(suite):
2943
stream.write("%s\n" % (t.id()))
2945
result = runner.run(suite)
2947
return result.wasStrictlySuccessful()
2949
return result.wasSuccessful()
2952
# A registry where get() returns a suite decorator.
2953
parallel_registry = registry.Registry()
2956
def fork_decorator(suite):
2957
concurrency = osutils.local_concurrency()
2958
if concurrency == 1:
2960
from testtools import ConcurrentTestSuite
2961
return ConcurrentTestSuite(suite, fork_for_tests)
2962
parallel_registry.register('fork', fork_decorator)
2965
def subprocess_decorator(suite):
2966
concurrency = osutils.local_concurrency()
2967
if concurrency == 1:
2969
from testtools import ConcurrentTestSuite
2970
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2971
parallel_registry.register('subprocess', subprocess_decorator)
2974
def exclude_tests(exclude_pattern):
2975
"""Return a test suite decorator that excludes tests."""
2976
if exclude_pattern is None:
2977
return identity_decorator
2978
def decorator(suite):
2979
return ExcludeDecorator(suite, exclude_pattern)
2983
def filter_tests(pattern):
2985
return identity_decorator
2986
def decorator(suite):
2987
return FilterTestsDecorator(suite, pattern)
2991
def random_order(random_seed, runner):
2992
"""Return a test suite decorator factory for randomising tests order.
2994
:param random_seed: now, a string which casts to a long, or a long.
2995
:param runner: A test runner with a stream attribute to report on.
2997
if random_seed is None:
2998
return identity_decorator
2999
def decorator(suite):
3000
return RandomDecorator(suite, random_seed, runner.stream)
3004
def tests_first(pattern):
3006
return identity_decorator
3007
def decorator(suite):
3008
return TestFirstDecorator(suite, pattern)
3012
def identity_decorator(suite):
3017
class TestDecorator(TestSuite):
3018
"""A decorator for TestCase/TestSuite objects.
3020
Usually, subclasses should override __iter__(used when flattening test
3021
suites), which we do to filter, reorder, parallelise and so on, run() and
3025
def __init__(self, suite):
3026
TestSuite.__init__(self)
3029
def countTestCases(self):
3032
cases += test.countTestCases()
3039
def run(self, result):
3040
# Use iteration on self, not self._tests, to allow subclasses to hook
3043
if result.shouldStop:
3049
class CountingDecorator(TestDecorator):
3050
"""A decorator which calls result.progress(self.countTestCases)."""
3052
def run(self, result):
3053
progress_method = getattr(result, 'progress', None)
3054
if callable(progress_method):
3055
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3056
return super(CountingDecorator, self).run(result)
3059
class ExcludeDecorator(TestDecorator):
3060
"""A decorator which excludes test matching an exclude pattern."""
3062
def __init__(self, suite, exclude_pattern):
3063
TestDecorator.__init__(self, suite)
3064
self.exclude_pattern = exclude_pattern
3065
self.excluded = False
3069
return iter(self._tests)
3070
self.excluded = True
3071
suite = exclude_tests_by_re(self, self.exclude_pattern)
3073
self.addTests(suite)
3074
return iter(self._tests)
3077
class FilterTestsDecorator(TestDecorator):
3078
"""A decorator which filters tests to those matching a pattern."""
3080
def __init__(self, suite, pattern):
3081
TestDecorator.__init__(self, suite)
3082
self.pattern = pattern
3083
self.filtered = False
3087
return iter(self._tests)
3088
self.filtered = True
3089
suite = filter_suite_by_re(self, self.pattern)
3091
self.addTests(suite)
3092
return iter(self._tests)
3095
class RandomDecorator(TestDecorator):
3096
"""A decorator which randomises the order of its tests."""
3098
def __init__(self, suite, random_seed, stream):
3099
TestDecorator.__init__(self, suite)
3100
self.random_seed = random_seed
3101
self.randomised = False
3102
self.stream = stream
3106
return iter(self._tests)
3107
self.randomised = True
3108
self.stream.write("Randomizing test order using seed %s\n\n" %
3109
(self.actual_seed()))
3110
# Initialise the random number generator.
3111
random.seed(self.actual_seed())
3112
suite = randomize_suite(self)
3114
self.addTests(suite)
3115
return iter(self._tests)
3117
def actual_seed(self):
3118
if self.random_seed == "now":
3119
# We convert the seed to a long to make it reuseable across
3120
# invocations (because the user can reenter it).
3121
self.random_seed = long(time.time())
3123
# Convert the seed to a long if we can
3125
self.random_seed = long(self.random_seed)
3128
return self.random_seed
3131
class TestFirstDecorator(TestDecorator):
3132
"""A decorator which moves named tests to the front."""
3134
def __init__(self, suite, pattern):
3135
TestDecorator.__init__(self, suite)
3136
self.pattern = pattern
3137
self.filtered = False
3141
return iter(self._tests)
3142
self.filtered = True
3143
suites = split_suite_by_re(self, self.pattern)
3145
self.addTests(suites)
3146
return iter(self._tests)
3149
def partition_tests(suite, count):
3150
"""Partition suite into count lists of tests."""
3152
tests = list(iter_suite_tests(suite))
3153
tests_per_process = int(math.ceil(float(len(tests)) / count))
3154
for block in range(count):
3155
low_test = block * tests_per_process
3156
high_test = low_test + tests_per_process
3157
process_tests = tests[low_test:high_test]
3158
result.append(process_tests)
3162
def fork_for_tests(suite):
3163
"""Take suite and start up one runner per CPU by forking()
3165
:return: An iterable of TestCase-like objects which can each have
3166
run(result) called on them to feed tests to result.
3168
concurrency = osutils.local_concurrency()
3170
from subunit import TestProtocolClient, ProtocolTestCase
3171
from subunit.test_results import AutoTimingTestResultDecorator
3172
class TestInOtherProcess(ProtocolTestCase):
3173
# Should be in subunit, I think. RBC.
3174
def __init__(self, stream, pid):
3175
ProtocolTestCase.__init__(self, stream)
3178
def run(self, result):
3180
ProtocolTestCase.run(self, result)
3182
os.waitpid(self.pid, os.WNOHANG)
3184
test_blocks = partition_tests(suite, concurrency)
3185
for process_tests in test_blocks:
3186
process_suite = TestSuite()
3187
process_suite.addTests(process_tests)
3188
c2pread, c2pwrite = os.pipe()
3193
# Leave stderr and stdout open so we can see test noise
3194
# Close stdin so that the child goes away if it decides to
3195
# read from stdin (otherwise its a roulette to see what
3196
# child actually gets keystrokes for pdb etc).
3199
stream = os.fdopen(c2pwrite, 'wb', 1)
3200
subunit_result = AutoTimingTestResultDecorator(
3201
TestProtocolClient(stream))
3202
process_suite.run(subunit_result)
3207
stream = os.fdopen(c2pread, 'rb', 1)
3208
test = TestInOtherProcess(stream, pid)
3213
def reinvoke_for_tests(suite):
3214
"""Take suite and start up one runner per CPU using subprocess().
3216
:return: An iterable of TestCase-like objects which can each have
3217
run(result) called on them to feed tests to result.
3219
concurrency = osutils.local_concurrency()
3221
from subunit import ProtocolTestCase
3222
class TestInSubprocess(ProtocolTestCase):
3223
def __init__(self, process, name):
3224
ProtocolTestCase.__init__(self, process.stdout)
3225
self.process = process
3226
self.process.stdin.close()
3229
def run(self, result):
3231
ProtocolTestCase.run(self, result)
3234
os.unlink(self.name)
3235
# print "pid %d finished" % finished_process
3236
test_blocks = partition_tests(suite, concurrency)
3237
for process_tests in test_blocks:
3238
# ugly; currently reimplement rather than reuses TestCase methods.
3239
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3240
if not os.path.isfile(bzr_path):
3241
# We are probably installed. Assume sys.argv is the right file
3242
bzr_path = sys.argv[0]
3243
bzr_path = [bzr_path]
3244
if sys.platform == "win32":
3245
# if we're on windows, we can't execute the bzr script directly
3246
bzr_path = [sys.executable] + bzr_path
3247
fd, test_list_file_name = tempfile.mkstemp()
3248
test_list_file = os.fdopen(fd, 'wb', 1)
3249
for test in process_tests:
3250
test_list_file.write(test.id() + '\n')
3251
test_list_file.close()
3253
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3255
if '--no-plugins' in sys.argv:
3256
argv.append('--no-plugins')
3257
# stderr=STDOUT would be ideal, but until we prevent noise on
3258
# stderr it can interrupt the subunit protocol.
3259
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3261
test = TestInSubprocess(process, test_list_file_name)
3264
os.unlink(test_list_file_name)
3269
class ForwardingResult(unittest.TestResult):
3271
def __init__(self, target):
3272
unittest.TestResult.__init__(self)
3273
self.result = target
3275
def startTest(self, test):
3276
self.result.startTest(test)
3278
def stopTest(self, test):
3279
self.result.stopTest(test)
3281
def startTestRun(self):
3282
self.result.startTestRun()
3284
def stopTestRun(self):
3285
self.result.stopTestRun()
3287
def addSkip(self, test, reason):
3288
self.result.addSkip(test, reason)
3290
def addSuccess(self, test):
3291
self.result.addSuccess(test)
3293
def addError(self, test, err):
3294
self.result.addError(test, err)
3296
def addFailure(self, test, err):
3297
self.result.addFailure(test, err)
3298
ForwardingResult = testtools.ExtendedToOriginalDecorator
3301
class ProfileResult(ForwardingResult):
3302
"""Generate profiling data for all activity between start and success.
3304
The profile data is appended to the test's _benchcalls attribute and can
3305
be accessed by the forwarded-to TestResult.
3307
While it might be cleaner do accumulate this in stopTest, addSuccess is
3308
where our existing output support for lsprof is, and this class aims to
3309
fit in with that: while it could be moved it's not necessary to accomplish
3310
test profiling, nor would it be dramatically cleaner.
3313
def startTest(self, test):
3314
self.profiler = bzrlib.lsprof.BzrProfiler()
3315
self.profiler.start()
3316
ForwardingResult.startTest(self, test)
3318
def addSuccess(self, test):
3319
stats = self.profiler.stop()
3321
calls = test._benchcalls
3322
except AttributeError:
3323
test._benchcalls = []
3324
calls = test._benchcalls
3325
calls.append(((test.id(), "", ""), stats))
3326
ForwardingResult.addSuccess(self, test)
3328
def stopTest(self, test):
3329
ForwardingResult.stopTest(self, test)
3330
self.profiler = None
3333
# Controlled by "bzr selftest -E=..." option
3334
# Currently supported:
3335
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3336
# preserves any flags supplied at the command line.
3337
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3338
# rather than failing tests. And no longer raise
3339
# LockContention when fctnl locks are not being used
3340
# with proper exclusion rules.
3341
selftest_debug_flags = set()
3344
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3346
test_suite_factory=None,
3349
matching_tests_first=None,
3352
exclude_pattern=None,
3358
suite_decorators=None,
3362
"""Run the whole test suite under the enhanced runner"""
3363
# XXX: Very ugly way to do this...
3364
# Disable warning about old formats because we don't want it to disturb
3365
# any blackbox tests.
3366
from bzrlib import repository
3367
repository._deprecation_warning_done = True
3369
global default_transport
3370
if transport is None:
3371
transport = default_transport
3372
old_transport = default_transport
3373
default_transport = transport
3374
global selftest_debug_flags
3375
old_debug_flags = selftest_debug_flags
3376
if debug_flags is not None:
3377
selftest_debug_flags = set(debug_flags)
3379
if load_list is None:
3382
keep_only = load_test_id_list(load_list)
3384
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3385
for start in starting_with]
3386
if test_suite_factory is None:
3387
# Reduce loading time by loading modules based on the starting_with
3389
suite = test_suite(keep_only, starting_with)
3391
suite = test_suite_factory()
3393
# But always filter as requested.
3394
suite = filter_suite_by_id_startswith(suite, starting_with)
3395
result_decorators = []
3397
result_decorators.append(ProfileResult)
3398
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3399
stop_on_failure=stop_on_failure,
3400
transport=transport,
3401
lsprof_timed=lsprof_timed,
3402
bench_history=bench_history,
3403
matching_tests_first=matching_tests_first,
3404
list_only=list_only,
3405
random_seed=random_seed,
3406
exclude_pattern=exclude_pattern,
3408
runner_class=runner_class,
3409
suite_decorators=suite_decorators,
3411
result_decorators=result_decorators,
3414
default_transport = old_transport
3415
selftest_debug_flags = old_debug_flags
3418
def load_test_id_list(file_name):
3419
"""Load a test id list from a text file.
3421
The format is one test id by line. No special care is taken to impose
3422
strict rules, these test ids are used to filter the test suite so a test id
3423
that do not match an existing test will do no harm. This allows user to add
3424
comments, leave blank lines, etc.
3428
ftest = open(file_name, 'rt')
3430
if e.errno != errno.ENOENT:
3433
raise errors.NoSuchFile(file_name)
3435
for test_name in ftest.readlines():
3436
test_list.append(test_name.strip())
3441
def suite_matches_id_list(test_suite, id_list):
3442
"""Warns about tests not appearing or appearing more than once.
3444
:param test_suite: A TestSuite object.
3445
:param test_id_list: The list of test ids that should be found in
3448
:return: (absents, duplicates) absents is a list containing the test found
3449
in id_list but not in test_suite, duplicates is a list containing the
3450
test found multiple times in test_suite.
3452
When using a prefined test id list, it may occurs that some tests do not
3453
exist anymore or that some tests use the same id. This function warns the
3454
tester about potential problems in his workflow (test lists are volatile)
3455
or in the test suite itself (using the same id for several tests does not
3456
help to localize defects).
3458
# Build a dict counting id occurrences
3460
for test in iter_suite_tests(test_suite):
3462
tests[id] = tests.get(id, 0) + 1
3467
occurs = tests.get(id, 0)
3469
not_found.append(id)
3471
duplicates.append(id)
3473
return not_found, duplicates
3476
class TestIdList(object):
3477
"""Test id list to filter a test suite.
3479
Relying on the assumption that test ids are built as:
3480
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3481
notation, this class offers methods to :
3482
- avoid building a test suite for modules not refered to in the test list,
3483
- keep only the tests listed from the module test suite.
3486
def __init__(self, test_id_list):
3487
# When a test suite needs to be filtered against us we compare test ids
3488
# for equality, so a simple dict offers a quick and simple solution.
3489
self.tests = dict().fromkeys(test_id_list, True)
3491
# While unittest.TestCase have ids like:
3492
# <module>.<class>.<method>[(<param+)],
3493
# doctest.DocTestCase can have ids like:
3496
# <module>.<function>
3497
# <module>.<class>.<method>
3499
# Since we can't predict a test class from its name only, we settle on
3500
# a simple constraint: a test id always begins with its module name.
3503
for test_id in test_id_list:
3504
parts = test_id.split('.')
3505
mod_name = parts.pop(0)
3506
modules[mod_name] = True
3508
mod_name += '.' + part
3509
modules[mod_name] = True
3510
self.modules = modules
3512
def refers_to(self, module_name):
3513
"""Is there tests for the module or one of its sub modules."""
3514
return self.modules.has_key(module_name)
3516
def includes(self, test_id):
3517
return self.tests.has_key(test_id)
3520
class TestPrefixAliasRegistry(registry.Registry):
3521
"""A registry for test prefix aliases.
3523
This helps implement shorcuts for the --starting-with selftest
3524
option. Overriding existing prefixes is not allowed but not fatal (a
3525
warning will be emitted).
3528
def register(self, key, obj, help=None, info=None,
3529
override_existing=False):
3530
"""See Registry.register.
3532
Trying to override an existing alias causes a warning to be emitted,
3533
not a fatal execption.
3536
super(TestPrefixAliasRegistry, self).register(
3537
key, obj, help=help, info=info, override_existing=False)
3539
actual = self.get(key)
3540
note('Test prefix alias %s is already used for %s, ignoring %s'
3541
% (key, actual, obj))
3543
def resolve_alias(self, id_start):
3544
"""Replace the alias by the prefix in the given string.
3546
Using an unknown prefix is an error to help catching typos.
3548
parts = id_start.split('.')
3550
parts[0] = self.get(parts[0])
3552
raise errors.BzrCommandError(
3553
'%s is not a known test prefix alias' % parts[0])
3554
return '.'.join(parts)
3557
test_prefix_alias_registry = TestPrefixAliasRegistry()
3558
"""Registry of test prefix aliases."""
3561
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3562
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3563
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3565
# Obvious higest levels prefixes, feel free to add your own via a plugin
3566
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3567
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3568
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3569
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3570
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3573
def _test_suite_testmod_names():
3574
"""Return the standard list of test module names to test."""
3577
'bzrlib.tests.blackbox',
3578
'bzrlib.tests.commands',
3579
'bzrlib.tests.per_branch',
3580
'bzrlib.tests.per_bzrdir',
3581
'bzrlib.tests.per_foreign_vcs',
3582
'bzrlib.tests.per_interrepository',
3583
'bzrlib.tests.per_intertree',
3584
'bzrlib.tests.per_inventory',
3585
'bzrlib.tests.per_interbranch',
3586
'bzrlib.tests.per_lock',
3587
'bzrlib.tests.per_merger',
3588
'bzrlib.tests.per_transport',
3589
'bzrlib.tests.per_tree',
3590
'bzrlib.tests.per_pack_repository',
3591
'bzrlib.tests.per_repository',
3592
'bzrlib.tests.per_repository_chk',
3593
'bzrlib.tests.per_repository_reference',
3594
'bzrlib.tests.per_uifactory',
3595
'bzrlib.tests.per_versionedfile',
3596
'bzrlib.tests.per_workingtree',
3597
'bzrlib.tests.test__annotator',
3598
'bzrlib.tests.test__bencode',
3599
'bzrlib.tests.test__chk_map',
3600
'bzrlib.tests.test__dirstate_helpers',
3601
'bzrlib.tests.test__groupcompress',
3602
'bzrlib.tests.test__known_graph',
3603
'bzrlib.tests.test__rio',
3604
'bzrlib.tests.test__simple_set',
3605
'bzrlib.tests.test__static_tuple',
3606
'bzrlib.tests.test__walkdirs_win32',
3607
'bzrlib.tests.test_ancestry',
3608
'bzrlib.tests.test_annotate',
3609
'bzrlib.tests.test_api',
3610
'bzrlib.tests.test_atomicfile',
3611
'bzrlib.tests.test_bad_files',
3612
'bzrlib.tests.test_bisect_multi',
3613
'bzrlib.tests.test_branch',
3614
'bzrlib.tests.test_branchbuilder',
3615
'bzrlib.tests.test_btree_index',
3616
'bzrlib.tests.test_bugtracker',
3617
'bzrlib.tests.test_bundle',
3618
'bzrlib.tests.test_bzrdir',
3619
'bzrlib.tests.test__chunks_to_lines',
3620
'bzrlib.tests.test_cache_utf8',
3621
'bzrlib.tests.test_chk_map',
3622
'bzrlib.tests.test_chk_serializer',
3623
'bzrlib.tests.test_chunk_writer',
3624
'bzrlib.tests.test_clean_tree',
3625
'bzrlib.tests.test_cleanup',
3626
'bzrlib.tests.test_commands',
3627
'bzrlib.tests.test_commit',
3628
'bzrlib.tests.test_commit_merge',
3629
'bzrlib.tests.test_config',
3630
'bzrlib.tests.test_conflicts',
3631
'bzrlib.tests.test_counted_lock',
3632
'bzrlib.tests.test_crash',
3633
'bzrlib.tests.test_decorators',
3634
'bzrlib.tests.test_delta',
3635
'bzrlib.tests.test_debug',
3636
'bzrlib.tests.test_deprecated_graph',
3637
'bzrlib.tests.test_diff',
3638
'bzrlib.tests.test_directory_service',
3639
'bzrlib.tests.test_dirstate',
3640
'bzrlib.tests.test_email_message',
3641
'bzrlib.tests.test_eol_filters',
3642
'bzrlib.tests.test_errors',
3643
'bzrlib.tests.test_export',
3644
'bzrlib.tests.test_extract',
3645
'bzrlib.tests.test_fetch',
3646
'bzrlib.tests.test_fifo_cache',
3647
'bzrlib.tests.test_filters',
3648
'bzrlib.tests.test_ftp_transport',
3649
'bzrlib.tests.test_foreign',
3650
'bzrlib.tests.test_generate_docs',
3651
'bzrlib.tests.test_generate_ids',
3652
'bzrlib.tests.test_globbing',
3653
'bzrlib.tests.test_gpg',
3654
'bzrlib.tests.test_graph',
3655
'bzrlib.tests.test_groupcompress',
3656
'bzrlib.tests.test_hashcache',
3657
'bzrlib.tests.test_help',
3658
'bzrlib.tests.test_hooks',
3659
'bzrlib.tests.test_http',
3660
'bzrlib.tests.test_http_response',
3661
'bzrlib.tests.test_https_ca_bundle',
3662
'bzrlib.tests.test_identitymap',
3663
'bzrlib.tests.test_ignores',
3664
'bzrlib.tests.test_index',
3665
'bzrlib.tests.test_info',
3666
'bzrlib.tests.test_inv',
3667
'bzrlib.tests.test_inventory_delta',
3668
'bzrlib.tests.test_knit',
3669
'bzrlib.tests.test_lazy_import',
3670
'bzrlib.tests.test_lazy_regex',
3671
'bzrlib.tests.test_lock',
3672
'bzrlib.tests.test_lockable_files',
3673
'bzrlib.tests.test_lockdir',
3674
'bzrlib.tests.test_log',
3675
'bzrlib.tests.test_lru_cache',
3676
'bzrlib.tests.test_lsprof',
3677
'bzrlib.tests.test_mail_client',
3678
'bzrlib.tests.test_memorytree',
3679
'bzrlib.tests.test_merge',
3680
'bzrlib.tests.test_merge3',
3681
'bzrlib.tests.test_merge_core',
3682
'bzrlib.tests.test_merge_directive',
3683
'bzrlib.tests.test_missing',
3684
'bzrlib.tests.test_msgeditor',
3685
'bzrlib.tests.test_multiparent',
3686
'bzrlib.tests.test_mutabletree',
3687
'bzrlib.tests.test_nonascii',
3688
'bzrlib.tests.test_options',
3689
'bzrlib.tests.test_osutils',
3690
'bzrlib.tests.test_osutils_encodings',
3691
'bzrlib.tests.test_pack',
3692
'bzrlib.tests.test_patch',
3693
'bzrlib.tests.test_patches',
3694
'bzrlib.tests.test_permissions',
3695
'bzrlib.tests.test_plugins',
3696
'bzrlib.tests.test_progress',
3697
'bzrlib.tests.test_read_bundle',
3698
'bzrlib.tests.test_reconcile',
3699
'bzrlib.tests.test_reconfigure',
3700
'bzrlib.tests.test_registry',
3701
'bzrlib.tests.test_remote',
3702
'bzrlib.tests.test_rename_map',
3703
'bzrlib.tests.test_repository',
3704
'bzrlib.tests.test_revert',
3705
'bzrlib.tests.test_revision',
3706
'bzrlib.tests.test_revisionspec',
3707
'bzrlib.tests.test_revisiontree',
3708
'bzrlib.tests.test_rio',
3709
'bzrlib.tests.test_rules',
3710
'bzrlib.tests.test_sampler',
3711
'bzrlib.tests.test_script',
3712
'bzrlib.tests.test_selftest',
3713
'bzrlib.tests.test_serializer',
3714
'bzrlib.tests.test_setup',
3715
'bzrlib.tests.test_sftp_transport',
3716
'bzrlib.tests.test_shelf',
3717
'bzrlib.tests.test_shelf_ui',
3718
'bzrlib.tests.test_smart',
3719
'bzrlib.tests.test_smart_add',
3720
'bzrlib.tests.test_smart_request',
3721
'bzrlib.tests.test_smart_transport',
3722
'bzrlib.tests.test_smtp_connection',
3723
'bzrlib.tests.test_source',
3724
'bzrlib.tests.test_ssh_transport',
3725
'bzrlib.tests.test_status',
3726
'bzrlib.tests.test_store',
3727
'bzrlib.tests.test_strace',
3728
'bzrlib.tests.test_subsume',
3729
'bzrlib.tests.test_switch',
3730
'bzrlib.tests.test_symbol_versioning',
3731
'bzrlib.tests.test_tag',
3732
'bzrlib.tests.test_testament',
3733
'bzrlib.tests.test_textfile',
3734
'bzrlib.tests.test_textmerge',
3735
'bzrlib.tests.test_timestamp',
3736
'bzrlib.tests.test_trace',
3737
'bzrlib.tests.test_transactions',
3738
'bzrlib.tests.test_transform',
3739
'bzrlib.tests.test_transport',
3740
'bzrlib.tests.test_transport_log',
3741
'bzrlib.tests.test_tree',
3742
'bzrlib.tests.test_treebuilder',
3743
'bzrlib.tests.test_tsort',
3744
'bzrlib.tests.test_tuned_gzip',
3745
'bzrlib.tests.test_ui',
3746
'bzrlib.tests.test_uncommit',
3747
'bzrlib.tests.test_upgrade',
3748
'bzrlib.tests.test_upgrade_stacked',
3749
'bzrlib.tests.test_urlutils',
3750
'bzrlib.tests.test_version',
3751
'bzrlib.tests.test_version_info',
3752
'bzrlib.tests.test_weave',
3753
'bzrlib.tests.test_whitebox',
3754
'bzrlib.tests.test_win32utils',
3755
'bzrlib.tests.test_workingtree',
3756
'bzrlib.tests.test_workingtree_4',
3757
'bzrlib.tests.test_wsgi',
3758
'bzrlib.tests.test_xml',
3762
def _test_suite_modules_to_doctest():
3763
"""Return the list of modules to doctest."""
3766
'bzrlib.branchbuilder',
3767
'bzrlib.decorators',
3770
'bzrlib.iterablefile',
3774
'bzrlib.symbol_versioning',
3777
'bzrlib.version_info_formats.format_custom',
3781
def test_suite(keep_only=None, starting_with=None):
3782
"""Build and return TestSuite for the whole of bzrlib.
3784
:param keep_only: A list of test ids limiting the suite returned.
3786
:param starting_with: An id limiting the suite returned to the tests
3789
This function can be replaced if you need to change the default test
3790
suite on a global basis, but it is not encouraged.
3793
loader = TestUtil.TestLoader()
3795
if keep_only is not None:
3796
id_filter = TestIdList(keep_only)
3798
# We take precedence over keep_only because *at loading time* using
3799
# both options means we will load less tests for the same final result.
3800
def interesting_module(name):
3801
for start in starting_with:
3803
# Either the module name starts with the specified string
3804
name.startswith(start)
3805
# or it may contain tests starting with the specified string
3806
or start.startswith(name)
3810
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3812
elif keep_only is not None:
3813
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3814
def interesting_module(name):
3815
return id_filter.refers_to(name)
3818
loader = TestUtil.TestLoader()
3819
def interesting_module(name):
3820
# No filtering, all modules are interesting
3823
suite = loader.suiteClass()
3825
# modules building their suite with loadTestsFromModuleNames
3826
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3828
for mod in _test_suite_modules_to_doctest():
3829
if not interesting_module(mod):
3830
# No tests to keep here, move along
3833
# note that this really does mean "report only" -- doctest
3834
# still runs the rest of the examples
3835
doc_suite = doctest.DocTestSuite(mod,
3836
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3837
except ValueError, e:
3838
print '**failed to get doctest for: %s\n%s' % (mod, e)
3840
if len(doc_suite._tests) == 0:
3841
raise errors.BzrError("no doctests found in %s" % (mod,))
3842
suite.addTest(doc_suite)
3844
default_encoding = sys.getdefaultencoding()
3845
for name, plugin in bzrlib.plugin.plugins().items():
3846
if not interesting_module(plugin.module.__name__):
3848
plugin_suite = plugin.test_suite()
3849
# We used to catch ImportError here and turn it into just a warning,
3850
# but really if you don't have --no-plugins this should be a failure.
3851
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3852
if plugin_suite is None:
3853
plugin_suite = plugin.load_plugin_tests(loader)
3854
if plugin_suite is not None:
3855
suite.addTest(plugin_suite)
3856
if default_encoding != sys.getdefaultencoding():
3857
bzrlib.trace.warning(
3858
'Plugin "%s" tried to reset default encoding to: %s', name,
3859
sys.getdefaultencoding())
3861
sys.setdefaultencoding(default_encoding)
3863
if keep_only is not None:
3864
# Now that the referred modules have loaded their tests, keep only the
3866
suite = filter_suite_by_id_list(suite, id_filter)
3867
# Do some sanity checks on the id_list filtering
3868
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3870
# The tester has used both keep_only and starting_with, so he is
3871
# already aware that some tests are excluded from the list, there
3872
# is no need to tell him which.
3875
# Some tests mentioned in the list are not in the test suite. The
3876
# list may be out of date, report to the tester.
3877
for id in not_found:
3878
bzrlib.trace.warning('"%s" not found in the test suite', id)
3879
for id in duplicates:
3880
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3885
def multiply_scenarios(scenarios_left, scenarios_right):
3886
"""Multiply two sets of scenarios.
3888
:returns: the cartesian product of the two sets of scenarios, that is
3889
a scenario for every possible combination of a left scenario and a
3893
('%s,%s' % (left_name, right_name),
3894
dict(left_dict.items() + right_dict.items()))
3895
for left_name, left_dict in scenarios_left
3896
for right_name, right_dict in scenarios_right]
3899
def multiply_tests(tests, scenarios, result):
3900
"""Multiply tests_list by scenarios into result.
3902
This is the core workhorse for test parameterisation.
3904
Typically the load_tests() method for a per-implementation test suite will
3905
call multiply_tests and return the result.
3907
:param tests: The tests to parameterise.
3908
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3909
scenario_param_dict).
3910
:param result: A TestSuite to add created tests to.
3912
This returns the passed in result TestSuite with the cross product of all
3913
the tests repeated once for each scenario. Each test is adapted by adding
3914
the scenario name at the end of its id(), and updating the test object's
3915
__dict__ with the scenario_param_dict.
3917
>>> import bzrlib.tests.test_sampler
3918
>>> r = multiply_tests(
3919
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3920
... [('one', dict(param=1)),
3921
... ('two', dict(param=2))],
3923
>>> tests = list(iter_suite_tests(r))
3927
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3933
for test in iter_suite_tests(tests):
3934
apply_scenarios(test, scenarios, result)
3938
def apply_scenarios(test, scenarios, result):
3939
"""Apply the scenarios in scenarios to test and add to result.
3941
:param test: The test to apply scenarios to.
3942
:param scenarios: An iterable of scenarios to apply to test.
3944
:seealso: apply_scenario
3946
for scenario in scenarios:
3947
result.addTest(apply_scenario(test, scenario))
3951
def apply_scenario(test, scenario):
3952
"""Copy test and apply scenario to it.
3954
:param test: A test to adapt.
3955
:param scenario: A tuple describing the scenarion.
3956
The first element of the tuple is the new test id.
3957
The second element is a dict containing attributes to set on the
3959
:return: The adapted test.
3961
new_id = "%s(%s)" % (test.id(), scenario[0])
3962
new_test = clone_test(test, new_id)
3963
for name, value in scenario[1].items():
3964
setattr(new_test, name, value)
3968
def clone_test(test, new_id):
3969
"""Clone a test giving it a new id.
3971
:param test: The test to clone.
3972
:param new_id: The id to assign to it.
3973
:return: The new test.
3975
new_test = copy(test)
3976
new_test.id = lambda: new_id
3980
def permute_tests_for_extension(standard_tests, loader, py_module_name,
3982
"""Helper for permutating tests against an extension module.
3984
This is meant to be used inside a modules 'load_tests()' function. It will
3985
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
3986
against both implementations. Setting 'test.module' to the appropriate
3987
module. See bzrlib.tests.test__chk_map.load_tests as an example.
3989
:param standard_tests: A test suite to permute
3990
:param loader: A TestLoader
3991
:param py_module_name: The python path to a python module that can always
3992
be loaded, and will be considered the 'python' implementation. (eg
3993
'bzrlib._chk_map_py')
3994
:param ext_module_name: The python path to an extension module. If the
3995
module cannot be loaded, a single test will be added, which notes that
3996
the module is not available. If it can be loaded, all standard_tests
3997
will be run against that module.
3998
:return: (suite, feature) suite is a test-suite that has all the permuted
3999
tests. feature is the Feature object that can be used to determine if
4000
the module is available.
4003
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4005
('python', {'module': py_module}),
4007
suite = loader.suiteClass()
4008
feature = ModuleAvailableFeature(ext_module_name)
4009
if feature.available():
4010
scenarios.append(('C', {'module': feature.module}))
4012
# the compiled module isn't available, so we add a failing test
4013
class FailWithoutFeature(TestCase):
4014
def test_fail(self):
4015
self.requireFeature(feature)
4016
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4017
result = multiply_tests(standard_tests, scenarios, suite)
4018
return result, feature
4021
def _rmtree_temp_dir(dirname, test_id=None):
4022
# If LANG=C we probably have created some bogus paths
4023
# which rmtree(unicode) will fail to delete
4024
# so make sure we are using rmtree(str) to delete everything
4025
# except on win32, where rmtree(str) will fail
4026
# since it doesn't have the property of byte-stream paths
4027
# (they are either ascii or mbcs)
4028
if sys.platform == 'win32':
4029
# make sure we are using the unicode win32 api
4030
dirname = unicode(dirname)
4032
dirname = dirname.encode(sys.getfilesystemencoding())
4034
osutils.rmtree(dirname)
4036
# We don't want to fail here because some useful display will be lost
4037
# otherwise. Polluting the tmp dir is bad, but not giving all the
4038
# possible info to the test runner is even worse.
4040
ui.ui_factory.clear_term()
4041
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4042
sys.stderr.write('Unable to remove testing dir %s\n%s'
4043
% (os.path.basename(dirname), e))
4046
class Feature(object):
4047
"""An operating system Feature."""
4050
self._available = None
4052
def available(self):
4053
"""Is the feature available?
4055
:return: True if the feature is available.
4057
if self._available is None:
4058
self._available = self._probe()
4059
return self._available
4062
"""Implement this method in concrete features.
4064
:return: True if the feature is available.
4066
raise NotImplementedError
4069
if getattr(self, 'feature_name', None):
4070
return self.feature_name()
4071
return self.__class__.__name__
4074
class _SymlinkFeature(Feature):
4077
return osutils.has_symlinks()
4079
def feature_name(self):
4082
SymlinkFeature = _SymlinkFeature()
4085
class _HardlinkFeature(Feature):
4088
return osutils.has_hardlinks()
4090
def feature_name(self):
4093
HardlinkFeature = _HardlinkFeature()
4096
class _OsFifoFeature(Feature):
4099
return getattr(os, 'mkfifo', None)
4101
def feature_name(self):
4102
return 'filesystem fifos'
4104
OsFifoFeature = _OsFifoFeature()
4107
class _UnicodeFilenameFeature(Feature):
4108
"""Does the filesystem support Unicode filenames?"""
4112
# Check for character combinations unlikely to be covered by any
4113
# single non-unicode encoding. We use the characters
4114
# - greek small letter alpha (U+03B1) and
4115
# - braille pattern dots-123456 (U+283F).
4116
os.stat(u'\u03b1\u283f')
4117
except UnicodeEncodeError:
4119
except (IOError, OSError):
4120
# The filesystem allows the Unicode filename but the file doesn't
4124
# The filesystem allows the Unicode filename and the file exists,
4128
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4131
class _CompatabilityThunkFeature(Feature):
4132
"""This feature is just a thunk to another feature.
4134
It issues a deprecation warning if it is accessed, to let you know that you
4135
should really use a different feature.
4138
def __init__(self, module, name, this_name, dep_version):
4139
super(_CompatabilityThunkFeature, self).__init__()
4140
self._module = module
4142
self._this_name = this_name
4143
self._dep_version = dep_version
4144
self._feature = None
4147
if self._feature is None:
4148
msg = (self._dep_version % self._this_name) + (
4149
' Use %s.%s instead.' % (self._module, self._name))
4150
symbol_versioning.warn(msg, DeprecationWarning)
4151
mod = __import__(self._module, {}, {}, [self._name])
4152
self._feature = getattr(mod, self._name)
4156
return self._feature._probe()
4159
class ModuleAvailableFeature(Feature):
4160
"""This is a feature than describes a module we want to be available.
4162
Declare the name of the module in __init__(), and then after probing, the
4163
module will be available as 'self.module'.
4165
:ivar module: The module if it is available, else None.
4168
def __init__(self, module_name):
4169
super(ModuleAvailableFeature, self).__init__()
4170
self.module_name = module_name
4174
self._module = __import__(self.module_name, {}, {}, [''])
4181
if self.available(): # Make sure the probe has been done
4185
def feature_name(self):
4186
return self.module_name
4189
# This is kept here for compatibility, it is recommended to use
4190
# 'bzrlib.tests.feature.paramiko' instead
4191
ParamikoFeature = _CompatabilityThunkFeature('bzrlib.tests.features',
4192
'paramiko', 'bzrlib.tests.ParamikoFeature', deprecated_in((2,1,0)))
4195
def probe_unicode_in_user_encoding():
4196
"""Try to encode several unicode strings to use in unicode-aware tests.
4197
Return first successfull match.
4199
:return: (unicode value, encoded plain string value) or (None, None)
4201
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4202
for uni_val in possible_vals:
4204
str_val = uni_val.encode(osutils.get_user_encoding())
4205
except UnicodeEncodeError:
4206
# Try a different character
4209
return uni_val, str_val
4213
def probe_bad_non_ascii(encoding):
4214
"""Try to find [bad] character with code [128..255]
4215
that cannot be decoded to unicode in some encoding.
4216
Return None if all non-ascii characters is valid
4219
for i in xrange(128, 256):
4222
char.decode(encoding)
4223
except UnicodeDecodeError:
4228
class _HTTPSServerFeature(Feature):
4229
"""Some tests want an https Server, check if one is available.
4231
Right now, the only way this is available is under python2.6 which provides
4242
def feature_name(self):
4243
return 'HTTPSServer'
4246
HTTPSServerFeature = _HTTPSServerFeature()
4249
class _UnicodeFilename(Feature):
4250
"""Does the filesystem support Unicode filenames?"""
4255
except UnicodeEncodeError:
4257
except (IOError, OSError):
4258
# The filesystem allows the Unicode filename but the file doesn't
4262
# The filesystem allows the Unicode filename and the file exists,
4266
UnicodeFilename = _UnicodeFilename()
4269
class _UTF8Filesystem(Feature):
4270
"""Is the filesystem UTF-8?"""
4273
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4277
UTF8Filesystem = _UTF8Filesystem()
4280
class _BreakinFeature(Feature):
4281
"""Does this platform support the breakin feature?"""
4284
from bzrlib import breakin
4285
if breakin.determine_signal() is None:
4287
if sys.platform == 'win32':
4288
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4289
# We trigger SIGBREAK via a Console api so we need ctypes to
4290
# access the function
4297
def feature_name(self):
4298
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4301
BreakinFeature = _BreakinFeature()
4304
class _CaseInsCasePresFilenameFeature(Feature):
4305
"""Is the file-system case insensitive, but case-preserving?"""
4308
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4310
# first check truly case-preserving for created files, then check
4311
# case insensitive when opening existing files.
4312
name = osutils.normpath(name)
4313
base, rel = osutils.split(name)
4314
found_rel = osutils.canonical_relpath(base, name)
4315
return (found_rel == rel
4316
and os.path.isfile(name.upper())
4317
and os.path.isfile(name.lower()))
4322
def feature_name(self):
4323
return "case-insensitive case-preserving filesystem"
4325
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4328
class _CaseInsensitiveFilesystemFeature(Feature):
4329
"""Check if underlying filesystem is case-insensitive but *not* case
4332
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4333
# more likely to be case preserving, so this case is rare.
4336
if CaseInsCasePresFilenameFeature.available():
4339
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4340
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4341
TestCaseWithMemoryTransport.TEST_ROOT = root
4343
root = TestCaseWithMemoryTransport.TEST_ROOT
4344
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4346
name_a = osutils.pathjoin(tdir, 'a')
4347
name_A = osutils.pathjoin(tdir, 'A')
4349
result = osutils.isdir(name_A)
4350
_rmtree_temp_dir(tdir)
4353
def feature_name(self):
4354
return 'case-insensitive filesystem'
4356
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4359
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4360
SubUnitFeature = _CompatabilityThunkFeature('bzrlib.tests.features', 'subunit',
4361
'bzrlib.tests.SubUnitFeature', deprecated_in((2,1,0)))
4362
# Only define SubUnitBzrRunner if subunit is available.
4364
from subunit import TestProtocolClient
4365
from subunit.test_results import AutoTimingTestResultDecorator
4366
class SubUnitBzrRunner(TextTestRunner):
4367
def run(self, test):
4368
result = AutoTimingTestResultDecorator(
4369
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
