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
129
# Subunit result codes, defined here to prevent a hard dependency on subunit.
134
class ExtendedTestResult(unittest._TextTestResult):
135
"""Accepts, reports and accumulates the results of running tests.
137
Compared to the unittest version this class adds support for
138
profiling, benchmarking, stopping as soon as a test fails, and
139
skipping tests. There are further-specialized subclasses for
140
different types of display.
142
When a test finishes, in whatever way, it calls one of the addSuccess,
143
addFailure or addError classes. These in turn may redirect to a more
144
specific case for the special test results supported by our extended
147
Note that just one of these objects is fed the results from many tests.
152
def __init__(self, stream, descriptions, verbosity,
156
"""Construct new TestResult.
158
:param bench_history: Optionally, a writable file object to accumulate
161
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
162
if bench_history is not None:
163
from bzrlib.version import _get_bzr_source_tree
164
src_tree = _get_bzr_source_tree()
167
revision_id = src_tree.get_parent_ids()[0]
169
# XXX: if this is a brand new tree, do the same as if there
173
# XXX: If there's no branch, what should we do?
175
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
176
self._bench_history = bench_history
177
self.ui = ui.ui_factory
180
self.failure_count = 0
181
self.known_failure_count = 0
183
self.not_applicable_count = 0
184
self.unsupported = {}
186
self._overall_start_time = time.time()
187
self._strict = strict
189
def stopTestRun(self):
192
stopTime = time.time()
193
timeTaken = stopTime - self.startTime
195
self.stream.writeln(self.separator2)
196
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
197
run, run != 1 and "s" or "", timeTaken))
198
self.stream.writeln()
199
if not self.wasSuccessful():
200
self.stream.write("FAILED (")
201
failed, errored = map(len, (self.failures, self.errors))
203
self.stream.write("failures=%d" % failed)
205
if failed: self.stream.write(", ")
206
self.stream.write("errors=%d" % errored)
207
if self.known_failure_count:
208
if failed or errored: self.stream.write(", ")
209
self.stream.write("known_failure_count=%d" %
210
self.known_failure_count)
211
self.stream.writeln(")")
213
if self.known_failure_count:
214
self.stream.writeln("OK (known_failures=%d)" %
215
self.known_failure_count)
217
self.stream.writeln("OK")
218
if self.skip_count > 0:
219
skipped = self.skip_count
220
self.stream.writeln('%d test%s skipped' %
221
(skipped, skipped != 1 and "s" or ""))
223
for feature, count in sorted(self.unsupported.items()):
224
self.stream.writeln("Missing feature '%s' skipped %d tests." %
227
ok = self.wasStrictlySuccessful()
229
ok = self.wasSuccessful()
230
if TestCase._first_thread_leaker_id:
232
'%s is leaking threads among %d leaking tests.\n' % (
233
TestCase._first_thread_leaker_id,
234
TestCase._leaking_threads_tests))
235
# We don't report the main thread as an active one.
237
'%d non-main threads were left active in the end.\n'
238
% (TestCase._active_threads - 1))
240
def _extractBenchmarkTime(self, testCase, details=None):
241
"""Add a benchmark time for the current test case."""
242
if details and 'benchtime' in details:
243
return float(''.join(details['benchtime'].iter_bytes()))
244
return getattr(testCase, "_benchtime", None)
246
def _elapsedTestTimeString(self):
247
"""Return a time string for the overall time the current test has taken."""
248
return self._formatTime(time.time() - self._start_time)
250
def _testTimeString(self, testCase):
251
benchmark_time = self._extractBenchmarkTime(testCase)
252
if benchmark_time is not None:
253
return self._formatTime(benchmark_time) + "*"
255
return self._elapsedTestTimeString()
257
def _formatTime(self, seconds):
258
"""Format seconds as milliseconds with leading spaces."""
259
# some benchmarks can take thousands of seconds to run, so we need 8
261
return "%8dms" % (1000 * seconds)
263
def _shortened_test_description(self, test):
265
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
268
def startTest(self, test):
269
unittest.TestResult.startTest(self, test)
272
self.report_test_start(test)
273
test.number = self.count
274
self._recordTestStartTime()
276
def startTests(self):
278
if getattr(sys, 'frozen', None) is None:
279
bzr_path = osutils.realpath(sys.argv[0])
281
bzr_path = sys.executable
283
'bzr selftest: %s\n' % (bzr_path,))
286
bzrlib.__path__[0],))
288
' bzr-%s python-%s %s\n' % (
289
bzrlib.version_string,
290
bzrlib._format_version_tuple(sys.version_info),
291
platform.platform(aliased=1),
293
self.stream.write('\n')
295
def _recordTestStartTime(self):
296
"""Record that a test has started."""
297
self._start_time = time.time()
299
def _cleanupLogFile(self, test):
300
# We can only do this if we have one of our TestCases, not if
302
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
303
if setKeepLogfile is not None:
306
def addError(self, test, err):
307
"""Tell result that test finished with an error.
309
Called from the TestCase run() method when the test
310
fails with an unexpected error.
313
unittest.TestResult.addError(self, test, err)
314
self.error_count += 1
315
self.report_error(test, err)
318
self._cleanupLogFile(test)
320
def addFailure(self, test, err):
321
"""Tell result that test failed.
323
Called from the TestCase run() method when the test
324
fails because e.g. an assert() method failed.
327
unittest.TestResult.addFailure(self, test, err)
328
self.failure_count += 1
329
self.report_failure(test, err)
332
self._cleanupLogFile(test)
334
def addSuccess(self, test, details=None):
335
"""Tell result that test completed successfully.
337
Called from the TestCase run()
339
if self._bench_history is not None:
340
benchmark_time = self._extractBenchmarkTime(test, details)
341
if benchmark_time is not None:
342
self._bench_history.write("%s %s\n" % (
343
self._formatTime(benchmark_time),
345
self.report_success(test)
346
self._cleanupLogFile(test)
347
unittest.TestResult.addSuccess(self, test)
348
test._log_contents = ''
350
def addExpectedFailure(self, test, err):
351
self.known_failure_count += 1
352
self.report_known_failure(test, err)
354
def addNotSupported(self, test, feature):
355
"""The test will not be run because of a missing feature.
357
# this can be called in two different ways: it may be that the
358
# test started running, and then raised (through requireFeature)
359
# UnavailableFeature. Alternatively this method can be called
360
# while probing for features before running the test code proper; in
361
# that case we will see startTest and stopTest, but the test will
362
# never actually run.
363
self.unsupported.setdefault(str(feature), 0)
364
self.unsupported[str(feature)] += 1
365
self.report_unsupported(test, feature)
367
def addSkip(self, test, reason):
368
"""A test has not run for 'reason'."""
370
self.report_skip(test, reason)
372
def addNotApplicable(self, test, reason):
373
self.not_applicable_count += 1
374
self.report_not_applicable(test, reason)
376
def _post_mortem(self):
377
"""Start a PDB post mortem session."""
378
if os.environ.get('BZR_TEST_PDB', None):
379
import pdb;pdb.post_mortem()
381
def progress(self, offset, whence):
382
"""The test is adjusting the count of tests to run."""
383
if whence == SUBUNIT_SEEK_SET:
384
self.num_tests = offset
385
elif whence == SUBUNIT_SEEK_CUR:
386
self.num_tests += offset
388
raise errors.BzrError("Unknown whence %r" % whence)
390
def report_cleaning_up(self):
393
def startTestRun(self):
394
self.startTime = time.time()
396
def report_success(self, test):
399
def wasStrictlySuccessful(self):
400
if self.unsupported or self.known_failure_count:
402
return self.wasSuccessful()
405
class TextTestResult(ExtendedTestResult):
406
"""Displays progress and results of tests in text form"""
408
def __init__(self, stream, descriptions, verbosity,
413
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
414
bench_history, strict)
415
# We no longer pass them around, but just rely on the UIFactory stack
418
warnings.warn("Passing pb to TextTestResult is deprecated")
419
self.pb = self.ui.nested_progress_bar()
420
self.pb.show_pct = False
421
self.pb.show_spinner = False
422
self.pb.show_eta = False,
423
self.pb.show_count = False
424
self.pb.show_bar = False
425
self.pb.update_latency = 0
426
self.pb.show_transport_activity = False
428
def stopTestRun(self):
429
# called when the tests that are going to run have run
432
super(TextTestResult, self).stopTestRun()
434
def startTestRun(self):
435
super(TextTestResult, self).startTestRun()
436
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
438
def printErrors(self):
439
# clear the pb to make room for the error listing
441
super(TextTestResult, self).printErrors()
443
def _progress_prefix_text(self):
444
# the longer this text, the less space we have to show the test
446
a = '[%d' % self.count # total that have been run
447
# tests skipped as known not to be relevant are not important enough
449
## if self.skip_count:
450
## a += ', %d skip' % self.skip_count
451
## if self.known_failure_count:
452
## a += '+%dX' % self.known_failure_count
454
a +='/%d' % self.num_tests
456
runtime = time.time() - self._overall_start_time
458
a += '%dm%ds' % (runtime / 60, runtime % 60)
461
total_fail_count = self.error_count + self.failure_count
463
a += ', %d failed' % total_fail_count
464
# if self.unsupported:
465
# a += ', %d missing' % len(self.unsupported)
469
def report_test_start(self, test):
472
self._progress_prefix_text()
474
+ self._shortened_test_description(test))
476
def _test_description(self, test):
477
return self._shortened_test_description(test)
479
def report_error(self, test, err):
480
ui.ui_factory.note('ERROR: %s\n %s\n' % (
481
self._test_description(test),
485
def report_failure(self, test, err):
486
ui.ui_factory.note('FAIL: %s\n %s\n' % (
487
self._test_description(test),
491
def report_known_failure(self, test, err):
494
def report_skip(self, test, reason):
497
def report_not_applicable(self, test, reason):
500
def report_unsupported(self, test, feature):
501
"""test cannot be run because feature is missing."""
503
def report_cleaning_up(self):
504
self.pb.update('Cleaning up')
507
class VerboseTestResult(ExtendedTestResult):
508
"""Produce long output, with one line per test run plus times"""
510
def _ellipsize_to_right(self, a_string, final_width):
511
"""Truncate and pad a string, keeping the right hand side"""
512
if len(a_string) > final_width:
513
result = '...' + a_string[3-final_width:]
516
return result.ljust(final_width)
518
def startTestRun(self):
519
super(VerboseTestResult, self).startTestRun()
520
self.stream.write('running %d tests...\n' % self.num_tests)
522
def report_test_start(self, test):
524
name = self._shortened_test_description(test)
525
width = osutils.terminal_width()
526
if width is not None:
527
# width needs space for 6 char status, plus 1 for slash, plus an
528
# 11-char time string, plus a trailing blank
529
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
531
self.stream.write(self._ellipsize_to_right(name, width-18))
533
self.stream.write(name)
536
def _error_summary(self, err):
538
return '%s%s' % (indent, err[1])
540
def report_error(self, test, err):
541
self.stream.writeln('ERROR %s\n%s'
542
% (self._testTimeString(test),
543
self._error_summary(err)))
545
def report_failure(self, test, err):
546
self.stream.writeln(' FAIL %s\n%s'
547
% (self._testTimeString(test),
548
self._error_summary(err)))
550
def report_known_failure(self, test, err):
551
self.stream.writeln('XFAIL %s\n%s'
552
% (self._testTimeString(test),
553
self._error_summary(err)))
555
def report_success(self, test):
556
self.stream.writeln(' OK %s' % self._testTimeString(test))
557
for bench_called, stats in getattr(test, '_benchcalls', []):
558
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
559
stats.pprint(file=self.stream)
560
# flush the stream so that we get smooth output. This verbose mode is
561
# used to show the output in PQM.
564
def report_skip(self, test, reason):
565
self.stream.writeln(' SKIP %s\n%s'
566
% (self._testTimeString(test), reason))
568
def report_not_applicable(self, test, reason):
569
self.stream.writeln(' N/A %s\n %s'
570
% (self._testTimeString(test), reason))
572
def report_unsupported(self, test, feature):
573
"""test cannot be run because feature is missing."""
574
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
575
%(self._testTimeString(test), feature))
578
class TextTestRunner(object):
579
stop_on_failure = False
587
result_decorators=None,
589
"""Create a TextTestRunner.
591
:param result_decorators: An optional list of decorators to apply
592
to the result object being used by the runner. Decorators are
593
applied left to right - the first element in the list is the
596
# stream may know claim to know to write unicode strings, but in older
597
# pythons this goes sufficiently wrong that it is a bad idea. (
598
# specifically a built in file with encoding 'UTF-8' will still try
599
# to encode using ascii.
600
new_encoding = osutils.get_terminal_encoding()
601
codec = codecs.lookup(new_encoding)
602
if type(codec) is tuple:
606
encode = codec.encode
607
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
608
stream.encoding = new_encoding
609
self.stream = unittest._WritelnDecorator(stream)
610
self.descriptions = descriptions
611
self.verbosity = verbosity
612
self._bench_history = bench_history
613
self._strict = strict
614
self._result_decorators = result_decorators or []
617
"Run the given test case or test suite."
618
if self.verbosity == 1:
619
result_class = TextTestResult
620
elif self.verbosity >= 2:
621
result_class = VerboseTestResult
622
original_result = result_class(self.stream,
625
bench_history=self._bench_history,
628
# Signal to result objects that look at stop early policy to stop,
629
original_result.stop_early = self.stop_on_failure
630
result = original_result
631
for decorator in self._result_decorators:
632
result = decorator(result)
633
result.stop_early = self.stop_on_failure
634
result.startTestRun()
639
# higher level code uses our extended protocol to determine
640
# what exit code to give.
641
return original_result
644
def iter_suite_tests(suite):
645
"""Return all tests in a suite, recursing through nested suites"""
646
if isinstance(suite, unittest.TestCase):
648
elif isinstance(suite, unittest.TestSuite):
650
for r in iter_suite_tests(item):
653
raise Exception('unknown type %r for object %r'
654
% (type(suite), suite))
657
TestSkipped = testtools.testcase.TestSkipped
660
class TestNotApplicable(TestSkipped):
661
"""A test is not applicable to the situation where it was run.
663
This is only normally raised by parameterized tests, if they find that
664
the instance they're constructed upon does not support one aspect
669
# traceback._some_str fails to format exceptions that have the default
670
# __str__ which does an implicit ascii conversion. However, repr() on those
671
# objects works, for all that its not quite what the doctor may have ordered.
672
def _clever_some_str(value):
677
return repr(value).replace('\\n', '\n')
679
return '<unprintable %s object>' % type(value).__name__
681
traceback._some_str = _clever_some_str
684
# deprecated - use self.knownFailure(), or self.expectFailure.
685
KnownFailure = testtools.testcase._ExpectedFailure
688
class UnavailableFeature(Exception):
689
"""A feature required for this test was not available.
691
This can be considered a specialised form of SkippedTest.
693
The feature should be used to construct the exception.
697
class CommandFailed(Exception):
701
class StringIOWrapper(object):
702
"""A wrapper around cStringIO which just adds an encoding attribute.
704
Internally we can check sys.stdout to see what the output encoding
705
should be. However, cStringIO has no encoding attribute that we can
706
set. So we wrap it instead.
711
def __init__(self, s=None):
713
self.__dict__['_cstring'] = StringIO(s)
715
self.__dict__['_cstring'] = StringIO()
717
def __getattr__(self, name, getattr=getattr):
718
return getattr(self.__dict__['_cstring'], name)
720
def __setattr__(self, name, val):
721
if name == 'encoding':
722
self.__dict__['encoding'] = val
724
return setattr(self._cstring, name, val)
727
class TestUIFactory(TextUIFactory):
728
"""A UI Factory for testing.
730
Hide the progress bar but emit note()s.
732
Allows get_password to be tested without real tty attached.
734
See also CannedInputUIFactory which lets you provide programmatic input in
737
# TODO: Capture progress events at the model level and allow them to be
738
# observed by tests that care.
740
# XXX: Should probably unify more with CannedInputUIFactory or a
741
# particular configuration of TextUIFactory, or otherwise have a clearer
742
# idea of how they're supposed to be different.
743
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
745
def __init__(self, stdout=None, stderr=None, stdin=None):
746
if stdin is not None:
747
# We use a StringIOWrapper to be able to test various
748
# encodings, but the user is still responsible to
749
# encode the string and to set the encoding attribute
750
# of StringIOWrapper.
751
stdin = StringIOWrapper(stdin)
752
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
754
def get_non_echoed_password(self):
755
"""Get password from stdin without trying to handle the echo mode"""
756
password = self.stdin.readline()
759
if password[-1] == '\n':
760
password = password[:-1]
763
def make_progress_view(self):
764
return NullProgressView()
767
class TestCase(testtools.TestCase):
768
"""Base class for bzr unit tests.
770
Tests that need access to disk resources should subclass
771
TestCaseInTempDir not TestCase.
773
Error and debug log messages are redirected from their usual
774
location into a temporary file, the contents of which can be
775
retrieved by _get_log(). We use a real OS file, not an in-memory object,
776
so that it can also capture file IO. When the test completes this file
777
is read into memory and removed from disk.
779
There are also convenience functions to invoke bzr's command-line
780
routine, and to build and check bzr trees.
782
In addition to the usual method of overriding tearDown(), this class also
783
allows subclasses to register functions into the _cleanups list, which is
784
run in order as the object is torn down. It's less likely this will be
785
accidentally overlooked.
788
_active_threads = None
789
_leaking_threads_tests = 0
790
_first_thread_leaker_id = None
791
_log_file_name = None
792
# record lsprof data when performing benchmark calls.
793
_gather_lsprof_in_benchmarks = False
795
def __init__(self, methodName='testMethod'):
796
super(TestCase, self).__init__(methodName)
798
self._directory_isolation = True
799
self.exception_handlers.insert(0,
800
(UnavailableFeature, self._do_unsupported_or_skip))
801
self.exception_handlers.insert(0,
802
(TestNotApplicable, self._do_not_applicable))
805
super(TestCase, self).setUp()
806
for feature in getattr(self, '_test_needs_features', []):
807
self.requireFeature(feature)
808
self._log_contents = None
809
self.addDetail("log", content.Content(content.ContentType("text",
810
"plain", {"charset": "utf8"}),
811
lambda:[self._get_log(keep_log_file=True)]))
812
self._cleanEnvironment()
815
self._benchcalls = []
816
self._benchtime = None
818
self._track_transports()
820
self._clear_debug_flags()
821
TestCase._active_threads = threading.activeCount()
822
self.addCleanup(self._check_leaked_threads)
827
pdb.Pdb().set_trace(sys._getframe().f_back)
829
def _check_leaked_threads(self):
830
active = threading.activeCount()
831
leaked_threads = active - TestCase._active_threads
832
TestCase._active_threads = active
833
# If some tests make the number of threads *decrease*, we'll consider
834
# that they are just observing old threads dieing, not agressively kill
835
# random threads. So we don't report these tests as leaking. The risk
836
# is that we have false positives that way (the test see 2 threads
837
# going away but leak one) but it seems less likely than the actual
838
# false positives (the test see threads going away and does not leak).
839
if leaked_threads > 0:
840
TestCase._leaking_threads_tests += 1
841
if TestCase._first_thread_leaker_id is None:
842
TestCase._first_thread_leaker_id = self.id()
844
def _clear_debug_flags(self):
845
"""Prevent externally set debug flags affecting tests.
847
Tests that want to use debug flags can just set them in the
848
debug_flags set during setup/teardown.
850
self._preserved_debug_flags = set(debug.debug_flags)
851
if 'allow_debug' not in selftest_debug_flags:
852
debug.debug_flags.clear()
853
if 'disable_lock_checks' not in selftest_debug_flags:
854
debug.debug_flags.add('strict_locks')
855
self.addCleanup(self._restore_debug_flags)
857
def _clear_hooks(self):
858
# prevent hooks affecting tests
859
self._preserved_hooks = {}
860
for key, factory in hooks.known_hooks.items():
861
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
862
current_hooks = hooks.known_hooks_key_to_object(key)
863
self._preserved_hooks[parent] = (name, current_hooks)
864
self.addCleanup(self._restoreHooks)
865
for key, factory in hooks.known_hooks.items():
866
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
867
setattr(parent, name, factory())
868
# this hook should always be installed
869
request._install_hook()
871
def disable_directory_isolation(self):
872
"""Turn off directory isolation checks."""
873
self._directory_isolation = False
875
def enable_directory_isolation(self):
876
"""Enable directory isolation checks."""
877
self._directory_isolation = True
879
def _silenceUI(self):
880
"""Turn off UI for duration of test"""
881
# by default the UI is off; tests can turn it on if they want it.
882
saved = ui.ui_factory
884
ui.ui_factory = saved
885
ui.ui_factory = ui.SilentUIFactory()
886
self.addCleanup(_restore)
888
def _check_locks(self):
889
"""Check that all lock take/release actions have been paired."""
890
# We always check for mismatched locks. If a mismatch is found, we
891
# fail unless -Edisable_lock_checks is supplied to selftest, in which
892
# case we just print a warning.
894
acquired_locks = [lock for action, lock in self._lock_actions
895
if action == 'acquired']
896
released_locks = [lock for action, lock in self._lock_actions
897
if action == 'released']
898
broken_locks = [lock for action, lock in self._lock_actions
899
if action == 'broken']
900
# trivially, given the tests for lock acquistion and release, if we
901
# have as many in each list, it should be ok. Some lock tests also
902
# break some locks on purpose and should be taken into account by
903
# considering that breaking a lock is just a dirty way of releasing it.
904
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
905
message = ('Different number of acquired and '
906
'released or broken locks. (%s, %s + %s)' %
907
(acquired_locks, released_locks, broken_locks))
908
if not self._lock_check_thorough:
909
# Rather than fail, just warn
910
print "Broken test %s: %s" % (self, message)
914
def _track_locks(self):
915
"""Track lock activity during tests."""
916
self._lock_actions = []
917
if 'disable_lock_checks' in selftest_debug_flags:
918
self._lock_check_thorough = False
920
self._lock_check_thorough = True
922
self.addCleanup(self._check_locks)
923
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
924
self._lock_acquired, None)
925
_mod_lock.Lock.hooks.install_named_hook('lock_released',
926
self._lock_released, None)
927
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
928
self._lock_broken, None)
930
def _lock_acquired(self, result):
931
self._lock_actions.append(('acquired', result))
933
def _lock_released(self, result):
934
self._lock_actions.append(('released', result))
936
def _lock_broken(self, result):
937
self._lock_actions.append(('broken', result))
939
def permit_dir(self, name):
940
"""Permit a directory to be used by this test. See permit_url."""
941
name_transport = get_transport(name)
942
self.permit_url(name)
943
self.permit_url(name_transport.base)
945
def permit_url(self, url):
946
"""Declare that url is an ok url to use in this test.
948
Do this for memory transports, temporary test directory etc.
950
Do not do this for the current working directory, /tmp, or any other
951
preexisting non isolated url.
953
if not url.endswith('/'):
955
self._bzr_selftest_roots.append(url)
957
def permit_source_tree_branch_repo(self):
958
"""Permit the source tree bzr is running from to be opened.
960
Some code such as bzrlib.version attempts to read from the bzr branch
961
that bzr is executing from (if any). This method permits that directory
962
to be used in the test suite.
964
path = self.get_source_path()
965
self.record_directory_isolation()
968
workingtree.WorkingTree.open(path)
969
except (errors.NotBranchError, errors.NoWorkingTree):
972
self.enable_directory_isolation()
974
def _preopen_isolate_transport(self, transport):
975
"""Check that all transport openings are done in the test work area."""
976
while isinstance(transport, pathfilter.PathFilteringTransport):
977
# Unwrap pathfiltered transports
978
transport = transport.server.backing_transport.clone(
979
transport._filter('.'))
981
# ReadonlySmartTCPServer_for_testing decorates the backing transport
982
# urls it is given by prepending readonly+. This is appropriate as the
983
# client shouldn't know that the server is readonly (or not readonly).
984
# We could register all servers twice, with readonly+ prepending, but
985
# that makes for a long list; this is about the same but easier to
987
if url.startswith('readonly+'):
988
url = url[len('readonly+'):]
989
self._preopen_isolate_url(url)
991
def _preopen_isolate_url(self, url):
992
if not self._directory_isolation:
994
if self._directory_isolation == 'record':
995
self._bzr_selftest_roots.append(url)
997
# This prevents all transports, including e.g. sftp ones backed on disk
998
# from working unless they are explicitly granted permission. We then
999
# depend on the code that sets up test transports to check that they are
1000
# appropriately isolated and enable their use by calling
1001
# self.permit_transport()
1002
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1003
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1004
% (url, self._bzr_selftest_roots))
1006
def record_directory_isolation(self):
1007
"""Gather accessed directories to permit later access.
1009
This is used for tests that access the branch bzr is running from.
1011
self._directory_isolation = "record"
1013
def start_server(self, transport_server, backing_server=None):
1014
"""Start transport_server for this test.
1016
This starts the server, registers a cleanup for it and permits the
1017
server's urls to be used.
1019
if backing_server is None:
1020
transport_server.start_server()
1022
transport_server.start_server(backing_server)
1023
self.addCleanup(transport_server.stop_server)
1024
# Obtain a real transport because if the server supplies a password, it
1025
# will be hidden from the base on the client side.
1026
t = get_transport(transport_server.get_url())
1027
# Some transport servers effectively chroot the backing transport;
1028
# others like SFTPServer don't - users of the transport can walk up the
1029
# transport to read the entire backing transport. This wouldn't matter
1030
# except that the workdir tests are given - and that they expect the
1031
# server's url to point at - is one directory under the safety net. So
1032
# Branch operations into the transport will attempt to walk up one
1033
# directory. Chrooting all servers would avoid this but also mean that
1034
# we wouldn't be testing directly against non-root urls. Alternatively
1035
# getting the test framework to start the server with a backing server
1036
# at the actual safety net directory would work too, but this then
1037
# means that the self.get_url/self.get_transport methods would need
1038
# to transform all their results. On balance its cleaner to handle it
1039
# here, and permit a higher url when we have one of these transports.
1040
if t.base.endswith('/work/'):
1041
# we have safety net/test root/work
1042
t = t.clone('../..')
1043
elif isinstance(transport_server, server.SmartTCPServer_for_testing):
1044
# The smart server adds a path similar to work, which is traversed
1045
# up from by the client. But the server is chrooted - the actual
1046
# backing transport is not escaped from, and VFS requests to the
1047
# root will error (because they try to escape the chroot).
1049
while t2.base != t.base:
1052
self.permit_url(t.base)
1054
def _track_transports(self):
1055
"""Install checks for transport usage."""
1056
# TestCase has no safe place it can write to.
1057
self._bzr_selftest_roots = []
1058
# Currently the easiest way to be sure that nothing is going on is to
1059
# hook into bzr dir opening. This leaves a small window of error for
1060
# transport tests, but they are well known, and we can improve on this
1062
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1063
self._preopen_isolate_transport, "Check bzr directories are safe.")
1065
def _ndiff_strings(self, a, b):
1066
"""Return ndiff between two strings containing lines.
1068
A trailing newline is added if missing to make the strings
1070
if b and b[-1] != '\n':
1072
if a and a[-1] != '\n':
1074
difflines = difflib.ndiff(a.splitlines(True),
1076
linejunk=lambda x: False,
1077
charjunk=lambda x: False)
1078
return ''.join(difflines)
1080
def assertEqual(self, a, b, message=''):
1084
except UnicodeError, e:
1085
# If we can't compare without getting a UnicodeError, then
1086
# obviously they are different
1087
mutter('UnicodeError: %s', e)
1090
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1092
pformat(a), pformat(b)))
1094
assertEquals = assertEqual
1096
def assertEqualDiff(self, a, b, message=None):
1097
"""Assert two texts are equal, if not raise an exception.
1099
This is intended for use with multi-line strings where it can
1100
be hard to find the differences by eye.
1102
# TODO: perhaps override assertEquals to call this for strings?
1106
message = "texts not equal:\n"
1108
message = 'first string is missing a final newline.\n'
1110
message = 'second string is missing a final newline.\n'
1111
raise AssertionError(message +
1112
self._ndiff_strings(a, b))
1114
def assertEqualMode(self, mode, mode_test):
1115
self.assertEqual(mode, mode_test,
1116
'mode mismatch %o != %o' % (mode, mode_test))
1118
def assertEqualStat(self, expected, actual):
1119
"""assert that expected and actual are the same stat result.
1121
:param expected: A stat result.
1122
:param actual: A stat result.
1123
:raises AssertionError: If the expected and actual stat values differ
1124
other than by atime.
1126
self.assertEqual(expected.st_size, actual.st_size,
1127
'st_size did not match')
1128
self.assertEqual(expected.st_mtime, actual.st_mtime,
1129
'st_mtime did not match')
1130
self.assertEqual(expected.st_ctime, actual.st_ctime,
1131
'st_ctime did not match')
1132
if sys.platform != 'win32':
1133
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1134
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1135
# odd. Regardless we shouldn't actually try to assert anything
1136
# about their values
1137
self.assertEqual(expected.st_dev, actual.st_dev,
1138
'st_dev did not match')
1139
self.assertEqual(expected.st_ino, actual.st_ino,
1140
'st_ino did not match')
1141
self.assertEqual(expected.st_mode, actual.st_mode,
1142
'st_mode did not match')
1144
def assertLength(self, length, obj_with_len):
1145
"""Assert that obj_with_len is of length length."""
1146
if len(obj_with_len) != length:
1147
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1148
length, len(obj_with_len), obj_with_len))
1150
def assertLogsError(self, exception_class, func, *args, **kwargs):
1151
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1153
from bzrlib import trace
1155
orig_log_exception_quietly = trace.log_exception_quietly
1158
orig_log_exception_quietly()
1159
captured.append(sys.exc_info())
1160
trace.log_exception_quietly = capture
1161
func(*args, **kwargs)
1163
trace.log_exception_quietly = orig_log_exception_quietly
1164
self.assertLength(1, captured)
1165
err = captured[0][1]
1166
self.assertIsInstance(err, exception_class)
1169
def assertPositive(self, val):
1170
"""Assert that val is greater than 0."""
1171
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1173
def assertNegative(self, val):
1174
"""Assert that val is less than 0."""
1175
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1177
def assertStartsWith(self, s, prefix):
1178
if not s.startswith(prefix):
1179
raise AssertionError('string %r does not start with %r' % (s, prefix))
1181
def assertEndsWith(self, s, suffix):
1182
"""Asserts that s ends with suffix."""
1183
if not s.endswith(suffix):
1184
raise AssertionError('string %r does not end with %r' % (s, suffix))
1186
def assertContainsRe(self, haystack, needle_re, flags=0):
1187
"""Assert that a contains something matching a regular expression."""
1188
if not re.search(needle_re, haystack, flags):
1189
if '\n' in haystack or len(haystack) > 60:
1190
# a long string, format it in a more readable way
1191
raise AssertionError(
1192
'pattern "%s" not found in\n"""\\\n%s"""\n'
1193
% (needle_re, haystack))
1195
raise AssertionError('pattern "%s" not found in "%s"'
1196
% (needle_re, haystack))
1198
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1199
"""Assert that a does not match a regular expression"""
1200
if re.search(needle_re, haystack, flags):
1201
raise AssertionError('pattern "%s" found in "%s"'
1202
% (needle_re, haystack))
1204
def assertSubset(self, sublist, superlist):
1205
"""Assert that every entry in sublist is present in superlist."""
1206
missing = set(sublist) - set(superlist)
1207
if len(missing) > 0:
1208
raise AssertionError("value(s) %r not present in container %r" %
1209
(missing, superlist))
1211
def assertListRaises(self, excClass, func, *args, **kwargs):
1212
"""Fail unless excClass is raised when the iterator from func is used.
1214
Many functions can return generators this makes sure
1215
to wrap them in a list() call to make sure the whole generator
1216
is run, and that the proper exception is raised.
1219
list(func(*args, **kwargs))
1223
if getattr(excClass,'__name__', None) is not None:
1224
excName = excClass.__name__
1226
excName = str(excClass)
1227
raise self.failureException, "%s not raised" % excName
1229
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1230
"""Assert that a callable raises a particular exception.
1232
:param excClass: As for the except statement, this may be either an
1233
exception class, or a tuple of classes.
1234
:param callableObj: A callable, will be passed ``*args`` and
1237
Returns the exception so that you can examine it.
1240
callableObj(*args, **kwargs)
1244
if getattr(excClass,'__name__', None) is not None:
1245
excName = excClass.__name__
1248
excName = str(excClass)
1249
raise self.failureException, "%s not raised" % excName
1251
def assertIs(self, left, right, message=None):
1252
if not (left is right):
1253
if message is not None:
1254
raise AssertionError(message)
1256
raise AssertionError("%r is not %r." % (left, right))
1258
def assertIsNot(self, left, right, message=None):
1260
if message is not None:
1261
raise AssertionError(message)
1263
raise AssertionError("%r is %r." % (left, right))
1265
def assertTransportMode(self, transport, path, mode):
1266
"""Fail if a path does not have mode "mode".
1268
If modes are not supported on this transport, the assertion is ignored.
1270
if not transport._can_roundtrip_unix_modebits():
1272
path_stat = transport.stat(path)
1273
actual_mode = stat.S_IMODE(path_stat.st_mode)
1274
self.assertEqual(mode, actual_mode,
1275
'mode of %r incorrect (%s != %s)'
1276
% (path, oct(mode), oct(actual_mode)))
1278
def assertIsSameRealPath(self, path1, path2):
1279
"""Fail if path1 and path2 points to different files"""
1280
self.assertEqual(osutils.realpath(path1),
1281
osutils.realpath(path2),
1282
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1284
def assertIsInstance(self, obj, kls, msg=None):
1285
"""Fail if obj is not an instance of kls
1287
:param msg: Supplementary message to show if the assertion fails.
1289
if not isinstance(obj, kls):
1290
m = "%r is an instance of %s rather than %s" % (
1291
obj, obj.__class__, kls)
1296
def assertFileEqual(self, content, path):
1297
"""Fail if path does not contain 'content'."""
1298
self.failUnlessExists(path)
1299
f = file(path, 'rb')
1304
self.assertEqualDiff(content, s)
1306
def failUnlessExists(self, path):
1307
"""Fail unless path or paths, which may be abs or relative, exist."""
1308
if not isinstance(path, basestring):
1310
self.failUnlessExists(p)
1312
self.failUnless(osutils.lexists(path),path+" does not exist")
1314
def failIfExists(self, path):
1315
"""Fail if path or paths, which may be abs or relative, exist."""
1316
if not isinstance(path, basestring):
1318
self.failIfExists(p)
1320
self.failIf(osutils.lexists(path),path+" exists")
1322
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1323
"""A helper for callDeprecated and applyDeprecated.
1325
:param a_callable: A callable to call.
1326
:param args: The positional arguments for the callable
1327
:param kwargs: The keyword arguments for the callable
1328
:return: A tuple (warnings, result). result is the result of calling
1329
a_callable(``*args``, ``**kwargs``).
1332
def capture_warnings(msg, cls=None, stacklevel=None):
1333
# we've hooked into a deprecation specific callpath,
1334
# only deprecations should getting sent via it.
1335
self.assertEqual(cls, DeprecationWarning)
1336
local_warnings.append(msg)
1337
original_warning_method = symbol_versioning.warn
1338
symbol_versioning.set_warning_method(capture_warnings)
1340
result = a_callable(*args, **kwargs)
1342
symbol_versioning.set_warning_method(original_warning_method)
1343
return (local_warnings, result)
1345
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1346
"""Call a deprecated callable without warning the user.
1348
Note that this only captures warnings raised by symbol_versioning.warn,
1349
not other callers that go direct to the warning module.
1351
To test that a deprecated method raises an error, do something like
1354
self.assertRaises(errors.ReservedId,
1355
self.applyDeprecated,
1356
deprecated_in((1, 5, 0)),
1360
:param deprecation_format: The deprecation format that the callable
1361
should have been deprecated with. This is the same type as the
1362
parameter to deprecated_method/deprecated_function. If the
1363
callable is not deprecated with this format, an assertion error
1365
:param a_callable: A callable to call. This may be a bound method or
1366
a regular function. It will be called with ``*args`` and
1368
:param args: The positional arguments for the callable
1369
:param kwargs: The keyword arguments for the callable
1370
:return: The result of a_callable(``*args``, ``**kwargs``)
1372
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1374
expected_first_warning = symbol_versioning.deprecation_string(
1375
a_callable, deprecation_format)
1376
if len(call_warnings) == 0:
1377
self.fail("No deprecation warning generated by call to %s" %
1379
self.assertEqual(expected_first_warning, call_warnings[0])
1382
def callCatchWarnings(self, fn, *args, **kw):
1383
"""Call a callable that raises python warnings.
1385
The caller's responsible for examining the returned warnings.
1387
If the callable raises an exception, the exception is not
1388
caught and propagates up to the caller. In that case, the list
1389
of warnings is not available.
1391
:returns: ([warning_object, ...], fn_result)
1393
# XXX: This is not perfect, because it completely overrides the
1394
# warnings filters, and some code may depend on suppressing particular
1395
# warnings. It's the easiest way to insulate ourselves from -Werror,
1396
# though. -- Andrew, 20071062
1398
def _catcher(message, category, filename, lineno, file=None, line=None):
1399
# despite the name, 'message' is normally(?) a Warning subclass
1401
wlist.append(message)
1402
saved_showwarning = warnings.showwarning
1403
saved_filters = warnings.filters
1405
warnings.showwarning = _catcher
1406
warnings.filters = []
1407
result = fn(*args, **kw)
1409
warnings.showwarning = saved_showwarning
1410
warnings.filters = saved_filters
1411
return wlist, result
1413
def callDeprecated(self, expected, callable, *args, **kwargs):
1414
"""Assert that a callable is deprecated in a particular way.
1416
This is a very precise test for unusual requirements. The
1417
applyDeprecated helper function is probably more suited for most tests
1418
as it allows you to simply specify the deprecation format being used
1419
and will ensure that that is issued for the function being called.
1421
Note that this only captures warnings raised by symbol_versioning.warn,
1422
not other callers that go direct to the warning module. To catch
1423
general warnings, use callCatchWarnings.
1425
:param expected: a list of the deprecation warnings expected, in order
1426
:param callable: The callable to call
1427
:param args: The positional arguments for the callable
1428
:param kwargs: The keyword arguments for the callable
1430
call_warnings, result = self._capture_deprecation_warnings(callable,
1432
self.assertEqual(expected, call_warnings)
1435
def _startLogFile(self):
1436
"""Send bzr and test log messages to a temporary file.
1438
The file is removed as the test is torn down.
1440
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1441
self._log_file = os.fdopen(fileno, 'w+')
1442
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1443
self._log_file_name = name
1444
self.addCleanup(self._finishLogFile)
1446
def _finishLogFile(self):
1447
"""Finished with the log file.
1449
Close the file and delete it, unless setKeepLogfile was called.
1451
if bzrlib.trace._trace_file:
1452
# flush the log file, to get all content
1453
bzrlib.trace._trace_file.flush()
1454
bzrlib.trace.pop_log_file(self._log_memento)
1455
# Cache the log result and delete the file on disk
1456
self._get_log(False)
1458
def thisFailsStrictLockCheck(self):
1459
"""It is known that this test would fail with -Dstrict_locks.
1461
By default, all tests are run with strict lock checking unless
1462
-Edisable_lock_checks is supplied. However there are some tests which
1463
we know fail strict locks at this point that have not been fixed.
1464
They should call this function to disable the strict checking.
1466
This should be used sparingly, it is much better to fix the locking
1467
issues rather than papering over the problem by calling this function.
1469
debug.debug_flags.discard('strict_locks')
1471
def addCleanup(self, callable, *args, **kwargs):
1472
"""Arrange to run a callable when this case is torn down.
1474
Callables are run in the reverse of the order they are registered,
1475
ie last-in first-out.
1477
self._cleanups.append((callable, args, kwargs))
1479
def _cleanEnvironment(self):
1481
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1482
'HOME': os.getcwd(),
1483
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1484
# tests do check our impls match APPDATA
1485
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1489
'BZREMAIL': None, # may still be present in the environment
1491
'BZR_PROGRESS_BAR': None,
1493
'BZR_PLUGIN_PATH': None,
1494
'BZR_CONCURRENCY': None,
1495
# Make sure that any text ui tests are consistent regardless of
1496
# the environment the test case is run in; you may want tests that
1497
# test other combinations. 'dumb' is a reasonable guess for tests
1498
# going to a pipe or a StringIO.
1502
'BZR_COLUMNS': '80',
1504
'SSH_AUTH_SOCK': None,
1508
'https_proxy': None,
1509
'HTTPS_PROXY': None,
1514
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1515
# least. If you do (care), please update this comment
1519
'BZR_REMOTE_PATH': None,
1522
self.addCleanup(self._restoreEnvironment)
1523
for name, value in new_env.iteritems():
1524
self._captureVar(name, value)
1526
def _captureVar(self, name, newvalue):
1527
"""Set an environment variable, and reset it when finished."""
1528
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1530
def _restore_debug_flags(self):
1531
debug.debug_flags.clear()
1532
debug.debug_flags.update(self._preserved_debug_flags)
1534
def _restoreEnvironment(self):
1535
for name, value in self.__old_env.iteritems():
1536
osutils.set_or_unset_env(name, value)
1538
def _restoreHooks(self):
1539
for klass, (name, hooks) in self._preserved_hooks.items():
1540
setattr(klass, name, hooks)
1542
def knownFailure(self, reason):
1543
"""This test has failed for some known reason."""
1544
raise KnownFailure(reason)
1546
def _do_skip(self, result, reason):
1547
addSkip = getattr(result, 'addSkip', None)
1548
if not callable(addSkip):
1549
result.addSuccess(result)
1551
addSkip(self, reason)
1554
def _do_known_failure(self, result, e):
1555
err = sys.exc_info()
1556
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1557
if addExpectedFailure is not None:
1558
addExpectedFailure(self, err)
1560
result.addSuccess(self)
1563
def _do_not_applicable(self, result, e):
1565
reason = 'No reason given'
1568
addNotApplicable = getattr(result, 'addNotApplicable', None)
1569
if addNotApplicable is not None:
1570
result.addNotApplicable(self, reason)
1572
self._do_skip(result, reason)
1575
def _do_unsupported_or_skip(self, result, e):
1577
addNotSupported = getattr(result, 'addNotSupported', None)
1578
if addNotSupported is not None:
1579
result.addNotSupported(self, reason)
1581
self._do_skip(result, reason)
1583
def time(self, callable, *args, **kwargs):
1584
"""Run callable and accrue the time it takes to the benchmark time.
1586
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1587
this will cause lsprofile statistics to be gathered and stored in
1590
if self._benchtime is None:
1591
self.addDetail('benchtime', content.Content(content.ContentType(
1592
"text", "plain"), lambda:[str(self._benchtime)]))
1596
if not self._gather_lsprof_in_benchmarks:
1597
return callable(*args, **kwargs)
1599
# record this benchmark
1600
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1602
self._benchcalls.append(((callable, args, kwargs), stats))
1605
self._benchtime += time.time() - start
1607
def log(self, *args):
1610
def _get_log(self, keep_log_file=False):
1611
"""Internal helper to get the log from bzrlib.trace for this test.
1613
Please use self.getDetails, or self.get_log to access this in test case
1616
:param keep_log_file: When True, if the log is still a file on disk
1617
leave it as a file on disk. When False, if the log is still a file
1618
on disk, the log file is deleted and the log preserved as
1620
:return: A string containing the log.
1622
if self._log_contents is not None:
1624
self._log_contents.decode('utf8')
1625
except UnicodeDecodeError:
1626
unicodestr = self._log_contents.decode('utf8', 'replace')
1627
self._log_contents = unicodestr.encode('utf8')
1628
return self._log_contents
1630
if bzrlib.trace._trace_file:
1631
# flush the log file, to get all content
1632
bzrlib.trace._trace_file.flush()
1633
if self._log_file_name is not None:
1634
logfile = open(self._log_file_name)
1636
log_contents = logfile.read()
1640
log_contents.decode('utf8')
1641
except UnicodeDecodeError:
1642
unicodestr = log_contents.decode('utf8', 'replace')
1643
log_contents = unicodestr.encode('utf8')
1644
if not keep_log_file:
1645
self._log_file.close()
1646
self._log_file = None
1647
# Permit multiple calls to get_log until we clean it up in
1649
self._log_contents = log_contents
1651
os.remove(self._log_file_name)
1653
if sys.platform == 'win32' and e.errno == errno.EACCES:
1654
sys.stderr.write(('Unable to delete log file '
1655
' %r\n' % self._log_file_name))
1658
self._log_file_name = None
1661
return "No log file content and no log file name."
1664
"""Get a unicode string containing the log from bzrlib.trace.
1666
Undecodable characters are replaced.
1668
return u"".join(self.getDetails()['log'].iter_text())
1670
def requireFeature(self, feature):
1671
"""This test requires a specific feature is available.
1673
:raises UnavailableFeature: When feature is not available.
1675
if not feature.available():
1676
raise UnavailableFeature(feature)
1678
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1680
"""Run bazaar command line, splitting up a string command line."""
1681
if isinstance(args, basestring):
1682
# shlex don't understand unicode strings,
1683
# so args should be plain string (bialix 20070906)
1684
args = list(shlex.split(str(args)))
1685
return self._run_bzr_core(args, retcode=retcode,
1686
encoding=encoding, stdin=stdin, working_dir=working_dir,
1689
def _run_bzr_core(self, args, retcode, encoding, stdin,
1691
# Clear chk_map page cache, because the contents are likely to mask
1693
chk_map.clear_cache()
1694
if encoding is None:
1695
encoding = osutils.get_user_encoding()
1696
stdout = StringIOWrapper()
1697
stderr = StringIOWrapper()
1698
stdout.encoding = encoding
1699
stderr.encoding = encoding
1701
self.log('run bzr: %r', args)
1702
# FIXME: don't call into logging here
1703
handler = logging.StreamHandler(stderr)
1704
handler.setLevel(logging.INFO)
1705
logger = logging.getLogger('')
1706
logger.addHandler(handler)
1707
old_ui_factory = ui.ui_factory
1708
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1711
if working_dir is not None:
1712
cwd = osutils.getcwd()
1713
os.chdir(working_dir)
1717
result = self.apply_redirected(ui.ui_factory.stdin,
1719
bzrlib.commands.run_bzr_catch_user_errors,
1721
except KeyboardInterrupt:
1722
# Reraise KeyboardInterrupt with contents of redirected stdout
1723
# and stderr as arguments, for tests which are interested in
1724
# stdout and stderr and are expecting the exception.
1725
out = stdout.getvalue()
1726
err = stderr.getvalue()
1728
self.log('output:\n%r', out)
1730
self.log('errors:\n%r', err)
1731
raise KeyboardInterrupt(out, err)
1733
logger.removeHandler(handler)
1734
ui.ui_factory = old_ui_factory
1738
out = stdout.getvalue()
1739
err = stderr.getvalue()
1741
self.log('output:\n%r', out)
1743
self.log('errors:\n%r', err)
1744
if retcode is not None:
1745
self.assertEquals(retcode, result,
1746
message='Unexpected return code')
1747
return result, out, err
1749
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1750
working_dir=None, error_regexes=[], output_encoding=None):
1751
"""Invoke bzr, as if it were run from the command line.
1753
The argument list should not include the bzr program name - the
1754
first argument is normally the bzr command. Arguments may be
1755
passed in three ways:
1757
1- A list of strings, eg ["commit", "a"]. This is recommended
1758
when the command contains whitespace or metacharacters, or
1759
is built up at run time.
1761
2- A single string, eg "add a". This is the most convenient
1762
for hardcoded commands.
1764
This runs bzr through the interface that catches and reports
1765
errors, and with logging set to something approximating the
1766
default, so that error reporting can be checked.
1768
This should be the main method for tests that want to exercise the
1769
overall behavior of the bzr application (rather than a unit test
1770
or a functional test of the library.)
1772
This sends the stdout/stderr results into the test's log,
1773
where it may be useful for debugging. See also run_captured.
1775
:keyword stdin: A string to be used as stdin for the command.
1776
:keyword retcode: The status code the command should return;
1778
:keyword working_dir: The directory to run the command in
1779
:keyword error_regexes: A list of expected error messages. If
1780
specified they must be seen in the error output of the command.
1782
retcode, out, err = self._run_bzr_autosplit(
1787
working_dir=working_dir,
1789
self.assertIsInstance(error_regexes, (list, tuple))
1790
for regex in error_regexes:
1791
self.assertContainsRe(err, regex)
1794
def run_bzr_error(self, error_regexes, *args, **kwargs):
1795
"""Run bzr, and check that stderr contains the supplied regexes
1797
:param error_regexes: Sequence of regular expressions which
1798
must each be found in the error output. The relative ordering
1800
:param args: command-line arguments for bzr
1801
:param kwargs: Keyword arguments which are interpreted by run_bzr
1802
This function changes the default value of retcode to be 3,
1803
since in most cases this is run when you expect bzr to fail.
1805
:return: (out, err) The actual output of running the command (in case
1806
you want to do more inspection)
1810
# Make sure that commit is failing because there is nothing to do
1811
self.run_bzr_error(['no changes to commit'],
1812
['commit', '-m', 'my commit comment'])
1813
# Make sure --strict is handling an unknown file, rather than
1814
# giving us the 'nothing to do' error
1815
self.build_tree(['unknown'])
1816
self.run_bzr_error(['Commit refused because there are unknown files'],
1817
['commit', --strict', '-m', 'my commit comment'])
1819
kwargs.setdefault('retcode', 3)
1820
kwargs['error_regexes'] = error_regexes
1821
out, err = self.run_bzr(*args, **kwargs)
1824
def run_bzr_subprocess(self, *args, **kwargs):
1825
"""Run bzr in a subprocess for testing.
1827
This starts a new Python interpreter and runs bzr in there.
1828
This should only be used for tests that have a justifiable need for
1829
this isolation: e.g. they are testing startup time, or signal
1830
handling, or early startup code, etc. Subprocess code can't be
1831
profiled or debugged so easily.
1833
:keyword retcode: The status code that is expected. Defaults to 0. If
1834
None is supplied, the status code is not checked.
1835
:keyword env_changes: A dictionary which lists changes to environment
1836
variables. A value of None will unset the env variable.
1837
The values must be strings. The change will only occur in the
1838
child, so you don't need to fix the environment after running.
1839
:keyword universal_newlines: Convert CRLF => LF
1840
:keyword allow_plugins: By default the subprocess is run with
1841
--no-plugins to ensure test reproducibility. Also, it is possible
1842
for system-wide plugins to create unexpected output on stderr,
1843
which can cause unnecessary test failures.
1845
env_changes = kwargs.get('env_changes', {})
1846
working_dir = kwargs.get('working_dir', None)
1847
allow_plugins = kwargs.get('allow_plugins', False)
1849
if isinstance(args[0], list):
1851
elif isinstance(args[0], basestring):
1852
args = list(shlex.split(args[0]))
1854
raise ValueError("passing varargs to run_bzr_subprocess")
1855
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1856
working_dir=working_dir,
1857
allow_plugins=allow_plugins)
1858
# We distinguish between retcode=None and retcode not passed.
1859
supplied_retcode = kwargs.get('retcode', 0)
1860
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1861
universal_newlines=kwargs.get('universal_newlines', False),
1864
def start_bzr_subprocess(self, process_args, env_changes=None,
1865
skip_if_plan_to_signal=False,
1867
allow_plugins=False):
1868
"""Start bzr in a subprocess for testing.
1870
This starts a new Python interpreter and runs bzr in there.
1871
This should only be used for tests that have a justifiable need for
1872
this isolation: e.g. they are testing startup time, or signal
1873
handling, or early startup code, etc. Subprocess code can't be
1874
profiled or debugged so easily.
1876
:param process_args: a list of arguments to pass to the bzr executable,
1877
for example ``['--version']``.
1878
:param env_changes: A dictionary which lists changes to environment
1879
variables. A value of None will unset the env variable.
1880
The values must be strings. The change will only occur in the
1881
child, so you don't need to fix the environment after running.
1882
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1884
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1886
:returns: Popen object for the started process.
1888
if skip_if_plan_to_signal:
1889
if not getattr(os, 'kill', None):
1890
raise TestSkipped("os.kill not available.")
1892
if env_changes is None:
1896
def cleanup_environment():
1897
for env_var, value in env_changes.iteritems():
1898
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1900
def restore_environment():
1901
for env_var, value in old_env.iteritems():
1902
osutils.set_or_unset_env(env_var, value)
1904
bzr_path = self.get_bzr_path()
1907
if working_dir is not None:
1908
cwd = osutils.getcwd()
1909
os.chdir(working_dir)
1912
# win32 subprocess doesn't support preexec_fn
1913
# so we will avoid using it on all platforms, just to
1914
# make sure the code path is used, and we don't break on win32
1915
cleanup_environment()
1916
command = [sys.executable]
1917
# frozen executables don't need the path to bzr
1918
if getattr(sys, "frozen", None) is None:
1919
command.append(bzr_path)
1920
if not allow_plugins:
1921
command.append('--no-plugins')
1922
command.extend(process_args)
1923
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1925
restore_environment()
1931
def _popen(self, *args, **kwargs):
1932
"""Place a call to Popen.
1934
Allows tests to override this method to intercept the calls made to
1935
Popen for introspection.
1937
return Popen(*args, **kwargs)
1939
def get_source_path(self):
1940
"""Return the path of the directory containing bzrlib."""
1941
return os.path.dirname(os.path.dirname(bzrlib.__file__))
1943
def get_bzr_path(self):
1944
"""Return the path of the 'bzr' executable for this test suite."""
1945
bzr_path = self.get_source_path()+'/bzr'
1946
if not os.path.isfile(bzr_path):
1947
# We are probably installed. Assume sys.argv is the right file
1948
bzr_path = sys.argv[0]
1951
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1952
universal_newlines=False, process_args=None):
1953
"""Finish the execution of process.
1955
:param process: the Popen object returned from start_bzr_subprocess.
1956
:param retcode: The status code that is expected. Defaults to 0. If
1957
None is supplied, the status code is not checked.
1958
:param send_signal: an optional signal to send to the process.
1959
:param universal_newlines: Convert CRLF => LF
1960
:returns: (stdout, stderr)
1962
if send_signal is not None:
1963
os.kill(process.pid, send_signal)
1964
out, err = process.communicate()
1966
if universal_newlines:
1967
out = out.replace('\r\n', '\n')
1968
err = err.replace('\r\n', '\n')
1970
if retcode is not None and retcode != process.returncode:
1971
if process_args is None:
1972
process_args = "(unknown args)"
1973
mutter('Output of bzr %s:\n%s', process_args, out)
1974
mutter('Error for bzr %s:\n%s', process_args, err)
1975
self.fail('Command bzr %s failed with retcode %s != %s'
1976
% (process_args, retcode, process.returncode))
1979
def check_inventory_shape(self, inv, shape):
1980
"""Compare an inventory to a list of expected names.
1982
Fail if they are not precisely equal.
1985
shape = list(shape) # copy
1986
for path, ie in inv.entries():
1987
name = path.replace('\\', '/')
1988
if ie.kind == 'directory':
1995
self.fail("expected paths not found in inventory: %r" % shape)
1997
self.fail("unexpected paths found in inventory: %r" % extras)
1999
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2000
a_callable=None, *args, **kwargs):
2001
"""Call callable with redirected std io pipes.
2003
Returns the return code."""
2004
if not callable(a_callable):
2005
raise ValueError("a_callable must be callable.")
2007
stdin = StringIO("")
2009
if getattr(self, "_log_file", None) is not None:
2010
stdout = self._log_file
2014
if getattr(self, "_log_file", None is not None):
2015
stderr = self._log_file
2018
real_stdin = sys.stdin
2019
real_stdout = sys.stdout
2020
real_stderr = sys.stderr
2025
return a_callable(*args, **kwargs)
2027
sys.stdout = real_stdout
2028
sys.stderr = real_stderr
2029
sys.stdin = real_stdin
2031
def reduceLockdirTimeout(self):
2032
"""Reduce the default lock timeout for the duration of the test, so that
2033
if LockContention occurs during a test, it does so quickly.
2035
Tests that expect to provoke LockContention errors should call this.
2037
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
2039
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
2040
self.addCleanup(resetTimeout)
2041
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
2043
def make_utf8_encoded_stringio(self, encoding_type=None):
2044
"""Return a StringIOWrapper instance, that will encode Unicode
2047
if encoding_type is None:
2048
encoding_type = 'strict'
2050
output_encoding = 'utf-8'
2051
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2052
sio.encoding = output_encoding
2055
def disable_verb(self, verb):
2056
"""Disable a smart server verb for one test."""
2057
from bzrlib.smart import request
2058
request_handlers = request.request_handlers
2059
orig_method = request_handlers.get(verb)
2060
request_handlers.remove(verb)
2062
request_handlers.register(verb, orig_method)
2063
self.addCleanup(restoreVerb)
2066
class CapturedCall(object):
2067
"""A helper for capturing smart server calls for easy debug analysis."""
2069
def __init__(self, params, prefix_length):
2070
"""Capture the call with params and skip prefix_length stack frames."""
2073
# The last 5 frames are the __init__, the hook frame, and 3 smart
2074
# client frames. Beyond this we could get more clever, but this is good
2076
stack = traceback.extract_stack()[prefix_length:-5]
2077
self.stack = ''.join(traceback.format_list(stack))
2080
return self.call.method
2083
return self.call.method
2089
class TestCaseWithMemoryTransport(TestCase):
2090
"""Common test class for tests that do not need disk resources.
2092
Tests that need disk resources should derive from TestCaseWithTransport.
2094
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2096
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2097
a directory which does not exist. This serves to help ensure test isolation
2098
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2099
must exist. However, TestCaseWithMemoryTransport does not offer local
2100
file defaults for the transport in tests, nor does it obey the command line
2101
override, so tests that accidentally write to the common directory should
2104
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2105
a .bzr directory that stops us ascending higher into the filesystem.
2111
def __init__(self, methodName='runTest'):
2112
# allow test parameterization after test construction and before test
2113
# execution. Variables that the parameterizer sets need to be
2114
# ones that are not set by setUp, or setUp will trash them.
2115
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2116
self.vfs_transport_factory = default_transport
2117
self.transport_server = None
2118
self.transport_readonly_server = None
2119
self.__vfs_server = None
2121
def get_transport(self, relpath=None):
2122
"""Return a writeable transport.
2124
This transport is for the test scratch space relative to
2127
:param relpath: a path relative to the base url.
2129
t = get_transport(self.get_url(relpath))
2130
self.assertFalse(t.is_readonly())
2133
def get_readonly_transport(self, relpath=None):
2134
"""Return a readonly transport for the test scratch space
2136
This can be used to test that operations which should only need
2137
readonly access in fact do not try to write.
2139
:param relpath: a path relative to the base url.
2141
t = get_transport(self.get_readonly_url(relpath))
2142
self.assertTrue(t.is_readonly())
2145
def create_transport_readonly_server(self):
2146
"""Create a transport server from class defined at init.
2148
This is mostly a hook for daughter classes.
2150
return self.transport_readonly_server()
2152
def get_readonly_server(self):
2153
"""Get the server instance for the readonly transport
2155
This is useful for some tests with specific servers to do diagnostics.
2157
if self.__readonly_server is None:
2158
if self.transport_readonly_server is None:
2159
# readonly decorator requested
2160
self.__readonly_server = ReadonlyServer()
2162
# explicit readonly transport.
2163
self.__readonly_server = self.create_transport_readonly_server()
2164
self.start_server(self.__readonly_server,
2165
self.get_vfs_only_server())
2166
return self.__readonly_server
2168
def get_readonly_url(self, relpath=None):
2169
"""Get a URL for the readonly transport.
2171
This will either be backed by '.' or a decorator to the transport
2172
used by self.get_url()
2173
relpath provides for clients to get a path relative to the base url.
2174
These should only be downwards relative, not upwards.
2176
base = self.get_readonly_server().get_url()
2177
return self._adjust_url(base, relpath)
2179
def get_vfs_only_server(self):
2180
"""Get the vfs only read/write server instance.
2182
This is useful for some tests with specific servers that need
2185
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2186
is no means to override it.
2188
if self.__vfs_server is None:
2189
self.__vfs_server = MemoryServer()
2190
self.start_server(self.__vfs_server)
2191
return self.__vfs_server
2193
def get_server(self):
2194
"""Get the read/write server instance.
2196
This is useful for some tests with specific servers that need
2199
This is built from the self.transport_server factory. If that is None,
2200
then the self.get_vfs_server is returned.
2202
if self.__server is None:
2203
if (self.transport_server is None or self.transport_server is
2204
self.vfs_transport_factory):
2205
self.__server = self.get_vfs_only_server()
2207
# bring up a decorated means of access to the vfs only server.
2208
self.__server = self.transport_server()
2209
self.start_server(self.__server, self.get_vfs_only_server())
2210
return self.__server
2212
def _adjust_url(self, base, relpath):
2213
"""Get a URL (or maybe a path) for the readwrite transport.
2215
This will either be backed by '.' or to an equivalent non-file based
2217
relpath provides for clients to get a path relative to the base url.
2218
These should only be downwards relative, not upwards.
2220
if relpath is not None and relpath != '.':
2221
if not base.endswith('/'):
2223
# XXX: Really base should be a url; we did after all call
2224
# get_url()! But sometimes it's just a path (from
2225
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2226
# to a non-escaped local path.
2227
if base.startswith('./') or base.startswith('/'):
2230
base += urlutils.escape(relpath)
2233
def get_url(self, relpath=None):
2234
"""Get a URL (or maybe a path) for the readwrite transport.
2236
This will either be backed by '.' or to an equivalent non-file based
2238
relpath provides for clients to get a path relative to the base url.
2239
These should only be downwards relative, not upwards.
2241
base = self.get_server().get_url()
2242
return self._adjust_url(base, relpath)
2244
def get_vfs_only_url(self, relpath=None):
2245
"""Get a URL (or maybe a path for the plain old vfs transport.
2247
This will never be a smart protocol. It always has all the
2248
capabilities of the local filesystem, but it might actually be a
2249
MemoryTransport or some other similar virtual filesystem.
2251
This is the backing transport (if any) of the server returned by
2252
get_url and get_readonly_url.
2254
:param relpath: provides for clients to get a path relative to the base
2255
url. These should only be downwards relative, not upwards.
2258
base = self.get_vfs_only_server().get_url()
2259
return self._adjust_url(base, relpath)
2261
def _create_safety_net(self):
2262
"""Make a fake bzr directory.
2264
This prevents any tests propagating up onto the TEST_ROOT directory's
2267
root = TestCaseWithMemoryTransport.TEST_ROOT
2268
bzrdir.BzrDir.create_standalone_workingtree(root)
2270
def _check_safety_net(self):
2271
"""Check that the safety .bzr directory have not been touched.
2273
_make_test_root have created a .bzr directory to prevent tests from
2274
propagating. This method ensures than a test did not leaked.
2276
root = TestCaseWithMemoryTransport.TEST_ROOT
2277
self.permit_url(get_transport(root).base)
2278
wt = workingtree.WorkingTree.open(root)
2279
last_rev = wt.last_revision()
2280
if last_rev != 'null:':
2281
# The current test have modified the /bzr directory, we need to
2282
# recreate a new one or all the followng tests will fail.
2283
# If you need to inspect its content uncomment the following line
2284
# import pdb; pdb.set_trace()
2285
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2286
self._create_safety_net()
2287
raise AssertionError('%s/.bzr should not be modified' % root)
2289
def _make_test_root(self):
2290
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2291
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2292
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2294
TestCaseWithMemoryTransport.TEST_ROOT = root
2296
self._create_safety_net()
2298
# The same directory is used by all tests, and we're not
2299
# specifically told when all tests are finished. This will do.
2300
atexit.register(_rmtree_temp_dir, root)
2302
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2303
self.addCleanup(self._check_safety_net)
2305
def makeAndChdirToTestDir(self):
2306
"""Create a temporary directories for this one test.
2308
This must set self.test_home_dir and self.test_dir and chdir to
2311
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2313
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2314
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2315
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2316
self.permit_dir(self.test_dir)
2318
def make_branch(self, relpath, format=None):
2319
"""Create a branch on the transport at relpath."""
2320
repo = self.make_repository(relpath, format=format)
2321
return repo.bzrdir.create_branch()
2323
def make_bzrdir(self, relpath, format=None):
2325
# might be a relative or absolute path
2326
maybe_a_url = self.get_url(relpath)
2327
segments = maybe_a_url.rsplit('/', 1)
2328
t = get_transport(maybe_a_url)
2329
if len(segments) > 1 and segments[-1] not in ('', '.'):
2333
if isinstance(format, basestring):
2334
format = bzrdir.format_registry.make_bzrdir(format)
2335
return format.initialize_on_transport(t)
2336
except errors.UninitializableFormat:
2337
raise TestSkipped("Format %s is not initializable." % format)
2339
def make_repository(self, relpath, shared=False, format=None):
2340
"""Create a repository on our default transport at relpath.
2342
Note that relpath must be a relative path, not a full url.
2344
# FIXME: If you create a remoterepository this returns the underlying
2345
# real format, which is incorrect. Actually we should make sure that
2346
# RemoteBzrDir returns a RemoteRepository.
2347
# maybe mbp 20070410
2348
made_control = self.make_bzrdir(relpath, format=format)
2349
return made_control.create_repository(shared=shared)
2351
def make_smart_server(self, path):
2352
smart_server = server.SmartTCPServer_for_testing()
2353
self.start_server(smart_server, self.get_server())
2354
remote_transport = get_transport(smart_server.get_url()).clone(path)
2355
return remote_transport
2357
def make_branch_and_memory_tree(self, relpath, format=None):
2358
"""Create a branch on the default transport and a MemoryTree for it."""
2359
b = self.make_branch(relpath, format=format)
2360
return memorytree.MemoryTree.create_on_branch(b)
2362
def make_branch_builder(self, relpath, format=None):
2363
branch = self.make_branch(relpath, format=format)
2364
return branchbuilder.BranchBuilder(branch=branch)
2366
def overrideEnvironmentForTesting(self):
2367
test_home_dir = self.test_home_dir
2368
if isinstance(test_home_dir, unicode):
2369
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2370
os.environ['HOME'] = test_home_dir
2371
os.environ['BZR_HOME'] = test_home_dir
2374
super(TestCaseWithMemoryTransport, self).setUp()
2375
self._make_test_root()
2376
_currentdir = os.getcwdu()
2377
def _leaveDirectory():
2378
os.chdir(_currentdir)
2379
self.addCleanup(_leaveDirectory)
2380
self.makeAndChdirToTestDir()
2381
self.overrideEnvironmentForTesting()
2382
self.__readonly_server = None
2383
self.__server = None
2384
self.reduceLockdirTimeout()
2386
def setup_smart_server_with_call_log(self):
2387
"""Sets up a smart server as the transport server with a call log."""
2388
self.transport_server = server.SmartTCPServer_for_testing
2389
self.hpss_calls = []
2391
# Skip the current stack down to the caller of
2392
# setup_smart_server_with_call_log
2393
prefix_length = len(traceback.extract_stack()) - 2
2394
def capture_hpss_call(params):
2395
self.hpss_calls.append(
2396
CapturedCall(params, prefix_length))
2397
client._SmartClient.hooks.install_named_hook(
2398
'call', capture_hpss_call, None)
2400
def reset_smart_call_log(self):
2401
self.hpss_calls = []
2404
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2405
"""Derived class that runs a test within a temporary directory.
2407
This is useful for tests that need to create a branch, etc.
2409
The directory is created in a slightly complex way: for each
2410
Python invocation, a new temporary top-level directory is created.
2411
All test cases create their own directory within that. If the
2412
tests complete successfully, the directory is removed.
2414
:ivar test_base_dir: The path of the top-level directory for this
2415
test, which contains a home directory and a work directory.
2417
:ivar test_home_dir: An initially empty directory under test_base_dir
2418
which is used as $HOME for this test.
2420
:ivar test_dir: A directory under test_base_dir used as the current
2421
directory when the test proper is run.
2424
OVERRIDE_PYTHON = 'python'
2426
def check_file_contents(self, filename, expect):
2427
self.log("check contents of file %s" % filename)
2428
contents = file(filename, 'r').read()
2429
if contents != expect:
2430
self.log("expected: %r" % expect)
2431
self.log("actually: %r" % contents)
2432
self.fail("contents of %s not as expected" % filename)
2434
def _getTestDirPrefix(self):
2435
# create a directory within the top level test directory
2436
if sys.platform in ('win32', 'cygwin'):
2437
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2438
# windows is likely to have path-length limits so use a short name
2439
name_prefix = name_prefix[-30:]
2441
name_prefix = re.sub('[/]', '_', self.id())
2444
def makeAndChdirToTestDir(self):
2445
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2447
For TestCaseInTempDir we create a temporary directory based on the test
2448
name and then create two subdirs - test and home under it.
2450
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2451
self._getTestDirPrefix())
2453
for i in range(100):
2454
if os.path.exists(name):
2455
name = name_prefix + '_' + str(i)
2457
# now create test and home directories within this dir
2458
self.test_base_dir = name
2459
self.addCleanup(self.deleteTestDir)
2460
os.mkdir(self.test_base_dir)
2462
self.permit_dir(self.test_base_dir)
2463
# 'sprouting' and 'init' of a branch both walk up the tree to find
2464
# stacking policy to honour; create a bzr dir with an unshared
2465
# repository (but not a branch - our code would be trying to escape
2466
# then!) to stop them, and permit it to be read.
2467
# control = bzrdir.BzrDir.create(self.test_base_dir)
2468
# control.create_repository()
2469
self.test_home_dir = self.test_base_dir + '/home'
2470
os.mkdir(self.test_home_dir)
2471
self.test_dir = self.test_base_dir + '/work'
2472
os.mkdir(self.test_dir)
2473
os.chdir(self.test_dir)
2474
# put name of test inside
2475
f = file(self.test_base_dir + '/name', 'w')
2481
def deleteTestDir(self):
2482
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2483
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2485
def build_tree(self, shape, line_endings='binary', transport=None):
2486
"""Build a test tree according to a pattern.
2488
shape is a sequence of file specifications. If the final
2489
character is '/', a directory is created.
2491
This assumes that all the elements in the tree being built are new.
2493
This doesn't add anything to a branch.
2495
:type shape: list or tuple.
2496
:param line_endings: Either 'binary' or 'native'
2497
in binary mode, exact contents are written in native mode, the
2498
line endings match the default platform endings.
2499
:param transport: A transport to write to, for building trees on VFS's.
2500
If the transport is readonly or None, "." is opened automatically.
2503
if type(shape) not in (list, tuple):
2504
raise AssertionError("Parameter 'shape' should be "
2505
"a list or a tuple. Got %r instead" % (shape,))
2506
# It's OK to just create them using forward slashes on windows.
2507
if transport is None or transport.is_readonly():
2508
transport = get_transport(".")
2510
self.assertIsInstance(name, basestring)
2512
transport.mkdir(urlutils.escape(name[:-1]))
2514
if line_endings == 'binary':
2516
elif line_endings == 'native':
2519
raise errors.BzrError(
2520
'Invalid line ending request %r' % line_endings)
2521
content = "contents of %s%s" % (name.encode('utf-8'), end)
2522
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2524
def build_tree_contents(self, shape):
2525
build_tree_contents(shape)
2527
def assertInWorkingTree(self, path, root_path='.', tree=None):
2528
"""Assert whether path or paths are in the WorkingTree"""
2530
tree = workingtree.WorkingTree.open(root_path)
2531
if not isinstance(path, basestring):
2533
self.assertInWorkingTree(p, tree=tree)
2535
self.assertIsNot(tree.path2id(path), None,
2536
path+' not in working tree.')
2538
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2539
"""Assert whether path or paths are not in the WorkingTree"""
2541
tree = workingtree.WorkingTree.open(root_path)
2542
if not isinstance(path, basestring):
2544
self.assertNotInWorkingTree(p,tree=tree)
2546
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2549
class TestCaseWithTransport(TestCaseInTempDir):
2550
"""A test case that provides get_url and get_readonly_url facilities.
2552
These back onto two transport servers, one for readonly access and one for
2555
If no explicit class is provided for readonly access, a
2556
ReadonlyTransportDecorator is used instead which allows the use of non disk
2557
based read write transports.
2559
If an explicit class is provided for readonly access, that server and the
2560
readwrite one must both define get_url() as resolving to os.getcwd().
2563
def get_vfs_only_server(self):
2564
"""See TestCaseWithMemoryTransport.
2566
This is useful for some tests with specific servers that need
2569
if self.__vfs_server is None:
2570
self.__vfs_server = self.vfs_transport_factory()
2571
self.start_server(self.__vfs_server)
2572
return self.__vfs_server
2574
def make_branch_and_tree(self, relpath, format=None):
2575
"""Create a branch on the transport and a tree locally.
2577
If the transport is not a LocalTransport, the Tree can't be created on
2578
the transport. In that case if the vfs_transport_factory is
2579
LocalURLServer the working tree is created in the local
2580
directory backing the transport, and the returned tree's branch and
2581
repository will also be accessed locally. Otherwise a lightweight
2582
checkout is created and returned.
2584
We do this because we can't physically create a tree in the local
2585
path, with a branch reference to the transport_factory url, and
2586
a branch + repository in the vfs_transport, unless the vfs_transport
2587
namespace is distinct from the local disk - the two branch objects
2588
would collide. While we could construct a tree with its branch object
2589
pointing at the transport_factory transport in memory, reopening it
2590
would behaving unexpectedly, and has in the past caused testing bugs
2591
when we tried to do it that way.
2593
:param format: The BzrDirFormat.
2594
:returns: the WorkingTree.
2596
# TODO: always use the local disk path for the working tree,
2597
# this obviously requires a format that supports branch references
2598
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2600
b = self.make_branch(relpath, format=format)
2602
return b.bzrdir.create_workingtree()
2603
except errors.NotLocalUrl:
2604
# We can only make working trees locally at the moment. If the
2605
# transport can't support them, then we keep the non-disk-backed
2606
# branch and create a local checkout.
2607
if self.vfs_transport_factory is LocalURLServer:
2608
# the branch is colocated on disk, we cannot create a checkout.
2609
# hopefully callers will expect this.
2610
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2611
wt = local_controldir.create_workingtree()
2612
if wt.branch._format != b._format:
2614
# Make sure that assigning to wt._branch fixes wt.branch,
2615
# in case the implementation details of workingtree objects
2617
self.assertIs(b, wt.branch)
2620
return b.create_checkout(relpath, lightweight=True)
2622
def assertIsDirectory(self, relpath, transport):
2623
"""Assert that relpath within transport is a directory.
2625
This may not be possible on all transports; in that case it propagates
2626
a TransportNotPossible.
2629
mode = transport.stat(relpath).st_mode
2630
except errors.NoSuchFile:
2631
self.fail("path %s is not a directory; no such file"
2633
if not stat.S_ISDIR(mode):
2634
self.fail("path %s is not a directory; has mode %#o"
2637
def assertTreesEqual(self, left, right):
2638
"""Check that left and right have the same content and properties."""
2639
# we use a tree delta to check for equality of the content, and we
2640
# manually check for equality of other things such as the parents list.
2641
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2642
differences = left.changes_from(right)
2643
self.assertFalse(differences.has_changed(),
2644
"Trees %r and %r are different: %r" % (left, right, differences))
2647
super(TestCaseWithTransport, self).setUp()
2648
self.__vfs_server = None
2650
def disable_missing_extensions_warning(self):
2651
"""Some tests expect a precise stderr content.
2653
There is no point in forcing them to duplicate the extension related
2656
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2659
class ChrootedTestCase(TestCaseWithTransport):
2660
"""A support class that provides readonly urls outside the local namespace.
2662
This is done by checking if self.transport_server is a MemoryServer. if it
2663
is then we are chrooted already, if it is not then an HttpServer is used
2666
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2667
be used without needed to redo it when a different
2668
subclass is in use ?
2672
super(ChrootedTestCase, self).setUp()
2673
if not self.vfs_transport_factory == MemoryServer:
2674
self.transport_readonly_server = HttpServer
2677
def condition_id_re(pattern):
2678
"""Create a condition filter which performs a re check on a test's id.
2680
:param pattern: A regular expression string.
2681
:return: A callable that returns True if the re matches.
2683
filter_re = osutils.re_compile_checked(pattern, 0,
2685
def condition(test):
2687
return filter_re.search(test_id)
2691
def condition_isinstance(klass_or_klass_list):
2692
"""Create a condition filter which returns isinstance(param, klass).
2694
:return: A callable which when called with one parameter obj return the
2695
result of isinstance(obj, klass_or_klass_list).
2698
return isinstance(obj, klass_or_klass_list)
2702
def condition_id_in_list(id_list):
2703
"""Create a condition filter which verify that test's id in a list.
2705
:param id_list: A TestIdList object.
2706
:return: A callable that returns True if the test's id appears in the list.
2708
def condition(test):
2709
return id_list.includes(test.id())
2713
def condition_id_startswith(starts):
2714
"""Create a condition filter verifying that test's id starts with a string.
2716
:param starts: A list of string.
2717
:return: A callable that returns True if the test's id starts with one of
2720
def condition(test):
2721
for start in starts:
2722
if test.id().startswith(start):
2728
def exclude_tests_by_condition(suite, condition):
2729
"""Create a test suite which excludes some tests from suite.
2731
:param suite: The suite to get tests from.
2732
:param condition: A callable whose result evaluates True when called with a
2733
test case which should be excluded from the result.
2734
:return: A suite which contains the tests found in suite that fail
2738
for test in iter_suite_tests(suite):
2739
if not condition(test):
2741
return TestUtil.TestSuite(result)
2744
def filter_suite_by_condition(suite, condition):
2745
"""Create a test suite by filtering another one.
2747
:param suite: The source suite.
2748
:param condition: A callable whose result evaluates True when called with a
2749
test case which should be included in the result.
2750
:return: A suite which contains the tests found in suite that pass
2754
for test in iter_suite_tests(suite):
2757
return TestUtil.TestSuite(result)
2760
def filter_suite_by_re(suite, pattern):
2761
"""Create a test suite by filtering another one.
2763
:param suite: the source suite
2764
:param pattern: pattern that names must match
2765
:returns: the newly created suite
2767
condition = condition_id_re(pattern)
2768
result_suite = filter_suite_by_condition(suite, condition)
2772
def filter_suite_by_id_list(suite, test_id_list):
2773
"""Create a test suite by filtering another one.
2775
:param suite: The source suite.
2776
:param test_id_list: A list of the test ids to keep as strings.
2777
:returns: the newly created suite
2779
condition = condition_id_in_list(test_id_list)
2780
result_suite = filter_suite_by_condition(suite, condition)
2784
def filter_suite_by_id_startswith(suite, start):
2785
"""Create a test suite by filtering another one.
2787
:param suite: The source suite.
2788
:param start: A list of string the test id must start with one of.
2789
:returns: the newly created suite
2791
condition = condition_id_startswith(start)
2792
result_suite = filter_suite_by_condition(suite, condition)
2796
def exclude_tests_by_re(suite, pattern):
2797
"""Create a test suite which excludes some tests from suite.
2799
:param suite: The suite to get tests from.
2800
:param pattern: A regular expression string. Test ids that match this
2801
pattern will be excluded from the result.
2802
:return: A TestSuite that contains all the tests from suite without the
2803
tests that matched pattern. The order of tests is the same as it was in
2806
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2809
def preserve_input(something):
2810
"""A helper for performing test suite transformation chains.
2812
:param something: Anything you want to preserve.
2818
def randomize_suite(suite):
2819
"""Return a new TestSuite with suite's tests in random order.
2821
The tests in the input suite are flattened into a single suite in order to
2822
accomplish this. Any nested TestSuites are removed to provide global
2825
tests = list(iter_suite_tests(suite))
2826
random.shuffle(tests)
2827
return TestUtil.TestSuite(tests)
2830
def split_suite_by_condition(suite, condition):
2831
"""Split a test suite into two by a condition.
2833
:param suite: The suite to split.
2834
:param condition: The condition to match on. Tests that match this
2835
condition are returned in the first test suite, ones that do not match
2836
are in the second suite.
2837
:return: A tuple of two test suites, where the first contains tests from
2838
suite matching the condition, and the second contains the remainder
2839
from suite. The order within each output suite is the same as it was in
2844
for test in iter_suite_tests(suite):
2846
matched.append(test)
2848
did_not_match.append(test)
2849
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2852
def split_suite_by_re(suite, pattern):
2853
"""Split a test suite into two by a regular expression.
2855
:param suite: The suite to split.
2856
:param pattern: A regular expression string. Test ids that match this
2857
pattern will be in the first test suite returned, and the others in the
2858
second test suite returned.
2859
:return: A tuple of two test suites, where the first contains tests from
2860
suite matching pattern, and the second contains the remainder from
2861
suite. The order within each output suite is the same as it was in
2864
return split_suite_by_condition(suite, condition_id_re(pattern))
2867
def run_suite(suite, name='test', verbose=False, pattern=".*",
2868
stop_on_failure=False,
2869
transport=None, lsprof_timed=None, bench_history=None,
2870
matching_tests_first=None,
2873
exclude_pattern=None,
2876
suite_decorators=None,
2878
result_decorators=None,
2880
"""Run a test suite for bzr selftest.
2882
:param runner_class: The class of runner to use. Must support the
2883
constructor arguments passed by run_suite which are more than standard
2885
:return: A boolean indicating success.
2887
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2892
if runner_class is None:
2893
runner_class = TextTestRunner
2896
runner = runner_class(stream=stream,
2898
verbosity=verbosity,
2899
bench_history=bench_history,
2901
result_decorators=result_decorators,
2903
runner.stop_on_failure=stop_on_failure
2904
# built in decorator factories:
2906
random_order(random_seed, runner),
2907
exclude_tests(exclude_pattern),
2909
if matching_tests_first:
2910
decorators.append(tests_first(pattern))
2912
decorators.append(filter_tests(pattern))
2913
if suite_decorators:
2914
decorators.extend(suite_decorators)
2915
# tell the result object how many tests will be running: (except if
2916
# --parallel=fork is being used. Robert said he will provide a better
2917
# progress design later -- vila 20090817)
2918
if fork_decorator not in decorators:
2919
decorators.append(CountingDecorator)
2920
for decorator in decorators:
2921
suite = decorator(suite)
2923
# Done after test suite decoration to allow randomisation etc
2924
# to take effect, though that is of marginal benefit.
2926
stream.write("Listing tests only ...\n")
2927
for t in iter_suite_tests(suite):
2928
stream.write("%s\n" % (t.id()))
2930
result = runner.run(suite)
2932
return result.wasStrictlySuccessful()
2934
return result.wasSuccessful()
2937
# A registry where get() returns a suite decorator.
2938
parallel_registry = registry.Registry()
2941
def fork_decorator(suite):
2942
concurrency = osutils.local_concurrency()
2943
if concurrency == 1:
2945
from testtools import ConcurrentTestSuite
2946
return ConcurrentTestSuite(suite, fork_for_tests)
2947
parallel_registry.register('fork', fork_decorator)
2950
def subprocess_decorator(suite):
2951
concurrency = osutils.local_concurrency()
2952
if concurrency == 1:
2954
from testtools import ConcurrentTestSuite
2955
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2956
parallel_registry.register('subprocess', subprocess_decorator)
2959
def exclude_tests(exclude_pattern):
2960
"""Return a test suite decorator that excludes tests."""
2961
if exclude_pattern is None:
2962
return identity_decorator
2963
def decorator(suite):
2964
return ExcludeDecorator(suite, exclude_pattern)
2968
def filter_tests(pattern):
2970
return identity_decorator
2971
def decorator(suite):
2972
return FilterTestsDecorator(suite, pattern)
2976
def random_order(random_seed, runner):
2977
"""Return a test suite decorator factory for randomising tests order.
2979
:param random_seed: now, a string which casts to a long, or a long.
2980
:param runner: A test runner with a stream attribute to report on.
2982
if random_seed is None:
2983
return identity_decorator
2984
def decorator(suite):
2985
return RandomDecorator(suite, random_seed, runner.stream)
2989
def tests_first(pattern):
2991
return identity_decorator
2992
def decorator(suite):
2993
return TestFirstDecorator(suite, pattern)
2997
def identity_decorator(suite):
3002
class TestDecorator(TestSuite):
3003
"""A decorator for TestCase/TestSuite objects.
3005
Usually, subclasses should override __iter__(used when flattening test
3006
suites), which we do to filter, reorder, parallelise and so on, run() and
3010
def __init__(self, suite):
3011
TestSuite.__init__(self)
3014
def countTestCases(self):
3017
cases += test.countTestCases()
3024
def run(self, result):
3025
# Use iteration on self, not self._tests, to allow subclasses to hook
3028
if result.shouldStop:
3034
class CountingDecorator(TestDecorator):
3035
"""A decorator which calls result.progress(self.countTestCases)."""
3037
def run(self, result):
3038
progress_method = getattr(result, 'progress', None)
3039
if callable(progress_method):
3040
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3041
return super(CountingDecorator, self).run(result)
3044
class ExcludeDecorator(TestDecorator):
3045
"""A decorator which excludes test matching an exclude pattern."""
3047
def __init__(self, suite, exclude_pattern):
3048
TestDecorator.__init__(self, suite)
3049
self.exclude_pattern = exclude_pattern
3050
self.excluded = False
3054
return iter(self._tests)
3055
self.excluded = True
3056
suite = exclude_tests_by_re(self, self.exclude_pattern)
3058
self.addTests(suite)
3059
return iter(self._tests)
3062
class FilterTestsDecorator(TestDecorator):
3063
"""A decorator which filters tests to those matching a pattern."""
3065
def __init__(self, suite, pattern):
3066
TestDecorator.__init__(self, suite)
3067
self.pattern = pattern
3068
self.filtered = False
3072
return iter(self._tests)
3073
self.filtered = True
3074
suite = filter_suite_by_re(self, self.pattern)
3076
self.addTests(suite)
3077
return iter(self._tests)
3080
class RandomDecorator(TestDecorator):
3081
"""A decorator which randomises the order of its tests."""
3083
def __init__(self, suite, random_seed, stream):
3084
TestDecorator.__init__(self, suite)
3085
self.random_seed = random_seed
3086
self.randomised = False
3087
self.stream = stream
3091
return iter(self._tests)
3092
self.randomised = True
3093
self.stream.write("Randomizing test order using seed %s\n\n" %
3094
(self.actual_seed()))
3095
# Initialise the random number generator.
3096
random.seed(self.actual_seed())
3097
suite = randomize_suite(self)
3099
self.addTests(suite)
3100
return iter(self._tests)
3102
def actual_seed(self):
3103
if self.random_seed == "now":
3104
# We convert the seed to a long to make it reuseable across
3105
# invocations (because the user can reenter it).
3106
self.random_seed = long(time.time())
3108
# Convert the seed to a long if we can
3110
self.random_seed = long(self.random_seed)
3113
return self.random_seed
3116
class TestFirstDecorator(TestDecorator):
3117
"""A decorator which moves named tests to the front."""
3119
def __init__(self, suite, pattern):
3120
TestDecorator.__init__(self, suite)
3121
self.pattern = pattern
3122
self.filtered = False
3126
return iter(self._tests)
3127
self.filtered = True
3128
suites = split_suite_by_re(self, self.pattern)
3130
self.addTests(suites)
3131
return iter(self._tests)
3134
def partition_tests(suite, count):
3135
"""Partition suite into count lists of tests."""
3137
tests = list(iter_suite_tests(suite))
3138
tests_per_process = int(math.ceil(float(len(tests)) / count))
3139
for block in range(count):
3140
low_test = block * tests_per_process
3141
high_test = low_test + tests_per_process
3142
process_tests = tests[low_test:high_test]
3143
result.append(process_tests)
3147
def fork_for_tests(suite):
3148
"""Take suite and start up one runner per CPU by forking()
3150
:return: An iterable of TestCase-like objects which can each have
3151
run(result) called on them to feed tests to result.
3153
concurrency = osutils.local_concurrency()
3155
from subunit import TestProtocolClient, ProtocolTestCase
3156
from subunit.test_results import AutoTimingTestResultDecorator
3157
class TestInOtherProcess(ProtocolTestCase):
3158
# Should be in subunit, I think. RBC.
3159
def __init__(self, stream, pid):
3160
ProtocolTestCase.__init__(self, stream)
3163
def run(self, result):
3165
ProtocolTestCase.run(self, result)
3167
os.waitpid(self.pid, os.WNOHANG)
3169
test_blocks = partition_tests(suite, concurrency)
3170
for process_tests in test_blocks:
3171
process_suite = TestSuite()
3172
process_suite.addTests(process_tests)
3173
c2pread, c2pwrite = os.pipe()
3178
# Leave stderr and stdout open so we can see test noise
3179
# Close stdin so that the child goes away if it decides to
3180
# read from stdin (otherwise its a roulette to see what
3181
# child actually gets keystrokes for pdb etc).
3184
stream = os.fdopen(c2pwrite, 'wb', 1)
3185
subunit_result = AutoTimingTestResultDecorator(
3186
TestProtocolClient(stream))
3187
process_suite.run(subunit_result)
3192
stream = os.fdopen(c2pread, 'rb', 1)
3193
test = TestInOtherProcess(stream, pid)
3198
def reinvoke_for_tests(suite):
3199
"""Take suite and start up one runner per CPU using subprocess().
3201
:return: An iterable of TestCase-like objects which can each have
3202
run(result) called on them to feed tests to result.
3204
concurrency = osutils.local_concurrency()
3206
from subunit import ProtocolTestCase
3207
class TestInSubprocess(ProtocolTestCase):
3208
def __init__(self, process, name):
3209
ProtocolTestCase.__init__(self, process.stdout)
3210
self.process = process
3211
self.process.stdin.close()
3214
def run(self, result):
3216
ProtocolTestCase.run(self, result)
3219
os.unlink(self.name)
3220
# print "pid %d finished" % finished_process
3221
test_blocks = partition_tests(suite, concurrency)
3222
for process_tests in test_blocks:
3223
# ugly; currently reimplement rather than reuses TestCase methods.
3224
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3225
if not os.path.isfile(bzr_path):
3226
# We are probably installed. Assume sys.argv is the right file
3227
bzr_path = sys.argv[0]
3228
bzr_path = [bzr_path]
3229
if sys.platform == "win32":
3230
# if we're on windows, we can't execute the bzr script directly
3231
bzr_path = [sys.executable] + bzr_path
3232
fd, test_list_file_name = tempfile.mkstemp()
3233
test_list_file = os.fdopen(fd, 'wb', 1)
3234
for test in process_tests:
3235
test_list_file.write(test.id() + '\n')
3236
test_list_file.close()
3238
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3240
if '--no-plugins' in sys.argv:
3241
argv.append('--no-plugins')
3242
# stderr=STDOUT would be ideal, but until we prevent noise on
3243
# stderr it can interrupt the subunit protocol.
3244
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3246
test = TestInSubprocess(process, test_list_file_name)
3249
os.unlink(test_list_file_name)
3254
class ForwardingResult(unittest.TestResult):
3256
def __init__(self, target):
3257
unittest.TestResult.__init__(self)
3258
self.result = target
3260
def startTest(self, test):
3261
self.result.startTest(test)
3263
def stopTest(self, test):
3264
self.result.stopTest(test)
3266
def startTestRun(self):
3267
self.result.startTestRun()
3269
def stopTestRun(self):
3270
self.result.stopTestRun()
3272
def addSkip(self, test, reason):
3273
self.result.addSkip(test, reason)
3275
def addSuccess(self, test):
3276
self.result.addSuccess(test)
3278
def addError(self, test, err):
3279
self.result.addError(test, err)
3281
def addFailure(self, test, err):
3282
self.result.addFailure(test, err)
3283
ForwardingResult = testtools.ExtendedToOriginalDecorator
3286
class ProfileResult(ForwardingResult):
3287
"""Generate profiling data for all activity between start and success.
3289
The profile data is appended to the test's _benchcalls attribute and can
3290
be accessed by the forwarded-to TestResult.
3292
While it might be cleaner do accumulate this in stopTest, addSuccess is
3293
where our existing output support for lsprof is, and this class aims to
3294
fit in with that: while it could be moved it's not necessary to accomplish
3295
test profiling, nor would it be dramatically cleaner.
3298
def startTest(self, test):
3299
self.profiler = bzrlib.lsprof.BzrProfiler()
3300
self.profiler.start()
3301
ForwardingResult.startTest(self, test)
3303
def addSuccess(self, test):
3304
stats = self.profiler.stop()
3306
calls = test._benchcalls
3307
except AttributeError:
3308
test._benchcalls = []
3309
calls = test._benchcalls
3310
calls.append(((test.id(), "", ""), stats))
3311
ForwardingResult.addSuccess(self, test)
3313
def stopTest(self, test):
3314
ForwardingResult.stopTest(self, test)
3315
self.profiler = None
3318
# Controlled by "bzr selftest -E=..." option
3319
# Currently supported:
3320
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3321
# preserves any flags supplied at the command line.
3322
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3323
# rather than failing tests. And no longer raise
3324
# LockContention when fctnl locks are not being used
3325
# with proper exclusion rules.
3326
selftest_debug_flags = set()
3329
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3331
test_suite_factory=None,
3334
matching_tests_first=None,
3337
exclude_pattern=None,
3343
suite_decorators=None,
3347
"""Run the whole test suite under the enhanced runner"""
3348
# XXX: Very ugly way to do this...
3349
# Disable warning about old formats because we don't want it to disturb
3350
# any blackbox tests.
3351
from bzrlib import repository
3352
repository._deprecation_warning_done = True
3354
global default_transport
3355
if transport is None:
3356
transport = default_transport
3357
old_transport = default_transport
3358
default_transport = transport
3359
global selftest_debug_flags
3360
old_debug_flags = selftest_debug_flags
3361
if debug_flags is not None:
3362
selftest_debug_flags = set(debug_flags)
3364
if load_list is None:
3367
keep_only = load_test_id_list(load_list)
3369
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3370
for start in starting_with]
3371
if test_suite_factory is None:
3372
# Reduce loading time by loading modules based on the starting_with
3374
suite = test_suite(keep_only, starting_with)
3376
suite = test_suite_factory()
3378
# But always filter as requested.
3379
suite = filter_suite_by_id_startswith(suite, starting_with)
3380
result_decorators = []
3382
result_decorators.append(ProfileResult)
3383
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3384
stop_on_failure=stop_on_failure,
3385
transport=transport,
3386
lsprof_timed=lsprof_timed,
3387
bench_history=bench_history,
3388
matching_tests_first=matching_tests_first,
3389
list_only=list_only,
3390
random_seed=random_seed,
3391
exclude_pattern=exclude_pattern,
3393
runner_class=runner_class,
3394
suite_decorators=suite_decorators,
3396
result_decorators=result_decorators,
3399
default_transport = old_transport
3400
selftest_debug_flags = old_debug_flags
3403
def load_test_id_list(file_name):
3404
"""Load a test id list from a text file.
3406
The format is one test id by line. No special care is taken to impose
3407
strict rules, these test ids are used to filter the test suite so a test id
3408
that do not match an existing test will do no harm. This allows user to add
3409
comments, leave blank lines, etc.
3413
ftest = open(file_name, 'rt')
3415
if e.errno != errno.ENOENT:
3418
raise errors.NoSuchFile(file_name)
3420
for test_name in ftest.readlines():
3421
test_list.append(test_name.strip())
3426
def suite_matches_id_list(test_suite, id_list):
3427
"""Warns about tests not appearing or appearing more than once.
3429
:param test_suite: A TestSuite object.
3430
:param test_id_list: The list of test ids that should be found in
3433
:return: (absents, duplicates) absents is a list containing the test found
3434
in id_list but not in test_suite, duplicates is a list containing the
3435
test found multiple times in test_suite.
3437
When using a prefined test id list, it may occurs that some tests do not
3438
exist anymore or that some tests use the same id. This function warns the
3439
tester about potential problems in his workflow (test lists are volatile)
3440
or in the test suite itself (using the same id for several tests does not
3441
help to localize defects).
3443
# Build a dict counting id occurrences
3445
for test in iter_suite_tests(test_suite):
3447
tests[id] = tests.get(id, 0) + 1
3452
occurs = tests.get(id, 0)
3454
not_found.append(id)
3456
duplicates.append(id)
3458
return not_found, duplicates
3461
class TestIdList(object):
3462
"""Test id list to filter a test suite.
3464
Relying on the assumption that test ids are built as:
3465
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3466
notation, this class offers methods to :
3467
- avoid building a test suite for modules not refered to in the test list,
3468
- keep only the tests listed from the module test suite.
3471
def __init__(self, test_id_list):
3472
# When a test suite needs to be filtered against us we compare test ids
3473
# for equality, so a simple dict offers a quick and simple solution.
3474
self.tests = dict().fromkeys(test_id_list, True)
3476
# While unittest.TestCase have ids like:
3477
# <module>.<class>.<method>[(<param+)],
3478
# doctest.DocTestCase can have ids like:
3481
# <module>.<function>
3482
# <module>.<class>.<method>
3484
# Since we can't predict a test class from its name only, we settle on
3485
# a simple constraint: a test id always begins with its module name.
3488
for test_id in test_id_list:
3489
parts = test_id.split('.')
3490
mod_name = parts.pop(0)
3491
modules[mod_name] = True
3493
mod_name += '.' + part
3494
modules[mod_name] = True
3495
self.modules = modules
3497
def refers_to(self, module_name):
3498
"""Is there tests for the module or one of its sub modules."""
3499
return self.modules.has_key(module_name)
3501
def includes(self, test_id):
3502
return self.tests.has_key(test_id)
3505
class TestPrefixAliasRegistry(registry.Registry):
3506
"""A registry for test prefix aliases.
3508
This helps implement shorcuts for the --starting-with selftest
3509
option. Overriding existing prefixes is not allowed but not fatal (a
3510
warning will be emitted).
3513
def register(self, key, obj, help=None, info=None,
3514
override_existing=False):
3515
"""See Registry.register.
3517
Trying to override an existing alias causes a warning to be emitted,
3518
not a fatal execption.
3521
super(TestPrefixAliasRegistry, self).register(
3522
key, obj, help=help, info=info, override_existing=False)
3524
actual = self.get(key)
3525
note('Test prefix alias %s is already used for %s, ignoring %s'
3526
% (key, actual, obj))
3528
def resolve_alias(self, id_start):
3529
"""Replace the alias by the prefix in the given string.
3531
Using an unknown prefix is an error to help catching typos.
3533
parts = id_start.split('.')
3535
parts[0] = self.get(parts[0])
3537
raise errors.BzrCommandError(
3538
'%s is not a known test prefix alias' % parts[0])
3539
return '.'.join(parts)
3542
test_prefix_alias_registry = TestPrefixAliasRegistry()
3543
"""Registry of test prefix aliases."""
3546
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3547
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3548
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3550
# Obvious higest levels prefixes, feel free to add your own via a plugin
3551
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3552
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3553
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3554
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3555
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3558
def _test_suite_testmod_names():
3559
"""Return the standard list of test module names to test."""
3562
'bzrlib.tests.blackbox',
3563
'bzrlib.tests.commands',
3564
'bzrlib.tests.per_branch',
3565
'bzrlib.tests.per_bzrdir',
3566
'bzrlib.tests.per_foreign_vcs',
3567
'bzrlib.tests.per_interrepository',
3568
'bzrlib.tests.per_intertree',
3569
'bzrlib.tests.per_inventory',
3570
'bzrlib.tests.per_interbranch',
3571
'bzrlib.tests.per_lock',
3572
'bzrlib.tests.per_merger',
3573
'bzrlib.tests.per_transport',
3574
'bzrlib.tests.per_tree',
3575
'bzrlib.tests.per_pack_repository',
3576
'bzrlib.tests.per_repository',
3577
'bzrlib.tests.per_repository_chk',
3578
'bzrlib.tests.per_repository_reference',
3579
'bzrlib.tests.per_uifactory',
3580
'bzrlib.tests.per_versionedfile',
3581
'bzrlib.tests.per_workingtree',
3582
'bzrlib.tests.test__annotator',
3583
'bzrlib.tests.test__bencode',
3584
'bzrlib.tests.test__chk_map',
3585
'bzrlib.tests.test__dirstate_helpers',
3586
'bzrlib.tests.test__groupcompress',
3587
'bzrlib.tests.test__known_graph',
3588
'bzrlib.tests.test__rio',
3589
'bzrlib.tests.test__simple_set',
3590
'bzrlib.tests.test__static_tuple',
3591
'bzrlib.tests.test__walkdirs_win32',
3592
'bzrlib.tests.test_ancestry',
3593
'bzrlib.tests.test_annotate',
3594
'bzrlib.tests.test_api',
3595
'bzrlib.tests.test_atomicfile',
3596
'bzrlib.tests.test_bad_files',
3597
'bzrlib.tests.test_bisect_multi',
3598
'bzrlib.tests.test_branch',
3599
'bzrlib.tests.test_branchbuilder',
3600
'bzrlib.tests.test_btree_index',
3601
'bzrlib.tests.test_bugtracker',
3602
'bzrlib.tests.test_bundle',
3603
'bzrlib.tests.test_bzrdir',
3604
'bzrlib.tests.test__chunks_to_lines',
3605
'bzrlib.tests.test_cache_utf8',
3606
'bzrlib.tests.test_chk_map',
3607
'bzrlib.tests.test_chk_serializer',
3608
'bzrlib.tests.test_chunk_writer',
3609
'bzrlib.tests.test_clean_tree',
3610
'bzrlib.tests.test_cleanup',
3611
'bzrlib.tests.test_commands',
3612
'bzrlib.tests.test_commit',
3613
'bzrlib.tests.test_commit_merge',
3614
'bzrlib.tests.test_config',
3615
'bzrlib.tests.test_conflicts',
3616
'bzrlib.tests.test_counted_lock',
3617
'bzrlib.tests.test_crash',
3618
'bzrlib.tests.test_decorators',
3619
'bzrlib.tests.test_delta',
3620
'bzrlib.tests.test_debug',
3621
'bzrlib.tests.test_deprecated_graph',
3622
'bzrlib.tests.test_diff',
3623
'bzrlib.tests.test_directory_service',
3624
'bzrlib.tests.test_dirstate',
3625
'bzrlib.tests.test_email_message',
3626
'bzrlib.tests.test_eol_filters',
3627
'bzrlib.tests.test_errors',
3628
'bzrlib.tests.test_export',
3629
'bzrlib.tests.test_extract',
3630
'bzrlib.tests.test_fetch',
3631
'bzrlib.tests.test_fifo_cache',
3632
'bzrlib.tests.test_filters',
3633
'bzrlib.tests.test_ftp_transport',
3634
'bzrlib.tests.test_foreign',
3635
'bzrlib.tests.test_generate_docs',
3636
'bzrlib.tests.test_generate_ids',
3637
'bzrlib.tests.test_globbing',
3638
'bzrlib.tests.test_gpg',
3639
'bzrlib.tests.test_graph',
3640
'bzrlib.tests.test_groupcompress',
3641
'bzrlib.tests.test_hashcache',
3642
'bzrlib.tests.test_help',
3643
'bzrlib.tests.test_hooks',
3644
'bzrlib.tests.test_http',
3645
'bzrlib.tests.test_http_response',
3646
'bzrlib.tests.test_https_ca_bundle',
3647
'bzrlib.tests.test_identitymap',
3648
'bzrlib.tests.test_ignores',
3649
'bzrlib.tests.test_index',
3650
'bzrlib.tests.test_info',
3651
'bzrlib.tests.test_inv',
3652
'bzrlib.tests.test_inventory_delta',
3653
'bzrlib.tests.test_knit',
3654
'bzrlib.tests.test_lazy_import',
3655
'bzrlib.tests.test_lazy_regex',
3656
'bzrlib.tests.test_lock',
3657
'bzrlib.tests.test_lockable_files',
3658
'bzrlib.tests.test_lockdir',
3659
'bzrlib.tests.test_log',
3660
'bzrlib.tests.test_lru_cache',
3661
'bzrlib.tests.test_lsprof',
3662
'bzrlib.tests.test_mail_client',
3663
'bzrlib.tests.test_memorytree',
3664
'bzrlib.tests.test_merge',
3665
'bzrlib.tests.test_merge3',
3666
'bzrlib.tests.test_merge_core',
3667
'bzrlib.tests.test_merge_directive',
3668
'bzrlib.tests.test_missing',
3669
'bzrlib.tests.test_msgeditor',
3670
'bzrlib.tests.test_multiparent',
3671
'bzrlib.tests.test_mutabletree',
3672
'bzrlib.tests.test_nonascii',
3673
'bzrlib.tests.test_options',
3674
'bzrlib.tests.test_osutils',
3675
'bzrlib.tests.test_osutils_encodings',
3676
'bzrlib.tests.test_pack',
3677
'bzrlib.tests.test_patch',
3678
'bzrlib.tests.test_patches',
3679
'bzrlib.tests.test_permissions',
3680
'bzrlib.tests.test_plugins',
3681
'bzrlib.tests.test_progress',
3682
'bzrlib.tests.test_read_bundle',
3683
'bzrlib.tests.test_reconcile',
3684
'bzrlib.tests.test_reconfigure',
3685
'bzrlib.tests.test_registry',
3686
'bzrlib.tests.test_remote',
3687
'bzrlib.tests.test_rename_map',
3688
'bzrlib.tests.test_repository',
3689
'bzrlib.tests.test_revert',
3690
'bzrlib.tests.test_revision',
3691
'bzrlib.tests.test_revisionspec',
3692
'bzrlib.tests.test_revisiontree',
3693
'bzrlib.tests.test_rio',
3694
'bzrlib.tests.test_rules',
3695
'bzrlib.tests.test_sampler',
3696
'bzrlib.tests.test_script',
3697
'bzrlib.tests.test_selftest',
3698
'bzrlib.tests.test_serializer',
3699
'bzrlib.tests.test_setup',
3700
'bzrlib.tests.test_sftp_transport',
3701
'bzrlib.tests.test_shelf',
3702
'bzrlib.tests.test_shelf_ui',
3703
'bzrlib.tests.test_smart',
3704
'bzrlib.tests.test_smart_add',
3705
'bzrlib.tests.test_smart_request',
3706
'bzrlib.tests.test_smart_transport',
3707
'bzrlib.tests.test_smtp_connection',
3708
'bzrlib.tests.test_source',
3709
'bzrlib.tests.test_ssh_transport',
3710
'bzrlib.tests.test_status',
3711
'bzrlib.tests.test_store',
3712
'bzrlib.tests.test_strace',
3713
'bzrlib.tests.test_subsume',
3714
'bzrlib.tests.test_switch',
3715
'bzrlib.tests.test_symbol_versioning',
3716
'bzrlib.tests.test_tag',
3717
'bzrlib.tests.test_testament',
3718
'bzrlib.tests.test_textfile',
3719
'bzrlib.tests.test_textmerge',
3720
'bzrlib.tests.test_timestamp',
3721
'bzrlib.tests.test_trace',
3722
'bzrlib.tests.test_transactions',
3723
'bzrlib.tests.test_transform',
3724
'bzrlib.tests.test_transport',
3725
'bzrlib.tests.test_transport_log',
3726
'bzrlib.tests.test_tree',
3727
'bzrlib.tests.test_treebuilder',
3728
'bzrlib.tests.test_tsort',
3729
'bzrlib.tests.test_tuned_gzip',
3730
'bzrlib.tests.test_ui',
3731
'bzrlib.tests.test_uncommit',
3732
'bzrlib.tests.test_upgrade',
3733
'bzrlib.tests.test_upgrade_stacked',
3734
'bzrlib.tests.test_urlutils',
3735
'bzrlib.tests.test_version',
3736
'bzrlib.tests.test_version_info',
3737
'bzrlib.tests.test_weave',
3738
'bzrlib.tests.test_whitebox',
3739
'bzrlib.tests.test_win32utils',
3740
'bzrlib.tests.test_workingtree',
3741
'bzrlib.tests.test_workingtree_4',
3742
'bzrlib.tests.test_wsgi',
3743
'bzrlib.tests.test_xml',
3747
def _test_suite_modules_to_doctest():
3748
"""Return the list of modules to doctest."""
3751
'bzrlib.branchbuilder',
3754
'bzrlib.iterablefile',
3758
'bzrlib.symbol_versioning',
3761
'bzrlib.version_info_formats.format_custom',
3765
def test_suite(keep_only=None, starting_with=None):
3766
"""Build and return TestSuite for the whole of bzrlib.
3768
:param keep_only: A list of test ids limiting the suite returned.
3770
:param starting_with: An id limiting the suite returned to the tests
3773
This function can be replaced if you need to change the default test
3774
suite on a global basis, but it is not encouraged.
3777
loader = TestUtil.TestLoader()
3779
if keep_only is not None:
3780
id_filter = TestIdList(keep_only)
3782
# We take precedence over keep_only because *at loading time* using
3783
# both options means we will load less tests for the same final result.
3784
def interesting_module(name):
3785
for start in starting_with:
3787
# Either the module name starts with the specified string
3788
name.startswith(start)
3789
# or it may contain tests starting with the specified string
3790
or start.startswith(name)
3794
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3796
elif keep_only is not None:
3797
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3798
def interesting_module(name):
3799
return id_filter.refers_to(name)
3802
loader = TestUtil.TestLoader()
3803
def interesting_module(name):
3804
# No filtering, all modules are interesting
3807
suite = loader.suiteClass()
3809
# modules building their suite with loadTestsFromModuleNames
3810
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3812
for mod in _test_suite_modules_to_doctest():
3813
if not interesting_module(mod):
3814
# No tests to keep here, move along
3817
# note that this really does mean "report only" -- doctest
3818
# still runs the rest of the examples
3819
doc_suite = doctest.DocTestSuite(mod,
3820
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3821
except ValueError, e:
3822
print '**failed to get doctest for: %s\n%s' % (mod, e)
3824
if len(doc_suite._tests) == 0:
3825
raise errors.BzrError("no doctests found in %s" % (mod,))
3826
suite.addTest(doc_suite)
3828
default_encoding = sys.getdefaultencoding()
3829
for name, plugin in bzrlib.plugin.plugins().items():
3830
if not interesting_module(plugin.module.__name__):
3832
plugin_suite = plugin.test_suite()
3833
# We used to catch ImportError here and turn it into just a warning,
3834
# but really if you don't have --no-plugins this should be a failure.
3835
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3836
if plugin_suite is None:
3837
plugin_suite = plugin.load_plugin_tests(loader)
3838
if plugin_suite is not None:
3839
suite.addTest(plugin_suite)
3840
if default_encoding != sys.getdefaultencoding():
3841
bzrlib.trace.warning(
3842
'Plugin "%s" tried to reset default encoding to: %s', name,
3843
sys.getdefaultencoding())
3845
sys.setdefaultencoding(default_encoding)
3847
if keep_only is not None:
3848
# Now that the referred modules have loaded their tests, keep only the
3850
suite = filter_suite_by_id_list(suite, id_filter)
3851
# Do some sanity checks on the id_list filtering
3852
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3854
# The tester has used both keep_only and starting_with, so he is
3855
# already aware that some tests are excluded from the list, there
3856
# is no need to tell him which.
3859
# Some tests mentioned in the list are not in the test suite. The
3860
# list may be out of date, report to the tester.
3861
for id in not_found:
3862
bzrlib.trace.warning('"%s" not found in the test suite', id)
3863
for id in duplicates:
3864
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3869
def multiply_scenarios(scenarios_left, scenarios_right):
3870
"""Multiply two sets of scenarios.
3872
:returns: the cartesian product of the two sets of scenarios, that is
3873
a scenario for every possible combination of a left scenario and a
3877
('%s,%s' % (left_name, right_name),
3878
dict(left_dict.items() + right_dict.items()))
3879
for left_name, left_dict in scenarios_left
3880
for right_name, right_dict in scenarios_right]
3883
def multiply_tests(tests, scenarios, result):
3884
"""Multiply tests_list by scenarios into result.
3886
This is the core workhorse for test parameterisation.
3888
Typically the load_tests() method for a per-implementation test suite will
3889
call multiply_tests and return the result.
3891
:param tests: The tests to parameterise.
3892
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3893
scenario_param_dict).
3894
:param result: A TestSuite to add created tests to.
3896
This returns the passed in result TestSuite with the cross product of all
3897
the tests repeated once for each scenario. Each test is adapted by adding
3898
the scenario name at the end of its id(), and updating the test object's
3899
__dict__ with the scenario_param_dict.
3901
>>> import bzrlib.tests.test_sampler
3902
>>> r = multiply_tests(
3903
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3904
... [('one', dict(param=1)),
3905
... ('two', dict(param=2))],
3907
>>> tests = list(iter_suite_tests(r))
3911
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3917
for test in iter_suite_tests(tests):
3918
apply_scenarios(test, scenarios, result)
3922
def apply_scenarios(test, scenarios, result):
3923
"""Apply the scenarios in scenarios to test and add to result.
3925
:param test: The test to apply scenarios to.
3926
:param scenarios: An iterable of scenarios to apply to test.
3928
:seealso: apply_scenario
3930
for scenario in scenarios:
3931
result.addTest(apply_scenario(test, scenario))
3935
def apply_scenario(test, scenario):
3936
"""Copy test and apply scenario to it.
3938
:param test: A test to adapt.
3939
:param scenario: A tuple describing the scenarion.
3940
The first element of the tuple is the new test id.
3941
The second element is a dict containing attributes to set on the
3943
:return: The adapted test.
3945
new_id = "%s(%s)" % (test.id(), scenario[0])
3946
new_test = clone_test(test, new_id)
3947
for name, value in scenario[1].items():
3948
setattr(new_test, name, value)
3952
def clone_test(test, new_id):
3953
"""Clone a test giving it a new id.
3955
:param test: The test to clone.
3956
:param new_id: The id to assign to it.
3957
:return: The new test.
3959
new_test = copy(test)
3960
new_test.id = lambda: new_id
3964
def permute_tests_for_extension(standard_tests, loader, py_module_name,
3966
"""Helper for permutating tests against an extension module.
3968
This is meant to be used inside a modules 'load_tests()' function. It will
3969
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
3970
against both implementations. Setting 'test.module' to the appropriate
3971
module. See bzrlib.tests.test__chk_map.load_tests as an example.
3973
:param standard_tests: A test suite to permute
3974
:param loader: A TestLoader
3975
:param py_module_name: The python path to a python module that can always
3976
be loaded, and will be considered the 'python' implementation. (eg
3977
'bzrlib._chk_map_py')
3978
:param ext_module_name: The python path to an extension module. If the
3979
module cannot be loaded, a single test will be added, which notes that
3980
the module is not available. If it can be loaded, all standard_tests
3981
will be run against that module.
3982
:return: (suite, feature) suite is a test-suite that has all the permuted
3983
tests. feature is the Feature object that can be used to determine if
3984
the module is available.
3987
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
3989
('python', {'module': py_module}),
3991
suite = loader.suiteClass()
3992
feature = ModuleAvailableFeature(ext_module_name)
3993
if feature.available():
3994
scenarios.append(('C', {'module': feature.module}))
3996
# the compiled module isn't available, so we add a failing test
3997
class FailWithoutFeature(TestCase):
3998
def test_fail(self):
3999
self.requireFeature(feature)
4000
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4001
result = multiply_tests(standard_tests, scenarios, suite)
4002
return result, feature
4005
def _rmtree_temp_dir(dirname, test_id=None):
4006
# If LANG=C we probably have created some bogus paths
4007
# which rmtree(unicode) will fail to delete
4008
# so make sure we are using rmtree(str) to delete everything
4009
# except on win32, where rmtree(str) will fail
4010
# since it doesn't have the property of byte-stream paths
4011
# (they are either ascii or mbcs)
4012
if sys.platform == 'win32':
4013
# make sure we are using the unicode win32 api
4014
dirname = unicode(dirname)
4016
dirname = dirname.encode(sys.getfilesystemencoding())
4018
osutils.rmtree(dirname)
4020
# We don't want to fail here because some useful display will be lost
4021
# otherwise. Polluting the tmp dir is bad, but not giving all the
4022
# possible info to the test runner is even worse.
4024
ui.ui_factory.clear_term()
4025
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4026
sys.stderr.write('Unable to remove testing dir %s\n%s'
4027
% (os.path.basename(dirname), e))
4030
class Feature(object):
4031
"""An operating system Feature."""
4034
self._available = None
4036
def available(self):
4037
"""Is the feature available?
4039
:return: True if the feature is available.
4041
if self._available is None:
4042
self._available = self._probe()
4043
return self._available
4046
"""Implement this method in concrete features.
4048
:return: True if the feature is available.
4050
raise NotImplementedError
4053
if getattr(self, 'feature_name', None):
4054
return self.feature_name()
4055
return self.__class__.__name__
4058
class _SymlinkFeature(Feature):
4061
return osutils.has_symlinks()
4063
def feature_name(self):
4066
SymlinkFeature = _SymlinkFeature()
4069
class _HardlinkFeature(Feature):
4072
return osutils.has_hardlinks()
4074
def feature_name(self):
4077
HardlinkFeature = _HardlinkFeature()
4080
class _OsFifoFeature(Feature):
4083
return getattr(os, 'mkfifo', None)
4085
def feature_name(self):
4086
return 'filesystem fifos'
4088
OsFifoFeature = _OsFifoFeature()
4091
class _UnicodeFilenameFeature(Feature):
4092
"""Does the filesystem support Unicode filenames?"""
4096
# Check for character combinations unlikely to be covered by any
4097
# single non-unicode encoding. We use the characters
4098
# - greek small letter alpha (U+03B1) and
4099
# - braille pattern dots-123456 (U+283F).
4100
os.stat(u'\u03b1\u283f')
4101
except UnicodeEncodeError:
4103
except (IOError, OSError):
4104
# The filesystem allows the Unicode filename but the file doesn't
4108
# The filesystem allows the Unicode filename and the file exists,
4112
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4115
class _CompatabilityThunkFeature(Feature):
4116
"""This feature is just a thunk to another feature.
4118
It issues a deprecation warning if it is accessed, to let you know that you
4119
should really use a different feature.
4122
def __init__(self, module, name, this_name, dep_version):
4123
super(_CompatabilityThunkFeature, self).__init__()
4124
self._module = module
4126
self._this_name = this_name
4127
self._dep_version = dep_version
4128
self._feature = None
4131
if self._feature is None:
4132
msg = (self._dep_version % self._this_name) + (
4133
' Use %s.%s instead.' % (self._module, self._name))
4134
symbol_versioning.warn(msg, DeprecationWarning)
4135
mod = __import__(self._module, {}, {}, [self._name])
4136
self._feature = getattr(mod, self._name)
4140
return self._feature._probe()
4143
class ModuleAvailableFeature(Feature):
4144
"""This is a feature than describes a module we want to be available.
4146
Declare the name of the module in __init__(), and then after probing, the
4147
module will be available as 'self.module'.
4149
:ivar module: The module if it is available, else None.
4152
def __init__(self, module_name):
4153
super(ModuleAvailableFeature, self).__init__()
4154
self.module_name = module_name
4158
self._module = __import__(self.module_name, {}, {}, [''])
4165
if self.available(): # Make sure the probe has been done
4169
def feature_name(self):
4170
return self.module_name
4173
# This is kept here for compatibility, it is recommended to use
4174
# 'bzrlib.tests.feature.paramiko' instead
4175
ParamikoFeature = _CompatabilityThunkFeature('bzrlib.tests.features',
4176
'paramiko', 'bzrlib.tests.ParamikoFeature', deprecated_in((2,1,0)))
4179
def probe_unicode_in_user_encoding():
4180
"""Try to encode several unicode strings to use in unicode-aware tests.
4181
Return first successfull match.
4183
:return: (unicode value, encoded plain string value) or (None, None)
4185
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4186
for uni_val in possible_vals:
4188
str_val = uni_val.encode(osutils.get_user_encoding())
4189
except UnicodeEncodeError:
4190
# Try a different character
4193
return uni_val, str_val
4197
def probe_bad_non_ascii(encoding):
4198
"""Try to find [bad] character with code [128..255]
4199
that cannot be decoded to unicode in some encoding.
4200
Return None if all non-ascii characters is valid
4203
for i in xrange(128, 256):
4206
char.decode(encoding)
4207
except UnicodeDecodeError:
4212
class _HTTPSServerFeature(Feature):
4213
"""Some tests want an https Server, check if one is available.
4215
Right now, the only way this is available is under python2.6 which provides
4226
def feature_name(self):
4227
return 'HTTPSServer'
4230
HTTPSServerFeature = _HTTPSServerFeature()
4233
class _UnicodeFilename(Feature):
4234
"""Does the filesystem support Unicode filenames?"""
4239
except UnicodeEncodeError:
4241
except (IOError, OSError):
4242
# The filesystem allows the Unicode filename but the file doesn't
4246
# The filesystem allows the Unicode filename and the file exists,
4250
UnicodeFilename = _UnicodeFilename()
4253
class _UTF8Filesystem(Feature):
4254
"""Is the filesystem UTF-8?"""
4257
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4261
UTF8Filesystem = _UTF8Filesystem()
4264
class _BreakinFeature(Feature):
4265
"""Does this platform support the breakin feature?"""
4268
from bzrlib import breakin
4269
if breakin.determine_signal() is None:
4271
if sys.platform == 'win32':
4272
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4273
# We trigger SIGBREAK via a Console api so we need ctypes to
4274
# access the function
4281
def feature_name(self):
4282
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4285
BreakinFeature = _BreakinFeature()
4288
class _CaseInsCasePresFilenameFeature(Feature):
4289
"""Is the file-system case insensitive, but case-preserving?"""
4292
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4294
# first check truly case-preserving for created files, then check
4295
# case insensitive when opening existing files.
4296
name = osutils.normpath(name)
4297
base, rel = osutils.split(name)
4298
found_rel = osutils.canonical_relpath(base, name)
4299
return (found_rel == rel
4300
and os.path.isfile(name.upper())
4301
and os.path.isfile(name.lower()))
4306
def feature_name(self):
4307
return "case-insensitive case-preserving filesystem"
4309
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4312
class _CaseInsensitiveFilesystemFeature(Feature):
4313
"""Check if underlying filesystem is case-insensitive but *not* case
4316
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4317
# more likely to be case preserving, so this case is rare.
4320
if CaseInsCasePresFilenameFeature.available():
4323
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4324
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4325
TestCaseWithMemoryTransport.TEST_ROOT = root
4327
root = TestCaseWithMemoryTransport.TEST_ROOT
4328
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4330
name_a = osutils.pathjoin(tdir, 'a')
4331
name_A = osutils.pathjoin(tdir, 'A')
4333
result = osutils.isdir(name_A)
4334
_rmtree_temp_dir(tdir)
4337
def feature_name(self):
4338
return 'case-insensitive filesystem'
4340
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4343
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4344
SubUnitFeature = _CompatabilityThunkFeature('bzrlib.tests.features', 'subunit',
4345
'bzrlib.tests.SubUnitFeature', deprecated_in((2,1,0)))
4346
# Only define SubUnitBzrRunner if subunit is available.
4348
from subunit import TestProtocolClient
4349
from subunit.test_results import AutoTimingTestResultDecorator
4350
class SubUnitBzrRunner(TextTestRunner):
4351
def run(self, test):
4352
result = AutoTimingTestResultDecorator(
4353
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
