1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Testing framework extensions"""
19
# TODO: Perhaps there should be an API to find out if bzr running under the
20
# test suite -- some plugins might want to avoid making intrusive changes if
21
# this is the case. However, we want behaviour under to test to diverge as
22
# little as possible, so this should be used rarely if it's added at all.
23
# (Suggestion from j-a-meinel, 2005-11-24)
25
# NOTE: Some classes in here use camelCaseNaming() rather than
26
# underscore_naming(). That's for consistency with unittest; it's not the
27
# general style of bzrlib. Please continue that consistency when adding e.g.
28
# new assertFoo() methods.
33
from cStringIO import StringIO
40
from pprint import pformat
45
from subprocess import Popen, PIPE, STDOUT
55
# nb: check this before importing anything else from within it
56
_testtools_version = getattr(testtools, '__version__', ())
57
if _testtools_version < (0, 9, 2):
58
raise ImportError("need at least testtools 0.9.2: %s is %r"
59
% (testtools.__file__, _testtools_version))
60
from testtools import content
80
import bzrlib.commands
81
import bzrlib.timestamp
83
import bzrlib.inventory
84
import bzrlib.iterablefile
89
# lsprof not available
91
from bzrlib.merge import merge_inner
94
from bzrlib.smart import client, request, server
96
from bzrlib import symbol_versioning
97
from bzrlib.symbol_versioning import (
105
from bzrlib.transport import (
110
import bzrlib.transport
111
from bzrlib.trace import mutter, note
112
from bzrlib.tests import (
117
from bzrlib.tests.http_server import HttpServer
118
from bzrlib.tests.TestUtil import (
122
from bzrlib.ui import NullProgressView
123
from bzrlib.ui.text import TextUIFactory
124
import bzrlib.version_info_formats.format_custom
125
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
127
# Mark this python module as being part of the implementation
128
# of unittest: this gives us better tracebacks where the last
129
# shown frame is the test code, not our assertXYZ.
132
default_transport = test_server.LocalURLServer
135
_unitialized_attr = object()
136
"""A sentinel needed to act as a default value in a method signature."""
139
# Subunit result codes, defined here to prevent a hard dependency on subunit.
144
class ExtendedTestResult(unittest._TextTestResult):
145
"""Accepts, reports and accumulates the results of running tests.
147
Compared to the unittest version this class adds support for
148
profiling, benchmarking, stopping as soon as a test fails, and
149
skipping tests. There are further-specialized subclasses for
150
different types of display.
152
When a test finishes, in whatever way, it calls one of the addSuccess,
153
addFailure or addError classes. These in turn may redirect to a more
154
specific case for the special test results supported by our extended
157
Note that just one of these objects is fed the results from many tests.
162
def __init__(self, stream, descriptions, verbosity,
166
"""Construct new TestResult.
168
:param bench_history: Optionally, a writable file object to accumulate
171
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
172
if bench_history is not None:
173
from bzrlib.version import _get_bzr_source_tree
174
src_tree = _get_bzr_source_tree()
177
revision_id = src_tree.get_parent_ids()[0]
179
# XXX: if this is a brand new tree, do the same as if there
183
# XXX: If there's no branch, what should we do?
185
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
186
self._bench_history = bench_history
187
self.ui = ui.ui_factory
190
self.failure_count = 0
191
self.known_failure_count = 0
193
self.not_applicable_count = 0
194
self.unsupported = {}
196
self._overall_start_time = time.time()
197
self._strict = strict
199
def stopTestRun(self):
202
stopTime = time.time()
203
timeTaken = stopTime - self.startTime
205
self.stream.writeln(self.separator2)
206
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
207
run, run != 1 and "s" or "", timeTaken))
208
self.stream.writeln()
209
if not self.wasSuccessful():
210
self.stream.write("FAILED (")
211
failed, errored = map(len, (self.failures, self.errors))
213
self.stream.write("failures=%d" % failed)
215
if failed: self.stream.write(", ")
216
self.stream.write("errors=%d" % errored)
217
if self.known_failure_count:
218
if failed or errored: self.stream.write(", ")
219
self.stream.write("known_failure_count=%d" %
220
self.known_failure_count)
221
self.stream.writeln(")")
223
if self.known_failure_count:
224
self.stream.writeln("OK (known_failures=%d)" %
225
self.known_failure_count)
227
self.stream.writeln("OK")
228
if self.skip_count > 0:
229
skipped = self.skip_count
230
self.stream.writeln('%d test%s skipped' %
231
(skipped, skipped != 1 and "s" or ""))
233
for feature, count in sorted(self.unsupported.items()):
234
self.stream.writeln("Missing feature '%s' skipped %d tests." %
237
ok = self.wasStrictlySuccessful()
239
ok = self.wasSuccessful()
240
if TestCase._first_thread_leaker_id:
242
'%s is leaking threads among %d leaking tests.\n' % (
243
TestCase._first_thread_leaker_id,
244
TestCase._leaking_threads_tests))
245
# We don't report the main thread as an active one.
247
'%d non-main threads were left active in the end.\n'
248
% (TestCase._active_threads - 1))
250
def getDescription(self, test):
253
def _extractBenchmarkTime(self, testCase, details=None):
254
"""Add a benchmark time for the current test case."""
255
if details and 'benchtime' in details:
256
return float(''.join(details['benchtime'].iter_bytes()))
257
return getattr(testCase, "_benchtime", None)
259
def _elapsedTestTimeString(self):
260
"""Return a time string for the overall time the current test has taken."""
261
return self._formatTime(time.time() - self._start_time)
263
def _testTimeString(self, testCase):
264
benchmark_time = self._extractBenchmarkTime(testCase)
265
if benchmark_time is not None:
266
return self._formatTime(benchmark_time) + "*"
268
return self._elapsedTestTimeString()
270
def _formatTime(self, seconds):
271
"""Format seconds as milliseconds with leading spaces."""
272
# some benchmarks can take thousands of seconds to run, so we need 8
274
return "%8dms" % (1000 * seconds)
276
def _shortened_test_description(self, test):
278
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
281
def startTest(self, test):
282
unittest.TestResult.startTest(self, test)
285
self.report_test_start(test)
286
test.number = self.count
287
self._recordTestStartTime()
289
def startTests(self):
291
if getattr(sys, 'frozen', None) is None:
292
bzr_path = osutils.realpath(sys.argv[0])
294
bzr_path = sys.executable
296
'bzr selftest: %s\n' % (bzr_path,))
299
bzrlib.__path__[0],))
301
' bzr-%s python-%s %s\n' % (
302
bzrlib.version_string,
303
bzrlib._format_version_tuple(sys.version_info),
304
platform.platform(aliased=1),
306
self.stream.write('\n')
308
def _recordTestStartTime(self):
309
"""Record that a test has started."""
310
self._start_time = time.time()
312
def _cleanupLogFile(self, test):
313
# We can only do this if we have one of our TestCases, not if
315
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
316
if setKeepLogfile is not None:
319
def addError(self, test, err):
320
"""Tell result that test finished with an error.
322
Called from the TestCase run() method when the test
323
fails with an unexpected error.
326
unittest.TestResult.addError(self, test, err)
327
self.error_count += 1
328
self.report_error(test, err)
331
self._cleanupLogFile(test)
333
def addFailure(self, test, err):
334
"""Tell result that test failed.
336
Called from the TestCase run() method when the test
337
fails because e.g. an assert() method failed.
340
unittest.TestResult.addFailure(self, test, err)
341
self.failure_count += 1
342
self.report_failure(test, err)
345
self._cleanupLogFile(test)
347
def addSuccess(self, test, details=None):
348
"""Tell result that test completed successfully.
350
Called from the TestCase run()
352
if self._bench_history is not None:
353
benchmark_time = self._extractBenchmarkTime(test, details)
354
if benchmark_time is not None:
355
self._bench_history.write("%s %s\n" % (
356
self._formatTime(benchmark_time),
358
self.report_success(test)
359
self._cleanupLogFile(test)
360
unittest.TestResult.addSuccess(self, test)
361
test._log_contents = ''
363
def addExpectedFailure(self, test, err):
364
self.known_failure_count += 1
365
self.report_known_failure(test, err)
367
def addNotSupported(self, test, feature):
368
"""The test will not be run because of a missing feature.
370
# this can be called in two different ways: it may be that the
371
# test started running, and then raised (through requireFeature)
372
# UnavailableFeature. Alternatively this method can be called
373
# while probing for features before running the test code proper; in
374
# that case we will see startTest and stopTest, but the test will
375
# never actually run.
376
self.unsupported.setdefault(str(feature), 0)
377
self.unsupported[str(feature)] += 1
378
self.report_unsupported(test, feature)
380
def addSkip(self, test, reason):
381
"""A test has not run for 'reason'."""
383
self.report_skip(test, reason)
385
def addNotApplicable(self, test, reason):
386
self.not_applicable_count += 1
387
self.report_not_applicable(test, reason)
389
def _post_mortem(self):
390
"""Start a PDB post mortem session."""
391
if os.environ.get('BZR_TEST_PDB', None):
392
import pdb;pdb.post_mortem()
394
def progress(self, offset, whence):
395
"""The test is adjusting the count of tests to run."""
396
if whence == SUBUNIT_SEEK_SET:
397
self.num_tests = offset
398
elif whence == SUBUNIT_SEEK_CUR:
399
self.num_tests += offset
401
raise errors.BzrError("Unknown whence %r" % whence)
403
def report_cleaning_up(self):
406
def startTestRun(self):
407
self.startTime = time.time()
409
def report_success(self, test):
412
def wasStrictlySuccessful(self):
413
if self.unsupported or self.known_failure_count:
415
return self.wasSuccessful()
418
class TextTestResult(ExtendedTestResult):
419
"""Displays progress and results of tests in text form"""
421
def __init__(self, stream, descriptions, verbosity,
426
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
427
bench_history, strict)
428
# We no longer pass them around, but just rely on the UIFactory stack
431
warnings.warn("Passing pb to TextTestResult is deprecated")
432
self.pb = self.ui.nested_progress_bar()
433
self.pb.show_pct = False
434
self.pb.show_spinner = False
435
self.pb.show_eta = False,
436
self.pb.show_count = False
437
self.pb.show_bar = False
438
self.pb.update_latency = 0
439
self.pb.show_transport_activity = False
441
def stopTestRun(self):
442
# called when the tests that are going to run have run
445
super(TextTestResult, self).stopTestRun()
447
def startTestRun(self):
448
super(TextTestResult, self).startTestRun()
449
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
451
def printErrors(self):
452
# clear the pb to make room for the error listing
454
super(TextTestResult, self).printErrors()
456
def _progress_prefix_text(self):
457
# the longer this text, the less space we have to show the test
459
a = '[%d' % self.count # total that have been run
460
# tests skipped as known not to be relevant are not important enough
462
## if self.skip_count:
463
## a += ', %d skip' % self.skip_count
464
## if self.known_failure_count:
465
## a += '+%dX' % self.known_failure_count
467
a +='/%d' % self.num_tests
469
runtime = time.time() - self._overall_start_time
471
a += '%dm%ds' % (runtime / 60, runtime % 60)
474
total_fail_count = self.error_count + self.failure_count
476
a += ', %d failed' % total_fail_count
477
# if self.unsupported:
478
# a += ', %d missing' % len(self.unsupported)
482
def report_test_start(self, test):
485
self._progress_prefix_text()
487
+ self._shortened_test_description(test))
489
def _test_description(self, test):
490
return self._shortened_test_description(test)
492
def report_error(self, test, err):
493
self.stream.write('ERROR: %s\n %s\n' % (
494
self._test_description(test),
498
def report_failure(self, test, err):
499
self.stream.write('FAIL: %s\n %s\n' % (
500
self._test_description(test),
504
def report_known_failure(self, test, err):
507
def report_skip(self, test, reason):
510
def report_not_applicable(self, test, reason):
513
def report_unsupported(self, test, feature):
514
"""test cannot be run because feature is missing."""
516
def report_cleaning_up(self):
517
self.pb.update('Cleaning up')
520
class VerboseTestResult(ExtendedTestResult):
521
"""Produce long output, with one line per test run plus times"""
523
def _ellipsize_to_right(self, a_string, final_width):
524
"""Truncate and pad a string, keeping the right hand side"""
525
if len(a_string) > final_width:
526
result = '...' + a_string[3-final_width:]
529
return result.ljust(final_width)
531
def startTestRun(self):
532
super(VerboseTestResult, self).startTestRun()
533
self.stream.write('running %d tests...\n' % self.num_tests)
535
def report_test_start(self, test):
537
name = self._shortened_test_description(test)
538
width = osutils.terminal_width()
539
if width is not None:
540
# width needs space for 6 char status, plus 1 for slash, plus an
541
# 11-char time string, plus a trailing blank
542
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
544
self.stream.write(self._ellipsize_to_right(name, width-18))
546
self.stream.write(name)
549
def _error_summary(self, err):
551
return '%s%s' % (indent, err[1])
553
def report_error(self, test, err):
554
self.stream.writeln('ERROR %s\n%s'
555
% (self._testTimeString(test),
556
self._error_summary(err)))
558
def report_failure(self, test, err):
559
self.stream.writeln(' FAIL %s\n%s'
560
% (self._testTimeString(test),
561
self._error_summary(err)))
563
def report_known_failure(self, test, err):
564
self.stream.writeln('XFAIL %s\n%s'
565
% (self._testTimeString(test),
566
self._error_summary(err)))
568
def report_success(self, test):
569
self.stream.writeln(' OK %s' % self._testTimeString(test))
570
for bench_called, stats in getattr(test, '_benchcalls', []):
571
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
572
stats.pprint(file=self.stream)
573
# flush the stream so that we get smooth output. This verbose mode is
574
# used to show the output in PQM.
577
def report_skip(self, test, reason):
578
self.stream.writeln(' SKIP %s\n%s'
579
% (self._testTimeString(test), reason))
581
def report_not_applicable(self, test, reason):
582
self.stream.writeln(' N/A %s\n %s'
583
% (self._testTimeString(test), reason))
585
def report_unsupported(self, test, feature):
586
"""test cannot be run because feature is missing."""
587
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
588
%(self._testTimeString(test), feature))
591
class TextTestRunner(object):
592
stop_on_failure = False
600
result_decorators=None,
602
"""Create a TextTestRunner.
604
:param result_decorators: An optional list of decorators to apply
605
to the result object being used by the runner. Decorators are
606
applied left to right - the first element in the list is the
609
# stream may know claim to know to write unicode strings, but in older
610
# pythons this goes sufficiently wrong that it is a bad idea. (
611
# specifically a built in file with encoding 'UTF-8' will still try
612
# to encode using ascii.
613
new_encoding = osutils.get_terminal_encoding()
614
codec = codecs.lookup(new_encoding)
615
if type(codec) is tuple:
619
encode = codec.encode
620
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
621
stream.encoding = new_encoding
622
self.stream = unittest._WritelnDecorator(stream)
623
self.descriptions = descriptions
624
self.verbosity = verbosity
625
self._bench_history = bench_history
626
self._strict = strict
627
self._result_decorators = result_decorators or []
630
"Run the given test case or test suite."
631
if self.verbosity == 1:
632
result_class = TextTestResult
633
elif self.verbosity >= 2:
634
result_class = VerboseTestResult
635
original_result = result_class(self.stream,
638
bench_history=self._bench_history,
641
# Signal to result objects that look at stop early policy to stop,
642
original_result.stop_early = self.stop_on_failure
643
result = original_result
644
for decorator in self._result_decorators:
645
result = decorator(result)
646
result.stop_early = self.stop_on_failure
647
result.startTestRun()
652
# higher level code uses our extended protocol to determine
653
# what exit code to give.
654
return original_result
657
def iter_suite_tests(suite):
658
"""Return all tests in a suite, recursing through nested suites"""
659
if isinstance(suite, unittest.TestCase):
661
elif isinstance(suite, unittest.TestSuite):
663
for r in iter_suite_tests(item):
666
raise Exception('unknown type %r for object %r'
667
% (type(suite), suite))
670
TestSkipped = testtools.testcase.TestSkipped
673
class TestNotApplicable(TestSkipped):
674
"""A test is not applicable to the situation where it was run.
676
This is only normally raised by parameterized tests, if they find that
677
the instance they're constructed upon does not support one aspect
682
# traceback._some_str fails to format exceptions that have the default
683
# __str__ which does an implicit ascii conversion. However, repr() on those
684
# objects works, for all that its not quite what the doctor may have ordered.
685
def _clever_some_str(value):
690
return repr(value).replace('\\n', '\n')
692
return '<unprintable %s object>' % type(value).__name__
694
traceback._some_str = _clever_some_str
697
# deprecated - use self.knownFailure(), or self.expectFailure.
698
KnownFailure = testtools.testcase._ExpectedFailure
701
class UnavailableFeature(Exception):
702
"""A feature required for this test was not available.
704
This can be considered a specialised form of SkippedTest.
706
The feature should be used to construct the exception.
710
class StringIOWrapper(object):
711
"""A wrapper around cStringIO which just adds an encoding attribute.
713
Internally we can check sys.stdout to see what the output encoding
714
should be. However, cStringIO has no encoding attribute that we can
715
set. So we wrap it instead.
720
def __init__(self, s=None):
722
self.__dict__['_cstring'] = StringIO(s)
724
self.__dict__['_cstring'] = StringIO()
726
def __getattr__(self, name, getattr=getattr):
727
return getattr(self.__dict__['_cstring'], name)
729
def __setattr__(self, name, val):
730
if name == 'encoding':
731
self.__dict__['encoding'] = val
733
return setattr(self._cstring, name, val)
736
class TestUIFactory(TextUIFactory):
737
"""A UI Factory for testing.
739
Hide the progress bar but emit note()s.
741
Allows get_password to be tested without real tty attached.
743
See also CannedInputUIFactory which lets you provide programmatic input in
746
# TODO: Capture progress events at the model level and allow them to be
747
# observed by tests that care.
749
# XXX: Should probably unify more with CannedInputUIFactory or a
750
# particular configuration of TextUIFactory, or otherwise have a clearer
751
# idea of how they're supposed to be different.
752
# See https://bugs.launchpad.net/bzr/+bug/408213
754
def __init__(self, stdout=None, stderr=None, stdin=None):
755
if stdin is not None:
756
# We use a StringIOWrapper to be able to test various
757
# encodings, but the user is still responsible to
758
# encode the string and to set the encoding attribute
759
# of StringIOWrapper.
760
stdin = StringIOWrapper(stdin)
761
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
763
def get_non_echoed_password(self):
764
"""Get password from stdin without trying to handle the echo mode"""
765
password = self.stdin.readline()
768
if password[-1] == '\n':
769
password = password[:-1]
772
def make_progress_view(self):
773
return NullProgressView()
776
class TestCase(testtools.TestCase):
777
"""Base class for bzr unit tests.
779
Tests that need access to disk resources should subclass
780
TestCaseInTempDir not TestCase.
782
Error and debug log messages are redirected from their usual
783
location into a temporary file, the contents of which can be
784
retrieved by _get_log(). We use a real OS file, not an in-memory object,
785
so that it can also capture file IO. When the test completes this file
786
is read into memory and removed from disk.
788
There are also convenience functions to invoke bzr's command-line
789
routine, and to build and check bzr trees.
791
In addition to the usual method of overriding tearDown(), this class also
792
allows subclasses to register functions into the _cleanups list, which is
793
run in order as the object is torn down. It's less likely this will be
794
accidentally overlooked.
797
_active_threads = None
798
_leaking_threads_tests = 0
799
_first_thread_leaker_id = None
800
_log_file_name = None
801
# record lsprof data when performing benchmark calls.
802
_gather_lsprof_in_benchmarks = False
804
def __init__(self, methodName='testMethod'):
805
super(TestCase, self).__init__(methodName)
807
self._directory_isolation = True
808
self.exception_handlers.insert(0,
809
(UnavailableFeature, self._do_unsupported_or_skip))
810
self.exception_handlers.insert(0,
811
(TestNotApplicable, self._do_not_applicable))
814
super(TestCase, self).setUp()
815
for feature in getattr(self, '_test_needs_features', []):
816
self.requireFeature(feature)
817
self._log_contents = None
818
self.addDetail("log", content.Content(content.ContentType("text",
819
"plain", {"charset": "utf8"}),
820
lambda:[self._get_log(keep_log_file=True)]))
821
self._cleanEnvironment()
824
self._benchcalls = []
825
self._benchtime = None
827
self._track_transports()
829
self._clear_debug_flags()
830
TestCase._active_threads = threading.activeCount()
831
self.addCleanup(self._check_leaked_threads)
836
pdb.Pdb().set_trace(sys._getframe().f_back)
838
def _check_leaked_threads(self):
839
active = threading.activeCount()
840
leaked_threads = active - TestCase._active_threads
841
TestCase._active_threads = active
842
# If some tests make the number of threads *decrease*, we'll consider
843
# that they are just observing old threads dieing, not agressively kill
844
# random threads. So we don't report these tests as leaking. The risk
845
# is that we have false positives that way (the test see 2 threads
846
# going away but leak one) but it seems less likely than the actual
847
# false positives (the test see threads going away and does not leak).
848
if leaked_threads > 0:
849
TestCase._leaking_threads_tests += 1
850
if TestCase._first_thread_leaker_id is None:
851
TestCase._first_thread_leaker_id = self.id()
853
def _clear_debug_flags(self):
854
"""Prevent externally set debug flags affecting tests.
856
Tests that want to use debug flags can just set them in the
857
debug_flags set during setup/teardown.
859
# Start with a copy of the current debug flags we can safely modify.
860
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
861
if 'allow_debug' not in selftest_debug_flags:
862
debug.debug_flags.clear()
863
if 'disable_lock_checks' not in selftest_debug_flags:
864
debug.debug_flags.add('strict_locks')
866
def _clear_hooks(self):
867
# prevent hooks affecting tests
868
self._preserved_hooks = {}
869
for key, factory in hooks.known_hooks.items():
870
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
871
current_hooks = hooks.known_hooks_key_to_object(key)
872
self._preserved_hooks[parent] = (name, current_hooks)
873
self.addCleanup(self._restoreHooks)
874
for key, factory in hooks.known_hooks.items():
875
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
876
setattr(parent, name, factory())
877
# this hook should always be installed
878
request._install_hook()
880
def disable_directory_isolation(self):
881
"""Turn off directory isolation checks."""
882
self._directory_isolation = False
884
def enable_directory_isolation(self):
885
"""Enable directory isolation checks."""
886
self._directory_isolation = True
888
def _silenceUI(self):
889
"""Turn off UI for duration of test"""
890
# by default the UI is off; tests can turn it on if they want it.
891
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
893
def _check_locks(self):
894
"""Check that all lock take/release actions have been paired."""
895
# We always check for mismatched locks. If a mismatch is found, we
896
# fail unless -Edisable_lock_checks is supplied to selftest, in which
897
# case we just print a warning.
899
acquired_locks = [lock for action, lock in self._lock_actions
900
if action == 'acquired']
901
released_locks = [lock for action, lock in self._lock_actions
902
if action == 'released']
903
broken_locks = [lock for action, lock in self._lock_actions
904
if action == 'broken']
905
# trivially, given the tests for lock acquistion and release, if we
906
# have as many in each list, it should be ok. Some lock tests also
907
# break some locks on purpose and should be taken into account by
908
# considering that breaking a lock is just a dirty way of releasing it.
909
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
910
message = ('Different number of acquired and '
911
'released or broken locks. (%s, %s + %s)' %
912
(acquired_locks, released_locks, broken_locks))
913
if not self._lock_check_thorough:
914
# Rather than fail, just warn
915
print "Broken test %s: %s" % (self, message)
919
def _track_locks(self):
920
"""Track lock activity during tests."""
921
self._lock_actions = []
922
if 'disable_lock_checks' in selftest_debug_flags:
923
self._lock_check_thorough = False
925
self._lock_check_thorough = True
927
self.addCleanup(self._check_locks)
928
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
929
self._lock_acquired, None)
930
_mod_lock.Lock.hooks.install_named_hook('lock_released',
931
self._lock_released, None)
932
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
933
self._lock_broken, None)
935
def _lock_acquired(self, result):
936
self._lock_actions.append(('acquired', result))
938
def _lock_released(self, result):
939
self._lock_actions.append(('released', result))
941
def _lock_broken(self, result):
942
self._lock_actions.append(('broken', result))
944
def permit_dir(self, name):
945
"""Permit a directory to be used by this test. See permit_url."""
946
name_transport = get_transport(name)
947
self.permit_url(name)
948
self.permit_url(name_transport.base)
950
def permit_url(self, url):
951
"""Declare that url is an ok url to use in this test.
953
Do this for memory transports, temporary test directory etc.
955
Do not do this for the current working directory, /tmp, or any other
956
preexisting non isolated url.
958
if not url.endswith('/'):
960
self._bzr_selftest_roots.append(url)
962
def permit_source_tree_branch_repo(self):
963
"""Permit the source tree bzr is running from to be opened.
965
Some code such as bzrlib.version attempts to read from the bzr branch
966
that bzr is executing from (if any). This method permits that directory
967
to be used in the test suite.
969
path = self.get_source_path()
970
self.record_directory_isolation()
973
workingtree.WorkingTree.open(path)
974
except (errors.NotBranchError, errors.NoWorkingTree):
977
self.enable_directory_isolation()
979
def _preopen_isolate_transport(self, transport):
980
"""Check that all transport openings are done in the test work area."""
981
while isinstance(transport, pathfilter.PathFilteringTransport):
982
# Unwrap pathfiltered transports
983
transport = transport.server.backing_transport.clone(
984
transport._filter('.'))
986
# ReadonlySmartTCPServer_for_testing decorates the backing transport
987
# urls it is given by prepending readonly+. This is appropriate as the
988
# client shouldn't know that the server is readonly (or not readonly).
989
# We could register all servers twice, with readonly+ prepending, but
990
# that makes for a long list; this is about the same but easier to
992
if url.startswith('readonly+'):
993
url = url[len('readonly+'):]
994
self._preopen_isolate_url(url)
996
def _preopen_isolate_url(self, url):
997
if not self._directory_isolation:
999
if self._directory_isolation == 'record':
1000
self._bzr_selftest_roots.append(url)
1002
# This prevents all transports, including e.g. sftp ones backed on disk
1003
# from working unless they are explicitly granted permission. We then
1004
# depend on the code that sets up test transports to check that they are
1005
# appropriately isolated and enable their use by calling
1006
# self.permit_transport()
1007
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1008
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1009
% (url, self._bzr_selftest_roots))
1011
def record_directory_isolation(self):
1012
"""Gather accessed directories to permit later access.
1014
This is used for tests that access the branch bzr is running from.
1016
self._directory_isolation = "record"
1018
def start_server(self, transport_server, backing_server=None):
1019
"""Start transport_server for this test.
1021
This starts the server, registers a cleanup for it and permits the
1022
server's urls to be used.
1024
if backing_server is None:
1025
transport_server.start_server()
1027
transport_server.start_server(backing_server)
1028
self.addCleanup(transport_server.stop_server)
1029
# Obtain a real transport because if the server supplies a password, it
1030
# will be hidden from the base on the client side.
1031
t = get_transport(transport_server.get_url())
1032
# Some transport servers effectively chroot the backing transport;
1033
# others like SFTPServer don't - users of the transport can walk up the
1034
# transport to read the entire backing transport. This wouldn't matter
1035
# except that the workdir tests are given - and that they expect the
1036
# server's url to point at - is one directory under the safety net. So
1037
# Branch operations into the transport will attempt to walk up one
1038
# directory. Chrooting all servers would avoid this but also mean that
1039
# we wouldn't be testing directly against non-root urls. Alternatively
1040
# getting the test framework to start the server with a backing server
1041
# at the actual safety net directory would work too, but this then
1042
# means that the self.get_url/self.get_transport methods would need
1043
# to transform all their results. On balance its cleaner to handle it
1044
# here, and permit a higher url when we have one of these transports.
1045
if t.base.endswith('/work/'):
1046
# we have safety net/test root/work
1047
t = t.clone('../..')
1048
elif isinstance(transport_server,
1049
test_server.SmartTCPServer_for_testing):
1050
# The smart server adds a path similar to work, which is traversed
1051
# up from by the client. But the server is chrooted - the actual
1052
# backing transport is not escaped from, and VFS requests to the
1053
# root will error (because they try to escape the chroot).
1055
while t2.base != t.base:
1058
self.permit_url(t.base)
1060
def _track_transports(self):
1061
"""Install checks for transport usage."""
1062
# TestCase has no safe place it can write to.
1063
self._bzr_selftest_roots = []
1064
# Currently the easiest way to be sure that nothing is going on is to
1065
# hook into bzr dir opening. This leaves a small window of error for
1066
# transport tests, but they are well known, and we can improve on this
1068
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1069
self._preopen_isolate_transport, "Check bzr directories are safe.")
1071
def _ndiff_strings(self, a, b):
1072
"""Return ndiff between two strings containing lines.
1074
A trailing newline is added if missing to make the strings
1076
if b and b[-1] != '\n':
1078
if a and a[-1] != '\n':
1080
difflines = difflib.ndiff(a.splitlines(True),
1082
linejunk=lambda x: False,
1083
charjunk=lambda x: False)
1084
return ''.join(difflines)
1086
def assertEqual(self, a, b, message=''):
1090
except UnicodeError, e:
1091
# If we can't compare without getting a UnicodeError, then
1092
# obviously they are different
1093
mutter('UnicodeError: %s', e)
1096
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1098
pformat(a), pformat(b)))
1100
assertEquals = assertEqual
1102
def assertEqualDiff(self, a, b, message=None):
1103
"""Assert two texts are equal, if not raise an exception.
1105
This is intended for use with multi-line strings where it can
1106
be hard to find the differences by eye.
1108
# TODO: perhaps override assertEquals to call this for strings?
1112
message = "texts not equal:\n"
1114
message = 'first string is missing a final newline.\n'
1116
message = 'second string is missing a final newline.\n'
1117
raise AssertionError(message +
1118
self._ndiff_strings(a, b))
1120
def assertEqualMode(self, mode, mode_test):
1121
self.assertEqual(mode, mode_test,
1122
'mode mismatch %o != %o' % (mode, mode_test))
1124
def assertEqualStat(self, expected, actual):
1125
"""assert that expected and actual are the same stat result.
1127
:param expected: A stat result.
1128
:param actual: A stat result.
1129
:raises AssertionError: If the expected and actual stat values differ
1130
other than by atime.
1132
self.assertEqual(expected.st_size, actual.st_size,
1133
'st_size did not match')
1134
self.assertEqual(expected.st_mtime, actual.st_mtime,
1135
'st_mtime did not match')
1136
self.assertEqual(expected.st_ctime, actual.st_ctime,
1137
'st_ctime did not match')
1138
if sys.platform != 'win32':
1139
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1140
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1141
# odd. Regardless we shouldn't actually try to assert anything
1142
# about their values
1143
self.assertEqual(expected.st_dev, actual.st_dev,
1144
'st_dev did not match')
1145
self.assertEqual(expected.st_ino, actual.st_ino,
1146
'st_ino did not match')
1147
self.assertEqual(expected.st_mode, actual.st_mode,
1148
'st_mode did not match')
1150
def assertLength(self, length, obj_with_len):
1151
"""Assert that obj_with_len is of length length."""
1152
if len(obj_with_len) != length:
1153
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1154
length, len(obj_with_len), obj_with_len))
1156
def assertLogsError(self, exception_class, func, *args, **kwargs):
1157
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1159
from bzrlib import trace
1161
orig_log_exception_quietly = trace.log_exception_quietly
1164
orig_log_exception_quietly()
1165
captured.append(sys.exc_info())
1166
trace.log_exception_quietly = capture
1167
func(*args, **kwargs)
1169
trace.log_exception_quietly = orig_log_exception_quietly
1170
self.assertLength(1, captured)
1171
err = captured[0][1]
1172
self.assertIsInstance(err, exception_class)
1175
def assertPositive(self, val):
1176
"""Assert that val is greater than 0."""
1177
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1179
def assertNegative(self, val):
1180
"""Assert that val is less than 0."""
1181
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1183
def assertStartsWith(self, s, prefix):
1184
if not s.startswith(prefix):
1185
raise AssertionError('string %r does not start with %r' % (s, prefix))
1187
def assertEndsWith(self, s, suffix):
1188
"""Asserts that s ends with suffix."""
1189
if not s.endswith(suffix):
1190
raise AssertionError('string %r does not end with %r' % (s, suffix))
1192
def assertContainsRe(self, haystack, needle_re, flags=0):
1193
"""Assert that a contains something matching a regular expression."""
1194
if not re.search(needle_re, haystack, flags):
1195
if '\n' in haystack or len(haystack) > 60:
1196
# a long string, format it in a more readable way
1197
raise AssertionError(
1198
'pattern "%s" not found in\n"""\\\n%s"""\n'
1199
% (needle_re, haystack))
1201
raise AssertionError('pattern "%s" not found in "%s"'
1202
% (needle_re, haystack))
1204
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1205
"""Assert that a does not match a regular expression"""
1206
if re.search(needle_re, haystack, flags):
1207
raise AssertionError('pattern "%s" found in "%s"'
1208
% (needle_re, haystack))
1210
def assertContainsString(self, haystack, needle):
1211
if haystack.find(needle) == -1:
1212
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1214
def assertSubset(self, sublist, superlist):
1215
"""Assert that every entry in sublist is present in superlist."""
1216
missing = set(sublist) - set(superlist)
1217
if len(missing) > 0:
1218
raise AssertionError("value(s) %r not present in container %r" %
1219
(missing, superlist))
1221
def assertListRaises(self, excClass, func, *args, **kwargs):
1222
"""Fail unless excClass is raised when the iterator from func is used.
1224
Many functions can return generators this makes sure
1225
to wrap them in a list() call to make sure the whole generator
1226
is run, and that the proper exception is raised.
1229
list(func(*args, **kwargs))
1233
if getattr(excClass,'__name__', None) is not None:
1234
excName = excClass.__name__
1236
excName = str(excClass)
1237
raise self.failureException, "%s not raised" % excName
1239
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1240
"""Assert that a callable raises a particular exception.
1242
:param excClass: As for the except statement, this may be either an
1243
exception class, or a tuple of classes.
1244
:param callableObj: A callable, will be passed ``*args`` and
1247
Returns the exception so that you can examine it.
1250
callableObj(*args, **kwargs)
1254
if getattr(excClass,'__name__', None) is not None:
1255
excName = excClass.__name__
1258
excName = str(excClass)
1259
raise self.failureException, "%s not raised" % excName
1261
def assertIs(self, left, right, message=None):
1262
if not (left is right):
1263
if message is not None:
1264
raise AssertionError(message)
1266
raise AssertionError("%r is not %r." % (left, right))
1268
def assertIsNot(self, left, right, message=None):
1270
if message is not None:
1271
raise AssertionError(message)
1273
raise AssertionError("%r is %r." % (left, right))
1275
def assertTransportMode(self, transport, path, mode):
1276
"""Fail if a path does not have mode "mode".
1278
If modes are not supported on this transport, the assertion is ignored.
1280
if not transport._can_roundtrip_unix_modebits():
1282
path_stat = transport.stat(path)
1283
actual_mode = stat.S_IMODE(path_stat.st_mode)
1284
self.assertEqual(mode, actual_mode,
1285
'mode of %r incorrect (%s != %s)'
1286
% (path, oct(mode), oct(actual_mode)))
1288
def assertIsSameRealPath(self, path1, path2):
1289
"""Fail if path1 and path2 points to different files"""
1290
self.assertEqual(osutils.realpath(path1),
1291
osutils.realpath(path2),
1292
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1294
def assertIsInstance(self, obj, kls, msg=None):
1295
"""Fail if obj is not an instance of kls
1297
:param msg: Supplementary message to show if the assertion fails.
1299
if not isinstance(obj, kls):
1300
m = "%r is an instance of %s rather than %s" % (
1301
obj, obj.__class__, kls)
1306
def assertFileEqual(self, content, path):
1307
"""Fail if path does not contain 'content'."""
1308
self.failUnlessExists(path)
1309
f = file(path, 'rb')
1314
self.assertEqualDiff(content, s)
1316
def assertDocstring(self, expected_docstring, obj):
1317
"""Fail if obj does not have expected_docstring"""
1319
# With -OO the docstring should be None instead
1320
self.assertIs(obj.__doc__, None)
1322
self.assertEqual(expected_docstring, obj.__doc__)
1324
def failUnlessExists(self, path):
1325
"""Fail unless path or paths, which may be abs or relative, exist."""
1326
if not isinstance(path, basestring):
1328
self.failUnlessExists(p)
1330
self.failUnless(osutils.lexists(path),path+" does not exist")
1332
def failIfExists(self, path):
1333
"""Fail if path or paths, which may be abs or relative, exist."""
1334
if not isinstance(path, basestring):
1336
self.failIfExists(p)
1338
self.failIf(osutils.lexists(path),path+" exists")
1340
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1341
"""A helper for callDeprecated and applyDeprecated.
1343
:param a_callable: A callable to call.
1344
:param args: The positional arguments for the callable
1345
:param kwargs: The keyword arguments for the callable
1346
:return: A tuple (warnings, result). result is the result of calling
1347
a_callable(``*args``, ``**kwargs``).
1350
def capture_warnings(msg, cls=None, stacklevel=None):
1351
# we've hooked into a deprecation specific callpath,
1352
# only deprecations should getting sent via it.
1353
self.assertEqual(cls, DeprecationWarning)
1354
local_warnings.append(msg)
1355
original_warning_method = symbol_versioning.warn
1356
symbol_versioning.set_warning_method(capture_warnings)
1358
result = a_callable(*args, **kwargs)
1360
symbol_versioning.set_warning_method(original_warning_method)
1361
return (local_warnings, result)
1363
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1364
"""Call a deprecated callable without warning the user.
1366
Note that this only captures warnings raised by symbol_versioning.warn,
1367
not other callers that go direct to the warning module.
1369
To test that a deprecated method raises an error, do something like
1372
self.assertRaises(errors.ReservedId,
1373
self.applyDeprecated,
1374
deprecated_in((1, 5, 0)),
1378
:param deprecation_format: The deprecation format that the callable
1379
should have been deprecated with. This is the same type as the
1380
parameter to deprecated_method/deprecated_function. If the
1381
callable is not deprecated with this format, an assertion error
1383
:param a_callable: A callable to call. This may be a bound method or
1384
a regular function. It will be called with ``*args`` and
1386
:param args: The positional arguments for the callable
1387
:param kwargs: The keyword arguments for the callable
1388
:return: The result of a_callable(``*args``, ``**kwargs``)
1390
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1392
expected_first_warning = symbol_versioning.deprecation_string(
1393
a_callable, deprecation_format)
1394
if len(call_warnings) == 0:
1395
self.fail("No deprecation warning generated by call to %s" %
1397
self.assertEqual(expected_first_warning, call_warnings[0])
1400
def callCatchWarnings(self, fn, *args, **kw):
1401
"""Call a callable that raises python warnings.
1403
The caller's responsible for examining the returned warnings.
1405
If the callable raises an exception, the exception is not
1406
caught and propagates up to the caller. In that case, the list
1407
of warnings is not available.
1409
:returns: ([warning_object, ...], fn_result)
1411
# XXX: This is not perfect, because it completely overrides the
1412
# warnings filters, and some code may depend on suppressing particular
1413
# warnings. It's the easiest way to insulate ourselves from -Werror,
1414
# though. -- Andrew, 20071062
1416
def _catcher(message, category, filename, lineno, file=None, line=None):
1417
# despite the name, 'message' is normally(?) a Warning subclass
1419
wlist.append(message)
1420
saved_showwarning = warnings.showwarning
1421
saved_filters = warnings.filters
1423
warnings.showwarning = _catcher
1424
warnings.filters = []
1425
result = fn(*args, **kw)
1427
warnings.showwarning = saved_showwarning
1428
warnings.filters = saved_filters
1429
return wlist, result
1431
def callDeprecated(self, expected, callable, *args, **kwargs):
1432
"""Assert that a callable is deprecated in a particular way.
1434
This is a very precise test for unusual requirements. The
1435
applyDeprecated helper function is probably more suited for most tests
1436
as it allows you to simply specify the deprecation format being used
1437
and will ensure that that is issued for the function being called.
1439
Note that this only captures warnings raised by symbol_versioning.warn,
1440
not other callers that go direct to the warning module. To catch
1441
general warnings, use callCatchWarnings.
1443
:param expected: a list of the deprecation warnings expected, in order
1444
:param callable: The callable to call
1445
:param args: The positional arguments for the callable
1446
:param kwargs: The keyword arguments for the callable
1448
call_warnings, result = self._capture_deprecation_warnings(callable,
1450
self.assertEqual(expected, call_warnings)
1453
def _startLogFile(self):
1454
"""Send bzr and test log messages to a temporary file.
1456
The file is removed as the test is torn down.
1458
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1459
self._log_file = os.fdopen(fileno, 'w+')
1460
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1461
self._log_file_name = name
1462
self.addCleanup(self._finishLogFile)
1464
def _finishLogFile(self):
1465
"""Finished with the log file.
1467
Close the file and delete it, unless setKeepLogfile was called.
1469
if bzrlib.trace._trace_file:
1470
# flush the log file, to get all content
1471
bzrlib.trace._trace_file.flush()
1472
bzrlib.trace.pop_log_file(self._log_memento)
1473
# Cache the log result and delete the file on disk
1474
self._get_log(False)
1476
def thisFailsStrictLockCheck(self):
1477
"""It is known that this test would fail with -Dstrict_locks.
1479
By default, all tests are run with strict lock checking unless
1480
-Edisable_lock_checks is supplied. However there are some tests which
1481
we know fail strict locks at this point that have not been fixed.
1482
They should call this function to disable the strict checking.
1484
This should be used sparingly, it is much better to fix the locking
1485
issues rather than papering over the problem by calling this function.
1487
debug.debug_flags.discard('strict_locks')
1489
def addCleanup(self, callable, *args, **kwargs):
1490
"""Arrange to run a callable when this case is torn down.
1492
Callables are run in the reverse of the order they are registered,
1493
ie last-in first-out.
1495
self._cleanups.append((callable, args, kwargs))
1497
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1498
"""Overrides an object attribute restoring it after the test.
1500
:param obj: The object that will be mutated.
1502
:param attr_name: The attribute name we want to preserve/override in
1505
:param new: The optional value we want to set the attribute to.
1507
:returns: The actual attr value.
1509
value = getattr(obj, attr_name)
1510
# The actual value is captured by the call below
1511
self.addCleanup(setattr, obj, attr_name, value)
1512
if new is not _unitialized_attr:
1513
setattr(obj, attr_name, new)
1516
def _cleanEnvironment(self):
1518
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1519
'HOME': os.getcwd(),
1520
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1521
# tests do check our impls match APPDATA
1522
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1526
'BZREMAIL': None, # may still be present in the environment
1527
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
1528
'BZR_PROGRESS_BAR': None,
1530
'BZR_PLUGIN_PATH': None,
1531
'BZR_DISABLE_PLUGINS': None,
1532
'BZR_PLUGINS_AT': None,
1533
'BZR_CONCURRENCY': None,
1534
# Make sure that any text ui tests are consistent regardless of
1535
# the environment the test case is run in; you may want tests that
1536
# test other combinations. 'dumb' is a reasonable guess for tests
1537
# going to a pipe or a StringIO.
1541
'BZR_COLUMNS': '80',
1543
'SSH_AUTH_SOCK': None,
1547
'https_proxy': None,
1548
'HTTPS_PROXY': None,
1553
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1554
# least. If you do (care), please update this comment
1558
'BZR_REMOTE_PATH': None,
1559
# Generally speaking, we don't want apport reporting on crashes in
1560
# the test envirnoment unless we're specifically testing apport,
1561
# so that it doesn't leak into the real system environment. We
1562
# use an env var so it propagates to subprocesses.
1563
'APPORT_DISABLE': '1',
1566
self.addCleanup(self._restoreEnvironment)
1567
for name, value in new_env.iteritems():
1568
self._captureVar(name, value)
1570
def _captureVar(self, name, newvalue):
1571
"""Set an environment variable, and reset it when finished."""
1572
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1574
def _restoreEnvironment(self):
1575
for name, value in self._old_env.iteritems():
1576
osutils.set_or_unset_env(name, value)
1578
def _restoreHooks(self):
1579
for klass, (name, hooks) in self._preserved_hooks.items():
1580
setattr(klass, name, hooks)
1582
def knownFailure(self, reason):
1583
"""This test has failed for some known reason."""
1584
raise KnownFailure(reason)
1586
def _do_skip(self, result, reason):
1587
addSkip = getattr(result, 'addSkip', None)
1588
if not callable(addSkip):
1589
result.addSuccess(result)
1591
addSkip(self, reason)
1594
def _do_known_failure(self, result, e):
1595
err = sys.exc_info()
1596
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1597
if addExpectedFailure is not None:
1598
addExpectedFailure(self, err)
1600
result.addSuccess(self)
1603
def _do_not_applicable(self, result, e):
1605
reason = 'No reason given'
1608
addNotApplicable = getattr(result, 'addNotApplicable', None)
1609
if addNotApplicable is not None:
1610
result.addNotApplicable(self, reason)
1612
self._do_skip(result, reason)
1615
def _do_unsupported_or_skip(self, result, e):
1617
addNotSupported = getattr(result, 'addNotSupported', None)
1618
if addNotSupported is not None:
1619
result.addNotSupported(self, reason)
1621
self._do_skip(result, reason)
1623
def time(self, callable, *args, **kwargs):
1624
"""Run callable and accrue the time it takes to the benchmark time.
1626
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1627
this will cause lsprofile statistics to be gathered and stored in
1630
if self._benchtime is None:
1631
self.addDetail('benchtime', content.Content(content.ContentType(
1632
"text", "plain"), lambda:[str(self._benchtime)]))
1636
if not self._gather_lsprof_in_benchmarks:
1637
return callable(*args, **kwargs)
1639
# record this benchmark
1640
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1642
self._benchcalls.append(((callable, args, kwargs), stats))
1645
self._benchtime += time.time() - start
1647
def log(self, *args):
1650
def _get_log(self, keep_log_file=False):
1651
"""Internal helper to get the log from bzrlib.trace for this test.
1653
Please use self.getDetails, or self.get_log to access this in test case
1656
:param keep_log_file: When True, if the log is still a file on disk
1657
leave it as a file on disk. When False, if the log is still a file
1658
on disk, the log file is deleted and the log preserved as
1660
:return: A string containing the log.
1662
if self._log_contents is not None:
1664
self._log_contents.decode('utf8')
1665
except UnicodeDecodeError:
1666
unicodestr = self._log_contents.decode('utf8', 'replace')
1667
self._log_contents = unicodestr.encode('utf8')
1668
return self._log_contents
1670
if bzrlib.trace._trace_file:
1671
# flush the log file, to get all content
1672
bzrlib.trace._trace_file.flush()
1673
if self._log_file_name is not None:
1674
logfile = open(self._log_file_name)
1676
log_contents = logfile.read()
1680
log_contents.decode('utf8')
1681
except UnicodeDecodeError:
1682
unicodestr = log_contents.decode('utf8', 'replace')
1683
log_contents = unicodestr.encode('utf8')
1684
if not keep_log_file:
1686
max_close_attempts = 100
1687
first_close_error = None
1688
while close_attempts < max_close_attempts:
1691
self._log_file.close()
1692
except IOError, ioe:
1693
if ioe.errno is None:
1694
# No errno implies 'close() called during
1695
# concurrent operation on the same file object', so
1696
# retry. Probably a thread is trying to write to
1698
if first_close_error is None:
1699
first_close_error = ioe
1704
if close_attempts > 1:
1706
'Unable to close log file on first attempt, '
1707
'will retry: %s\n' % (first_close_error,))
1708
if close_attempts == max_close_attempts:
1710
'Unable to close log file after %d attempts.\n'
1711
% (max_close_attempts,))
1712
self._log_file = None
1713
# Permit multiple calls to get_log until we clean it up in
1715
self._log_contents = log_contents
1717
os.remove(self._log_file_name)
1719
if sys.platform == 'win32' and e.errno == errno.EACCES:
1720
sys.stderr.write(('Unable to delete log file '
1721
' %r\n' % self._log_file_name))
1724
self._log_file_name = None
1727
return "No log file content and no log file name."
1730
"""Get a unicode string containing the log from bzrlib.trace.
1732
Undecodable characters are replaced.
1734
return u"".join(self.getDetails()['log'].iter_text())
1736
def requireFeature(self, feature):
1737
"""This test requires a specific feature is available.
1739
:raises UnavailableFeature: When feature is not available.
1741
if not feature.available():
1742
raise UnavailableFeature(feature)
1744
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1746
"""Run bazaar command line, splitting up a string command line."""
1747
if isinstance(args, basestring):
1748
# shlex don't understand unicode strings,
1749
# so args should be plain string (bialix 20070906)
1750
args = list(shlex.split(str(args)))
1751
return self._run_bzr_core(args, retcode=retcode,
1752
encoding=encoding, stdin=stdin, working_dir=working_dir,
1755
def _run_bzr_core(self, args, retcode, encoding, stdin,
1757
# Clear chk_map page cache, because the contents are likely to mask
1759
chk_map.clear_cache()
1760
if encoding is None:
1761
encoding = osutils.get_user_encoding()
1762
stdout = StringIOWrapper()
1763
stderr = StringIOWrapper()
1764
stdout.encoding = encoding
1765
stderr.encoding = encoding
1767
self.log('run bzr: %r', args)
1768
# FIXME: don't call into logging here
1769
handler = logging.StreamHandler(stderr)
1770
handler.setLevel(logging.INFO)
1771
logger = logging.getLogger('')
1772
logger.addHandler(handler)
1773
old_ui_factory = ui.ui_factory
1774
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1777
if working_dir is not None:
1778
cwd = osutils.getcwd()
1779
os.chdir(working_dir)
1783
result = self.apply_redirected(ui.ui_factory.stdin,
1785
bzrlib.commands.run_bzr_catch_user_errors,
1787
except KeyboardInterrupt:
1788
# Reraise KeyboardInterrupt with contents of redirected stdout
1789
# and stderr as arguments, for tests which are interested in
1790
# stdout and stderr and are expecting the exception.
1791
out = stdout.getvalue()
1792
err = stderr.getvalue()
1794
self.log('output:\n%r', out)
1796
self.log('errors:\n%r', err)
1797
raise KeyboardInterrupt(out, err)
1799
logger.removeHandler(handler)
1800
ui.ui_factory = old_ui_factory
1804
out = stdout.getvalue()
1805
err = stderr.getvalue()
1807
self.log('output:\n%r', out)
1809
self.log('errors:\n%r', err)
1810
if retcode is not None:
1811
self.assertEquals(retcode, result,
1812
message='Unexpected return code')
1813
return result, out, err
1815
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1816
working_dir=None, error_regexes=[], output_encoding=None):
1817
"""Invoke bzr, as if it were run from the command line.
1819
The argument list should not include the bzr program name - the
1820
first argument is normally the bzr command. Arguments may be
1821
passed in three ways:
1823
1- A list of strings, eg ["commit", "a"]. This is recommended
1824
when the command contains whitespace or metacharacters, or
1825
is built up at run time.
1827
2- A single string, eg "add a". This is the most convenient
1828
for hardcoded commands.
1830
This runs bzr through the interface that catches and reports
1831
errors, and with logging set to something approximating the
1832
default, so that error reporting can be checked.
1834
This should be the main method for tests that want to exercise the
1835
overall behavior of the bzr application (rather than a unit test
1836
or a functional test of the library.)
1838
This sends the stdout/stderr results into the test's log,
1839
where it may be useful for debugging. See also run_captured.
1841
:keyword stdin: A string to be used as stdin for the command.
1842
:keyword retcode: The status code the command should return;
1844
:keyword working_dir: The directory to run the command in
1845
:keyword error_regexes: A list of expected error messages. If
1846
specified they must be seen in the error output of the command.
1848
retcode, out, err = self._run_bzr_autosplit(
1853
working_dir=working_dir,
1855
self.assertIsInstance(error_regexes, (list, tuple))
1856
for regex in error_regexes:
1857
self.assertContainsRe(err, regex)
1860
def run_bzr_error(self, error_regexes, *args, **kwargs):
1861
"""Run bzr, and check that stderr contains the supplied regexes
1863
:param error_regexes: Sequence of regular expressions which
1864
must each be found in the error output. The relative ordering
1866
:param args: command-line arguments for bzr
1867
:param kwargs: Keyword arguments which are interpreted by run_bzr
1868
This function changes the default value of retcode to be 3,
1869
since in most cases this is run when you expect bzr to fail.
1871
:return: (out, err) The actual output of running the command (in case
1872
you want to do more inspection)
1876
# Make sure that commit is failing because there is nothing to do
1877
self.run_bzr_error(['no changes to commit'],
1878
['commit', '-m', 'my commit comment'])
1879
# Make sure --strict is handling an unknown file, rather than
1880
# giving us the 'nothing to do' error
1881
self.build_tree(['unknown'])
1882
self.run_bzr_error(['Commit refused because there are unknown files'],
1883
['commit', --strict', '-m', 'my commit comment'])
1885
kwargs.setdefault('retcode', 3)
1886
kwargs['error_regexes'] = error_regexes
1887
out, err = self.run_bzr(*args, **kwargs)
1890
def run_bzr_subprocess(self, *args, **kwargs):
1891
"""Run bzr in a subprocess for testing.
1893
This starts a new Python interpreter and runs bzr in there.
1894
This should only be used for tests that have a justifiable need for
1895
this isolation: e.g. they are testing startup time, or signal
1896
handling, or early startup code, etc. Subprocess code can't be
1897
profiled or debugged so easily.
1899
:keyword retcode: The status code that is expected. Defaults to 0. If
1900
None is supplied, the status code is not checked.
1901
:keyword env_changes: A dictionary which lists changes to environment
1902
variables. A value of None will unset the env variable.
1903
The values must be strings. The change will only occur in the
1904
child, so you don't need to fix the environment after running.
1905
:keyword universal_newlines: Convert CRLF => LF
1906
:keyword allow_plugins: By default the subprocess is run with
1907
--no-plugins to ensure test reproducibility. Also, it is possible
1908
for system-wide plugins to create unexpected output on stderr,
1909
which can cause unnecessary test failures.
1911
env_changes = kwargs.get('env_changes', {})
1912
working_dir = kwargs.get('working_dir', None)
1913
allow_plugins = kwargs.get('allow_plugins', False)
1915
if isinstance(args[0], list):
1917
elif isinstance(args[0], basestring):
1918
args = list(shlex.split(args[0]))
1920
raise ValueError("passing varargs to run_bzr_subprocess")
1921
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1922
working_dir=working_dir,
1923
allow_plugins=allow_plugins)
1924
# We distinguish between retcode=None and retcode not passed.
1925
supplied_retcode = kwargs.get('retcode', 0)
1926
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1927
universal_newlines=kwargs.get('universal_newlines', False),
1930
def start_bzr_subprocess(self, process_args, env_changes=None,
1931
skip_if_plan_to_signal=False,
1933
allow_plugins=False):
1934
"""Start bzr in a subprocess for testing.
1936
This starts a new Python interpreter and runs bzr in there.
1937
This should only be used for tests that have a justifiable need for
1938
this isolation: e.g. they are testing startup time, or signal
1939
handling, or early startup code, etc. Subprocess code can't be
1940
profiled or debugged so easily.
1942
:param process_args: a list of arguments to pass to the bzr executable,
1943
for example ``['--version']``.
1944
:param env_changes: A dictionary which lists changes to environment
1945
variables. A value of None will unset the env variable.
1946
The values must be strings. The change will only occur in the
1947
child, so you don't need to fix the environment after running.
1948
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1950
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1952
:returns: Popen object for the started process.
1954
if skip_if_plan_to_signal:
1955
if not getattr(os, 'kill', None):
1956
raise TestSkipped("os.kill not available.")
1958
if env_changes is None:
1962
def cleanup_environment():
1963
for env_var, value in env_changes.iteritems():
1964
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1966
def restore_environment():
1967
for env_var, value in old_env.iteritems():
1968
osutils.set_or_unset_env(env_var, value)
1970
bzr_path = self.get_bzr_path()
1973
if working_dir is not None:
1974
cwd = osutils.getcwd()
1975
os.chdir(working_dir)
1978
# win32 subprocess doesn't support preexec_fn
1979
# so we will avoid using it on all platforms, just to
1980
# make sure the code path is used, and we don't break on win32
1981
cleanup_environment()
1982
command = [sys.executable]
1983
# frozen executables don't need the path to bzr
1984
if getattr(sys, "frozen", None) is None:
1985
command.append(bzr_path)
1986
if not allow_plugins:
1987
command.append('--no-plugins')
1988
command.extend(process_args)
1989
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1991
restore_environment()
1997
def _popen(self, *args, **kwargs):
1998
"""Place a call to Popen.
2000
Allows tests to override this method to intercept the calls made to
2001
Popen for introspection.
2003
return Popen(*args, **kwargs)
2005
def get_source_path(self):
2006
"""Return the path of the directory containing bzrlib."""
2007
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2009
def get_bzr_path(self):
2010
"""Return the path of the 'bzr' executable for this test suite."""
2011
bzr_path = self.get_source_path()+'/bzr'
2012
if not os.path.isfile(bzr_path):
2013
# We are probably installed. Assume sys.argv is the right file
2014
bzr_path = sys.argv[0]
2017
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2018
universal_newlines=False, process_args=None):
2019
"""Finish the execution of process.
2021
:param process: the Popen object returned from start_bzr_subprocess.
2022
:param retcode: The status code that is expected. Defaults to 0. If
2023
None is supplied, the status code is not checked.
2024
:param send_signal: an optional signal to send to the process.
2025
:param universal_newlines: Convert CRLF => LF
2026
:returns: (stdout, stderr)
2028
if send_signal is not None:
2029
os.kill(process.pid, send_signal)
2030
out, err = process.communicate()
2032
if universal_newlines:
2033
out = out.replace('\r\n', '\n')
2034
err = err.replace('\r\n', '\n')
2036
if retcode is not None and retcode != process.returncode:
2037
if process_args is None:
2038
process_args = "(unknown args)"
2039
mutter('Output of bzr %s:\n%s', process_args, out)
2040
mutter('Error for bzr %s:\n%s', process_args, err)
2041
self.fail('Command bzr %s failed with retcode %s != %s'
2042
% (process_args, retcode, process.returncode))
2045
def check_inventory_shape(self, inv, shape):
2046
"""Compare an inventory to a list of expected names.
2048
Fail if they are not precisely equal.
2051
shape = list(shape) # copy
2052
for path, ie in inv.entries():
2053
name = path.replace('\\', '/')
2054
if ie.kind == 'directory':
2061
self.fail("expected paths not found in inventory: %r" % shape)
2063
self.fail("unexpected paths found in inventory: %r" % extras)
2065
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2066
a_callable=None, *args, **kwargs):
2067
"""Call callable with redirected std io pipes.
2069
Returns the return code."""
2070
if not callable(a_callable):
2071
raise ValueError("a_callable must be callable.")
2073
stdin = StringIO("")
2075
if getattr(self, "_log_file", None) is not None:
2076
stdout = self._log_file
2080
if getattr(self, "_log_file", None is not None):
2081
stderr = self._log_file
2084
real_stdin = sys.stdin
2085
real_stdout = sys.stdout
2086
real_stderr = sys.stderr
2091
return a_callable(*args, **kwargs)
2093
sys.stdout = real_stdout
2094
sys.stderr = real_stderr
2095
sys.stdin = real_stdin
2097
def reduceLockdirTimeout(self):
2098
"""Reduce the default lock timeout for the duration of the test, so that
2099
if LockContention occurs during a test, it does so quickly.
2101
Tests that expect to provoke LockContention errors should call this.
2103
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2105
def make_utf8_encoded_stringio(self, encoding_type=None):
2106
"""Return a StringIOWrapper instance, that will encode Unicode
2109
if encoding_type is None:
2110
encoding_type = 'strict'
2112
output_encoding = 'utf-8'
2113
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2114
sio.encoding = output_encoding
2117
def disable_verb(self, verb):
2118
"""Disable a smart server verb for one test."""
2119
from bzrlib.smart import request
2120
request_handlers = request.request_handlers
2121
orig_method = request_handlers.get(verb)
2122
request_handlers.remove(verb)
2123
self.addCleanup(request_handlers.register, verb, orig_method)
2126
class CapturedCall(object):
2127
"""A helper for capturing smart server calls for easy debug analysis."""
2129
def __init__(self, params, prefix_length):
2130
"""Capture the call with params and skip prefix_length stack frames."""
2133
# The last 5 frames are the __init__, the hook frame, and 3 smart
2134
# client frames. Beyond this we could get more clever, but this is good
2136
stack = traceback.extract_stack()[prefix_length:-5]
2137
self.stack = ''.join(traceback.format_list(stack))
2140
return self.call.method
2143
return self.call.method
2149
class TestCaseWithMemoryTransport(TestCase):
2150
"""Common test class for tests that do not need disk resources.
2152
Tests that need disk resources should derive from TestCaseWithTransport.
2154
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2156
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2157
a directory which does not exist. This serves to help ensure test isolation
2158
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2159
must exist. However, TestCaseWithMemoryTransport does not offer local
2160
file defaults for the transport in tests, nor does it obey the command line
2161
override, so tests that accidentally write to the common directory should
2164
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2165
a .bzr directory that stops us ascending higher into the filesystem.
2171
def __init__(self, methodName='runTest'):
2172
# allow test parameterization after test construction and before test
2173
# execution. Variables that the parameterizer sets need to be
2174
# ones that are not set by setUp, or setUp will trash them.
2175
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2176
self.vfs_transport_factory = default_transport
2177
self.transport_server = None
2178
self.transport_readonly_server = None
2179
self.__vfs_server = None
2181
def get_transport(self, relpath=None):
2182
"""Return a writeable transport.
2184
This transport is for the test scratch space relative to
2187
:param relpath: a path relative to the base url.
2189
t = get_transport(self.get_url(relpath))
2190
self.assertFalse(t.is_readonly())
2193
def get_readonly_transport(self, relpath=None):
2194
"""Return a readonly transport for the test scratch space
2196
This can be used to test that operations which should only need
2197
readonly access in fact do not try to write.
2199
:param relpath: a path relative to the base url.
2201
t = get_transport(self.get_readonly_url(relpath))
2202
self.assertTrue(t.is_readonly())
2205
def create_transport_readonly_server(self):
2206
"""Create a transport server from class defined at init.
2208
This is mostly a hook for daughter classes.
2210
return self.transport_readonly_server()
2212
def get_readonly_server(self):
2213
"""Get the server instance for the readonly transport
2215
This is useful for some tests with specific servers to do diagnostics.
2217
if self.__readonly_server is None:
2218
if self.transport_readonly_server is None:
2219
# readonly decorator requested
2220
self.__readonly_server = test_server.ReadonlyServer()
2222
# explicit readonly transport.
2223
self.__readonly_server = self.create_transport_readonly_server()
2224
self.start_server(self.__readonly_server,
2225
self.get_vfs_only_server())
2226
return self.__readonly_server
2228
def get_readonly_url(self, relpath=None):
2229
"""Get a URL for the readonly transport.
2231
This will either be backed by '.' or a decorator to the transport
2232
used by self.get_url()
2233
relpath provides for clients to get a path relative to the base url.
2234
These should only be downwards relative, not upwards.
2236
base = self.get_readonly_server().get_url()
2237
return self._adjust_url(base, relpath)
2239
def get_vfs_only_server(self):
2240
"""Get the vfs only read/write server instance.
2242
This is useful for some tests with specific servers that need
2245
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2246
is no means to override it.
2248
if self.__vfs_server is None:
2249
self.__vfs_server = memory.MemoryServer()
2250
self.start_server(self.__vfs_server)
2251
return self.__vfs_server
2253
def get_server(self):
2254
"""Get the read/write server instance.
2256
This is useful for some tests with specific servers that need
2259
This is built from the self.transport_server factory. If that is None,
2260
then the self.get_vfs_server is returned.
2262
if self.__server is None:
2263
if (self.transport_server is None or self.transport_server is
2264
self.vfs_transport_factory):
2265
self.__server = self.get_vfs_only_server()
2267
# bring up a decorated means of access to the vfs only server.
2268
self.__server = self.transport_server()
2269
self.start_server(self.__server, self.get_vfs_only_server())
2270
return self.__server
2272
def _adjust_url(self, base, relpath):
2273
"""Get a URL (or maybe a path) for the readwrite transport.
2275
This will either be backed by '.' or to an equivalent non-file based
2277
relpath provides for clients to get a path relative to the base url.
2278
These should only be downwards relative, not upwards.
2280
if relpath is not None and relpath != '.':
2281
if not base.endswith('/'):
2283
# XXX: Really base should be a url; we did after all call
2284
# get_url()! But sometimes it's just a path (from
2285
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2286
# to a non-escaped local path.
2287
if base.startswith('./') or base.startswith('/'):
2290
base += urlutils.escape(relpath)
2293
def get_url(self, relpath=None):
2294
"""Get a URL (or maybe a path) for the readwrite transport.
2296
This will either be backed by '.' or to an equivalent non-file based
2298
relpath provides for clients to get a path relative to the base url.
2299
These should only be downwards relative, not upwards.
2301
base = self.get_server().get_url()
2302
return self._adjust_url(base, relpath)
2304
def get_vfs_only_url(self, relpath=None):
2305
"""Get a URL (or maybe a path for the plain old vfs transport.
2307
This will never be a smart protocol. It always has all the
2308
capabilities of the local filesystem, but it might actually be a
2309
MemoryTransport or some other similar virtual filesystem.
2311
This is the backing transport (if any) of the server returned by
2312
get_url and get_readonly_url.
2314
:param relpath: provides for clients to get a path relative to the base
2315
url. These should only be downwards relative, not upwards.
2318
base = self.get_vfs_only_server().get_url()
2319
return self._adjust_url(base, relpath)
2321
def _create_safety_net(self):
2322
"""Make a fake bzr directory.
2324
This prevents any tests propagating up onto the TEST_ROOT directory's
2327
root = TestCaseWithMemoryTransport.TEST_ROOT
2328
bzrdir.BzrDir.create_standalone_workingtree(root)
2330
def _check_safety_net(self):
2331
"""Check that the safety .bzr directory have not been touched.
2333
_make_test_root have created a .bzr directory to prevent tests from
2334
propagating. This method ensures than a test did not leaked.
2336
root = TestCaseWithMemoryTransport.TEST_ROOT
2337
self.permit_url(get_transport(root).base)
2338
wt = workingtree.WorkingTree.open(root)
2339
last_rev = wt.last_revision()
2340
if last_rev != 'null:':
2341
# The current test have modified the /bzr directory, we need to
2342
# recreate a new one or all the followng tests will fail.
2343
# If you need to inspect its content uncomment the following line
2344
# import pdb; pdb.set_trace()
2345
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2346
self._create_safety_net()
2347
raise AssertionError('%s/.bzr should not be modified' % root)
2349
def _make_test_root(self):
2350
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2351
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2352
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2354
TestCaseWithMemoryTransport.TEST_ROOT = root
2356
self._create_safety_net()
2358
# The same directory is used by all tests, and we're not
2359
# specifically told when all tests are finished. This will do.
2360
atexit.register(_rmtree_temp_dir, root)
2362
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2363
self.addCleanup(self._check_safety_net)
2365
def makeAndChdirToTestDir(self):
2366
"""Create a temporary directories for this one test.
2368
This must set self.test_home_dir and self.test_dir and chdir to
2371
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2373
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2374
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2375
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2376
self.permit_dir(self.test_dir)
2378
def make_branch(self, relpath, format=None):
2379
"""Create a branch on the transport at relpath."""
2380
repo = self.make_repository(relpath, format=format)
2381
return repo.bzrdir.create_branch()
2383
def make_bzrdir(self, relpath, format=None):
2385
# might be a relative or absolute path
2386
maybe_a_url = self.get_url(relpath)
2387
segments = maybe_a_url.rsplit('/', 1)
2388
t = get_transport(maybe_a_url)
2389
if len(segments) > 1 and segments[-1] not in ('', '.'):
2393
if isinstance(format, basestring):
2394
format = bzrdir.format_registry.make_bzrdir(format)
2395
return format.initialize_on_transport(t)
2396
except errors.UninitializableFormat:
2397
raise TestSkipped("Format %s is not initializable." % format)
2399
def make_repository(self, relpath, shared=False, format=None):
2400
"""Create a repository on our default transport at relpath.
2402
Note that relpath must be a relative path, not a full url.
2404
# FIXME: If you create a remoterepository this returns the underlying
2405
# real format, which is incorrect. Actually we should make sure that
2406
# RemoteBzrDir returns a RemoteRepository.
2407
# maybe mbp 20070410
2408
made_control = self.make_bzrdir(relpath, format=format)
2409
return made_control.create_repository(shared=shared)
2411
def make_smart_server(self, path, backing_server=None):
2412
if backing_server is None:
2413
backing_server = self.get_server()
2414
smart_server = test_server.SmartTCPServer_for_testing()
2415
self.start_server(smart_server, backing_server)
2416
remote_transport = get_transport(smart_server.get_url()).clone(path)
2417
return remote_transport
2419
def make_branch_and_memory_tree(self, relpath, format=None):
2420
"""Create a branch on the default transport and a MemoryTree for it."""
2421
b = self.make_branch(relpath, format=format)
2422
return memorytree.MemoryTree.create_on_branch(b)
2424
def make_branch_builder(self, relpath, format=None):
2425
branch = self.make_branch(relpath, format=format)
2426
return branchbuilder.BranchBuilder(branch=branch)
2428
def overrideEnvironmentForTesting(self):
2429
test_home_dir = self.test_home_dir
2430
if isinstance(test_home_dir, unicode):
2431
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2432
os.environ['HOME'] = test_home_dir
2433
os.environ['BZR_HOME'] = test_home_dir
2436
super(TestCaseWithMemoryTransport, self).setUp()
2437
self._make_test_root()
2438
self.addCleanup(os.chdir, os.getcwdu())
2439
self.makeAndChdirToTestDir()
2440
self.overrideEnvironmentForTesting()
2441
self.__readonly_server = None
2442
self.__server = None
2443
self.reduceLockdirTimeout()
2445
def setup_smart_server_with_call_log(self):
2446
"""Sets up a smart server as the transport server with a call log."""
2447
self.transport_server = test_server.SmartTCPServer_for_testing
2448
self.hpss_calls = []
2450
# Skip the current stack down to the caller of
2451
# setup_smart_server_with_call_log
2452
prefix_length = len(traceback.extract_stack()) - 2
2453
def capture_hpss_call(params):
2454
self.hpss_calls.append(
2455
CapturedCall(params, prefix_length))
2456
client._SmartClient.hooks.install_named_hook(
2457
'call', capture_hpss_call, None)
2459
def reset_smart_call_log(self):
2460
self.hpss_calls = []
2463
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2464
"""Derived class that runs a test within a temporary directory.
2466
This is useful for tests that need to create a branch, etc.
2468
The directory is created in a slightly complex way: for each
2469
Python invocation, a new temporary top-level directory is created.
2470
All test cases create their own directory within that. If the
2471
tests complete successfully, the directory is removed.
2473
:ivar test_base_dir: The path of the top-level directory for this
2474
test, which contains a home directory and a work directory.
2476
:ivar test_home_dir: An initially empty directory under test_base_dir
2477
which is used as $HOME for this test.
2479
:ivar test_dir: A directory under test_base_dir used as the current
2480
directory when the test proper is run.
2483
OVERRIDE_PYTHON = 'python'
2485
def check_file_contents(self, filename, expect):
2486
self.log("check contents of file %s" % filename)
2492
if contents != expect:
2493
self.log("expected: %r" % expect)
2494
self.log("actually: %r" % contents)
2495
self.fail("contents of %s not as expected" % filename)
2497
def _getTestDirPrefix(self):
2498
# create a directory within the top level test directory
2499
if sys.platform in ('win32', 'cygwin'):
2500
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2501
# windows is likely to have path-length limits so use a short name
2502
name_prefix = name_prefix[-30:]
2504
name_prefix = re.sub('[/]', '_', self.id())
2507
def makeAndChdirToTestDir(self):
2508
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2510
For TestCaseInTempDir we create a temporary directory based on the test
2511
name and then create two subdirs - test and home under it.
2513
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2514
self._getTestDirPrefix())
2516
for i in range(100):
2517
if os.path.exists(name):
2518
name = name_prefix + '_' + str(i)
2520
# now create test and home directories within this dir
2521
self.test_base_dir = name
2522
self.addCleanup(self.deleteTestDir)
2523
os.mkdir(self.test_base_dir)
2525
self.permit_dir(self.test_base_dir)
2526
# 'sprouting' and 'init' of a branch both walk up the tree to find
2527
# stacking policy to honour; create a bzr dir with an unshared
2528
# repository (but not a branch - our code would be trying to escape
2529
# then!) to stop them, and permit it to be read.
2530
# control = bzrdir.BzrDir.create(self.test_base_dir)
2531
# control.create_repository()
2532
self.test_home_dir = self.test_base_dir + '/home'
2533
os.mkdir(self.test_home_dir)
2534
self.test_dir = self.test_base_dir + '/work'
2535
os.mkdir(self.test_dir)
2536
os.chdir(self.test_dir)
2537
# put name of test inside
2538
f = file(self.test_base_dir + '/name', 'w')
2544
def deleteTestDir(self):
2545
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2546
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2548
def build_tree(self, shape, line_endings='binary', transport=None):
2549
"""Build a test tree according to a pattern.
2551
shape is a sequence of file specifications. If the final
2552
character is '/', a directory is created.
2554
This assumes that all the elements in the tree being built are new.
2556
This doesn't add anything to a branch.
2558
:type shape: list or tuple.
2559
:param line_endings: Either 'binary' or 'native'
2560
in binary mode, exact contents are written in native mode, the
2561
line endings match the default platform endings.
2562
:param transport: A transport to write to, for building trees on VFS's.
2563
If the transport is readonly or None, "." is opened automatically.
2566
if type(shape) not in (list, tuple):
2567
raise AssertionError("Parameter 'shape' should be "
2568
"a list or a tuple. Got %r instead" % (shape,))
2569
# It's OK to just create them using forward slashes on windows.
2570
if transport is None or transport.is_readonly():
2571
transport = get_transport(".")
2573
self.assertIsInstance(name, basestring)
2575
transport.mkdir(urlutils.escape(name[:-1]))
2577
if line_endings == 'binary':
2579
elif line_endings == 'native':
2582
raise errors.BzrError(
2583
'Invalid line ending request %r' % line_endings)
2584
content = "contents of %s%s" % (name.encode('utf-8'), end)
2585
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2587
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2589
def assertInWorkingTree(self, path, root_path='.', tree=None):
2590
"""Assert whether path or paths are in the WorkingTree"""
2592
tree = workingtree.WorkingTree.open(root_path)
2593
if not isinstance(path, basestring):
2595
self.assertInWorkingTree(p, tree=tree)
2597
self.assertIsNot(tree.path2id(path), None,
2598
path+' not in working tree.')
2600
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2601
"""Assert whether path or paths are not in the WorkingTree"""
2603
tree = workingtree.WorkingTree.open(root_path)
2604
if not isinstance(path, basestring):
2606
self.assertNotInWorkingTree(p,tree=tree)
2608
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2611
class TestCaseWithTransport(TestCaseInTempDir):
2612
"""A test case that provides get_url and get_readonly_url facilities.
2614
These back onto two transport servers, one for readonly access and one for
2617
If no explicit class is provided for readonly access, a
2618
ReadonlyTransportDecorator is used instead which allows the use of non disk
2619
based read write transports.
2621
If an explicit class is provided for readonly access, that server and the
2622
readwrite one must both define get_url() as resolving to os.getcwd().
2625
def get_vfs_only_server(self):
2626
"""See TestCaseWithMemoryTransport.
2628
This is useful for some tests with specific servers that need
2631
if self.__vfs_server is None:
2632
self.__vfs_server = self.vfs_transport_factory()
2633
self.start_server(self.__vfs_server)
2634
return self.__vfs_server
2636
def make_branch_and_tree(self, relpath, format=None):
2637
"""Create a branch on the transport and a tree locally.
2639
If the transport is not a LocalTransport, the Tree can't be created on
2640
the transport. In that case if the vfs_transport_factory is
2641
LocalURLServer the working tree is created in the local
2642
directory backing the transport, and the returned tree's branch and
2643
repository will also be accessed locally. Otherwise a lightweight
2644
checkout is created and returned.
2646
We do this because we can't physically create a tree in the local
2647
path, with a branch reference to the transport_factory url, and
2648
a branch + repository in the vfs_transport, unless the vfs_transport
2649
namespace is distinct from the local disk - the two branch objects
2650
would collide. While we could construct a tree with its branch object
2651
pointing at the transport_factory transport in memory, reopening it
2652
would behaving unexpectedly, and has in the past caused testing bugs
2653
when we tried to do it that way.
2655
:param format: The BzrDirFormat.
2656
:returns: the WorkingTree.
2658
# TODO: always use the local disk path for the working tree,
2659
# this obviously requires a format that supports branch references
2660
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2662
b = self.make_branch(relpath, format=format)
2664
return b.bzrdir.create_workingtree()
2665
except errors.NotLocalUrl:
2666
# We can only make working trees locally at the moment. If the
2667
# transport can't support them, then we keep the non-disk-backed
2668
# branch and create a local checkout.
2669
if self.vfs_transport_factory is test_server.LocalURLServer:
2670
# the branch is colocated on disk, we cannot create a checkout.
2671
# hopefully callers will expect this.
2672
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2673
wt = local_controldir.create_workingtree()
2674
if wt.branch._format != b._format:
2676
# Make sure that assigning to wt._branch fixes wt.branch,
2677
# in case the implementation details of workingtree objects
2679
self.assertIs(b, wt.branch)
2682
return b.create_checkout(relpath, lightweight=True)
2684
def assertIsDirectory(self, relpath, transport):
2685
"""Assert that relpath within transport is a directory.
2687
This may not be possible on all transports; in that case it propagates
2688
a TransportNotPossible.
2691
mode = transport.stat(relpath).st_mode
2692
except errors.NoSuchFile:
2693
self.fail("path %s is not a directory; no such file"
2695
if not stat.S_ISDIR(mode):
2696
self.fail("path %s is not a directory; has mode %#o"
2699
def assertTreesEqual(self, left, right):
2700
"""Check that left and right have the same content and properties."""
2701
# we use a tree delta to check for equality of the content, and we
2702
# manually check for equality of other things such as the parents list.
2703
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2704
differences = left.changes_from(right)
2705
self.assertFalse(differences.has_changed(),
2706
"Trees %r and %r are different: %r" % (left, right, differences))
2709
super(TestCaseWithTransport, self).setUp()
2710
self.__vfs_server = None
2712
def disable_missing_extensions_warning(self):
2713
"""Some tests expect a precise stderr content.
2715
There is no point in forcing them to duplicate the extension related
2718
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2721
class ChrootedTestCase(TestCaseWithTransport):
2722
"""A support class that provides readonly urls outside the local namespace.
2724
This is done by checking if self.transport_server is a MemoryServer. if it
2725
is then we are chrooted already, if it is not then an HttpServer is used
2728
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2729
be used without needed to redo it when a different
2730
subclass is in use ?
2734
super(ChrootedTestCase, self).setUp()
2735
if not self.vfs_transport_factory == memory.MemoryServer:
2736
self.transport_readonly_server = HttpServer
2739
def condition_id_re(pattern):
2740
"""Create a condition filter which performs a re check on a test's id.
2742
:param pattern: A regular expression string.
2743
:return: A callable that returns True if the re matches.
2745
filter_re = osutils.re_compile_checked(pattern, 0,
2747
def condition(test):
2749
return filter_re.search(test_id)
2753
def condition_isinstance(klass_or_klass_list):
2754
"""Create a condition filter which returns isinstance(param, klass).
2756
:return: A callable which when called with one parameter obj return the
2757
result of isinstance(obj, klass_or_klass_list).
2760
return isinstance(obj, klass_or_klass_list)
2764
def condition_id_in_list(id_list):
2765
"""Create a condition filter which verify that test's id in a list.
2767
:param id_list: A TestIdList object.
2768
:return: A callable that returns True if the test's id appears in the list.
2770
def condition(test):
2771
return id_list.includes(test.id())
2775
def condition_id_startswith(starts):
2776
"""Create a condition filter verifying that test's id starts with a string.
2778
:param starts: A list of string.
2779
:return: A callable that returns True if the test's id starts with one of
2782
def condition(test):
2783
for start in starts:
2784
if test.id().startswith(start):
2790
def exclude_tests_by_condition(suite, condition):
2791
"""Create a test suite which excludes some tests from suite.
2793
:param suite: The suite to get tests from.
2794
:param condition: A callable whose result evaluates True when called with a
2795
test case which should be excluded from the result.
2796
:return: A suite which contains the tests found in suite that fail
2800
for test in iter_suite_tests(suite):
2801
if not condition(test):
2803
return TestUtil.TestSuite(result)
2806
def filter_suite_by_condition(suite, condition):
2807
"""Create a test suite by filtering another one.
2809
:param suite: The source suite.
2810
:param condition: A callable whose result evaluates True when called with a
2811
test case which should be included in the result.
2812
:return: A suite which contains the tests found in suite that pass
2816
for test in iter_suite_tests(suite):
2819
return TestUtil.TestSuite(result)
2822
def filter_suite_by_re(suite, pattern):
2823
"""Create a test suite by filtering another one.
2825
:param suite: the source suite
2826
:param pattern: pattern that names must match
2827
:returns: the newly created suite
2829
condition = condition_id_re(pattern)
2830
result_suite = filter_suite_by_condition(suite, condition)
2834
def filter_suite_by_id_list(suite, test_id_list):
2835
"""Create a test suite by filtering another one.
2837
:param suite: The source suite.
2838
:param test_id_list: A list of the test ids to keep as strings.
2839
:returns: the newly created suite
2841
condition = condition_id_in_list(test_id_list)
2842
result_suite = filter_suite_by_condition(suite, condition)
2846
def filter_suite_by_id_startswith(suite, start):
2847
"""Create a test suite by filtering another one.
2849
:param suite: The source suite.
2850
:param start: A list of string the test id must start with one of.
2851
:returns: the newly created suite
2853
condition = condition_id_startswith(start)
2854
result_suite = filter_suite_by_condition(suite, condition)
2858
def exclude_tests_by_re(suite, pattern):
2859
"""Create a test suite which excludes some tests from suite.
2861
:param suite: The suite to get tests from.
2862
:param pattern: A regular expression string. Test ids that match this
2863
pattern will be excluded from the result.
2864
:return: A TestSuite that contains all the tests from suite without the
2865
tests that matched pattern. The order of tests is the same as it was in
2868
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2871
def preserve_input(something):
2872
"""A helper for performing test suite transformation chains.
2874
:param something: Anything you want to preserve.
2880
def randomize_suite(suite):
2881
"""Return a new TestSuite with suite's tests in random order.
2883
The tests in the input suite are flattened into a single suite in order to
2884
accomplish this. Any nested TestSuites are removed to provide global
2887
tests = list(iter_suite_tests(suite))
2888
random.shuffle(tests)
2889
return TestUtil.TestSuite(tests)
2892
def split_suite_by_condition(suite, condition):
2893
"""Split a test suite into two by a condition.
2895
:param suite: The suite to split.
2896
:param condition: The condition to match on. Tests that match this
2897
condition are returned in the first test suite, ones that do not match
2898
are in the second suite.
2899
:return: A tuple of two test suites, where the first contains tests from
2900
suite matching the condition, and the second contains the remainder
2901
from suite. The order within each output suite is the same as it was in
2906
for test in iter_suite_tests(suite):
2908
matched.append(test)
2910
did_not_match.append(test)
2911
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2914
def split_suite_by_re(suite, pattern):
2915
"""Split a test suite into two by a regular expression.
2917
:param suite: The suite to split.
2918
:param pattern: A regular expression string. Test ids that match this
2919
pattern will be in the first test suite returned, and the others in the
2920
second test suite returned.
2921
:return: A tuple of two test suites, where the first contains tests from
2922
suite matching pattern, and the second contains the remainder from
2923
suite. The order within each output suite is the same as it was in
2926
return split_suite_by_condition(suite, condition_id_re(pattern))
2929
def run_suite(suite, name='test', verbose=False, pattern=".*",
2930
stop_on_failure=False,
2931
transport=None, lsprof_timed=None, bench_history=None,
2932
matching_tests_first=None,
2935
exclude_pattern=None,
2938
suite_decorators=None,
2940
result_decorators=None,
2942
"""Run a test suite for bzr selftest.
2944
:param runner_class: The class of runner to use. Must support the
2945
constructor arguments passed by run_suite which are more than standard
2947
:return: A boolean indicating success.
2949
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2954
if runner_class is None:
2955
runner_class = TextTestRunner
2958
runner = runner_class(stream=stream,
2960
verbosity=verbosity,
2961
bench_history=bench_history,
2963
result_decorators=result_decorators,
2965
runner.stop_on_failure=stop_on_failure
2966
# built in decorator factories:
2968
random_order(random_seed, runner),
2969
exclude_tests(exclude_pattern),
2971
if matching_tests_first:
2972
decorators.append(tests_first(pattern))
2974
decorators.append(filter_tests(pattern))
2975
if suite_decorators:
2976
decorators.extend(suite_decorators)
2977
# tell the result object how many tests will be running: (except if
2978
# --parallel=fork is being used. Robert said he will provide a better
2979
# progress design later -- vila 20090817)
2980
if fork_decorator not in decorators:
2981
decorators.append(CountingDecorator)
2982
for decorator in decorators:
2983
suite = decorator(suite)
2985
# Done after test suite decoration to allow randomisation etc
2986
# to take effect, though that is of marginal benefit.
2988
stream.write("Listing tests only ...\n")
2989
for t in iter_suite_tests(suite):
2990
stream.write("%s\n" % (t.id()))
2992
result = runner.run(suite)
2994
return result.wasStrictlySuccessful()
2996
return result.wasSuccessful()
2999
# A registry where get() returns a suite decorator.
3000
parallel_registry = registry.Registry()
3003
def fork_decorator(suite):
3004
concurrency = osutils.local_concurrency()
3005
if concurrency == 1:
3007
from testtools import ConcurrentTestSuite
3008
return ConcurrentTestSuite(suite, fork_for_tests)
3009
parallel_registry.register('fork', fork_decorator)
3012
def subprocess_decorator(suite):
3013
concurrency = osutils.local_concurrency()
3014
if concurrency == 1:
3016
from testtools import ConcurrentTestSuite
3017
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3018
parallel_registry.register('subprocess', subprocess_decorator)
3021
def exclude_tests(exclude_pattern):
3022
"""Return a test suite decorator that excludes tests."""
3023
if exclude_pattern is None:
3024
return identity_decorator
3025
def decorator(suite):
3026
return ExcludeDecorator(suite, exclude_pattern)
3030
def filter_tests(pattern):
3032
return identity_decorator
3033
def decorator(suite):
3034
return FilterTestsDecorator(suite, pattern)
3038
def random_order(random_seed, runner):
3039
"""Return a test suite decorator factory for randomising tests order.
3041
:param random_seed: now, a string which casts to a long, or a long.
3042
:param runner: A test runner with a stream attribute to report on.
3044
if random_seed is None:
3045
return identity_decorator
3046
def decorator(suite):
3047
return RandomDecorator(suite, random_seed, runner.stream)
3051
def tests_first(pattern):
3053
return identity_decorator
3054
def decorator(suite):
3055
return TestFirstDecorator(suite, pattern)
3059
def identity_decorator(suite):
3064
class TestDecorator(TestSuite):
3065
"""A decorator for TestCase/TestSuite objects.
3067
Usually, subclasses should override __iter__(used when flattening test
3068
suites), which we do to filter, reorder, parallelise and so on, run() and
3072
def __init__(self, suite):
3073
TestSuite.__init__(self)
3076
def countTestCases(self):
3079
cases += test.countTestCases()
3086
def run(self, result):
3087
# Use iteration on self, not self._tests, to allow subclasses to hook
3090
if result.shouldStop:
3096
class CountingDecorator(TestDecorator):
3097
"""A decorator which calls result.progress(self.countTestCases)."""
3099
def run(self, result):
3100
progress_method = getattr(result, 'progress', None)
3101
if callable(progress_method):
3102
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3103
return super(CountingDecorator, self).run(result)
3106
class ExcludeDecorator(TestDecorator):
3107
"""A decorator which excludes test matching an exclude pattern."""
3109
def __init__(self, suite, exclude_pattern):
3110
TestDecorator.__init__(self, suite)
3111
self.exclude_pattern = exclude_pattern
3112
self.excluded = False
3116
return iter(self._tests)
3117
self.excluded = True
3118
suite = exclude_tests_by_re(self, self.exclude_pattern)
3120
self.addTests(suite)
3121
return iter(self._tests)
3124
class FilterTestsDecorator(TestDecorator):
3125
"""A decorator which filters tests to those matching a pattern."""
3127
def __init__(self, suite, pattern):
3128
TestDecorator.__init__(self, suite)
3129
self.pattern = pattern
3130
self.filtered = False
3134
return iter(self._tests)
3135
self.filtered = True
3136
suite = filter_suite_by_re(self, self.pattern)
3138
self.addTests(suite)
3139
return iter(self._tests)
3142
class RandomDecorator(TestDecorator):
3143
"""A decorator which randomises the order of its tests."""
3145
def __init__(self, suite, random_seed, stream):
3146
TestDecorator.__init__(self, suite)
3147
self.random_seed = random_seed
3148
self.randomised = False
3149
self.stream = stream
3153
return iter(self._tests)
3154
self.randomised = True
3155
self.stream.write("Randomizing test order using seed %s\n\n" %
3156
(self.actual_seed()))
3157
# Initialise the random number generator.
3158
random.seed(self.actual_seed())
3159
suite = randomize_suite(self)
3161
self.addTests(suite)
3162
return iter(self._tests)
3164
def actual_seed(self):
3165
if self.random_seed == "now":
3166
# We convert the seed to a long to make it reuseable across
3167
# invocations (because the user can reenter it).
3168
self.random_seed = long(time.time())
3170
# Convert the seed to a long if we can
3172
self.random_seed = long(self.random_seed)
3175
return self.random_seed
3178
class TestFirstDecorator(TestDecorator):
3179
"""A decorator which moves named tests to the front."""
3181
def __init__(self, suite, pattern):
3182
TestDecorator.__init__(self, suite)
3183
self.pattern = pattern
3184
self.filtered = False
3188
return iter(self._tests)
3189
self.filtered = True
3190
suites = split_suite_by_re(self, self.pattern)
3192
self.addTests(suites)
3193
return iter(self._tests)
3196
def partition_tests(suite, count):
3197
"""Partition suite into count lists of tests."""
3199
tests = list(iter_suite_tests(suite))
3200
tests_per_process = int(math.ceil(float(len(tests)) / count))
3201
for block in range(count):
3202
low_test = block * tests_per_process
3203
high_test = low_test + tests_per_process
3204
process_tests = tests[low_test:high_test]
3205
result.append(process_tests)
3209
def workaround_zealous_crypto_random():
3210
"""Crypto.Random want to help us being secure, but we don't care here.
3212
This workaround some test failure related to the sftp server. Once paramiko
3213
stop using the controversial API in Crypto.Random, we may get rid of it.
3216
from Crypto.Random import atfork
3222
def fork_for_tests(suite):
3223
"""Take suite and start up one runner per CPU by forking()
3225
:return: An iterable of TestCase-like objects which can each have
3226
run(result) called on them to feed tests to result.
3228
concurrency = osutils.local_concurrency()
3230
from subunit import TestProtocolClient, ProtocolTestCase
3231
from subunit.test_results import AutoTimingTestResultDecorator
3232
class TestInOtherProcess(ProtocolTestCase):
3233
# Should be in subunit, I think. RBC.
3234
def __init__(self, stream, pid):
3235
ProtocolTestCase.__init__(self, stream)
3238
def run(self, result):
3240
ProtocolTestCase.run(self, result)
3242
os.waitpid(self.pid, 0)
3244
test_blocks = partition_tests(suite, concurrency)
3245
for process_tests in test_blocks:
3246
process_suite = TestSuite()
3247
process_suite.addTests(process_tests)
3248
c2pread, c2pwrite = os.pipe()
3251
workaround_zealous_crypto_random()
3254
# Leave stderr and stdout open so we can see test noise
3255
# Close stdin so that the child goes away if it decides to
3256
# read from stdin (otherwise its a roulette to see what
3257
# child actually gets keystrokes for pdb etc).
3260
stream = os.fdopen(c2pwrite, 'wb', 1)
3261
subunit_result = AutoTimingTestResultDecorator(
3262
TestProtocolClient(stream))
3263
process_suite.run(subunit_result)
3268
stream = os.fdopen(c2pread, 'rb', 1)
3269
test = TestInOtherProcess(stream, pid)
3274
def reinvoke_for_tests(suite):
3275
"""Take suite and start up one runner per CPU using subprocess().
3277
:return: An iterable of TestCase-like objects which can each have
3278
run(result) called on them to feed tests to result.
3280
concurrency = osutils.local_concurrency()
3282
from subunit import ProtocolTestCase
3283
class TestInSubprocess(ProtocolTestCase):
3284
def __init__(self, process, name):
3285
ProtocolTestCase.__init__(self, process.stdout)
3286
self.process = process
3287
self.process.stdin.close()
3290
def run(self, result):
3292
ProtocolTestCase.run(self, result)
3295
os.unlink(self.name)
3296
# print "pid %d finished" % finished_process
3297
test_blocks = partition_tests(suite, concurrency)
3298
for process_tests in test_blocks:
3299
# ugly; currently reimplement rather than reuses TestCase methods.
3300
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3301
if not os.path.isfile(bzr_path):
3302
# We are probably installed. Assume sys.argv is the right file
3303
bzr_path = sys.argv[0]
3304
bzr_path = [bzr_path]
3305
if sys.platform == "win32":
3306
# if we're on windows, we can't execute the bzr script directly
3307
bzr_path = [sys.executable] + bzr_path
3308
fd, test_list_file_name = tempfile.mkstemp()
3309
test_list_file = os.fdopen(fd, 'wb', 1)
3310
for test in process_tests:
3311
test_list_file.write(test.id() + '\n')
3312
test_list_file.close()
3314
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3316
if '--no-plugins' in sys.argv:
3317
argv.append('--no-plugins')
3318
# stderr=STDOUT would be ideal, but until we prevent noise on
3319
# stderr it can interrupt the subunit protocol.
3320
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3322
test = TestInSubprocess(process, test_list_file_name)
3325
os.unlink(test_list_file_name)
3330
class ForwardingResult(unittest.TestResult):
3332
def __init__(self, target):
3333
unittest.TestResult.__init__(self)
3334
self.result = target
3336
def startTest(self, test):
3337
self.result.startTest(test)
3339
def stopTest(self, test):
3340
self.result.stopTest(test)
3342
def startTestRun(self):
3343
self.result.startTestRun()
3345
def stopTestRun(self):
3346
self.result.stopTestRun()
3348
def addSkip(self, test, reason):
3349
self.result.addSkip(test, reason)
3351
def addSuccess(self, test):
3352
self.result.addSuccess(test)
3354
def addError(self, test, err):
3355
self.result.addError(test, err)
3357
def addFailure(self, test, err):
3358
self.result.addFailure(test, err)
3359
ForwardingResult = testtools.ExtendedToOriginalDecorator
3362
class ProfileResult(ForwardingResult):
3363
"""Generate profiling data for all activity between start and success.
3365
The profile data is appended to the test's _benchcalls attribute and can
3366
be accessed by the forwarded-to TestResult.
3368
While it might be cleaner do accumulate this in stopTest, addSuccess is
3369
where our existing output support for lsprof is, and this class aims to
3370
fit in with that: while it could be moved it's not necessary to accomplish
3371
test profiling, nor would it be dramatically cleaner.
3374
def startTest(self, test):
3375
self.profiler = bzrlib.lsprof.BzrProfiler()
3376
self.profiler.start()
3377
ForwardingResult.startTest(self, test)
3379
def addSuccess(self, test):
3380
stats = self.profiler.stop()
3382
calls = test._benchcalls
3383
except AttributeError:
3384
test._benchcalls = []
3385
calls = test._benchcalls
3386
calls.append(((test.id(), "", ""), stats))
3387
ForwardingResult.addSuccess(self, test)
3389
def stopTest(self, test):
3390
ForwardingResult.stopTest(self, test)
3391
self.profiler = None
3394
# Controlled by "bzr selftest -E=..." option
3395
# Currently supported:
3396
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3397
# preserves any flags supplied at the command line.
3398
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3399
# rather than failing tests. And no longer raise
3400
# LockContention when fctnl locks are not being used
3401
# with proper exclusion rules.
3402
selftest_debug_flags = set()
3405
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3407
test_suite_factory=None,
3410
matching_tests_first=None,
3413
exclude_pattern=None,
3419
suite_decorators=None,
3423
"""Run the whole test suite under the enhanced runner"""
3424
# XXX: Very ugly way to do this...
3425
# Disable warning about old formats because we don't want it to disturb
3426
# any blackbox tests.
3427
from bzrlib import repository
3428
repository._deprecation_warning_done = True
3430
global default_transport
3431
if transport is None:
3432
transport = default_transport
3433
old_transport = default_transport
3434
default_transport = transport
3435
global selftest_debug_flags
3436
old_debug_flags = selftest_debug_flags
3437
if debug_flags is not None:
3438
selftest_debug_flags = set(debug_flags)
3440
if load_list is None:
3443
keep_only = load_test_id_list(load_list)
3445
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3446
for start in starting_with]
3447
if test_suite_factory is None:
3448
# Reduce loading time by loading modules based on the starting_with
3450
suite = test_suite(keep_only, starting_with)
3452
suite = test_suite_factory()
3454
# But always filter as requested.
3455
suite = filter_suite_by_id_startswith(suite, starting_with)
3456
result_decorators = []
3458
result_decorators.append(ProfileResult)
3459
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3460
stop_on_failure=stop_on_failure,
3461
transport=transport,
3462
lsprof_timed=lsprof_timed,
3463
bench_history=bench_history,
3464
matching_tests_first=matching_tests_first,
3465
list_only=list_only,
3466
random_seed=random_seed,
3467
exclude_pattern=exclude_pattern,
3469
runner_class=runner_class,
3470
suite_decorators=suite_decorators,
3472
result_decorators=result_decorators,
3475
default_transport = old_transport
3476
selftest_debug_flags = old_debug_flags
3479
def load_test_id_list(file_name):
3480
"""Load a test id list from a text file.
3482
The format is one test id by line. No special care is taken to impose
3483
strict rules, these test ids are used to filter the test suite so a test id
3484
that do not match an existing test will do no harm. This allows user to add
3485
comments, leave blank lines, etc.
3489
ftest = open(file_name, 'rt')
3491
if e.errno != errno.ENOENT:
3494
raise errors.NoSuchFile(file_name)
3496
for test_name in ftest.readlines():
3497
test_list.append(test_name.strip())
3502
def suite_matches_id_list(test_suite, id_list):
3503
"""Warns about tests not appearing or appearing more than once.
3505
:param test_suite: A TestSuite object.
3506
:param test_id_list: The list of test ids that should be found in
3509
:return: (absents, duplicates) absents is a list containing the test found
3510
in id_list but not in test_suite, duplicates is a list containing the
3511
test found multiple times in test_suite.
3513
When using a prefined test id list, it may occurs that some tests do not
3514
exist anymore or that some tests use the same id. This function warns the
3515
tester about potential problems in his workflow (test lists are volatile)
3516
or in the test suite itself (using the same id for several tests does not
3517
help to localize defects).
3519
# Build a dict counting id occurrences
3521
for test in iter_suite_tests(test_suite):
3523
tests[id] = tests.get(id, 0) + 1
3528
occurs = tests.get(id, 0)
3530
not_found.append(id)
3532
duplicates.append(id)
3534
return not_found, duplicates
3537
class TestIdList(object):
3538
"""Test id list to filter a test suite.
3540
Relying on the assumption that test ids are built as:
3541
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3542
notation, this class offers methods to :
3543
- avoid building a test suite for modules not refered to in the test list,
3544
- keep only the tests listed from the module test suite.
3547
def __init__(self, test_id_list):
3548
# When a test suite needs to be filtered against us we compare test ids
3549
# for equality, so a simple dict offers a quick and simple solution.
3550
self.tests = dict().fromkeys(test_id_list, True)
3552
# While unittest.TestCase have ids like:
3553
# <module>.<class>.<method>[(<param+)],
3554
# doctest.DocTestCase can have ids like:
3557
# <module>.<function>
3558
# <module>.<class>.<method>
3560
# Since we can't predict a test class from its name only, we settle on
3561
# a simple constraint: a test id always begins with its module name.
3564
for test_id in test_id_list:
3565
parts = test_id.split('.')
3566
mod_name = parts.pop(0)
3567
modules[mod_name] = True
3569
mod_name += '.' + part
3570
modules[mod_name] = True
3571
self.modules = modules
3573
def refers_to(self, module_name):
3574
"""Is there tests for the module or one of its sub modules."""
3575
return self.modules.has_key(module_name)
3577
def includes(self, test_id):
3578
return self.tests.has_key(test_id)
3581
class TestPrefixAliasRegistry(registry.Registry):
3582
"""A registry for test prefix aliases.
3584
This helps implement shorcuts for the --starting-with selftest
3585
option. Overriding existing prefixes is not allowed but not fatal (a
3586
warning will be emitted).
3589
def register(self, key, obj, help=None, info=None,
3590
override_existing=False):
3591
"""See Registry.register.
3593
Trying to override an existing alias causes a warning to be emitted,
3594
not a fatal execption.
3597
super(TestPrefixAliasRegistry, self).register(
3598
key, obj, help=help, info=info, override_existing=False)
3600
actual = self.get(key)
3601
note('Test prefix alias %s is already used for %s, ignoring %s'
3602
% (key, actual, obj))
3604
def resolve_alias(self, id_start):
3605
"""Replace the alias by the prefix in the given string.
3607
Using an unknown prefix is an error to help catching typos.
3609
parts = id_start.split('.')
3611
parts[0] = self.get(parts[0])
3613
raise errors.BzrCommandError(
3614
'%s is not a known test prefix alias' % parts[0])
3615
return '.'.join(parts)
3618
test_prefix_alias_registry = TestPrefixAliasRegistry()
3619
"""Registry of test prefix aliases."""
3622
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3623
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3624
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3626
# Obvious highest levels prefixes, feel free to add your own via a plugin
3627
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3628
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3629
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3630
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3631
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3634
def _test_suite_testmod_names():
3635
"""Return the standard list of test module names to test."""
3638
'bzrlib.tests.blackbox',
3639
'bzrlib.tests.commands',
3640
'bzrlib.tests.per_branch',
3641
'bzrlib.tests.per_bzrdir',
3642
'bzrlib.tests.per_bzrdir_colo',
3643
'bzrlib.tests.per_foreign_vcs',
3644
'bzrlib.tests.per_interrepository',
3645
'bzrlib.tests.per_intertree',
3646
'bzrlib.tests.per_inventory',
3647
'bzrlib.tests.per_interbranch',
3648
'bzrlib.tests.per_lock',
3649
'bzrlib.tests.per_merger',
3650
'bzrlib.tests.per_transport',
3651
'bzrlib.tests.per_tree',
3652
'bzrlib.tests.per_pack_repository',
3653
'bzrlib.tests.per_repository',
3654
'bzrlib.tests.per_repository_chk',
3655
'bzrlib.tests.per_repository_reference',
3656
'bzrlib.tests.per_uifactory',
3657
'bzrlib.tests.per_versionedfile',
3658
'bzrlib.tests.per_workingtree',
3659
'bzrlib.tests.test__annotator',
3660
'bzrlib.tests.test__bencode',
3661
'bzrlib.tests.test__chk_map',
3662
'bzrlib.tests.test__dirstate_helpers',
3663
'bzrlib.tests.test__groupcompress',
3664
'bzrlib.tests.test__known_graph',
3665
'bzrlib.tests.test__rio',
3666
'bzrlib.tests.test__simple_set',
3667
'bzrlib.tests.test__static_tuple',
3668
'bzrlib.tests.test__walkdirs_win32',
3669
'bzrlib.tests.test_ancestry',
3670
'bzrlib.tests.test_annotate',
3671
'bzrlib.tests.test_api',
3672
'bzrlib.tests.test_atomicfile',
3673
'bzrlib.tests.test_bad_files',
3674
'bzrlib.tests.test_bisect_multi',
3675
'bzrlib.tests.test_branch',
3676
'bzrlib.tests.test_branchbuilder',
3677
'bzrlib.tests.test_btree_index',
3678
'bzrlib.tests.test_bugtracker',
3679
'bzrlib.tests.test_bundle',
3680
'bzrlib.tests.test_bzrdir',
3681
'bzrlib.tests.test__chunks_to_lines',
3682
'bzrlib.tests.test_cache_utf8',
3683
'bzrlib.tests.test_chk_map',
3684
'bzrlib.tests.test_chk_serializer',
3685
'bzrlib.tests.test_chunk_writer',
3686
'bzrlib.tests.test_clean_tree',
3687
'bzrlib.tests.test_cleanup',
3688
'bzrlib.tests.test_cmdline',
3689
'bzrlib.tests.test_commands',
3690
'bzrlib.tests.test_commit',
3691
'bzrlib.tests.test_commit_merge',
3692
'bzrlib.tests.test_config',
3693
'bzrlib.tests.test_conflicts',
3694
'bzrlib.tests.test_counted_lock',
3695
'bzrlib.tests.test_crash',
3696
'bzrlib.tests.test_decorators',
3697
'bzrlib.tests.test_delta',
3698
'bzrlib.tests.test_debug',
3699
'bzrlib.tests.test_deprecated_graph',
3700
'bzrlib.tests.test_diff',
3701
'bzrlib.tests.test_directory_service',
3702
'bzrlib.tests.test_dirstate',
3703
'bzrlib.tests.test_email_message',
3704
'bzrlib.tests.test_eol_filters',
3705
'bzrlib.tests.test_errors',
3706
'bzrlib.tests.test_export',
3707
'bzrlib.tests.test_extract',
3708
'bzrlib.tests.test_fetch',
3709
'bzrlib.tests.test_fixtures',
3710
'bzrlib.tests.test_fifo_cache',
3711
'bzrlib.tests.test_filters',
3712
'bzrlib.tests.test_ftp_transport',
3713
'bzrlib.tests.test_foreign',
3714
'bzrlib.tests.test_generate_docs',
3715
'bzrlib.tests.test_generate_ids',
3716
'bzrlib.tests.test_globbing',
3717
'bzrlib.tests.test_gpg',
3718
'bzrlib.tests.test_graph',
3719
'bzrlib.tests.test_groupcompress',
3720
'bzrlib.tests.test_hashcache',
3721
'bzrlib.tests.test_help',
3722
'bzrlib.tests.test_hooks',
3723
'bzrlib.tests.test_http',
3724
'bzrlib.tests.test_http_response',
3725
'bzrlib.tests.test_https_ca_bundle',
3726
'bzrlib.tests.test_identitymap',
3727
'bzrlib.tests.test_ignores',
3728
'bzrlib.tests.test_index',
3729
'bzrlib.tests.test_import_tariff',
3730
'bzrlib.tests.test_info',
3731
'bzrlib.tests.test_inv',
3732
'bzrlib.tests.test_inventory_delta',
3733
'bzrlib.tests.test_knit',
3734
'bzrlib.tests.test_lazy_import',
3735
'bzrlib.tests.test_lazy_regex',
3736
'bzrlib.tests.test_library_state',
3737
'bzrlib.tests.test_lock',
3738
'bzrlib.tests.test_lockable_files',
3739
'bzrlib.tests.test_lockdir',
3740
'bzrlib.tests.test_log',
3741
'bzrlib.tests.test_lru_cache',
3742
'bzrlib.tests.test_lsprof',
3743
'bzrlib.tests.test_mail_client',
3744
'bzrlib.tests.test_matchers',
3745
'bzrlib.tests.test_memorytree',
3746
'bzrlib.tests.test_merge',
3747
'bzrlib.tests.test_merge3',
3748
'bzrlib.tests.test_merge_core',
3749
'bzrlib.tests.test_merge_directive',
3750
'bzrlib.tests.test_missing',
3751
'bzrlib.tests.test_msgeditor',
3752
'bzrlib.tests.test_multiparent',
3753
'bzrlib.tests.test_mutabletree',
3754
'bzrlib.tests.test_nonascii',
3755
'bzrlib.tests.test_options',
3756
'bzrlib.tests.test_osutils',
3757
'bzrlib.tests.test_osutils_encodings',
3758
'bzrlib.tests.test_pack',
3759
'bzrlib.tests.test_patch',
3760
'bzrlib.tests.test_patches',
3761
'bzrlib.tests.test_permissions',
3762
'bzrlib.tests.test_plugins',
3763
'bzrlib.tests.test_progress',
3764
'bzrlib.tests.test_read_bundle',
3765
'bzrlib.tests.test_reconcile',
3766
'bzrlib.tests.test_reconfigure',
3767
'bzrlib.tests.test_registry',
3768
'bzrlib.tests.test_remote',
3769
'bzrlib.tests.test_rename_map',
3770
'bzrlib.tests.test_repository',
3771
'bzrlib.tests.test_revert',
3772
'bzrlib.tests.test_revision',
3773
'bzrlib.tests.test_revisionspec',
3774
'bzrlib.tests.test_revisiontree',
3775
'bzrlib.tests.test_rio',
3776
'bzrlib.tests.test_rules',
3777
'bzrlib.tests.test_sampler',
3778
'bzrlib.tests.test_script',
3779
'bzrlib.tests.test_selftest',
3780
'bzrlib.tests.test_serializer',
3781
'bzrlib.tests.test_setup',
3782
'bzrlib.tests.test_sftp_transport',
3783
'bzrlib.tests.test_shelf',
3784
'bzrlib.tests.test_shelf_ui',
3785
'bzrlib.tests.test_smart',
3786
'bzrlib.tests.test_smart_add',
3787
'bzrlib.tests.test_smart_request',
3788
'bzrlib.tests.test_smart_transport',
3789
'bzrlib.tests.test_smtp_connection',
3790
'bzrlib.tests.test_source',
3791
'bzrlib.tests.test_ssh_transport',
3792
'bzrlib.tests.test_status',
3793
'bzrlib.tests.test_store',
3794
'bzrlib.tests.test_strace',
3795
'bzrlib.tests.test_subsume',
3796
'bzrlib.tests.test_switch',
3797
'bzrlib.tests.test_symbol_versioning',
3798
'bzrlib.tests.test_tag',
3799
'bzrlib.tests.test_testament',
3800
'bzrlib.tests.test_textfile',
3801
'bzrlib.tests.test_textmerge',
3802
'bzrlib.tests.test_timestamp',
3803
'bzrlib.tests.test_trace',
3804
'bzrlib.tests.test_transactions',
3805
'bzrlib.tests.test_transform',
3806
'bzrlib.tests.test_transport',
3807
'bzrlib.tests.test_transport_log',
3808
'bzrlib.tests.test_tree',
3809
'bzrlib.tests.test_treebuilder',
3810
'bzrlib.tests.test_tsort',
3811
'bzrlib.tests.test_tuned_gzip',
3812
'bzrlib.tests.test_ui',
3813
'bzrlib.tests.test_uncommit',
3814
'bzrlib.tests.test_upgrade',
3815
'bzrlib.tests.test_upgrade_stacked',
3816
'bzrlib.tests.test_urlutils',
3817
'bzrlib.tests.test_version',
3818
'bzrlib.tests.test_version_info',
3819
'bzrlib.tests.test_weave',
3820
'bzrlib.tests.test_whitebox',
3821
'bzrlib.tests.test_win32utils',
3822
'bzrlib.tests.test_workingtree',
3823
'bzrlib.tests.test_workingtree_4',
3824
'bzrlib.tests.test_wsgi',
3825
'bzrlib.tests.test_xml',
3829
def _test_suite_modules_to_doctest():
3830
"""Return the list of modules to doctest."""
3832
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3836
'bzrlib.branchbuilder',
3837
'bzrlib.decorators',
3840
'bzrlib.iterablefile',
3844
'bzrlib.symbol_versioning',
3846
'bzrlib.tests.fixtures',
3848
'bzrlib.version_info_formats.format_custom',
3852
def test_suite(keep_only=None, starting_with=None):
3853
"""Build and return TestSuite for the whole of bzrlib.
3855
:param keep_only: A list of test ids limiting the suite returned.
3857
:param starting_with: An id limiting the suite returned to the tests
3860
This function can be replaced if you need to change the default test
3861
suite on a global basis, but it is not encouraged.
3864
loader = TestUtil.TestLoader()
3866
if keep_only is not None:
3867
id_filter = TestIdList(keep_only)
3869
# We take precedence over keep_only because *at loading time* using
3870
# both options means we will load less tests for the same final result.
3871
def interesting_module(name):
3872
for start in starting_with:
3874
# Either the module name starts with the specified string
3875
name.startswith(start)
3876
# or it may contain tests starting with the specified string
3877
or start.startswith(name)
3881
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3883
elif keep_only is not None:
3884
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3885
def interesting_module(name):
3886
return id_filter.refers_to(name)
3889
loader = TestUtil.TestLoader()
3890
def interesting_module(name):
3891
# No filtering, all modules are interesting
3894
suite = loader.suiteClass()
3896
# modules building their suite with loadTestsFromModuleNames
3897
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3899
for mod in _test_suite_modules_to_doctest():
3900
if not interesting_module(mod):
3901
# No tests to keep here, move along
3904
# note that this really does mean "report only" -- doctest
3905
# still runs the rest of the examples
3906
doc_suite = doctest.DocTestSuite(mod,
3907
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3908
except ValueError, e:
3909
print '**failed to get doctest for: %s\n%s' % (mod, e)
3911
if len(doc_suite._tests) == 0:
3912
raise errors.BzrError("no doctests found in %s" % (mod,))
3913
suite.addTest(doc_suite)
3915
default_encoding = sys.getdefaultencoding()
3916
for name, plugin in bzrlib.plugin.plugins().items():
3917
if not interesting_module(plugin.module.__name__):
3919
plugin_suite = plugin.test_suite()
3920
# We used to catch ImportError here and turn it into just a warning,
3921
# but really if you don't have --no-plugins this should be a failure.
3922
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3923
if plugin_suite is None:
3924
plugin_suite = plugin.load_plugin_tests(loader)
3925
if plugin_suite is not None:
3926
suite.addTest(plugin_suite)
3927
if default_encoding != sys.getdefaultencoding():
3928
bzrlib.trace.warning(
3929
'Plugin "%s" tried to reset default encoding to: %s', name,
3930
sys.getdefaultencoding())
3932
sys.setdefaultencoding(default_encoding)
3934
if keep_only is not None:
3935
# Now that the referred modules have loaded their tests, keep only the
3937
suite = filter_suite_by_id_list(suite, id_filter)
3938
# Do some sanity checks on the id_list filtering
3939
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3941
# The tester has used both keep_only and starting_with, so he is
3942
# already aware that some tests are excluded from the list, there
3943
# is no need to tell him which.
3946
# Some tests mentioned in the list are not in the test suite. The
3947
# list may be out of date, report to the tester.
3948
for id in not_found:
3949
bzrlib.trace.warning('"%s" not found in the test suite', id)
3950
for id in duplicates:
3951
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3956
def multiply_scenarios(scenarios_left, scenarios_right):
3957
"""Multiply two sets of scenarios.
3959
:returns: the cartesian product of the two sets of scenarios, that is
3960
a scenario for every possible combination of a left scenario and a
3964
('%s,%s' % (left_name, right_name),
3965
dict(left_dict.items() + right_dict.items()))
3966
for left_name, left_dict in scenarios_left
3967
for right_name, right_dict in scenarios_right]
3970
def multiply_tests(tests, scenarios, result):
3971
"""Multiply tests_list by scenarios into result.
3973
This is the core workhorse for test parameterisation.
3975
Typically the load_tests() method for a per-implementation test suite will
3976
call multiply_tests and return the result.
3978
:param tests: The tests to parameterise.
3979
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3980
scenario_param_dict).
3981
:param result: A TestSuite to add created tests to.
3983
This returns the passed in result TestSuite with the cross product of all
3984
the tests repeated once for each scenario. Each test is adapted by adding
3985
the scenario name at the end of its id(), and updating the test object's
3986
__dict__ with the scenario_param_dict.
3988
>>> import bzrlib.tests.test_sampler
3989
>>> r = multiply_tests(
3990
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3991
... [('one', dict(param=1)),
3992
... ('two', dict(param=2))],
3994
>>> tests = list(iter_suite_tests(r))
3998
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4004
for test in iter_suite_tests(tests):
4005
apply_scenarios(test, scenarios, result)
4009
def apply_scenarios(test, scenarios, result):
4010
"""Apply the scenarios in scenarios to test and add to result.
4012
:param test: The test to apply scenarios to.
4013
:param scenarios: An iterable of scenarios to apply to test.
4015
:seealso: apply_scenario
4017
for scenario in scenarios:
4018
result.addTest(apply_scenario(test, scenario))
4022
def apply_scenario(test, scenario):
4023
"""Copy test and apply scenario to it.
4025
:param test: A test to adapt.
4026
:param scenario: A tuple describing the scenarion.
4027
The first element of the tuple is the new test id.
4028
The second element is a dict containing attributes to set on the
4030
:return: The adapted test.
4032
new_id = "%s(%s)" % (test.id(), scenario[0])
4033
new_test = clone_test(test, new_id)
4034
for name, value in scenario[1].items():
4035
setattr(new_test, name, value)
4039
def clone_test(test, new_id):
4040
"""Clone a test giving it a new id.
4042
:param test: The test to clone.
4043
:param new_id: The id to assign to it.
4044
:return: The new test.
4046
new_test = copy(test)
4047
new_test.id = lambda: new_id
4051
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4053
"""Helper for permutating tests against an extension module.
4055
This is meant to be used inside a modules 'load_tests()' function. It will
4056
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4057
against both implementations. Setting 'test.module' to the appropriate
4058
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4060
:param standard_tests: A test suite to permute
4061
:param loader: A TestLoader
4062
:param py_module_name: The python path to a python module that can always
4063
be loaded, and will be considered the 'python' implementation. (eg
4064
'bzrlib._chk_map_py')
4065
:param ext_module_name: The python path to an extension module. If the
4066
module cannot be loaded, a single test will be added, which notes that
4067
the module is not available. If it can be loaded, all standard_tests
4068
will be run against that module.
4069
:return: (suite, feature) suite is a test-suite that has all the permuted
4070
tests. feature is the Feature object that can be used to determine if
4071
the module is available.
4074
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4076
('python', {'module': py_module}),
4078
suite = loader.suiteClass()
4079
feature = ModuleAvailableFeature(ext_module_name)
4080
if feature.available():
4081
scenarios.append(('C', {'module': feature.module}))
4083
# the compiled module isn't available, so we add a failing test
4084
class FailWithoutFeature(TestCase):
4085
def test_fail(self):
4086
self.requireFeature(feature)
4087
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4088
result = multiply_tests(standard_tests, scenarios, suite)
4089
return result, feature
4092
def _rmtree_temp_dir(dirname, test_id=None):
4093
# If LANG=C we probably have created some bogus paths
4094
# which rmtree(unicode) will fail to delete
4095
# so make sure we are using rmtree(str) to delete everything
4096
# except on win32, where rmtree(str) will fail
4097
# since it doesn't have the property of byte-stream paths
4098
# (they are either ascii or mbcs)
4099
if sys.platform == 'win32':
4100
# make sure we are using the unicode win32 api
4101
dirname = unicode(dirname)
4103
dirname = dirname.encode(sys.getfilesystemencoding())
4105
osutils.rmtree(dirname)
4107
# We don't want to fail here because some useful display will be lost
4108
# otherwise. Polluting the tmp dir is bad, but not giving all the
4109
# possible info to the test runner is even worse.
4111
ui.ui_factory.clear_term()
4112
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4113
# Ugly, but the last thing we want here is fail, so bear with it.
4114
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4115
).encode('ascii', 'replace')
4116
sys.stderr.write('Unable to remove testing dir %s\n%s'
4117
% (os.path.basename(dirname), printable_e))
4120
class Feature(object):
4121
"""An operating system Feature."""
4124
self._available = None
4126
def available(self):
4127
"""Is the feature available?
4129
:return: True if the feature is available.
4131
if self._available is None:
4132
self._available = self._probe()
4133
return self._available
4136
"""Implement this method in concrete features.
4138
:return: True if the feature is available.
4140
raise NotImplementedError
4143
if getattr(self, 'feature_name', None):
4144
return self.feature_name()
4145
return self.__class__.__name__
4148
class _SymlinkFeature(Feature):
4151
return osutils.has_symlinks()
4153
def feature_name(self):
4156
SymlinkFeature = _SymlinkFeature()
4159
class _HardlinkFeature(Feature):
4162
return osutils.has_hardlinks()
4164
def feature_name(self):
4167
HardlinkFeature = _HardlinkFeature()
4170
class _OsFifoFeature(Feature):
4173
return getattr(os, 'mkfifo', None)
4175
def feature_name(self):
4176
return 'filesystem fifos'
4178
OsFifoFeature = _OsFifoFeature()
4181
class _UnicodeFilenameFeature(Feature):
4182
"""Does the filesystem support Unicode filenames?"""
4186
# Check for character combinations unlikely to be covered by any
4187
# single non-unicode encoding. We use the characters
4188
# - greek small letter alpha (U+03B1) and
4189
# - braille pattern dots-123456 (U+283F).
4190
os.stat(u'\u03b1\u283f')
4191
except UnicodeEncodeError:
4193
except (IOError, OSError):
4194
# The filesystem allows the Unicode filename but the file doesn't
4198
# The filesystem allows the Unicode filename and the file exists,
4202
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4205
class _CompatabilityThunkFeature(Feature):
4206
"""This feature is just a thunk to another feature.
4208
It issues a deprecation warning if it is accessed, to let you know that you
4209
should really use a different feature.
4212
def __init__(self, dep_version, module, name,
4213
replacement_name, replacement_module=None):
4214
super(_CompatabilityThunkFeature, self).__init__()
4215
self._module = module
4216
if replacement_module is None:
4217
replacement_module = module
4218
self._replacement_module = replacement_module
4220
self._replacement_name = replacement_name
4221
self._dep_version = dep_version
4222
self._feature = None
4225
if self._feature is None:
4226
depr_msg = self._dep_version % ('%s.%s'
4227
% (self._module, self._name))
4228
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4229
self._replacement_name)
4230
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4231
# Import the new feature and use it as a replacement for the
4233
mod = __import__(self._replacement_module, {}, {},
4234
[self._replacement_name])
4235
self._feature = getattr(mod, self._replacement_name)
4239
return self._feature._probe()
4242
class ModuleAvailableFeature(Feature):
4243
"""This is a feature than describes a module we want to be available.
4245
Declare the name of the module in __init__(), and then after probing, the
4246
module will be available as 'self.module'.
4248
:ivar module: The module if it is available, else None.
4251
def __init__(self, module_name):
4252
super(ModuleAvailableFeature, self).__init__()
4253
self.module_name = module_name
4257
self._module = __import__(self.module_name, {}, {}, [''])
4264
if self.available(): # Make sure the probe has been done
4268
def feature_name(self):
4269
return self.module_name
4272
# This is kept here for compatibility, it is recommended to use
4273
# 'bzrlib.tests.feature.paramiko' instead
4274
ParamikoFeature = _CompatabilityThunkFeature(
4275
deprecated_in((2,1,0)),
4276
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4279
def probe_unicode_in_user_encoding():
4280
"""Try to encode several unicode strings to use in unicode-aware tests.
4281
Return first successfull match.
4283
:return: (unicode value, encoded plain string value) or (None, None)
4285
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4286
for uni_val in possible_vals:
4288
str_val = uni_val.encode(osutils.get_user_encoding())
4289
except UnicodeEncodeError:
4290
# Try a different character
4293
return uni_val, str_val
4297
def probe_bad_non_ascii(encoding):
4298
"""Try to find [bad] character with code [128..255]
4299
that cannot be decoded to unicode in some encoding.
4300
Return None if all non-ascii characters is valid
4303
for i in xrange(128, 256):
4306
char.decode(encoding)
4307
except UnicodeDecodeError:
4312
class _HTTPSServerFeature(Feature):
4313
"""Some tests want an https Server, check if one is available.
4315
Right now, the only way this is available is under python2.6 which provides
4326
def feature_name(self):
4327
return 'HTTPSServer'
4330
HTTPSServerFeature = _HTTPSServerFeature()
4333
class _UnicodeFilename(Feature):
4334
"""Does the filesystem support Unicode filenames?"""
4339
except UnicodeEncodeError:
4341
except (IOError, OSError):
4342
# The filesystem allows the Unicode filename but the file doesn't
4346
# The filesystem allows the Unicode filename and the file exists,
4350
UnicodeFilename = _UnicodeFilename()
4353
class _ByteStringNamedFilesystem(Feature):
4354
"""Is the filesystem based on bytes?"""
4357
if os.name == "posix":
4361
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
4364
class _UTF8Filesystem(Feature):
4365
"""Is the filesystem UTF-8?"""
4368
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4372
UTF8Filesystem = _UTF8Filesystem()
4375
class _BreakinFeature(Feature):
4376
"""Does this platform support the breakin feature?"""
4379
from bzrlib import breakin
4380
if breakin.determine_signal() is None:
4382
if sys.platform == 'win32':
4383
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4384
# We trigger SIGBREAK via a Console api so we need ctypes to
4385
# access the function
4392
def feature_name(self):
4393
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4396
BreakinFeature = _BreakinFeature()
4399
class _CaseInsCasePresFilenameFeature(Feature):
4400
"""Is the file-system case insensitive, but case-preserving?"""
4403
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4405
# first check truly case-preserving for created files, then check
4406
# case insensitive when opening existing files.
4407
name = osutils.normpath(name)
4408
base, rel = osutils.split(name)
4409
found_rel = osutils.canonical_relpath(base, name)
4410
return (found_rel == rel
4411
and os.path.isfile(name.upper())
4412
and os.path.isfile(name.lower()))
4417
def feature_name(self):
4418
return "case-insensitive case-preserving filesystem"
4420
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4423
class _CaseInsensitiveFilesystemFeature(Feature):
4424
"""Check if underlying filesystem is case-insensitive but *not* case
4427
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4428
# more likely to be case preserving, so this case is rare.
4431
if CaseInsCasePresFilenameFeature.available():
4434
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4435
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4436
TestCaseWithMemoryTransport.TEST_ROOT = root
4438
root = TestCaseWithMemoryTransport.TEST_ROOT
4439
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4441
name_a = osutils.pathjoin(tdir, 'a')
4442
name_A = osutils.pathjoin(tdir, 'A')
4444
result = osutils.isdir(name_A)
4445
_rmtree_temp_dir(tdir)
4448
def feature_name(self):
4449
return 'case-insensitive filesystem'
4451
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4454
class _CaseSensitiveFilesystemFeature(Feature):
4457
if CaseInsCasePresFilenameFeature.available():
4459
elif CaseInsensitiveFilesystemFeature.available():
4464
def feature_name(self):
4465
return 'case-sensitive filesystem'
4467
# new coding style is for feature instances to be lowercase
4468
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4471
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4472
SubUnitFeature = _CompatabilityThunkFeature(
4473
deprecated_in((2,1,0)),
4474
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4475
# Only define SubUnitBzrRunner if subunit is available.
4477
from subunit import TestProtocolClient
4478
from subunit.test_results import AutoTimingTestResultDecorator
4479
class SubUnitBzrRunner(TextTestRunner):
4480
def run(self, test):
4481
result = AutoTimingTestResultDecorator(
4482
TestProtocolClient(self.stream))
4488
class _PosixPermissionsFeature(Feature):
4492
# create temporary file and check if specified perms are maintained.
4495
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4496
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4499
os.chmod(name, write_perms)
4501
read_perms = os.stat(name).st_mode & 0777
4503
return (write_perms == read_perms)
4505
return (os.name == 'posix') and has_perms()
4507
def feature_name(self):
4508
return 'POSIX permissions support'
4510
posix_permissions_feature = _PosixPermissionsFeature()
added
removed
bzrlib/tests/__init__.py
