1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Testing framework extensions"""
19
# TODO: Perhaps there should be an API to find out if bzr running under the
20
# test suite -- some plugins might want to avoid making intrusive changes if
21
# this is the case. However, we want behaviour under to test to diverge as
22
# little as possible, so this should be used rarely if it's added at all.
23
# (Suggestion from j-a-meinel, 2005-11-24)
25
# NOTE: Some classes in here use camelCaseNaming() rather than
26
# underscore_naming(). That's for consistency with unittest; it's not the
27
# general style of bzrlib. Please continue that consistency when adding e.g.
28
# new assertFoo() methods.
33
from cStringIO import StringIO
56
# nb: check this before importing anything else from within it
57
_testtools_version = getattr(testtools, '__version__', ())
58
if _testtools_version < (0, 9, 5):
59
raise ImportError("need at least testtools 0.9.5: %s is %r"
60
% (testtools.__file__, _testtools_version))
61
from testtools import content
68
commands as _mod_commands,
77
plugin as _mod_plugin,
84
transport as _mod_transport,
90
# lsprof not available
92
from bzrlib.smart import client, request
93
from bzrlib.transport import (
97
from bzrlib.tests import (
102
from bzrlib.ui import NullProgressView
103
from bzrlib.ui.text import TextUIFactory
105
# Mark this python module as being part of the implementation
106
# of unittest: this gives us better tracebacks where the last
107
# shown frame is the test code, not our assertXYZ.
110
default_transport = test_server.LocalURLServer
113
_unitialized_attr = object()
114
"""A sentinel needed to act as a default value in a method signature."""
117
# Subunit result codes, defined here to prevent a hard dependency on subunit.
121
# These are intentionally brought into this namespace. That way plugins, etc
122
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
123
TestSuite = TestUtil.TestSuite
124
TestLoader = TestUtil.TestLoader
126
# Tests should run in a clean and clearly defined environment. The goal is to
127
# keep them isolated from the running environment as mush as possible. The test
128
# framework ensures the variables defined below are set (or deleted if the
129
# value is None) before a test is run and reset to their original value after
130
# the test is run. Generally if some code depends on an environment variable,
131
# the tests should start without this variable in the environment. There are a
132
# few exceptions but you shouldn't violate this rule lightly.
136
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
137
# tests do check our impls match APPDATA
138
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
142
'BZREMAIL': None, # may still be present in the environment
143
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
144
'BZR_PROGRESS_BAR': None,
146
'BZR_PLUGIN_PATH': None,
147
'BZR_DISABLE_PLUGINS': None,
148
'BZR_PLUGINS_AT': None,
149
'BZR_CONCURRENCY': None,
150
# Make sure that any text ui tests are consistent regardless of
151
# the environment the test case is run in; you may want tests that
152
# test other combinations. 'dumb' is a reasonable guess for tests
153
# going to a pipe or a StringIO.
159
'SSH_AUTH_SOCK': None,
169
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
170
# least. If you do (care), please update this comment
174
'BZR_REMOTE_PATH': None,
175
# Generally speaking, we don't want apport reporting on crashes in
176
# the test envirnoment unless we're specifically testing apport,
177
# so that it doesn't leak into the real system environment. We
178
# use an env var so it propagates to subprocesses.
179
'APPORT_DISABLE': '1',
183
def override_os_environ(test, env=None):
184
"""Modify os.environ keeping a copy.
186
:param test: A test instance
188
:param env: A dict containing variable definitions to be installed
191
env = isolated_environ
192
test._original_os_environ = dict([(var, value)
193
for var, value in os.environ.iteritems()])
194
for var, value in env.iteritems():
195
osutils.set_or_unset_env(var, value)
196
if var not in test._original_os_environ:
197
# The var is new, add it with a value of None, so
198
# restore_os_environ will delete it
199
test._original_os_environ[var] = None
202
def restore_os_environ(test):
203
"""Restore os.environ to its original state.
205
:param test: A test instance previously passed to override_os_environ.
207
for var, value in test._original_os_environ.iteritems():
208
# Restore the original value (or delete it if the value has been set to
209
# None in override_os_environ).
210
osutils.set_or_unset_env(var, value)
213
class ExtendedTestResult(testtools.TextTestResult):
214
"""Accepts, reports and accumulates the results of running tests.
216
Compared to the unittest version this class adds support for
217
profiling, benchmarking, stopping as soon as a test fails, and
218
skipping tests. There are further-specialized subclasses for
219
different types of display.
221
When a test finishes, in whatever way, it calls one of the addSuccess,
222
addFailure or addError classes. These in turn may redirect to a more
223
specific case for the special test results supported by our extended
226
Note that just one of these objects is fed the results from many tests.
231
def __init__(self, stream, descriptions, verbosity,
235
"""Construct new TestResult.
237
:param bench_history: Optionally, a writable file object to accumulate
240
testtools.TextTestResult.__init__(self, stream)
241
if bench_history is not None:
242
from bzrlib.version import _get_bzr_source_tree
243
src_tree = _get_bzr_source_tree()
246
revision_id = src_tree.get_parent_ids()[0]
248
# XXX: if this is a brand new tree, do the same as if there
252
# XXX: If there's no branch, what should we do?
254
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
255
self._bench_history = bench_history
256
self.ui = ui.ui_factory
259
self.failure_count = 0
260
self.known_failure_count = 0
262
self.not_applicable_count = 0
263
self.unsupported = {}
265
self._overall_start_time = time.time()
266
self._strict = strict
267
self._first_thread_leaker_id = None
268
self._tests_leaking_threads_count = 0
269
self._traceback_from_test = None
271
def stopTestRun(self):
274
stopTime = time.time()
275
timeTaken = stopTime - self.startTime
276
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
277
# the parent class method is similar have to duplicate
278
self._show_list('ERROR', self.errors)
279
self._show_list('FAIL', self.failures)
280
self.stream.write(self.sep2)
281
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
282
run, run != 1 and "s" or "", timeTaken))
283
if not self.wasSuccessful():
284
self.stream.write("FAILED (")
285
failed, errored = map(len, (self.failures, self.errors))
287
self.stream.write("failures=%d" % failed)
289
if failed: self.stream.write(", ")
290
self.stream.write("errors=%d" % errored)
291
if self.known_failure_count:
292
if failed or errored: self.stream.write(", ")
293
self.stream.write("known_failure_count=%d" %
294
self.known_failure_count)
295
self.stream.write(")\n")
297
if self.known_failure_count:
298
self.stream.write("OK (known_failures=%d)\n" %
299
self.known_failure_count)
301
self.stream.write("OK\n")
302
if self.skip_count > 0:
303
skipped = self.skip_count
304
self.stream.write('%d test%s skipped\n' %
305
(skipped, skipped != 1 and "s" or ""))
307
for feature, count in sorted(self.unsupported.items()):
308
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
311
ok = self.wasStrictlySuccessful()
313
ok = self.wasSuccessful()
314
if self._first_thread_leaker_id:
316
'%s is leaking threads among %d leaking tests.\n' % (
317
self._first_thread_leaker_id,
318
self._tests_leaking_threads_count))
319
# We don't report the main thread as an active one.
321
'%d non-main threads were left active in the end.\n'
322
% (len(self._active_threads) - 1))
324
def getDescription(self, test):
327
def _extractBenchmarkTime(self, testCase, details=None):
328
"""Add a benchmark time for the current test case."""
329
if details and 'benchtime' in details:
330
return float(''.join(details['benchtime'].iter_bytes()))
331
return getattr(testCase, "_benchtime", None)
333
def _elapsedTestTimeString(self):
334
"""Return a time string for the overall time the current test has taken."""
335
return self._formatTime(self._delta_to_float(
336
self._now() - self._start_datetime))
338
def _testTimeString(self, testCase):
339
benchmark_time = self._extractBenchmarkTime(testCase)
340
if benchmark_time is not None:
341
return self._formatTime(benchmark_time) + "*"
343
return self._elapsedTestTimeString()
345
def _formatTime(self, seconds):
346
"""Format seconds as milliseconds with leading spaces."""
347
# some benchmarks can take thousands of seconds to run, so we need 8
349
return "%8dms" % (1000 * seconds)
351
def _shortened_test_description(self, test):
353
what = re.sub(r'^bzrlib\.tests\.', '', what)
356
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
357
# multiple times in a row, because the handler is added for
358
# each test but the container list is shared between cases.
359
# See lp:498869 lp:625574 and lp:637725 for background.
360
def _record_traceback_from_test(self, exc_info):
361
"""Store the traceback from passed exc_info tuple till"""
362
self._traceback_from_test = exc_info[2]
364
def startTest(self, test):
365
super(ExtendedTestResult, self).startTest(test)
369
self.report_test_start(test)
370
test.number = self.count
371
self._recordTestStartTime()
372
# Make testtools cases give us the real traceback on failure
373
addOnException = getattr(test, "addOnException", None)
374
if addOnException is not None:
375
addOnException(self._record_traceback_from_test)
376
# Only check for thread leaks on bzrlib derived test cases
377
if isinstance(test, TestCase):
378
test.addCleanup(self._check_leaked_threads, test)
380
def startTests(self):
381
self.report_tests_starting()
382
self._active_threads = threading.enumerate()
384
def stopTest(self, test):
385
self._traceback_from_test = None
387
def _check_leaked_threads(self, test):
388
"""See if any threads have leaked since last call
390
A sample of live threads is stored in the _active_threads attribute,
391
when this method runs it compares the current live threads and any not
392
in the previous sample are treated as having leaked.
394
now_active_threads = set(threading.enumerate())
395
threads_leaked = now_active_threads.difference(self._active_threads)
397
self._report_thread_leak(test, threads_leaked, now_active_threads)
398
self._tests_leaking_threads_count += 1
399
if self._first_thread_leaker_id is None:
400
self._first_thread_leaker_id = test.id()
401
self._active_threads = now_active_threads
403
def _recordTestStartTime(self):
404
"""Record that a test has started."""
405
self._start_datetime = self._now()
407
def addError(self, test, err):
408
"""Tell result that test finished with an error.
410
Called from the TestCase run() method when the test
411
fails with an unexpected error.
413
self._post_mortem(self._traceback_from_test)
414
super(ExtendedTestResult, self).addError(test, err)
415
self.error_count += 1
416
self.report_error(test, err)
420
def addFailure(self, test, err):
421
"""Tell result that test failed.
423
Called from the TestCase run() method when the test
424
fails because e.g. an assert() method failed.
426
self._post_mortem(self._traceback_from_test)
427
super(ExtendedTestResult, self).addFailure(test, err)
428
self.failure_count += 1
429
self.report_failure(test, err)
433
def addSuccess(self, test, details=None):
434
"""Tell result that test completed successfully.
436
Called from the TestCase run()
438
if self._bench_history is not None:
439
benchmark_time = self._extractBenchmarkTime(test, details)
440
if benchmark_time is not None:
441
self._bench_history.write("%s %s\n" % (
442
self._formatTime(benchmark_time),
444
self.report_success(test)
445
super(ExtendedTestResult, self).addSuccess(test)
446
test._log_contents = ''
448
def addExpectedFailure(self, test, err):
449
self.known_failure_count += 1
450
self.report_known_failure(test, err)
452
def addNotSupported(self, test, feature):
453
"""The test will not be run because of a missing feature.
455
# this can be called in two different ways: it may be that the
456
# test started running, and then raised (through requireFeature)
457
# UnavailableFeature. Alternatively this method can be called
458
# while probing for features before running the test code proper; in
459
# that case we will see startTest and stopTest, but the test will
460
# never actually run.
461
self.unsupported.setdefault(str(feature), 0)
462
self.unsupported[str(feature)] += 1
463
self.report_unsupported(test, feature)
465
def addSkip(self, test, reason):
466
"""A test has not run for 'reason'."""
468
self.report_skip(test, reason)
470
def addNotApplicable(self, test, reason):
471
self.not_applicable_count += 1
472
self.report_not_applicable(test, reason)
474
def _post_mortem(self, tb=None):
475
"""Start a PDB post mortem session."""
476
if os.environ.get('BZR_TEST_PDB', None):
480
def progress(self, offset, whence):
481
"""The test is adjusting the count of tests to run."""
482
if whence == SUBUNIT_SEEK_SET:
483
self.num_tests = offset
484
elif whence == SUBUNIT_SEEK_CUR:
485
self.num_tests += offset
487
raise errors.BzrError("Unknown whence %r" % whence)
489
def report_tests_starting(self):
490
"""Display information before the test run begins"""
491
if getattr(sys, 'frozen', None) is None:
492
bzr_path = osutils.realpath(sys.argv[0])
494
bzr_path = sys.executable
496
'bzr selftest: %s\n' % (bzr_path,))
499
bzrlib.__path__[0],))
501
' bzr-%s python-%s %s\n' % (
502
bzrlib.version_string,
503
bzrlib._format_version_tuple(sys.version_info),
504
platform.platform(aliased=1),
506
self.stream.write('\n')
508
def report_test_start(self, test):
509
"""Display information on the test just about to be run"""
511
def _report_thread_leak(self, test, leaked_threads, active_threads):
512
"""Display information on a test that leaked one or more threads"""
513
# GZ 2010-09-09: A leak summary reported separately from the general
514
# thread debugging would be nice. Tests under subunit
515
# need something not using stream, perhaps adding a
516
# testtools details object would be fitting.
517
if 'threads' in selftest_debug_flags:
518
self.stream.write('%s is leaking, active is now %d\n' %
519
(test.id(), len(active_threads)))
521
def startTestRun(self):
522
self.startTime = time.time()
524
def report_success(self, test):
527
def wasStrictlySuccessful(self):
528
if self.unsupported or self.known_failure_count:
530
return self.wasSuccessful()
533
class TextTestResult(ExtendedTestResult):
534
"""Displays progress and results of tests in text form"""
536
def __init__(self, stream, descriptions, verbosity,
541
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
542
bench_history, strict)
543
# We no longer pass them around, but just rely on the UIFactory stack
546
warnings.warn("Passing pb to TextTestResult is deprecated")
547
self.pb = self.ui.nested_progress_bar()
548
self.pb.show_pct = False
549
self.pb.show_spinner = False
550
self.pb.show_eta = False,
551
self.pb.show_count = False
552
self.pb.show_bar = False
553
self.pb.update_latency = 0
554
self.pb.show_transport_activity = False
556
def stopTestRun(self):
557
# called when the tests that are going to run have run
560
super(TextTestResult, self).stopTestRun()
562
def report_tests_starting(self):
563
super(TextTestResult, self).report_tests_starting()
564
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
566
def _progress_prefix_text(self):
567
# the longer this text, the less space we have to show the test
569
a = '[%d' % self.count # total that have been run
570
# tests skipped as known not to be relevant are not important enough
572
## if self.skip_count:
573
## a += ', %d skip' % self.skip_count
574
## if self.known_failure_count:
575
## a += '+%dX' % self.known_failure_count
577
a +='/%d' % self.num_tests
579
runtime = time.time() - self._overall_start_time
581
a += '%dm%ds' % (runtime / 60, runtime % 60)
584
total_fail_count = self.error_count + self.failure_count
586
a += ', %d failed' % total_fail_count
587
# if self.unsupported:
588
# a += ', %d missing' % len(self.unsupported)
592
def report_test_start(self, test):
594
self._progress_prefix_text()
596
+ self._shortened_test_description(test))
598
def _test_description(self, test):
599
return self._shortened_test_description(test)
601
def report_error(self, test, err):
602
self.stream.write('ERROR: %s\n %s\n' % (
603
self._test_description(test),
607
def report_failure(self, test, err):
608
self.stream.write('FAIL: %s\n %s\n' % (
609
self._test_description(test),
613
def report_known_failure(self, test, err):
616
def report_skip(self, test, reason):
619
def report_not_applicable(self, test, reason):
622
def report_unsupported(self, test, feature):
623
"""test cannot be run because feature is missing."""
626
class VerboseTestResult(ExtendedTestResult):
627
"""Produce long output, with one line per test run plus times"""
629
def _ellipsize_to_right(self, a_string, final_width):
630
"""Truncate and pad a string, keeping the right hand side"""
631
if len(a_string) > final_width:
632
result = '...' + a_string[3-final_width:]
635
return result.ljust(final_width)
637
def report_tests_starting(self):
638
self.stream.write('running %d tests...\n' % self.num_tests)
639
super(VerboseTestResult, self).report_tests_starting()
641
def report_test_start(self, test):
642
name = self._shortened_test_description(test)
643
width = osutils.terminal_width()
644
if width is not None:
645
# width needs space for 6 char status, plus 1 for slash, plus an
646
# 11-char time string, plus a trailing blank
647
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
649
self.stream.write(self._ellipsize_to_right(name, width-18))
651
self.stream.write(name)
654
def _error_summary(self, err):
656
return '%s%s' % (indent, err[1])
658
def report_error(self, test, err):
659
self.stream.write('ERROR %s\n%s\n'
660
% (self._testTimeString(test),
661
self._error_summary(err)))
663
def report_failure(self, test, err):
664
self.stream.write(' FAIL %s\n%s\n'
665
% (self._testTimeString(test),
666
self._error_summary(err)))
668
def report_known_failure(self, test, err):
669
self.stream.write('XFAIL %s\n%s\n'
670
% (self._testTimeString(test),
671
self._error_summary(err)))
673
def report_success(self, test):
674
self.stream.write(' OK %s\n' % self._testTimeString(test))
675
for bench_called, stats in getattr(test, '_benchcalls', []):
676
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
677
stats.pprint(file=self.stream)
678
# flush the stream so that we get smooth output. This verbose mode is
679
# used to show the output in PQM.
682
def report_skip(self, test, reason):
683
self.stream.write(' SKIP %s\n%s\n'
684
% (self._testTimeString(test), reason))
686
def report_not_applicable(self, test, reason):
687
self.stream.write(' N/A %s\n %s\n'
688
% (self._testTimeString(test), reason))
690
def report_unsupported(self, test, feature):
691
"""test cannot be run because feature is missing."""
692
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
693
%(self._testTimeString(test), feature))
696
class TextTestRunner(object):
697
stop_on_failure = False
705
result_decorators=None,
707
"""Create a TextTestRunner.
709
:param result_decorators: An optional list of decorators to apply
710
to the result object being used by the runner. Decorators are
711
applied left to right - the first element in the list is the
714
# stream may know claim to know to write unicode strings, but in older
715
# pythons this goes sufficiently wrong that it is a bad idea. (
716
# specifically a built in file with encoding 'UTF-8' will still try
717
# to encode using ascii.
718
new_encoding = osutils.get_terminal_encoding()
719
codec = codecs.lookup(new_encoding)
720
if type(codec) is tuple:
724
encode = codec.encode
725
# GZ 2010-09-08: Really we don't want to be writing arbitrary bytes,
726
# so should swap to the plain codecs.StreamWriter
727
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream,
729
stream.encoding = new_encoding
731
self.descriptions = descriptions
732
self.verbosity = verbosity
733
self._bench_history = bench_history
734
self._strict = strict
735
self._result_decorators = result_decorators or []
738
"Run the given test case or test suite."
739
if self.verbosity == 1:
740
result_class = TextTestResult
741
elif self.verbosity >= 2:
742
result_class = VerboseTestResult
743
original_result = result_class(self.stream,
746
bench_history=self._bench_history,
749
# Signal to result objects that look at stop early policy to stop,
750
original_result.stop_early = self.stop_on_failure
751
result = original_result
752
for decorator in self._result_decorators:
753
result = decorator(result)
754
result.stop_early = self.stop_on_failure
755
result.startTestRun()
760
# higher level code uses our extended protocol to determine
761
# what exit code to give.
762
return original_result
765
def iter_suite_tests(suite):
766
"""Return all tests in a suite, recursing through nested suites"""
767
if isinstance(suite, unittest.TestCase):
769
elif isinstance(suite, unittest.TestSuite):
771
for r in iter_suite_tests(item):
774
raise Exception('unknown type %r for object %r'
775
% (type(suite), suite))
778
TestSkipped = testtools.testcase.TestSkipped
781
class TestNotApplicable(TestSkipped):
782
"""A test is not applicable to the situation where it was run.
784
This is only normally raised by parameterized tests, if they find that
785
the instance they're constructed upon does not support one aspect
790
# traceback._some_str fails to format exceptions that have the default
791
# __str__ which does an implicit ascii conversion. However, repr() on those
792
# objects works, for all that its not quite what the doctor may have ordered.
793
def _clever_some_str(value):
798
return repr(value).replace('\\n', '\n')
800
return '<unprintable %s object>' % type(value).__name__
802
traceback._some_str = _clever_some_str
805
# deprecated - use self.knownFailure(), or self.expectFailure.
806
KnownFailure = testtools.testcase._ExpectedFailure
809
class UnavailableFeature(Exception):
810
"""A feature required for this test was not available.
812
This can be considered a specialised form of SkippedTest.
814
The feature should be used to construct the exception.
818
class StringIOWrapper(object):
819
"""A wrapper around cStringIO which just adds an encoding attribute.
821
Internally we can check sys.stdout to see what the output encoding
822
should be. However, cStringIO has no encoding attribute that we can
823
set. So we wrap it instead.
828
def __init__(self, s=None):
830
self.__dict__['_cstring'] = StringIO(s)
832
self.__dict__['_cstring'] = StringIO()
834
def __getattr__(self, name, getattr=getattr):
835
return getattr(self.__dict__['_cstring'], name)
837
def __setattr__(self, name, val):
838
if name == 'encoding':
839
self.__dict__['encoding'] = val
841
return setattr(self._cstring, name, val)
844
class TestUIFactory(TextUIFactory):
845
"""A UI Factory for testing.
847
Hide the progress bar but emit note()s.
849
Allows get_password to be tested without real tty attached.
851
See also CannedInputUIFactory which lets you provide programmatic input in
854
# TODO: Capture progress events at the model level and allow them to be
855
# observed by tests that care.
857
# XXX: Should probably unify more with CannedInputUIFactory or a
858
# particular configuration of TextUIFactory, or otherwise have a clearer
859
# idea of how they're supposed to be different.
860
# See https://bugs.launchpad.net/bzr/+bug/408213
862
def __init__(self, stdout=None, stderr=None, stdin=None):
863
if stdin is not None:
864
# We use a StringIOWrapper to be able to test various
865
# encodings, but the user is still responsible to
866
# encode the string and to set the encoding attribute
867
# of StringIOWrapper.
868
stdin = StringIOWrapper(stdin)
869
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
871
def get_non_echoed_password(self):
872
"""Get password from stdin without trying to handle the echo mode"""
873
password = self.stdin.readline()
876
if password[-1] == '\n':
877
password = password[:-1]
880
def make_progress_view(self):
881
return NullProgressView()
884
def isolated_doctest_setUp(test):
885
override_os_environ(test)
888
def isolated_doctest_tearDown(test):
889
restore_os_environ(test)
892
def IsolatedDocTestSuite(*args, **kwargs):
893
"""Overrides doctest.DocTestSuite to handle isolation.
895
The method is really a factory and users are expected to use it as such.
898
kwargs['setUp'] = isolated_doctest_setUp
899
kwargs['tearDown'] = isolated_doctest_tearDown
900
return doctest.DocTestSuite(*args, **kwargs)
903
class TestCase(testtools.TestCase):
904
"""Base class for bzr unit tests.
906
Tests that need access to disk resources should subclass
907
TestCaseInTempDir not TestCase.
909
Error and debug log messages are redirected from their usual
910
location into a temporary file, the contents of which can be
911
retrieved by _get_log(). We use a real OS file, not an in-memory object,
912
so that it can also capture file IO. When the test completes this file
913
is read into memory and removed from disk.
915
There are also convenience functions to invoke bzr's command-line
916
routine, and to build and check bzr trees.
918
In addition to the usual method of overriding tearDown(), this class also
919
allows subclasses to register cleanup functions via addCleanup, which are
920
run in order as the object is torn down. It's less likely this will be
921
accidentally overlooked.
925
# record lsprof data when performing benchmark calls.
926
_gather_lsprof_in_benchmarks = False
928
def __init__(self, methodName='testMethod'):
929
super(TestCase, self).__init__(methodName)
930
self._directory_isolation = True
931
self.exception_handlers.insert(0,
932
(UnavailableFeature, self._do_unsupported_or_skip))
933
self.exception_handlers.insert(0,
934
(TestNotApplicable, self._do_not_applicable))
937
super(TestCase, self).setUp()
938
for feature in getattr(self, '_test_needs_features', []):
939
self.requireFeature(feature)
940
self._log_contents = None
941
self.addDetail("log", content.Content(content.ContentType("text",
942
"plain", {"charset": "utf8"}),
943
lambda:[self._get_log(keep_log_file=True)]))
944
self._cleanEnvironment()
947
self._benchcalls = []
948
self._benchtime = None
950
self._track_transports()
952
self._clear_debug_flags()
953
# Isolate global verbosity level, to make sure it's reproducible
954
# between tests. We should get rid of this altogether: bug 656694. --
956
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
957
# Isolate config option expansion until its default value for bzrlib is
958
# settled on or a the FIXME associated with _get_expand_default_value
959
# is addressed -- vila 20110219
960
self.overrideAttr(config, '_expand_default_value', None)
965
pdb.Pdb().set_trace(sys._getframe().f_back)
967
def discardDetail(self, name):
968
"""Extend the addDetail, getDetails api so we can remove a detail.
970
eg. bzr always adds the 'log' detail at startup, but we don't want to
971
include it for skipped, xfail, etc tests.
973
It is safe to call this for a detail that doesn't exist, in case this
974
gets called multiple times.
976
# We cheat. details is stored in __details which means we shouldn't
977
# touch it. but getDetails() returns the dict directly, so we can
979
details = self.getDetails()
983
def _clear_debug_flags(self):
984
"""Prevent externally set debug flags affecting tests.
986
Tests that want to use debug flags can just set them in the
987
debug_flags set during setup/teardown.
989
# Start with a copy of the current debug flags we can safely modify.
990
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
991
if 'allow_debug' not in selftest_debug_flags:
992
debug.debug_flags.clear()
993
if 'disable_lock_checks' not in selftest_debug_flags:
994
debug.debug_flags.add('strict_locks')
996
def _clear_hooks(self):
997
# prevent hooks affecting tests
998
known_hooks = hooks.known_hooks
999
self._preserved_hooks = {}
1000
for key, (parent, name) in known_hooks.iter_parent_objects():
1001
current_hooks = getattr(parent, name)
1002
self._preserved_hooks[parent] = (name, current_hooks)
1003
self._preserved_lazy_hooks = hooks._lazy_hooks
1004
hooks._lazy_hooks = {}
1005
self.addCleanup(self._restoreHooks)
1006
for key, (parent, name) in known_hooks.iter_parent_objects():
1007
factory = known_hooks.get(key)
1008
setattr(parent, name, factory())
1009
# this hook should always be installed
1010
request._install_hook()
1012
def disable_directory_isolation(self):
1013
"""Turn off directory isolation checks."""
1014
self._directory_isolation = False
1016
def enable_directory_isolation(self):
1017
"""Enable directory isolation checks."""
1018
self._directory_isolation = True
1020
def _silenceUI(self):
1021
"""Turn off UI for duration of test"""
1022
# by default the UI is off; tests can turn it on if they want it.
1023
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1025
def _check_locks(self):
1026
"""Check that all lock take/release actions have been paired."""
1027
# We always check for mismatched locks. If a mismatch is found, we
1028
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1029
# case we just print a warning.
1031
acquired_locks = [lock for action, lock in self._lock_actions
1032
if action == 'acquired']
1033
released_locks = [lock for action, lock in self._lock_actions
1034
if action == 'released']
1035
broken_locks = [lock for action, lock in self._lock_actions
1036
if action == 'broken']
1037
# trivially, given the tests for lock acquistion and release, if we
1038
# have as many in each list, it should be ok. Some lock tests also
1039
# break some locks on purpose and should be taken into account by
1040
# considering that breaking a lock is just a dirty way of releasing it.
1041
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1042
message = ('Different number of acquired and '
1043
'released or broken locks. (%s, %s + %s)' %
1044
(acquired_locks, released_locks, broken_locks))
1045
if not self._lock_check_thorough:
1046
# Rather than fail, just warn
1047
print "Broken test %s: %s" % (self, message)
1051
def _track_locks(self):
1052
"""Track lock activity during tests."""
1053
self._lock_actions = []
1054
if 'disable_lock_checks' in selftest_debug_flags:
1055
self._lock_check_thorough = False
1057
self._lock_check_thorough = True
1059
self.addCleanup(self._check_locks)
1060
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1061
self._lock_acquired, None)
1062
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1063
self._lock_released, None)
1064
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1065
self._lock_broken, None)
1067
def _lock_acquired(self, result):
1068
self._lock_actions.append(('acquired', result))
1070
def _lock_released(self, result):
1071
self._lock_actions.append(('released', result))
1073
def _lock_broken(self, result):
1074
self._lock_actions.append(('broken', result))
1076
def permit_dir(self, name):
1077
"""Permit a directory to be used by this test. See permit_url."""
1078
name_transport = _mod_transport.get_transport(name)
1079
self.permit_url(name)
1080
self.permit_url(name_transport.base)
1082
def permit_url(self, url):
1083
"""Declare that url is an ok url to use in this test.
1085
Do this for memory transports, temporary test directory etc.
1087
Do not do this for the current working directory, /tmp, or any other
1088
preexisting non isolated url.
1090
if not url.endswith('/'):
1092
self._bzr_selftest_roots.append(url)
1094
def permit_source_tree_branch_repo(self):
1095
"""Permit the source tree bzr is running from to be opened.
1097
Some code such as bzrlib.version attempts to read from the bzr branch
1098
that bzr is executing from (if any). This method permits that directory
1099
to be used in the test suite.
1101
path = self.get_source_path()
1102
self.record_directory_isolation()
1105
workingtree.WorkingTree.open(path)
1106
except (errors.NotBranchError, errors.NoWorkingTree):
1107
raise TestSkipped('Needs a working tree of bzr sources')
1109
self.enable_directory_isolation()
1111
def _preopen_isolate_transport(self, transport):
1112
"""Check that all transport openings are done in the test work area."""
1113
while isinstance(transport, pathfilter.PathFilteringTransport):
1114
# Unwrap pathfiltered transports
1115
transport = transport.server.backing_transport.clone(
1116
transport._filter('.'))
1117
url = transport.base
1118
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1119
# urls it is given by prepending readonly+. This is appropriate as the
1120
# client shouldn't know that the server is readonly (or not readonly).
1121
# We could register all servers twice, with readonly+ prepending, but
1122
# that makes for a long list; this is about the same but easier to
1124
if url.startswith('readonly+'):
1125
url = url[len('readonly+'):]
1126
self._preopen_isolate_url(url)
1128
def _preopen_isolate_url(self, url):
1129
if not self._directory_isolation:
1131
if self._directory_isolation == 'record':
1132
self._bzr_selftest_roots.append(url)
1134
# This prevents all transports, including e.g. sftp ones backed on disk
1135
# from working unless they are explicitly granted permission. We then
1136
# depend on the code that sets up test transports to check that they are
1137
# appropriately isolated and enable their use by calling
1138
# self.permit_transport()
1139
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1140
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1141
% (url, self._bzr_selftest_roots))
1143
def record_directory_isolation(self):
1144
"""Gather accessed directories to permit later access.
1146
This is used for tests that access the branch bzr is running from.
1148
self._directory_isolation = "record"
1150
def start_server(self, transport_server, backing_server=None):
1151
"""Start transport_server for this test.
1153
This starts the server, registers a cleanup for it and permits the
1154
server's urls to be used.
1156
if backing_server is None:
1157
transport_server.start_server()
1159
transport_server.start_server(backing_server)
1160
self.addCleanup(transport_server.stop_server)
1161
# Obtain a real transport because if the server supplies a password, it
1162
# will be hidden from the base on the client side.
1163
t = _mod_transport.get_transport(transport_server.get_url())
1164
# Some transport servers effectively chroot the backing transport;
1165
# others like SFTPServer don't - users of the transport can walk up the
1166
# transport to read the entire backing transport. This wouldn't matter
1167
# except that the workdir tests are given - and that they expect the
1168
# server's url to point at - is one directory under the safety net. So
1169
# Branch operations into the transport will attempt to walk up one
1170
# directory. Chrooting all servers would avoid this but also mean that
1171
# we wouldn't be testing directly against non-root urls. Alternatively
1172
# getting the test framework to start the server with a backing server
1173
# at the actual safety net directory would work too, but this then
1174
# means that the self.get_url/self.get_transport methods would need
1175
# to transform all their results. On balance its cleaner to handle it
1176
# here, and permit a higher url when we have one of these transports.
1177
if t.base.endswith('/work/'):
1178
# we have safety net/test root/work
1179
t = t.clone('../..')
1180
elif isinstance(transport_server,
1181
test_server.SmartTCPServer_for_testing):
1182
# The smart server adds a path similar to work, which is traversed
1183
# up from by the client. But the server is chrooted - the actual
1184
# backing transport is not escaped from, and VFS requests to the
1185
# root will error (because they try to escape the chroot).
1187
while t2.base != t.base:
1190
self.permit_url(t.base)
1192
def _track_transports(self):
1193
"""Install checks for transport usage."""
1194
# TestCase has no safe place it can write to.
1195
self._bzr_selftest_roots = []
1196
# Currently the easiest way to be sure that nothing is going on is to
1197
# hook into bzr dir opening. This leaves a small window of error for
1198
# transport tests, but they are well known, and we can improve on this
1200
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1201
self._preopen_isolate_transport, "Check bzr directories are safe.")
1203
def _ndiff_strings(self, a, b):
1204
"""Return ndiff between two strings containing lines.
1206
A trailing newline is added if missing to make the strings
1208
if b and b[-1] != '\n':
1210
if a and a[-1] != '\n':
1212
difflines = difflib.ndiff(a.splitlines(True),
1214
linejunk=lambda x: False,
1215
charjunk=lambda x: False)
1216
return ''.join(difflines)
1218
def assertEqual(self, a, b, message=''):
1222
except UnicodeError, e:
1223
# If we can't compare without getting a UnicodeError, then
1224
# obviously they are different
1225
trace.mutter('UnicodeError: %s', e)
1228
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1230
pprint.pformat(a), pprint.pformat(b)))
1232
assertEquals = assertEqual
1234
def assertEqualDiff(self, a, b, message=None):
1235
"""Assert two texts are equal, if not raise an exception.
1237
This is intended for use with multi-line strings where it can
1238
be hard to find the differences by eye.
1240
# TODO: perhaps override assertEquals to call this for strings?
1244
message = "texts not equal:\n"
1246
message = 'first string is missing a final newline.\n'
1248
message = 'second string is missing a final newline.\n'
1249
raise AssertionError(message +
1250
self._ndiff_strings(a, b))
1252
def assertEqualMode(self, mode, mode_test):
1253
self.assertEqual(mode, mode_test,
1254
'mode mismatch %o != %o' % (mode, mode_test))
1256
def assertEqualStat(self, expected, actual):
1257
"""assert that expected and actual are the same stat result.
1259
:param expected: A stat result.
1260
:param actual: A stat result.
1261
:raises AssertionError: If the expected and actual stat values differ
1262
other than by atime.
1264
self.assertEqual(expected.st_size, actual.st_size,
1265
'st_size did not match')
1266
self.assertEqual(expected.st_mtime, actual.st_mtime,
1267
'st_mtime did not match')
1268
self.assertEqual(expected.st_ctime, actual.st_ctime,
1269
'st_ctime did not match')
1270
if sys.platform == 'win32':
1271
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1272
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1273
# odd. We just force it to always be 0 to avoid any problems.
1274
self.assertEqual(0, expected.st_dev)
1275
self.assertEqual(0, actual.st_dev)
1276
self.assertEqual(0, expected.st_ino)
1277
self.assertEqual(0, actual.st_ino)
1279
self.assertEqual(expected.st_dev, actual.st_dev,
1280
'st_dev did not match')
1281
self.assertEqual(expected.st_ino, actual.st_ino,
1282
'st_ino did not match')
1283
self.assertEqual(expected.st_mode, actual.st_mode,
1284
'st_mode did not match')
1286
def assertLength(self, length, obj_with_len):
1287
"""Assert that obj_with_len is of length length."""
1288
if len(obj_with_len) != length:
1289
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1290
length, len(obj_with_len), obj_with_len))
1292
def assertLogsError(self, exception_class, func, *args, **kwargs):
1293
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1296
orig_log_exception_quietly = trace.log_exception_quietly
1299
orig_log_exception_quietly()
1300
captured.append(sys.exc_info())
1301
trace.log_exception_quietly = capture
1302
func(*args, **kwargs)
1304
trace.log_exception_quietly = orig_log_exception_quietly
1305
self.assertLength(1, captured)
1306
err = captured[0][1]
1307
self.assertIsInstance(err, exception_class)
1310
def assertPositive(self, val):
1311
"""Assert that val is greater than 0."""
1312
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1314
def assertNegative(self, val):
1315
"""Assert that val is less than 0."""
1316
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1318
def assertStartsWith(self, s, prefix):
1319
if not s.startswith(prefix):
1320
raise AssertionError('string %r does not start with %r' % (s, prefix))
1322
def assertEndsWith(self, s, suffix):
1323
"""Asserts that s ends with suffix."""
1324
if not s.endswith(suffix):
1325
raise AssertionError('string %r does not end with %r' % (s, suffix))
1327
def assertContainsRe(self, haystack, needle_re, flags=0):
1328
"""Assert that a contains something matching a regular expression."""
1329
if not re.search(needle_re, haystack, flags):
1330
if '\n' in haystack or len(haystack) > 60:
1331
# a long string, format it in a more readable way
1332
raise AssertionError(
1333
'pattern "%s" not found in\n"""\\\n%s"""\n'
1334
% (needle_re, haystack))
1336
raise AssertionError('pattern "%s" not found in "%s"'
1337
% (needle_re, haystack))
1339
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1340
"""Assert that a does not match a regular expression"""
1341
if re.search(needle_re, haystack, flags):
1342
raise AssertionError('pattern "%s" found in "%s"'
1343
% (needle_re, haystack))
1345
def assertContainsString(self, haystack, needle):
1346
if haystack.find(needle) == -1:
1347
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1349
def assertNotContainsString(self, haystack, needle):
1350
if haystack.find(needle) != -1:
1351
self.fail("string %r found in '''%s'''" % (needle, haystack))
1353
def assertSubset(self, sublist, superlist):
1354
"""Assert that every entry in sublist is present in superlist."""
1355
missing = set(sublist) - set(superlist)
1356
if len(missing) > 0:
1357
raise AssertionError("value(s) %r not present in container %r" %
1358
(missing, superlist))
1360
def assertListRaises(self, excClass, func, *args, **kwargs):
1361
"""Fail unless excClass is raised when the iterator from func is used.
1363
Many functions can return generators this makes sure
1364
to wrap them in a list() call to make sure the whole generator
1365
is run, and that the proper exception is raised.
1368
list(func(*args, **kwargs))
1372
if getattr(excClass,'__name__', None) is not None:
1373
excName = excClass.__name__
1375
excName = str(excClass)
1376
raise self.failureException, "%s not raised" % excName
1378
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1379
"""Assert that a callable raises a particular exception.
1381
:param excClass: As for the except statement, this may be either an
1382
exception class, or a tuple of classes.
1383
:param callableObj: A callable, will be passed ``*args`` and
1386
Returns the exception so that you can examine it.
1389
callableObj(*args, **kwargs)
1393
if getattr(excClass,'__name__', None) is not None:
1394
excName = excClass.__name__
1397
excName = str(excClass)
1398
raise self.failureException, "%s not raised" % excName
1400
def assertIs(self, left, right, message=None):
1401
if not (left is right):
1402
if message is not None:
1403
raise AssertionError(message)
1405
raise AssertionError("%r is not %r." % (left, right))
1407
def assertIsNot(self, left, right, message=None):
1409
if message is not None:
1410
raise AssertionError(message)
1412
raise AssertionError("%r is %r." % (left, right))
1414
def assertTransportMode(self, transport, path, mode):
1415
"""Fail if a path does not have mode "mode".
1417
If modes are not supported on this transport, the assertion is ignored.
1419
if not transport._can_roundtrip_unix_modebits():
1421
path_stat = transport.stat(path)
1422
actual_mode = stat.S_IMODE(path_stat.st_mode)
1423
self.assertEqual(mode, actual_mode,
1424
'mode of %r incorrect (%s != %s)'
1425
% (path, oct(mode), oct(actual_mode)))
1427
def assertIsSameRealPath(self, path1, path2):
1428
"""Fail if path1 and path2 points to different files"""
1429
self.assertEqual(osutils.realpath(path1),
1430
osutils.realpath(path2),
1431
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1433
def assertIsInstance(self, obj, kls, msg=None):
1434
"""Fail if obj is not an instance of kls
1436
:param msg: Supplementary message to show if the assertion fails.
1438
if not isinstance(obj, kls):
1439
m = "%r is an instance of %s rather than %s" % (
1440
obj, obj.__class__, kls)
1445
def assertFileEqual(self, content, path):
1446
"""Fail if path does not contain 'content'."""
1447
self.failUnlessExists(path)
1448
f = file(path, 'rb')
1453
self.assertEqualDiff(content, s)
1455
def assertDocstring(self, expected_docstring, obj):
1456
"""Fail if obj does not have expected_docstring"""
1458
# With -OO the docstring should be None instead
1459
self.assertIs(obj.__doc__, None)
1461
self.assertEqual(expected_docstring, obj.__doc__)
1463
def failUnlessExists(self, path):
1464
"""Fail unless path or paths, which may be abs or relative, exist."""
1465
if not isinstance(path, basestring):
1467
self.failUnlessExists(p)
1469
self.failUnless(osutils.lexists(path),path+" does not exist")
1471
def failIfExists(self, path):
1472
"""Fail if path or paths, which may be abs or relative, exist."""
1473
if not isinstance(path, basestring):
1475
self.failIfExists(p)
1477
self.failIf(osutils.lexists(path),path+" exists")
1479
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1480
"""A helper for callDeprecated and applyDeprecated.
1482
:param a_callable: A callable to call.
1483
:param args: The positional arguments for the callable
1484
:param kwargs: The keyword arguments for the callable
1485
:return: A tuple (warnings, result). result is the result of calling
1486
a_callable(``*args``, ``**kwargs``).
1489
def capture_warnings(msg, cls=None, stacklevel=None):
1490
# we've hooked into a deprecation specific callpath,
1491
# only deprecations should getting sent via it.
1492
self.assertEqual(cls, DeprecationWarning)
1493
local_warnings.append(msg)
1494
original_warning_method = symbol_versioning.warn
1495
symbol_versioning.set_warning_method(capture_warnings)
1497
result = a_callable(*args, **kwargs)
1499
symbol_versioning.set_warning_method(original_warning_method)
1500
return (local_warnings, result)
1502
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1503
"""Call a deprecated callable without warning the user.
1505
Note that this only captures warnings raised by symbol_versioning.warn,
1506
not other callers that go direct to the warning module.
1508
To test that a deprecated method raises an error, do something like
1511
self.assertRaises(errors.ReservedId,
1512
self.applyDeprecated,
1513
deprecated_in((1, 5, 0)),
1517
:param deprecation_format: The deprecation format that the callable
1518
should have been deprecated with. This is the same type as the
1519
parameter to deprecated_method/deprecated_function. If the
1520
callable is not deprecated with this format, an assertion error
1522
:param a_callable: A callable to call. This may be a bound method or
1523
a regular function. It will be called with ``*args`` and
1525
:param args: The positional arguments for the callable
1526
:param kwargs: The keyword arguments for the callable
1527
:return: The result of a_callable(``*args``, ``**kwargs``)
1529
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1531
expected_first_warning = symbol_versioning.deprecation_string(
1532
a_callable, deprecation_format)
1533
if len(call_warnings) == 0:
1534
self.fail("No deprecation warning generated by call to %s" %
1536
self.assertEqual(expected_first_warning, call_warnings[0])
1539
def callCatchWarnings(self, fn, *args, **kw):
1540
"""Call a callable that raises python warnings.
1542
The caller's responsible for examining the returned warnings.
1544
If the callable raises an exception, the exception is not
1545
caught and propagates up to the caller. In that case, the list
1546
of warnings is not available.
1548
:returns: ([warning_object, ...], fn_result)
1550
# XXX: This is not perfect, because it completely overrides the
1551
# warnings filters, and some code may depend on suppressing particular
1552
# warnings. It's the easiest way to insulate ourselves from -Werror,
1553
# though. -- Andrew, 20071062
1555
def _catcher(message, category, filename, lineno, file=None, line=None):
1556
# despite the name, 'message' is normally(?) a Warning subclass
1558
wlist.append(message)
1559
saved_showwarning = warnings.showwarning
1560
saved_filters = warnings.filters
1562
warnings.showwarning = _catcher
1563
warnings.filters = []
1564
result = fn(*args, **kw)
1566
warnings.showwarning = saved_showwarning
1567
warnings.filters = saved_filters
1568
return wlist, result
1570
def callDeprecated(self, expected, callable, *args, **kwargs):
1571
"""Assert that a callable is deprecated in a particular way.
1573
This is a very precise test for unusual requirements. The
1574
applyDeprecated helper function is probably more suited for most tests
1575
as it allows you to simply specify the deprecation format being used
1576
and will ensure that that is issued for the function being called.
1578
Note that this only captures warnings raised by symbol_versioning.warn,
1579
not other callers that go direct to the warning module. To catch
1580
general warnings, use callCatchWarnings.
1582
:param expected: a list of the deprecation warnings expected, in order
1583
:param callable: The callable to call
1584
:param args: The positional arguments for the callable
1585
:param kwargs: The keyword arguments for the callable
1587
call_warnings, result = self._capture_deprecation_warnings(callable,
1589
self.assertEqual(expected, call_warnings)
1592
def _startLogFile(self):
1593
"""Send bzr and test log messages to a temporary file.
1595
The file is removed as the test is torn down.
1597
self._log_file = StringIO()
1598
self._log_memento = trace.push_log_file(self._log_file)
1599
self.addCleanup(self._finishLogFile)
1601
def _finishLogFile(self):
1602
"""Finished with the log file.
1604
Close the file and delete it, unless setKeepLogfile was called.
1606
if trace._trace_file:
1607
# flush the log file, to get all content
1608
trace._trace_file.flush()
1609
trace.pop_log_file(self._log_memento)
1610
# Cache the log result and delete the file on disk
1611
self._get_log(False)
1613
def thisFailsStrictLockCheck(self):
1614
"""It is known that this test would fail with -Dstrict_locks.
1616
By default, all tests are run with strict lock checking unless
1617
-Edisable_lock_checks is supplied. However there are some tests which
1618
we know fail strict locks at this point that have not been fixed.
1619
They should call this function to disable the strict checking.
1621
This should be used sparingly, it is much better to fix the locking
1622
issues rather than papering over the problem by calling this function.
1624
debug.debug_flags.discard('strict_locks')
1626
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1627
"""Overrides an object attribute restoring it after the test.
1629
:param obj: The object that will be mutated.
1631
:param attr_name: The attribute name we want to preserve/override in
1634
:param new: The optional value we want to set the attribute to.
1636
:returns: The actual attr value.
1638
value = getattr(obj, attr_name)
1639
# The actual value is captured by the call below
1640
self.addCleanup(setattr, obj, attr_name, value)
1641
if new is not _unitialized_attr:
1642
setattr(obj, attr_name, new)
1645
def overrideEnv(self, name, new):
1646
"""Set an environment variable, and reset it after the test.
1648
:param name: The environment variable name.
1650
:param new: The value to set the variable to. If None, the
1651
variable is deleted from the environment.
1653
:returns: The actual variable value.
1655
value = osutils.set_or_unset_env(name, new)
1656
self.addCleanup(osutils.set_or_unset_env, name, value)
1659
def _cleanEnvironment(self):
1660
for name, value in isolated_environ.iteritems():
1661
self.overrideEnv(name, value)
1663
def _restoreHooks(self):
1664
for klass, (name, hooks) in self._preserved_hooks.items():
1665
setattr(klass, name, hooks)
1666
hooks._lazy_hooks = self._preserved_lazy_hooks
1668
def knownFailure(self, reason):
1669
"""This test has failed for some known reason."""
1670
raise KnownFailure(reason)
1672
def _suppress_log(self):
1673
"""Remove the log info from details."""
1674
self.discardDetail('log')
1676
def _do_skip(self, result, reason):
1677
self._suppress_log()
1678
addSkip = getattr(result, 'addSkip', None)
1679
if not callable(addSkip):
1680
result.addSuccess(result)
1682
addSkip(self, reason)
1685
def _do_known_failure(self, result, e):
1686
self._suppress_log()
1687
err = sys.exc_info()
1688
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1689
if addExpectedFailure is not None:
1690
addExpectedFailure(self, err)
1692
result.addSuccess(self)
1695
def _do_not_applicable(self, result, e):
1697
reason = 'No reason given'
1700
self._suppress_log ()
1701
addNotApplicable = getattr(result, 'addNotApplicable', None)
1702
if addNotApplicable is not None:
1703
result.addNotApplicable(self, reason)
1705
self._do_skip(result, reason)
1708
def _report_skip(self, result, err):
1709
"""Override the default _report_skip.
1711
We want to strip the 'log' detail. If we waint until _do_skip, it has
1712
already been formatted into the 'reason' string, and we can't pull it
1715
self._suppress_log()
1716
super(TestCase, self)._report_skip(self, result, err)
1719
def _report_expected_failure(self, result, err):
1722
See _report_skip for motivation.
1724
self._suppress_log()
1725
super(TestCase, self)._report_expected_failure(self, result, err)
1728
def _do_unsupported_or_skip(self, result, e):
1730
self._suppress_log()
1731
addNotSupported = getattr(result, 'addNotSupported', None)
1732
if addNotSupported is not None:
1733
result.addNotSupported(self, reason)
1735
self._do_skip(result, reason)
1737
def time(self, callable, *args, **kwargs):
1738
"""Run callable and accrue the time it takes to the benchmark time.
1740
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1741
this will cause lsprofile statistics to be gathered and stored in
1744
if self._benchtime is None:
1745
self.addDetail('benchtime', content.Content(content.ContentType(
1746
"text", "plain"), lambda:[str(self._benchtime)]))
1750
if not self._gather_lsprof_in_benchmarks:
1751
return callable(*args, **kwargs)
1753
# record this benchmark
1754
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1756
self._benchcalls.append(((callable, args, kwargs), stats))
1759
self._benchtime += time.time() - start
1761
def log(self, *args):
1764
def _get_log(self, keep_log_file=False):
1765
"""Internal helper to get the log from bzrlib.trace for this test.
1767
Please use self.getDetails, or self.get_log to access this in test case
1770
:param keep_log_file: When True, if the log is still a file on disk
1771
leave it as a file on disk. When False, if the log is still a file
1772
on disk, the log file is deleted and the log preserved as
1774
:return: A string containing the log.
1776
if self._log_contents is not None:
1778
self._log_contents.decode('utf8')
1779
except UnicodeDecodeError:
1780
unicodestr = self._log_contents.decode('utf8', 'replace')
1781
self._log_contents = unicodestr.encode('utf8')
1782
return self._log_contents
1783
if self._log_file is not None:
1784
log_contents = self._log_file.getvalue()
1786
log_contents.decode('utf8')
1787
except UnicodeDecodeError:
1788
unicodestr = log_contents.decode('utf8', 'replace')
1789
log_contents = unicodestr.encode('utf8')
1790
if not keep_log_file:
1791
self._log_file = None
1792
# Permit multiple calls to get_log until we clean it up in
1794
self._log_contents = log_contents
1797
return "No log file content."
1800
"""Get a unicode string containing the log from bzrlib.trace.
1802
Undecodable characters are replaced.
1804
return u"".join(self.getDetails()['log'].iter_text())
1806
def requireFeature(self, feature):
1807
"""This test requires a specific feature is available.
1809
:raises UnavailableFeature: When feature is not available.
1811
if not feature.available():
1812
raise UnavailableFeature(feature)
1814
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1816
"""Run bazaar command line, splitting up a string command line."""
1817
if isinstance(args, basestring):
1818
# shlex don't understand unicode strings,
1819
# so args should be plain string (bialix 20070906)
1820
args = list(shlex.split(str(args)))
1821
return self._run_bzr_core(args, retcode=retcode,
1822
encoding=encoding, stdin=stdin, working_dir=working_dir,
1825
def _run_bzr_core(self, args, retcode, encoding, stdin,
1827
# Clear chk_map page cache, because the contents are likely to mask
1829
chk_map.clear_cache()
1830
if encoding is None:
1831
encoding = osutils.get_user_encoding()
1832
stdout = StringIOWrapper()
1833
stderr = StringIOWrapper()
1834
stdout.encoding = encoding
1835
stderr.encoding = encoding
1837
self.log('run bzr: %r', args)
1838
# FIXME: don't call into logging here
1839
handler = logging.StreamHandler(stderr)
1840
handler.setLevel(logging.INFO)
1841
logger = logging.getLogger('')
1842
logger.addHandler(handler)
1843
old_ui_factory = ui.ui_factory
1844
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1847
if working_dir is not None:
1848
cwd = osutils.getcwd()
1849
os.chdir(working_dir)
1853
result = self.apply_redirected(
1854
ui.ui_factory.stdin,
1856
_mod_commands.run_bzr_catch_user_errors,
1858
except KeyboardInterrupt:
1859
# Reraise KeyboardInterrupt with contents of redirected stdout
1860
# and stderr as arguments, for tests which are interested in
1861
# stdout and stderr and are expecting the exception.
1862
out = stdout.getvalue()
1863
err = stderr.getvalue()
1865
self.log('output:\n%r', out)
1867
self.log('errors:\n%r', err)
1868
raise KeyboardInterrupt(out, err)
1870
logger.removeHandler(handler)
1871
ui.ui_factory = old_ui_factory
1875
out = stdout.getvalue()
1876
err = stderr.getvalue()
1878
self.log('output:\n%r', out)
1880
self.log('errors:\n%r', err)
1881
if retcode is not None:
1882
self.assertEquals(retcode, result,
1883
message='Unexpected return code')
1884
return result, out, err
1886
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1887
working_dir=None, error_regexes=[], output_encoding=None):
1888
"""Invoke bzr, as if it were run from the command line.
1890
The argument list should not include the bzr program name - the
1891
first argument is normally the bzr command. Arguments may be
1892
passed in three ways:
1894
1- A list of strings, eg ["commit", "a"]. This is recommended
1895
when the command contains whitespace or metacharacters, or
1896
is built up at run time.
1898
2- A single string, eg "add a". This is the most convenient
1899
for hardcoded commands.
1901
This runs bzr through the interface that catches and reports
1902
errors, and with logging set to something approximating the
1903
default, so that error reporting can be checked.
1905
This should be the main method for tests that want to exercise the
1906
overall behavior of the bzr application (rather than a unit test
1907
or a functional test of the library.)
1909
This sends the stdout/stderr results into the test's log,
1910
where it may be useful for debugging. See also run_captured.
1912
:keyword stdin: A string to be used as stdin for the command.
1913
:keyword retcode: The status code the command should return;
1915
:keyword working_dir: The directory to run the command in
1916
:keyword error_regexes: A list of expected error messages. If
1917
specified they must be seen in the error output of the command.
1919
retcode, out, err = self._run_bzr_autosplit(
1924
working_dir=working_dir,
1926
self.assertIsInstance(error_regexes, (list, tuple))
1927
for regex in error_regexes:
1928
self.assertContainsRe(err, regex)
1931
def run_bzr_error(self, error_regexes, *args, **kwargs):
1932
"""Run bzr, and check that stderr contains the supplied regexes
1934
:param error_regexes: Sequence of regular expressions which
1935
must each be found in the error output. The relative ordering
1937
:param args: command-line arguments for bzr
1938
:param kwargs: Keyword arguments which are interpreted by run_bzr
1939
This function changes the default value of retcode to be 3,
1940
since in most cases this is run when you expect bzr to fail.
1942
:return: (out, err) The actual output of running the command (in case
1943
you want to do more inspection)
1947
# Make sure that commit is failing because there is nothing to do
1948
self.run_bzr_error(['no changes to commit'],
1949
['commit', '-m', 'my commit comment'])
1950
# Make sure --strict is handling an unknown file, rather than
1951
# giving us the 'nothing to do' error
1952
self.build_tree(['unknown'])
1953
self.run_bzr_error(['Commit refused because there are unknown files'],
1954
['commit', --strict', '-m', 'my commit comment'])
1956
kwargs.setdefault('retcode', 3)
1957
kwargs['error_regexes'] = error_regexes
1958
out, err = self.run_bzr(*args, **kwargs)
1961
def run_bzr_subprocess(self, *args, **kwargs):
1962
"""Run bzr in a subprocess for testing.
1964
This starts a new Python interpreter and runs bzr in there.
1965
This should only be used for tests that have a justifiable need for
1966
this isolation: e.g. they are testing startup time, or signal
1967
handling, or early startup code, etc. Subprocess code can't be
1968
profiled or debugged so easily.
1970
:keyword retcode: The status code that is expected. Defaults to 0. If
1971
None is supplied, the status code is not checked.
1972
:keyword env_changes: A dictionary which lists changes to environment
1973
variables. A value of None will unset the env variable.
1974
The values must be strings. The change will only occur in the
1975
child, so you don't need to fix the environment after running.
1976
:keyword universal_newlines: Convert CRLF => LF
1977
:keyword allow_plugins: By default the subprocess is run with
1978
--no-plugins to ensure test reproducibility. Also, it is possible
1979
for system-wide plugins to create unexpected output on stderr,
1980
which can cause unnecessary test failures.
1982
env_changes = kwargs.get('env_changes', {})
1983
working_dir = kwargs.get('working_dir', None)
1984
allow_plugins = kwargs.get('allow_plugins', False)
1986
if isinstance(args[0], list):
1988
elif isinstance(args[0], basestring):
1989
args = list(shlex.split(args[0]))
1991
raise ValueError("passing varargs to run_bzr_subprocess")
1992
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1993
working_dir=working_dir,
1994
allow_plugins=allow_plugins)
1995
# We distinguish between retcode=None and retcode not passed.
1996
supplied_retcode = kwargs.get('retcode', 0)
1997
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1998
universal_newlines=kwargs.get('universal_newlines', False),
2001
def start_bzr_subprocess(self, process_args, env_changes=None,
2002
skip_if_plan_to_signal=False,
2004
allow_plugins=False):
2005
"""Start bzr in a subprocess for testing.
2007
This starts a new Python interpreter and runs bzr in there.
2008
This should only be used for tests that have a justifiable need for
2009
this isolation: e.g. they are testing startup time, or signal
2010
handling, or early startup code, etc. Subprocess code can't be
2011
profiled or debugged so easily.
2013
:param process_args: a list of arguments to pass to the bzr executable,
2014
for example ``['--version']``.
2015
:param env_changes: A dictionary which lists changes to environment
2016
variables. A value of None will unset the env variable.
2017
The values must be strings. The change will only occur in the
2018
child, so you don't need to fix the environment after running.
2019
:param skip_if_plan_to_signal: raise TestSkipped when true and system
2020
doesn't support signalling subprocesses.
2021
:param allow_plugins: If False (default) pass --no-plugins to bzr.
2023
:returns: Popen object for the started process.
2025
if skip_if_plan_to_signal:
2026
if os.name != "posix":
2027
raise TestSkipped("Sending signals not supported")
2029
if env_changes is None:
2033
def cleanup_environment():
2034
for env_var, value in env_changes.iteritems():
2035
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2037
def restore_environment():
2038
for env_var, value in old_env.iteritems():
2039
osutils.set_or_unset_env(env_var, value)
2041
bzr_path = self.get_bzr_path()
2044
if working_dir is not None:
2045
cwd = osutils.getcwd()
2046
os.chdir(working_dir)
2049
# win32 subprocess doesn't support preexec_fn
2050
# so we will avoid using it on all platforms, just to
2051
# make sure the code path is used, and we don't break on win32
2052
cleanup_environment()
2053
command = [sys.executable]
2054
# frozen executables don't need the path to bzr
2055
if getattr(sys, "frozen", None) is None:
2056
command.append(bzr_path)
2057
if not allow_plugins:
2058
command.append('--no-plugins')
2059
command.extend(process_args)
2060
process = self._popen(command, stdin=subprocess.PIPE,
2061
stdout=subprocess.PIPE,
2062
stderr=subprocess.PIPE)
2064
restore_environment()
2070
def _popen(self, *args, **kwargs):
2071
"""Place a call to Popen.
2073
Allows tests to override this method to intercept the calls made to
2074
Popen for introspection.
2076
return subprocess.Popen(*args, **kwargs)
2078
def get_source_path(self):
2079
"""Return the path of the directory containing bzrlib."""
2080
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2082
def get_bzr_path(self):
2083
"""Return the path of the 'bzr' executable for this test suite."""
2084
bzr_path = os.path.join(self.get_source_path(), "bzr")
2085
if not os.path.isfile(bzr_path):
2086
# We are probably installed. Assume sys.argv is the right file
2087
bzr_path = sys.argv[0]
2090
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2091
universal_newlines=False, process_args=None):
2092
"""Finish the execution of process.
2094
:param process: the Popen object returned from start_bzr_subprocess.
2095
:param retcode: The status code that is expected. Defaults to 0. If
2096
None is supplied, the status code is not checked.
2097
:param send_signal: an optional signal to send to the process.
2098
:param universal_newlines: Convert CRLF => LF
2099
:returns: (stdout, stderr)
2101
if send_signal is not None:
2102
os.kill(process.pid, send_signal)
2103
out, err = process.communicate()
2105
if universal_newlines:
2106
out = out.replace('\r\n', '\n')
2107
err = err.replace('\r\n', '\n')
2109
if retcode is not None and retcode != process.returncode:
2110
if process_args is None:
2111
process_args = "(unknown args)"
2112
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2113
trace.mutter('Error for bzr %s:\n%s', process_args, err)
2114
self.fail('Command bzr %s failed with retcode %s != %s'
2115
% (process_args, retcode, process.returncode))
2118
def check_inventory_shape(self, inv, shape):
2119
"""Compare an inventory to a list of expected names.
2121
Fail if they are not precisely equal.
2124
shape = list(shape) # copy
2125
for path, ie in inv.entries():
2126
name = path.replace('\\', '/')
2127
if ie.kind == 'directory':
2134
self.fail("expected paths not found in inventory: %r" % shape)
2136
self.fail("unexpected paths found in inventory: %r" % extras)
2138
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2139
a_callable=None, *args, **kwargs):
2140
"""Call callable with redirected std io pipes.
2142
Returns the return code."""
2143
if not callable(a_callable):
2144
raise ValueError("a_callable must be callable.")
2146
stdin = StringIO("")
2148
if getattr(self, "_log_file", None) is not None:
2149
stdout = self._log_file
2153
if getattr(self, "_log_file", None is not None):
2154
stderr = self._log_file
2157
real_stdin = sys.stdin
2158
real_stdout = sys.stdout
2159
real_stderr = sys.stderr
2164
return a_callable(*args, **kwargs)
2166
sys.stdout = real_stdout
2167
sys.stderr = real_stderr
2168
sys.stdin = real_stdin
2170
def reduceLockdirTimeout(self):
2171
"""Reduce the default lock timeout for the duration of the test, so that
2172
if LockContention occurs during a test, it does so quickly.
2174
Tests that expect to provoke LockContention errors should call this.
2176
self.overrideAttr(lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2178
def make_utf8_encoded_stringio(self, encoding_type=None):
2179
"""Return a StringIOWrapper instance, that will encode Unicode
2182
if encoding_type is None:
2183
encoding_type = 'strict'
2185
output_encoding = 'utf-8'
2186
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2187
sio.encoding = output_encoding
2190
def disable_verb(self, verb):
2191
"""Disable a smart server verb for one test."""
2192
from bzrlib.smart import request
2193
request_handlers = request.request_handlers
2194
orig_method = request_handlers.get(verb)
2195
request_handlers.remove(verb)
2196
self.addCleanup(request_handlers.register, verb, orig_method)
2199
class CapturedCall(object):
2200
"""A helper for capturing smart server calls for easy debug analysis."""
2202
def __init__(self, params, prefix_length):
2203
"""Capture the call with params and skip prefix_length stack frames."""
2206
# The last 5 frames are the __init__, the hook frame, and 3 smart
2207
# client frames. Beyond this we could get more clever, but this is good
2209
stack = traceback.extract_stack()[prefix_length:-5]
2210
self.stack = ''.join(traceback.format_list(stack))
2213
return self.call.method
2216
return self.call.method
2222
class TestCaseWithMemoryTransport(TestCase):
2223
"""Common test class for tests that do not need disk resources.
2225
Tests that need disk resources should derive from TestCaseWithTransport.
2227
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2229
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2230
a directory which does not exist. This serves to help ensure test isolation
2231
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2232
must exist. However, TestCaseWithMemoryTransport does not offer local
2233
file defaults for the transport in tests, nor does it obey the command line
2234
override, so tests that accidentally write to the common directory should
2237
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2238
a .bzr directory that stops us ascending higher into the filesystem.
2244
def __init__(self, methodName='runTest'):
2245
# allow test parameterization after test construction and before test
2246
# execution. Variables that the parameterizer sets need to be
2247
# ones that are not set by setUp, or setUp will trash them.
2248
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2249
self.vfs_transport_factory = default_transport
2250
self.transport_server = None
2251
self.transport_readonly_server = None
2252
self.__vfs_server = None
2254
def get_transport(self, relpath=None):
2255
"""Return a writeable transport.
2257
This transport is for the test scratch space relative to
2260
:param relpath: a path relative to the base url.
2262
t = _mod_transport.get_transport(self.get_url(relpath))
2263
self.assertFalse(t.is_readonly())
2266
def get_readonly_transport(self, relpath=None):
2267
"""Return a readonly transport for the test scratch space
2269
This can be used to test that operations which should only need
2270
readonly access in fact do not try to write.
2272
:param relpath: a path relative to the base url.
2274
t = _mod_transport.get_transport(self.get_readonly_url(relpath))
2275
self.assertTrue(t.is_readonly())
2278
def create_transport_readonly_server(self):
2279
"""Create a transport server from class defined at init.
2281
This is mostly a hook for daughter classes.
2283
return self.transport_readonly_server()
2285
def get_readonly_server(self):
2286
"""Get the server instance for the readonly transport
2288
This is useful for some tests with specific servers to do diagnostics.
2290
if self.__readonly_server is None:
2291
if self.transport_readonly_server is None:
2292
# readonly decorator requested
2293
self.__readonly_server = test_server.ReadonlyServer()
2295
# explicit readonly transport.
2296
self.__readonly_server = self.create_transport_readonly_server()
2297
self.start_server(self.__readonly_server,
2298
self.get_vfs_only_server())
2299
return self.__readonly_server
2301
def get_readonly_url(self, relpath=None):
2302
"""Get a URL for the readonly transport.
2304
This will either be backed by '.' or a decorator to the transport
2305
used by self.get_url()
2306
relpath provides for clients to get a path relative to the base url.
2307
These should only be downwards relative, not upwards.
2309
base = self.get_readonly_server().get_url()
2310
return self._adjust_url(base, relpath)
2312
def get_vfs_only_server(self):
2313
"""Get the vfs only read/write server instance.
2315
This is useful for some tests with specific servers that need
2318
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2319
is no means to override it.
2321
if self.__vfs_server is None:
2322
self.__vfs_server = memory.MemoryServer()
2323
self.start_server(self.__vfs_server)
2324
return self.__vfs_server
2326
def get_server(self):
2327
"""Get the read/write server instance.
2329
This is useful for some tests with specific servers that need
2332
This is built from the self.transport_server factory. If that is None,
2333
then the self.get_vfs_server is returned.
2335
if self.__server is None:
2336
if (self.transport_server is None or self.transport_server is
2337
self.vfs_transport_factory):
2338
self.__server = self.get_vfs_only_server()
2340
# bring up a decorated means of access to the vfs only server.
2341
self.__server = self.transport_server()
2342
self.start_server(self.__server, self.get_vfs_only_server())
2343
return self.__server
2345
def _adjust_url(self, base, relpath):
2346
"""Get a URL (or maybe a path) for the readwrite transport.
2348
This will either be backed by '.' or to an equivalent non-file based
2350
relpath provides for clients to get a path relative to the base url.
2351
These should only be downwards relative, not upwards.
2353
if relpath is not None and relpath != '.':
2354
if not base.endswith('/'):
2356
# XXX: Really base should be a url; we did after all call
2357
# get_url()! But sometimes it's just a path (from
2358
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2359
# to a non-escaped local path.
2360
if base.startswith('./') or base.startswith('/'):
2363
base += urlutils.escape(relpath)
2366
def get_url(self, relpath=None):
2367
"""Get a URL (or maybe a path) for the readwrite transport.
2369
This will either be backed by '.' or to an equivalent non-file based
2371
relpath provides for clients to get a path relative to the base url.
2372
These should only be downwards relative, not upwards.
2374
base = self.get_server().get_url()
2375
return self._adjust_url(base, relpath)
2377
def get_vfs_only_url(self, relpath=None):
2378
"""Get a URL (or maybe a path for the plain old vfs transport.
2380
This will never be a smart protocol. It always has all the
2381
capabilities of the local filesystem, but it might actually be a
2382
MemoryTransport or some other similar virtual filesystem.
2384
This is the backing transport (if any) of the server returned by
2385
get_url and get_readonly_url.
2387
:param relpath: provides for clients to get a path relative to the base
2388
url. These should only be downwards relative, not upwards.
2391
base = self.get_vfs_only_server().get_url()
2392
return self._adjust_url(base, relpath)
2394
def _create_safety_net(self):
2395
"""Make a fake bzr directory.
2397
This prevents any tests propagating up onto the TEST_ROOT directory's
2400
root = TestCaseWithMemoryTransport.TEST_ROOT
2401
bzrdir.BzrDir.create_standalone_workingtree(root)
2403
def _check_safety_net(self):
2404
"""Check that the safety .bzr directory have not been touched.
2406
_make_test_root have created a .bzr directory to prevent tests from
2407
propagating. This method ensures than a test did not leaked.
2409
root = TestCaseWithMemoryTransport.TEST_ROOT
2410
self.permit_url(_mod_transport.get_transport(root).base)
2411
wt = workingtree.WorkingTree.open(root)
2412
last_rev = wt.last_revision()
2413
if last_rev != 'null:':
2414
# The current test have modified the /bzr directory, we need to
2415
# recreate a new one or all the followng tests will fail.
2416
# If you need to inspect its content uncomment the following line
2417
# import pdb; pdb.set_trace()
2418
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2419
self._create_safety_net()
2420
raise AssertionError('%s/.bzr should not be modified' % root)
2422
def _make_test_root(self):
2423
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2424
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2425
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2427
TestCaseWithMemoryTransport.TEST_ROOT = root
2429
self._create_safety_net()
2431
# The same directory is used by all tests, and we're not
2432
# specifically told when all tests are finished. This will do.
2433
atexit.register(_rmtree_temp_dir, root)
2435
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2436
self.addCleanup(self._check_safety_net)
2438
def makeAndChdirToTestDir(self):
2439
"""Create a temporary directories for this one test.
2441
This must set self.test_home_dir and self.test_dir and chdir to
2444
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2446
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2447
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2448
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2449
self.permit_dir(self.test_dir)
2451
def make_branch(self, relpath, format=None):
2452
"""Create a branch on the transport at relpath."""
2453
repo = self.make_repository(relpath, format=format)
2454
return repo.bzrdir.create_branch()
2456
def make_bzrdir(self, relpath, format=None):
2458
# might be a relative or absolute path
2459
maybe_a_url = self.get_url(relpath)
2460
segments = maybe_a_url.rsplit('/', 1)
2461
t = _mod_transport.get_transport(maybe_a_url)
2462
if len(segments) > 1 and segments[-1] not in ('', '.'):
2466
if isinstance(format, basestring):
2467
format = bzrdir.format_registry.make_bzrdir(format)
2468
return format.initialize_on_transport(t)
2469
except errors.UninitializableFormat:
2470
raise TestSkipped("Format %s is not initializable." % format)
2472
def make_repository(self, relpath, shared=False, format=None):
2473
"""Create a repository on our default transport at relpath.
2475
Note that relpath must be a relative path, not a full url.
2477
# FIXME: If you create a remoterepository this returns the underlying
2478
# real format, which is incorrect. Actually we should make sure that
2479
# RemoteBzrDir returns a RemoteRepository.
2480
# maybe mbp 20070410
2481
made_control = self.make_bzrdir(relpath, format=format)
2482
return made_control.create_repository(shared=shared)
2484
def make_smart_server(self, path, backing_server=None):
2485
if backing_server is None:
2486
backing_server = self.get_server()
2487
smart_server = test_server.SmartTCPServer_for_testing()
2488
self.start_server(smart_server, backing_server)
2489
remote_transport = _mod_transport.get_transport(smart_server.get_url()
2491
return remote_transport
2493
def make_branch_and_memory_tree(self, relpath, format=None):
2494
"""Create a branch on the default transport and a MemoryTree for it."""
2495
b = self.make_branch(relpath, format=format)
2496
return memorytree.MemoryTree.create_on_branch(b)
2498
def make_branch_builder(self, relpath, format=None):
2499
branch = self.make_branch(relpath, format=format)
2500
return branchbuilder.BranchBuilder(branch=branch)
2502
def overrideEnvironmentForTesting(self):
2503
test_home_dir = self.test_home_dir
2504
if isinstance(test_home_dir, unicode):
2505
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2506
self.overrideEnv('HOME', test_home_dir)
2507
self.overrideEnv('BZR_HOME', test_home_dir)
2510
super(TestCaseWithMemoryTransport, self).setUp()
2511
# Ensure that ConnectedTransport doesn't leak sockets
2512
def get_transport_with_cleanup(*args, **kwargs):
2513
t = orig_get_transport(*args, **kwargs)
2514
if isinstance(t, _mod_transport.ConnectedTransport):
2515
self.addCleanup(t.disconnect)
2518
orig_get_transport = self.overrideAttr(_mod_transport, 'get_transport',
2519
get_transport_with_cleanup)
2520
self._make_test_root()
2521
self.addCleanup(os.chdir, os.getcwdu())
2522
self.makeAndChdirToTestDir()
2523
self.overrideEnvironmentForTesting()
2524
self.__readonly_server = None
2525
self.__server = None
2526
self.reduceLockdirTimeout()
2528
def setup_smart_server_with_call_log(self):
2529
"""Sets up a smart server as the transport server with a call log."""
2530
self.transport_server = test_server.SmartTCPServer_for_testing
2531
self.hpss_calls = []
2533
# Skip the current stack down to the caller of
2534
# setup_smart_server_with_call_log
2535
prefix_length = len(traceback.extract_stack()) - 2
2536
def capture_hpss_call(params):
2537
self.hpss_calls.append(
2538
CapturedCall(params, prefix_length))
2539
client._SmartClient.hooks.install_named_hook(
2540
'call', capture_hpss_call, None)
2542
def reset_smart_call_log(self):
2543
self.hpss_calls = []
2546
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2547
"""Derived class that runs a test within a temporary directory.
2549
This is useful for tests that need to create a branch, etc.
2551
The directory is created in a slightly complex way: for each
2552
Python invocation, a new temporary top-level directory is created.
2553
All test cases create their own directory within that. If the
2554
tests complete successfully, the directory is removed.
2556
:ivar test_base_dir: The path of the top-level directory for this
2557
test, which contains a home directory and a work directory.
2559
:ivar test_home_dir: An initially empty directory under test_base_dir
2560
which is used as $HOME for this test.
2562
:ivar test_dir: A directory under test_base_dir used as the current
2563
directory when the test proper is run.
2566
OVERRIDE_PYTHON = 'python'
2568
def check_file_contents(self, filename, expect):
2569
self.log("check contents of file %s" % filename)
2575
if contents != expect:
2576
self.log("expected: %r" % expect)
2577
self.log("actually: %r" % contents)
2578
self.fail("contents of %s not as expected" % filename)
2580
def _getTestDirPrefix(self):
2581
# create a directory within the top level test directory
2582
if sys.platform in ('win32', 'cygwin'):
2583
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2584
# windows is likely to have path-length limits so use a short name
2585
name_prefix = name_prefix[-30:]
2587
name_prefix = re.sub('[/]', '_', self.id())
2590
def makeAndChdirToTestDir(self):
2591
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2593
For TestCaseInTempDir we create a temporary directory based on the test
2594
name and then create two subdirs - test and home under it.
2596
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2597
self._getTestDirPrefix())
2599
for i in range(100):
2600
if os.path.exists(name):
2601
name = name_prefix + '_' + str(i)
2603
# now create test and home directories within this dir
2604
self.test_base_dir = name
2605
self.addCleanup(self.deleteTestDir)
2606
os.mkdir(self.test_base_dir)
2608
self.permit_dir(self.test_base_dir)
2609
# 'sprouting' and 'init' of a branch both walk up the tree to find
2610
# stacking policy to honour; create a bzr dir with an unshared
2611
# repository (but not a branch - our code would be trying to escape
2612
# then!) to stop them, and permit it to be read.
2613
# control = bzrdir.BzrDir.create(self.test_base_dir)
2614
# control.create_repository()
2615
self.test_home_dir = self.test_base_dir + '/home'
2616
os.mkdir(self.test_home_dir)
2617
self.test_dir = self.test_base_dir + '/work'
2618
os.mkdir(self.test_dir)
2619
os.chdir(self.test_dir)
2620
# put name of test inside
2621
f = file(self.test_base_dir + '/name', 'w')
2627
def deleteTestDir(self):
2628
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2629
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2631
def build_tree(self, shape, line_endings='binary', transport=None):
2632
"""Build a test tree according to a pattern.
2634
shape is a sequence of file specifications. If the final
2635
character is '/', a directory is created.
2637
This assumes that all the elements in the tree being built are new.
2639
This doesn't add anything to a branch.
2641
:type shape: list or tuple.
2642
:param line_endings: Either 'binary' or 'native'
2643
in binary mode, exact contents are written in native mode, the
2644
line endings match the default platform endings.
2645
:param transport: A transport to write to, for building trees on VFS's.
2646
If the transport is readonly or None, "." is opened automatically.
2649
if type(shape) not in (list, tuple):
2650
raise AssertionError("Parameter 'shape' should be "
2651
"a list or a tuple. Got %r instead" % (shape,))
2652
# It's OK to just create them using forward slashes on windows.
2653
if transport is None or transport.is_readonly():
2654
transport = _mod_transport.get_transport(".")
2656
self.assertIsInstance(name, basestring)
2658
transport.mkdir(urlutils.escape(name[:-1]))
2660
if line_endings == 'binary':
2662
elif line_endings == 'native':
2665
raise errors.BzrError(
2666
'Invalid line ending request %r' % line_endings)
2667
content = "contents of %s%s" % (name.encode('utf-8'), end)
2668
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2670
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2672
def assertInWorkingTree(self, path, root_path='.', tree=None):
2673
"""Assert whether path or paths are in the WorkingTree"""
2675
tree = workingtree.WorkingTree.open(root_path)
2676
if not isinstance(path, basestring):
2678
self.assertInWorkingTree(p, tree=tree)
2680
self.assertIsNot(tree.path2id(path), None,
2681
path+' not in working tree.')
2683
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2684
"""Assert whether path or paths are not in the WorkingTree"""
2686
tree = workingtree.WorkingTree.open(root_path)
2687
if not isinstance(path, basestring):
2689
self.assertNotInWorkingTree(p,tree=tree)
2691
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2694
class TestCaseWithTransport(TestCaseInTempDir):
2695
"""A test case that provides get_url and get_readonly_url facilities.
2697
These back onto two transport servers, one for readonly access and one for
2700
If no explicit class is provided for readonly access, a
2701
ReadonlyTransportDecorator is used instead which allows the use of non disk
2702
based read write transports.
2704
If an explicit class is provided for readonly access, that server and the
2705
readwrite one must both define get_url() as resolving to os.getcwd().
2708
def get_vfs_only_server(self):
2709
"""See TestCaseWithMemoryTransport.
2711
This is useful for some tests with specific servers that need
2714
if self.__vfs_server is None:
2715
self.__vfs_server = self.vfs_transport_factory()
2716
self.start_server(self.__vfs_server)
2717
return self.__vfs_server
2719
def make_branch_and_tree(self, relpath, format=None):
2720
"""Create a branch on the transport and a tree locally.
2722
If the transport is not a LocalTransport, the Tree can't be created on
2723
the transport. In that case if the vfs_transport_factory is
2724
LocalURLServer the working tree is created in the local
2725
directory backing the transport, and the returned tree's branch and
2726
repository will also be accessed locally. Otherwise a lightweight
2727
checkout is created and returned.
2729
We do this because we can't physically create a tree in the local
2730
path, with a branch reference to the transport_factory url, and
2731
a branch + repository in the vfs_transport, unless the vfs_transport
2732
namespace is distinct from the local disk - the two branch objects
2733
would collide. While we could construct a tree with its branch object
2734
pointing at the transport_factory transport in memory, reopening it
2735
would behaving unexpectedly, and has in the past caused testing bugs
2736
when we tried to do it that way.
2738
:param format: The BzrDirFormat.
2739
:returns: the WorkingTree.
2741
# TODO: always use the local disk path for the working tree,
2742
# this obviously requires a format that supports branch references
2743
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2745
b = self.make_branch(relpath, format=format)
2747
return b.bzrdir.create_workingtree()
2748
except errors.NotLocalUrl:
2749
# We can only make working trees locally at the moment. If the
2750
# transport can't support them, then we keep the non-disk-backed
2751
# branch and create a local checkout.
2752
if self.vfs_transport_factory is test_server.LocalURLServer:
2753
# the branch is colocated on disk, we cannot create a checkout.
2754
# hopefully callers will expect this.
2755
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2756
wt = local_controldir.create_workingtree()
2757
if wt.branch._format != b._format:
2759
# Make sure that assigning to wt._branch fixes wt.branch,
2760
# in case the implementation details of workingtree objects
2762
self.assertIs(b, wt.branch)
2765
return b.create_checkout(relpath, lightweight=True)
2767
def assertIsDirectory(self, relpath, transport):
2768
"""Assert that relpath within transport is a directory.
2770
This may not be possible on all transports; in that case it propagates
2771
a TransportNotPossible.
2774
mode = transport.stat(relpath).st_mode
2775
except errors.NoSuchFile:
2776
self.fail("path %s is not a directory; no such file"
2778
if not stat.S_ISDIR(mode):
2779
self.fail("path %s is not a directory; has mode %#o"
2782
def assertTreesEqual(self, left, right):
2783
"""Check that left and right have the same content and properties."""
2784
# we use a tree delta to check for equality of the content, and we
2785
# manually check for equality of other things such as the parents list.
2786
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2787
differences = left.changes_from(right)
2788
self.assertFalse(differences.has_changed(),
2789
"Trees %r and %r are different: %r" % (left, right, differences))
2792
super(TestCaseWithTransport, self).setUp()
2793
self.__vfs_server = None
2795
def disable_missing_extensions_warning(self):
2796
"""Some tests expect a precise stderr content.
2798
There is no point in forcing them to duplicate the extension related
2801
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2804
class ChrootedTestCase(TestCaseWithTransport):
2805
"""A support class that provides readonly urls outside the local namespace.
2807
This is done by checking if self.transport_server is a MemoryServer. if it
2808
is then we are chrooted already, if it is not then an HttpServer is used
2811
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2812
be used without needed to redo it when a different
2813
subclass is in use ?
2817
from bzrlib.tests import http_server
2818
super(ChrootedTestCase, self).setUp()
2819
if not self.vfs_transport_factory == memory.MemoryServer:
2820
self.transport_readonly_server = http_server.HttpServer
2823
def condition_id_re(pattern):
2824
"""Create a condition filter which performs a re check on a test's id.
2826
:param pattern: A regular expression string.
2827
:return: A callable that returns True if the re matches.
2829
filter_re = re.compile(pattern, 0)
2830
def condition(test):
2832
return filter_re.search(test_id)
2836
def condition_isinstance(klass_or_klass_list):
2837
"""Create a condition filter which returns isinstance(param, klass).
2839
:return: A callable which when called with one parameter obj return the
2840
result of isinstance(obj, klass_or_klass_list).
2843
return isinstance(obj, klass_or_klass_list)
2847
def condition_id_in_list(id_list):
2848
"""Create a condition filter which verify that test's id in a list.
2850
:param id_list: A TestIdList object.
2851
:return: A callable that returns True if the test's id appears in the list.
2853
def condition(test):
2854
return id_list.includes(test.id())
2858
def condition_id_startswith(starts):
2859
"""Create a condition filter verifying that test's id starts with a string.
2861
:param starts: A list of string.
2862
:return: A callable that returns True if the test's id starts with one of
2865
def condition(test):
2866
for start in starts:
2867
if test.id().startswith(start):
2873
def exclude_tests_by_condition(suite, condition):
2874
"""Create a test suite which excludes some tests from suite.
2876
:param suite: The suite to get tests from.
2877
:param condition: A callable whose result evaluates True when called with a
2878
test case which should be excluded from the result.
2879
:return: A suite which contains the tests found in suite that fail
2883
for test in iter_suite_tests(suite):
2884
if not condition(test):
2886
return TestUtil.TestSuite(result)
2889
def filter_suite_by_condition(suite, condition):
2890
"""Create a test suite by filtering another one.
2892
:param suite: The source suite.
2893
:param condition: A callable whose result evaluates True when called with a
2894
test case which should be included in the result.
2895
:return: A suite which contains the tests found in suite that pass
2899
for test in iter_suite_tests(suite):
2902
return TestUtil.TestSuite(result)
2905
def filter_suite_by_re(suite, pattern):
2906
"""Create a test suite by filtering another one.
2908
:param suite: the source suite
2909
:param pattern: pattern that names must match
2910
:returns: the newly created suite
2912
condition = condition_id_re(pattern)
2913
result_suite = filter_suite_by_condition(suite, condition)
2917
def filter_suite_by_id_list(suite, test_id_list):
2918
"""Create a test suite by filtering another one.
2920
:param suite: The source suite.
2921
:param test_id_list: A list of the test ids to keep as strings.
2922
:returns: the newly created suite
2924
condition = condition_id_in_list(test_id_list)
2925
result_suite = filter_suite_by_condition(suite, condition)
2929
def filter_suite_by_id_startswith(suite, start):
2930
"""Create a test suite by filtering another one.
2932
:param suite: The source suite.
2933
:param start: A list of string the test id must start with one of.
2934
:returns: the newly created suite
2936
condition = condition_id_startswith(start)
2937
result_suite = filter_suite_by_condition(suite, condition)
2941
def exclude_tests_by_re(suite, pattern):
2942
"""Create a test suite which excludes some tests from suite.
2944
:param suite: The suite to get tests from.
2945
:param pattern: A regular expression string. Test ids that match this
2946
pattern will be excluded from the result.
2947
:return: A TestSuite that contains all the tests from suite without the
2948
tests that matched pattern. The order of tests is the same as it was in
2951
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2954
def preserve_input(something):
2955
"""A helper for performing test suite transformation chains.
2957
:param something: Anything you want to preserve.
2963
def randomize_suite(suite):
2964
"""Return a new TestSuite with suite's tests in random order.
2966
The tests in the input suite are flattened into a single suite in order to
2967
accomplish this. Any nested TestSuites are removed to provide global
2970
tests = list(iter_suite_tests(suite))
2971
random.shuffle(tests)
2972
return TestUtil.TestSuite(tests)
2975
def split_suite_by_condition(suite, condition):
2976
"""Split a test suite into two by a condition.
2978
:param suite: The suite to split.
2979
:param condition: The condition to match on. Tests that match this
2980
condition are returned in the first test suite, ones that do not match
2981
are in the second suite.
2982
:return: A tuple of two test suites, where the first contains tests from
2983
suite matching the condition, and the second contains the remainder
2984
from suite. The order within each output suite is the same as it was in
2989
for test in iter_suite_tests(suite):
2991
matched.append(test)
2993
did_not_match.append(test)
2994
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2997
def split_suite_by_re(suite, pattern):
2998
"""Split a test suite into two by a regular expression.
3000
:param suite: The suite to split.
3001
:param pattern: A regular expression string. Test ids that match this
3002
pattern will be in the first test suite returned, and the others in the
3003
second test suite returned.
3004
:return: A tuple of two test suites, where the first contains tests from
3005
suite matching pattern, and the second contains the remainder from
3006
suite. The order within each output suite is the same as it was in
3009
return split_suite_by_condition(suite, condition_id_re(pattern))
3012
def run_suite(suite, name='test', verbose=False, pattern=".*",
3013
stop_on_failure=False,
3014
transport=None, lsprof_timed=None, bench_history=None,
3015
matching_tests_first=None,
3018
exclude_pattern=None,
3021
suite_decorators=None,
3023
result_decorators=None,
3025
"""Run a test suite for bzr selftest.
3027
:param runner_class: The class of runner to use. Must support the
3028
constructor arguments passed by run_suite which are more than standard
3030
:return: A boolean indicating success.
3032
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3037
if runner_class is None:
3038
runner_class = TextTestRunner
3041
runner = runner_class(stream=stream,
3043
verbosity=verbosity,
3044
bench_history=bench_history,
3046
result_decorators=result_decorators,
3048
runner.stop_on_failure=stop_on_failure
3049
# built in decorator factories:
3051
random_order(random_seed, runner),
3052
exclude_tests(exclude_pattern),
3054
if matching_tests_first:
3055
decorators.append(tests_first(pattern))
3057
decorators.append(filter_tests(pattern))
3058
if suite_decorators:
3059
decorators.extend(suite_decorators)
3060
# tell the result object how many tests will be running: (except if
3061
# --parallel=fork is being used. Robert said he will provide a better
3062
# progress design later -- vila 20090817)
3063
if fork_decorator not in decorators:
3064
decorators.append(CountingDecorator)
3065
for decorator in decorators:
3066
suite = decorator(suite)
3068
# Done after test suite decoration to allow randomisation etc
3069
# to take effect, though that is of marginal benefit.
3071
stream.write("Listing tests only ...\n")
3072
for t in iter_suite_tests(suite):
3073
stream.write("%s\n" % (t.id()))
3075
result = runner.run(suite)
3077
return result.wasStrictlySuccessful()
3079
return result.wasSuccessful()
3082
# A registry where get() returns a suite decorator.
3083
parallel_registry = registry.Registry()
3086
def fork_decorator(suite):
3087
if getattr(os, "fork", None) is None:
3088
raise errors.BzrCommandError("platform does not support fork,"
3089
" try --parallel=subprocess instead.")
3090
concurrency = osutils.local_concurrency()
3091
if concurrency == 1:
3093
from testtools import ConcurrentTestSuite
3094
return ConcurrentTestSuite(suite, fork_for_tests)
3095
parallel_registry.register('fork', fork_decorator)
3098
def subprocess_decorator(suite):
3099
concurrency = osutils.local_concurrency()
3100
if concurrency == 1:
3102
from testtools import ConcurrentTestSuite
3103
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3104
parallel_registry.register('subprocess', subprocess_decorator)
3107
def exclude_tests(exclude_pattern):
3108
"""Return a test suite decorator that excludes tests."""
3109
if exclude_pattern is None:
3110
return identity_decorator
3111
def decorator(suite):
3112
return ExcludeDecorator(suite, exclude_pattern)
3116
def filter_tests(pattern):
3118
return identity_decorator
3119
def decorator(suite):
3120
return FilterTestsDecorator(suite, pattern)
3124
def random_order(random_seed, runner):
3125
"""Return a test suite decorator factory for randomising tests order.
3127
:param random_seed: now, a string which casts to a long, or a long.
3128
:param runner: A test runner with a stream attribute to report on.
3130
if random_seed is None:
3131
return identity_decorator
3132
def decorator(suite):
3133
return RandomDecorator(suite, random_seed, runner.stream)
3137
def tests_first(pattern):
3139
return identity_decorator
3140
def decorator(suite):
3141
return TestFirstDecorator(suite, pattern)
3145
def identity_decorator(suite):
3150
class TestDecorator(TestUtil.TestSuite):
3151
"""A decorator for TestCase/TestSuite objects.
3153
Usually, subclasses should override __iter__(used when flattening test
3154
suites), which we do to filter, reorder, parallelise and so on, run() and
3158
def __init__(self, suite):
3159
TestUtil.TestSuite.__init__(self)
3162
def countTestCases(self):
3165
cases += test.countTestCases()
3172
def run(self, result):
3173
# Use iteration on self, not self._tests, to allow subclasses to hook
3176
if result.shouldStop:
3182
class CountingDecorator(TestDecorator):
3183
"""A decorator which calls result.progress(self.countTestCases)."""
3185
def run(self, result):
3186
progress_method = getattr(result, 'progress', None)
3187
if callable(progress_method):
3188
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3189
return super(CountingDecorator, self).run(result)
3192
class ExcludeDecorator(TestDecorator):
3193
"""A decorator which excludes test matching an exclude pattern."""
3195
def __init__(self, suite, exclude_pattern):
3196
TestDecorator.__init__(self, suite)
3197
self.exclude_pattern = exclude_pattern
3198
self.excluded = False
3202
return iter(self._tests)
3203
self.excluded = True
3204
suite = exclude_tests_by_re(self, self.exclude_pattern)
3206
self.addTests(suite)
3207
return iter(self._tests)
3210
class FilterTestsDecorator(TestDecorator):
3211
"""A decorator which filters tests to those matching a pattern."""
3213
def __init__(self, suite, pattern):
3214
TestDecorator.__init__(self, suite)
3215
self.pattern = pattern
3216
self.filtered = False
3220
return iter(self._tests)
3221
self.filtered = True
3222
suite = filter_suite_by_re(self, self.pattern)
3224
self.addTests(suite)
3225
return iter(self._tests)
3228
class RandomDecorator(TestDecorator):
3229
"""A decorator which randomises the order of its tests."""
3231
def __init__(self, suite, random_seed, stream):
3232
TestDecorator.__init__(self, suite)
3233
self.random_seed = random_seed
3234
self.randomised = False
3235
self.stream = stream
3239
return iter(self._tests)
3240
self.randomised = True
3241
self.stream.write("Randomizing test order using seed %s\n\n" %
3242
(self.actual_seed()))
3243
# Initialise the random number generator.
3244
random.seed(self.actual_seed())
3245
suite = randomize_suite(self)
3247
self.addTests(suite)
3248
return iter(self._tests)
3250
def actual_seed(self):
3251
if self.random_seed == "now":
3252
# We convert the seed to a long to make it reuseable across
3253
# invocations (because the user can reenter it).
3254
self.random_seed = long(time.time())
3256
# Convert the seed to a long if we can
3258
self.random_seed = long(self.random_seed)
3261
return self.random_seed
3264
class TestFirstDecorator(TestDecorator):
3265
"""A decorator which moves named tests to the front."""
3267
def __init__(self, suite, pattern):
3268
TestDecorator.__init__(self, suite)
3269
self.pattern = pattern
3270
self.filtered = False
3274
return iter(self._tests)
3275
self.filtered = True
3276
suites = split_suite_by_re(self, self.pattern)
3278
self.addTests(suites)
3279
return iter(self._tests)
3282
def partition_tests(suite, count):
3283
"""Partition suite into count lists of tests."""
3284
# This just assigns tests in a round-robin fashion. On one hand this
3285
# splits up blocks of related tests that might run faster if they shared
3286
# resources, but on the other it avoids assigning blocks of slow tests to
3287
# just one partition. So the slowest partition shouldn't be much slower
3289
partitions = [list() for i in range(count)]
3290
tests = iter_suite_tests(suite)
3291
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3292
partition.append(test)
3296
def workaround_zealous_crypto_random():
3297
"""Crypto.Random want to help us being secure, but we don't care here.
3299
This workaround some test failure related to the sftp server. Once paramiko
3300
stop using the controversial API in Crypto.Random, we may get rid of it.
3303
from Crypto.Random import atfork
3309
def fork_for_tests(suite):
3310
"""Take suite and start up one runner per CPU by forking()
3312
:return: An iterable of TestCase-like objects which can each have
3313
run(result) called on them to feed tests to result.
3315
concurrency = osutils.local_concurrency()
3317
from subunit import TestProtocolClient, ProtocolTestCase
3318
from subunit.test_results import AutoTimingTestResultDecorator
3319
class TestInOtherProcess(ProtocolTestCase):
3320
# Should be in subunit, I think. RBC.
3321
def __init__(self, stream, pid):
3322
ProtocolTestCase.__init__(self, stream)
3325
def run(self, result):
3327
ProtocolTestCase.run(self, result)
3329
os.waitpid(self.pid, 0)
3331
test_blocks = partition_tests(suite, concurrency)
3332
for process_tests in test_blocks:
3333
process_suite = TestUtil.TestSuite()
3334
process_suite.addTests(process_tests)
3335
c2pread, c2pwrite = os.pipe()
3338
workaround_zealous_crypto_random()
3341
# Leave stderr and stdout open so we can see test noise
3342
# Close stdin so that the child goes away if it decides to
3343
# read from stdin (otherwise its a roulette to see what
3344
# child actually gets keystrokes for pdb etc).
3347
stream = os.fdopen(c2pwrite, 'wb', 1)
3348
subunit_result = AutoTimingTestResultDecorator(
3349
TestProtocolClient(stream))
3350
process_suite.run(subunit_result)
3355
stream = os.fdopen(c2pread, 'rb', 1)
3356
test = TestInOtherProcess(stream, pid)
3361
def reinvoke_for_tests(suite):
3362
"""Take suite and start up one runner per CPU using subprocess().
3364
:return: An iterable of TestCase-like objects which can each have
3365
run(result) called on them to feed tests to result.
3367
concurrency = osutils.local_concurrency()
3369
from subunit import ProtocolTestCase
3370
class TestInSubprocess(ProtocolTestCase):
3371
def __init__(self, process, name):
3372
ProtocolTestCase.__init__(self, process.stdout)
3373
self.process = process
3374
self.process.stdin.close()
3377
def run(self, result):
3379
ProtocolTestCase.run(self, result)
3382
os.unlink(self.name)
3383
# print "pid %d finished" % finished_process
3384
test_blocks = partition_tests(suite, concurrency)
3385
for process_tests in test_blocks:
3386
# ugly; currently reimplement rather than reuses TestCase methods.
3387
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3388
if not os.path.isfile(bzr_path):
3389
# We are probably installed. Assume sys.argv is the right file
3390
bzr_path = sys.argv[0]
3391
bzr_path = [bzr_path]
3392
if sys.platform == "win32":
3393
# if we're on windows, we can't execute the bzr script directly
3394
bzr_path = [sys.executable] + bzr_path
3395
fd, test_list_file_name = tempfile.mkstemp()
3396
test_list_file = os.fdopen(fd, 'wb', 1)
3397
for test in process_tests:
3398
test_list_file.write(test.id() + '\n')
3399
test_list_file.close()
3401
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3403
if '--no-plugins' in sys.argv:
3404
argv.append('--no-plugins')
3405
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3406
# noise on stderr it can interrupt the subunit protocol.
3407
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3408
stdout=subprocess.PIPE,
3409
stderr=subprocess.PIPE,
3411
test = TestInSubprocess(process, test_list_file_name)
3414
os.unlink(test_list_file_name)
3419
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3420
"""Generate profiling data for all activity between start and success.
3422
The profile data is appended to the test's _benchcalls attribute and can
3423
be accessed by the forwarded-to TestResult.
3425
While it might be cleaner do accumulate this in stopTest, addSuccess is
3426
where our existing output support for lsprof is, and this class aims to
3427
fit in with that: while it could be moved it's not necessary to accomplish
3428
test profiling, nor would it be dramatically cleaner.
3431
def startTest(self, test):
3432
self.profiler = bzrlib.lsprof.BzrProfiler()
3433
# Prevent deadlocks in tests that use lsprof: those tests will
3435
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3436
self.profiler.start()
3437
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3439
def addSuccess(self, test):
3440
stats = self.profiler.stop()
3442
calls = test._benchcalls
3443
except AttributeError:
3444
test._benchcalls = []
3445
calls = test._benchcalls
3446
calls.append(((test.id(), "", ""), stats))
3447
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3449
def stopTest(self, test):
3450
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3451
self.profiler = None
3454
# Controlled by "bzr selftest -E=..." option
3455
# Currently supported:
3456
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3457
# preserves any flags supplied at the command line.
3458
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3459
# rather than failing tests. And no longer raise
3460
# LockContention when fctnl locks are not being used
3461
# with proper exclusion rules.
3462
# -Ethreads Will display thread ident at creation/join time to
3463
# help track thread leaks
3464
selftest_debug_flags = set()
3467
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3469
test_suite_factory=None,
3472
matching_tests_first=None,
3475
exclude_pattern=None,
3481
suite_decorators=None,
3485
"""Run the whole test suite under the enhanced runner"""
3486
# XXX: Very ugly way to do this...
3487
# Disable warning about old formats because we don't want it to disturb
3488
# any blackbox tests.
3489
from bzrlib import repository
3490
repository._deprecation_warning_done = True
3492
global default_transport
3493
if transport is None:
3494
transport = default_transport
3495
old_transport = default_transport
3496
default_transport = transport
3497
global selftest_debug_flags
3498
old_debug_flags = selftest_debug_flags
3499
if debug_flags is not None:
3500
selftest_debug_flags = set(debug_flags)
3502
if load_list is None:
3505
keep_only = load_test_id_list(load_list)
3507
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3508
for start in starting_with]
3509
if test_suite_factory is None:
3510
# Reduce loading time by loading modules based on the starting_with
3512
suite = test_suite(keep_only, starting_with)
3514
suite = test_suite_factory()
3516
# But always filter as requested.
3517
suite = filter_suite_by_id_startswith(suite, starting_with)
3518
result_decorators = []
3520
result_decorators.append(ProfileResult)
3521
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3522
stop_on_failure=stop_on_failure,
3523
transport=transport,
3524
lsprof_timed=lsprof_timed,
3525
bench_history=bench_history,
3526
matching_tests_first=matching_tests_first,
3527
list_only=list_only,
3528
random_seed=random_seed,
3529
exclude_pattern=exclude_pattern,
3531
runner_class=runner_class,
3532
suite_decorators=suite_decorators,
3534
result_decorators=result_decorators,
3537
default_transport = old_transport
3538
selftest_debug_flags = old_debug_flags
3541
def load_test_id_list(file_name):
3542
"""Load a test id list from a text file.
3544
The format is one test id by line. No special care is taken to impose
3545
strict rules, these test ids are used to filter the test suite so a test id
3546
that do not match an existing test will do no harm. This allows user to add
3547
comments, leave blank lines, etc.
3551
ftest = open(file_name, 'rt')
3553
if e.errno != errno.ENOENT:
3556
raise errors.NoSuchFile(file_name)
3558
for test_name in ftest.readlines():
3559
test_list.append(test_name.strip())
3564
def suite_matches_id_list(test_suite, id_list):
3565
"""Warns about tests not appearing or appearing more than once.
3567
:param test_suite: A TestSuite object.
3568
:param test_id_list: The list of test ids that should be found in
3571
:return: (absents, duplicates) absents is a list containing the test found
3572
in id_list but not in test_suite, duplicates is a list containing the
3573
test found multiple times in test_suite.
3575
When using a prefined test id list, it may occurs that some tests do not
3576
exist anymore or that some tests use the same id. This function warns the
3577
tester about potential problems in his workflow (test lists are volatile)
3578
or in the test suite itself (using the same id for several tests does not
3579
help to localize defects).
3581
# Build a dict counting id occurrences
3583
for test in iter_suite_tests(test_suite):
3585
tests[id] = tests.get(id, 0) + 1
3590
occurs = tests.get(id, 0)
3592
not_found.append(id)
3594
duplicates.append(id)
3596
return not_found, duplicates
3599
class TestIdList(object):
3600
"""Test id list to filter a test suite.
3602
Relying on the assumption that test ids are built as:
3603
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3604
notation, this class offers methods to :
3605
- avoid building a test suite for modules not refered to in the test list,
3606
- keep only the tests listed from the module test suite.
3609
def __init__(self, test_id_list):
3610
# When a test suite needs to be filtered against us we compare test ids
3611
# for equality, so a simple dict offers a quick and simple solution.
3612
self.tests = dict().fromkeys(test_id_list, True)
3614
# While unittest.TestCase have ids like:
3615
# <module>.<class>.<method>[(<param+)],
3616
# doctest.DocTestCase can have ids like:
3619
# <module>.<function>
3620
# <module>.<class>.<method>
3622
# Since we can't predict a test class from its name only, we settle on
3623
# a simple constraint: a test id always begins with its module name.
3626
for test_id in test_id_list:
3627
parts = test_id.split('.')
3628
mod_name = parts.pop(0)
3629
modules[mod_name] = True
3631
mod_name += '.' + part
3632
modules[mod_name] = True
3633
self.modules = modules
3635
def refers_to(self, module_name):
3636
"""Is there tests for the module or one of its sub modules."""
3637
return self.modules.has_key(module_name)
3639
def includes(self, test_id):
3640
return self.tests.has_key(test_id)
3643
class TestPrefixAliasRegistry(registry.Registry):
3644
"""A registry for test prefix aliases.
3646
This helps implement shorcuts for the --starting-with selftest
3647
option. Overriding existing prefixes is not allowed but not fatal (a
3648
warning will be emitted).
3651
def register(self, key, obj, help=None, info=None,
3652
override_existing=False):
3653
"""See Registry.register.
3655
Trying to override an existing alias causes a warning to be emitted,
3656
not a fatal execption.
3659
super(TestPrefixAliasRegistry, self).register(
3660
key, obj, help=help, info=info, override_existing=False)
3662
actual = self.get(key)
3664
'Test prefix alias %s is already used for %s, ignoring %s'
3665
% (key, actual, obj))
3667
def resolve_alias(self, id_start):
3668
"""Replace the alias by the prefix in the given string.
3670
Using an unknown prefix is an error to help catching typos.
3672
parts = id_start.split('.')
3674
parts[0] = self.get(parts[0])
3676
raise errors.BzrCommandError(
3677
'%s is not a known test prefix alias' % parts[0])
3678
return '.'.join(parts)
3681
test_prefix_alias_registry = TestPrefixAliasRegistry()
3682
"""Registry of test prefix aliases."""
3685
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3686
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3687
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3689
# Obvious highest levels prefixes, feel free to add your own via a plugin
3690
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3691
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3692
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3693
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3694
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3697
def _test_suite_testmod_names():
3698
"""Return the standard list of test module names to test."""
3701
'bzrlib.tests.blackbox',
3702
'bzrlib.tests.commands',
3703
'bzrlib.tests.doc_generate',
3704
'bzrlib.tests.per_branch',
3705
'bzrlib.tests.per_bzrdir',
3706
'bzrlib.tests.per_controldir',
3707
'bzrlib.tests.per_controldir_colo',
3708
'bzrlib.tests.per_foreign_vcs',
3709
'bzrlib.tests.per_interrepository',
3710
'bzrlib.tests.per_intertree',
3711
'bzrlib.tests.per_inventory',
3712
'bzrlib.tests.per_interbranch',
3713
'bzrlib.tests.per_lock',
3714
'bzrlib.tests.per_merger',
3715
'bzrlib.tests.per_transport',
3716
'bzrlib.tests.per_tree',
3717
'bzrlib.tests.per_pack_repository',
3718
'bzrlib.tests.per_repository',
3719
'bzrlib.tests.per_repository_chk',
3720
'bzrlib.tests.per_repository_reference',
3721
'bzrlib.tests.per_repository_vf',
3722
'bzrlib.tests.per_uifactory',
3723
'bzrlib.tests.per_versionedfile',
3724
'bzrlib.tests.per_workingtree',
3725
'bzrlib.tests.test__annotator',
3726
'bzrlib.tests.test__bencode',
3727
'bzrlib.tests.test__btree_serializer',
3728
'bzrlib.tests.test__chk_map',
3729
'bzrlib.tests.test__dirstate_helpers',
3730
'bzrlib.tests.test__groupcompress',
3731
'bzrlib.tests.test__known_graph',
3732
'bzrlib.tests.test__rio',
3733
'bzrlib.tests.test__simple_set',
3734
'bzrlib.tests.test__static_tuple',
3735
'bzrlib.tests.test__walkdirs_win32',
3736
'bzrlib.tests.test_ancestry',
3737
'bzrlib.tests.test_annotate',
3738
'bzrlib.tests.test_api',
3739
'bzrlib.tests.test_atomicfile',
3740
'bzrlib.tests.test_bad_files',
3741
'bzrlib.tests.test_bisect_multi',
3742
'bzrlib.tests.test_branch',
3743
'bzrlib.tests.test_branchbuilder',
3744
'bzrlib.tests.test_btree_index',
3745
'bzrlib.tests.test_bugtracker',
3746
'bzrlib.tests.test_bundle',
3747
'bzrlib.tests.test_bzrdir',
3748
'bzrlib.tests.test__chunks_to_lines',
3749
'bzrlib.tests.test_cache_utf8',
3750
'bzrlib.tests.test_chk_map',
3751
'bzrlib.tests.test_chk_serializer',
3752
'bzrlib.tests.test_chunk_writer',
3753
'bzrlib.tests.test_clean_tree',
3754
'bzrlib.tests.test_cleanup',
3755
'bzrlib.tests.test_cmdline',
3756
'bzrlib.tests.test_commands',
3757
'bzrlib.tests.test_commit',
3758
'bzrlib.tests.test_commit_merge',
3759
'bzrlib.tests.test_config',
3760
'bzrlib.tests.test_conflicts',
3761
'bzrlib.tests.test_controldir',
3762
'bzrlib.tests.test_counted_lock',
3763
'bzrlib.tests.test_crash',
3764
'bzrlib.tests.test_decorators',
3765
'bzrlib.tests.test_delta',
3766
'bzrlib.tests.test_debug',
3767
'bzrlib.tests.test_deprecated_graph',
3768
'bzrlib.tests.test_diff',
3769
'bzrlib.tests.test_directory_service',
3770
'bzrlib.tests.test_dirstate',
3771
'bzrlib.tests.test_email_message',
3772
'bzrlib.tests.test_eol_filters',
3773
'bzrlib.tests.test_errors',
3774
'bzrlib.tests.test_export',
3775
'bzrlib.tests.test_extract',
3776
'bzrlib.tests.test_fetch',
3777
'bzrlib.tests.test_fixtures',
3778
'bzrlib.tests.test_fifo_cache',
3779
'bzrlib.tests.test_filters',
3780
'bzrlib.tests.test_ftp_transport',
3781
'bzrlib.tests.test_foreign',
3782
'bzrlib.tests.test_generate_docs',
3783
'bzrlib.tests.test_generate_ids',
3784
'bzrlib.tests.test_globbing',
3785
'bzrlib.tests.test_gpg',
3786
'bzrlib.tests.test_graph',
3787
'bzrlib.tests.test_groupcompress',
3788
'bzrlib.tests.test_hashcache',
3789
'bzrlib.tests.test_help',
3790
'bzrlib.tests.test_hooks',
3791
'bzrlib.tests.test_http',
3792
'bzrlib.tests.test_http_response',
3793
'bzrlib.tests.test_https_ca_bundle',
3794
'bzrlib.tests.test_identitymap',
3795
'bzrlib.tests.test_ignores',
3796
'bzrlib.tests.test_index',
3797
'bzrlib.tests.test_import_tariff',
3798
'bzrlib.tests.test_info',
3799
'bzrlib.tests.test_inv',
3800
'bzrlib.tests.test_inventory_delta',
3801
'bzrlib.tests.test_knit',
3802
'bzrlib.tests.test_lazy_import',
3803
'bzrlib.tests.test_lazy_regex',
3804
'bzrlib.tests.test_library_state',
3805
'bzrlib.tests.test_lock',
3806
'bzrlib.tests.test_lockable_files',
3807
'bzrlib.tests.test_lockdir',
3808
'bzrlib.tests.test_log',
3809
'bzrlib.tests.test_lru_cache',
3810
'bzrlib.tests.test_lsprof',
3811
'bzrlib.tests.test_mail_client',
3812
'bzrlib.tests.test_matchers',
3813
'bzrlib.tests.test_memorytree',
3814
'bzrlib.tests.test_merge',
3815
'bzrlib.tests.test_merge3',
3816
'bzrlib.tests.test_merge_core',
3817
'bzrlib.tests.test_merge_directive',
3818
'bzrlib.tests.test_mergetools',
3819
'bzrlib.tests.test_missing',
3820
'bzrlib.tests.test_msgeditor',
3821
'bzrlib.tests.test_multiparent',
3822
'bzrlib.tests.test_mutabletree',
3823
'bzrlib.tests.test_nonascii',
3824
'bzrlib.tests.test_options',
3825
'bzrlib.tests.test_osutils',
3826
'bzrlib.tests.test_osutils_encodings',
3827
'bzrlib.tests.test_pack',
3828
'bzrlib.tests.test_patch',
3829
'bzrlib.tests.test_patches',
3830
'bzrlib.tests.test_permissions',
3831
'bzrlib.tests.test_plugins',
3832
'bzrlib.tests.test_progress',
3833
'bzrlib.tests.test_pyutils',
3834
'bzrlib.tests.test_read_bundle',
3835
'bzrlib.tests.test_reconcile',
3836
'bzrlib.tests.test_reconfigure',
3837
'bzrlib.tests.test_registry',
3838
'bzrlib.tests.test_remote',
3839
'bzrlib.tests.test_rename_map',
3840
'bzrlib.tests.test_repository',
3841
'bzrlib.tests.test_revert',
3842
'bzrlib.tests.test_revision',
3843
'bzrlib.tests.test_revisionspec',
3844
'bzrlib.tests.test_revisiontree',
3845
'bzrlib.tests.test_rio',
3846
'bzrlib.tests.test_rules',
3847
'bzrlib.tests.test_sampler',
3848
'bzrlib.tests.test_scenarios',
3849
'bzrlib.tests.test_script',
3850
'bzrlib.tests.test_selftest',
3851
'bzrlib.tests.test_serializer',
3852
'bzrlib.tests.test_setup',
3853
'bzrlib.tests.test_sftp_transport',
3854
'bzrlib.tests.test_shelf',
3855
'bzrlib.tests.test_shelf_ui',
3856
'bzrlib.tests.test_smart',
3857
'bzrlib.tests.test_smart_add',
3858
'bzrlib.tests.test_smart_request',
3859
'bzrlib.tests.test_smart_transport',
3860
'bzrlib.tests.test_smtp_connection',
3861
'bzrlib.tests.test_source',
3862
'bzrlib.tests.test_ssh_transport',
3863
'bzrlib.tests.test_status',
3864
'bzrlib.tests.test_store',
3865
'bzrlib.tests.test_strace',
3866
'bzrlib.tests.test_subsume',
3867
'bzrlib.tests.test_switch',
3868
'bzrlib.tests.test_symbol_versioning',
3869
'bzrlib.tests.test_tag',
3870
'bzrlib.tests.test_test_server',
3871
'bzrlib.tests.test_testament',
3872
'bzrlib.tests.test_textfile',
3873
'bzrlib.tests.test_textmerge',
3874
'bzrlib.tests.test_cethread',
3875
'bzrlib.tests.test_timestamp',
3876
'bzrlib.tests.test_trace',
3877
'bzrlib.tests.test_transactions',
3878
'bzrlib.tests.test_transform',
3879
'bzrlib.tests.test_transport',
3880
'bzrlib.tests.test_transport_log',
3881
'bzrlib.tests.test_tree',
3882
'bzrlib.tests.test_treebuilder',
3883
'bzrlib.tests.test_treeshape',
3884
'bzrlib.tests.test_tsort',
3885
'bzrlib.tests.test_tuned_gzip',
3886
'bzrlib.tests.test_ui',
3887
'bzrlib.tests.test_uncommit',
3888
'bzrlib.tests.test_upgrade',
3889
'bzrlib.tests.test_upgrade_stacked',
3890
'bzrlib.tests.test_urlutils',
3891
'bzrlib.tests.test_version',
3892
'bzrlib.tests.test_version_info',
3893
'bzrlib.tests.test_versionedfile',
3894
'bzrlib.tests.test_weave',
3895
'bzrlib.tests.test_whitebox',
3896
'bzrlib.tests.test_win32utils',
3897
'bzrlib.tests.test_workingtree',
3898
'bzrlib.tests.test_workingtree_4',
3899
'bzrlib.tests.test_wsgi',
3900
'bzrlib.tests.test_xml',
3904
def _test_suite_modules_to_doctest():
3905
"""Return the list of modules to doctest."""
3907
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3911
'bzrlib.branchbuilder',
3912
'bzrlib.decorators',
3914
'bzrlib.iterablefile',
3919
'bzrlib.symbol_versioning',
3921
'bzrlib.tests.fixtures',
3923
'bzrlib.transport.http',
3924
'bzrlib.version_info_formats.format_custom',
3928
def test_suite(keep_only=None, starting_with=None):
3929
"""Build and return TestSuite for the whole of bzrlib.
3931
:param keep_only: A list of test ids limiting the suite returned.
3933
:param starting_with: An id limiting the suite returned to the tests
3936
This function can be replaced if you need to change the default test
3937
suite on a global basis, but it is not encouraged.
3940
loader = TestUtil.TestLoader()
3942
if keep_only is not None:
3943
id_filter = TestIdList(keep_only)
3945
# We take precedence over keep_only because *at loading time* using
3946
# both options means we will load less tests for the same final result.
3947
def interesting_module(name):
3948
for start in starting_with:
3950
# Either the module name starts with the specified string
3951
name.startswith(start)
3952
# or it may contain tests starting with the specified string
3953
or start.startswith(name)
3957
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3959
elif keep_only is not None:
3960
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3961
def interesting_module(name):
3962
return id_filter.refers_to(name)
3965
loader = TestUtil.TestLoader()
3966
def interesting_module(name):
3967
# No filtering, all modules are interesting
3970
suite = loader.suiteClass()
3972
# modules building their suite with loadTestsFromModuleNames
3973
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3975
for mod in _test_suite_modules_to_doctest():
3976
if not interesting_module(mod):
3977
# No tests to keep here, move along
3980
# note that this really does mean "report only" -- doctest
3981
# still runs the rest of the examples
3982
doc_suite = IsolatedDocTestSuite(
3983
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3984
except ValueError, e:
3985
print '**failed to get doctest for: %s\n%s' % (mod, e)
3987
if len(doc_suite._tests) == 0:
3988
raise errors.BzrError("no doctests found in %s" % (mod,))
3989
suite.addTest(doc_suite)
3991
default_encoding = sys.getdefaultencoding()
3992
for name, plugin in _mod_plugin.plugins().items():
3993
if not interesting_module(plugin.module.__name__):
3995
plugin_suite = plugin.test_suite()
3996
# We used to catch ImportError here and turn it into just a warning,
3997
# but really if you don't have --no-plugins this should be a failure.
3998
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3999
if plugin_suite is None:
4000
plugin_suite = plugin.load_plugin_tests(loader)
4001
if plugin_suite is not None:
4002
suite.addTest(plugin_suite)
4003
if default_encoding != sys.getdefaultencoding():
4005
'Plugin "%s" tried to reset default encoding to: %s', name,
4006
sys.getdefaultencoding())
4008
sys.setdefaultencoding(default_encoding)
4010
if keep_only is not None:
4011
# Now that the referred modules have loaded their tests, keep only the
4013
suite = filter_suite_by_id_list(suite, id_filter)
4014
# Do some sanity checks on the id_list filtering
4015
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4017
# The tester has used both keep_only and starting_with, so he is
4018
# already aware that some tests are excluded from the list, there
4019
# is no need to tell him which.
4022
# Some tests mentioned in the list are not in the test suite. The
4023
# list may be out of date, report to the tester.
4024
for id in not_found:
4025
trace.warning('"%s" not found in the test suite', id)
4026
for id in duplicates:
4027
trace.warning('"%s" is used as an id by several tests', id)
4032
def multiply_scenarios(*scenarios):
4033
"""Multiply two or more iterables of scenarios.
4035
It is safe to pass scenario generators or iterators.
4037
:returns: A list of compound scenarios: the cross-product of all
4038
scenarios, with the names concatenated and the parameters
4041
return reduce(_multiply_two_scenarios, map(list, scenarios))
4044
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4045
"""Multiply two sets of scenarios.
4047
:returns: the cartesian product of the two sets of scenarios, that is
4048
a scenario for every possible combination of a left scenario and a
4052
('%s,%s' % (left_name, right_name),
4053
dict(left_dict.items() + right_dict.items()))
4054
for left_name, left_dict in scenarios_left
4055
for right_name, right_dict in scenarios_right]
4058
def multiply_tests(tests, scenarios, result):
4059
"""Multiply tests_list by scenarios into result.
4061
This is the core workhorse for test parameterisation.
4063
Typically the load_tests() method for a per-implementation test suite will
4064
call multiply_tests and return the result.
4066
:param tests: The tests to parameterise.
4067
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4068
scenario_param_dict).
4069
:param result: A TestSuite to add created tests to.
4071
This returns the passed in result TestSuite with the cross product of all
4072
the tests repeated once for each scenario. Each test is adapted by adding
4073
the scenario name at the end of its id(), and updating the test object's
4074
__dict__ with the scenario_param_dict.
4076
>>> import bzrlib.tests.test_sampler
4077
>>> r = multiply_tests(
4078
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4079
... [('one', dict(param=1)),
4080
... ('two', dict(param=2))],
4081
... TestUtil.TestSuite())
4082
>>> tests = list(iter_suite_tests(r))
4086
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4092
for test in iter_suite_tests(tests):
4093
apply_scenarios(test, scenarios, result)
4097
def apply_scenarios(test, scenarios, result):
4098
"""Apply the scenarios in scenarios to test and add to result.
4100
:param test: The test to apply scenarios to.
4101
:param scenarios: An iterable of scenarios to apply to test.
4103
:seealso: apply_scenario
4105
for scenario in scenarios:
4106
result.addTest(apply_scenario(test, scenario))
4110
def apply_scenario(test, scenario):
4111
"""Copy test and apply scenario to it.
4113
:param test: A test to adapt.
4114
:param scenario: A tuple describing the scenarion.
4115
The first element of the tuple is the new test id.
4116
The second element is a dict containing attributes to set on the
4118
:return: The adapted test.
4120
new_id = "%s(%s)" % (test.id(), scenario[0])
4121
new_test = clone_test(test, new_id)
4122
for name, value in scenario[1].items():
4123
setattr(new_test, name, value)
4127
def clone_test(test, new_id):
4128
"""Clone a test giving it a new id.
4130
:param test: The test to clone.
4131
:param new_id: The id to assign to it.
4132
:return: The new test.
4134
new_test = copy.copy(test)
4135
new_test.id = lambda: new_id
4136
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4137
# causes cloned tests to share the 'details' dict. This makes it hard to
4138
# read the test output for parameterized tests, because tracebacks will be
4139
# associated with irrelevant tests.
4141
details = new_test._TestCase__details
4142
except AttributeError:
4143
# must be a different version of testtools than expected. Do nothing.
4146
# Reset the '__details' dict.
4147
new_test._TestCase__details = {}
4151
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4153
"""Helper for permutating tests against an extension module.
4155
This is meant to be used inside a modules 'load_tests()' function. It will
4156
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4157
against both implementations. Setting 'test.module' to the appropriate
4158
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4160
:param standard_tests: A test suite to permute
4161
:param loader: A TestLoader
4162
:param py_module_name: The python path to a python module that can always
4163
be loaded, and will be considered the 'python' implementation. (eg
4164
'bzrlib._chk_map_py')
4165
:param ext_module_name: The python path to an extension module. If the
4166
module cannot be loaded, a single test will be added, which notes that
4167
the module is not available. If it can be loaded, all standard_tests
4168
will be run against that module.
4169
:return: (suite, feature) suite is a test-suite that has all the permuted
4170
tests. feature is the Feature object that can be used to determine if
4171
the module is available.
4174
py_module = pyutils.get_named_object(py_module_name)
4176
('python', {'module': py_module}),
4178
suite = loader.suiteClass()
4179
feature = ModuleAvailableFeature(ext_module_name)
4180
if feature.available():
4181
scenarios.append(('C', {'module': feature.module}))
4183
# the compiled module isn't available, so we add a failing test
4184
class FailWithoutFeature(TestCase):
4185
def test_fail(self):
4186
self.requireFeature(feature)
4187
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4188
result = multiply_tests(standard_tests, scenarios, suite)
4189
return result, feature
4192
def _rmtree_temp_dir(dirname, test_id=None):
4193
# If LANG=C we probably have created some bogus paths
4194
# which rmtree(unicode) will fail to delete
4195
# so make sure we are using rmtree(str) to delete everything
4196
# except on win32, where rmtree(str) will fail
4197
# since it doesn't have the property of byte-stream paths
4198
# (they are either ascii or mbcs)
4199
if sys.platform == 'win32':
4200
# make sure we are using the unicode win32 api
4201
dirname = unicode(dirname)
4203
dirname = dirname.encode(sys.getfilesystemencoding())
4205
osutils.rmtree(dirname)
4207
# We don't want to fail here because some useful display will be lost
4208
# otherwise. Polluting the tmp dir is bad, but not giving all the
4209
# possible info to the test runner is even worse.
4211
ui.ui_factory.clear_term()
4212
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4213
# Ugly, but the last thing we want here is fail, so bear with it.
4214
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4215
).encode('ascii', 'replace')
4216
sys.stderr.write('Unable to remove testing dir %s\n%s'
4217
% (os.path.basename(dirname), printable_e))
4220
class Feature(object):
4221
"""An operating system Feature."""
4224
self._available = None
4226
def available(self):
4227
"""Is the feature available?
4229
:return: True if the feature is available.
4231
if self._available is None:
4232
self._available = self._probe()
4233
return self._available
4236
"""Implement this method in concrete features.
4238
:return: True if the feature is available.
4240
raise NotImplementedError
4243
if getattr(self, 'feature_name', None):
4244
return self.feature_name()
4245
return self.__class__.__name__
4248
class _SymlinkFeature(Feature):
4251
return osutils.has_symlinks()
4253
def feature_name(self):
4256
SymlinkFeature = _SymlinkFeature()
4259
class _HardlinkFeature(Feature):
4262
return osutils.has_hardlinks()
4264
def feature_name(self):
4267
HardlinkFeature = _HardlinkFeature()
4270
class _OsFifoFeature(Feature):
4273
return getattr(os, 'mkfifo', None)
4275
def feature_name(self):
4276
return 'filesystem fifos'
4278
OsFifoFeature = _OsFifoFeature()
4281
class _UnicodeFilenameFeature(Feature):
4282
"""Does the filesystem support Unicode filenames?"""
4286
# Check for character combinations unlikely to be covered by any
4287
# single non-unicode encoding. We use the characters
4288
# - greek small letter alpha (U+03B1) and
4289
# - braille pattern dots-123456 (U+283F).
4290
os.stat(u'\u03b1\u283f')
4291
except UnicodeEncodeError:
4293
except (IOError, OSError):
4294
# The filesystem allows the Unicode filename but the file doesn't
4298
# The filesystem allows the Unicode filename and the file exists,
4302
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4305
class _CompatabilityThunkFeature(Feature):
4306
"""This feature is just a thunk to another feature.
4308
It issues a deprecation warning if it is accessed, to let you know that you
4309
should really use a different feature.
4312
def __init__(self, dep_version, module, name,
4313
replacement_name, replacement_module=None):
4314
super(_CompatabilityThunkFeature, self).__init__()
4315
self._module = module
4316
if replacement_module is None:
4317
replacement_module = module
4318
self._replacement_module = replacement_module
4320
self._replacement_name = replacement_name
4321
self._dep_version = dep_version
4322
self._feature = None
4325
if self._feature is None:
4326
depr_msg = self._dep_version % ('%s.%s'
4327
% (self._module, self._name))
4328
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4329
self._replacement_name)
4330
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4331
# Import the new feature and use it as a replacement for the
4333
self._feature = pyutils.get_named_object(
4334
self._replacement_module, self._replacement_name)
4338
return self._feature._probe()
4341
class ModuleAvailableFeature(Feature):
4342
"""This is a feature than describes a module we want to be available.
4344
Declare the name of the module in __init__(), and then after probing, the
4345
module will be available as 'self.module'.
4347
:ivar module: The module if it is available, else None.
4350
def __init__(self, module_name):
4351
super(ModuleAvailableFeature, self).__init__()
4352
self.module_name = module_name
4356
self._module = __import__(self.module_name, {}, {}, [''])
4358
except (ImportError, ImportWarning):
4363
if self.available(): # Make sure the probe has been done
4367
def feature_name(self):
4368
return self.module_name
4371
def probe_unicode_in_user_encoding():
4372
"""Try to encode several unicode strings to use in unicode-aware tests.
4373
Return first successfull match.
4375
:return: (unicode value, encoded plain string value) or (None, None)
4377
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4378
for uni_val in possible_vals:
4380
str_val = uni_val.encode(osutils.get_user_encoding())
4381
except UnicodeEncodeError:
4382
# Try a different character
4385
return uni_val, str_val
4389
def probe_bad_non_ascii(encoding):
4390
"""Try to find [bad] character with code [128..255]
4391
that cannot be decoded to unicode in some encoding.
4392
Return None if all non-ascii characters is valid
4395
for i in xrange(128, 256):
4398
char.decode(encoding)
4399
except UnicodeDecodeError:
4404
class _HTTPSServerFeature(Feature):
4405
"""Some tests want an https Server, check if one is available.
4407
Right now, the only way this is available is under python2.6 which provides
4418
def feature_name(self):
4419
return 'HTTPSServer'
4422
HTTPSServerFeature = _HTTPSServerFeature()
4425
class _UnicodeFilename(Feature):
4426
"""Does the filesystem support Unicode filenames?"""
4431
except UnicodeEncodeError:
4433
except (IOError, OSError):
4434
# The filesystem allows the Unicode filename but the file doesn't
4438
# The filesystem allows the Unicode filename and the file exists,
4442
UnicodeFilename = _UnicodeFilename()
4445
class _ByteStringNamedFilesystem(Feature):
4446
"""Is the filesystem based on bytes?"""
4449
if os.name == "posix":
4453
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
4456
class _UTF8Filesystem(Feature):
4457
"""Is the filesystem UTF-8?"""
4460
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4464
UTF8Filesystem = _UTF8Filesystem()
4467
class _BreakinFeature(Feature):
4468
"""Does this platform support the breakin feature?"""
4471
from bzrlib import breakin
4472
if breakin.determine_signal() is None:
4474
if sys.platform == 'win32':
4475
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4476
# We trigger SIGBREAK via a Console api so we need ctypes to
4477
# access the function
4484
def feature_name(self):
4485
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4488
BreakinFeature = _BreakinFeature()
4491
class _CaseInsCasePresFilenameFeature(Feature):
4492
"""Is the file-system case insensitive, but case-preserving?"""
4495
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4497
# first check truly case-preserving for created files, then check
4498
# case insensitive when opening existing files.
4499
name = osutils.normpath(name)
4500
base, rel = osutils.split(name)
4501
found_rel = osutils.canonical_relpath(base, name)
4502
return (found_rel == rel
4503
and os.path.isfile(name.upper())
4504
and os.path.isfile(name.lower()))
4509
def feature_name(self):
4510
return "case-insensitive case-preserving filesystem"
4512
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4515
class _CaseInsensitiveFilesystemFeature(Feature):
4516
"""Check if underlying filesystem is case-insensitive but *not* case
4519
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4520
# more likely to be case preserving, so this case is rare.
4523
if CaseInsCasePresFilenameFeature.available():
4526
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4527
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4528
TestCaseWithMemoryTransport.TEST_ROOT = root
4530
root = TestCaseWithMemoryTransport.TEST_ROOT
4531
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4533
name_a = osutils.pathjoin(tdir, 'a')
4534
name_A = osutils.pathjoin(tdir, 'A')
4536
result = osutils.isdir(name_A)
4537
_rmtree_temp_dir(tdir)
4540
def feature_name(self):
4541
return 'case-insensitive filesystem'
4543
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4546
class _CaseSensitiveFilesystemFeature(Feature):
4549
if CaseInsCasePresFilenameFeature.available():
4551
elif CaseInsensitiveFilesystemFeature.available():
4556
def feature_name(self):
4557
return 'case-sensitive filesystem'
4559
# new coding style is for feature instances to be lowercase
4560
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4563
# Only define SubUnitBzrRunner if subunit is available.
4565
from subunit import TestProtocolClient
4566
from subunit.test_results import AutoTimingTestResultDecorator
4567
class SubUnitBzrProtocolClient(TestProtocolClient):
4569
def addSuccess(self, test, details=None):
4570
# The subunit client always includes the details in the subunit
4571
# stream, but we don't want to include it in ours.
4572
if details is not None and 'log' in details:
4574
return super(SubUnitBzrProtocolClient, self).addSuccess(
4577
class SubUnitBzrRunner(TextTestRunner):
4578
def run(self, test):
4579
result = AutoTimingTestResultDecorator(
4580
SubUnitBzrProtocolClient(self.stream))
4586
class _PosixPermissionsFeature(Feature):
4590
# create temporary file and check if specified perms are maintained.
4593
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4594
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4597
os.chmod(name, write_perms)
4599
read_perms = os.stat(name).st_mode & 0777
4601
return (write_perms == read_perms)
4603
return (os.name == 'posix') and has_perms()
4605
def feature_name(self):
4606
return 'POSIX permissions support'
4608
posix_permissions_feature = _PosixPermissionsFeature()
added
removed
bzrlib/tests/__init__.py
