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
# NOTE: Some classes in here use camelCaseNaming() rather than
20
# underscore_naming(). That's for consistency with unittest; it's not the
21
# general style of bzrlib. Please continue that consistency when adding e.g.
22
# new assertFoo() methods.
27
from cStringIO import StringIO
50
# nb: check this before importing anything else from within it
51
_testtools_version = getattr(testtools, '__version__', ())
52
if _testtools_version < (0, 9, 5):
53
raise ImportError("need at least testtools 0.9.5: %s is %r"
54
% (testtools.__file__, _testtools_version))
55
from testtools import content
62
commands as _mod_commands,
72
plugin as _mod_plugin,
79
transport as _mod_transport,
85
# lsprof not available
87
from bzrlib.smart import client, request
88
from bzrlib.transport import (
92
from bzrlib.symbol_versioning import (
96
from bzrlib.tests import (
101
from bzrlib.ui import NullProgressView
102
from bzrlib.ui.text import TextUIFactory
104
# Mark this python module as being part of the implementation
105
# of unittest: this gives us better tracebacks where the last
106
# shown frame is the test code, not our assertXYZ.
109
default_transport = test_server.LocalURLServer
112
_unitialized_attr = object()
113
"""A sentinel needed to act as a default value in a method signature."""
116
# Subunit result codes, defined here to prevent a hard dependency on subunit.
120
# These are intentionally brought into this namespace. That way plugins, etc
121
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
122
TestSuite = TestUtil.TestSuite
123
TestLoader = TestUtil.TestLoader
125
# Tests should run in a clean and clearly defined environment. The goal is to
126
# keep them isolated from the running environment as mush as possible. The test
127
# framework ensures the variables defined below are set (or deleted if the
128
# value is None) before a test is run and reset to their original value after
129
# the test is run. Generally if some code depends on an environment variable,
130
# the tests should start without this variable in the environment. There are a
131
# few exceptions but you shouldn't violate this rule lightly.
135
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
136
# tests do check our impls match APPDATA
137
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
141
'BZREMAIL': None, # may still be present in the environment
142
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
143
'BZR_PROGRESS_BAR': None,
144
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
145
# as a base class instead of TestCaseInTempDir. Tests inheriting from
146
# TestCase should not use disk resources, BZR_LOG is one.
147
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
148
'BZR_PLUGIN_PATH': None,
149
'BZR_DISABLE_PLUGINS': None,
150
'BZR_PLUGINS_AT': None,
151
'BZR_CONCURRENCY': None,
152
# Make sure that any text ui tests are consistent regardless of
153
# the environment the test case is run in; you may want tests that
154
# test other combinations. 'dumb' is a reasonable guess for tests
155
# going to a pipe or a StringIO.
161
'SSH_AUTH_SOCK': None,
171
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
172
# least. If you do (care), please update this comment
176
'BZR_REMOTE_PATH': None,
177
# Generally speaking, we don't want apport reporting on crashes in
178
# the test envirnoment unless we're specifically testing apport,
179
# so that it doesn't leak into the real system environment. We
180
# use an env var so it propagates to subprocesses.
181
'APPORT_DISABLE': '1',
185
def override_os_environ(test, env=None):
186
"""Modify os.environ keeping a copy.
188
:param test: A test instance
190
:param env: A dict containing variable definitions to be installed
193
env = isolated_environ
194
test._original_os_environ = dict([(var, value)
195
for var, value in os.environ.iteritems()])
196
for var, value in env.iteritems():
197
osutils.set_or_unset_env(var, value)
198
if var not in test._original_os_environ:
199
# The var is new, add it with a value of None, so
200
# restore_os_environ will delete it
201
test._original_os_environ[var] = None
204
def restore_os_environ(test):
205
"""Restore os.environ to its original state.
207
:param test: A test instance previously passed to override_os_environ.
209
for var, value in test._original_os_environ.iteritems():
210
# Restore the original value (or delete it if the value has been set to
211
# None in override_os_environ).
212
osutils.set_or_unset_env(var, value)
215
class ExtendedTestResult(testtools.TextTestResult):
216
"""Accepts, reports and accumulates the results of running tests.
218
Compared to the unittest version this class adds support for
219
profiling, benchmarking, stopping as soon as a test fails, and
220
skipping tests. There are further-specialized subclasses for
221
different types of display.
223
When a test finishes, in whatever way, it calls one of the addSuccess,
224
addFailure or addError classes. These in turn may redirect to a more
225
specific case for the special test results supported by our extended
228
Note that just one of these objects is fed the results from many tests.
233
def __init__(self, stream, descriptions, verbosity,
237
"""Construct new TestResult.
239
:param bench_history: Optionally, a writable file object to accumulate
242
testtools.TextTestResult.__init__(self, stream)
243
if bench_history is not None:
244
from bzrlib.version import _get_bzr_source_tree
245
src_tree = _get_bzr_source_tree()
248
revision_id = src_tree.get_parent_ids()[0]
250
# XXX: if this is a brand new tree, do the same as if there
254
# XXX: If there's no branch, what should we do?
256
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
257
self._bench_history = bench_history
258
self.ui = ui.ui_factory
261
self.failure_count = 0
262
self.known_failure_count = 0
264
self.not_applicable_count = 0
265
self.unsupported = {}
267
self._overall_start_time = time.time()
268
self._strict = strict
269
self._first_thread_leaker_id = None
270
self._tests_leaking_threads_count = 0
271
self._traceback_from_test = None
273
def stopTestRun(self):
276
stopTime = time.time()
277
timeTaken = stopTime - self.startTime
278
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
279
# the parent class method is similar have to duplicate
280
self._show_list('ERROR', self.errors)
281
self._show_list('FAIL', self.failures)
282
self.stream.write(self.sep2)
283
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
284
run, run != 1 and "s" or "", timeTaken))
285
if not self.wasSuccessful():
286
self.stream.write("FAILED (")
287
failed, errored = map(len, (self.failures, self.errors))
289
self.stream.write("failures=%d" % failed)
291
if failed: self.stream.write(", ")
292
self.stream.write("errors=%d" % errored)
293
if self.known_failure_count:
294
if failed or errored: self.stream.write(", ")
295
self.stream.write("known_failure_count=%d" %
296
self.known_failure_count)
297
self.stream.write(")\n")
299
if self.known_failure_count:
300
self.stream.write("OK (known_failures=%d)\n" %
301
self.known_failure_count)
303
self.stream.write("OK\n")
304
if self.skip_count > 0:
305
skipped = self.skip_count
306
self.stream.write('%d test%s skipped\n' %
307
(skipped, skipped != 1 and "s" or ""))
309
for feature, count in sorted(self.unsupported.items()):
310
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
313
ok = self.wasStrictlySuccessful()
315
ok = self.wasSuccessful()
316
if self._first_thread_leaker_id:
318
'%s is leaking threads among %d leaking tests.\n' % (
319
self._first_thread_leaker_id,
320
self._tests_leaking_threads_count))
321
# We don't report the main thread as an active one.
323
'%d non-main threads were left active in the end.\n'
324
% (len(self._active_threads) - 1))
326
def getDescription(self, test):
329
def _extractBenchmarkTime(self, testCase, details=None):
330
"""Add a benchmark time for the current test case."""
331
if details and 'benchtime' in details:
332
return float(''.join(details['benchtime'].iter_bytes()))
333
return getattr(testCase, "_benchtime", None)
335
def _elapsedTestTimeString(self):
336
"""Return a time string for the overall time the current test has taken."""
337
return self._formatTime(self._delta_to_float(
338
self._now() - self._start_datetime))
340
def _testTimeString(self, testCase):
341
benchmark_time = self._extractBenchmarkTime(testCase)
342
if benchmark_time is not None:
343
return self._formatTime(benchmark_time) + "*"
345
return self._elapsedTestTimeString()
347
def _formatTime(self, seconds):
348
"""Format seconds as milliseconds with leading spaces."""
349
# some benchmarks can take thousands of seconds to run, so we need 8
351
return "%8dms" % (1000 * seconds)
353
def _shortened_test_description(self, test):
355
what = re.sub(r'^bzrlib\.tests\.', '', what)
358
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
359
# multiple times in a row, because the handler is added for
360
# each test but the container list is shared between cases.
361
# See lp:498869 lp:625574 and lp:637725 for background.
362
def _record_traceback_from_test(self, exc_info):
363
"""Store the traceback from passed exc_info tuple till"""
364
self._traceback_from_test = exc_info[2]
366
def startTest(self, test):
367
super(ExtendedTestResult, self).startTest(test)
371
self.report_test_start(test)
372
test.number = self.count
373
self._recordTestStartTime()
374
# Make testtools cases give us the real traceback on failure
375
addOnException = getattr(test, "addOnException", None)
376
if addOnException is not None:
377
addOnException(self._record_traceback_from_test)
378
# Only check for thread leaks on bzrlib derived test cases
379
if isinstance(test, TestCase):
380
test.addCleanup(self._check_leaked_threads, test)
382
def stopTest(self, test):
383
super(ExtendedTestResult, self).stopTest(test)
384
# Manually break cycles, means touching various private things but hey
385
getDetails = getattr(test, "getDetails", None)
386
if getDetails is not None:
388
# Clear _type_equality_funcs to try to stop TestCase instances
389
# from wasting memory. 'clear' is not available in all Python
390
# versions (bug 809048)
391
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
392
if type_equality_funcs is not None:
393
tef_clear = getattr(type_equality_funcs, "clear", None)
394
if tef_clear is None:
395
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
396
if tef_instance_dict is not None:
397
tef_clear = tef_instance_dict.clear
398
if tef_clear is not None:
400
self._traceback_from_test = None
402
def startTests(self):
403
self.report_tests_starting()
404
self._active_threads = threading.enumerate()
406
def _check_leaked_threads(self, test):
407
"""See if any threads have leaked since last call
409
A sample of live threads is stored in the _active_threads attribute,
410
when this method runs it compares the current live threads and any not
411
in the previous sample are treated as having leaked.
413
now_active_threads = set(threading.enumerate())
414
threads_leaked = now_active_threads.difference(self._active_threads)
416
self._report_thread_leak(test, threads_leaked, now_active_threads)
417
self._tests_leaking_threads_count += 1
418
if self._first_thread_leaker_id is None:
419
self._first_thread_leaker_id = test.id()
420
self._active_threads = now_active_threads
422
def _recordTestStartTime(self):
423
"""Record that a test has started."""
424
self._start_datetime = self._now()
426
def addError(self, test, err):
427
"""Tell result that test finished with an error.
429
Called from the TestCase run() method when the test
430
fails with an unexpected error.
432
self._post_mortem(self._traceback_from_test)
433
super(ExtendedTestResult, self).addError(test, err)
434
self.error_count += 1
435
self.report_error(test, err)
439
def addFailure(self, test, err):
440
"""Tell result that test failed.
442
Called from the TestCase run() method when the test
443
fails because e.g. an assert() method failed.
445
self._post_mortem(self._traceback_from_test)
446
super(ExtendedTestResult, self).addFailure(test, err)
447
self.failure_count += 1
448
self.report_failure(test, err)
452
def addSuccess(self, test, details=None):
453
"""Tell result that test completed successfully.
455
Called from the TestCase run()
457
if self._bench_history is not None:
458
benchmark_time = self._extractBenchmarkTime(test, details)
459
if benchmark_time is not None:
460
self._bench_history.write("%s %s\n" % (
461
self._formatTime(benchmark_time),
463
self.report_success(test)
464
super(ExtendedTestResult, self).addSuccess(test)
465
test._log_contents = ''
467
def addExpectedFailure(self, test, err):
468
self.known_failure_count += 1
469
self.report_known_failure(test, err)
471
def addUnexpectedSuccess(self, test, details=None):
472
"""Tell result the test unexpectedly passed, counting as a failure
474
When the minimum version of testtools required becomes 0.9.8 this
475
can be updated to use the new handling there.
477
super(ExtendedTestResult, self).addFailure(test, details=details)
478
self.failure_count += 1
479
self.report_unexpected_success(test,
480
"".join(details["reason"].iter_text()))
484
def addNotSupported(self, test, feature):
485
"""The test will not be run because of a missing feature.
487
# this can be called in two different ways: it may be that the
488
# test started running, and then raised (through requireFeature)
489
# UnavailableFeature. Alternatively this method can be called
490
# while probing for features before running the test code proper; in
491
# that case we will see startTest and stopTest, but the test will
492
# never actually run.
493
self.unsupported.setdefault(str(feature), 0)
494
self.unsupported[str(feature)] += 1
495
self.report_unsupported(test, feature)
497
def addSkip(self, test, reason):
498
"""A test has not run for 'reason'."""
500
self.report_skip(test, reason)
502
def addNotApplicable(self, test, reason):
503
self.not_applicable_count += 1
504
self.report_not_applicable(test, reason)
506
def _post_mortem(self, tb=None):
507
"""Start a PDB post mortem session."""
508
if os.environ.get('BZR_TEST_PDB', None):
512
def progress(self, offset, whence):
513
"""The test is adjusting the count of tests to run."""
514
if whence == SUBUNIT_SEEK_SET:
515
self.num_tests = offset
516
elif whence == SUBUNIT_SEEK_CUR:
517
self.num_tests += offset
519
raise errors.BzrError("Unknown whence %r" % whence)
521
def report_tests_starting(self):
522
"""Display information before the test run begins"""
523
if getattr(sys, 'frozen', None) is None:
524
bzr_path = osutils.realpath(sys.argv[0])
526
bzr_path = sys.executable
528
'bzr selftest: %s\n' % (bzr_path,))
531
bzrlib.__path__[0],))
533
' bzr-%s python-%s %s\n' % (
534
bzrlib.version_string,
535
bzrlib._format_version_tuple(sys.version_info),
536
platform.platform(aliased=1),
538
self.stream.write('\n')
540
def report_test_start(self, test):
541
"""Display information on the test just about to be run"""
543
def _report_thread_leak(self, test, leaked_threads, active_threads):
544
"""Display information on a test that leaked one or more threads"""
545
# GZ 2010-09-09: A leak summary reported separately from the general
546
# thread debugging would be nice. Tests under subunit
547
# need something not using stream, perhaps adding a
548
# testtools details object would be fitting.
549
if 'threads' in selftest_debug_flags:
550
self.stream.write('%s is leaking, active is now %d\n' %
551
(test.id(), len(active_threads)))
553
def startTestRun(self):
554
self.startTime = time.time()
556
def report_success(self, test):
559
def wasStrictlySuccessful(self):
560
if self.unsupported or self.known_failure_count:
562
return self.wasSuccessful()
565
class TextTestResult(ExtendedTestResult):
566
"""Displays progress and results of tests in text form"""
568
def __init__(self, stream, descriptions, verbosity,
573
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
574
bench_history, strict)
575
# We no longer pass them around, but just rely on the UIFactory stack
578
warnings.warn("Passing pb to TextTestResult is deprecated")
579
self.pb = self.ui.nested_progress_bar()
580
self.pb.show_pct = False
581
self.pb.show_spinner = False
582
self.pb.show_eta = False,
583
self.pb.show_count = False
584
self.pb.show_bar = False
585
self.pb.update_latency = 0
586
self.pb.show_transport_activity = False
588
def stopTestRun(self):
589
# called when the tests that are going to run have run
592
super(TextTestResult, self).stopTestRun()
594
def report_tests_starting(self):
595
super(TextTestResult, self).report_tests_starting()
596
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
598
def _progress_prefix_text(self):
599
# the longer this text, the less space we have to show the test
601
a = '[%d' % self.count # total that have been run
602
# tests skipped as known not to be relevant are not important enough
604
## if self.skip_count:
605
## a += ', %d skip' % self.skip_count
606
## if self.known_failure_count:
607
## a += '+%dX' % self.known_failure_count
609
a +='/%d' % self.num_tests
611
runtime = time.time() - self._overall_start_time
613
a += '%dm%ds' % (runtime / 60, runtime % 60)
616
total_fail_count = self.error_count + self.failure_count
618
a += ', %d failed' % total_fail_count
619
# if self.unsupported:
620
# a += ', %d missing' % len(self.unsupported)
624
def report_test_start(self, test):
626
self._progress_prefix_text()
628
+ self._shortened_test_description(test))
630
def _test_description(self, test):
631
return self._shortened_test_description(test)
633
def report_error(self, test, err):
634
self.stream.write('ERROR: %s\n %s\n' % (
635
self._test_description(test),
639
def report_failure(self, test, err):
640
self.stream.write('FAIL: %s\n %s\n' % (
641
self._test_description(test),
645
def report_known_failure(self, test, err):
648
def report_unexpected_success(self, test, reason):
649
self.stream.write('FAIL: %s\n %s: %s\n' % (
650
self._test_description(test),
651
"Unexpected success. Should have failed",
655
def report_skip(self, test, reason):
658
def report_not_applicable(self, test, reason):
661
def report_unsupported(self, test, feature):
662
"""test cannot be run because feature is missing."""
665
class VerboseTestResult(ExtendedTestResult):
666
"""Produce long output, with one line per test run plus times"""
668
def _ellipsize_to_right(self, a_string, final_width):
669
"""Truncate and pad a string, keeping the right hand side"""
670
if len(a_string) > final_width:
671
result = '...' + a_string[3-final_width:]
674
return result.ljust(final_width)
676
def report_tests_starting(self):
677
self.stream.write('running %d tests...\n' % self.num_tests)
678
super(VerboseTestResult, self).report_tests_starting()
680
def report_test_start(self, test):
681
name = self._shortened_test_description(test)
682
width = osutils.terminal_width()
683
if width is not None:
684
# width needs space for 6 char status, plus 1 for slash, plus an
685
# 11-char time string, plus a trailing blank
686
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
688
self.stream.write(self._ellipsize_to_right(name, width-18))
690
self.stream.write(name)
693
def _error_summary(self, err):
695
return '%s%s' % (indent, err[1])
697
def report_error(self, test, err):
698
self.stream.write('ERROR %s\n%s\n'
699
% (self._testTimeString(test),
700
self._error_summary(err)))
702
def report_failure(self, test, err):
703
self.stream.write(' FAIL %s\n%s\n'
704
% (self._testTimeString(test),
705
self._error_summary(err)))
707
def report_known_failure(self, test, err):
708
self.stream.write('XFAIL %s\n%s\n'
709
% (self._testTimeString(test),
710
self._error_summary(err)))
712
def report_unexpected_success(self, test, reason):
713
self.stream.write(' FAIL %s\n%s: %s\n'
714
% (self._testTimeString(test),
715
"Unexpected success. Should have failed",
718
def report_success(self, test):
719
self.stream.write(' OK %s\n' % self._testTimeString(test))
720
for bench_called, stats in getattr(test, '_benchcalls', []):
721
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
722
stats.pprint(file=self.stream)
723
# flush the stream so that we get smooth output. This verbose mode is
724
# used to show the output in PQM.
727
def report_skip(self, test, reason):
728
self.stream.write(' SKIP %s\n%s\n'
729
% (self._testTimeString(test), reason))
731
def report_not_applicable(self, test, reason):
732
self.stream.write(' N/A %s\n %s\n'
733
% (self._testTimeString(test), reason))
735
def report_unsupported(self, test, feature):
736
"""test cannot be run because feature is missing."""
737
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
738
%(self._testTimeString(test), feature))
741
class TextTestRunner(object):
742
stop_on_failure = False
750
result_decorators=None,
752
"""Create a TextTestRunner.
754
:param result_decorators: An optional list of decorators to apply
755
to the result object being used by the runner. Decorators are
756
applied left to right - the first element in the list is the
759
# stream may know claim to know to write unicode strings, but in older
760
# pythons this goes sufficiently wrong that it is a bad idea. (
761
# specifically a built in file with encoding 'UTF-8' will still try
762
# to encode using ascii.
763
new_encoding = osutils.get_terminal_encoding()
764
codec = codecs.lookup(new_encoding)
765
if type(codec) is tuple:
769
encode = codec.encode
770
# GZ 2010-09-08: Really we don't want to be writing arbitrary bytes,
771
# so should swap to the plain codecs.StreamWriter
772
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream,
774
stream.encoding = new_encoding
776
self.descriptions = descriptions
777
self.verbosity = verbosity
778
self._bench_history = bench_history
779
self._strict = strict
780
self._result_decorators = result_decorators or []
783
"Run the given test case or test suite."
784
if self.verbosity == 1:
785
result_class = TextTestResult
786
elif self.verbosity >= 2:
787
result_class = VerboseTestResult
788
original_result = result_class(self.stream,
791
bench_history=self._bench_history,
794
# Signal to result objects that look at stop early policy to stop,
795
original_result.stop_early = self.stop_on_failure
796
result = original_result
797
for decorator in self._result_decorators:
798
result = decorator(result)
799
result.stop_early = self.stop_on_failure
800
result.startTestRun()
805
# higher level code uses our extended protocol to determine
806
# what exit code to give.
807
return original_result
810
def iter_suite_tests(suite):
811
"""Return all tests in a suite, recursing through nested suites"""
812
if isinstance(suite, unittest.TestCase):
814
elif isinstance(suite, unittest.TestSuite):
816
for r in iter_suite_tests(item):
819
raise Exception('unknown type %r for object %r'
820
% (type(suite), suite))
823
TestSkipped = testtools.testcase.TestSkipped
826
class TestNotApplicable(TestSkipped):
827
"""A test is not applicable to the situation where it was run.
829
This is only normally raised by parameterized tests, if they find that
830
the instance they're constructed upon does not support one aspect
835
# traceback._some_str fails to format exceptions that have the default
836
# __str__ which does an implicit ascii conversion. However, repr() on those
837
# objects works, for all that its not quite what the doctor may have ordered.
838
def _clever_some_str(value):
843
return repr(value).replace('\\n', '\n')
845
return '<unprintable %s object>' % type(value).__name__
847
traceback._some_str = _clever_some_str
850
# deprecated - use self.knownFailure(), or self.expectFailure.
851
KnownFailure = testtools.testcase._ExpectedFailure
854
class UnavailableFeature(Exception):
855
"""A feature required for this test was not available.
857
This can be considered a specialised form of SkippedTest.
859
The feature should be used to construct the exception.
863
class StringIOWrapper(object):
864
"""A wrapper around cStringIO which just adds an encoding attribute.
866
Internally we can check sys.stdout to see what the output encoding
867
should be. However, cStringIO has no encoding attribute that we can
868
set. So we wrap it instead.
873
def __init__(self, s=None):
875
self.__dict__['_cstring'] = StringIO(s)
877
self.__dict__['_cstring'] = StringIO()
879
def __getattr__(self, name, getattr=getattr):
880
return getattr(self.__dict__['_cstring'], name)
882
def __setattr__(self, name, val):
883
if name == 'encoding':
884
self.__dict__['encoding'] = val
886
return setattr(self._cstring, name, val)
889
class TestUIFactory(TextUIFactory):
890
"""A UI Factory for testing.
892
Hide the progress bar but emit note()s.
894
Allows get_password to be tested without real tty attached.
896
See also CannedInputUIFactory which lets you provide programmatic input in
899
# TODO: Capture progress events at the model level and allow them to be
900
# observed by tests that care.
902
# XXX: Should probably unify more with CannedInputUIFactory or a
903
# particular configuration of TextUIFactory, or otherwise have a clearer
904
# idea of how they're supposed to be different.
905
# See https://bugs.launchpad.net/bzr/+bug/408213
907
def __init__(self, stdout=None, stderr=None, stdin=None):
908
if stdin is not None:
909
# We use a StringIOWrapper to be able to test various
910
# encodings, but the user is still responsible to
911
# encode the string and to set the encoding attribute
912
# of StringIOWrapper.
913
stdin = StringIOWrapper(stdin)
914
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
916
def get_non_echoed_password(self):
917
"""Get password from stdin without trying to handle the echo mode"""
918
password = self.stdin.readline()
921
if password[-1] == '\n':
922
password = password[:-1]
925
def make_progress_view(self):
926
return NullProgressView()
929
def isolated_doctest_setUp(test):
930
override_os_environ(test)
933
def isolated_doctest_tearDown(test):
934
restore_os_environ(test)
937
def IsolatedDocTestSuite(*args, **kwargs):
938
"""Overrides doctest.DocTestSuite to handle isolation.
940
The method is really a factory and users are expected to use it as such.
943
kwargs['setUp'] = isolated_doctest_setUp
944
kwargs['tearDown'] = isolated_doctest_tearDown
945
return doctest.DocTestSuite(*args, **kwargs)
948
class TestCase(testtools.TestCase):
949
"""Base class for bzr unit tests.
951
Tests that need access to disk resources should subclass
952
TestCaseInTempDir not TestCase.
954
Error and debug log messages are redirected from their usual
955
location into a temporary file, the contents of which can be
956
retrieved by _get_log(). We use a real OS file, not an in-memory object,
957
so that it can also capture file IO. When the test completes this file
958
is read into memory and removed from disk.
960
There are also convenience functions to invoke bzr's command-line
961
routine, and to build and check bzr trees.
963
In addition to the usual method of overriding tearDown(), this class also
964
allows subclasses to register cleanup functions via addCleanup, which are
965
run in order as the object is torn down. It's less likely this will be
966
accidentally overlooked.
970
# record lsprof data when performing benchmark calls.
971
_gather_lsprof_in_benchmarks = False
973
def __init__(self, methodName='testMethod'):
974
super(TestCase, self).__init__(methodName)
975
self._directory_isolation = True
976
self.exception_handlers.insert(0,
977
(UnavailableFeature, self._do_unsupported_or_skip))
978
self.exception_handlers.insert(0,
979
(TestNotApplicable, self._do_not_applicable))
982
super(TestCase, self).setUp()
983
for feature in getattr(self, '_test_needs_features', []):
984
self.requireFeature(feature)
985
self._cleanEnvironment()
986
self.overrideAttr(bzrlib.global_state, 'cmdline_overrides',
987
config.CommandLineSection())
990
self._benchcalls = []
991
self._benchtime = None
993
self._track_transports()
995
self._clear_debug_flags()
996
# Isolate global verbosity level, to make sure it's reproducible
997
# between tests. We should get rid of this altogether: bug 656694. --
999
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
1000
# Isolate config option expansion until its default value for bzrlib is
1001
# settled on or a the FIXME associated with _get_expand_default_value
1002
# is addressed -- vila 20110219
1003
self.overrideAttr(config, '_expand_default_value', None)
1004
self._log_files = set()
1005
# Each key in the ``_counters`` dict holds a value for a different
1006
# counter. When the test ends, addDetail() should be used to output the
1007
# counter values. This happens in install_counter_hook().
1009
if 'config_stats' in selftest_debug_flags:
1010
self._install_config_stats_hooks()
1011
# Do not use i18n for tests (unless the test reverses this)
1017
# The sys preserved stdin/stdout should allow blackbox tests debugging
1018
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
1019
).set_trace(sys._getframe().f_back)
1021
def discardDetail(self, name):
1022
"""Extend the addDetail, getDetails api so we can remove a detail.
1024
eg. bzr always adds the 'log' detail at startup, but we don't want to
1025
include it for skipped, xfail, etc tests.
1027
It is safe to call this for a detail that doesn't exist, in case this
1028
gets called multiple times.
1030
# We cheat. details is stored in __details which means we shouldn't
1031
# touch it. but getDetails() returns the dict directly, so we can
1033
details = self.getDetails()
1037
def install_counter_hook(self, hooks, name, counter_name=None):
1038
"""Install a counting hook.
1040
Any hook can be counted as long as it doesn't need to return a value.
1042
:param hooks: Where the hook should be installed.
1044
:param name: The hook name that will be counted.
1046
:param counter_name: The counter identifier in ``_counters``, defaults
1049
_counters = self._counters # Avoid closing over self
1050
if counter_name is None:
1052
if _counters.has_key(counter_name):
1053
raise AssertionError('%s is already used as a counter name'
1055
_counters[counter_name] = 0
1056
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1057
lambda: ['%d' % (_counters[counter_name],)]))
1058
def increment_counter(*args, **kwargs):
1059
_counters[counter_name] += 1
1060
label = 'count %s calls' % (counter_name,)
1061
hooks.install_named_hook(name, increment_counter, label)
1062
self.addCleanup(hooks.uninstall_named_hook, name, label)
1064
def _install_config_stats_hooks(self):
1065
"""Install config hooks to count hook calls.
1068
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1069
self.install_counter_hook(config.ConfigHooks, hook_name,
1070
'config.%s' % (hook_name,))
1072
# The OldConfigHooks are private and need special handling to protect
1073
# against recursive tests (tests that run other tests), so we just do
1074
# manually what registering them into _builtin_known_hooks will provide
1076
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1077
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1078
self.install_counter_hook(config.OldConfigHooks, hook_name,
1079
'old_config.%s' % (hook_name,))
1081
def _clear_debug_flags(self):
1082
"""Prevent externally set debug flags affecting tests.
1084
Tests that want to use debug flags can just set them in the
1085
debug_flags set during setup/teardown.
1087
# Start with a copy of the current debug flags we can safely modify.
1088
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1089
if 'allow_debug' not in selftest_debug_flags:
1090
debug.debug_flags.clear()
1091
if 'disable_lock_checks' not in selftest_debug_flags:
1092
debug.debug_flags.add('strict_locks')
1094
def _clear_hooks(self):
1095
# prevent hooks affecting tests
1096
known_hooks = hooks.known_hooks
1097
self._preserved_hooks = {}
1098
for key, (parent, name) in known_hooks.iter_parent_objects():
1099
current_hooks = getattr(parent, name)
1100
self._preserved_hooks[parent] = (name, current_hooks)
1101
self._preserved_lazy_hooks = hooks._lazy_hooks
1102
hooks._lazy_hooks = {}
1103
self.addCleanup(self._restoreHooks)
1104
for key, (parent, name) in known_hooks.iter_parent_objects():
1105
factory = known_hooks.get(key)
1106
setattr(parent, name, factory())
1107
# this hook should always be installed
1108
request._install_hook()
1110
def disable_directory_isolation(self):
1111
"""Turn off directory isolation checks."""
1112
self._directory_isolation = False
1114
def enable_directory_isolation(self):
1115
"""Enable directory isolation checks."""
1116
self._directory_isolation = True
1118
def _silenceUI(self):
1119
"""Turn off UI for duration of test"""
1120
# by default the UI is off; tests can turn it on if they want it.
1121
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1123
def _check_locks(self):
1124
"""Check that all lock take/release actions have been paired."""
1125
# We always check for mismatched locks. If a mismatch is found, we
1126
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1127
# case we just print a warning.
1129
acquired_locks = [lock for action, lock in self._lock_actions
1130
if action == 'acquired']
1131
released_locks = [lock for action, lock in self._lock_actions
1132
if action == 'released']
1133
broken_locks = [lock for action, lock in self._lock_actions
1134
if action == 'broken']
1135
# trivially, given the tests for lock acquistion and release, if we
1136
# have as many in each list, it should be ok. Some lock tests also
1137
# break some locks on purpose and should be taken into account by
1138
# considering that breaking a lock is just a dirty way of releasing it.
1139
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1141
'Different number of acquired and '
1142
'released or broken locks.\n'
1146
(acquired_locks, released_locks, broken_locks))
1147
if not self._lock_check_thorough:
1148
# Rather than fail, just warn
1149
print "Broken test %s: %s" % (self, message)
1153
def _track_locks(self):
1154
"""Track lock activity during tests."""
1155
self._lock_actions = []
1156
if 'disable_lock_checks' in selftest_debug_flags:
1157
self._lock_check_thorough = False
1159
self._lock_check_thorough = True
1161
self.addCleanup(self._check_locks)
1162
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1163
self._lock_acquired, None)
1164
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1165
self._lock_released, None)
1166
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1167
self._lock_broken, None)
1169
def _lock_acquired(self, result):
1170
self._lock_actions.append(('acquired', result))
1172
def _lock_released(self, result):
1173
self._lock_actions.append(('released', result))
1175
def _lock_broken(self, result):
1176
self._lock_actions.append(('broken', result))
1178
def permit_dir(self, name):
1179
"""Permit a directory to be used by this test. See permit_url."""
1180
name_transport = _mod_transport.get_transport_from_path(name)
1181
self.permit_url(name)
1182
self.permit_url(name_transport.base)
1184
def permit_url(self, url):
1185
"""Declare that url is an ok url to use in this test.
1187
Do this for memory transports, temporary test directory etc.
1189
Do not do this for the current working directory, /tmp, or any other
1190
preexisting non isolated url.
1192
if not url.endswith('/'):
1194
self._bzr_selftest_roots.append(url)
1196
def permit_source_tree_branch_repo(self):
1197
"""Permit the source tree bzr is running from to be opened.
1199
Some code such as bzrlib.version attempts to read from the bzr branch
1200
that bzr is executing from (if any). This method permits that directory
1201
to be used in the test suite.
1203
path = self.get_source_path()
1204
self.record_directory_isolation()
1207
workingtree.WorkingTree.open(path)
1208
except (errors.NotBranchError, errors.NoWorkingTree):
1209
raise TestSkipped('Needs a working tree of bzr sources')
1211
self.enable_directory_isolation()
1213
def _preopen_isolate_transport(self, transport):
1214
"""Check that all transport openings are done in the test work area."""
1215
while isinstance(transport, pathfilter.PathFilteringTransport):
1216
# Unwrap pathfiltered transports
1217
transport = transport.server.backing_transport.clone(
1218
transport._filter('.'))
1219
url = transport.base
1220
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1221
# urls it is given by prepending readonly+. This is appropriate as the
1222
# client shouldn't know that the server is readonly (or not readonly).
1223
# We could register all servers twice, with readonly+ prepending, but
1224
# that makes for a long list; this is about the same but easier to
1226
if url.startswith('readonly+'):
1227
url = url[len('readonly+'):]
1228
self._preopen_isolate_url(url)
1230
def _preopen_isolate_url(self, url):
1231
if not self._directory_isolation:
1233
if self._directory_isolation == 'record':
1234
self._bzr_selftest_roots.append(url)
1236
# This prevents all transports, including e.g. sftp ones backed on disk
1237
# from working unless they are explicitly granted permission. We then
1238
# depend on the code that sets up test transports to check that they are
1239
# appropriately isolated and enable their use by calling
1240
# self.permit_transport()
1241
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1242
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1243
% (url, self._bzr_selftest_roots))
1245
def record_directory_isolation(self):
1246
"""Gather accessed directories to permit later access.
1248
This is used for tests that access the branch bzr is running from.
1250
self._directory_isolation = "record"
1252
def start_server(self, transport_server, backing_server=None):
1253
"""Start transport_server for this test.
1255
This starts the server, registers a cleanup for it and permits the
1256
server's urls to be used.
1258
if backing_server is None:
1259
transport_server.start_server()
1261
transport_server.start_server(backing_server)
1262
self.addCleanup(transport_server.stop_server)
1263
# Obtain a real transport because if the server supplies a password, it
1264
# will be hidden from the base on the client side.
1265
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1266
# Some transport servers effectively chroot the backing transport;
1267
# others like SFTPServer don't - users of the transport can walk up the
1268
# transport to read the entire backing transport. This wouldn't matter
1269
# except that the workdir tests are given - and that they expect the
1270
# server's url to point at - is one directory under the safety net. So
1271
# Branch operations into the transport will attempt to walk up one
1272
# directory. Chrooting all servers would avoid this but also mean that
1273
# we wouldn't be testing directly against non-root urls. Alternatively
1274
# getting the test framework to start the server with a backing server
1275
# at the actual safety net directory would work too, but this then
1276
# means that the self.get_url/self.get_transport methods would need
1277
# to transform all their results. On balance its cleaner to handle it
1278
# here, and permit a higher url when we have one of these transports.
1279
if t.base.endswith('/work/'):
1280
# we have safety net/test root/work
1281
t = t.clone('../..')
1282
elif isinstance(transport_server,
1283
test_server.SmartTCPServer_for_testing):
1284
# The smart server adds a path similar to work, which is traversed
1285
# up from by the client. But the server is chrooted - the actual
1286
# backing transport is not escaped from, and VFS requests to the
1287
# root will error (because they try to escape the chroot).
1289
while t2.base != t.base:
1292
self.permit_url(t.base)
1294
def _track_transports(self):
1295
"""Install checks for transport usage."""
1296
# TestCase has no safe place it can write to.
1297
self._bzr_selftest_roots = []
1298
# Currently the easiest way to be sure that nothing is going on is to
1299
# hook into bzr dir opening. This leaves a small window of error for
1300
# transport tests, but they are well known, and we can improve on this
1302
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1303
self._preopen_isolate_transport, "Check bzr directories are safe.")
1305
def _ndiff_strings(self, a, b):
1306
"""Return ndiff between two strings containing lines.
1308
A trailing newline is added if missing to make the strings
1310
if b and b[-1] != '\n':
1312
if a and a[-1] != '\n':
1314
difflines = difflib.ndiff(a.splitlines(True),
1316
linejunk=lambda x: False,
1317
charjunk=lambda x: False)
1318
return ''.join(difflines)
1320
def assertEqual(self, a, b, message=''):
1324
except UnicodeError, e:
1325
# If we can't compare without getting a UnicodeError, then
1326
# obviously they are different
1327
trace.mutter('UnicodeError: %s', e)
1330
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1332
pprint.pformat(a), pprint.pformat(b)))
1334
assertEquals = assertEqual
1336
def assertEqualDiff(self, a, b, message=None):
1337
"""Assert two texts are equal, if not raise an exception.
1339
This is intended for use with multi-line strings where it can
1340
be hard to find the differences by eye.
1342
# TODO: perhaps override assertEquals to call this for strings?
1346
message = "texts not equal:\n"
1348
message = 'first string is missing a final newline.\n'
1350
message = 'second string is missing a final newline.\n'
1351
raise AssertionError(message +
1352
self._ndiff_strings(a, b))
1354
def assertEqualMode(self, mode, mode_test):
1355
self.assertEqual(mode, mode_test,
1356
'mode mismatch %o != %o' % (mode, mode_test))
1358
def assertEqualStat(self, expected, actual):
1359
"""assert that expected and actual are the same stat result.
1361
:param expected: A stat result.
1362
:param actual: A stat result.
1363
:raises AssertionError: If the expected and actual stat values differ
1364
other than by atime.
1366
self.assertEqual(expected.st_size, actual.st_size,
1367
'st_size did not match')
1368
self.assertEqual(expected.st_mtime, actual.st_mtime,
1369
'st_mtime did not match')
1370
self.assertEqual(expected.st_ctime, actual.st_ctime,
1371
'st_ctime did not match')
1372
if sys.platform == 'win32':
1373
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1374
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1375
# odd. We just force it to always be 0 to avoid any problems.
1376
self.assertEqual(0, expected.st_dev)
1377
self.assertEqual(0, actual.st_dev)
1378
self.assertEqual(0, expected.st_ino)
1379
self.assertEqual(0, actual.st_ino)
1381
self.assertEqual(expected.st_dev, actual.st_dev,
1382
'st_dev did not match')
1383
self.assertEqual(expected.st_ino, actual.st_ino,
1384
'st_ino did not match')
1385
self.assertEqual(expected.st_mode, actual.st_mode,
1386
'st_mode did not match')
1388
def assertLength(self, length, obj_with_len):
1389
"""Assert that obj_with_len is of length length."""
1390
if len(obj_with_len) != length:
1391
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1392
length, len(obj_with_len), obj_with_len))
1394
def assertLogsError(self, exception_class, func, *args, **kwargs):
1395
"""Assert that `func(*args, **kwargs)` quietly logs a specific error.
1398
orig_log_exception_quietly = trace.log_exception_quietly
1401
orig_log_exception_quietly()
1402
captured.append(sys.exc_info()[1])
1403
trace.log_exception_quietly = capture
1404
func(*args, **kwargs)
1406
trace.log_exception_quietly = orig_log_exception_quietly
1407
self.assertLength(1, captured)
1409
self.assertIsInstance(err, exception_class)
1412
def assertPositive(self, val):
1413
"""Assert that val is greater than 0."""
1414
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1416
def assertNegative(self, val):
1417
"""Assert that val is less than 0."""
1418
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1420
def assertStartsWith(self, s, prefix):
1421
if not s.startswith(prefix):
1422
raise AssertionError('string %r does not start with %r' % (s, prefix))
1424
def assertEndsWith(self, s, suffix):
1425
"""Asserts that s ends with suffix."""
1426
if not s.endswith(suffix):
1427
raise AssertionError('string %r does not end with %r' % (s, suffix))
1429
def assertContainsRe(self, haystack, needle_re, flags=0):
1430
"""Assert that a contains something matching a regular expression."""
1431
if not re.search(needle_re, haystack, flags):
1432
if '\n' in haystack or len(haystack) > 60:
1433
# a long string, format it in a more readable way
1434
raise AssertionError(
1435
'pattern "%s" not found in\n"""\\\n%s"""\n'
1436
% (needle_re, haystack))
1438
raise AssertionError('pattern "%s" not found in "%s"'
1439
% (needle_re, haystack))
1441
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1442
"""Assert that a does not match a regular expression"""
1443
if re.search(needle_re, haystack, flags):
1444
raise AssertionError('pattern "%s" found in "%s"'
1445
% (needle_re, haystack))
1447
def assertContainsString(self, haystack, needle):
1448
if haystack.find(needle) == -1:
1449
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1451
def assertNotContainsString(self, haystack, needle):
1452
if haystack.find(needle) != -1:
1453
self.fail("string %r found in '''%s'''" % (needle, haystack))
1455
def assertSubset(self, sublist, superlist):
1456
"""Assert that every entry in sublist is present in superlist."""
1457
missing = set(sublist) - set(superlist)
1458
if len(missing) > 0:
1459
raise AssertionError("value(s) %r not present in container %r" %
1460
(missing, superlist))
1462
def assertListRaises(self, excClass, func, *args, **kwargs):
1463
"""Fail unless excClass is raised when the iterator from func is used.
1465
Many functions can return generators this makes sure
1466
to wrap them in a list() call to make sure the whole generator
1467
is run, and that the proper exception is raised.
1470
list(func(*args, **kwargs))
1474
if getattr(excClass,'__name__', None) is not None:
1475
excName = excClass.__name__
1477
excName = str(excClass)
1478
raise self.failureException, "%s not raised" % excName
1480
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1481
"""Assert that a callable raises a particular exception.
1483
:param excClass: As for the except statement, this may be either an
1484
exception class, or a tuple of classes.
1485
:param callableObj: A callable, will be passed ``*args`` and
1488
Returns the exception so that you can examine it.
1491
callableObj(*args, **kwargs)
1495
if getattr(excClass,'__name__', None) is not None:
1496
excName = excClass.__name__
1499
excName = str(excClass)
1500
raise self.failureException, "%s not raised" % excName
1502
def assertIs(self, left, right, message=None):
1503
if not (left is right):
1504
if message is not None:
1505
raise AssertionError(message)
1507
raise AssertionError("%r is not %r." % (left, right))
1509
def assertIsNot(self, left, right, message=None):
1511
if message is not None:
1512
raise AssertionError(message)
1514
raise AssertionError("%r is %r." % (left, right))
1516
def assertTransportMode(self, transport, path, mode):
1517
"""Fail if a path does not have mode "mode".
1519
If modes are not supported on this transport, the assertion is ignored.
1521
if not transport._can_roundtrip_unix_modebits():
1523
path_stat = transport.stat(path)
1524
actual_mode = stat.S_IMODE(path_stat.st_mode)
1525
self.assertEqual(mode, actual_mode,
1526
'mode of %r incorrect (%s != %s)'
1527
% (path, oct(mode), oct(actual_mode)))
1529
def assertIsSameRealPath(self, path1, path2):
1530
"""Fail if path1 and path2 points to different files"""
1531
self.assertEqual(osutils.realpath(path1),
1532
osutils.realpath(path2),
1533
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1535
def assertIsInstance(self, obj, kls, msg=None):
1536
"""Fail if obj is not an instance of kls
1538
:param msg: Supplementary message to show if the assertion fails.
1540
if not isinstance(obj, kls):
1541
m = "%r is an instance of %s rather than %s" % (
1542
obj, obj.__class__, kls)
1547
def assertFileEqual(self, content, path):
1548
"""Fail if path does not contain 'content'."""
1549
self.assertPathExists(path)
1550
f = file(path, 'rb')
1555
self.assertEqualDiff(content, s)
1557
def assertDocstring(self, expected_docstring, obj):
1558
"""Fail if obj does not have expected_docstring"""
1560
# With -OO the docstring should be None instead
1561
self.assertIs(obj.__doc__, None)
1563
self.assertEqual(expected_docstring, obj.__doc__)
1565
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1566
def failUnlessExists(self, path):
1567
return self.assertPathExists(path)
1569
def assertPathExists(self, path):
1570
"""Fail unless path or paths, which may be abs or relative, exist."""
1571
if not isinstance(path, basestring):
1573
self.assertPathExists(p)
1575
self.assertTrue(osutils.lexists(path),
1576
path + " does not exist")
1578
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1579
def failIfExists(self, path):
1580
return self.assertPathDoesNotExist(path)
1582
def assertPathDoesNotExist(self, path):
1583
"""Fail if path or paths, which may be abs or relative, exist."""
1584
if not isinstance(path, basestring):
1586
self.assertPathDoesNotExist(p)
1588
self.assertFalse(osutils.lexists(path),
1591
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1592
"""A helper for callDeprecated and applyDeprecated.
1594
:param a_callable: A callable to call.
1595
:param args: The positional arguments for the callable
1596
:param kwargs: The keyword arguments for the callable
1597
:return: A tuple (warnings, result). result is the result of calling
1598
a_callable(``*args``, ``**kwargs``).
1601
def capture_warnings(msg, cls=None, stacklevel=None):
1602
# we've hooked into a deprecation specific callpath,
1603
# only deprecations should getting sent via it.
1604
self.assertEqual(cls, DeprecationWarning)
1605
local_warnings.append(msg)
1606
original_warning_method = symbol_versioning.warn
1607
symbol_versioning.set_warning_method(capture_warnings)
1609
result = a_callable(*args, **kwargs)
1611
symbol_versioning.set_warning_method(original_warning_method)
1612
return (local_warnings, result)
1614
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1615
"""Call a deprecated callable without warning the user.
1617
Note that this only captures warnings raised by symbol_versioning.warn,
1618
not other callers that go direct to the warning module.
1620
To test that a deprecated method raises an error, do something like
1621
this (remember that both assertRaises and applyDeprecated delays *args
1622
and **kwargs passing)::
1624
self.assertRaises(errors.ReservedId,
1625
self.applyDeprecated,
1626
deprecated_in((1, 5, 0)),
1630
:param deprecation_format: The deprecation format that the callable
1631
should have been deprecated with. This is the same type as the
1632
parameter to deprecated_method/deprecated_function. If the
1633
callable is not deprecated with this format, an assertion error
1635
:param a_callable: A callable to call. This may be a bound method or
1636
a regular function. It will be called with ``*args`` and
1638
:param args: The positional arguments for the callable
1639
:param kwargs: The keyword arguments for the callable
1640
:return: The result of a_callable(``*args``, ``**kwargs``)
1642
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1644
expected_first_warning = symbol_versioning.deprecation_string(
1645
a_callable, deprecation_format)
1646
if len(call_warnings) == 0:
1647
self.fail("No deprecation warning generated by call to %s" %
1649
self.assertEqual(expected_first_warning, call_warnings[0])
1652
def callCatchWarnings(self, fn, *args, **kw):
1653
"""Call a callable that raises python warnings.
1655
The caller's responsible for examining the returned warnings.
1657
If the callable raises an exception, the exception is not
1658
caught and propagates up to the caller. In that case, the list
1659
of warnings is not available.
1661
:returns: ([warning_object, ...], fn_result)
1663
# XXX: This is not perfect, because it completely overrides the
1664
# warnings filters, and some code may depend on suppressing particular
1665
# warnings. It's the easiest way to insulate ourselves from -Werror,
1666
# though. -- Andrew, 20071062
1668
def _catcher(message, category, filename, lineno, file=None, line=None):
1669
# despite the name, 'message' is normally(?) a Warning subclass
1671
wlist.append(message)
1672
saved_showwarning = warnings.showwarning
1673
saved_filters = warnings.filters
1675
warnings.showwarning = _catcher
1676
warnings.filters = []
1677
result = fn(*args, **kw)
1679
warnings.showwarning = saved_showwarning
1680
warnings.filters = saved_filters
1681
return wlist, result
1683
def callDeprecated(self, expected, callable, *args, **kwargs):
1684
"""Assert that a callable is deprecated in a particular way.
1686
This is a very precise test for unusual requirements. The
1687
applyDeprecated helper function is probably more suited for most tests
1688
as it allows you to simply specify the deprecation format being used
1689
and will ensure that that is issued for the function being called.
1691
Note that this only captures warnings raised by symbol_versioning.warn,
1692
not other callers that go direct to the warning module. To catch
1693
general warnings, use callCatchWarnings.
1695
:param expected: a list of the deprecation warnings expected, in order
1696
:param callable: The callable to call
1697
:param args: The positional arguments for the callable
1698
:param kwargs: The keyword arguments for the callable
1700
call_warnings, result = self._capture_deprecation_warnings(callable,
1702
self.assertEqual(expected, call_warnings)
1705
def _startLogFile(self):
1706
"""Send bzr and test log messages to a temporary file.
1708
The file is removed as the test is torn down.
1710
pseudo_log_file = StringIO()
1711
def _get_log_contents_for_weird_testtools_api():
1712
return [pseudo_log_file.getvalue().decode(
1713
"utf-8", "replace").encode("utf-8")]
1714
self.addDetail("log", content.Content(content.ContentType("text",
1715
"plain", {"charset": "utf8"}),
1716
_get_log_contents_for_weird_testtools_api))
1717
self._log_file = pseudo_log_file
1718
self._log_memento = trace.push_log_file(self._log_file)
1719
self.addCleanup(self._finishLogFile)
1721
def _finishLogFile(self):
1722
"""Finished with the log file.
1724
Close the file and delete it.
1726
if trace._trace_file:
1727
# flush the log file, to get all content
1728
trace._trace_file.flush()
1729
trace.pop_log_file(self._log_memento)
1731
def thisFailsStrictLockCheck(self):
1732
"""It is known that this test would fail with -Dstrict_locks.
1734
By default, all tests are run with strict lock checking unless
1735
-Edisable_lock_checks is supplied. However there are some tests which
1736
we know fail strict locks at this point that have not been fixed.
1737
They should call this function to disable the strict checking.
1739
This should be used sparingly, it is much better to fix the locking
1740
issues rather than papering over the problem by calling this function.
1742
debug.debug_flags.discard('strict_locks')
1744
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1745
"""Overrides an object attribute restoring it after the test.
1747
:note: This should be used with discretion; you should think about
1748
whether it's better to make the code testable without monkey-patching.
1750
:param obj: The object that will be mutated.
1752
:param attr_name: The attribute name we want to preserve/override in
1755
:param new: The optional value we want to set the attribute to.
1757
:returns: The actual attr value.
1759
value = getattr(obj, attr_name)
1760
# The actual value is captured by the call below
1761
self.addCleanup(setattr, obj, attr_name, value)
1762
if new is not _unitialized_attr:
1763
setattr(obj, attr_name, new)
1766
def overrideEnv(self, name, new):
1767
"""Set an environment variable, and reset it after the test.
1769
:param name: The environment variable name.
1771
:param new: The value to set the variable to. If None, the
1772
variable is deleted from the environment.
1774
:returns: The actual variable value.
1776
value = osutils.set_or_unset_env(name, new)
1777
self.addCleanup(osutils.set_or_unset_env, name, value)
1780
def recordCalls(self, obj, attr_name):
1781
"""Monkeypatch in a wrapper that will record calls.
1783
The monkeypatch is automatically removed when the test concludes.
1785
:param obj: The namespace holding the reference to be replaced;
1786
typically a module, class, or object.
1787
:param attr_name: A string for the name of the attribute to
1789
:returns: A list that will be extended with one item every time the
1790
function is called, with a tuple of (args, kwargs).
1794
def decorator(*args, **kwargs):
1795
calls.append((args, kwargs))
1796
return orig(*args, **kwargs)
1797
orig = self.overrideAttr(obj, attr_name, decorator)
1800
def _cleanEnvironment(self):
1801
for name, value in isolated_environ.iteritems():
1802
self.overrideEnv(name, value)
1804
def _restoreHooks(self):
1805
for klass, (name, hooks) in self._preserved_hooks.items():
1806
setattr(klass, name, hooks)
1807
self._preserved_hooks.clear()
1808
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1809
self._preserved_lazy_hooks.clear()
1811
def knownFailure(self, reason):
1812
"""Declare that this test fails for a known reason
1814
Tests that are known to fail should generally be using expectedFailure
1815
with an appropriate reverse assertion if a change could cause the test
1816
to start passing. Conversely if the test has no immediate prospect of
1817
succeeding then using skip is more suitable.
1819
When this method is called while an exception is being handled, that
1820
traceback will be used, otherwise a new exception will be thrown to
1821
provide one but won't be reported.
1823
self._add_reason(reason)
1825
exc_info = sys.exc_info()
1826
if exc_info != (None, None, None):
1827
self._report_traceback(exc_info)
1830
raise self.failureException(reason)
1831
except self.failureException:
1832
exc_info = sys.exc_info()
1833
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1834
raise testtools.testcase._ExpectedFailure(exc_info)
1838
def _suppress_log(self):
1839
"""Remove the log info from details."""
1840
self.discardDetail('log')
1842
def _do_skip(self, result, reason):
1843
self._suppress_log()
1844
addSkip = getattr(result, 'addSkip', None)
1845
if not callable(addSkip):
1846
result.addSuccess(result)
1848
addSkip(self, reason)
1851
def _do_known_failure(self, result, e):
1852
self._suppress_log()
1853
err = sys.exc_info()
1854
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1855
if addExpectedFailure is not None:
1856
addExpectedFailure(self, err)
1858
result.addSuccess(self)
1861
def _do_not_applicable(self, result, e):
1863
reason = 'No reason given'
1866
self._suppress_log ()
1867
addNotApplicable = getattr(result, 'addNotApplicable', None)
1868
if addNotApplicable is not None:
1869
result.addNotApplicable(self, reason)
1871
self._do_skip(result, reason)
1874
def _report_skip(self, result, err):
1875
"""Override the default _report_skip.
1877
We want to strip the 'log' detail. If we waint until _do_skip, it has
1878
already been formatted into the 'reason' string, and we can't pull it
1881
self._suppress_log()
1882
super(TestCase, self)._report_skip(self, result, err)
1885
def _report_expected_failure(self, result, err):
1888
See _report_skip for motivation.
1890
self._suppress_log()
1891
super(TestCase, self)._report_expected_failure(self, result, err)
1894
def _do_unsupported_or_skip(self, result, e):
1896
self._suppress_log()
1897
addNotSupported = getattr(result, 'addNotSupported', None)
1898
if addNotSupported is not None:
1899
result.addNotSupported(self, reason)
1901
self._do_skip(result, reason)
1903
def time(self, callable, *args, **kwargs):
1904
"""Run callable and accrue the time it takes to the benchmark time.
1906
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1907
this will cause lsprofile statistics to be gathered and stored in
1910
if self._benchtime is None:
1911
self.addDetail('benchtime', content.Content(content.ContentType(
1912
"text", "plain"), lambda:[str(self._benchtime)]))
1916
if not self._gather_lsprof_in_benchmarks:
1917
return callable(*args, **kwargs)
1919
# record this benchmark
1920
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1922
self._benchcalls.append(((callable, args, kwargs), stats))
1925
self._benchtime += time.time() - start
1927
def log(self, *args):
1931
"""Get a unicode string containing the log from bzrlib.trace.
1933
Undecodable characters are replaced.
1935
return u"".join(self.getDetails()['log'].iter_text())
1937
def requireFeature(self, feature):
1938
"""This test requires a specific feature is available.
1940
:raises UnavailableFeature: When feature is not available.
1942
if not feature.available():
1943
raise UnavailableFeature(feature)
1945
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1947
"""Run bazaar command line, splitting up a string command line."""
1948
if isinstance(args, basestring):
1949
# shlex don't understand unicode strings,
1950
# so args should be plain string (bialix 20070906)
1951
args = list(shlex.split(str(args)))
1952
return self._run_bzr_core(args, retcode=retcode,
1953
encoding=encoding, stdin=stdin, working_dir=working_dir,
1956
def _run_bzr_core(self, args, retcode, encoding, stdin,
1958
# Clear chk_map page cache, because the contents are likely to mask
1960
chk_map.clear_cache()
1961
if encoding is None:
1962
encoding = osutils.get_user_encoding()
1963
stdout = StringIOWrapper()
1964
stderr = StringIOWrapper()
1965
stdout.encoding = encoding
1966
stderr.encoding = encoding
1968
self.log('run bzr: %r', args)
1969
# FIXME: don't call into logging here
1970
handler = logging.StreamHandler(stderr)
1971
handler.setLevel(logging.INFO)
1972
logger = logging.getLogger('')
1973
logger.addHandler(handler)
1974
old_ui_factory = ui.ui_factory
1975
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1978
if working_dir is not None:
1979
cwd = osutils.getcwd()
1980
os.chdir(working_dir)
1984
result = self.apply_redirected(
1985
ui.ui_factory.stdin,
1987
_mod_commands.run_bzr_catch_user_errors,
1989
except KeyboardInterrupt:
1990
# Reraise KeyboardInterrupt with contents of redirected stdout
1991
# and stderr as arguments, for tests which are interested in
1992
# stdout and stderr and are expecting the exception.
1993
out = stdout.getvalue()
1994
err = stderr.getvalue()
1996
self.log('output:\n%r', out)
1998
self.log('errors:\n%r', err)
1999
raise KeyboardInterrupt(out, err)
2001
logger.removeHandler(handler)
2002
ui.ui_factory = old_ui_factory
2006
out = stdout.getvalue()
2007
err = stderr.getvalue()
2009
self.log('output:\n%r', out)
2011
self.log('errors:\n%r', err)
2012
if retcode is not None:
2013
self.assertEquals(retcode, result,
2014
message='Unexpected return code')
2015
return result, out, err
2017
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
2018
working_dir=None, error_regexes=[], output_encoding=None):
2019
"""Invoke bzr, as if it were run from the command line.
2021
The argument list should not include the bzr program name - the
2022
first argument is normally the bzr command. Arguments may be
2023
passed in three ways:
2025
1- A list of strings, eg ["commit", "a"]. This is recommended
2026
when the command contains whitespace or metacharacters, or
2027
is built up at run time.
2029
2- A single string, eg "add a". This is the most convenient
2030
for hardcoded commands.
2032
This runs bzr through the interface that catches and reports
2033
errors, and with logging set to something approximating the
2034
default, so that error reporting can be checked.
2036
This should be the main method for tests that want to exercise the
2037
overall behavior of the bzr application (rather than a unit test
2038
or a functional test of the library.)
2040
This sends the stdout/stderr results into the test's log,
2041
where it may be useful for debugging. See also run_captured.
2043
:keyword stdin: A string to be used as stdin for the command.
2044
:keyword retcode: The status code the command should return;
2046
:keyword working_dir: The directory to run the command in
2047
:keyword error_regexes: A list of expected error messages. If
2048
specified they must be seen in the error output of the command.
2050
retcode, out, err = self._run_bzr_autosplit(
2055
working_dir=working_dir,
2057
self.assertIsInstance(error_regexes, (list, tuple))
2058
for regex in error_regexes:
2059
self.assertContainsRe(err, regex)
2062
def run_bzr_error(self, error_regexes, *args, **kwargs):
2063
"""Run bzr, and check that stderr contains the supplied regexes
2065
:param error_regexes: Sequence of regular expressions which
2066
must each be found in the error output. The relative ordering
2068
:param args: command-line arguments for bzr
2069
:param kwargs: Keyword arguments which are interpreted by run_bzr
2070
This function changes the default value of retcode to be 3,
2071
since in most cases this is run when you expect bzr to fail.
2073
:return: (out, err) The actual output of running the command (in case
2074
you want to do more inspection)
2078
# Make sure that commit is failing because there is nothing to do
2079
self.run_bzr_error(['no changes to commit'],
2080
['commit', '-m', 'my commit comment'])
2081
# Make sure --strict is handling an unknown file, rather than
2082
# giving us the 'nothing to do' error
2083
self.build_tree(['unknown'])
2084
self.run_bzr_error(['Commit refused because there are unknown files'],
2085
['commit', --strict', '-m', 'my commit comment'])
2087
kwargs.setdefault('retcode', 3)
2088
kwargs['error_regexes'] = error_regexes
2089
out, err = self.run_bzr(*args, **kwargs)
2092
def run_bzr_subprocess(self, *args, **kwargs):
2093
"""Run bzr in a subprocess for testing.
2095
This starts a new Python interpreter and runs bzr in there.
2096
This should only be used for tests that have a justifiable need for
2097
this isolation: e.g. they are testing startup time, or signal
2098
handling, or early startup code, etc. Subprocess code can't be
2099
profiled or debugged so easily.
2101
:keyword retcode: The status code that is expected. Defaults to 0. If
2102
None is supplied, the status code is not checked.
2103
:keyword env_changes: A dictionary which lists changes to environment
2104
variables. A value of None will unset the env variable.
2105
The values must be strings. The change will only occur in the
2106
child, so you don't need to fix the environment after running.
2107
:keyword universal_newlines: Convert CRLF => LF
2108
:keyword allow_plugins: By default the subprocess is run with
2109
--no-plugins to ensure test reproducibility. Also, it is possible
2110
for system-wide plugins to create unexpected output on stderr,
2111
which can cause unnecessary test failures.
2113
env_changes = kwargs.get('env_changes', {})
2114
working_dir = kwargs.get('working_dir', None)
2115
allow_plugins = kwargs.get('allow_plugins', False)
2117
if isinstance(args[0], list):
2119
elif isinstance(args[0], basestring):
2120
args = list(shlex.split(args[0]))
2122
raise ValueError("passing varargs to run_bzr_subprocess")
2123
process = self.start_bzr_subprocess(args, env_changes=env_changes,
2124
working_dir=working_dir,
2125
allow_plugins=allow_plugins)
2126
# We distinguish between retcode=None and retcode not passed.
2127
supplied_retcode = kwargs.get('retcode', 0)
2128
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
2129
universal_newlines=kwargs.get('universal_newlines', False),
2132
def start_bzr_subprocess(self, process_args, env_changes=None,
2133
skip_if_plan_to_signal=False,
2135
allow_plugins=False, stderr=subprocess.PIPE):
2136
"""Start bzr in a subprocess for testing.
2138
This starts a new Python interpreter and runs bzr in there.
2139
This should only be used for tests that have a justifiable need for
2140
this isolation: e.g. they are testing startup time, or signal
2141
handling, or early startup code, etc. Subprocess code can't be
2142
profiled or debugged so easily.
2144
:param process_args: a list of arguments to pass to the bzr executable,
2145
for example ``['--version']``.
2146
:param env_changes: A dictionary which lists changes to environment
2147
variables. A value of None will unset the env variable.
2148
The values must be strings. The change will only occur in the
2149
child, so you don't need to fix the environment after running.
2150
:param skip_if_plan_to_signal: raise TestSkipped when true and system
2151
doesn't support signalling subprocesses.
2152
:param allow_plugins: If False (default) pass --no-plugins to bzr.
2153
:param stderr: file to use for the subprocess's stderr. Valid values
2154
are those valid for the stderr argument of `subprocess.Popen`.
2155
Default value is ``subprocess.PIPE``.
2157
:returns: Popen object for the started process.
2159
if skip_if_plan_to_signal:
2160
if os.name != "posix":
2161
raise TestSkipped("Sending signals not supported")
2163
if env_changes is None:
2167
def cleanup_environment():
2168
for env_var, value in env_changes.iteritems():
2169
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2171
def restore_environment():
2172
for env_var, value in old_env.iteritems():
2173
osutils.set_or_unset_env(env_var, value)
2175
bzr_path = self.get_bzr_path()
2178
if working_dir is not None:
2179
cwd = osutils.getcwd()
2180
os.chdir(working_dir)
2183
# win32 subprocess doesn't support preexec_fn
2184
# so we will avoid using it on all platforms, just to
2185
# make sure the code path is used, and we don't break on win32
2186
cleanup_environment()
2187
# Include the subprocess's log file in the test details, in case
2188
# the test fails due to an error in the subprocess.
2189
self._add_subprocess_log(trace._get_bzr_log_filename())
2190
command = [sys.executable]
2191
# frozen executables don't need the path to bzr
2192
if getattr(sys, "frozen", None) is None:
2193
command.append(bzr_path)
2194
if not allow_plugins:
2195
command.append('--no-plugins')
2196
command.extend(process_args)
2197
process = self._popen(command, stdin=subprocess.PIPE,
2198
stdout=subprocess.PIPE,
2201
restore_environment()
2207
def _add_subprocess_log(self, log_file_path):
2208
if len(self._log_files) == 0:
2209
# Register an addCleanup func. We do this on the first call to
2210
# _add_subprocess_log rather than in TestCase.setUp so that this
2211
# addCleanup is registered after any cleanups for tempdirs that
2212
# subclasses might create, which will probably remove the log file
2214
self.addCleanup(self._subprocess_log_cleanup)
2215
# self._log_files is a set, so if a log file is reused we won't grab it
2217
self._log_files.add(log_file_path)
2219
def _subprocess_log_cleanup(self):
2220
for count, log_file_path in enumerate(self._log_files):
2221
# We use buffer_now=True to avoid holding the file open beyond
2222
# the life of this function, which might interfere with e.g.
2223
# cleaning tempdirs on Windows.
2224
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
2225
#detail_content = content.content_from_file(
2226
# log_file_path, buffer_now=True)
2227
with open(log_file_path, 'rb') as log_file:
2228
log_file_bytes = log_file.read()
2229
detail_content = content.Content(content.ContentType("text",
2230
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
2231
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
2234
def _popen(self, *args, **kwargs):
2235
"""Place a call to Popen.
2237
Allows tests to override this method to intercept the calls made to
2238
Popen for introspection.
2240
return subprocess.Popen(*args, **kwargs)
2242
def get_source_path(self):
2243
"""Return the path of the directory containing bzrlib."""
2244
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2246
def get_bzr_path(self):
2247
"""Return the path of the 'bzr' executable for this test suite."""
2248
bzr_path = os.path.join(self.get_source_path(), "bzr")
2249
if not os.path.isfile(bzr_path):
2250
# We are probably installed. Assume sys.argv is the right file
2251
bzr_path = sys.argv[0]
2254
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2255
universal_newlines=False, process_args=None):
2256
"""Finish the execution of process.
2258
:param process: the Popen object returned from start_bzr_subprocess.
2259
:param retcode: The status code that is expected. Defaults to 0. If
2260
None is supplied, the status code is not checked.
2261
:param send_signal: an optional signal to send to the process.
2262
:param universal_newlines: Convert CRLF => LF
2263
:returns: (stdout, stderr)
2265
if send_signal is not None:
2266
os.kill(process.pid, send_signal)
2267
out, err = process.communicate()
2269
if universal_newlines:
2270
out = out.replace('\r\n', '\n')
2271
err = err.replace('\r\n', '\n')
2273
if retcode is not None and retcode != process.returncode:
2274
if process_args is None:
2275
process_args = "(unknown args)"
2276
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2277
trace.mutter('Error for bzr %s:\n%s', process_args, err)
2278
self.fail('Command bzr %s failed with retcode %s != %s'
2279
% (process_args, retcode, process.returncode))
2282
def check_tree_shape(self, tree, shape):
2283
"""Compare a tree to a list of expected names.
2285
Fail if they are not precisely equal.
2288
shape = list(shape) # copy
2289
for path, ie in tree.iter_entries_by_dir():
2290
name = path.replace('\\', '/')
2291
if ie.kind == 'directory':
2294
pass # ignore root entry
2300
self.fail("expected paths not found in inventory: %r" % shape)
2302
self.fail("unexpected paths found in inventory: %r" % extras)
2304
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2305
a_callable=None, *args, **kwargs):
2306
"""Call callable with redirected std io pipes.
2308
Returns the return code."""
2309
if not callable(a_callable):
2310
raise ValueError("a_callable must be callable.")
2312
stdin = StringIO("")
2314
if getattr(self, "_log_file", None) is not None:
2315
stdout = self._log_file
2319
if getattr(self, "_log_file", None is not None):
2320
stderr = self._log_file
2323
real_stdin = sys.stdin
2324
real_stdout = sys.stdout
2325
real_stderr = sys.stderr
2330
return a_callable(*args, **kwargs)
2332
sys.stdout = real_stdout
2333
sys.stderr = real_stderr
2334
sys.stdin = real_stdin
2336
def reduceLockdirTimeout(self):
2337
"""Reduce the default lock timeout for the duration of the test, so that
2338
if LockContention occurs during a test, it does so quickly.
2340
Tests that expect to provoke LockContention errors should call this.
2342
self.overrideAttr(lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2344
def make_utf8_encoded_stringio(self, encoding_type=None):
2345
"""Return a StringIOWrapper instance, that will encode Unicode
2348
if encoding_type is None:
2349
encoding_type = 'strict'
2351
output_encoding = 'utf-8'
2352
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2353
sio.encoding = output_encoding
2356
def disable_verb(self, verb):
2357
"""Disable a smart server verb for one test."""
2358
from bzrlib.smart import request
2359
request_handlers = request.request_handlers
2360
orig_method = request_handlers.get(verb)
2361
request_handlers.remove(verb)
2362
self.addCleanup(request_handlers.register, verb, orig_method)
2365
class CapturedCall(object):
2366
"""A helper for capturing smart server calls for easy debug analysis."""
2368
def __init__(self, params, prefix_length):
2369
"""Capture the call with params and skip prefix_length stack frames."""
2372
# The last 5 frames are the __init__, the hook frame, and 3 smart
2373
# client frames. Beyond this we could get more clever, but this is good
2375
stack = traceback.extract_stack()[prefix_length:-5]
2376
self.stack = ''.join(traceback.format_list(stack))
2379
return self.call.method
2382
return self.call.method
2388
class TestCaseWithMemoryTransport(TestCase):
2389
"""Common test class for tests that do not need disk resources.
2391
Tests that need disk resources should derive from TestCaseInTempDir
2392
orTestCaseWithTransport.
2394
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2396
For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
2397
a directory which does not exist. This serves to help ensure test isolation
2398
is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
2399
must exist. However, TestCaseWithMemoryTransport does not offer local file
2400
defaults for the transport in tests, nor does it obey the command line
2401
override, so tests that accidentally write to the common directory should
2404
:cvar TEST_ROOT: Directory containing all temporary directories, plus a
2405
``.bzr`` directory that stops us ascending higher into the filesystem.
2411
def __init__(self, methodName='runTest'):
2412
# allow test parameterization after test construction and before test
2413
# execution. Variables that the parameterizer sets need to be
2414
# ones that are not set by setUp, or setUp will trash them.
2415
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2416
self.vfs_transport_factory = default_transport
2417
self.transport_server = None
2418
self.transport_readonly_server = None
2419
self.__vfs_server = None
2421
def get_transport(self, relpath=None):
2422
"""Return a writeable transport.
2424
This transport is for the test scratch space relative to
2427
:param relpath: a path relative to the base url.
2429
t = _mod_transport.get_transport_from_url(self.get_url(relpath))
2430
self.assertFalse(t.is_readonly())
2433
def get_readonly_transport(self, relpath=None):
2434
"""Return a readonly transport for the test scratch space
2436
This can be used to test that operations which should only need
2437
readonly access in fact do not try to write.
2439
:param relpath: a path relative to the base url.
2441
t = _mod_transport.get_transport_from_url(
2442
self.get_readonly_url(relpath))
2443
self.assertTrue(t.is_readonly())
2446
def create_transport_readonly_server(self):
2447
"""Create a transport server from class defined at init.
2449
This is mostly a hook for daughter classes.
2451
return self.transport_readonly_server()
2453
def get_readonly_server(self):
2454
"""Get the server instance for the readonly transport
2456
This is useful for some tests with specific servers to do diagnostics.
2458
if self.__readonly_server is None:
2459
if self.transport_readonly_server is None:
2460
# readonly decorator requested
2461
self.__readonly_server = test_server.ReadonlyServer()
2463
# explicit readonly transport.
2464
self.__readonly_server = self.create_transport_readonly_server()
2465
self.start_server(self.__readonly_server,
2466
self.get_vfs_only_server())
2467
return self.__readonly_server
2469
def get_readonly_url(self, relpath=None):
2470
"""Get a URL for the readonly transport.
2472
This will either be backed by '.' or a decorator to the transport
2473
used by self.get_url()
2474
relpath provides for clients to get a path relative to the base url.
2475
These should only be downwards relative, not upwards.
2477
base = self.get_readonly_server().get_url()
2478
return self._adjust_url(base, relpath)
2480
def get_vfs_only_server(self):
2481
"""Get the vfs only read/write server instance.
2483
This is useful for some tests with specific servers that need
2486
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2487
is no means to override it.
2489
if self.__vfs_server is None:
2490
self.__vfs_server = memory.MemoryServer()
2491
self.start_server(self.__vfs_server)
2492
return self.__vfs_server
2494
def get_server(self):
2495
"""Get the read/write server instance.
2497
This is useful for some tests with specific servers that need
2500
This is built from the self.transport_server factory. If that is None,
2501
then the self.get_vfs_server is returned.
2503
if self.__server is None:
2504
if (self.transport_server is None or self.transport_server is
2505
self.vfs_transport_factory):
2506
self.__server = self.get_vfs_only_server()
2508
# bring up a decorated means of access to the vfs only server.
2509
self.__server = self.transport_server()
2510
self.start_server(self.__server, self.get_vfs_only_server())
2511
return self.__server
2513
def _adjust_url(self, base, relpath):
2514
"""Get a URL (or maybe a path) for the readwrite transport.
2516
This will either be backed by '.' or to an equivalent non-file based
2518
relpath provides for clients to get a path relative to the base url.
2519
These should only be downwards relative, not upwards.
2521
if relpath is not None and relpath != '.':
2522
if not base.endswith('/'):
2524
# XXX: Really base should be a url; we did after all call
2525
# get_url()! But sometimes it's just a path (from
2526
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2527
# to a non-escaped local path.
2528
if base.startswith('./') or base.startswith('/'):
2531
base += urlutils.escape(relpath)
2534
def get_url(self, relpath=None):
2535
"""Get a URL (or maybe a path) for the readwrite transport.
2537
This will either be backed by '.' or to an equivalent non-file based
2539
relpath provides for clients to get a path relative to the base url.
2540
These should only be downwards relative, not upwards.
2542
base = self.get_server().get_url()
2543
return self._adjust_url(base, relpath)
2545
def get_vfs_only_url(self, relpath=None):
2546
"""Get a URL (or maybe a path for the plain old vfs transport.
2548
This will never be a smart protocol. It always has all the
2549
capabilities of the local filesystem, but it might actually be a
2550
MemoryTransport or some other similar virtual filesystem.
2552
This is the backing transport (if any) of the server returned by
2553
get_url and get_readonly_url.
2555
:param relpath: provides for clients to get a path relative to the base
2556
url. These should only be downwards relative, not upwards.
2559
base = self.get_vfs_only_server().get_url()
2560
return self._adjust_url(base, relpath)
2562
def _create_safety_net(self):
2563
"""Make a fake bzr directory.
2565
This prevents any tests propagating up onto the TEST_ROOT directory's
2568
root = TestCaseWithMemoryTransport.TEST_ROOT
2570
# Make sure we get a readable and accessible home for .bzr.log
2571
# and/or config files, and not fallback to weird defaults (see
2572
# http://pad.lv/825027).
2573
self.assertIs(None, os.environ.get('BZR_HOME', None))
2574
os.environ['BZR_HOME'] = root
2575
wt = bzrdir.BzrDir.create_standalone_workingtree(root)
2576
del os.environ['BZR_HOME']
2577
except Exception, e:
2578
self.fail("Fail to initialize the safety net: %r\nExiting\n" % (e,))
2579
# Hack for speed: remember the raw bytes of the dirstate file so that
2580
# we don't need to re-open the wt to check it hasn't changed.
2581
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
2582
wt.control_transport.get_bytes('dirstate'))
2584
def _check_safety_net(self):
2585
"""Check that the safety .bzr directory have not been touched.
2587
_make_test_root have created a .bzr directory to prevent tests from
2588
propagating. This method ensures than a test did not leaked.
2590
root = TestCaseWithMemoryTransport.TEST_ROOT
2591
t = _mod_transport.get_transport_from_path(root)
2592
self.permit_url(t.base)
2593
if (t.get_bytes('.bzr/checkout/dirstate') !=
2594
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
2595
# The current test have modified the /bzr directory, we need to
2596
# recreate a new one or all the followng tests will fail.
2597
# If you need to inspect its content uncomment the following line
2598
# import pdb; pdb.set_trace()
2599
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2600
self._create_safety_net()
2601
raise AssertionError('%s/.bzr should not be modified' % root)
2603
def _make_test_root(self):
2604
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2605
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2606
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2608
TestCaseWithMemoryTransport.TEST_ROOT = root
2610
self._create_safety_net()
2612
# The same directory is used by all tests, and we're not
2613
# specifically told when all tests are finished. This will do.
2614
atexit.register(_rmtree_temp_dir, root)
2616
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2617
self.addCleanup(self._check_safety_net)
2619
def makeAndChdirToTestDir(self):
2620
"""Create a temporary directories for this one test.
2622
This must set self.test_home_dir and self.test_dir and chdir to
2625
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2627
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2628
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2629
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2630
self.permit_dir(self.test_dir)
2632
def make_branch(self, relpath, format=None):
2633
"""Create a branch on the transport at relpath."""
2634
repo = self.make_repository(relpath, format=format)
2635
return repo.bzrdir.create_branch(append_revisions_only=False)
2637
def get_default_format(self):
2640
def resolve_format(self, format):
2641
"""Resolve an object to a ControlDir format object.
2643
The initial format object can either already be
2644
a ControlDirFormat, None (for the default format),
2645
or a string with the name of the control dir format.
2647
:param format: Object to resolve
2648
:return A ControlDirFormat instance
2651
format = self.get_default_format()
2652
if isinstance(format, basestring):
2653
format = bzrdir.format_registry.make_bzrdir(format)
2656
def make_bzrdir(self, relpath, format=None):
2658
# might be a relative or absolute path
2659
maybe_a_url = self.get_url(relpath)
2660
segments = maybe_a_url.rsplit('/', 1)
2661
t = _mod_transport.get_transport(maybe_a_url)
2662
if len(segments) > 1 and segments[-1] not in ('', '.'):
2664
format = self.resolve_format(format)
2665
return format.initialize_on_transport(t)
2666
except errors.UninitializableFormat:
2667
raise TestSkipped("Format %s is not initializable." % format)
2669
def make_repository(self, relpath, shared=None, format=None):
2670
"""Create a repository on our default transport at relpath.
2672
Note that relpath must be a relative path, not a full url.
2674
# FIXME: If you create a remoterepository this returns the underlying
2675
# real format, which is incorrect. Actually we should make sure that
2676
# RemoteBzrDir returns a RemoteRepository.
2677
# maybe mbp 20070410
2678
made_control = self.make_bzrdir(relpath, format=format)
2679
return made_control.create_repository(shared=shared)
2681
def make_smart_server(self, path, backing_server=None):
2682
if backing_server is None:
2683
backing_server = self.get_server()
2684
smart_server = test_server.SmartTCPServer_for_testing()
2685
self.start_server(smart_server, backing_server)
2686
remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
2688
return remote_transport
2690
def make_branch_and_memory_tree(self, relpath, format=None):
2691
"""Create a branch on the default transport and a MemoryTree for it."""
2692
b = self.make_branch(relpath, format=format)
2693
return memorytree.MemoryTree.create_on_branch(b)
2695
def make_branch_builder(self, relpath, format=None):
2696
branch = self.make_branch(relpath, format=format)
2697
return branchbuilder.BranchBuilder(branch=branch)
2699
def overrideEnvironmentForTesting(self):
2700
test_home_dir = self.test_home_dir
2701
if isinstance(test_home_dir, unicode):
2702
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2703
self.overrideEnv('HOME', test_home_dir)
2704
self.overrideEnv('BZR_HOME', test_home_dir)
2707
super(TestCaseWithMemoryTransport, self).setUp()
2708
# Ensure that ConnectedTransport doesn't leak sockets
2709
def get_transport_from_url_with_cleanup(*args, **kwargs):
2710
t = orig_get_transport_from_url(*args, **kwargs)
2711
if isinstance(t, _mod_transport.ConnectedTransport):
2712
self.addCleanup(t.disconnect)
2715
orig_get_transport_from_url = self.overrideAttr(
2716
_mod_transport, 'get_transport_from_url',
2717
get_transport_from_url_with_cleanup)
2718
self._make_test_root()
2719
self.addCleanup(os.chdir, os.getcwdu())
2720
self.makeAndChdirToTestDir()
2721
self.overrideEnvironmentForTesting()
2722
self.__readonly_server = None
2723
self.__server = None
2724
self.reduceLockdirTimeout()
2726
def setup_smart_server_with_call_log(self):
2727
"""Sets up a smart server as the transport server with a call log."""
2728
self.transport_server = test_server.SmartTCPServer_for_testing
2729
self.hpss_calls = []
2731
# Skip the current stack down to the caller of
2732
# setup_smart_server_with_call_log
2733
prefix_length = len(traceback.extract_stack()) - 2
2734
def capture_hpss_call(params):
2735
self.hpss_calls.append(
2736
CapturedCall(params, prefix_length))
2737
client._SmartClient.hooks.install_named_hook(
2738
'call', capture_hpss_call, None)
2740
def reset_smart_call_log(self):
2741
self.hpss_calls = []
2744
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2745
"""Derived class that runs a test within a temporary directory.
2747
This is useful for tests that need to create a branch, etc.
2749
The directory is created in a slightly complex way: for each
2750
Python invocation, a new temporary top-level directory is created.
2751
All test cases create their own directory within that. If the
2752
tests complete successfully, the directory is removed.
2754
:ivar test_base_dir: The path of the top-level directory for this
2755
test, which contains a home directory and a work directory.
2757
:ivar test_home_dir: An initially empty directory under test_base_dir
2758
which is used as $HOME for this test.
2760
:ivar test_dir: A directory under test_base_dir used as the current
2761
directory when the test proper is run.
2764
OVERRIDE_PYTHON = 'python'
2767
super(TestCaseInTempDir, self).setUp()
2768
# Remove the protection set in isolated_environ, we have a proper
2769
# access to disk resources now.
2770
self.overrideEnv('BZR_LOG', None)
2772
def check_file_contents(self, filename, expect):
2773
self.log("check contents of file %s" % filename)
2779
if contents != expect:
2780
self.log("expected: %r" % expect)
2781
self.log("actually: %r" % contents)
2782
self.fail("contents of %s not as expected" % filename)
2784
def _getTestDirPrefix(self):
2785
# create a directory within the top level test directory
2786
if sys.platform in ('win32', 'cygwin'):
2787
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2788
# windows is likely to have path-length limits so use a short name
2789
name_prefix = name_prefix[-30:]
2791
name_prefix = re.sub('[/]', '_', self.id())
2794
def makeAndChdirToTestDir(self):
2795
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2797
For TestCaseInTempDir we create a temporary directory based on the test
2798
name and then create two subdirs - test and home under it.
2800
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2801
self._getTestDirPrefix())
2803
for i in range(100):
2804
if os.path.exists(name):
2805
name = name_prefix + '_' + str(i)
2807
# now create test and home directories within this dir
2808
self.test_base_dir = name
2809
self.addCleanup(self.deleteTestDir)
2810
os.mkdir(self.test_base_dir)
2812
self.permit_dir(self.test_base_dir)
2813
# 'sprouting' and 'init' of a branch both walk up the tree to find
2814
# stacking policy to honour; create a bzr dir with an unshared
2815
# repository (but not a branch - our code would be trying to escape
2816
# then!) to stop them, and permit it to be read.
2817
# control = bzrdir.BzrDir.create(self.test_base_dir)
2818
# control.create_repository()
2819
self.test_home_dir = self.test_base_dir + '/home'
2820
os.mkdir(self.test_home_dir)
2821
self.test_dir = self.test_base_dir + '/work'
2822
os.mkdir(self.test_dir)
2823
os.chdir(self.test_dir)
2824
# put name of test inside
2825
f = file(self.test_base_dir + '/name', 'w')
2831
def deleteTestDir(self):
2832
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2833
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2835
def build_tree(self, shape, line_endings='binary', transport=None):
2836
"""Build a test tree according to a pattern.
2838
shape is a sequence of file specifications. If the final
2839
character is '/', a directory is created.
2841
This assumes that all the elements in the tree being built are new.
2843
This doesn't add anything to a branch.
2845
:type shape: list or tuple.
2846
:param line_endings: Either 'binary' or 'native'
2847
in binary mode, exact contents are written in native mode, the
2848
line endings match the default platform endings.
2849
:param transport: A transport to write to, for building trees on VFS's.
2850
If the transport is readonly or None, "." is opened automatically.
2853
if type(shape) not in (list, tuple):
2854
raise AssertionError("Parameter 'shape' should be "
2855
"a list or a tuple. Got %r instead" % (shape,))
2856
# It's OK to just create them using forward slashes on windows.
2857
if transport is None or transport.is_readonly():
2858
transport = _mod_transport.get_transport_from_path(".")
2860
self.assertIsInstance(name, basestring)
2862
transport.mkdir(urlutils.escape(name[:-1]))
2864
if line_endings == 'binary':
2866
elif line_endings == 'native':
2869
raise errors.BzrError(
2870
'Invalid line ending request %r' % line_endings)
2871
content = "contents of %s%s" % (name.encode('utf-8'), end)
2872
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2874
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2876
def assertInWorkingTree(self, path, root_path='.', tree=None):
2877
"""Assert whether path or paths are in the WorkingTree"""
2879
tree = workingtree.WorkingTree.open(root_path)
2880
if not isinstance(path, basestring):
2882
self.assertInWorkingTree(p, tree=tree)
2884
self.assertIsNot(tree.path2id(path), None,
2885
path+' not in working tree.')
2887
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2888
"""Assert whether path or paths are not in the WorkingTree"""
2890
tree = workingtree.WorkingTree.open(root_path)
2891
if not isinstance(path, basestring):
2893
self.assertNotInWorkingTree(p,tree=tree)
2895
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2898
class TestCaseWithTransport(TestCaseInTempDir):
2899
"""A test case that provides get_url and get_readonly_url facilities.
2901
These back onto two transport servers, one for readonly access and one for
2904
If no explicit class is provided for readonly access, a
2905
ReadonlyTransportDecorator is used instead which allows the use of non disk
2906
based read write transports.
2908
If an explicit class is provided for readonly access, that server and the
2909
readwrite one must both define get_url() as resolving to os.getcwd().
2912
def get_vfs_only_server(self):
2913
"""See TestCaseWithMemoryTransport.
2915
This is useful for some tests with specific servers that need
2918
if self.__vfs_server is None:
2919
self.__vfs_server = self.vfs_transport_factory()
2920
self.start_server(self.__vfs_server)
2921
return self.__vfs_server
2923
def make_branch_and_tree(self, relpath, format=None):
2924
"""Create a branch on the transport and a tree locally.
2926
If the transport is not a LocalTransport, the Tree can't be created on
2927
the transport. In that case if the vfs_transport_factory is
2928
LocalURLServer the working tree is created in the local
2929
directory backing the transport, and the returned tree's branch and
2930
repository will also be accessed locally. Otherwise a lightweight
2931
checkout is created and returned.
2933
We do this because we can't physically create a tree in the local
2934
path, with a branch reference to the transport_factory url, and
2935
a branch + repository in the vfs_transport, unless the vfs_transport
2936
namespace is distinct from the local disk - the two branch objects
2937
would collide. While we could construct a tree with its branch object
2938
pointing at the transport_factory transport in memory, reopening it
2939
would behaving unexpectedly, and has in the past caused testing bugs
2940
when we tried to do it that way.
2942
:param format: The BzrDirFormat.
2943
:returns: the WorkingTree.
2945
# TODO: always use the local disk path for the working tree,
2946
# this obviously requires a format that supports branch references
2947
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2949
format = self.resolve_format(format=format)
2950
b = self.make_branch(relpath, format=format)
2952
return b.bzrdir.create_workingtree()
2953
except errors.NotLocalUrl:
2954
# We can only make working trees locally at the moment. If the
2955
# transport can't support them, then we keep the non-disk-backed
2956
# branch and create a local checkout.
2957
if self.vfs_transport_factory is test_server.LocalURLServer:
2958
# the branch is colocated on disk, we cannot create a checkout.
2959
# hopefully callers will expect this.
2960
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2961
wt = local_controldir.create_workingtree()
2962
if wt.branch._format != b._format:
2964
# Make sure that assigning to wt._branch fixes wt.branch,
2965
# in case the implementation details of workingtree objects
2967
self.assertIs(b, wt.branch)
2970
return b.create_checkout(relpath, lightweight=True)
2972
def assertIsDirectory(self, relpath, transport):
2973
"""Assert that relpath within transport is a directory.
2975
This may not be possible on all transports; in that case it propagates
2976
a TransportNotPossible.
2979
mode = transport.stat(relpath).st_mode
2980
except errors.NoSuchFile:
2981
self.fail("path %s is not a directory; no such file"
2983
if not stat.S_ISDIR(mode):
2984
self.fail("path %s is not a directory; has mode %#o"
2987
def assertTreesEqual(self, left, right):
2988
"""Check that left and right have the same content and properties."""
2989
# we use a tree delta to check for equality of the content, and we
2990
# manually check for equality of other things such as the parents list.
2991
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2992
differences = left.changes_from(right)
2993
self.assertFalse(differences.has_changed(),
2994
"Trees %r and %r are different: %r" % (left, right, differences))
2997
super(TestCaseWithTransport, self).setUp()
2998
self.__vfs_server = None
3000
def disable_missing_extensions_warning(self):
3001
"""Some tests expect a precise stderr content.
3003
There is no point in forcing them to duplicate the extension related
3006
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
3009
class ChrootedTestCase(TestCaseWithTransport):
3010
"""A support class that provides readonly urls outside the local namespace.
3012
This is done by checking if self.transport_server is a MemoryServer. if it
3013
is then we are chrooted already, if it is not then an HttpServer is used
3016
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
3017
be used without needed to redo it when a different
3018
subclass is in use ?
3022
from bzrlib.tests import http_server
3023
super(ChrootedTestCase, self).setUp()
3024
if not self.vfs_transport_factory == memory.MemoryServer:
3025
self.transport_readonly_server = http_server.HttpServer
3028
def condition_id_re(pattern):
3029
"""Create a condition filter which performs a re check on a test's id.
3031
:param pattern: A regular expression string.
3032
:return: A callable that returns True if the re matches.
3034
filter_re = re.compile(pattern, 0)
3035
def condition(test):
3037
return filter_re.search(test_id)
3041
def condition_isinstance(klass_or_klass_list):
3042
"""Create a condition filter which returns isinstance(param, klass).
3044
:return: A callable which when called with one parameter obj return the
3045
result of isinstance(obj, klass_or_klass_list).
3048
return isinstance(obj, klass_or_klass_list)
3052
def condition_id_in_list(id_list):
3053
"""Create a condition filter which verify that test's id in a list.
3055
:param id_list: A TestIdList object.
3056
:return: A callable that returns True if the test's id appears in the list.
3058
def condition(test):
3059
return id_list.includes(test.id())
3063
def condition_id_startswith(starts):
3064
"""Create a condition filter verifying that test's id starts with a string.
3066
:param starts: A list of string.
3067
:return: A callable that returns True if the test's id starts with one of
3070
def condition(test):
3071
for start in starts:
3072
if test.id().startswith(start):
3078
def exclude_tests_by_condition(suite, condition):
3079
"""Create a test suite which excludes some tests from suite.
3081
:param suite: The suite to get tests from.
3082
:param condition: A callable whose result evaluates True when called with a
3083
test case which should be excluded from the result.
3084
:return: A suite which contains the tests found in suite that fail
3088
for test in iter_suite_tests(suite):
3089
if not condition(test):
3091
return TestUtil.TestSuite(result)
3094
def filter_suite_by_condition(suite, condition):
3095
"""Create a test suite by filtering another one.
3097
:param suite: The source suite.
3098
:param condition: A callable whose result evaluates True when called with a
3099
test case which should be included in the result.
3100
:return: A suite which contains the tests found in suite that pass
3104
for test in iter_suite_tests(suite):
3107
return TestUtil.TestSuite(result)
3110
def filter_suite_by_re(suite, pattern):
3111
"""Create a test suite by filtering another one.
3113
:param suite: the source suite
3114
:param pattern: pattern that names must match
3115
:returns: the newly created suite
3117
condition = condition_id_re(pattern)
3118
result_suite = filter_suite_by_condition(suite, condition)
3122
def filter_suite_by_id_list(suite, test_id_list):
3123
"""Create a test suite by filtering another one.
3125
:param suite: The source suite.
3126
:param test_id_list: A list of the test ids to keep as strings.
3127
:returns: the newly created suite
3129
condition = condition_id_in_list(test_id_list)
3130
result_suite = filter_suite_by_condition(suite, condition)
3134
def filter_suite_by_id_startswith(suite, start):
3135
"""Create a test suite by filtering another one.
3137
:param suite: The source suite.
3138
:param start: A list of string the test id must start with one of.
3139
:returns: the newly created suite
3141
condition = condition_id_startswith(start)
3142
result_suite = filter_suite_by_condition(suite, condition)
3146
def exclude_tests_by_re(suite, pattern):
3147
"""Create a test suite which excludes some tests from suite.
3149
:param suite: The suite to get tests from.
3150
:param pattern: A regular expression string. Test ids that match this
3151
pattern will be excluded from the result.
3152
:return: A TestSuite that contains all the tests from suite without the
3153
tests that matched pattern. The order of tests is the same as it was in
3156
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3159
def preserve_input(something):
3160
"""A helper for performing test suite transformation chains.
3162
:param something: Anything you want to preserve.
3168
def randomize_suite(suite):
3169
"""Return a new TestSuite with suite's tests in random order.
3171
The tests in the input suite are flattened into a single suite in order to
3172
accomplish this. Any nested TestSuites are removed to provide global
3175
tests = list(iter_suite_tests(suite))
3176
random.shuffle(tests)
3177
return TestUtil.TestSuite(tests)
3180
def split_suite_by_condition(suite, condition):
3181
"""Split a test suite into two by a condition.
3183
:param suite: The suite to split.
3184
:param condition: The condition to match on. Tests that match this
3185
condition are returned in the first test suite, ones that do not match
3186
are in the second suite.
3187
:return: A tuple of two test suites, where the first contains tests from
3188
suite matching the condition, and the second contains the remainder
3189
from suite. The order within each output suite is the same as it was in
3194
for test in iter_suite_tests(suite):
3196
matched.append(test)
3198
did_not_match.append(test)
3199
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3202
def split_suite_by_re(suite, pattern):
3203
"""Split a test suite into two by a regular expression.
3205
:param suite: The suite to split.
3206
:param pattern: A regular expression string. Test ids that match this
3207
pattern will be in the first test suite returned, and the others in the
3208
second test suite returned.
3209
:return: A tuple of two test suites, where the first contains tests from
3210
suite matching pattern, and the second contains the remainder from
3211
suite. The order within each output suite is the same as it was in
3214
return split_suite_by_condition(suite, condition_id_re(pattern))
3217
def run_suite(suite, name='test', verbose=False, pattern=".*",
3218
stop_on_failure=False,
3219
transport=None, lsprof_timed=None, bench_history=None,
3220
matching_tests_first=None,
3223
exclude_pattern=None,
3226
suite_decorators=None,
3228
result_decorators=None,
3230
"""Run a test suite for bzr selftest.
3232
:param runner_class: The class of runner to use. Must support the
3233
constructor arguments passed by run_suite which are more than standard
3235
:return: A boolean indicating success.
3237
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3242
if runner_class is None:
3243
runner_class = TextTestRunner
3246
runner = runner_class(stream=stream,
3248
verbosity=verbosity,
3249
bench_history=bench_history,
3251
result_decorators=result_decorators,
3253
runner.stop_on_failure=stop_on_failure
3254
# built in decorator factories:
3256
random_order(random_seed, runner),
3257
exclude_tests(exclude_pattern),
3259
if matching_tests_first:
3260
decorators.append(tests_first(pattern))
3262
decorators.append(filter_tests(pattern))
3263
if suite_decorators:
3264
decorators.extend(suite_decorators)
3265
# tell the result object how many tests will be running: (except if
3266
# --parallel=fork is being used. Robert said he will provide a better
3267
# progress design later -- vila 20090817)
3268
if fork_decorator not in decorators:
3269
decorators.append(CountingDecorator)
3270
for decorator in decorators:
3271
suite = decorator(suite)
3273
# Done after test suite decoration to allow randomisation etc
3274
# to take effect, though that is of marginal benefit.
3276
stream.write("Listing tests only ...\n")
3277
for t in iter_suite_tests(suite):
3278
stream.write("%s\n" % (t.id()))
3280
result = runner.run(suite)
3282
return result.wasStrictlySuccessful()
3284
return result.wasSuccessful()
3287
# A registry where get() returns a suite decorator.
3288
parallel_registry = registry.Registry()
3291
def fork_decorator(suite):
3292
if getattr(os, "fork", None) is None:
3293
raise errors.BzrCommandError("platform does not support fork,"
3294
" try --parallel=subprocess instead.")
3295
concurrency = osutils.local_concurrency()
3296
if concurrency == 1:
3298
from testtools import ConcurrentTestSuite
3299
return ConcurrentTestSuite(suite, fork_for_tests)
3300
parallel_registry.register('fork', fork_decorator)
3303
def subprocess_decorator(suite):
3304
concurrency = osutils.local_concurrency()
3305
if concurrency == 1:
3307
from testtools import ConcurrentTestSuite
3308
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3309
parallel_registry.register('subprocess', subprocess_decorator)
3312
def exclude_tests(exclude_pattern):
3313
"""Return a test suite decorator that excludes tests."""
3314
if exclude_pattern is None:
3315
return identity_decorator
3316
def decorator(suite):
3317
return ExcludeDecorator(suite, exclude_pattern)
3321
def filter_tests(pattern):
3323
return identity_decorator
3324
def decorator(suite):
3325
return FilterTestsDecorator(suite, pattern)
3329
def random_order(random_seed, runner):
3330
"""Return a test suite decorator factory for randomising tests order.
3332
:param random_seed: now, a string which casts to a long, or a long.
3333
:param runner: A test runner with a stream attribute to report on.
3335
if random_seed is None:
3336
return identity_decorator
3337
def decorator(suite):
3338
return RandomDecorator(suite, random_seed, runner.stream)
3342
def tests_first(pattern):
3344
return identity_decorator
3345
def decorator(suite):
3346
return TestFirstDecorator(suite, pattern)
3350
def identity_decorator(suite):
3355
class TestDecorator(TestUtil.TestSuite):
3356
"""A decorator for TestCase/TestSuite objects.
3358
Usually, subclasses should override __iter__(used when flattening test
3359
suites), which we do to filter, reorder, parallelise and so on, run() and
3363
def __init__(self, suite):
3364
TestUtil.TestSuite.__init__(self)
3367
def countTestCases(self):
3370
cases += test.countTestCases()
3377
def run(self, result):
3378
# Use iteration on self, not self._tests, to allow subclasses to hook
3381
if result.shouldStop:
3387
class CountingDecorator(TestDecorator):
3388
"""A decorator which calls result.progress(self.countTestCases)."""
3390
def run(self, result):
3391
progress_method = getattr(result, 'progress', None)
3392
if callable(progress_method):
3393
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3394
return super(CountingDecorator, self).run(result)
3397
class ExcludeDecorator(TestDecorator):
3398
"""A decorator which excludes test matching an exclude pattern."""
3400
def __init__(self, suite, exclude_pattern):
3401
TestDecorator.__init__(self, suite)
3402
self.exclude_pattern = exclude_pattern
3403
self.excluded = False
3407
return iter(self._tests)
3408
self.excluded = True
3409
suite = exclude_tests_by_re(self, self.exclude_pattern)
3411
self.addTests(suite)
3412
return iter(self._tests)
3415
class FilterTestsDecorator(TestDecorator):
3416
"""A decorator which filters tests to those matching a pattern."""
3418
def __init__(self, suite, pattern):
3419
TestDecorator.__init__(self, suite)
3420
self.pattern = pattern
3421
self.filtered = False
3425
return iter(self._tests)
3426
self.filtered = True
3427
suite = filter_suite_by_re(self, self.pattern)
3429
self.addTests(suite)
3430
return iter(self._tests)
3433
class RandomDecorator(TestDecorator):
3434
"""A decorator which randomises the order of its tests."""
3436
def __init__(self, suite, random_seed, stream):
3437
TestDecorator.__init__(self, suite)
3438
self.random_seed = random_seed
3439
self.randomised = False
3440
self.stream = stream
3444
return iter(self._tests)
3445
self.randomised = True
3446
self.stream.write("Randomizing test order using seed %s\n\n" %
3447
(self.actual_seed()))
3448
# Initialise the random number generator.
3449
random.seed(self.actual_seed())
3450
suite = randomize_suite(self)
3452
self.addTests(suite)
3453
return iter(self._tests)
3455
def actual_seed(self):
3456
if self.random_seed == "now":
3457
# We convert the seed to a long to make it reuseable across
3458
# invocations (because the user can reenter it).
3459
self.random_seed = long(time.time())
3461
# Convert the seed to a long if we can
3463
self.random_seed = long(self.random_seed)
3466
return self.random_seed
3469
class TestFirstDecorator(TestDecorator):
3470
"""A decorator which moves named tests to the front."""
3472
def __init__(self, suite, pattern):
3473
TestDecorator.__init__(self, suite)
3474
self.pattern = pattern
3475
self.filtered = False
3479
return iter(self._tests)
3480
self.filtered = True
3481
suites = split_suite_by_re(self, self.pattern)
3483
self.addTests(suites)
3484
return iter(self._tests)
3487
def partition_tests(suite, count):
3488
"""Partition suite into count lists of tests."""
3489
# This just assigns tests in a round-robin fashion. On one hand this
3490
# splits up blocks of related tests that might run faster if they shared
3491
# resources, but on the other it avoids assigning blocks of slow tests to
3492
# just one partition. So the slowest partition shouldn't be much slower
3494
partitions = [list() for i in range(count)]
3495
tests = iter_suite_tests(suite)
3496
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3497
partition.append(test)
3501
def workaround_zealous_crypto_random():
3502
"""Crypto.Random want to help us being secure, but we don't care here.
3504
This workaround some test failure related to the sftp server. Once paramiko
3505
stop using the controversial API in Crypto.Random, we may get rid of it.
3508
from Crypto.Random import atfork
3514
def fork_for_tests(suite):
3515
"""Take suite and start up one runner per CPU by forking()
3517
:return: An iterable of TestCase-like objects which can each have
3518
run(result) called on them to feed tests to result.
3520
concurrency = osutils.local_concurrency()
3522
from subunit import TestProtocolClient, ProtocolTestCase
3523
from subunit.test_results import AutoTimingTestResultDecorator
3524
class TestInOtherProcess(ProtocolTestCase):
3525
# Should be in subunit, I think. RBC.
3526
def __init__(self, stream, pid):
3527
ProtocolTestCase.__init__(self, stream)
3530
def run(self, result):
3532
ProtocolTestCase.run(self, result)
3534
os.waitpid(self.pid, 0)
3536
test_blocks = partition_tests(suite, concurrency)
3537
for process_tests in test_blocks:
3538
process_suite = TestUtil.TestSuite()
3539
process_suite.addTests(process_tests)
3540
c2pread, c2pwrite = os.pipe()
3543
workaround_zealous_crypto_random()
3546
# Leave stderr and stdout open so we can see test noise
3547
# Close stdin so that the child goes away if it decides to
3548
# read from stdin (otherwise its a roulette to see what
3549
# child actually gets keystrokes for pdb etc).
3552
stream = os.fdopen(c2pwrite, 'wb', 1)
3553
subunit_result = AutoTimingTestResultDecorator(
3554
TestProtocolClient(stream))
3555
process_suite.run(subunit_result)
3560
stream = os.fdopen(c2pread, 'rb', 1)
3561
test = TestInOtherProcess(stream, pid)
3566
def reinvoke_for_tests(suite):
3567
"""Take suite and start up one runner per CPU using subprocess().
3569
:return: An iterable of TestCase-like objects which can each have
3570
run(result) called on them to feed tests to result.
3572
concurrency = osutils.local_concurrency()
3574
from subunit import ProtocolTestCase
3575
class TestInSubprocess(ProtocolTestCase):
3576
def __init__(self, process, name):
3577
ProtocolTestCase.__init__(self, process.stdout)
3578
self.process = process
3579
self.process.stdin.close()
3582
def run(self, result):
3584
ProtocolTestCase.run(self, result)
3587
os.unlink(self.name)
3588
# print "pid %d finished" % finished_process
3589
test_blocks = partition_tests(suite, concurrency)
3590
for process_tests in test_blocks:
3591
# ugly; currently reimplement rather than reuses TestCase methods.
3592
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3593
if not os.path.isfile(bzr_path):
3594
# We are probably installed. Assume sys.argv is the right file
3595
bzr_path = sys.argv[0]
3596
bzr_path = [bzr_path]
3597
if sys.platform == "win32":
3598
# if we're on windows, we can't execute the bzr script directly
3599
bzr_path = [sys.executable] + bzr_path
3600
fd, test_list_file_name = tempfile.mkstemp()
3601
test_list_file = os.fdopen(fd, 'wb', 1)
3602
for test in process_tests:
3603
test_list_file.write(test.id() + '\n')
3604
test_list_file.close()
3606
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3608
if '--no-plugins' in sys.argv:
3609
argv.append('--no-plugins')
3610
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3611
# noise on stderr it can interrupt the subunit protocol.
3612
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3613
stdout=subprocess.PIPE,
3614
stderr=subprocess.PIPE,
3616
test = TestInSubprocess(process, test_list_file_name)
3619
os.unlink(test_list_file_name)
3624
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3625
"""Generate profiling data for all activity between start and success.
3627
The profile data is appended to the test's _benchcalls attribute and can
3628
be accessed by the forwarded-to TestResult.
3630
While it might be cleaner do accumulate this in stopTest, addSuccess is
3631
where our existing output support for lsprof is, and this class aims to
3632
fit in with that: while it could be moved it's not necessary to accomplish
3633
test profiling, nor would it be dramatically cleaner.
3636
def startTest(self, test):
3637
self.profiler = bzrlib.lsprof.BzrProfiler()
3638
# Prevent deadlocks in tests that use lsprof: those tests will
3640
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3641
self.profiler.start()
3642
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3644
def addSuccess(self, test):
3645
stats = self.profiler.stop()
3647
calls = test._benchcalls
3648
except AttributeError:
3649
test._benchcalls = []
3650
calls = test._benchcalls
3651
calls.append(((test.id(), "", ""), stats))
3652
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3654
def stopTest(self, test):
3655
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3656
self.profiler = None
3659
# Controlled by "bzr selftest -E=..." option
3660
# Currently supported:
3661
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3662
# preserves any flags supplied at the command line.
3663
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3664
# rather than failing tests. And no longer raise
3665
# LockContention when fctnl locks are not being used
3666
# with proper exclusion rules.
3667
# -Ethreads Will display thread ident at creation/join time to
3668
# help track thread leaks
3670
# -Econfig_stats Will collect statistics using addDetail
3671
selftest_debug_flags = set()
3674
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3676
test_suite_factory=None,
3679
matching_tests_first=None,
3682
exclude_pattern=None,
3688
suite_decorators=None,
3692
"""Run the whole test suite under the enhanced runner"""
3693
# XXX: Very ugly way to do this...
3694
# Disable warning about old formats because we don't want it to disturb
3695
# any blackbox tests.
3696
from bzrlib import repository
3697
repository._deprecation_warning_done = True
3699
global default_transport
3700
if transport is None:
3701
transport = default_transport
3702
old_transport = default_transport
3703
default_transport = transport
3704
global selftest_debug_flags
3705
old_debug_flags = selftest_debug_flags
3706
if debug_flags is not None:
3707
selftest_debug_flags = set(debug_flags)
3709
if load_list is None:
3712
keep_only = load_test_id_list(load_list)
3714
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3715
for start in starting_with]
3716
if test_suite_factory is None:
3717
# Reduce loading time by loading modules based on the starting_with
3719
suite = test_suite(keep_only, starting_with)
3721
suite = test_suite_factory()
3723
# But always filter as requested.
3724
suite = filter_suite_by_id_startswith(suite, starting_with)
3725
result_decorators = []
3727
result_decorators.append(ProfileResult)
3728
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3729
stop_on_failure=stop_on_failure,
3730
transport=transport,
3731
lsprof_timed=lsprof_timed,
3732
bench_history=bench_history,
3733
matching_tests_first=matching_tests_first,
3734
list_only=list_only,
3735
random_seed=random_seed,
3736
exclude_pattern=exclude_pattern,
3738
runner_class=runner_class,
3739
suite_decorators=suite_decorators,
3741
result_decorators=result_decorators,
3744
default_transport = old_transport
3745
selftest_debug_flags = old_debug_flags
3748
def load_test_id_list(file_name):
3749
"""Load a test id list from a text file.
3751
The format is one test id by line. No special care is taken to impose
3752
strict rules, these test ids are used to filter the test suite so a test id
3753
that do not match an existing test will do no harm. This allows user to add
3754
comments, leave blank lines, etc.
3758
ftest = open(file_name, 'rt')
3760
if e.errno != errno.ENOENT:
3763
raise errors.NoSuchFile(file_name)
3765
for test_name in ftest.readlines():
3766
test_list.append(test_name.strip())
3771
def suite_matches_id_list(test_suite, id_list):
3772
"""Warns about tests not appearing or appearing more than once.
3774
:param test_suite: A TestSuite object.
3775
:param test_id_list: The list of test ids that should be found in
3778
:return: (absents, duplicates) absents is a list containing the test found
3779
in id_list but not in test_suite, duplicates is a list containing the
3780
test found multiple times in test_suite.
3782
When using a prefined test id list, it may occurs that some tests do not
3783
exist anymore or that some tests use the same id. This function warns the
3784
tester about potential problems in his workflow (test lists are volatile)
3785
or in the test suite itself (using the same id for several tests does not
3786
help to localize defects).
3788
# Build a dict counting id occurrences
3790
for test in iter_suite_tests(test_suite):
3792
tests[id] = tests.get(id, 0) + 1
3797
occurs = tests.get(id, 0)
3799
not_found.append(id)
3801
duplicates.append(id)
3803
return not_found, duplicates
3806
class TestIdList(object):
3807
"""Test id list to filter a test suite.
3809
Relying on the assumption that test ids are built as:
3810
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3811
notation, this class offers methods to :
3812
- avoid building a test suite for modules not refered to in the test list,
3813
- keep only the tests listed from the module test suite.
3816
def __init__(self, test_id_list):
3817
# When a test suite needs to be filtered against us we compare test ids
3818
# for equality, so a simple dict offers a quick and simple solution.
3819
self.tests = dict().fromkeys(test_id_list, True)
3821
# While unittest.TestCase have ids like:
3822
# <module>.<class>.<method>[(<param+)],
3823
# doctest.DocTestCase can have ids like:
3826
# <module>.<function>
3827
# <module>.<class>.<method>
3829
# Since we can't predict a test class from its name only, we settle on
3830
# a simple constraint: a test id always begins with its module name.
3833
for test_id in test_id_list:
3834
parts = test_id.split('.')
3835
mod_name = parts.pop(0)
3836
modules[mod_name] = True
3838
mod_name += '.' + part
3839
modules[mod_name] = True
3840
self.modules = modules
3842
def refers_to(self, module_name):
3843
"""Is there tests for the module or one of its sub modules."""
3844
return self.modules.has_key(module_name)
3846
def includes(self, test_id):
3847
return self.tests.has_key(test_id)
3850
class TestPrefixAliasRegistry(registry.Registry):
3851
"""A registry for test prefix aliases.
3853
This helps implement shorcuts for the --starting-with selftest
3854
option. Overriding existing prefixes is not allowed but not fatal (a
3855
warning will be emitted).
3858
def register(self, key, obj, help=None, info=None,
3859
override_existing=False):
3860
"""See Registry.register.
3862
Trying to override an existing alias causes a warning to be emitted,
3863
not a fatal execption.
3866
super(TestPrefixAliasRegistry, self).register(
3867
key, obj, help=help, info=info, override_existing=False)
3869
actual = self.get(key)
3871
'Test prefix alias %s is already used for %s, ignoring %s'
3872
% (key, actual, obj))
3874
def resolve_alias(self, id_start):
3875
"""Replace the alias by the prefix in the given string.
3877
Using an unknown prefix is an error to help catching typos.
3879
parts = id_start.split('.')
3881
parts[0] = self.get(parts[0])
3883
raise errors.BzrCommandError(
3884
'%s is not a known test prefix alias' % parts[0])
3885
return '.'.join(parts)
3888
test_prefix_alias_registry = TestPrefixAliasRegistry()
3889
"""Registry of test prefix aliases."""
3892
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3893
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3894
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3896
# Obvious highest levels prefixes, feel free to add your own via a plugin
3897
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3898
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3899
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3900
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3901
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3904
def _test_suite_testmod_names():
3905
"""Return the standard list of test module names to test."""
3908
'bzrlib.tests.blackbox',
3909
'bzrlib.tests.commands',
3910
'bzrlib.tests.doc_generate',
3911
'bzrlib.tests.per_branch',
3912
'bzrlib.tests.per_bzrdir',
3913
'bzrlib.tests.per_controldir',
3914
'bzrlib.tests.per_controldir_colo',
3915
'bzrlib.tests.per_foreign_vcs',
3916
'bzrlib.tests.per_interrepository',
3917
'bzrlib.tests.per_intertree',
3918
'bzrlib.tests.per_inventory',
3919
'bzrlib.tests.per_interbranch',
3920
'bzrlib.tests.per_lock',
3921
'bzrlib.tests.per_merger',
3922
'bzrlib.tests.per_transport',
3923
'bzrlib.tests.per_tree',
3924
'bzrlib.tests.per_pack_repository',
3925
'bzrlib.tests.per_repository',
3926
'bzrlib.tests.per_repository_chk',
3927
'bzrlib.tests.per_repository_reference',
3928
'bzrlib.tests.per_repository_vf',
3929
'bzrlib.tests.per_uifactory',
3930
'bzrlib.tests.per_versionedfile',
3931
'bzrlib.tests.per_workingtree',
3932
'bzrlib.tests.test__annotator',
3933
'bzrlib.tests.test__bencode',
3934
'bzrlib.tests.test__btree_serializer',
3935
'bzrlib.tests.test__chk_map',
3936
'bzrlib.tests.test__dirstate_helpers',
3937
'bzrlib.tests.test__groupcompress',
3938
'bzrlib.tests.test__known_graph',
3939
'bzrlib.tests.test__rio',
3940
'bzrlib.tests.test__simple_set',
3941
'bzrlib.tests.test__static_tuple',
3942
'bzrlib.tests.test__walkdirs_win32',
3943
'bzrlib.tests.test_ancestry',
3944
'bzrlib.tests.test_annotate',
3945
'bzrlib.tests.test_api',
3946
'bzrlib.tests.test_atomicfile',
3947
'bzrlib.tests.test_bad_files',
3948
'bzrlib.tests.test_bisect_multi',
3949
'bzrlib.tests.test_branch',
3950
'bzrlib.tests.test_branchbuilder',
3951
'bzrlib.tests.test_btree_index',
3952
'bzrlib.tests.test_bugtracker',
3953
'bzrlib.tests.test_bundle',
3954
'bzrlib.tests.test_bzrdir',
3955
'bzrlib.tests.test__chunks_to_lines',
3956
'bzrlib.tests.test_cache_utf8',
3957
'bzrlib.tests.test_chk_map',
3958
'bzrlib.tests.test_chk_serializer',
3959
'bzrlib.tests.test_chunk_writer',
3960
'bzrlib.tests.test_clean_tree',
3961
'bzrlib.tests.test_cleanup',
3962
'bzrlib.tests.test_cmdline',
3963
'bzrlib.tests.test_commands',
3964
'bzrlib.tests.test_commit',
3965
'bzrlib.tests.test_commit_merge',
3966
'bzrlib.tests.test_config',
3967
'bzrlib.tests.test_conflicts',
3968
'bzrlib.tests.test_controldir',
3969
'bzrlib.tests.test_counted_lock',
3970
'bzrlib.tests.test_crash',
3971
'bzrlib.tests.test_decorators',
3972
'bzrlib.tests.test_delta',
3973
'bzrlib.tests.test_debug',
3974
'bzrlib.tests.test_diff',
3975
'bzrlib.tests.test_directory_service',
3976
'bzrlib.tests.test_dirstate',
3977
'bzrlib.tests.test_email_message',
3978
'bzrlib.tests.test_eol_filters',
3979
'bzrlib.tests.test_errors',
3980
'bzrlib.tests.test_estimate_compressed_size',
3981
'bzrlib.tests.test_export',
3982
'bzrlib.tests.test_export_pot',
3983
'bzrlib.tests.test_extract',
3984
'bzrlib.tests.test_features',
3985
'bzrlib.tests.test_fetch',
3986
'bzrlib.tests.test_fixtures',
3987
'bzrlib.tests.test_fifo_cache',
3988
'bzrlib.tests.test_filters',
3989
'bzrlib.tests.test_filter_tree',
3990
'bzrlib.tests.test_ftp_transport',
3991
'bzrlib.tests.test_foreign',
3992
'bzrlib.tests.test_generate_docs',
3993
'bzrlib.tests.test_generate_ids',
3994
'bzrlib.tests.test_globbing',
3995
'bzrlib.tests.test_gpg',
3996
'bzrlib.tests.test_graph',
3997
'bzrlib.tests.test_groupcompress',
3998
'bzrlib.tests.test_hashcache',
3999
'bzrlib.tests.test_help',
4000
'bzrlib.tests.test_hooks',
4001
'bzrlib.tests.test_http',
4002
'bzrlib.tests.test_http_response',
4003
'bzrlib.tests.test_https_ca_bundle',
4004
'bzrlib.tests.test_i18n',
4005
'bzrlib.tests.test_identitymap',
4006
'bzrlib.tests.test_ignores',
4007
'bzrlib.tests.test_index',
4008
'bzrlib.tests.test_import_tariff',
4009
'bzrlib.tests.test_info',
4010
'bzrlib.tests.test_inv',
4011
'bzrlib.tests.test_inventory_delta',
4012
'bzrlib.tests.test_knit',
4013
'bzrlib.tests.test_lazy_import',
4014
'bzrlib.tests.test_lazy_regex',
4015
'bzrlib.tests.test_library_state',
4016
'bzrlib.tests.test_lock',
4017
'bzrlib.tests.test_lockable_files',
4018
'bzrlib.tests.test_lockdir',
4019
'bzrlib.tests.test_log',
4020
'bzrlib.tests.test_lru_cache',
4021
'bzrlib.tests.test_lsprof',
4022
'bzrlib.tests.test_mail_client',
4023
'bzrlib.tests.test_matchers',
4024
'bzrlib.tests.test_memorytree',
4025
'bzrlib.tests.test_merge',
4026
'bzrlib.tests.test_merge3',
4027
'bzrlib.tests.test_merge_core',
4028
'bzrlib.tests.test_merge_directive',
4029
'bzrlib.tests.test_mergetools',
4030
'bzrlib.tests.test_missing',
4031
'bzrlib.tests.test_msgeditor',
4032
'bzrlib.tests.test_multiparent',
4033
'bzrlib.tests.test_mutabletree',
4034
'bzrlib.tests.test_nonascii',
4035
'bzrlib.tests.test_options',
4036
'bzrlib.tests.test_osutils',
4037
'bzrlib.tests.test_osutils_encodings',
4038
'bzrlib.tests.test_pack',
4039
'bzrlib.tests.test_patch',
4040
'bzrlib.tests.test_patches',
4041
'bzrlib.tests.test_permissions',
4042
'bzrlib.tests.test_plugins',
4043
'bzrlib.tests.test_progress',
4044
'bzrlib.tests.test_pyutils',
4045
'bzrlib.tests.test_read_bundle',
4046
'bzrlib.tests.test_reconcile',
4047
'bzrlib.tests.test_reconfigure',
4048
'bzrlib.tests.test_registry',
4049
'bzrlib.tests.test_remote',
4050
'bzrlib.tests.test_rename_map',
4051
'bzrlib.tests.test_repository',
4052
'bzrlib.tests.test_revert',
4053
'bzrlib.tests.test_revision',
4054
'bzrlib.tests.test_revisionspec',
4055
'bzrlib.tests.test_revisiontree',
4056
'bzrlib.tests.test_rio',
4057
'bzrlib.tests.test_rules',
4058
'bzrlib.tests.test_sampler',
4059
'bzrlib.tests.test_scenarios',
4060
'bzrlib.tests.test_script',
4061
'bzrlib.tests.test_selftest',
4062
'bzrlib.tests.test_serializer',
4063
'bzrlib.tests.test_setup',
4064
'bzrlib.tests.test_sftp_transport',
4065
'bzrlib.tests.test_shelf',
4066
'bzrlib.tests.test_shelf_ui',
4067
'bzrlib.tests.test_smart',
4068
'bzrlib.tests.test_smart_add',
4069
'bzrlib.tests.test_smart_request',
4070
'bzrlib.tests.test_smart_signals',
4071
'bzrlib.tests.test_smart_transport',
4072
'bzrlib.tests.test_smtp_connection',
4073
'bzrlib.tests.test_source',
4074
'bzrlib.tests.test_ssh_transport',
4075
'bzrlib.tests.test_status',
4076
'bzrlib.tests.test_store',
4077
'bzrlib.tests.test_strace',
4078
'bzrlib.tests.test_subsume',
4079
'bzrlib.tests.test_switch',
4080
'bzrlib.tests.test_symbol_versioning',
4081
'bzrlib.tests.test_tag',
4082
'bzrlib.tests.test_test_server',
4083
'bzrlib.tests.test_testament',
4084
'bzrlib.tests.test_textfile',
4085
'bzrlib.tests.test_textmerge',
4086
'bzrlib.tests.test_cethread',
4087
'bzrlib.tests.test_timestamp',
4088
'bzrlib.tests.test_trace',
4089
'bzrlib.tests.test_transactions',
4090
'bzrlib.tests.test_transform',
4091
'bzrlib.tests.test_transport',
4092
'bzrlib.tests.test_transport_log',
4093
'bzrlib.tests.test_tree',
4094
'bzrlib.tests.test_treebuilder',
4095
'bzrlib.tests.test_treeshape',
4096
'bzrlib.tests.test_tsort',
4097
'bzrlib.tests.test_tuned_gzip',
4098
'bzrlib.tests.test_ui',
4099
'bzrlib.tests.test_uncommit',
4100
'bzrlib.tests.test_upgrade',
4101
'bzrlib.tests.test_upgrade_stacked',
4102
'bzrlib.tests.test_urlutils',
4103
'bzrlib.tests.test_utextwrap',
4104
'bzrlib.tests.test_version',
4105
'bzrlib.tests.test_version_info',
4106
'bzrlib.tests.test_versionedfile',
4107
'bzrlib.tests.test_weave',
4108
'bzrlib.tests.test_whitebox',
4109
'bzrlib.tests.test_win32utils',
4110
'bzrlib.tests.test_workingtree',
4111
'bzrlib.tests.test_workingtree_4',
4112
'bzrlib.tests.test_wsgi',
4113
'bzrlib.tests.test_xml',
4117
def _test_suite_modules_to_doctest():
4118
"""Return the list of modules to doctest."""
4120
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4124
'bzrlib.branchbuilder',
4125
'bzrlib.decorators',
4127
'bzrlib.iterablefile',
4132
'bzrlib.symbol_versioning',
4134
'bzrlib.tests.fixtures',
4136
'bzrlib.transport.http',
4137
'bzrlib.version_info_formats.format_custom',
4141
def test_suite(keep_only=None, starting_with=None):
4142
"""Build and return TestSuite for the whole of bzrlib.
4144
:param keep_only: A list of test ids limiting the suite returned.
4146
:param starting_with: An id limiting the suite returned to the tests
4149
This function can be replaced if you need to change the default test
4150
suite on a global basis, but it is not encouraged.
4153
loader = TestUtil.TestLoader()
4155
if keep_only is not None:
4156
id_filter = TestIdList(keep_only)
4158
# We take precedence over keep_only because *at loading time* using
4159
# both options means we will load less tests for the same final result.
4160
def interesting_module(name):
4161
for start in starting_with:
4163
# Either the module name starts with the specified string
4164
name.startswith(start)
4165
# or it may contain tests starting with the specified string
4166
or start.startswith(name)
4170
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4172
elif keep_only is not None:
4173
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4174
def interesting_module(name):
4175
return id_filter.refers_to(name)
4178
loader = TestUtil.TestLoader()
4179
def interesting_module(name):
4180
# No filtering, all modules are interesting
4183
suite = loader.suiteClass()
4185
# modules building their suite with loadTestsFromModuleNames
4186
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4188
for mod in _test_suite_modules_to_doctest():
4189
if not interesting_module(mod):
4190
# No tests to keep here, move along
4193
# note that this really does mean "report only" -- doctest
4194
# still runs the rest of the examples
4195
doc_suite = IsolatedDocTestSuite(
4196
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
4197
except ValueError, e:
4198
print '**failed to get doctest for: %s\n%s' % (mod, e)
4200
if len(doc_suite._tests) == 0:
4201
raise errors.BzrError("no doctests found in %s" % (mod,))
4202
suite.addTest(doc_suite)
4204
default_encoding = sys.getdefaultencoding()
4205
for name, plugin in _mod_plugin.plugins().items():
4206
if not interesting_module(plugin.module.__name__):
4208
plugin_suite = plugin.test_suite()
4209
# We used to catch ImportError here and turn it into just a warning,
4210
# but really if you don't have --no-plugins this should be a failure.
4211
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4212
if plugin_suite is None:
4213
plugin_suite = plugin.load_plugin_tests(loader)
4214
if plugin_suite is not None:
4215
suite.addTest(plugin_suite)
4216
if default_encoding != sys.getdefaultencoding():
4218
'Plugin "%s" tried to reset default encoding to: %s', name,
4219
sys.getdefaultencoding())
4221
sys.setdefaultencoding(default_encoding)
4223
if keep_only is not None:
4224
# Now that the referred modules have loaded their tests, keep only the
4226
suite = filter_suite_by_id_list(suite, id_filter)
4227
# Do some sanity checks on the id_list filtering
4228
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4230
# The tester has used both keep_only and starting_with, so he is
4231
# already aware that some tests are excluded from the list, there
4232
# is no need to tell him which.
4235
# Some tests mentioned in the list are not in the test suite. The
4236
# list may be out of date, report to the tester.
4237
for id in not_found:
4238
trace.warning('"%s" not found in the test suite', id)
4239
for id in duplicates:
4240
trace.warning('"%s" is used as an id by several tests', id)
4245
def multiply_scenarios(*scenarios):
4246
"""Multiply two or more iterables of scenarios.
4248
It is safe to pass scenario generators or iterators.
4250
:returns: A list of compound scenarios: the cross-product of all
4251
scenarios, with the names concatenated and the parameters
4254
return reduce(_multiply_two_scenarios, map(list, scenarios))
4257
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4258
"""Multiply two sets of scenarios.
4260
:returns: the cartesian product of the two sets of scenarios, that is
4261
a scenario for every possible combination of a left scenario and a
4265
('%s,%s' % (left_name, right_name),
4266
dict(left_dict.items() + right_dict.items()))
4267
for left_name, left_dict in scenarios_left
4268
for right_name, right_dict in scenarios_right]
4271
def multiply_tests(tests, scenarios, result):
4272
"""Multiply tests_list by scenarios into result.
4274
This is the core workhorse for test parameterisation.
4276
Typically the load_tests() method for a per-implementation test suite will
4277
call multiply_tests and return the result.
4279
:param tests: The tests to parameterise.
4280
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4281
scenario_param_dict).
4282
:param result: A TestSuite to add created tests to.
4284
This returns the passed in result TestSuite with the cross product of all
4285
the tests repeated once for each scenario. Each test is adapted by adding
4286
the scenario name at the end of its id(), and updating the test object's
4287
__dict__ with the scenario_param_dict.
4289
>>> import bzrlib.tests.test_sampler
4290
>>> r = multiply_tests(
4291
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4292
... [('one', dict(param=1)),
4293
... ('two', dict(param=2))],
4294
... TestUtil.TestSuite())
4295
>>> tests = list(iter_suite_tests(r))
4299
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4305
for test in iter_suite_tests(tests):
4306
apply_scenarios(test, scenarios, result)
4310
def apply_scenarios(test, scenarios, result):
4311
"""Apply the scenarios in scenarios to test and add to result.
4313
:param test: The test to apply scenarios to.
4314
:param scenarios: An iterable of scenarios to apply to test.
4316
:seealso: apply_scenario
4318
for scenario in scenarios:
4319
result.addTest(apply_scenario(test, scenario))
4323
def apply_scenario(test, scenario):
4324
"""Copy test and apply scenario to it.
4326
:param test: A test to adapt.
4327
:param scenario: A tuple describing the scenarion.
4328
The first element of the tuple is the new test id.
4329
The second element is a dict containing attributes to set on the
4331
:return: The adapted test.
4333
new_id = "%s(%s)" % (test.id(), scenario[0])
4334
new_test = clone_test(test, new_id)
4335
for name, value in scenario[1].items():
4336
setattr(new_test, name, value)
4340
def clone_test(test, new_id):
4341
"""Clone a test giving it a new id.
4343
:param test: The test to clone.
4344
:param new_id: The id to assign to it.
4345
:return: The new test.
4347
new_test = copy.copy(test)
4348
new_test.id = lambda: new_id
4349
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4350
# causes cloned tests to share the 'details' dict. This makes it hard to
4351
# read the test output for parameterized tests, because tracebacks will be
4352
# associated with irrelevant tests.
4354
details = new_test._TestCase__details
4355
except AttributeError:
4356
# must be a different version of testtools than expected. Do nothing.
4359
# Reset the '__details' dict.
4360
new_test._TestCase__details = {}
4364
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4366
"""Helper for permutating tests against an extension module.
4368
This is meant to be used inside a modules 'load_tests()' function. It will
4369
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4370
against both implementations. Setting 'test.module' to the appropriate
4371
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4373
:param standard_tests: A test suite to permute
4374
:param loader: A TestLoader
4375
:param py_module_name: The python path to a python module that can always
4376
be loaded, and will be considered the 'python' implementation. (eg
4377
'bzrlib._chk_map_py')
4378
:param ext_module_name: The python path to an extension module. If the
4379
module cannot be loaded, a single test will be added, which notes that
4380
the module is not available. If it can be loaded, all standard_tests
4381
will be run against that module.
4382
:return: (suite, feature) suite is a test-suite that has all the permuted
4383
tests. feature is the Feature object that can be used to determine if
4384
the module is available.
4387
from bzrlib.tests.features import ModuleAvailableFeature
4388
py_module = pyutils.get_named_object(py_module_name)
4390
('python', {'module': py_module}),
4392
suite = loader.suiteClass()
4393
feature = ModuleAvailableFeature(ext_module_name)
4394
if feature.available():
4395
scenarios.append(('C', {'module': feature.module}))
4397
# the compiled module isn't available, so we add a failing test
4398
class FailWithoutFeature(TestCase):
4399
def test_fail(self):
4400
self.requireFeature(feature)
4401
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4402
result = multiply_tests(standard_tests, scenarios, suite)
4403
return result, feature
4406
def _rmtree_temp_dir(dirname, test_id=None):
4407
# If LANG=C we probably have created some bogus paths
4408
# which rmtree(unicode) will fail to delete
4409
# so make sure we are using rmtree(str) to delete everything
4410
# except on win32, where rmtree(str) will fail
4411
# since it doesn't have the property of byte-stream paths
4412
# (they are either ascii or mbcs)
4413
if sys.platform == 'win32':
4414
# make sure we are using the unicode win32 api
4415
dirname = unicode(dirname)
4417
dirname = dirname.encode(sys.getfilesystemencoding())
4419
osutils.rmtree(dirname)
4421
# We don't want to fail here because some useful display will be lost
4422
# otherwise. Polluting the tmp dir is bad, but not giving all the
4423
# possible info to the test runner is even worse.
4425
ui.ui_factory.clear_term()
4426
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4427
# Ugly, but the last thing we want here is fail, so bear with it.
4428
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4429
).encode('ascii', 'replace')
4430
sys.stderr.write('Unable to remove testing dir %s\n%s'
4431
% (os.path.basename(dirname), printable_e))
4434
def probe_unicode_in_user_encoding():
4435
"""Try to encode several unicode strings to use in unicode-aware tests.
4436
Return first successfull match.
4438
:return: (unicode value, encoded plain string value) or (None, None)
4440
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4441
for uni_val in possible_vals:
4443
str_val = uni_val.encode(osutils.get_user_encoding())
4444
except UnicodeEncodeError:
4445
# Try a different character
4448
return uni_val, str_val
4452
def probe_bad_non_ascii(encoding):
4453
"""Try to find [bad] character with code [128..255]
4454
that cannot be decoded to unicode in some encoding.
4455
Return None if all non-ascii characters is valid
4458
for i in xrange(128, 256):
4461
char.decode(encoding)
4462
except UnicodeDecodeError:
4467
# Only define SubUnitBzrRunner if subunit is available.
4469
from subunit import TestProtocolClient
4470
from subunit.test_results import AutoTimingTestResultDecorator
4471
class SubUnitBzrProtocolClient(TestProtocolClient):
4473
def addSuccess(self, test, details=None):
4474
# The subunit client always includes the details in the subunit
4475
# stream, but we don't want to include it in ours.
4476
if details is not None and 'log' in details:
4478
return super(SubUnitBzrProtocolClient, self).addSuccess(
4481
class SubUnitBzrRunner(TextTestRunner):
4482
def run(self, test):
4483
result = AutoTimingTestResultDecorator(
4484
SubUnitBzrProtocolClient(self.stream))
4491
@deprecated_function(deprecated_in((2, 5, 0)))
4492
def ModuleAvailableFeature(name):
4493
from bzrlib.tests import features
4494
return features.ModuleAvailableFeature(name)
added
removed
bzrlib/tests/__init__.py
