1
# Copyright (C) 2005-2010 Canonical Ltd
1
# Copyright (C) 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
56
# nb: check this before importing anything else from within it
57
_testtools_version = getattr(testtools, '__version__', ())
58
if _testtools_version < (0, 9, 2):
59
raise ImportError("need at least testtools 0.9.2: %s is %r"
60
% (testtools.__file__, _testtools_version))
61
from testtools import content
78
transport as _mod_transport,
82
import bzrlib.commands
83
import bzrlib.timestamp
85
import bzrlib.inventory
86
import bzrlib.iterablefile
91
# lsprof not available
93
from bzrlib.merge import merge_inner
96
from bzrlib.smart import client, request, server
98
from bzrlib import symbol_versioning
99
from bzrlib.symbol_versioning import (
100
DEPRECATED_PARAMETER,
107
from bzrlib.transport import (
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\.', '', 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 = _mod_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 = _mod_transport.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
pprint.pformat(a), pprint.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=subprocess.PIPE,
1990
stdout=subprocess.PIPE,
1991
stderr=subprocess.PIPE)
1993
restore_environment()
1999
def _popen(self, *args, **kwargs):
2000
"""Place a call to Popen.
2002
Allows tests to override this method to intercept the calls made to
2003
Popen for introspection.
2005
return subprocess.Popen(*args, **kwargs)
2007
def get_source_path(self):
2008
"""Return the path of the directory containing bzrlib."""
2009
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2011
def get_bzr_path(self):
2012
"""Return the path of the 'bzr' executable for this test suite."""
2013
bzr_path = os.path.join(self.get_source_path(), "bzr")
2014
if not os.path.isfile(bzr_path):
2015
# We are probably installed. Assume sys.argv is the right file
2016
bzr_path = sys.argv[0]
2019
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2020
universal_newlines=False, process_args=None):
2021
"""Finish the execution of process.
2023
:param process: the Popen object returned from start_bzr_subprocess.
2024
:param retcode: The status code that is expected. Defaults to 0. If
2025
None is supplied, the status code is not checked.
2026
:param send_signal: an optional signal to send to the process.
2027
:param universal_newlines: Convert CRLF => LF
2028
:returns: (stdout, stderr)
2030
if send_signal is not None:
2031
os.kill(process.pid, send_signal)
2032
out, err = process.communicate()
2034
if universal_newlines:
2035
out = out.replace('\r\n', '\n')
2036
err = err.replace('\r\n', '\n')
2038
if retcode is not None and retcode != process.returncode:
2039
if process_args is None:
2040
process_args = "(unknown args)"
2041
mutter('Output of bzr %s:\n%s', process_args, out)
2042
mutter('Error for bzr %s:\n%s', process_args, err)
2043
self.fail('Command bzr %s failed with retcode %s != %s'
2044
% (process_args, retcode, process.returncode))
2047
def check_inventory_shape(self, inv, shape):
2048
"""Compare an inventory to a list of expected names.
2050
Fail if they are not precisely equal.
2053
shape = list(shape) # copy
2054
for path, ie in inv.entries():
2055
name = path.replace('\\', '/')
2056
if ie.kind == 'directory':
2063
self.fail("expected paths not found in inventory: %r" % shape)
2065
self.fail("unexpected paths found in inventory: %r" % extras)
2067
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2068
a_callable=None, *args, **kwargs):
2069
"""Call callable with redirected std io pipes.
2071
Returns the return code."""
2072
if not callable(a_callable):
2073
raise ValueError("a_callable must be callable.")
2075
stdin = StringIO("")
2077
if getattr(self, "_log_file", None) is not None:
2078
stdout = self._log_file
2082
if getattr(self, "_log_file", None is not None):
2083
stderr = self._log_file
2086
real_stdin = sys.stdin
2087
real_stdout = sys.stdout
2088
real_stderr = sys.stderr
2093
return a_callable(*args, **kwargs)
2095
sys.stdout = real_stdout
2096
sys.stderr = real_stderr
2097
sys.stdin = real_stdin
2099
def reduceLockdirTimeout(self):
2100
"""Reduce the default lock timeout for the duration of the test, so that
2101
if LockContention occurs during a test, it does so quickly.
2103
Tests that expect to provoke LockContention errors should call this.
2105
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2107
def make_utf8_encoded_stringio(self, encoding_type=None):
2108
"""Return a StringIOWrapper instance, that will encode Unicode
2111
if encoding_type is None:
2112
encoding_type = 'strict'
2114
output_encoding = 'utf-8'
2115
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2116
sio.encoding = output_encoding
2119
def disable_verb(self, verb):
2120
"""Disable a smart server verb for one test."""
2121
from bzrlib.smart import request
2122
request_handlers = request.request_handlers
2123
orig_method = request_handlers.get(verb)
2124
request_handlers.remove(verb)
2125
self.addCleanup(request_handlers.register, verb, orig_method)
2128
class CapturedCall(object):
2129
"""A helper for capturing smart server calls for easy debug analysis."""
2131
def __init__(self, params, prefix_length):
2132
"""Capture the call with params and skip prefix_length stack frames."""
2135
# The last 5 frames are the __init__, the hook frame, and 3 smart
2136
# client frames. Beyond this we could get more clever, but this is good
2138
stack = traceback.extract_stack()[prefix_length:-5]
2139
self.stack = ''.join(traceback.format_list(stack))
2142
return self.call.method
2145
return self.call.method
2151
class TestCaseWithMemoryTransport(TestCase):
2152
"""Common test class for tests that do not need disk resources.
2154
Tests that need disk resources should derive from TestCaseWithTransport.
2156
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2158
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2159
a directory which does not exist. This serves to help ensure test isolation
2160
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2161
must exist. However, TestCaseWithMemoryTransport does not offer local
2162
file defaults for the transport in tests, nor does it obey the command line
2163
override, so tests that accidentally write to the common directory should
2166
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2167
a .bzr directory that stops us ascending higher into the filesystem.
2173
def __init__(self, methodName='runTest'):
2174
# allow test parameterization after test construction and before test
2175
# execution. Variables that the parameterizer sets need to be
2176
# ones that are not set by setUp, or setUp will trash them.
2177
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2178
self.vfs_transport_factory = default_transport
2179
self.transport_server = None
2180
self.transport_readonly_server = None
2181
self.__vfs_server = None
2183
def get_transport(self, relpath=None):
2184
"""Return a writeable transport.
2186
This transport is for the test scratch space relative to
2189
:param relpath: a path relative to the base url.
2191
t = _mod_transport.get_transport(self.get_url(relpath))
2192
self.assertFalse(t.is_readonly())
2195
def get_readonly_transport(self, relpath=None):
2196
"""Return a readonly transport for the test scratch space
2198
This can be used to test that operations which should only need
2199
readonly access in fact do not try to write.
2201
:param relpath: a path relative to the base url.
2203
t = _mod_transport.get_transport(self.get_readonly_url(relpath))
2204
self.assertTrue(t.is_readonly())
2207
def create_transport_readonly_server(self):
2208
"""Create a transport server from class defined at init.
2210
This is mostly a hook for daughter classes.
2212
return self.transport_readonly_server()
2214
def get_readonly_server(self):
2215
"""Get the server instance for the readonly transport
2217
This is useful for some tests with specific servers to do diagnostics.
2219
if self.__readonly_server is None:
2220
if self.transport_readonly_server is None:
2221
# readonly decorator requested
2222
self.__readonly_server = test_server.ReadonlyServer()
2224
# explicit readonly transport.
2225
self.__readonly_server = self.create_transport_readonly_server()
2226
self.start_server(self.__readonly_server,
2227
self.get_vfs_only_server())
2228
return self.__readonly_server
2230
def get_readonly_url(self, relpath=None):
2231
"""Get a URL for the readonly transport.
2233
This will either be backed by '.' or a decorator to the transport
2234
used by self.get_url()
2235
relpath provides for clients to get a path relative to the base url.
2236
These should only be downwards relative, not upwards.
2238
base = self.get_readonly_server().get_url()
2239
return self._adjust_url(base, relpath)
2241
def get_vfs_only_server(self):
2242
"""Get the vfs only read/write server instance.
2244
This is useful for some tests with specific servers that need
2247
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2248
is no means to override it.
2250
if self.__vfs_server is None:
2251
self.__vfs_server = memory.MemoryServer()
2252
self.start_server(self.__vfs_server)
2253
return self.__vfs_server
2255
def get_server(self):
2256
"""Get the read/write server instance.
2258
This is useful for some tests with specific servers that need
2261
This is built from the self.transport_server factory. If that is None,
2262
then the self.get_vfs_server is returned.
2264
if self.__server is None:
2265
if (self.transport_server is None or self.transport_server is
2266
self.vfs_transport_factory):
2267
self.__server = self.get_vfs_only_server()
2269
# bring up a decorated means of access to the vfs only server.
2270
self.__server = self.transport_server()
2271
self.start_server(self.__server, self.get_vfs_only_server())
2272
return self.__server
2274
def _adjust_url(self, base, relpath):
2275
"""Get a URL (or maybe a path) for the readwrite transport.
2277
This will either be backed by '.' or to an equivalent non-file based
2279
relpath provides for clients to get a path relative to the base url.
2280
These should only be downwards relative, not upwards.
2282
if relpath is not None and relpath != '.':
2283
if not base.endswith('/'):
2285
# XXX: Really base should be a url; we did after all call
2286
# get_url()! But sometimes it's just a path (from
2287
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2288
# to a non-escaped local path.
2289
if base.startswith('./') or base.startswith('/'):
2292
base += urlutils.escape(relpath)
2295
def get_url(self, relpath=None):
2296
"""Get a URL (or maybe a path) for the readwrite transport.
2298
This will either be backed by '.' or to an equivalent non-file based
2300
relpath provides for clients to get a path relative to the base url.
2301
These should only be downwards relative, not upwards.
2303
base = self.get_server().get_url()
2304
return self._adjust_url(base, relpath)
2306
def get_vfs_only_url(self, relpath=None):
2307
"""Get a URL (or maybe a path for the plain old vfs transport.
2309
This will never be a smart protocol. It always has all the
2310
capabilities of the local filesystem, but it might actually be a
2311
MemoryTransport or some other similar virtual filesystem.
2313
This is the backing transport (if any) of the server returned by
2314
get_url and get_readonly_url.
2316
:param relpath: provides for clients to get a path relative to the base
2317
url. These should only be downwards relative, not upwards.
2320
base = self.get_vfs_only_server().get_url()
2321
return self._adjust_url(base, relpath)
2323
def _create_safety_net(self):
2324
"""Make a fake bzr directory.
2326
This prevents any tests propagating up onto the TEST_ROOT directory's
2329
root = TestCaseWithMemoryTransport.TEST_ROOT
2330
bzrdir.BzrDir.create_standalone_workingtree(root)
2332
def _check_safety_net(self):
2333
"""Check that the safety .bzr directory have not been touched.
2335
_make_test_root have created a .bzr directory to prevent tests from
2336
propagating. This method ensures than a test did not leaked.
2338
root = TestCaseWithMemoryTransport.TEST_ROOT
2339
self.permit_url(_mod_transport.get_transport(root).base)
2340
wt = workingtree.WorkingTree.open(root)
2341
last_rev = wt.last_revision()
2342
if last_rev != 'null:':
2343
# The current test have modified the /bzr directory, we need to
2344
# recreate a new one or all the followng tests will fail.
2345
# If you need to inspect its content uncomment the following line
2346
# import pdb; pdb.set_trace()
2347
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2348
self._create_safety_net()
2349
raise AssertionError('%s/.bzr should not be modified' % root)
2351
def _make_test_root(self):
2352
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2353
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2354
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2356
TestCaseWithMemoryTransport.TEST_ROOT = root
2358
self._create_safety_net()
2360
# The same directory is used by all tests, and we're not
2361
# specifically told when all tests are finished. This will do.
2362
atexit.register(_rmtree_temp_dir, root)
2364
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2365
self.addCleanup(self._check_safety_net)
2367
def makeAndChdirToTestDir(self):
2368
"""Create a temporary directories for this one test.
2370
This must set self.test_home_dir and self.test_dir and chdir to
2373
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2375
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2376
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2377
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2378
self.permit_dir(self.test_dir)
2380
def make_branch(self, relpath, format=None):
2381
"""Create a branch on the transport at relpath."""
2382
repo = self.make_repository(relpath, format=format)
2383
return repo.bzrdir.create_branch()
2385
def make_bzrdir(self, relpath, format=None):
2387
# might be a relative or absolute path
2388
maybe_a_url = self.get_url(relpath)
2389
segments = maybe_a_url.rsplit('/', 1)
2390
t = _mod_transport.get_transport(maybe_a_url)
2391
if len(segments) > 1 and segments[-1] not in ('', '.'):
2395
if isinstance(format, basestring):
2396
format = bzrdir.format_registry.make_bzrdir(format)
2397
return format.initialize_on_transport(t)
2398
except errors.UninitializableFormat:
2399
raise TestSkipped("Format %s is not initializable." % format)
2401
def make_repository(self, relpath, shared=False, format=None):
2402
"""Create a repository on our default transport at relpath.
2404
Note that relpath must be a relative path, not a full url.
2406
# FIXME: If you create a remoterepository this returns the underlying
2407
# real format, which is incorrect. Actually we should make sure that
2408
# RemoteBzrDir returns a RemoteRepository.
2409
# maybe mbp 20070410
2410
made_control = self.make_bzrdir(relpath, format=format)
2411
return made_control.create_repository(shared=shared)
2413
def make_smart_server(self, path, backing_server=None):
2414
if backing_server is None:
2415
backing_server = self.get_server()
2416
smart_server = test_server.SmartTCPServer_for_testing()
2417
self.start_server(smart_server, backing_server)
2418
remote_transport = _mod_transport.get_transport(smart_server.get_url()
2420
return remote_transport
2422
def make_branch_and_memory_tree(self, relpath, format=None):
2423
"""Create a branch on the default transport and a MemoryTree for it."""
2424
b = self.make_branch(relpath, format=format)
2425
return memorytree.MemoryTree.create_on_branch(b)
2427
def make_branch_builder(self, relpath, format=None):
2428
branch = self.make_branch(relpath, format=format)
2429
return branchbuilder.BranchBuilder(branch=branch)
2431
def overrideEnvironmentForTesting(self):
2432
test_home_dir = self.test_home_dir
2433
if isinstance(test_home_dir, unicode):
2434
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2435
os.environ['HOME'] = test_home_dir
2436
os.environ['BZR_HOME'] = test_home_dir
2439
super(TestCaseWithMemoryTransport, self).setUp()
2440
self._make_test_root()
2441
self.addCleanup(os.chdir, os.getcwdu())
2442
self.makeAndChdirToTestDir()
2443
self.overrideEnvironmentForTesting()
2444
self.__readonly_server = None
2445
self.__server = None
2446
self.reduceLockdirTimeout()
2448
def setup_smart_server_with_call_log(self):
2449
"""Sets up a smart server as the transport server with a call log."""
2450
self.transport_server = test_server.SmartTCPServer_for_testing
2451
self.hpss_calls = []
2453
# Skip the current stack down to the caller of
2454
# setup_smart_server_with_call_log
2455
prefix_length = len(traceback.extract_stack()) - 2
2456
def capture_hpss_call(params):
2457
self.hpss_calls.append(
2458
CapturedCall(params, prefix_length))
2459
client._SmartClient.hooks.install_named_hook(
2460
'call', capture_hpss_call, None)
2462
def reset_smart_call_log(self):
2463
self.hpss_calls = []
2466
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2467
"""Derived class that runs a test within a temporary directory.
2469
This is useful for tests that need to create a branch, etc.
2471
The directory is created in a slightly complex way: for each
2472
Python invocation, a new temporary top-level directory is created.
2473
All test cases create their own directory within that. If the
2474
tests complete successfully, the directory is removed.
2476
:ivar test_base_dir: The path of the top-level directory for this
2477
test, which contains a home directory and a work directory.
2479
:ivar test_home_dir: An initially empty directory under test_base_dir
2480
which is used as $HOME for this test.
2482
:ivar test_dir: A directory under test_base_dir used as the current
2483
directory when the test proper is run.
2486
OVERRIDE_PYTHON = 'python'
2488
def check_file_contents(self, filename, expect):
2489
self.log("check contents of file %s" % filename)
2495
if contents != expect:
2496
self.log("expected: %r" % expect)
2497
self.log("actually: %r" % contents)
2498
self.fail("contents of %s not as expected" % filename)
2500
def _getTestDirPrefix(self):
2501
# create a directory within the top level test directory
2502
if sys.platform in ('win32', 'cygwin'):
2503
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2504
# windows is likely to have path-length limits so use a short name
2505
name_prefix = name_prefix[-30:]
2507
name_prefix = re.sub('[/]', '_', self.id())
2510
def makeAndChdirToTestDir(self):
2511
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2513
For TestCaseInTempDir we create a temporary directory based on the test
2514
name and then create two subdirs - test and home under it.
2516
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2517
self._getTestDirPrefix())
2519
for i in range(100):
2520
if os.path.exists(name):
2521
name = name_prefix + '_' + str(i)
2523
# now create test and home directories within this dir
2524
self.test_base_dir = name
2525
self.addCleanup(self.deleteTestDir)
2526
os.mkdir(self.test_base_dir)
2528
self.permit_dir(self.test_base_dir)
2529
# 'sprouting' and 'init' of a branch both walk up the tree to find
2530
# stacking policy to honour; create a bzr dir with an unshared
2531
# repository (but not a branch - our code would be trying to escape
2532
# then!) to stop them, and permit it to be read.
2533
# control = bzrdir.BzrDir.create(self.test_base_dir)
2534
# control.create_repository()
2535
self.test_home_dir = self.test_base_dir + '/home'
2536
os.mkdir(self.test_home_dir)
2537
self.test_dir = self.test_base_dir + '/work'
2538
os.mkdir(self.test_dir)
2539
os.chdir(self.test_dir)
2540
# put name of test inside
2541
f = file(self.test_base_dir + '/name', 'w')
2547
def deleteTestDir(self):
2548
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2549
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2551
def build_tree(self, shape, line_endings='binary', transport=None):
2552
"""Build a test tree according to a pattern.
2554
shape is a sequence of file specifications. If the final
2555
character is '/', a directory is created.
2557
This assumes that all the elements in the tree being built are new.
2559
This doesn't add anything to a branch.
2561
:type shape: list or tuple.
2562
:param line_endings: Either 'binary' or 'native'
2563
in binary mode, exact contents are written in native mode, the
2564
line endings match the default platform endings.
2565
:param transport: A transport to write to, for building trees on VFS's.
2566
If the transport is readonly or None, "." is opened automatically.
2569
if type(shape) not in (list, tuple):
2570
raise AssertionError("Parameter 'shape' should be "
2571
"a list or a tuple. Got %r instead" % (shape,))
2572
# It's OK to just create them using forward slashes on windows.
2573
if transport is None or transport.is_readonly():
2574
transport = _mod_transport.get_transport(".")
2576
self.assertIsInstance(name, basestring)
2578
transport.mkdir(urlutils.escape(name[:-1]))
2580
if line_endings == 'binary':
2582
elif line_endings == 'native':
2585
raise errors.BzrError(
2586
'Invalid line ending request %r' % line_endings)
2587
content = "contents of %s%s" % (name.encode('utf-8'), end)
2588
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2590
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2592
def assertInWorkingTree(self, path, root_path='.', tree=None):
2593
"""Assert whether path or paths are in the WorkingTree"""
2595
tree = workingtree.WorkingTree.open(root_path)
2596
if not isinstance(path, basestring):
2598
self.assertInWorkingTree(p, tree=tree)
2600
self.assertIsNot(tree.path2id(path), None,
2601
path+' not in working tree.')
2603
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2604
"""Assert whether path or paths are not in the WorkingTree"""
2606
tree = workingtree.WorkingTree.open(root_path)
2607
if not isinstance(path, basestring):
2609
self.assertNotInWorkingTree(p,tree=tree)
2611
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2614
class TestCaseWithTransport(TestCaseInTempDir):
2615
"""A test case that provides get_url and get_readonly_url facilities.
2617
These back onto two transport servers, one for readonly access and one for
2620
If no explicit class is provided for readonly access, a
2621
ReadonlyTransportDecorator is used instead which allows the use of non disk
2622
based read write transports.
2624
If an explicit class is provided for readonly access, that server and the
2625
readwrite one must both define get_url() as resolving to os.getcwd().
2628
def get_vfs_only_server(self):
2629
"""See TestCaseWithMemoryTransport.
2631
This is useful for some tests with specific servers that need
2634
if self.__vfs_server is None:
2635
self.__vfs_server = self.vfs_transport_factory()
2636
self.start_server(self.__vfs_server)
2637
return self.__vfs_server
2639
def make_branch_and_tree(self, relpath, format=None):
2640
"""Create a branch on the transport and a tree locally.
2642
If the transport is not a LocalTransport, the Tree can't be created on
2643
the transport. In that case if the vfs_transport_factory is
2644
LocalURLServer the working tree is created in the local
2645
directory backing the transport, and the returned tree's branch and
2646
repository will also be accessed locally. Otherwise a lightweight
2647
checkout is created and returned.
2649
We do this because we can't physically create a tree in the local
2650
path, with a branch reference to the transport_factory url, and
2651
a branch + repository in the vfs_transport, unless the vfs_transport
2652
namespace is distinct from the local disk - the two branch objects
2653
would collide. While we could construct a tree with its branch object
2654
pointing at the transport_factory transport in memory, reopening it
2655
would behaving unexpectedly, and has in the past caused testing bugs
2656
when we tried to do it that way.
2658
:param format: The BzrDirFormat.
2659
:returns: the WorkingTree.
2661
# TODO: always use the local disk path for the working tree,
2662
# this obviously requires a format that supports branch references
2663
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2665
b = self.make_branch(relpath, format=format)
2667
return b.bzrdir.create_workingtree()
2668
except errors.NotLocalUrl:
2669
# We can only make working trees locally at the moment. If the
2670
# transport can't support them, then we keep the non-disk-backed
2671
# branch and create a local checkout.
2672
if self.vfs_transport_factory is test_server.LocalURLServer:
2673
# the branch is colocated on disk, we cannot create a checkout.
2674
# hopefully callers will expect this.
2675
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2676
wt = local_controldir.create_workingtree()
2677
if wt.branch._format != b._format:
2679
# Make sure that assigning to wt._branch fixes wt.branch,
2680
# in case the implementation details of workingtree objects
2682
self.assertIs(b, wt.branch)
2685
return b.create_checkout(relpath, lightweight=True)
2687
def assertIsDirectory(self, relpath, transport):
2688
"""Assert that relpath within transport is a directory.
2690
This may not be possible on all transports; in that case it propagates
2691
a TransportNotPossible.
2694
mode = transport.stat(relpath).st_mode
2695
except errors.NoSuchFile:
2696
self.fail("path %s is not a directory; no such file"
2698
if not stat.S_ISDIR(mode):
2699
self.fail("path %s is not a directory; has mode %#o"
2702
def assertTreesEqual(self, left, right):
2703
"""Check that left and right have the same content and properties."""
2704
# we use a tree delta to check for equality of the content, and we
2705
# manually check for equality of other things such as the parents list.
2706
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2707
differences = left.changes_from(right)
2708
self.assertFalse(differences.has_changed(),
2709
"Trees %r and %r are different: %r" % (left, right, differences))
2712
super(TestCaseWithTransport, self).setUp()
2713
self.__vfs_server = None
2715
def disable_missing_extensions_warning(self):
2716
"""Some tests expect a precise stderr content.
2718
There is no point in forcing them to duplicate the extension related
2721
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2724
class ChrootedTestCase(TestCaseWithTransport):
2725
"""A support class that provides readonly urls outside the local namespace.
2727
This is done by checking if self.transport_server is a MemoryServer. if it
2728
is then we are chrooted already, if it is not then an HttpServer is used
2731
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2732
be used without needed to redo it when a different
2733
subclass is in use ?
2737
super(ChrootedTestCase, self).setUp()
2738
if not self.vfs_transport_factory == memory.MemoryServer:
2739
self.transport_readonly_server = HttpServer
2742
def condition_id_re(pattern):
2743
"""Create a condition filter which performs a re check on a test's id.
2745
:param pattern: A regular expression string.
2746
:return: A callable that returns True if the re matches.
2748
filter_re = re.compile(pattern, 0)
2749
def condition(test):
2751
return filter_re.search(test_id)
2755
def condition_isinstance(klass_or_klass_list):
2756
"""Create a condition filter which returns isinstance(param, klass).
2758
:return: A callable which when called with one parameter obj return the
2759
result of isinstance(obj, klass_or_klass_list).
2762
return isinstance(obj, klass_or_klass_list)
2766
def condition_id_in_list(id_list):
2767
"""Create a condition filter which verify that test's id in a list.
2769
:param id_list: A TestIdList object.
2770
:return: A callable that returns True if the test's id appears in the list.
2772
def condition(test):
2773
return id_list.includes(test.id())
2777
def condition_id_startswith(starts):
2778
"""Create a condition filter verifying that test's id starts with a string.
2780
:param starts: A list of string.
2781
:return: A callable that returns True if the test's id starts with one of
2784
def condition(test):
2785
for start in starts:
2786
if test.id().startswith(start):
2792
def exclude_tests_by_condition(suite, condition):
2793
"""Create a test suite which excludes some tests from suite.
2795
:param suite: The suite to get tests from.
2796
:param condition: A callable whose result evaluates True when called with a
2797
test case which should be excluded from the result.
2798
:return: A suite which contains the tests found in suite that fail
2802
for test in iter_suite_tests(suite):
2803
if not condition(test):
2805
return TestUtil.TestSuite(result)
2808
def filter_suite_by_condition(suite, condition):
2809
"""Create a test suite by filtering another one.
2811
:param suite: The source suite.
2812
:param condition: A callable whose result evaluates True when called with a
2813
test case which should be included in the result.
2814
:return: A suite which contains the tests found in suite that pass
2818
for test in iter_suite_tests(suite):
2821
return TestUtil.TestSuite(result)
2824
def filter_suite_by_re(suite, pattern):
2825
"""Create a test suite by filtering another one.
2827
:param suite: the source suite
2828
:param pattern: pattern that names must match
2829
:returns: the newly created suite
2831
condition = condition_id_re(pattern)
2832
result_suite = filter_suite_by_condition(suite, condition)
2836
def filter_suite_by_id_list(suite, test_id_list):
2837
"""Create a test suite by filtering another one.
2839
:param suite: The source suite.
2840
:param test_id_list: A list of the test ids to keep as strings.
2841
:returns: the newly created suite
2843
condition = condition_id_in_list(test_id_list)
2844
result_suite = filter_suite_by_condition(suite, condition)
2848
def filter_suite_by_id_startswith(suite, start):
2849
"""Create a test suite by filtering another one.
2851
:param suite: The source suite.
2852
:param start: A list of string the test id must start with one of.
2853
:returns: the newly created suite
2855
condition = condition_id_startswith(start)
2856
result_suite = filter_suite_by_condition(suite, condition)
2860
def exclude_tests_by_re(suite, pattern):
2861
"""Create a test suite which excludes some tests from suite.
2863
:param suite: The suite to get tests from.
2864
:param pattern: A regular expression string. Test ids that match this
2865
pattern will be excluded from the result.
2866
:return: A TestSuite that contains all the tests from suite without the
2867
tests that matched pattern. The order of tests is the same as it was in
2870
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2873
def preserve_input(something):
2874
"""A helper for performing test suite transformation chains.
2876
:param something: Anything you want to preserve.
2882
def randomize_suite(suite):
2883
"""Return a new TestSuite with suite's tests in random order.
2885
The tests in the input suite are flattened into a single suite in order to
2886
accomplish this. Any nested TestSuites are removed to provide global
2889
tests = list(iter_suite_tests(suite))
2890
random.shuffle(tests)
2891
return TestUtil.TestSuite(tests)
2894
def split_suite_by_condition(suite, condition):
2895
"""Split a test suite into two by a condition.
2897
:param suite: The suite to split.
2898
:param condition: The condition to match on. Tests that match this
2899
condition are returned in the first test suite, ones that do not match
2900
are in the second suite.
2901
:return: A tuple of two test suites, where the first contains tests from
2902
suite matching the condition, and the second contains the remainder
2903
from suite. The order within each output suite is the same as it was in
2908
for test in iter_suite_tests(suite):
2910
matched.append(test)
2912
did_not_match.append(test)
2913
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2916
def split_suite_by_re(suite, pattern):
2917
"""Split a test suite into two by a regular expression.
2919
:param suite: The suite to split.
2920
:param pattern: A regular expression string. Test ids that match this
2921
pattern will be in the first test suite returned, and the others in the
2922
second test suite returned.
2923
:return: A tuple of two test suites, where the first contains tests from
2924
suite matching pattern, and the second contains the remainder from
2925
suite. The order within each output suite is the same as it was in
2928
return split_suite_by_condition(suite, condition_id_re(pattern))
2931
def run_suite(suite, name='test', verbose=False, pattern=".*",
2932
stop_on_failure=False,
2933
transport=None, lsprof_timed=None, bench_history=None,
2934
matching_tests_first=None,
2937
exclude_pattern=None,
2940
suite_decorators=None,
2942
result_decorators=None,
2944
"""Run a test suite for bzr selftest.
2946
:param runner_class: The class of runner to use. Must support the
2947
constructor arguments passed by run_suite which are more than standard
2949
:return: A boolean indicating success.
2951
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2956
if runner_class is None:
2957
runner_class = TextTestRunner
2960
runner = runner_class(stream=stream,
2962
verbosity=verbosity,
2963
bench_history=bench_history,
2965
result_decorators=result_decorators,
2967
runner.stop_on_failure=stop_on_failure
2968
# built in decorator factories:
2970
random_order(random_seed, runner),
2971
exclude_tests(exclude_pattern),
2973
if matching_tests_first:
2974
decorators.append(tests_first(pattern))
2976
decorators.append(filter_tests(pattern))
2977
if suite_decorators:
2978
decorators.extend(suite_decorators)
2979
# tell the result object how many tests will be running: (except if
2980
# --parallel=fork is being used. Robert said he will provide a better
2981
# progress design later -- vila 20090817)
2982
if fork_decorator not in decorators:
2983
decorators.append(CountingDecorator)
2984
for decorator in decorators:
2985
suite = decorator(suite)
2987
# Done after test suite decoration to allow randomisation etc
2988
# to take effect, though that is of marginal benefit.
2990
stream.write("Listing tests only ...\n")
2991
for t in iter_suite_tests(suite):
2992
stream.write("%s\n" % (t.id()))
2994
result = runner.run(suite)
2996
return result.wasStrictlySuccessful()
2998
return result.wasSuccessful()
3001
# A registry where get() returns a suite decorator.
3002
parallel_registry = registry.Registry()
3005
def fork_decorator(suite):
3006
concurrency = osutils.local_concurrency()
3007
if concurrency == 1:
3009
from testtools import ConcurrentTestSuite
3010
return ConcurrentTestSuite(suite, fork_for_tests)
3011
parallel_registry.register('fork', fork_decorator)
3014
def subprocess_decorator(suite):
3015
concurrency = osutils.local_concurrency()
3016
if concurrency == 1:
3018
from testtools import ConcurrentTestSuite
3019
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3020
parallel_registry.register('subprocess', subprocess_decorator)
3023
def exclude_tests(exclude_pattern):
3024
"""Return a test suite decorator that excludes tests."""
3025
if exclude_pattern is None:
3026
return identity_decorator
3027
def decorator(suite):
3028
return ExcludeDecorator(suite, exclude_pattern)
3032
def filter_tests(pattern):
3034
return identity_decorator
3035
def decorator(suite):
3036
return FilterTestsDecorator(suite, pattern)
3040
def random_order(random_seed, runner):
3041
"""Return a test suite decorator factory for randomising tests order.
3043
:param random_seed: now, a string which casts to a long, or a long.
3044
:param runner: A test runner with a stream attribute to report on.
3046
if random_seed is None:
3047
return identity_decorator
3048
def decorator(suite):
3049
return RandomDecorator(suite, random_seed, runner.stream)
3053
def tests_first(pattern):
3055
return identity_decorator
3056
def decorator(suite):
3057
return TestFirstDecorator(suite, pattern)
3061
def identity_decorator(suite):
3066
class TestDecorator(TestSuite):
3067
"""A decorator for TestCase/TestSuite objects.
3069
Usually, subclasses should override __iter__(used when flattening test
3070
suites), which we do to filter, reorder, parallelise and so on, run() and
3074
def __init__(self, suite):
3075
TestSuite.__init__(self)
3078
def countTestCases(self):
3081
cases += test.countTestCases()
3088
def run(self, result):
3089
# Use iteration on self, not self._tests, to allow subclasses to hook
3092
if result.shouldStop:
3098
class CountingDecorator(TestDecorator):
3099
"""A decorator which calls result.progress(self.countTestCases)."""
3101
def run(self, result):
3102
progress_method = getattr(result, 'progress', None)
3103
if callable(progress_method):
3104
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3105
return super(CountingDecorator, self).run(result)
3108
class ExcludeDecorator(TestDecorator):
3109
"""A decorator which excludes test matching an exclude pattern."""
3111
def __init__(self, suite, exclude_pattern):
3112
TestDecorator.__init__(self, suite)
3113
self.exclude_pattern = exclude_pattern
3114
self.excluded = False
3118
return iter(self._tests)
3119
self.excluded = True
3120
suite = exclude_tests_by_re(self, self.exclude_pattern)
3122
self.addTests(suite)
3123
return iter(self._tests)
3126
class FilterTestsDecorator(TestDecorator):
3127
"""A decorator which filters tests to those matching a pattern."""
3129
def __init__(self, suite, pattern):
3130
TestDecorator.__init__(self, suite)
3131
self.pattern = pattern
3132
self.filtered = False
3136
return iter(self._tests)
3137
self.filtered = True
3138
suite = filter_suite_by_re(self, self.pattern)
3140
self.addTests(suite)
3141
return iter(self._tests)
3144
class RandomDecorator(TestDecorator):
3145
"""A decorator which randomises the order of its tests."""
3147
def __init__(self, suite, random_seed, stream):
3148
TestDecorator.__init__(self, suite)
3149
self.random_seed = random_seed
3150
self.randomised = False
3151
self.stream = stream
3155
return iter(self._tests)
3156
self.randomised = True
3157
self.stream.write("Randomizing test order using seed %s\n\n" %
3158
(self.actual_seed()))
3159
# Initialise the random number generator.
3160
random.seed(self.actual_seed())
3161
suite = randomize_suite(self)
3163
self.addTests(suite)
3164
return iter(self._tests)
3166
def actual_seed(self):
3167
if self.random_seed == "now":
3168
# We convert the seed to a long to make it reuseable across
3169
# invocations (because the user can reenter it).
3170
self.random_seed = long(time.time())
3172
# Convert the seed to a long if we can
3174
self.random_seed = long(self.random_seed)
3177
return self.random_seed
3180
class TestFirstDecorator(TestDecorator):
3181
"""A decorator which moves named tests to the front."""
3183
def __init__(self, suite, pattern):
3184
TestDecorator.__init__(self, suite)
3185
self.pattern = pattern
3186
self.filtered = False
3190
return iter(self._tests)
3191
self.filtered = True
3192
suites = split_suite_by_re(self, self.pattern)
3194
self.addTests(suites)
3195
return iter(self._tests)
3198
def partition_tests(suite, count):
3199
"""Partition suite into count lists of tests."""
3200
# This just assigns tests in a round-robin fashion. On one hand this
3201
# splits up blocks of related tests that might run faster if they shared
3202
# resources, but on the other it avoids assigning blocks of slow tests to
3203
# just one partition. So the slowest partition shouldn't be much slower
3205
partitions = [list() for i in range(count)]
3206
tests = iter_suite_tests(suite)
3207
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3208
partition.append(test)
3212
def workaround_zealous_crypto_random():
3213
"""Crypto.Random want to help us being secure, but we don't care here.
3215
This workaround some test failure related to the sftp server. Once paramiko
3216
stop using the controversial API in Crypto.Random, we may get rid of it.
3219
from Crypto.Random import atfork
3225
def fork_for_tests(suite):
3226
"""Take suite and start up one runner per CPU by forking()
3228
:return: An iterable of TestCase-like objects which can each have
3229
run(result) called on them to feed tests to result.
3231
concurrency = osutils.local_concurrency()
3233
from subunit import TestProtocolClient, ProtocolTestCase
3234
from subunit.test_results import AutoTimingTestResultDecorator
3235
class TestInOtherProcess(ProtocolTestCase):
3236
# Should be in subunit, I think. RBC.
3237
def __init__(self, stream, pid):
3238
ProtocolTestCase.__init__(self, stream)
3241
def run(self, result):
3243
ProtocolTestCase.run(self, result)
3245
os.waitpid(self.pid, 0)
3247
test_blocks = partition_tests(suite, concurrency)
3248
for process_tests in test_blocks:
3249
process_suite = TestSuite()
3250
process_suite.addTests(process_tests)
3251
c2pread, c2pwrite = os.pipe()
3254
workaround_zealous_crypto_random()
3257
# Leave stderr and stdout open so we can see test noise
3258
# Close stdin so that the child goes away if it decides to
3259
# read from stdin (otherwise its a roulette to see what
3260
# child actually gets keystrokes for pdb etc).
3263
stream = os.fdopen(c2pwrite, 'wb', 1)
3264
subunit_result = AutoTimingTestResultDecorator(
3265
TestProtocolClient(stream))
3266
process_suite.run(subunit_result)
3271
stream = os.fdopen(c2pread, 'rb', 1)
3272
test = TestInOtherProcess(stream, pid)
3277
def reinvoke_for_tests(suite):
3278
"""Take suite and start up one runner per CPU using subprocess().
3280
:return: An iterable of TestCase-like objects which can each have
3281
run(result) called on them to feed tests to result.
3283
concurrency = osutils.local_concurrency()
3285
from subunit import ProtocolTestCase
3286
class TestInSubprocess(ProtocolTestCase):
3287
def __init__(self, process, name):
3288
ProtocolTestCase.__init__(self, process.stdout)
3289
self.process = process
3290
self.process.stdin.close()
3293
def run(self, result):
3295
ProtocolTestCase.run(self, result)
3298
os.unlink(self.name)
3299
# print "pid %d finished" % finished_process
3300
test_blocks = partition_tests(suite, concurrency)
3301
for process_tests in test_blocks:
3302
# ugly; currently reimplement rather than reuses TestCase methods.
3303
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3304
if not os.path.isfile(bzr_path):
3305
# We are probably installed. Assume sys.argv is the right file
3306
bzr_path = sys.argv[0]
3307
bzr_path = [bzr_path]
3308
if sys.platform == "win32":
3309
# if we're on windows, we can't execute the bzr script directly
3310
bzr_path = [sys.executable] + bzr_path
3311
fd, test_list_file_name = tempfile.mkstemp()
3312
test_list_file = os.fdopen(fd, 'wb', 1)
3313
for test in process_tests:
3314
test_list_file.write(test.id() + '\n')
3315
test_list_file.close()
3317
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3319
if '--no-plugins' in sys.argv:
3320
argv.append('--no-plugins')
3321
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3322
# noise on stderr it can interrupt the subunit protocol.
3323
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3324
stdout=subprocess.PIPE,
3325
stderr=subprocess.PIPE,
3327
test = TestInSubprocess(process, test_list_file_name)
3330
os.unlink(test_list_file_name)
3335
class ForwardingResult(unittest.TestResult):
3337
def __init__(self, target):
3338
unittest.TestResult.__init__(self)
3339
self.result = target
3341
def startTest(self, test):
3342
self.result.startTest(test)
3344
def stopTest(self, test):
3345
self.result.stopTest(test)
3347
def startTestRun(self):
3348
self.result.startTestRun()
3350
def stopTestRun(self):
3351
self.result.stopTestRun()
3353
def addSkip(self, test, reason):
3354
self.result.addSkip(test, reason)
3356
def addSuccess(self, test):
3357
self.result.addSuccess(test)
3359
def addError(self, test, err):
3360
self.result.addError(test, err)
3362
def addFailure(self, test, err):
3363
self.result.addFailure(test, err)
3364
ForwardingResult = testtools.ExtendedToOriginalDecorator
3367
class ProfileResult(ForwardingResult):
3368
"""Generate profiling data for all activity between start and success.
3370
The profile data is appended to the test's _benchcalls attribute and can
3371
be accessed by the forwarded-to TestResult.
3373
While it might be cleaner do accumulate this in stopTest, addSuccess is
3374
where our existing output support for lsprof is, and this class aims to
3375
fit in with that: while it could be moved it's not necessary to accomplish
3376
test profiling, nor would it be dramatically cleaner.
3379
def startTest(self, test):
3380
self.profiler = bzrlib.lsprof.BzrProfiler()
3381
# Prevent deadlocks in tests that use lsprof: those tests will
3383
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3384
self.profiler.start()
3385
ForwardingResult.startTest(self, test)
3387
def addSuccess(self, test):
3388
stats = self.profiler.stop()
3390
calls = test._benchcalls
3391
except AttributeError:
3392
test._benchcalls = []
3393
calls = test._benchcalls
3394
calls.append(((test.id(), "", ""), stats))
3395
ForwardingResult.addSuccess(self, test)
3397
def stopTest(self, test):
3398
ForwardingResult.stopTest(self, test)
3399
self.profiler = None
3402
# Controlled by "bzr selftest -E=..." option
3403
# Currently supported:
3404
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3405
# preserves any flags supplied at the command line.
3406
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3407
# rather than failing tests. And no longer raise
3408
# LockContention when fctnl locks are not being used
3409
# with proper exclusion rules.
3410
selftest_debug_flags = set()
3413
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3415
test_suite_factory=None,
3418
matching_tests_first=None,
3421
exclude_pattern=None,
3427
suite_decorators=None,
3431
"""Run the whole test suite under the enhanced runner"""
3432
# XXX: Very ugly way to do this...
3433
# Disable warning about old formats because we don't want it to disturb
3434
# any blackbox tests.
3435
from bzrlib import repository
3436
repository._deprecation_warning_done = True
3438
global default_transport
3439
if transport is None:
3440
transport = default_transport
3441
old_transport = default_transport
3442
default_transport = transport
3443
global selftest_debug_flags
3444
old_debug_flags = selftest_debug_flags
3445
if debug_flags is not None:
3446
selftest_debug_flags = set(debug_flags)
3448
if load_list is None:
3451
keep_only = load_test_id_list(load_list)
3453
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3454
for start in starting_with]
3455
if test_suite_factory is None:
3456
# Reduce loading time by loading modules based on the starting_with
3458
suite = test_suite(keep_only, starting_with)
3460
suite = test_suite_factory()
3462
# But always filter as requested.
3463
suite = filter_suite_by_id_startswith(suite, starting_with)
3464
result_decorators = []
3466
result_decorators.append(ProfileResult)
3467
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3468
stop_on_failure=stop_on_failure,
3469
transport=transport,
3470
lsprof_timed=lsprof_timed,
3471
bench_history=bench_history,
3472
matching_tests_first=matching_tests_first,
3473
list_only=list_only,
3474
random_seed=random_seed,
3475
exclude_pattern=exclude_pattern,
3477
runner_class=runner_class,
3478
suite_decorators=suite_decorators,
3480
result_decorators=result_decorators,
3483
default_transport = old_transport
3484
selftest_debug_flags = old_debug_flags
3487
def load_test_id_list(file_name):
3488
"""Load a test id list from a text file.
3490
The format is one test id by line. No special care is taken to impose
3491
strict rules, these test ids are used to filter the test suite so a test id
3492
that do not match an existing test will do no harm. This allows user to add
3493
comments, leave blank lines, etc.
3497
ftest = open(file_name, 'rt')
3499
if e.errno != errno.ENOENT:
3502
raise errors.NoSuchFile(file_name)
3504
for test_name in ftest.readlines():
3505
test_list.append(test_name.strip())
3510
def suite_matches_id_list(test_suite, id_list):
3511
"""Warns about tests not appearing or appearing more than once.
3513
:param test_suite: A TestSuite object.
3514
:param test_id_list: The list of test ids that should be found in
3517
:return: (absents, duplicates) absents is a list containing the test found
3518
in id_list but not in test_suite, duplicates is a list containing the
3519
test found multiple times in test_suite.
3521
When using a prefined test id list, it may occurs that some tests do not
3522
exist anymore or that some tests use the same id. This function warns the
3523
tester about potential problems in his workflow (test lists are volatile)
3524
or in the test suite itself (using the same id for several tests does not
3525
help to localize defects).
3527
# Build a dict counting id occurrences
3529
for test in iter_suite_tests(test_suite):
3531
tests[id] = tests.get(id, 0) + 1
3536
occurs = tests.get(id, 0)
3538
not_found.append(id)
3540
duplicates.append(id)
3542
return not_found, duplicates
3545
class TestIdList(object):
3546
"""Test id list to filter a test suite.
3548
Relying on the assumption that test ids are built as:
3549
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3550
notation, this class offers methods to :
3551
- avoid building a test suite for modules not refered to in the test list,
3552
- keep only the tests listed from the module test suite.
3555
def __init__(self, test_id_list):
3556
# When a test suite needs to be filtered against us we compare test ids
3557
# for equality, so a simple dict offers a quick and simple solution.
3558
self.tests = dict().fromkeys(test_id_list, True)
3560
# While unittest.TestCase have ids like:
3561
# <module>.<class>.<method>[(<param+)],
3562
# doctest.DocTestCase can have ids like:
3565
# <module>.<function>
3566
# <module>.<class>.<method>
3568
# Since we can't predict a test class from its name only, we settle on
3569
# a simple constraint: a test id always begins with its module name.
3572
for test_id in test_id_list:
3573
parts = test_id.split('.')
3574
mod_name = parts.pop(0)
3575
modules[mod_name] = True
3577
mod_name += '.' + part
3578
modules[mod_name] = True
3579
self.modules = modules
3581
def refers_to(self, module_name):
3582
"""Is there tests for the module or one of its sub modules."""
3583
return self.modules.has_key(module_name)
3585
def includes(self, test_id):
3586
return self.tests.has_key(test_id)
3589
class TestPrefixAliasRegistry(registry.Registry):
3590
"""A registry for test prefix aliases.
3592
This helps implement shorcuts for the --starting-with selftest
3593
option. Overriding existing prefixes is not allowed but not fatal (a
3594
warning will be emitted).
3597
def register(self, key, obj, help=None, info=None,
3598
override_existing=False):
3599
"""See Registry.register.
3601
Trying to override an existing alias causes a warning to be emitted,
3602
not a fatal execption.
3605
super(TestPrefixAliasRegistry, self).register(
3606
key, obj, help=help, info=info, override_existing=False)
3608
actual = self.get(key)
3609
note('Test prefix alias %s is already used for %s, ignoring %s'
3610
% (key, actual, obj))
3612
def resolve_alias(self, id_start):
3613
"""Replace the alias by the prefix in the given string.
3615
Using an unknown prefix is an error to help catching typos.
3617
parts = id_start.split('.')
3619
parts[0] = self.get(parts[0])
3621
raise errors.BzrCommandError(
3622
'%s is not a known test prefix alias' % parts[0])
3623
return '.'.join(parts)
3626
test_prefix_alias_registry = TestPrefixAliasRegistry()
3627
"""Registry of test prefix aliases."""
3630
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3631
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3632
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3634
# Obvious highest levels prefixes, feel free to add your own via a plugin
3635
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3636
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3637
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3638
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3639
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3642
def _test_suite_testmod_names():
3643
"""Return the standard list of test module names to test."""
3646
'bzrlib.tests.blackbox',
3647
'bzrlib.tests.commands',
3648
'bzrlib.tests.doc_generate',
3649
'bzrlib.tests.per_branch',
3650
'bzrlib.tests.per_bzrdir',
3651
'bzrlib.tests.per_bzrdir_colo',
3652
'bzrlib.tests.per_foreign_vcs',
3653
'bzrlib.tests.per_interrepository',
3654
'bzrlib.tests.per_intertree',
3655
'bzrlib.tests.per_inventory',
3656
'bzrlib.tests.per_interbranch',
3657
'bzrlib.tests.per_lock',
3658
'bzrlib.tests.per_merger',
3659
'bzrlib.tests.per_transport',
3660
'bzrlib.tests.per_tree',
3661
'bzrlib.tests.per_pack_repository',
3662
'bzrlib.tests.per_repository',
3663
'bzrlib.tests.per_repository_chk',
3664
'bzrlib.tests.per_repository_reference',
3665
'bzrlib.tests.per_uifactory',
3666
'bzrlib.tests.per_versionedfile',
3667
'bzrlib.tests.per_workingtree',
3668
'bzrlib.tests.test__annotator',
3669
'bzrlib.tests.test__bencode',
3670
'bzrlib.tests.test__chk_map',
3671
'bzrlib.tests.test__dirstate_helpers',
3672
'bzrlib.tests.test__groupcompress',
3673
'bzrlib.tests.test__known_graph',
3674
'bzrlib.tests.test__rio',
3675
'bzrlib.tests.test__simple_set',
3676
'bzrlib.tests.test__static_tuple',
3677
'bzrlib.tests.test__walkdirs_win32',
3678
'bzrlib.tests.test_ancestry',
3679
'bzrlib.tests.test_annotate',
3680
'bzrlib.tests.test_api',
3681
'bzrlib.tests.test_atomicfile',
3682
'bzrlib.tests.test_bad_files',
3683
'bzrlib.tests.test_bisect_multi',
3684
'bzrlib.tests.test_branch',
3685
'bzrlib.tests.test_branchbuilder',
3686
'bzrlib.tests.test_btree_index',
3687
'bzrlib.tests.test_bugtracker',
3688
'bzrlib.tests.test_bundle',
3689
'bzrlib.tests.test_bzrdir',
3690
'bzrlib.tests.test__chunks_to_lines',
3691
'bzrlib.tests.test_cache_utf8',
3692
'bzrlib.tests.test_chk_map',
3693
'bzrlib.tests.test_chk_serializer',
3694
'bzrlib.tests.test_chunk_writer',
3695
'bzrlib.tests.test_clean_tree',
3696
'bzrlib.tests.test_cleanup',
3697
'bzrlib.tests.test_cmdline',
3698
'bzrlib.tests.test_commands',
3699
'bzrlib.tests.test_commit',
3700
'bzrlib.tests.test_commit_merge',
3701
'bzrlib.tests.test_config',
3702
'bzrlib.tests.test_conflicts',
3703
'bzrlib.tests.test_counted_lock',
3704
'bzrlib.tests.test_crash',
3705
'bzrlib.tests.test_decorators',
3706
'bzrlib.tests.test_delta',
3707
'bzrlib.tests.test_debug',
3708
'bzrlib.tests.test_deprecated_graph',
3709
'bzrlib.tests.test_diff',
3710
'bzrlib.tests.test_directory_service',
3711
'bzrlib.tests.test_dirstate',
3712
'bzrlib.tests.test_email_message',
3713
'bzrlib.tests.test_eol_filters',
3714
'bzrlib.tests.test_errors',
3715
'bzrlib.tests.test_export',
3716
'bzrlib.tests.test_extract',
3717
'bzrlib.tests.test_fetch',
3718
'bzrlib.tests.test_fixtures',
3719
'bzrlib.tests.test_fifo_cache',
3720
'bzrlib.tests.test_filters',
3721
'bzrlib.tests.test_ftp_transport',
3722
'bzrlib.tests.test_foreign',
3723
'bzrlib.tests.test_generate_docs',
3724
'bzrlib.tests.test_generate_ids',
3725
'bzrlib.tests.test_globbing',
3726
'bzrlib.tests.test_gpg',
3727
'bzrlib.tests.test_graph',
3728
'bzrlib.tests.test_groupcompress',
3729
'bzrlib.tests.test_hashcache',
3730
'bzrlib.tests.test_help',
3731
'bzrlib.tests.test_hooks',
3732
'bzrlib.tests.test_http',
3733
'bzrlib.tests.test_http_response',
3734
'bzrlib.tests.test_https_ca_bundle',
3735
'bzrlib.tests.test_identitymap',
3736
'bzrlib.tests.test_ignores',
3737
'bzrlib.tests.test_index',
3738
'bzrlib.tests.test_import_tariff',
3739
'bzrlib.tests.test_info',
3740
'bzrlib.tests.test_inv',
3741
'bzrlib.tests.test_inventory_delta',
3742
'bzrlib.tests.test_knit',
3743
'bzrlib.tests.test_lazy_import',
3744
'bzrlib.tests.test_lazy_regex',
3745
'bzrlib.tests.test_library_state',
3746
'bzrlib.tests.test_lock',
3747
'bzrlib.tests.test_lockable_files',
3748
'bzrlib.tests.test_lockdir',
3749
'bzrlib.tests.test_log',
3750
'bzrlib.tests.test_lru_cache',
3751
'bzrlib.tests.test_lsprof',
3752
'bzrlib.tests.test_mail_client',
3753
'bzrlib.tests.test_matchers',
3754
'bzrlib.tests.test_memorytree',
3755
'bzrlib.tests.test_merge',
3756
'bzrlib.tests.test_merge3',
3757
'bzrlib.tests.test_merge_core',
3758
'bzrlib.tests.test_merge_directive',
3759
'bzrlib.tests.test_missing',
3760
'bzrlib.tests.test_msgeditor',
3761
'bzrlib.tests.test_multiparent',
3762
'bzrlib.tests.test_mutabletree',
3763
'bzrlib.tests.test_nonascii',
3764
'bzrlib.tests.test_options',
3765
'bzrlib.tests.test_osutils',
3766
'bzrlib.tests.test_osutils_encodings',
3767
'bzrlib.tests.test_pack',
3768
'bzrlib.tests.test_patch',
3769
'bzrlib.tests.test_patches',
3770
'bzrlib.tests.test_permissions',
3771
'bzrlib.tests.test_plugins',
3772
'bzrlib.tests.test_progress',
3773
'bzrlib.tests.test_read_bundle',
3774
'bzrlib.tests.test_reconcile',
3775
'bzrlib.tests.test_reconfigure',
3776
'bzrlib.tests.test_registry',
3777
'bzrlib.tests.test_remote',
3778
'bzrlib.tests.test_rename_map',
3779
'bzrlib.tests.test_repository',
3780
'bzrlib.tests.test_revert',
3781
'bzrlib.tests.test_revision',
3782
'bzrlib.tests.test_revisionspec',
3783
'bzrlib.tests.test_revisiontree',
3784
'bzrlib.tests.test_rio',
3785
'bzrlib.tests.test_rules',
3786
'bzrlib.tests.test_sampler',
3787
'bzrlib.tests.test_script',
3788
'bzrlib.tests.test_selftest',
3789
'bzrlib.tests.test_serializer',
3790
'bzrlib.tests.test_setup',
3791
'bzrlib.tests.test_sftp_transport',
3792
'bzrlib.tests.test_shelf',
3793
'bzrlib.tests.test_shelf_ui',
3794
'bzrlib.tests.test_smart',
3795
'bzrlib.tests.test_smart_add',
3796
'bzrlib.tests.test_smart_request',
3797
'bzrlib.tests.test_smart_transport',
3798
'bzrlib.tests.test_smtp_connection',
3799
'bzrlib.tests.test_source',
3800
'bzrlib.tests.test_ssh_transport',
3801
'bzrlib.tests.test_status',
3802
'bzrlib.tests.test_store',
3803
'bzrlib.tests.test_strace',
3804
'bzrlib.tests.test_subsume',
3805
'bzrlib.tests.test_switch',
3806
'bzrlib.tests.test_symbol_versioning',
3807
'bzrlib.tests.test_tag',
3808
'bzrlib.tests.test_testament',
3809
'bzrlib.tests.test_textfile',
3810
'bzrlib.tests.test_textmerge',
3811
'bzrlib.tests.test_timestamp',
3812
'bzrlib.tests.test_trace',
3813
'bzrlib.tests.test_transactions',
3814
'bzrlib.tests.test_transform',
3815
'bzrlib.tests.test_transport',
3816
'bzrlib.tests.test_transport_log',
3817
'bzrlib.tests.test_tree',
3818
'bzrlib.tests.test_treebuilder',
3819
'bzrlib.tests.test_treeshape',
3820
'bzrlib.tests.test_tsort',
3821
'bzrlib.tests.test_tuned_gzip',
3822
'bzrlib.tests.test_ui',
3823
'bzrlib.tests.test_uncommit',
3824
'bzrlib.tests.test_upgrade',
3825
'bzrlib.tests.test_upgrade_stacked',
3826
'bzrlib.tests.test_urlutils',
3827
'bzrlib.tests.test_version',
3828
'bzrlib.tests.test_version_info',
3829
'bzrlib.tests.test_weave',
3830
'bzrlib.tests.test_whitebox',
3831
'bzrlib.tests.test_win32utils',
3832
'bzrlib.tests.test_workingtree',
3833
'bzrlib.tests.test_workingtree_4',
3834
'bzrlib.tests.test_wsgi',
3835
'bzrlib.tests.test_xml',
3839
def _test_suite_modules_to_doctest():
3840
"""Return the list of modules to doctest."""
3842
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3846
'bzrlib.branchbuilder',
3847
'bzrlib.decorators',
3850
'bzrlib.iterablefile',
3854
'bzrlib.symbol_versioning',
3856
'bzrlib.tests.fixtures',
3858
'bzrlib.version_info_formats.format_custom',
3862
def test_suite(keep_only=None, starting_with=None):
3863
"""Build and return TestSuite for the whole of bzrlib.
3865
:param keep_only: A list of test ids limiting the suite returned.
3867
:param starting_with: An id limiting the suite returned to the tests
3870
This function can be replaced if you need to change the default test
3871
suite on a global basis, but it is not encouraged.
3874
loader = TestUtil.TestLoader()
3876
if keep_only is not None:
3877
id_filter = TestIdList(keep_only)
3879
# We take precedence over keep_only because *at loading time* using
3880
# both options means we will load less tests for the same final result.
3881
def interesting_module(name):
3882
for start in starting_with:
3884
# Either the module name starts with the specified string
3885
name.startswith(start)
3886
# or it may contain tests starting with the specified string
3887
or start.startswith(name)
3891
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3893
elif keep_only is not None:
3894
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3895
def interesting_module(name):
3896
return id_filter.refers_to(name)
3899
loader = TestUtil.TestLoader()
3900
def interesting_module(name):
3901
# No filtering, all modules are interesting
3904
suite = loader.suiteClass()
3906
# modules building their suite with loadTestsFromModuleNames
3907
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3909
for mod in _test_suite_modules_to_doctest():
3910
if not interesting_module(mod):
3911
# No tests to keep here, move along
3914
# note that this really does mean "report only" -- doctest
3915
# still runs the rest of the examples
3916
doc_suite = doctest.DocTestSuite(mod,
3917
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3918
except ValueError, e:
3919
print '**failed to get doctest for: %s\n%s' % (mod, e)
3921
if len(doc_suite._tests) == 0:
3922
raise errors.BzrError("no doctests found in %s" % (mod,))
3923
suite.addTest(doc_suite)
3925
default_encoding = sys.getdefaultencoding()
3926
for name, plugin in bzrlib.plugin.plugins().items():
3927
if not interesting_module(plugin.module.__name__):
3929
plugin_suite = plugin.test_suite()
3930
# We used to catch ImportError here and turn it into just a warning,
3931
# but really if you don't have --no-plugins this should be a failure.
3932
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3933
if plugin_suite is None:
3934
plugin_suite = plugin.load_plugin_tests(loader)
3935
if plugin_suite is not None:
3936
suite.addTest(plugin_suite)
3937
if default_encoding != sys.getdefaultencoding():
3938
bzrlib.trace.warning(
3939
'Plugin "%s" tried to reset default encoding to: %s', name,
3940
sys.getdefaultencoding())
3942
sys.setdefaultencoding(default_encoding)
3944
if keep_only is not None:
3945
# Now that the referred modules have loaded their tests, keep only the
3947
suite = filter_suite_by_id_list(suite, id_filter)
3948
# Do some sanity checks on the id_list filtering
3949
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3951
# The tester has used both keep_only and starting_with, so he is
3952
# already aware that some tests are excluded from the list, there
3953
# is no need to tell him which.
3956
# Some tests mentioned in the list are not in the test suite. The
3957
# list may be out of date, report to the tester.
3958
for id in not_found:
3959
bzrlib.trace.warning('"%s" not found in the test suite', id)
3960
for id in duplicates:
3961
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3966
def multiply_scenarios(scenarios_left, scenarios_right):
3967
"""Multiply two sets of scenarios.
3969
:returns: the cartesian product of the two sets of scenarios, that is
3970
a scenario for every possible combination of a left scenario and a
3974
('%s,%s' % (left_name, right_name),
3975
dict(left_dict.items() + right_dict.items()))
3976
for left_name, left_dict in scenarios_left
3977
for right_name, right_dict in scenarios_right]
3980
def multiply_tests(tests, scenarios, result):
3981
"""Multiply tests_list by scenarios into result.
3983
This is the core workhorse for test parameterisation.
3985
Typically the load_tests() method for a per-implementation test suite will
3986
call multiply_tests and return the result.
3988
:param tests: The tests to parameterise.
3989
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3990
scenario_param_dict).
3991
:param result: A TestSuite to add created tests to.
3993
This returns the passed in result TestSuite with the cross product of all
3994
the tests repeated once for each scenario. Each test is adapted by adding
3995
the scenario name at the end of its id(), and updating the test object's
3996
__dict__ with the scenario_param_dict.
3998
>>> import bzrlib.tests.test_sampler
3999
>>> r = multiply_tests(
4000
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4001
... [('one', dict(param=1)),
4002
... ('two', dict(param=2))],
4004
>>> tests = list(iter_suite_tests(r))
4008
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4014
for test in iter_suite_tests(tests):
4015
apply_scenarios(test, scenarios, result)
4019
def apply_scenarios(test, scenarios, result):
4020
"""Apply the scenarios in scenarios to test and add to result.
4022
:param test: The test to apply scenarios to.
4023
:param scenarios: An iterable of scenarios to apply to test.
4025
:seealso: apply_scenario
4027
for scenario in scenarios:
4028
result.addTest(apply_scenario(test, scenario))
4032
def apply_scenario(test, scenario):
4033
"""Copy test and apply scenario to it.
4035
:param test: A test to adapt.
4036
:param scenario: A tuple describing the scenarion.
4037
The first element of the tuple is the new test id.
4038
The second element is a dict containing attributes to set on the
4040
:return: The adapted test.
4042
new_id = "%s(%s)" % (test.id(), scenario[0])
4043
new_test = clone_test(test, new_id)
4044
for name, value in scenario[1].items():
4045
setattr(new_test, name, value)
4049
def clone_test(test, new_id):
4050
"""Clone a test giving it a new id.
4052
:param test: The test to clone.
4053
:param new_id: The id to assign to it.
4054
:return: The new test.
4056
new_test = copy.copy(test)
4057
new_test.id = lambda: new_id
4061
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4063
"""Helper for permutating tests against an extension module.
4065
This is meant to be used inside a modules 'load_tests()' function. It will
4066
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4067
against both implementations. Setting 'test.module' to the appropriate
4068
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4070
:param standard_tests: A test suite to permute
4071
:param loader: A TestLoader
4072
:param py_module_name: The python path to a python module that can always
4073
be loaded, and will be considered the 'python' implementation. (eg
4074
'bzrlib._chk_map_py')
4075
:param ext_module_name: The python path to an extension module. If the
4076
module cannot be loaded, a single test will be added, which notes that
4077
the module is not available. If it can be loaded, all standard_tests
4078
will be run against that module.
4079
:return: (suite, feature) suite is a test-suite that has all the permuted
4080
tests. feature is the Feature object that can be used to determine if
4081
the module is available.
4084
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4086
('python', {'module': py_module}),
4088
suite = loader.suiteClass()
4089
feature = ModuleAvailableFeature(ext_module_name)
4090
if feature.available():
4091
scenarios.append(('C', {'module': feature.module}))
4093
# the compiled module isn't available, so we add a failing test
4094
class FailWithoutFeature(TestCase):
4095
def test_fail(self):
4096
self.requireFeature(feature)
4097
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4098
result = multiply_tests(standard_tests, scenarios, suite)
4099
return result, feature
4102
def _rmtree_temp_dir(dirname, test_id=None):
4103
# If LANG=C we probably have created some bogus paths
4104
# which rmtree(unicode) will fail to delete
4105
# so make sure we are using rmtree(str) to delete everything
4106
# except on win32, where rmtree(str) will fail
4107
# since it doesn't have the property of byte-stream paths
4108
# (they are either ascii or mbcs)
4109
if sys.platform == 'win32':
4110
# make sure we are using the unicode win32 api
4111
dirname = unicode(dirname)
4113
dirname = dirname.encode(sys.getfilesystemencoding())
4115
osutils.rmtree(dirname)
4117
# We don't want to fail here because some useful display will be lost
4118
# otherwise. Polluting the tmp dir is bad, but not giving all the
4119
# possible info to the test runner is even worse.
4121
ui.ui_factory.clear_term()
4122
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4123
# Ugly, but the last thing we want here is fail, so bear with it.
4124
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4125
).encode('ascii', 'replace')
4126
sys.stderr.write('Unable to remove testing dir %s\n%s'
4127
% (os.path.basename(dirname), printable_e))
4130
class Feature(object):
4131
"""An operating system Feature."""
4134
self._available = None
4136
def available(self):
4137
"""Is the feature available?
4139
:return: True if the feature is available.
4141
if self._available is None:
4142
self._available = self._probe()
4143
return self._available
4146
"""Implement this method in concrete features.
4148
:return: True if the feature is available.
4150
raise NotImplementedError
4153
if getattr(self, 'feature_name', None):
4154
return self.feature_name()
4155
return self.__class__.__name__
4158
class _SymlinkFeature(Feature):
4161
return osutils.has_symlinks()
4163
def feature_name(self):
4166
SymlinkFeature = _SymlinkFeature()
4169
class _HardlinkFeature(Feature):
4172
return osutils.has_hardlinks()
4174
def feature_name(self):
4177
HardlinkFeature = _HardlinkFeature()
4180
class _OsFifoFeature(Feature):
4183
return getattr(os, 'mkfifo', None)
4185
def feature_name(self):
4186
return 'filesystem fifos'
4188
OsFifoFeature = _OsFifoFeature()
4191
class _UnicodeFilenameFeature(Feature):
4192
"""Does the filesystem support Unicode filenames?"""
4196
# Check for character combinations unlikely to be covered by any
4197
# single non-unicode encoding. We use the characters
4198
# - greek small letter alpha (U+03B1) and
4199
# - braille pattern dots-123456 (U+283F).
4200
os.stat(u'\u03b1\u283f')
4201
except UnicodeEncodeError:
4203
except (IOError, OSError):
4204
# The filesystem allows the Unicode filename but the file doesn't
4208
# The filesystem allows the Unicode filename and the file exists,
4212
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4215
class _CompatabilityThunkFeature(Feature):
4216
"""This feature is just a thunk to another feature.
4218
It issues a deprecation warning if it is accessed, to let you know that you
4219
should really use a different feature.
4222
def __init__(self, dep_version, module, name,
4223
replacement_name, replacement_module=None):
4224
super(_CompatabilityThunkFeature, self).__init__()
4225
self._module = module
4226
if replacement_module is None:
4227
replacement_module = module
4228
self._replacement_module = replacement_module
4230
self._replacement_name = replacement_name
4231
self._dep_version = dep_version
4232
self._feature = None
4235
if self._feature is None:
4236
depr_msg = self._dep_version % ('%s.%s'
4237
% (self._module, self._name))
4238
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4239
self._replacement_name)
4240
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4241
# Import the new feature and use it as a replacement for the
4243
mod = __import__(self._replacement_module, {}, {},
4244
[self._replacement_name])
4245
self._feature = getattr(mod, self._replacement_name)
4249
return self._feature._probe()
4252
class ModuleAvailableFeature(Feature):
4253
"""This is a feature than describes a module we want to be available.
4255
Declare the name of the module in __init__(), and then after probing, the
4256
module will be available as 'self.module'.
4258
:ivar module: The module if it is available, else None.
4261
def __init__(self, module_name):
4262
super(ModuleAvailableFeature, self).__init__()
4263
self.module_name = module_name
4267
self._module = __import__(self.module_name, {}, {}, [''])
4274
if self.available(): # Make sure the probe has been done
4278
def feature_name(self):
4279
return self.module_name
4282
# This is kept here for compatibility, it is recommended to use
4283
# 'bzrlib.tests.feature.paramiko' instead
4284
ParamikoFeature = _CompatabilityThunkFeature(
4285
deprecated_in((2,1,0)),
4286
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4289
def probe_unicode_in_user_encoding():
4290
"""Try to encode several unicode strings to use in unicode-aware tests.
4291
Return first successfull match.
4293
:return: (unicode value, encoded plain string value) or (None, None)
4295
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4296
for uni_val in possible_vals:
4298
str_val = uni_val.encode(osutils.get_user_encoding())
4299
except UnicodeEncodeError:
4300
# Try a different character
4303
return uni_val, str_val
4307
def probe_bad_non_ascii(encoding):
4308
"""Try to find [bad] character with code [128..255]
4309
that cannot be decoded to unicode in some encoding.
4310
Return None if all non-ascii characters is valid
4313
for i in xrange(128, 256):
4316
char.decode(encoding)
4317
except UnicodeDecodeError:
4322
class _HTTPSServerFeature(Feature):
4323
"""Some tests want an https Server, check if one is available.
4325
Right now, the only way this is available is under python2.6 which provides
4336
def feature_name(self):
4337
return 'HTTPSServer'
4340
HTTPSServerFeature = _HTTPSServerFeature()
4343
class _UnicodeFilename(Feature):
4344
"""Does the filesystem support Unicode filenames?"""
4349
except UnicodeEncodeError:
4351
except (IOError, OSError):
4352
# The filesystem allows the Unicode filename but the file doesn't
4356
# The filesystem allows the Unicode filename and the file exists,
4360
UnicodeFilename = _UnicodeFilename()
4363
class _ByteStringNamedFilesystem(Feature):
4364
"""Is the filesystem based on bytes?"""
4367
if os.name == "posix":
4371
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
4374
class _UTF8Filesystem(Feature):
4375
"""Is the filesystem UTF-8?"""
4378
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4382
UTF8Filesystem = _UTF8Filesystem()
4385
class _BreakinFeature(Feature):
4386
"""Does this platform support the breakin feature?"""
4389
from bzrlib import breakin
4390
if breakin.determine_signal() is None:
4392
if sys.platform == 'win32':
4393
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4394
# We trigger SIGBREAK via a Console api so we need ctypes to
4395
# access the function
4402
def feature_name(self):
4403
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4406
BreakinFeature = _BreakinFeature()
4409
class _CaseInsCasePresFilenameFeature(Feature):
4410
"""Is the file-system case insensitive, but case-preserving?"""
4413
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4415
# first check truly case-preserving for created files, then check
4416
# case insensitive when opening existing files.
4417
name = osutils.normpath(name)
4418
base, rel = osutils.split(name)
4419
found_rel = osutils.canonical_relpath(base, name)
4420
return (found_rel == rel
4421
and os.path.isfile(name.upper())
4422
and os.path.isfile(name.lower()))
4427
def feature_name(self):
4428
return "case-insensitive case-preserving filesystem"
4430
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4433
class _CaseInsensitiveFilesystemFeature(Feature):
4434
"""Check if underlying filesystem is case-insensitive but *not* case
4437
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4438
# more likely to be case preserving, so this case is rare.
4441
if CaseInsCasePresFilenameFeature.available():
4444
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4445
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4446
TestCaseWithMemoryTransport.TEST_ROOT = root
4448
root = TestCaseWithMemoryTransport.TEST_ROOT
4449
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4451
name_a = osutils.pathjoin(tdir, 'a')
4452
name_A = osutils.pathjoin(tdir, 'A')
4454
result = osutils.isdir(name_A)
4455
_rmtree_temp_dir(tdir)
4458
def feature_name(self):
4459
return 'case-insensitive filesystem'
4461
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4464
class _CaseSensitiveFilesystemFeature(Feature):
4467
if CaseInsCasePresFilenameFeature.available():
4469
elif CaseInsensitiveFilesystemFeature.available():
4474
def feature_name(self):
4475
return 'case-sensitive filesystem'
4477
# new coding style is for feature instances to be lowercase
4478
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4481
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4482
SubUnitFeature = _CompatabilityThunkFeature(
4483
deprecated_in((2,1,0)),
4484
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4485
# Only define SubUnitBzrRunner if subunit is available.
4487
from subunit import TestProtocolClient
4488
from subunit.test_results import AutoTimingTestResultDecorator
4489
class SubUnitBzrRunner(TextTestRunner):
4490
def run(self, test):
4491
result = AutoTimingTestResultDecorator(
4492
TestProtocolClient(self.stream))
4498
class _PosixPermissionsFeature(Feature):
4502
# create temporary file and check if specified perms are maintained.
4505
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4506
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4509
os.chmod(name, write_perms)
4511
read_perms = os.stat(name).st_mode & 0777
4513
return (write_perms == read_perms)
4515
return (os.name == 'posix') and has_perms()
4517
def feature_name(self):
4518
return 'POSIX permissions support'
4520
posix_permissions_feature = _PosixPermissionsFeature()
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from unittest import TestLoader
22
from doctest import DocTestSuite
24
tr = unittest.TextTestRunner(verbosity=2)
25
suite = unittest.TestSuite()
26
import bzrlib.whitebox
28
suite.addTest(TestLoader().loadTestsFromModule(bzrlib.whitebox))
30
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
31
bzrlib.tree, bzrlib.commands, bzrlib.add:
32
suite.addTest(DocTestSuite(m))
34
result = tr.run(suite)
35
return result.wasSuccessful()
added
removed
bzrlib/selftest.py
