1
# Copyright (C) 2005-2013, 2015, 2016 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
from __future__ import absolute_import
21
# NOTE: Some classes in here use camelCaseNaming() rather than
22
# underscore_naming(). That's for consistency with unittest; it's not the
23
# general style of breezy. Please continue that consistency when adding e.g.
24
# new assertFoo() methods.
58
# nb: check this before importing anything else from within it
59
_testtools_version = getattr(testtools, '__version__', ())
60
if _testtools_version < (0, 9, 5):
61
raise ImportError("need at least testtools 0.9.5: %s is %r"
62
% (testtools.__file__, _testtools_version))
63
from testtools import content
69
commands as _mod_commands,
79
plugin as _mod_plugin,
86
transport as _mod_transport,
89
from breezy.bzr import (
95
# lsprof not available
97
from ..sixish import (
103
from ..bzr.smart import client, request
104
from ..transport import (
108
from ..tests import (
115
from ..tests.features import _CompatabilityThunkFeature
117
# Mark this python module as being part of the implementation
118
# of unittest: this gives us better tracebacks where the last
119
# shown frame is the test code, not our assertXYZ.
122
default_transport = test_server.LocalURLServer
125
_unitialized_attr = object()
126
"""A sentinel needed to act as a default value in a method signature."""
129
# Subunit result codes, defined here to prevent a hard dependency on subunit.
133
# These are intentionally brought into this namespace. That way plugins, etc
134
# can just "from breezy.tests import TestCase, TestLoader, etc"
135
TestSuite = TestUtil.TestSuite
136
TestLoader = TestUtil.TestLoader
138
# Tests should run in a clean and clearly defined environment. The goal is to
139
# keep them isolated from the running environment as mush as possible. The test
140
# framework ensures the variables defined below are set (or deleted if the
141
# value is None) before a test is run and reset to their original value after
142
# the test is run. Generally if some code depends on an environment variable,
143
# the tests should start without this variable in the environment. There are a
144
# few exceptions but you shouldn't violate this rule lightly.
149
'XDG_CONFIG_HOME': None,
150
# brz now uses the Win32 API and doesn't rely on APPDATA, but the
151
# tests do check our impls match APPDATA
152
'BRZ_EDITOR': None, # test_msgeditor manipulates this variable
156
'BZREMAIL': None, # may still be present in the environment
157
'EMAIL': 'jrandom@example.com', # set EMAIL as brz does not guess
158
'BRZ_PROGRESS_BAR': None,
159
# This should trap leaks to ~/.brz.log. This occurs when tests use TestCase
160
# as a base class instead of TestCaseInTempDir. Tests inheriting from
161
# TestCase should not use disk resources, BRZ_LOG is one.
162
'BRZ_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
163
'BRZ_PLUGIN_PATH': '-site',
164
'BRZ_DISABLE_PLUGINS': None,
165
'BRZ_PLUGINS_AT': None,
166
'BRZ_CONCURRENCY': None,
167
# Make sure that any text ui tests are consistent regardless of
168
# the environment the test case is run in; you may want tests that
169
# test other combinations. 'dumb' is a reasonable guess for tests
170
# going to a pipe or a BytesIO.
176
'SSH_AUTH_SOCK': None,
186
'BZR_REMOTE_PATH': None,
187
# Generally speaking, we don't want apport reporting on crashes in
188
# the test envirnoment unless we're specifically testing apport,
189
# so that it doesn't leak into the real system environment. We
190
# use an env var so it propagates to subprocesses.
191
'APPORT_DISABLE': '1',
195
def override_os_environ(test, env=None):
196
"""Modify os.environ keeping a copy.
198
:param test: A test instance
200
:param env: A dict containing variable definitions to be installed
203
env = isolated_environ
204
test._original_os_environ = dict(**os.environ)
206
osutils.set_or_unset_env(var, env[var])
207
if var not in test._original_os_environ:
208
# The var is new, add it with a value of None, so
209
# restore_os_environ will delete it
210
test._original_os_environ[var] = None
213
def restore_os_environ(test):
214
"""Restore os.environ to its original state.
216
:param test: A test instance previously passed to override_os_environ.
218
for var, value in test._original_os_environ.items():
219
# Restore the original value (or delete it if the value has been set to
220
# None in override_os_environ).
221
osutils.set_or_unset_env(var, value)
224
def _clear__type_equality_funcs(test):
225
"""Cleanup bound methods stored on TestCase instances
227
Clear the dict breaking a few (mostly) harmless cycles in the affected
228
unittests released with Python 2.6 and initial Python 2.7 versions.
230
For a few revisions between Python 2.7.1 and Python 2.7.2 that annoyingly
231
shipped in Oneiric, an object with no clear method was used, hence the
232
extra complications, see bug 809048 for details.
234
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
235
if type_equality_funcs is not None:
236
tef_clear = getattr(type_equality_funcs, "clear", None)
237
if tef_clear is None:
238
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
239
if tef_instance_dict is not None:
240
tef_clear = tef_instance_dict.clear
241
if tef_clear is not None:
245
class ExtendedTestResult(testtools.TextTestResult):
246
"""Accepts, reports and accumulates the results of running tests.
248
Compared to the unittest version this class adds support for
249
profiling, benchmarking, stopping as soon as a test fails, and
250
skipping tests. There are further-specialized subclasses for
251
different types of display.
253
When a test finishes, in whatever way, it calls one of the addSuccess,
254
addFailure or addError methods. These in turn may redirect to a more
255
specific case for the special test results supported by our extended
258
Note that just one of these objects is fed the results from many tests.
263
def __init__(self, stream, descriptions, verbosity,
267
"""Construct new TestResult.
269
:param bench_history: Optionally, a writable file object to accumulate
272
testtools.TextTestResult.__init__(self, stream)
273
if bench_history is not None:
274
from breezy.version import _get_bzr_source_tree
275
src_tree = _get_bzr_source_tree()
278
revision_id = src_tree.get_parent_ids()[0]
280
# XXX: if this is a brand new tree, do the same as if there
284
# XXX: If there's no branch, what should we do?
286
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
287
self._bench_history = bench_history
288
self.ui = ui.ui_factory
291
self.failure_count = 0
292
self.known_failure_count = 0
294
self.not_applicable_count = 0
295
self.unsupported = {}
297
self._overall_start_time = time.time()
298
self._strict = strict
299
self._first_thread_leaker_id = None
300
self._tests_leaking_threads_count = 0
301
self._traceback_from_test = None
303
def stopTestRun(self):
306
stopTime = time.time()
307
timeTaken = stopTime - self.startTime
308
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
309
# the parent class method is similar have to duplicate
310
self._show_list('ERROR', self.errors)
311
self._show_list('FAIL', self.failures)
312
self.stream.write(self.sep2)
313
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
314
run, run != 1 and "s" or "", timeTaken))
315
if not self.wasSuccessful():
316
self.stream.write("FAILED (")
317
failed, errored = map(len, (self.failures, self.errors))
319
self.stream.write("failures=%d" % failed)
321
if failed: self.stream.write(", ")
322
self.stream.write("errors=%d" % errored)
323
if self.known_failure_count:
324
if failed or errored: self.stream.write(", ")
325
self.stream.write("known_failure_count=%d" %
326
self.known_failure_count)
327
self.stream.write(")\n")
329
if self.known_failure_count:
330
self.stream.write("OK (known_failures=%d)\n" %
331
self.known_failure_count)
333
self.stream.write("OK\n")
334
if self.skip_count > 0:
335
skipped = self.skip_count
336
self.stream.write('%d test%s skipped\n' %
337
(skipped, skipped != 1 and "s" or ""))
339
for feature, count in sorted(self.unsupported.items()):
340
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
343
ok = self.wasStrictlySuccessful()
345
ok = self.wasSuccessful()
346
if self._first_thread_leaker_id:
348
'%s is leaking threads among %d leaking tests.\n' % (
349
self._first_thread_leaker_id,
350
self._tests_leaking_threads_count))
351
# We don't report the main thread as an active one.
353
'%d non-main threads were left active in the end.\n'
354
% (len(self._active_threads) - 1))
356
def getDescription(self, test):
359
def _extractBenchmarkTime(self, testCase, details=None):
360
"""Add a benchmark time for the current test case."""
361
if details and 'benchtime' in details:
362
return float(''.join(details['benchtime'].iter_bytes()))
363
return getattr(testCase, "_benchtime", None)
365
def _delta_to_float(self, a_timedelta, precision):
366
# This calls ceiling to ensure that the most pessimistic view of time
367
# taken is shown (rather than leaving it to the Python %f operator
368
# to decide whether to round/floor/ceiling. This was added when we
369
# had pyp3 test failures that suggest a floor was happening.
370
shift = 10 ** precision
371
return math.ceil((a_timedelta.days * 86400.0 + a_timedelta.seconds +
372
a_timedelta.microseconds / 1000000.0) * shift) / shift
374
def _elapsedTestTimeString(self):
375
"""Return a time string for the overall time the current test has taken."""
376
return self._formatTime(self._delta_to_float(
377
self._now() - self._start_datetime, 3))
379
def _testTimeString(self, testCase):
380
benchmark_time = self._extractBenchmarkTime(testCase)
381
if benchmark_time is not None:
382
return self._formatTime(benchmark_time) + "*"
384
return self._elapsedTestTimeString()
386
def _formatTime(self, seconds):
387
"""Format seconds as milliseconds with leading spaces."""
388
# some benchmarks can take thousands of seconds to run, so we need 8
390
return "%8dms" % (1000 * seconds)
392
def _shortened_test_description(self, test):
394
what = re.sub(r'^breezy\.tests\.', '', what)
397
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
398
# multiple times in a row, because the handler is added for
399
# each test but the container list is shared between cases.
400
# See lp:498869 lp:625574 and lp:637725 for background.
401
def _record_traceback_from_test(self, exc_info):
402
"""Store the traceback from passed exc_info tuple till"""
403
self._traceback_from_test = exc_info[2]
405
def startTest(self, test):
406
super(ExtendedTestResult, self).startTest(test)
410
self.report_test_start(test)
411
test.number = self.count
412
self._recordTestStartTime()
413
# Make testtools cases give us the real traceback on failure
414
addOnException = getattr(test, "addOnException", None)
415
if addOnException is not None:
416
addOnException(self._record_traceback_from_test)
417
# Only check for thread leaks on breezy derived test cases
418
if isinstance(test, TestCase):
419
test.addCleanup(self._check_leaked_threads, test)
421
def stopTest(self, test):
422
super(ExtendedTestResult, self).stopTest(test)
423
# Manually break cycles, means touching various private things but hey
424
getDetails = getattr(test, "getDetails", None)
425
if getDetails is not None:
427
_clear__type_equality_funcs(test)
428
self._traceback_from_test = None
430
def startTests(self):
431
self.report_tests_starting()
432
self._active_threads = threading.enumerate()
434
def _check_leaked_threads(self, test):
435
"""See if any threads have leaked since last call
437
A sample of live threads is stored in the _active_threads attribute,
438
when this method runs it compares the current live threads and any not
439
in the previous sample are treated as having leaked.
441
now_active_threads = set(threading.enumerate())
442
threads_leaked = now_active_threads.difference(self._active_threads)
444
self._report_thread_leak(test, threads_leaked, now_active_threads)
445
self._tests_leaking_threads_count += 1
446
if self._first_thread_leaker_id is None:
447
self._first_thread_leaker_id = test.id()
448
self._active_threads = now_active_threads
450
def _recordTestStartTime(self):
451
"""Record that a test has started."""
452
self._start_datetime = self._now()
454
def addError(self, test, err):
455
"""Tell result that test finished with an error.
457
Called from the TestCase run() method when the test
458
fails with an unexpected error.
460
self._post_mortem(self._traceback_from_test)
461
super(ExtendedTestResult, self).addError(test, err)
462
self.error_count += 1
463
self.report_error(test, err)
467
def addFailure(self, test, err):
468
"""Tell result that test failed.
470
Called from the TestCase run() method when the test
471
fails because e.g. an assert() method failed.
473
self._post_mortem(self._traceback_from_test)
474
super(ExtendedTestResult, self).addFailure(test, err)
475
self.failure_count += 1
476
self.report_failure(test, err)
480
def addSuccess(self, test, details=None):
481
"""Tell result that test completed successfully.
483
Called from the TestCase run()
485
if self._bench_history is not None:
486
benchmark_time = self._extractBenchmarkTime(test, details)
487
if benchmark_time is not None:
488
self._bench_history.write("%s %s\n" % (
489
self._formatTime(benchmark_time),
491
self.report_success(test)
492
super(ExtendedTestResult, self).addSuccess(test)
493
test._log_contents = ''
495
def addExpectedFailure(self, test, err):
496
self.known_failure_count += 1
497
self.report_known_failure(test, err)
499
def addUnexpectedSuccess(self, test, details=None):
500
"""Tell result the test unexpectedly passed, counting as a failure
502
When the minimum version of testtools required becomes 0.9.8 this
503
can be updated to use the new handling there.
505
super(ExtendedTestResult, self).addFailure(test, details=details)
506
self.failure_count += 1
507
self.report_unexpected_success(test,
508
"".join(details["reason"].iter_text()))
512
def addNotSupported(self, test, feature):
513
"""The test will not be run because of a missing feature.
515
# this can be called in two different ways: it may be that the
516
# test started running, and then raised (through requireFeature)
517
# UnavailableFeature. Alternatively this method can be called
518
# while probing for features before running the test code proper; in
519
# that case we will see startTest and stopTest, but the test will
520
# never actually run.
521
self.unsupported.setdefault(str(feature), 0)
522
self.unsupported[str(feature)] += 1
523
self.report_unsupported(test, feature)
525
def addSkip(self, test, reason):
526
"""A test has not run for 'reason'."""
528
self.report_skip(test, reason)
530
def addNotApplicable(self, test, reason):
531
self.not_applicable_count += 1
532
self.report_not_applicable(test, reason)
534
def _count_stored_tests(self):
535
"""Count of tests instances kept alive due to not succeeding"""
536
return self.error_count + self.failure_count + self.known_failure_count
538
def _post_mortem(self, tb=None):
539
"""Start a PDB post mortem session."""
540
if os.environ.get('BRZ_TEST_PDB', None):
544
def progress(self, offset, whence):
545
"""The test is adjusting the count of tests to run."""
546
if whence == SUBUNIT_SEEK_SET:
547
self.num_tests = offset
548
elif whence == SUBUNIT_SEEK_CUR:
549
self.num_tests += offset
551
raise errors.BzrError("Unknown whence %r" % whence)
553
def report_tests_starting(self):
554
"""Display information before the test run begins"""
555
if getattr(sys, 'frozen', None) is None:
556
bzr_path = osutils.realpath(sys.argv[0])
558
bzr_path = sys.executable
560
'brz selftest: %s\n' % (bzr_path,))
563
breezy.__path__[0],))
565
' bzr-%s python-%s %s\n' % (
566
breezy.version_string,
567
breezy._format_version_tuple(sys.version_info),
568
platform.platform(aliased=1),
570
self.stream.write('\n')
572
def report_test_start(self, test):
573
"""Display information on the test just about to be run"""
575
def _report_thread_leak(self, test, leaked_threads, active_threads):
576
"""Display information on a test that leaked one or more threads"""
577
# GZ 2010-09-09: A leak summary reported separately from the general
578
# thread debugging would be nice. Tests under subunit
579
# need something not using stream, perhaps adding a
580
# testtools details object would be fitting.
581
if 'threads' in selftest_debug_flags:
582
self.stream.write('%s is leaking, active is now %d\n' %
583
(test.id(), len(active_threads)))
585
def startTestRun(self):
586
self.startTime = time.time()
588
def report_success(self, test):
591
def wasStrictlySuccessful(self):
592
if self.unsupported or self.known_failure_count:
594
return self.wasSuccessful()
597
class TextTestResult(ExtendedTestResult):
598
"""Displays progress and results of tests in text form"""
600
def __init__(self, stream, descriptions, verbosity,
604
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
605
bench_history, strict)
606
self.pb = self.ui.nested_progress_bar()
607
self.pb.show_pct = False
608
self.pb.show_spinner = False
609
self.pb.show_eta = False,
610
self.pb.show_count = False
611
self.pb.show_bar = False
612
self.pb.update_latency = 0
613
self.pb.show_transport_activity = False
615
def stopTestRun(self):
616
# called when the tests that are going to run have run
619
super(TextTestResult, self).stopTestRun()
621
def report_tests_starting(self):
622
super(TextTestResult, self).report_tests_starting()
623
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
625
def _progress_prefix_text(self):
626
# the longer this text, the less space we have to show the test
628
a = '[%d' % self.count # total that have been run
629
# tests skipped as known not to be relevant are not important enough
631
## if self.skip_count:
632
## a += ', %d skip' % self.skip_count
633
## if self.known_failure_count:
634
## a += '+%dX' % self.known_failure_count
636
a +='/%d' % self.num_tests
638
runtime = time.time() - self._overall_start_time
640
a += '%dm%ds' % (runtime / 60, runtime % 60)
643
total_fail_count = self.error_count + self.failure_count
645
a += ', %d failed' % total_fail_count
646
# if self.unsupported:
647
# a += ', %d missing' % len(self.unsupported)
651
def report_test_start(self, test):
653
self._progress_prefix_text()
655
+ self._shortened_test_description(test))
657
def _test_description(self, test):
658
return self._shortened_test_description(test)
660
def report_error(self, test, err):
661
self.stream.write('ERROR: %s\n %s\n' % (
662
self._test_description(test),
666
def report_failure(self, test, err):
667
self.stream.write('FAIL: %s\n %s\n' % (
668
self._test_description(test),
672
def report_known_failure(self, test, err):
675
def report_unexpected_success(self, test, reason):
676
self.stream.write('FAIL: %s\n %s: %s\n' % (
677
self._test_description(test),
678
"Unexpected success. Should have failed",
682
def report_skip(self, test, reason):
685
def report_not_applicable(self, test, reason):
688
def report_unsupported(self, test, feature):
689
"""test cannot be run because feature is missing."""
692
class VerboseTestResult(ExtendedTestResult):
693
"""Produce long output, with one line per test run plus times"""
695
def _ellipsize_to_right(self, a_string, final_width):
696
"""Truncate and pad a string, keeping the right hand side"""
697
if len(a_string) > final_width:
698
result = '...' + a_string[3-final_width:]
701
return result.ljust(final_width)
703
def report_tests_starting(self):
704
self.stream.write('running %d tests...\n' % self.num_tests)
705
super(VerboseTestResult, self).report_tests_starting()
707
def report_test_start(self, test):
708
name = self._shortened_test_description(test)
709
width = osutils.terminal_width()
710
if width is not None:
711
# width needs space for 6 char status, plus 1 for slash, plus an
712
# 11-char time string, plus a trailing blank
713
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
715
self.stream.write(self._ellipsize_to_right(name, width-18))
717
self.stream.write(name)
720
def _error_summary(self, err):
722
return '%s%s' % (indent, err[1])
724
def report_error(self, test, err):
725
self.stream.write('ERROR %s\n%s\n'
726
% (self._testTimeString(test),
727
self._error_summary(err)))
729
def report_failure(self, test, err):
730
self.stream.write(' FAIL %s\n%s\n'
731
% (self._testTimeString(test),
732
self._error_summary(err)))
734
def report_known_failure(self, test, err):
735
self.stream.write('XFAIL %s\n%s\n'
736
% (self._testTimeString(test),
737
self._error_summary(err)))
739
def report_unexpected_success(self, test, reason):
740
self.stream.write(' FAIL %s\n%s: %s\n'
741
% (self._testTimeString(test),
742
"Unexpected success. Should have failed",
745
def report_success(self, test):
746
self.stream.write(' OK %s\n' % self._testTimeString(test))
747
for bench_called, stats in getattr(test, '_benchcalls', []):
748
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
749
stats.pprint(file=self.stream)
750
# flush the stream so that we get smooth output. This verbose mode is
751
# used to show the output in PQM.
754
def report_skip(self, test, reason):
755
self.stream.write(' SKIP %s\n%s\n'
756
% (self._testTimeString(test), reason))
758
def report_not_applicable(self, test, reason):
759
self.stream.write(' N/A %s\n %s\n'
760
% (self._testTimeString(test), reason))
762
def report_unsupported(self, test, feature):
763
"""test cannot be run because feature is missing."""
764
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
765
%(self._testTimeString(test), feature))
768
class TextTestRunner(object):
769
stop_on_failure = False
777
result_decorators=None,
779
"""Create a TextTestRunner.
781
:param result_decorators: An optional list of decorators to apply
782
to the result object being used by the runner. Decorators are
783
applied left to right - the first element in the list is the
786
# stream may know claim to know to write unicode strings, but in older
787
# pythons this goes sufficiently wrong that it is a bad idea. (
788
# specifically a built in file with encoding 'UTF-8' will still try
789
# to encode using ascii.
790
new_encoding = osutils.get_terminal_encoding()
791
codec = codecs.lookup(new_encoding)
792
encode = codec.encode
793
# GZ 2010-09-08: Really we don't want to be writing arbitrary bytes,
794
# so should swap to the plain codecs.StreamWriter
795
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream,
797
stream.encoding = new_encoding
799
self.descriptions = descriptions
800
self.verbosity = verbosity
801
self._bench_history = bench_history
802
self._strict = strict
803
self._result_decorators = result_decorators or []
806
"Run the given test case or test suite."
807
if self.verbosity == 1:
808
result_class = TextTestResult
809
elif self.verbosity >= 2:
810
result_class = VerboseTestResult
811
original_result = result_class(self.stream,
814
bench_history=self._bench_history,
817
# Signal to result objects that look at stop early policy to stop,
818
original_result.stop_early = self.stop_on_failure
819
result = original_result
820
for decorator in self._result_decorators:
821
result = decorator(result)
822
result.stop_early = self.stop_on_failure
823
result.startTestRun()
828
# higher level code uses our extended protocol to determine
829
# what exit code to give.
830
return original_result
833
def iter_suite_tests(suite):
834
"""Return all tests in a suite, recursing through nested suites"""
835
if isinstance(suite, unittest.TestCase):
837
elif isinstance(suite, unittest.TestSuite):
839
for r in iter_suite_tests(item):
842
raise Exception('unknown type %r for object %r'
843
% (type(suite), suite))
846
TestSkipped = testtools.testcase.TestSkipped
849
class TestNotApplicable(TestSkipped):
850
"""A test is not applicable to the situation where it was run.
852
This is only normally raised by parameterized tests, if they find that
853
the instance they're constructed upon does not support one aspect
858
# traceback._some_str fails to format exceptions that have the default
859
# __str__ which does an implicit ascii conversion. However, repr() on those
860
# objects works, for all that its not quite what the doctor may have ordered.
861
def _clever_some_str(value):
866
return repr(value).replace('\\n', '\n')
868
return '<unprintable %s object>' % type(value).__name__
870
traceback._some_str = _clever_some_str
873
# deprecated - use self.knownFailure(), or self.expectFailure.
874
KnownFailure = testtools.testcase._ExpectedFailure
877
class UnavailableFeature(Exception):
878
"""A feature required for this test was not available.
880
This can be considered a specialised form of SkippedTest.
882
The feature should be used to construct the exception.
886
class StringIOWrapper(ui_testing.BytesIOWithEncoding):
888
@symbol_versioning.deprecated_method(
889
symbol_versioning.deprecated_in((3, 0)))
890
def __init__(self, s=None):
891
super(StringIOWrapper, self).__init__(s)
894
TestUIFactory = ui_testing.TestUIFactory
897
def isolated_doctest_setUp(test):
898
override_os_environ(test)
899
osutils.set_or_unset_env('BRZ_HOME', '/nonexistent')
900
test._orig_ui_factory = ui.ui_factory
901
ui.ui_factory = ui.SilentUIFactory()
904
def isolated_doctest_tearDown(test):
905
restore_os_environ(test)
906
ui.ui_factory = test._orig_ui_factory
909
def IsolatedDocTestSuite(*args, **kwargs):
910
"""Overrides doctest.DocTestSuite to handle isolation.
912
The method is really a factory and users are expected to use it as such.
915
kwargs['setUp'] = isolated_doctest_setUp
916
kwargs['tearDown'] = isolated_doctest_tearDown
917
return doctest.DocTestSuite(*args, **kwargs)
920
class TestCase(testtools.TestCase):
921
"""Base class for brz unit tests.
923
Tests that need access to disk resources should subclass
924
TestCaseInTempDir not TestCase.
926
Error and debug log messages are redirected from their usual
927
location into a temporary file, the contents of which can be
928
retrieved by _get_log(). We use a real OS file, not an in-memory object,
929
so that it can also capture file IO. When the test completes this file
930
is read into memory and removed from disk.
932
There are also convenience functions to invoke bzr's command-line
933
routine, and to build and check brz trees.
935
In addition to the usual method of overriding tearDown(), this class also
936
allows subclasses to register cleanup functions via addCleanup, which are
937
run in order as the object is torn down. It's less likely this will be
938
accidentally overlooked.
942
# record lsprof data when performing benchmark calls.
943
_gather_lsprof_in_benchmarks = False
945
def __init__(self, methodName='testMethod'):
946
super(TestCase, self).__init__(methodName)
947
self._directory_isolation = True
948
self.exception_handlers.insert(0,
949
(UnavailableFeature, self._do_unsupported_or_skip))
950
self.exception_handlers.insert(0,
951
(TestNotApplicable, self._do_not_applicable))
954
super(TestCase, self).setUp()
956
# At this point we're still accessing the config files in $BRZ_HOME (as
957
# set by the user running selftest).
958
timeout = config.GlobalStack().get('selftest.timeout')
960
timeout_fixture = fixtures.TimeoutFixture(timeout)
961
timeout_fixture.setUp()
962
self.addCleanup(timeout_fixture.cleanUp)
964
for feature in getattr(self, '_test_needs_features', []):
965
self.requireFeature(feature)
966
self._cleanEnvironment()
968
self.overrideAttr(breezy.get_global_state(), 'cmdline_overrides',
969
config.CommandLineStore())
973
self._benchcalls = []
974
self._benchtime = None
976
self._track_transports()
978
self._clear_debug_flags()
979
# Isolate global verbosity level, to make sure it's reproducible
980
# between tests. We should get rid of this altogether: bug 656694. --
982
self.overrideAttr(breezy.trace, '_verbosity_level', 0)
983
self._log_files = set()
984
# Each key in the ``_counters`` dict holds a value for a different
985
# counter. When the test ends, addDetail() should be used to output the
986
# counter values. This happens in install_counter_hook().
988
if 'config_stats' in selftest_debug_flags:
989
self._install_config_stats_hooks()
990
# Do not use i18n for tests (unless the test reverses this)
996
# The sys preserved stdin/stdout should allow blackbox tests debugging
997
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
998
).set_trace(sys._getframe().f_back)
1000
def discardDetail(self, name):
1001
"""Extend the addDetail, getDetails api so we can remove a detail.
1003
eg. brz always adds the 'log' detail at startup, but we don't want to
1004
include it for skipped, xfail, etc tests.
1006
It is safe to call this for a detail that doesn't exist, in case this
1007
gets called multiple times.
1009
# We cheat. details is stored in __details which means we shouldn't
1010
# touch it. but getDetails() returns the dict directly, so we can
1012
details = self.getDetails()
1016
def install_counter_hook(self, hooks, name, counter_name=None):
1017
"""Install a counting hook.
1019
Any hook can be counted as long as it doesn't need to return a value.
1021
:param hooks: Where the hook should be installed.
1023
:param name: The hook name that will be counted.
1025
:param counter_name: The counter identifier in ``_counters``, defaults
1028
_counters = self._counters # Avoid closing over self
1029
if counter_name is None:
1031
if counter_name in _counters:
1032
raise AssertionError('%s is already used as a counter name'
1034
_counters[counter_name] = 0
1035
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1036
lambda: [b'%d' % (_counters[counter_name],)]))
1037
def increment_counter(*args, **kwargs):
1038
_counters[counter_name] += 1
1039
label = 'count %s calls' % (counter_name,)
1040
hooks.install_named_hook(name, increment_counter, label)
1041
self.addCleanup(hooks.uninstall_named_hook, name, label)
1043
def _install_config_stats_hooks(self):
1044
"""Install config hooks to count hook calls.
1047
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1048
self.install_counter_hook(config.ConfigHooks, hook_name,
1049
'config.%s' % (hook_name,))
1051
# The OldConfigHooks are private and need special handling to protect
1052
# against recursive tests (tests that run other tests), so we just do
1053
# manually what registering them into _builtin_known_hooks will provide
1055
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1056
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1057
self.install_counter_hook(config.OldConfigHooks, hook_name,
1058
'old_config.%s' % (hook_name,))
1060
def _clear_debug_flags(self):
1061
"""Prevent externally set debug flags affecting tests.
1063
Tests that want to use debug flags can just set them in the
1064
debug_flags set during setup/teardown.
1066
# Start with a copy of the current debug flags we can safely modify.
1067
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1068
if 'allow_debug' not in selftest_debug_flags:
1069
debug.debug_flags.clear()
1070
if 'disable_lock_checks' not in selftest_debug_flags:
1071
debug.debug_flags.add('strict_locks')
1073
def _clear_hooks(self):
1074
# prevent hooks affecting tests
1075
known_hooks = hooks.known_hooks
1076
self._preserved_hooks = {}
1077
for key, (parent, name) in known_hooks.iter_parent_objects():
1078
current_hooks = getattr(parent, name)
1079
self._preserved_hooks[parent] = (name, current_hooks)
1080
self._preserved_lazy_hooks = hooks._lazy_hooks
1081
hooks._lazy_hooks = {}
1082
self.addCleanup(self._restoreHooks)
1083
for key, (parent, name) in known_hooks.iter_parent_objects():
1084
factory = known_hooks.get(key)
1085
setattr(parent, name, factory())
1086
# this hook should always be installed
1087
request._install_hook()
1089
def disable_directory_isolation(self):
1090
"""Turn off directory isolation checks."""
1091
self._directory_isolation = False
1093
def enable_directory_isolation(self):
1094
"""Enable directory isolation checks."""
1095
self._directory_isolation = True
1097
def _silenceUI(self):
1098
"""Turn off UI for duration of test"""
1099
# by default the UI is off; tests can turn it on if they want it.
1100
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1102
def _check_locks(self):
1103
"""Check that all lock take/release actions have been paired."""
1104
# We always check for mismatched locks. If a mismatch is found, we
1105
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1106
# case we just print a warning.
1108
acquired_locks = [lock for action, lock in self._lock_actions
1109
if action == 'acquired']
1110
released_locks = [lock for action, lock in self._lock_actions
1111
if action == 'released']
1112
broken_locks = [lock for action, lock in self._lock_actions
1113
if action == 'broken']
1114
# trivially, given the tests for lock acquistion and release, if we
1115
# have as many in each list, it should be ok. Some lock tests also
1116
# break some locks on purpose and should be taken into account by
1117
# considering that breaking a lock is just a dirty way of releasing it.
1118
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1120
'Different number of acquired and '
1121
'released or broken locks.\n'
1125
(acquired_locks, released_locks, broken_locks))
1126
if not self._lock_check_thorough:
1127
# Rather than fail, just warn
1128
print("Broken test %s: %s" % (self, message))
1132
def _track_locks(self):
1133
"""Track lock activity during tests."""
1134
self._lock_actions = []
1135
if 'disable_lock_checks' in selftest_debug_flags:
1136
self._lock_check_thorough = False
1138
self._lock_check_thorough = True
1140
self.addCleanup(self._check_locks)
1141
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1142
self._lock_acquired, None)
1143
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1144
self._lock_released, None)
1145
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1146
self._lock_broken, None)
1148
def _lock_acquired(self, result):
1149
self._lock_actions.append(('acquired', result))
1151
def _lock_released(self, result):
1152
self._lock_actions.append(('released', result))
1154
def _lock_broken(self, result):
1155
self._lock_actions.append(('broken', result))
1157
def permit_dir(self, name):
1158
"""Permit a directory to be used by this test. See permit_url."""
1159
name_transport = _mod_transport.get_transport_from_path(name)
1160
self.permit_url(name)
1161
self.permit_url(name_transport.base)
1163
def permit_url(self, url):
1164
"""Declare that url is an ok url to use in this test.
1166
Do this for memory transports, temporary test directory etc.
1168
Do not do this for the current working directory, /tmp, or any other
1169
preexisting non isolated url.
1171
if not url.endswith('/'):
1173
self._bzr_selftest_roots.append(url)
1175
def permit_source_tree_branch_repo(self):
1176
"""Permit the source tree brz is running from to be opened.
1178
Some code such as breezy.version attempts to read from the brz branch
1179
that brz is executing from (if any). This method permits that directory
1180
to be used in the test suite.
1182
path = self.get_source_path()
1183
self.record_directory_isolation()
1186
workingtree.WorkingTree.open(path)
1187
except (errors.NotBranchError, errors.NoWorkingTree):
1188
raise TestSkipped('Needs a working tree of brz sources')
1190
self.enable_directory_isolation()
1192
def _preopen_isolate_transport(self, transport):
1193
"""Check that all transport openings are done in the test work area."""
1194
while isinstance(transport, pathfilter.PathFilteringTransport):
1195
# Unwrap pathfiltered transports
1196
transport = transport.server.backing_transport.clone(
1197
transport._filter('.'))
1198
url = transport.base
1199
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1200
# urls it is given by prepending readonly+. This is appropriate as the
1201
# client shouldn't know that the server is readonly (or not readonly).
1202
# We could register all servers twice, with readonly+ prepending, but
1203
# that makes for a long list; this is about the same but easier to
1205
if url.startswith('readonly+'):
1206
url = url[len('readonly+'):]
1207
self._preopen_isolate_url(url)
1209
def _preopen_isolate_url(self, url):
1210
if not self._directory_isolation:
1212
if self._directory_isolation == 'record':
1213
self._bzr_selftest_roots.append(url)
1215
# This prevents all transports, including e.g. sftp ones backed on disk
1216
# from working unless they are explicitly granted permission. We then
1217
# depend on the code that sets up test transports to check that they are
1218
# appropriately isolated and enable their use by calling
1219
# self.permit_transport()
1220
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1221
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1222
% (url, self._bzr_selftest_roots))
1224
def record_directory_isolation(self):
1225
"""Gather accessed directories to permit later access.
1227
This is used for tests that access the branch brz is running from.
1229
self._directory_isolation = "record"
1231
def start_server(self, transport_server, backing_server=None):
1232
"""Start transport_server for this test.
1234
This starts the server, registers a cleanup for it and permits the
1235
server's urls to be used.
1237
if backing_server is None:
1238
transport_server.start_server()
1240
transport_server.start_server(backing_server)
1241
self.addCleanup(transport_server.stop_server)
1242
# Obtain a real transport because if the server supplies a password, it
1243
# will be hidden from the base on the client side.
1244
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1245
# Some transport servers effectively chroot the backing transport;
1246
# others like SFTPServer don't - users of the transport can walk up the
1247
# transport to read the entire backing transport. This wouldn't matter
1248
# except that the workdir tests are given - and that they expect the
1249
# server's url to point at - is one directory under the safety net. So
1250
# Branch operations into the transport will attempt to walk up one
1251
# directory. Chrooting all servers would avoid this but also mean that
1252
# we wouldn't be testing directly against non-root urls. Alternatively
1253
# getting the test framework to start the server with a backing server
1254
# at the actual safety net directory would work too, but this then
1255
# means that the self.get_url/self.get_transport methods would need
1256
# to transform all their results. On balance its cleaner to handle it
1257
# here, and permit a higher url when we have one of these transports.
1258
if t.base.endswith('/work/'):
1259
# we have safety net/test root/work
1260
t = t.clone('../..')
1261
elif isinstance(transport_server,
1262
test_server.SmartTCPServer_for_testing):
1263
# The smart server adds a path similar to work, which is traversed
1264
# up from by the client. But the server is chrooted - the actual
1265
# backing transport is not escaped from, and VFS requests to the
1266
# root will error (because they try to escape the chroot).
1268
while t2.base != t.base:
1271
self.permit_url(t.base)
1273
def _track_transports(self):
1274
"""Install checks for transport usage."""
1275
# TestCase has no safe place it can write to.
1276
self._bzr_selftest_roots = []
1277
# Currently the easiest way to be sure that nothing is going on is to
1278
# hook into brz dir opening. This leaves a small window of error for
1279
# transport tests, but they are well known, and we can improve on this
1281
controldir.ControlDir.hooks.install_named_hook("pre_open",
1282
self._preopen_isolate_transport, "Check brz directories are safe.")
1284
def _ndiff_strings(self, a, b):
1285
"""Return ndiff between two strings containing lines.
1287
A trailing newline is added if missing to make the strings
1289
if b and b[-1] != '\n':
1291
if a and a[-1] != '\n':
1293
difflines = difflib.ndiff(a.splitlines(True),
1295
linejunk=lambda x: False,
1296
charjunk=lambda x: False)
1297
return ''.join(difflines)
1299
def assertEqual(self, a, b, message=''):
1303
except UnicodeError as e:
1304
# If we can't compare without getting a UnicodeError, then
1305
# obviously they are different
1306
trace.mutter('UnicodeError: %s', e)
1309
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1311
pprint.pformat(a), pprint.pformat(b)))
1313
# FIXME: This is deprecated in unittest2 but plugins may still use it so we
1314
# need a deprecation period for them -- vila 2016-02-01
1315
assertEquals = assertEqual
1317
def assertEqualDiff(self, a, b, message=None):
1318
"""Assert two texts are equal, if not raise an exception.
1320
This is intended for use with multi-line strings where it can
1321
be hard to find the differences by eye.
1323
# TODO: perhaps override assertEqual to call this for strings?
1327
message = "texts not equal:\n"
1329
message = 'first string is missing a final newline.\n'
1331
message = 'second string is missing a final newline.\n'
1332
raise AssertionError(message +
1333
self._ndiff_strings(a, b))
1335
def assertEqualMode(self, mode, mode_test):
1336
self.assertEqual(mode, mode_test,
1337
'mode mismatch %o != %o' % (mode, mode_test))
1339
def assertEqualStat(self, expected, actual):
1340
"""assert that expected and actual are the same stat result.
1342
:param expected: A stat result.
1343
:param actual: A stat result.
1344
:raises AssertionError: If the expected and actual stat values differ
1345
other than by atime.
1347
self.assertEqual(expected.st_size, actual.st_size,
1348
'st_size did not match')
1349
self.assertEqual(expected.st_mtime, actual.st_mtime,
1350
'st_mtime did not match')
1351
self.assertEqual(expected.st_ctime, actual.st_ctime,
1352
'st_ctime did not match')
1353
if sys.platform == 'win32':
1354
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1355
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1356
# odd. We just force it to always be 0 to avoid any problems.
1357
self.assertEqual(0, expected.st_dev)
1358
self.assertEqual(0, actual.st_dev)
1359
self.assertEqual(0, expected.st_ino)
1360
self.assertEqual(0, actual.st_ino)
1362
self.assertEqual(expected.st_dev, actual.st_dev,
1363
'st_dev did not match')
1364
self.assertEqual(expected.st_ino, actual.st_ino,
1365
'st_ino did not match')
1366
self.assertEqual(expected.st_mode, actual.st_mode,
1367
'st_mode did not match')
1369
def assertLength(self, length, obj_with_len):
1370
"""Assert that obj_with_len is of length length."""
1371
if len(obj_with_len) != length:
1372
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1373
length, len(obj_with_len), obj_with_len))
1375
def assertLogsError(self, exception_class, func, *args, **kwargs):
1376
"""Assert that `func(*args, **kwargs)` quietly logs a specific error.
1379
orig_log_exception_quietly = trace.log_exception_quietly
1382
orig_log_exception_quietly()
1383
captured.append(sys.exc_info()[1])
1384
trace.log_exception_quietly = capture
1385
func(*args, **kwargs)
1387
trace.log_exception_quietly = orig_log_exception_quietly
1388
self.assertLength(1, captured)
1390
self.assertIsInstance(err, exception_class)
1393
def assertPositive(self, val):
1394
"""Assert that val is greater than 0."""
1395
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1397
def assertNegative(self, val):
1398
"""Assert that val is less than 0."""
1399
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1401
def assertStartsWith(self, s, prefix):
1402
if not s.startswith(prefix):
1403
raise AssertionError('string %r does not start with %r' % (s, prefix))
1405
def assertEndsWith(self, s, suffix):
1406
"""Asserts that s ends with suffix."""
1407
if not s.endswith(suffix):
1408
raise AssertionError('string %r does not end with %r' % (s, suffix))
1410
def assertContainsRe(self, haystack, needle_re, flags=0):
1411
"""Assert that a contains something matching a regular expression."""
1412
if not re.search(needle_re, haystack, flags):
1413
if ('\n' if isinstance(haystack, str) else b'\n') in haystack or len(haystack) > 60:
1414
# a long string, format it in a more readable way
1415
raise AssertionError(
1416
'pattern "%s" not found in\n"""\\\n%s"""\n'
1417
% (needle_re, haystack))
1419
raise AssertionError('pattern "%s" not found in "%s"'
1420
% (needle_re, haystack))
1422
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1423
"""Assert that a does not match a regular expression"""
1424
if re.search(needle_re, haystack, flags):
1425
raise AssertionError('pattern "%s" found in "%s"'
1426
% (needle_re, haystack))
1428
def assertContainsString(self, haystack, needle):
1429
if haystack.find(needle) == -1:
1430
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1432
def assertNotContainsString(self, haystack, needle):
1433
if haystack.find(needle) != -1:
1434
self.fail("string %r found in '''%s'''" % (needle, haystack))
1436
def assertSubset(self, sublist, superlist):
1437
"""Assert that every entry in sublist is present in superlist."""
1438
missing = set(sublist) - set(superlist)
1439
if len(missing) > 0:
1440
raise AssertionError("value(s) %r not present in container %r" %
1441
(missing, superlist))
1443
def assertListRaises(self, excClass, func, *args, **kwargs):
1444
"""Fail unless excClass is raised when the iterator from func is used.
1446
Many functions can return generators this makes sure
1447
to wrap them in a list() call to make sure the whole generator
1448
is run, and that the proper exception is raised.
1451
list(func(*args, **kwargs))
1452
except excClass as e:
1455
if getattr(excClass, '__name__', None) is not None:
1456
excName = excClass.__name__
1458
excName = str(excClass)
1459
raise self.failureException("%s not raised" % excName)
1461
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1462
"""Assert that a callable raises a particular exception.
1464
:param excClass: As for the except statement, this may be either an
1465
exception class, or a tuple of classes.
1466
:param callableObj: A callable, will be passed ``*args`` and
1469
Returns the exception so that you can examine it.
1472
callableObj(*args, **kwargs)
1473
except excClass as e:
1476
if getattr(excClass, '__name__', None) is not None:
1477
excName = excClass.__name__
1480
excName = str(excClass)
1481
raise self.failureException("%s not raised" % excName)
1483
def assertIs(self, left, right, message=None):
1484
if not (left is right):
1485
if message is not None:
1486
raise AssertionError(message)
1488
raise AssertionError("%r is not %r." % (left, right))
1490
def assertIsNot(self, left, right, message=None):
1492
if message is not None:
1493
raise AssertionError(message)
1495
raise AssertionError("%r is %r." % (left, right))
1497
def assertTransportMode(self, transport, path, mode):
1498
"""Fail if a path does not have mode "mode".
1500
If modes are not supported on this transport, the assertion is ignored.
1502
if not transport._can_roundtrip_unix_modebits():
1504
path_stat = transport.stat(path)
1505
actual_mode = stat.S_IMODE(path_stat.st_mode)
1506
self.assertEqual(mode, actual_mode,
1507
'mode of %r incorrect (%s != %s)'
1508
% (path, oct(mode), oct(actual_mode)))
1510
def assertIsSameRealPath(self, path1, path2):
1511
"""Fail if path1 and path2 points to different files"""
1512
self.assertEqual(osutils.realpath(path1),
1513
osutils.realpath(path2),
1514
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1516
def assertIsInstance(self, obj, kls, msg=None):
1517
"""Fail if obj is not an instance of kls
1519
:param msg: Supplementary message to show if the assertion fails.
1521
if not isinstance(obj, kls):
1522
m = "%r is an instance of %s rather than %s" % (
1523
obj, obj.__class__, kls)
1528
def assertFileEqual(self, content, path):
1529
"""Fail if path does not contain 'content'."""
1530
self.assertPathExists(path)
1532
with open(path, 'r' + ('b' if isinstance(content, bytes) else '')) as f:
1534
self.assertEqualDiff(content, s)
1536
def assertDocstring(self, expected_docstring, obj):
1537
"""Fail if obj does not have expected_docstring"""
1539
# With -OO the docstring should be None instead
1540
self.assertIs(obj.__doc__, None)
1542
self.assertEqual(expected_docstring, obj.__doc__)
1544
def assertPathExists(self, path):
1545
"""Fail unless path or paths, which may be abs or relative, exist."""
1546
# TODO(jelmer): Clean this up for pad.lv/1696545
1547
if not isinstance(path, (bytes, str, text_type)):
1549
self.assertPathExists(p)
1551
self.assertTrue(osutils.lexists(path),
1552
path + " does not exist")
1554
def assertPathDoesNotExist(self, path):
1555
"""Fail if path or paths, which may be abs or relative, exist."""
1556
if not isinstance(path, (str, text_type)):
1558
self.assertPathDoesNotExist(p)
1560
self.assertFalse(osutils.lexists(path),
1563
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1564
"""A helper for callDeprecated and applyDeprecated.
1566
:param a_callable: A callable to call.
1567
:param args: The positional arguments for the callable
1568
:param kwargs: The keyword arguments for the callable
1569
:return: A tuple (warnings, result). result is the result of calling
1570
a_callable(``*args``, ``**kwargs``).
1573
def capture_warnings(msg, cls=None, stacklevel=None):
1574
# we've hooked into a deprecation specific callpath,
1575
# only deprecations should getting sent via it.
1576
self.assertEqual(cls, DeprecationWarning)
1577
local_warnings.append(msg)
1578
original_warning_method = symbol_versioning.warn
1579
symbol_versioning.set_warning_method(capture_warnings)
1581
result = a_callable(*args, **kwargs)
1583
symbol_versioning.set_warning_method(original_warning_method)
1584
return (local_warnings, result)
1586
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1587
"""Call a deprecated callable without warning the user.
1589
Note that this only captures warnings raised by symbol_versioning.warn,
1590
not other callers that go direct to the warning module.
1592
To test that a deprecated method raises an error, do something like
1593
this (remember that both assertRaises and applyDeprecated delays *args
1594
and **kwargs passing)::
1596
self.assertRaises(errors.ReservedId,
1597
self.applyDeprecated,
1598
deprecated_in((1, 5, 0)),
1602
:param deprecation_format: The deprecation format that the callable
1603
should have been deprecated with. This is the same type as the
1604
parameter to deprecated_method/deprecated_function. If the
1605
callable is not deprecated with this format, an assertion error
1607
:param a_callable: A callable to call. This may be a bound method or
1608
a regular function. It will be called with ``*args`` and
1610
:param args: The positional arguments for the callable
1611
:param kwargs: The keyword arguments for the callable
1612
:return: The result of a_callable(``*args``, ``**kwargs``)
1614
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1616
expected_first_warning = symbol_versioning.deprecation_string(
1617
a_callable, deprecation_format)
1618
if len(call_warnings) == 0:
1619
self.fail("No deprecation warning generated by call to %s" %
1621
self.assertEqual(expected_first_warning, call_warnings[0])
1624
def callCatchWarnings(self, fn, *args, **kw):
1625
"""Call a callable that raises python warnings.
1627
The caller's responsible for examining the returned warnings.
1629
If the callable raises an exception, the exception is not
1630
caught and propagates up to the caller. In that case, the list
1631
of warnings is not available.
1633
:returns: ([warning_object, ...], fn_result)
1635
# XXX: This is not perfect, because it completely overrides the
1636
# warnings filters, and some code may depend on suppressing particular
1637
# warnings. It's the easiest way to insulate ourselves from -Werror,
1638
# though. -- Andrew, 20071062
1640
def _catcher(message, category, filename, lineno, file=None, line=None):
1641
# despite the name, 'message' is normally(?) a Warning subclass
1643
wlist.append(message)
1644
saved_showwarning = warnings.showwarning
1645
saved_filters = warnings.filters
1647
warnings.showwarning = _catcher
1648
warnings.filters = []
1649
result = fn(*args, **kw)
1651
warnings.showwarning = saved_showwarning
1652
warnings.filters = saved_filters
1653
return wlist, result
1655
def callDeprecated(self, expected, callable, *args, **kwargs):
1656
"""Assert that a callable is deprecated in a particular way.
1658
This is a very precise test for unusual requirements. The
1659
applyDeprecated helper function is probably more suited for most tests
1660
as it allows you to simply specify the deprecation format being used
1661
and will ensure that that is issued for the function being called.
1663
Note that this only captures warnings raised by symbol_versioning.warn,
1664
not other callers that go direct to the warning module. To catch
1665
general warnings, use callCatchWarnings.
1667
:param expected: a list of the deprecation warnings expected, in order
1668
:param callable: The callable to call
1669
:param args: The positional arguments for the callable
1670
:param kwargs: The keyword arguments for the callable
1672
call_warnings, result = self._capture_deprecation_warnings(callable,
1674
self.assertEqual(expected, call_warnings)
1677
def _startLogFile(self):
1678
"""Setup a in-memory target for bzr and testcase log messages"""
1679
pseudo_log_file = BytesIO()
1680
def _get_log_contents_for_weird_testtools_api():
1681
return [pseudo_log_file.getvalue().decode(
1682
"utf-8", "replace").encode("utf-8")]
1683
self.addDetail("log", content.Content(content.ContentType("text",
1684
"plain", {"charset": "utf8"}),
1685
_get_log_contents_for_weird_testtools_api))
1686
self._log_file = pseudo_log_file
1687
self._log_memento = trace.push_log_file(self._log_file)
1688
self.addCleanup(self._finishLogFile)
1690
def _finishLogFile(self):
1691
"""Flush and dereference the in-memory log for this testcase"""
1692
if trace._trace_file:
1693
# flush the log file, to get all content
1694
trace._trace_file.flush()
1695
trace.pop_log_file(self._log_memento)
1696
# The logging module now tracks references for cleanup so discard ours
1697
del self._log_memento
1699
def thisFailsStrictLockCheck(self):
1700
"""It is known that this test would fail with -Dstrict_locks.
1702
By default, all tests are run with strict lock checking unless
1703
-Edisable_lock_checks is supplied. However there are some tests which
1704
we know fail strict locks at this point that have not been fixed.
1705
They should call this function to disable the strict checking.
1707
This should be used sparingly, it is much better to fix the locking
1708
issues rather than papering over the problem by calling this function.
1710
debug.debug_flags.discard('strict_locks')
1712
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1713
"""Overrides an object attribute restoring it after the test.
1715
:note: This should be used with discretion; you should think about
1716
whether it's better to make the code testable without monkey-patching.
1718
:param obj: The object that will be mutated.
1720
:param attr_name: The attribute name we want to preserve/override in
1723
:param new: The optional value we want to set the attribute to.
1725
:returns: The actual attr value.
1727
# The actual value is captured by the call below
1728
value = getattr(obj, attr_name, _unitialized_attr)
1729
if value is _unitialized_attr:
1730
# When the test completes, the attribute should not exist, but if
1731
# we aren't setting a value, we don't need to do anything.
1732
if new is not _unitialized_attr:
1733
self.addCleanup(delattr, obj, attr_name)
1735
self.addCleanup(setattr, obj, attr_name, value)
1736
if new is not _unitialized_attr:
1737
setattr(obj, attr_name, new)
1740
def overrideEnv(self, name, new):
1741
"""Set an environment variable, and reset it after the test.
1743
:param name: The environment variable name.
1745
:param new: The value to set the variable to. If None, the
1746
variable is deleted from the environment.
1748
:returns: The actual variable value.
1750
value = osutils.set_or_unset_env(name, new)
1751
self.addCleanup(osutils.set_or_unset_env, name, value)
1754
def recordCalls(self, obj, attr_name):
1755
"""Monkeypatch in a wrapper that will record calls.
1757
The monkeypatch is automatically removed when the test concludes.
1759
:param obj: The namespace holding the reference to be replaced;
1760
typically a module, class, or object.
1761
:param attr_name: A string for the name of the attribute to
1763
:returns: A list that will be extended with one item every time the
1764
function is called, with a tuple of (args, kwargs).
1768
def decorator(*args, **kwargs):
1769
calls.append((args, kwargs))
1770
return orig(*args, **kwargs)
1771
orig = self.overrideAttr(obj, attr_name, decorator)
1774
def _cleanEnvironment(self):
1775
for name, value in isolated_environ.items():
1776
self.overrideEnv(name, value)
1778
def _restoreHooks(self):
1779
for klass, (name, hooks) in self._preserved_hooks.items():
1780
setattr(klass, name, hooks)
1781
self._preserved_hooks.clear()
1782
breezy.hooks._lazy_hooks = self._preserved_lazy_hooks
1783
self._preserved_lazy_hooks.clear()
1785
def knownFailure(self, reason):
1786
"""Declare that this test fails for a known reason
1788
Tests that are known to fail should generally be using expectedFailure
1789
with an appropriate reverse assertion if a change could cause the test
1790
to start passing. Conversely if the test has no immediate prospect of
1791
succeeding then using skip is more suitable.
1793
When this method is called while an exception is being handled, that
1794
traceback will be used, otherwise a new exception will be thrown to
1795
provide one but won't be reported.
1797
self._add_reason(reason)
1799
exc_info = sys.exc_info()
1800
if exc_info != (None, None, None):
1801
self._report_traceback(exc_info)
1804
raise self.failureException(reason)
1805
except self.failureException:
1806
exc_info = sys.exc_info()
1807
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1808
raise testtools.testcase._ExpectedFailure(exc_info)
1812
def _suppress_log(self):
1813
"""Remove the log info from details."""
1814
self.discardDetail('log')
1816
def _do_skip(self, result, reason):
1817
self._suppress_log()
1818
addSkip = getattr(result, 'addSkip', None)
1819
if not callable(addSkip):
1820
result.addSuccess(result)
1822
addSkip(self, str(reason))
1825
def _do_known_failure(self, result, e):
1826
self._suppress_log()
1827
err = sys.exc_info()
1828
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1829
if addExpectedFailure is not None:
1830
addExpectedFailure(self, err)
1832
result.addSuccess(self)
1835
def _do_not_applicable(self, result, e):
1837
reason = 'No reason given'
1840
self._suppress_log ()
1841
addNotApplicable = getattr(result, 'addNotApplicable', None)
1842
if addNotApplicable is not None:
1843
result.addNotApplicable(self, reason)
1845
self._do_skip(result, reason)
1848
def _report_skip(self, result, err):
1849
"""Override the default _report_skip.
1851
We want to strip the 'log' detail. If we waint until _do_skip, it has
1852
already been formatted into the 'reason' string, and we can't pull it
1855
self._suppress_log()
1856
super(TestCase, self)._report_skip(self, result, err)
1859
def _report_expected_failure(self, result, err):
1862
See _report_skip for motivation.
1864
self._suppress_log()
1865
super(TestCase, self)._report_expected_failure(self, result, err)
1868
def _do_unsupported_or_skip(self, result, e):
1870
self._suppress_log()
1871
addNotSupported = getattr(result, 'addNotSupported', None)
1872
if addNotSupported is not None:
1873
result.addNotSupported(self, reason)
1875
self._do_skip(result, reason)
1877
def time(self, callable, *args, **kwargs):
1878
"""Run callable and accrue the time it takes to the benchmark time.
1880
If lsprofiling is enabled (i.e. by --lsprof-time to brz selftest) then
1881
this will cause lsprofile statistics to be gathered and stored in
1884
if self._benchtime is None:
1885
self.addDetail('benchtime', content.Content(content.UTF8_TEXT,
1886
lambda:[str(self._benchtime).encode('utf-8')]))
1890
if not self._gather_lsprof_in_benchmarks:
1891
return callable(*args, **kwargs)
1893
# record this benchmark
1894
ret, stats = breezy.lsprof.profile(callable, *args, **kwargs)
1896
self._benchcalls.append(((callable, args, kwargs), stats))
1899
self._benchtime += time.time() - start
1901
def log(self, *args):
1905
"""Get a unicode string containing the log from breezy.trace.
1907
Undecodable characters are replaced.
1909
return u"".join(self.getDetails()['log'].iter_text())
1911
def requireFeature(self, feature):
1912
"""This test requires a specific feature is available.
1914
:raises UnavailableFeature: When feature is not available.
1916
if not feature.available():
1917
raise UnavailableFeature(feature)
1919
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1921
"""Run bazaar command line, splitting up a string command line."""
1922
if isinstance(args, string_types):
1923
args = shlex.split(args)
1924
return self._run_bzr_core(args, retcode=retcode,
1925
encoding=encoding, stdin=stdin, working_dir=working_dir,
1928
def _run_bzr_core(self, args, retcode, encoding, stdin,
1930
# Clear chk_map page cache, because the contents are likely to mask
1932
chk_map.clear_cache()
1933
if encoding is None:
1934
encoding = osutils.get_user_encoding()
1936
self.log('run brz: %r', args)
1938
if sys.version_info[0] == 2:
1939
stdout = ui_testing.BytesIOWithEncoding()
1940
stderr = ui_testing.BytesIOWithEncoding()
1941
stdout.encoding = stderr.encoding = encoding
1943
stdout = ui_testing.StringIOWithEncoding()
1944
stderr = ui_testing.StringIOWithEncoding()
1945
stdout.encoding = stderr.encoding = encoding
1947
# FIXME: don't call into logging here
1948
handler = trace.EncodedStreamHandler(
1949
stderr, errors="replace", level=logging.INFO)
1950
logger = logging.getLogger('')
1951
logger.addHandler(handler)
1953
self._last_cmd_stdout = codecs.getwriter(encoding)(stdout)
1954
self._last_cmd_stderr = codecs.getwriter(encoding)(stderr)
1956
old_ui_factory = ui.ui_factory
1957
ui.ui_factory = ui_testing.TestUIFactory(
1959
stdout=self._last_cmd_stdout,
1960
stderr=self._last_cmd_stderr)
1963
if working_dir is not None:
1964
cwd = osutils.getcwd()
1965
os.chdir(working_dir)
1969
result = self.apply_redirected(
1970
ui.ui_factory.stdin,
1972
_mod_commands.run_bzr_catch_user_errors,
1975
logger.removeHandler(handler)
1976
ui.ui_factory = old_ui_factory
1980
out = stdout.getvalue()
1981
err = stderr.getvalue()
1983
self.log('output:\n%r', out)
1985
self.log('errors:\n%r', err)
1986
if retcode is not None:
1987
self.assertEqual(retcode, result,
1988
message='Unexpected return code')
1989
return result, out, err
1991
def run_bzr(self, args, retcode=0, stdin=None, encoding=None,
1992
working_dir=None, error_regexes=[]):
1993
"""Invoke brz, as if it were run from the command line.
1995
The argument list should not include the brz program name - the
1996
first argument is normally the brz command. Arguments may be
1997
passed in three ways:
1999
1- A list of strings, eg ["commit", "a"]. This is recommended
2000
when the command contains whitespace or metacharacters, or
2001
is built up at run time.
2003
2- A single string, eg "add a". This is the most convenient
2004
for hardcoded commands.
2006
This runs brz through the interface that catches and reports
2007
errors, and with logging set to something approximating the
2008
default, so that error reporting can be checked.
2010
This should be the main method for tests that want to exercise the
2011
overall behavior of the brz application (rather than a unit test
2012
or a functional test of the library.)
2014
This sends the stdout/stderr results into the test's log,
2015
where it may be useful for debugging. See also run_captured.
2017
:keyword stdin: A string to be used as stdin for the command.
2018
:keyword retcode: The status code the command should return;
2020
:keyword working_dir: The directory to run the command in
2021
:keyword error_regexes: A list of expected error messages. If
2022
specified they must be seen in the error output of the command.
2024
retcode, out, err = self._run_bzr_autosplit(
2029
working_dir=working_dir,
2031
self.assertIsInstance(error_regexes, (list, tuple))
2032
for regex in error_regexes:
2033
self.assertContainsRe(err, regex)
2036
def run_bzr_error(self, error_regexes, *args, **kwargs):
2037
"""Run brz, and check that stderr contains the supplied regexes
2039
:param error_regexes: Sequence of regular expressions which
2040
must each be found in the error output. The relative ordering
2042
:param args: command-line arguments for brz
2043
:param kwargs: Keyword arguments which are interpreted by run_brz
2044
This function changes the default value of retcode to be 3,
2045
since in most cases this is run when you expect brz to fail.
2047
:return: (out, err) The actual output of running the command (in case
2048
you want to do more inspection)
2052
# Make sure that commit is failing because there is nothing to do
2053
self.run_bzr_error(['no changes to commit'],
2054
['commit', '-m', 'my commit comment'])
2055
# Make sure --strict is handling an unknown file, rather than
2056
# giving us the 'nothing to do' error
2057
self.build_tree(['unknown'])
2058
self.run_bzr_error(['Commit refused because there are unknown files'],
2059
['commit', --strict', '-m', 'my commit comment'])
2061
kwargs.setdefault('retcode', 3)
2062
kwargs['error_regexes'] = error_regexes
2063
out, err = self.run_bzr(*args, **kwargs)
2066
def run_bzr_subprocess(self, *args, **kwargs):
2067
"""Run brz in a subprocess for testing.
2069
This starts a new Python interpreter and runs brz in there.
2070
This should only be used for tests that have a justifiable need for
2071
this isolation: e.g. they are testing startup time, or signal
2072
handling, or early startup code, etc. Subprocess code can't be
2073
profiled or debugged so easily.
2075
:keyword retcode: The status code that is expected. Defaults to 0. If
2076
None is supplied, the status code is not checked.
2077
:keyword env_changes: A dictionary which lists changes to environment
2078
variables. A value of None will unset the env variable.
2079
The values must be strings. The change will only occur in the
2080
child, so you don't need to fix the environment after running.
2081
:keyword universal_newlines: Convert CRLF => LF
2082
:keyword allow_plugins: By default the subprocess is run with
2083
--no-plugins to ensure test reproducibility. Also, it is possible
2084
for system-wide plugins to create unexpected output on stderr,
2085
which can cause unnecessary test failures.
2087
env_changes = kwargs.get('env_changes', {})
2088
working_dir = kwargs.get('working_dir', None)
2089
allow_plugins = kwargs.get('allow_plugins', False)
2091
if isinstance(args[0], list):
2093
elif isinstance(args[0], (str, text_type)):
2094
args = list(shlex.split(args[0]))
2096
raise ValueError("passing varargs to run_bzr_subprocess")
2097
process = self.start_bzr_subprocess(args, env_changes=env_changes,
2098
working_dir=working_dir,
2099
allow_plugins=allow_plugins)
2100
# We distinguish between retcode=None and retcode not passed.
2101
supplied_retcode = kwargs.get('retcode', 0)
2102
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
2103
universal_newlines=kwargs.get('universal_newlines', False),
2106
def start_bzr_subprocess(self, process_args, env_changes=None,
2107
skip_if_plan_to_signal=False,
2109
allow_plugins=False, stderr=subprocess.PIPE):
2110
"""Start brz in a subprocess for testing.
2112
This starts a new Python interpreter and runs brz in there.
2113
This should only be used for tests that have a justifiable need for
2114
this isolation: e.g. they are testing startup time, or signal
2115
handling, or early startup code, etc. Subprocess code can't be
2116
profiled or debugged so easily.
2118
:param process_args: a list of arguments to pass to the brz executable,
2119
for example ``['--version']``.
2120
:param env_changes: A dictionary which lists changes to environment
2121
variables. A value of None will unset the env variable.
2122
The values must be strings. The change will only occur in the
2123
child, so you don't need to fix the environment after running.
2124
:param skip_if_plan_to_signal: raise TestSkipped when true and system
2125
doesn't support signalling subprocesses.
2126
:param allow_plugins: If False (default) pass --no-plugins to brz.
2127
:param stderr: file to use for the subprocess's stderr. Valid values
2128
are those valid for the stderr argument of `subprocess.Popen`.
2129
Default value is ``subprocess.PIPE``.
2131
:returns: Popen object for the started process.
2133
if skip_if_plan_to_signal:
2134
if os.name != "posix":
2135
raise TestSkipped("Sending signals not supported")
2137
if env_changes is None:
2139
# Because $HOME is set to a tempdir for the context of a test, modules
2140
# installed in the user dir will not be found unless $PYTHONUSERBASE
2141
# gets set to the computed directory of this parent process.
2142
if site.USER_BASE is not None:
2143
env_changes["PYTHONUSERBASE"] = site.USER_BASE
2146
def cleanup_environment():
2147
for env_var, value in env_changes.items():
2148
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2150
def restore_environment():
2151
for env_var, value in old_env.items():
2152
osutils.set_or_unset_env(env_var, value)
2154
bzr_path = self.get_brz_path()
2157
if working_dir is not None:
2158
cwd = osutils.getcwd()
2159
os.chdir(working_dir)
2162
# win32 subprocess doesn't support preexec_fn
2163
# so we will avoid using it on all platforms, just to
2164
# make sure the code path is used, and we don't break on win32
2165
cleanup_environment()
2166
# Include the subprocess's log file in the test details, in case
2167
# the test fails due to an error in the subprocess.
2168
self._add_subprocess_log(trace._get_brz_log_filename())
2169
command = [sys.executable]
2170
# frozen executables don't need the path to bzr
2171
if getattr(sys, "frozen", None) is None:
2172
command.append(bzr_path)
2173
if not allow_plugins:
2174
command.append('--no-plugins')
2175
command.extend(process_args)
2176
process = self._popen(command, stdin=subprocess.PIPE,
2177
stdout=subprocess.PIPE,
2178
stderr=stderr, bufsize=0)
2180
restore_environment()
2186
def _add_subprocess_log(self, log_file_path):
2187
if len(self._log_files) == 0:
2188
# Register an addCleanup func. We do this on the first call to
2189
# _add_subprocess_log rather than in TestCase.setUp so that this
2190
# addCleanup is registered after any cleanups for tempdirs that
2191
# subclasses might create, which will probably remove the log file
2193
self.addCleanup(self._subprocess_log_cleanup)
2194
# self._log_files is a set, so if a log file is reused we won't grab it
2196
self._log_files.add(log_file_path)
2198
def _subprocess_log_cleanup(self):
2199
for count, log_file_path in enumerate(self._log_files):
2200
# We use buffer_now=True to avoid holding the file open beyond
2201
# the life of this function, which might interfere with e.g.
2202
# cleaning tempdirs on Windows.
2203
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
2204
#detail_content = content.content_from_file(
2205
# log_file_path, buffer_now=True)
2206
with open(log_file_path, 'rb') as log_file:
2207
log_file_bytes = log_file.read()
2208
detail_content = content.Content(content.ContentType("text",
2209
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
2210
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
2213
def _popen(self, *args, **kwargs):
2214
"""Place a call to Popen.
2216
Allows tests to override this method to intercept the calls made to
2217
Popen for introspection.
2219
return subprocess.Popen(*args, **kwargs)
2221
def get_source_path(self):
2222
"""Return the path of the directory containing breezy."""
2223
return os.path.dirname(os.path.dirname(breezy.__file__))
2225
def get_brz_path(self):
2226
"""Return the path of the 'brz' executable for this test suite."""
2227
brz_path = os.path.join(self.get_source_path(), "brz")
2228
if not os.path.isfile(brz_path):
2229
# We are probably installed. Assume sys.argv is the right file
2230
brz_path = sys.argv[0]
2233
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2234
universal_newlines=False, process_args=None):
2235
"""Finish the execution of process.
2237
:param process: the Popen object returned from start_bzr_subprocess.
2238
:param retcode: The status code that is expected. Defaults to 0. If
2239
None is supplied, the status code is not checked.
2240
:param send_signal: an optional signal to send to the process.
2241
:param universal_newlines: Convert CRLF => LF
2242
:returns: (stdout, stderr)
2244
if send_signal is not None:
2245
os.kill(process.pid, send_signal)
2246
out, err = process.communicate()
2248
if universal_newlines:
2249
out = out.replace(b'\r\n', b'\n')
2250
err = err.replace(b'\r\n', b'\n')
2252
if retcode is not None and retcode != process.returncode:
2253
if process_args is None:
2254
process_args = "(unknown args)"
2255
trace.mutter('Output of brz %r:\n%s', process_args, out)
2256
trace.mutter('Error for brz %r:\n%s', process_args, err)
2257
self.fail('Command brz %r failed with retcode %d != %d'
2258
% (process_args, retcode, process.returncode))
2261
def check_tree_shape(self, tree, shape):
2262
"""Compare a tree to a list of expected names.
2264
Fail if they are not precisely equal.
2267
shape = list(shape) # copy
2268
for path, ie in tree.iter_entries_by_dir():
2269
name = path.replace('\\', '/')
2270
if ie.kind == 'directory':
2273
pass # ignore root entry
2279
self.fail("expected paths not found in inventory: %r" % shape)
2281
self.fail("unexpected paths found in inventory: %r" % extras)
2283
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2284
a_callable=None, *args, **kwargs):
2285
"""Call callable with redirected std io pipes.
2287
Returns the return code."""
2288
if not callable(a_callable):
2289
raise ValueError("a_callable must be callable.")
2291
stdin = BytesIO(b"")
2293
if getattr(self, "_log_file", None) is not None:
2294
stdout = self._log_file
2296
if sys.version_info[0] == 2:
2301
if getattr(self, "_log_file", None is not None):
2302
stderr = self._log_file
2304
if sys.version_info[0] == 2:
2308
real_stdin = sys.stdin
2309
real_stdout = sys.stdout
2310
real_stderr = sys.stderr
2315
return a_callable(*args, **kwargs)
2317
sys.stdout = real_stdout
2318
sys.stderr = real_stderr
2319
sys.stdin = real_stdin
2321
def reduceLockdirTimeout(self):
2322
"""Reduce the default lock timeout for the duration of the test, so that
2323
if LockContention occurs during a test, it does so quickly.
2325
Tests that expect to provoke LockContention errors should call this.
2327
self.overrideAttr(lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2329
def make_utf8_encoded_stringio(self, encoding_type=None):
2330
"""Return a wrapped BytesIO, that will encode text input to UTF-8."""
2331
if encoding_type is None:
2332
encoding_type = 'strict'
2334
output_encoding = 'utf-8'
2335
sio = codecs.getwriter(output_encoding)(bio, errors=encoding_type)
2336
sio.encoding = output_encoding
2339
def disable_verb(self, verb):
2340
"""Disable a smart server verb for one test."""
2341
from breezy.bzr.smart import request
2342
request_handlers = request.request_handlers
2343
orig_method = request_handlers.get(verb)
2344
orig_info = request_handlers.get_info(verb)
2345
request_handlers.remove(verb)
2346
self.addCleanup(request_handlers.register, verb, orig_method,
2353
class CapturedCall(object):
2354
"""A helper for capturing smart server calls for easy debug analysis."""
2356
def __init__(self, params, prefix_length):
2357
"""Capture the call with params and skip prefix_length stack frames."""
2360
# The last 5 frames are the __init__, the hook frame, and 3 smart
2361
# client frames. Beyond this we could get more clever, but this is good
2363
stack = traceback.extract_stack()[prefix_length:-5]
2364
self.stack = ''.join(traceback.format_list(stack))
2367
return self.call.method
2370
return self.call.method
2376
class TestCaseWithMemoryTransport(TestCase):
2377
"""Common test class for tests that do not need disk resources.
2379
Tests that need disk resources should derive from TestCaseInTempDir
2380
orTestCaseWithTransport.
2382
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all brz tests.
2384
For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
2385
a directory which does not exist. This serves to help ensure test isolation
2386
is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
2387
must exist. However, TestCaseWithMemoryTransport does not offer local file
2388
defaults for the transport in tests, nor does it obey the command line
2389
override, so tests that accidentally write to the common directory should
2392
:cvar TEST_ROOT: Directory containing all temporary directories, plus a
2393
``.bzr`` directory that stops us ascending higher into the filesystem.
2399
def __init__(self, methodName='runTest'):
2400
# allow test parameterization after test construction and before test
2401
# execution. Variables that the parameterizer sets need to be
2402
# ones that are not set by setUp, or setUp will trash them.
2403
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2404
self.vfs_transport_factory = default_transport
2405
self.transport_server = None
2406
self.transport_readonly_server = None
2407
self.__vfs_server = None
2410
super(TestCaseWithMemoryTransport, self).setUp()
2412
def _add_disconnect_cleanup(transport):
2413
"""Schedule disconnection of given transport at test cleanup
2415
This needs to happen for all connected transports or leaks occur.
2417
Note reconnections may mean we call disconnect multiple times per
2418
transport which is suboptimal but seems harmless.
2420
self.addCleanup(transport.disconnect)
2422
_mod_transport.Transport.hooks.install_named_hook('post_connect',
2423
_add_disconnect_cleanup, None)
2425
self._make_test_root()
2426
self.addCleanup(os.chdir, osutils.getcwd())
2427
self.makeAndChdirToTestDir()
2428
self.overrideEnvironmentForTesting()
2429
self.__readonly_server = None
2430
self.__server = None
2431
self.reduceLockdirTimeout()
2432
# Each test may use its own config files even if the local config files
2433
# don't actually exist. They'll rightly fail if they try to create them
2435
self.overrideAttr(config, '_shared_stores', {})
2437
def get_transport(self, relpath=None):
2438
"""Return a writeable transport.
2440
This transport is for the test scratch space relative to
2443
:param relpath: a path relative to the base url.
2445
t = _mod_transport.get_transport_from_url(self.get_url(relpath))
2446
self.assertFalse(t.is_readonly())
2449
def get_readonly_transport(self, relpath=None):
2450
"""Return a readonly transport for the test scratch space
2452
This can be used to test that operations which should only need
2453
readonly access in fact do not try to write.
2455
:param relpath: a path relative to the base url.
2457
t = _mod_transport.get_transport_from_url(
2458
self.get_readonly_url(relpath))
2459
self.assertTrue(t.is_readonly())
2462
def create_transport_readonly_server(self):
2463
"""Create a transport server from class defined at init.
2465
This is mostly a hook for daughter classes.
2467
return self.transport_readonly_server()
2469
def get_readonly_server(self):
2470
"""Get the server instance for the readonly transport
2472
This is useful for some tests with specific servers to do diagnostics.
2474
if self.__readonly_server is None:
2475
if self.transport_readonly_server is None:
2476
# readonly decorator requested
2477
self.__readonly_server = test_server.ReadonlyServer()
2479
# explicit readonly transport.
2480
self.__readonly_server = self.create_transport_readonly_server()
2481
self.start_server(self.__readonly_server,
2482
self.get_vfs_only_server())
2483
return self.__readonly_server
2485
def get_readonly_url(self, relpath=None):
2486
"""Get a URL for the readonly transport.
2488
This will either be backed by '.' or a decorator to the transport
2489
used by self.get_url()
2490
relpath provides for clients to get a path relative to the base url.
2491
These should only be downwards relative, not upwards.
2493
base = self.get_readonly_server().get_url()
2494
return self._adjust_url(base, relpath)
2496
def get_vfs_only_server(self):
2497
"""Get the vfs only read/write server instance.
2499
This is useful for some tests with specific servers that need
2502
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2503
is no means to override it.
2505
if self.__vfs_server is None:
2506
self.__vfs_server = memory.MemoryServer()
2507
self.start_server(self.__vfs_server)
2508
return self.__vfs_server
2510
def get_server(self):
2511
"""Get the read/write server instance.
2513
This is useful for some tests with specific servers that need
2516
This is built from the self.transport_server factory. If that is None,
2517
then the self.get_vfs_server is returned.
2519
if self.__server is None:
2520
if (self.transport_server is None or self.transport_server is
2521
self.vfs_transport_factory):
2522
self.__server = self.get_vfs_only_server()
2524
# bring up a decorated means of access to the vfs only server.
2525
self.__server = self.transport_server()
2526
self.start_server(self.__server, self.get_vfs_only_server())
2527
return self.__server
2529
def _adjust_url(self, base, relpath):
2530
"""Get a URL (or maybe a path) for the readwrite transport.
2532
This will either be backed by '.' or to an equivalent non-file based
2534
relpath provides for clients to get a path relative to the base url.
2535
These should only be downwards relative, not upwards.
2537
if relpath is not None and relpath != '.':
2538
if not base.endswith('/'):
2540
# XXX: Really base should be a url; we did after all call
2541
# get_url()! But sometimes it's just a path (from
2542
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2543
# to a non-escaped local path.
2544
if base.startswith('./') or base.startswith('/'):
2547
base += urlutils.escape(relpath)
2550
def get_url(self, relpath=None):
2551
"""Get a URL (or maybe a path) for the readwrite transport.
2553
This will either be backed by '.' or to an equivalent non-file based
2555
relpath provides for clients to get a path relative to the base url.
2556
These should only be downwards relative, not upwards.
2558
base = self.get_server().get_url()
2559
return self._adjust_url(base, relpath)
2561
def get_vfs_only_url(self, relpath=None):
2562
"""Get a URL (or maybe a path for the plain old vfs transport.
2564
This will never be a smart protocol. It always has all the
2565
capabilities of the local filesystem, but it might actually be a
2566
MemoryTransport or some other similar virtual filesystem.
2568
This is the backing transport (if any) of the server returned by
2569
get_url and get_readonly_url.
2571
:param relpath: provides for clients to get a path relative to the base
2572
url. These should only be downwards relative, not upwards.
2575
base = self.get_vfs_only_server().get_url()
2576
return self._adjust_url(base, relpath)
2578
def _create_safety_net(self):
2579
"""Make a fake bzr directory.
2581
This prevents any tests propagating up onto the TEST_ROOT directory's
2584
root = TestCaseWithMemoryTransport.TEST_ROOT
2586
# Make sure we get a readable and accessible home for .brz.log
2587
# and/or config files, and not fallback to weird defaults (see
2588
# http://pad.lv/825027).
2589
self.assertIs(None, os.environ.get('BRZ_HOME', None))
2590
os.environ['BRZ_HOME'] = root
2591
wt = controldir.ControlDir.create_standalone_workingtree(root)
2592
del os.environ['BRZ_HOME']
2593
except Exception as e:
2594
self.fail("Fail to initialize the safety net: %r\n" % (e,))
2595
# Hack for speed: remember the raw bytes of the dirstate file so that
2596
# we don't need to re-open the wt to check it hasn't changed.
2597
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
2598
wt.control_transport.get_bytes('dirstate'))
2600
def _check_safety_net(self):
2601
"""Check that the safety .bzr directory have not been touched.
2603
_make_test_root have created a .bzr directory to prevent tests from
2604
propagating. This method ensures than a test did not leaked.
2606
root = TestCaseWithMemoryTransport.TEST_ROOT
2607
t = _mod_transport.get_transport_from_path(root)
2608
self.permit_url(t.base)
2609
if (t.get_bytes('.bzr/checkout/dirstate') !=
2610
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
2611
# The current test have modified the /bzr directory, we need to
2612
# recreate a new one or all the followng tests will fail.
2613
# If you need to inspect its content uncomment the following line
2614
# import pdb; pdb.set_trace()
2615
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2616
self._create_safety_net()
2617
raise AssertionError('%s/.bzr should not be modified' % root)
2619
def _make_test_root(self):
2620
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2621
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2622
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2624
TestCaseWithMemoryTransport.TEST_ROOT = root
2626
self._create_safety_net()
2628
# The same directory is used by all tests, and we're not
2629
# specifically told when all tests are finished. This will do.
2630
atexit.register(_rmtree_temp_dir, root)
2632
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2633
self.addCleanup(self._check_safety_net)
2635
def makeAndChdirToTestDir(self):
2636
"""Create a temporary directories for this one test.
2638
This must set self.test_home_dir and self.test_dir and chdir to
2641
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2643
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2644
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2645
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2646
self.permit_dir(self.test_dir)
2648
def make_branch(self, relpath, format=None, name=None):
2649
"""Create a branch on the transport at relpath."""
2650
repo = self.make_repository(relpath, format=format)
2651
return repo.controldir.create_branch(append_revisions_only=False, name=name)
2653
def get_default_format(self):
2656
def resolve_format(self, format):
2657
"""Resolve an object to a ControlDir format object.
2659
The initial format object can either already be
2660
a ControlDirFormat, None (for the default format),
2661
or a string with the name of the control dir format.
2663
:param format: Object to resolve
2664
:return A ControlDirFormat instance
2667
format = self.get_default_format()
2668
if isinstance(format, str):
2669
format = controldir.format_registry.make_controldir(format)
2672
def make_controldir(self, relpath, format=None):
2674
# might be a relative or absolute path
2675
maybe_a_url = self.get_url(relpath)
2676
segments = maybe_a_url.rsplit('/', 1)
2677
t = _mod_transport.get_transport(maybe_a_url)
2678
if len(segments) > 1 and segments[-1] not in ('', '.'):
2680
format = self.resolve_format(format)
2681
return format.initialize_on_transport(t)
2682
except errors.UninitializableFormat:
2683
raise TestSkipped("Format %s is not initializable." % format)
2685
def make_repository(self, relpath, shared=None, format=None):
2686
"""Create a repository on our default transport at relpath.
2688
Note that relpath must be a relative path, not a full url.
2690
# FIXME: If you create a remoterepository this returns the underlying
2691
# real format, which is incorrect. Actually we should make sure that
2692
# RemoteBzrDir returns a RemoteRepository.
2693
# maybe mbp 20070410
2694
made_control = self.make_controldir(relpath, format=format)
2695
return made_control.create_repository(shared=shared)
2697
def make_smart_server(self, path, backing_server=None):
2698
if backing_server is None:
2699
backing_server = self.get_server()
2700
smart_server = test_server.SmartTCPServer_for_testing()
2701
self.start_server(smart_server, backing_server)
2702
remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
2704
return remote_transport
2706
def make_branch_and_memory_tree(self, relpath, format=None):
2707
"""Create a branch on the default transport and a MemoryTree for it."""
2708
b = self.make_branch(relpath, format=format)
2709
return b.create_memorytree()
2711
def make_branch_builder(self, relpath, format=None):
2712
branch = self.make_branch(relpath, format=format)
2713
return branchbuilder.BranchBuilder(branch=branch)
2715
def overrideEnvironmentForTesting(self):
2716
test_home_dir = self.test_home_dir
2717
if not PY3 and isinstance(test_home_dir, text_type):
2718
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2719
self.overrideEnv('HOME', test_home_dir)
2720
self.overrideEnv('BRZ_HOME', test_home_dir)
2721
self.overrideEnv('GNUPGHOME', os.path.join(test_home_dir, '.gnupg'))
2723
def setup_smart_server_with_call_log(self):
2724
"""Sets up a smart server as the transport server with a call log."""
2725
self.transport_server = test_server.SmartTCPServer_for_testing
2726
self.hpss_connections = []
2727
self.hpss_calls = []
2729
# Skip the current stack down to the caller of
2730
# setup_smart_server_with_call_log
2731
prefix_length = len(traceback.extract_stack()) - 2
2732
def capture_hpss_call(params):
2733
self.hpss_calls.append(
2734
CapturedCall(params, prefix_length))
2735
def capture_connect(transport):
2736
self.hpss_connections.append(transport)
2737
client._SmartClient.hooks.install_named_hook(
2738
'call', capture_hpss_call, None)
2739
_mod_transport.Transport.hooks.install_named_hook(
2740
'post_connect', capture_connect, None)
2742
def reset_smart_call_log(self):
2743
self.hpss_calls = []
2744
self.hpss_connections = []
2747
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2748
"""Derived class that runs a test within a temporary directory.
2750
This is useful for tests that need to create a branch, etc.
2752
The directory is created in a slightly complex way: for each
2753
Python invocation, a new temporary top-level directory is created.
2754
All test cases create their own directory within that. If the
2755
tests complete successfully, the directory is removed.
2757
:ivar test_base_dir: The path of the top-level directory for this
2758
test, which contains a home directory and a work directory.
2760
:ivar test_home_dir: An initially empty directory under test_base_dir
2761
which is used as $HOME for this test.
2763
:ivar test_dir: A directory under test_base_dir used as the current
2764
directory when the test proper is run.
2767
OVERRIDE_PYTHON = 'python'
2770
super(TestCaseInTempDir, self).setUp()
2771
# Remove the protection set in isolated_environ, we have a proper
2772
# access to disk resources now.
2773
self.overrideEnv('BRZ_LOG', None)
2775
def check_file_contents(self, filename, expect):
2776
self.log("check contents of file %s" % filename)
2777
with open(filename, 'rb') as f:
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 = controldir.ControlDir.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
with open(self.test_base_dir + '/name', 'w') as f:
2828
def deleteTestDir(self):
2829
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2830
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2832
def build_tree(self, shape, line_endings='binary', transport=None):
2833
"""Build a test tree according to a pattern.
2835
shape is a sequence of file specifications. If the final
2836
character is '/', a directory is created.
2838
This assumes that all the elements in the tree being built are new.
2840
This doesn't add anything to a branch.
2842
:type shape: list or tuple.
2843
:param line_endings: Either 'binary' or 'native'
2844
in binary mode, exact contents are written in native mode, the
2845
line endings match the default platform endings.
2846
:param transport: A transport to write to, for building trees on VFS's.
2847
If the transport is readonly or None, "." is opened automatically.
2850
if type(shape) not in (list, tuple):
2851
raise AssertionError("Parameter 'shape' should be "
2852
"a list or a tuple. Got %r instead" % (shape,))
2853
# It's OK to just create them using forward slashes on windows.
2854
if transport is None or transport.is_readonly():
2855
transport = _mod_transport.get_transport_from_path(".")
2857
self.assertIsInstance(name, (str, text_type))
2859
transport.mkdir(urlutils.escape(name[:-1]))
2861
if line_endings == 'binary':
2863
elif line_endings == 'native':
2864
end = os.linesep.encode('ascii')
2866
raise errors.BzrError(
2867
'Invalid line ending request %r' % line_endings)
2868
content = b"contents of %s%s" % (name.encode('utf-8'), end)
2869
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2871
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2873
def assertInWorkingTree(self, path, root_path='.', tree=None):
2874
"""Assert whether path or paths are in the WorkingTree"""
2876
tree = workingtree.WorkingTree.open(root_path)
2877
if not isinstance(path, (str, text_type)):
2879
self.assertInWorkingTree(p, tree=tree)
2881
self.assertTrue(tree.is_versioned(path),
2882
path+' not in working tree.')
2884
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2885
"""Assert whether path or paths are not in the WorkingTree"""
2887
tree = workingtree.WorkingTree.open(root_path)
2888
if not isinstance(path, (str, text_type)):
2890
self.assertNotInWorkingTree(p, tree=tree)
2892
self.assertFalse(tree.is_versioned(path), path+' in working tree.')
2895
class TestCaseWithTransport(TestCaseInTempDir):
2896
"""A test case that provides get_url and get_readonly_url facilities.
2898
These back onto two transport servers, one for readonly access and one for
2901
If no explicit class is provided for readonly access, a
2902
ReadonlyTransportDecorator is used instead which allows the use of non disk
2903
based read write transports.
2905
If an explicit class is provided for readonly access, that server and the
2906
readwrite one must both define get_url() as resolving to os.getcwd().
2910
super(TestCaseWithTransport, self).setUp()
2911
self.__vfs_server = None
2913
def get_vfs_only_server(self):
2914
"""See TestCaseWithMemoryTransport.
2916
This is useful for some tests with specific servers that need
2919
if self.__vfs_server is None:
2920
self.__vfs_server = self.vfs_transport_factory()
2921
self.start_server(self.__vfs_server)
2922
return self.__vfs_server
2924
def make_branch_and_tree(self, relpath, format=None):
2925
"""Create a branch on the transport and a tree locally.
2927
If the transport is not a LocalTransport, the Tree can't be created on
2928
the transport. In that case if the vfs_transport_factory is
2929
LocalURLServer the working tree is created in the local
2930
directory backing the transport, and the returned tree's branch and
2931
repository will also be accessed locally. Otherwise a lightweight
2932
checkout is created and returned.
2934
We do this because we can't physically create a tree in the local
2935
path, with a branch reference to the transport_factory url, and
2936
a branch + repository in the vfs_transport, unless the vfs_transport
2937
namespace is distinct from the local disk - the two branch objects
2938
would collide. While we could construct a tree with its branch object
2939
pointing at the transport_factory transport in memory, reopening it
2940
would behaving unexpectedly, and has in the past caused testing bugs
2941
when we tried to do it that way.
2943
:param format: The BzrDirFormat.
2944
:returns: the WorkingTree.
2946
# TODO: always use the local disk path for the working tree,
2947
# this obviously requires a format that supports branch references
2948
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2950
format = self.resolve_format(format=format)
2951
if not format.supports_workingtrees:
2952
b = self.make_branch(relpath+'.branch', format=format)
2953
return b.create_checkout(relpath, lightweight=True)
2954
b = self.make_branch(relpath, format=format)
2956
return b.controldir.create_workingtree()
2957
except errors.NotLocalUrl:
2958
# We can only make working trees locally at the moment. If the
2959
# transport can't support them, then we keep the non-disk-backed
2960
# branch and create a local checkout.
2961
if self.vfs_transport_factory is test_server.LocalURLServer:
2962
# the branch is colocated on disk, we cannot create a checkout.
2963
# hopefully callers will expect this.
2964
local_controldir = controldir.ControlDir.open(
2965
self.get_vfs_only_url(relpath))
2966
wt = local_controldir.create_workingtree()
2967
if wt.branch._format != b._format:
2969
# Make sure that assigning to wt._branch fixes wt.branch,
2970
# in case the implementation details of workingtree objects
2972
self.assertIs(b, wt.branch)
2975
return b.create_checkout(relpath, lightweight=True)
2977
def assertIsDirectory(self, relpath, transport):
2978
"""Assert that relpath within transport is a directory.
2980
This may not be possible on all transports; in that case it propagates
2981
a TransportNotPossible.
2984
mode = transport.stat(relpath).st_mode
2985
except errors.NoSuchFile:
2986
self.fail("path %s is not a directory; no such file"
2988
if not stat.S_ISDIR(mode):
2989
self.fail("path %s is not a directory; has mode %#o"
2992
def assertTreesEqual(self, left, right):
2993
"""Check that left and right have the same content and properties."""
2994
# we use a tree delta to check for equality of the content, and we
2995
# manually check for equality of other things such as the parents list.
2996
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2997
differences = left.changes_from(right)
2998
self.assertFalse(differences.has_changed(),
2999
"Trees %r and %r are different: %r" % (left, right, differences))
3001
def disable_missing_extensions_warning(self):
3002
"""Some tests expect a precise stderr content.
3004
There is no point in forcing them to duplicate the extension related
3007
config.GlobalConfig().set_user_option(
3008
'suppress_warnings', 'missing_extensions')
3011
class ChrootedTestCase(TestCaseWithTransport):
3012
"""A support class that provides readonly urls outside the local namespace.
3014
This is done by checking if self.transport_server is a MemoryServer. if it
3015
is then we are chrooted already, if it is not then an HttpServer is used
3018
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
3019
be used without needed to redo it when a different
3020
subclass is in use ?
3024
from breezy.tests import http_server
3025
super(ChrootedTestCase, self).setUp()
3026
if not self.vfs_transport_factory == memory.MemoryServer:
3027
self.transport_readonly_server = http_server.HttpServer
3030
def condition_id_re(pattern):
3031
"""Create a condition filter which performs a re check on a test's id.
3033
:param pattern: A regular expression string.
3034
:return: A callable that returns True if the re matches.
3036
filter_re = re.compile(pattern, 0)
3037
def condition(test):
3039
return filter_re.search(test_id)
3043
def condition_isinstance(klass_or_klass_list):
3044
"""Create a condition filter which returns isinstance(param, klass).
3046
:return: A callable which when called with one parameter obj return the
3047
result of isinstance(obj, klass_or_klass_list).
3050
return isinstance(obj, klass_or_klass_list)
3054
def condition_id_in_list(id_list):
3055
"""Create a condition filter which verify that test's id in a list.
3057
:param id_list: A TestIdList object.
3058
:return: A callable that returns True if the test's id appears in the list.
3060
def condition(test):
3061
return id_list.includes(test.id())
3065
def condition_id_startswith(starts):
3066
"""Create a condition filter verifying that test's id starts with a string.
3068
:param starts: A list of string.
3069
:return: A callable that returns True if the test's id starts with one of
3072
def condition(test):
3073
for start in starts:
3074
if test.id().startswith(start):
3080
def exclude_tests_by_condition(suite, condition):
3081
"""Create a test suite which excludes some tests from suite.
3083
:param suite: The suite to get tests from.
3084
:param condition: A callable whose result evaluates True when called with a
3085
test case which should be excluded from the result.
3086
:return: A suite which contains the tests found in suite that fail
3090
for test in iter_suite_tests(suite):
3091
if not condition(test):
3093
return TestUtil.TestSuite(result)
3096
def filter_suite_by_condition(suite, condition):
3097
"""Create a test suite by filtering another one.
3099
:param suite: The source suite.
3100
:param condition: A callable whose result evaluates True when called with a
3101
test case which should be included in the result.
3102
:return: A suite which contains the tests found in suite that pass
3106
for test in iter_suite_tests(suite):
3109
return TestUtil.TestSuite(result)
3112
def filter_suite_by_re(suite, pattern):
3113
"""Create a test suite by filtering another one.
3115
:param suite: the source suite
3116
:param pattern: pattern that names must match
3117
:returns: the newly created suite
3119
condition = condition_id_re(pattern)
3120
result_suite = filter_suite_by_condition(suite, condition)
3124
def filter_suite_by_id_list(suite, test_id_list):
3125
"""Create a test suite by filtering another one.
3127
:param suite: The source suite.
3128
:param test_id_list: A list of the test ids to keep as strings.
3129
:returns: the newly created suite
3131
condition = condition_id_in_list(test_id_list)
3132
result_suite = filter_suite_by_condition(suite, condition)
3136
def filter_suite_by_id_startswith(suite, start):
3137
"""Create a test suite by filtering another one.
3139
:param suite: The source suite.
3140
:param start: A list of string the test id must start with one of.
3141
:returns: the newly created suite
3143
condition = condition_id_startswith(start)
3144
result_suite = filter_suite_by_condition(suite, condition)
3148
def exclude_tests_by_re(suite, pattern):
3149
"""Create a test suite which excludes some tests from suite.
3151
:param suite: The suite to get tests from.
3152
:param pattern: A regular expression string. Test ids that match this
3153
pattern will be excluded from the result.
3154
:return: A TestSuite that contains all the tests from suite without the
3155
tests that matched pattern. The order of tests is the same as it was in
3158
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3161
def preserve_input(something):
3162
"""A helper for performing test suite transformation chains.
3164
:param something: Anything you want to preserve.
3170
def randomize_suite(suite):
3171
"""Return a new TestSuite with suite's tests in random order.
3173
The tests in the input suite are flattened into a single suite in order to
3174
accomplish this. Any nested TestSuites are removed to provide global
3177
tests = list(iter_suite_tests(suite))
3178
random.shuffle(tests)
3179
return TestUtil.TestSuite(tests)
3182
def split_suite_by_condition(suite, condition):
3183
"""Split a test suite into two by a condition.
3185
:param suite: The suite to split.
3186
:param condition: The condition to match on. Tests that match this
3187
condition are returned in the first test suite, ones that do not match
3188
are in the second suite.
3189
:return: A tuple of two test suites, where the first contains tests from
3190
suite matching the condition, and the second contains the remainder
3191
from suite. The order within each output suite is the same as it was in
3196
for test in iter_suite_tests(suite):
3198
matched.append(test)
3200
did_not_match.append(test)
3201
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3204
def split_suite_by_re(suite, pattern):
3205
"""Split a test suite into two by a regular expression.
3207
:param suite: The suite to split.
3208
:param pattern: A regular expression string. Test ids that match this
3209
pattern will be in the first test suite returned, and the others in the
3210
second test suite returned.
3211
:return: A tuple of two test suites, where the first contains tests from
3212
suite matching pattern, and the second contains the remainder from
3213
suite. The order within each output suite is the same as it was in
3216
return split_suite_by_condition(suite, condition_id_re(pattern))
3219
def run_suite(suite, name='test', verbose=False, pattern=".*",
3220
stop_on_failure=False,
3221
transport=None, lsprof_timed=None, bench_history=None,
3222
matching_tests_first=None,
3225
exclude_pattern=None,
3228
suite_decorators=None,
3230
result_decorators=None,
3232
"""Run a test suite for brz selftest.
3234
:param runner_class: The class of runner to use. Must support the
3235
constructor arguments passed by run_suite which are more than standard
3237
:return: A boolean indicating success.
3239
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3244
if runner_class is None:
3245
runner_class = TextTestRunner
3248
runner = runner_class(stream=stream,
3250
verbosity=verbosity,
3251
bench_history=bench_history,
3253
result_decorators=result_decorators,
3255
runner.stop_on_failure=stop_on_failure
3256
if isinstance(suite, unittest.TestSuite):
3257
# Empty out _tests list of passed suite and populate new TestSuite
3258
suite._tests[:], suite = [], TestSuite(suite)
3259
# built in decorator factories:
3261
random_order(random_seed, runner),
3262
exclude_tests(exclude_pattern),
3264
if matching_tests_first:
3265
decorators.append(tests_first(pattern))
3267
decorators.append(filter_tests(pattern))
3268
if suite_decorators:
3269
decorators.extend(suite_decorators)
3270
# tell the result object how many tests will be running: (except if
3271
# --parallel=fork is being used. Robert said he will provide a better
3272
# progress design later -- vila 20090817)
3273
if fork_decorator not in decorators:
3274
decorators.append(CountingDecorator)
3275
for decorator in decorators:
3276
suite = decorator(suite)
3278
# Done after test suite decoration to allow randomisation etc
3279
# to take effect, though that is of marginal benefit.
3281
stream.write("Listing tests only ...\n")
3282
if getattr(runner, 'list', None) is not None:
3285
for t in iter_suite_tests(suite):
3286
stream.write("%s\n" % (t.id()))
3288
result = runner.run(suite)
3290
return result.wasStrictlySuccessful()
3292
return result.wasSuccessful()
3295
# A registry where get() returns a suite decorator.
3296
parallel_registry = registry.Registry()
3299
def fork_decorator(suite):
3300
if getattr(os, "fork", None) is None:
3301
raise errors.BzrCommandError("platform does not support fork,"
3302
" try --parallel=subprocess instead.")
3303
concurrency = osutils.local_concurrency()
3304
if concurrency == 1:
3306
from testtools import ConcurrentTestSuite
3307
return ConcurrentTestSuite(suite, fork_for_tests)
3308
parallel_registry.register('fork', fork_decorator)
3311
def subprocess_decorator(suite):
3312
concurrency = osutils.local_concurrency()
3313
if concurrency == 1:
3315
from testtools import ConcurrentTestSuite
3316
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3317
parallel_registry.register('subprocess', subprocess_decorator)
3320
def exclude_tests(exclude_pattern):
3321
"""Return a test suite decorator that excludes tests."""
3322
if exclude_pattern is None:
3323
return identity_decorator
3324
def decorator(suite):
3325
return ExcludeDecorator(suite, exclude_pattern)
3329
def filter_tests(pattern):
3331
return identity_decorator
3332
def decorator(suite):
3333
return FilterTestsDecorator(suite, pattern)
3337
def random_order(random_seed, runner):
3338
"""Return a test suite decorator factory for randomising tests order.
3340
:param random_seed: now, a string which casts to an integer, or an integer.
3341
:param runner: A test runner with a stream attribute to report on.
3343
if random_seed is None:
3344
return identity_decorator
3345
def decorator(suite):
3346
return RandomDecorator(suite, random_seed, runner.stream)
3350
def tests_first(pattern):
3352
return identity_decorator
3353
def decorator(suite):
3354
return TestFirstDecorator(suite, pattern)
3358
def identity_decorator(suite):
3363
class TestDecorator(TestUtil.TestSuite):
3364
"""A decorator for TestCase/TestSuite objects.
3366
Contains rather than flattening suite passed on construction
3369
def __init__(self, suite=None):
3370
super(TestDecorator, self).__init__()
3371
if suite is not None:
3374
# Don't need subclass run method with suite emptying
3375
run = unittest.TestSuite.run
3378
class CountingDecorator(TestDecorator):
3379
"""A decorator which calls result.progress(self.countTestCases)."""
3381
def run(self, result):
3382
progress_method = getattr(result, 'progress', None)
3383
if callable(progress_method):
3384
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3385
return super(CountingDecorator, self).run(result)
3388
class ExcludeDecorator(TestDecorator):
3389
"""A decorator which excludes test matching an exclude pattern."""
3391
def __init__(self, suite, exclude_pattern):
3392
super(ExcludeDecorator, self).__init__(
3393
exclude_tests_by_re(suite, exclude_pattern))
3396
class FilterTestsDecorator(TestDecorator):
3397
"""A decorator which filters tests to those matching a pattern."""
3399
def __init__(self, suite, pattern):
3400
super(FilterTestsDecorator, self).__init__(
3401
filter_suite_by_re(suite, pattern))
3404
class RandomDecorator(TestDecorator):
3405
"""A decorator which randomises the order of its tests."""
3407
def __init__(self, suite, random_seed, stream):
3408
random_seed = self.actual_seed(random_seed)
3409
stream.write("Randomizing test order using seed %s\n\n" %
3411
# Initialise the random number generator.
3412
random.seed(random_seed)
3413
super(RandomDecorator, self).__init__(randomize_suite(suite))
3416
def actual_seed(seed):
3418
# We convert the seed to an integer to make it reuseable across
3419
# invocations (because the user can reenter it).
3420
return int(time.time())
3422
# Convert the seed to an integer if we can
3425
except (TypeError, ValueError):
3430
class TestFirstDecorator(TestDecorator):
3431
"""A decorator which moves named tests to the front."""
3433
def __init__(self, suite, pattern):
3434
super(TestFirstDecorator, self).__init__()
3435
self.addTests(split_suite_by_re(suite, pattern))
3438
def partition_tests(suite, count):
3439
"""Partition suite into count lists of tests."""
3440
# This just assigns tests in a round-robin fashion. On one hand this
3441
# splits up blocks of related tests that might run faster if they shared
3442
# resources, but on the other it avoids assigning blocks of slow tests to
3443
# just one partition. So the slowest partition shouldn't be much slower
3445
partitions = [list() for i in range(count)]
3446
tests = iter_suite_tests(suite)
3447
for partition, test in zip(itertools.cycle(partitions), tests):
3448
partition.append(test)
3452
def workaround_zealous_crypto_random():
3453
"""Crypto.Random want to help us being secure, but we don't care here.
3455
This workaround some test failure related to the sftp server. Once paramiko
3456
stop using the controversial API in Crypto.Random, we may get rid of it.
3459
from Crypto.Random import atfork
3465
def fork_for_tests(suite):
3466
"""Take suite and start up one runner per CPU by forking()
3468
:return: An iterable of TestCase-like objects which can each have
3469
run(result) called on them to feed tests to result.
3471
concurrency = osutils.local_concurrency()
3473
from subunit import ProtocolTestCase
3474
from subunit.test_results import AutoTimingTestResultDecorator
3475
class TestInOtherProcess(ProtocolTestCase):
3476
# Should be in subunit, I think. RBC.
3477
def __init__(self, stream, pid):
3478
ProtocolTestCase.__init__(self, stream)
3481
def run(self, result):
3483
ProtocolTestCase.run(self, result)
3485
pid, status = os.waitpid(self.pid, 0)
3486
# GZ 2011-10-18: If status is nonzero, should report to the result
3487
# that something went wrong.
3489
test_blocks = partition_tests(suite, concurrency)
3490
# Clear the tests from the original suite so it doesn't keep them alive
3491
suite._tests[:] = []
3492
for process_tests in test_blocks:
3493
process_suite = TestUtil.TestSuite(process_tests)
3494
# Also clear each split list so new suite has only reference
3495
process_tests[:] = []
3496
c2pread, c2pwrite = os.pipe()
3500
stream = os.fdopen(c2pwrite, 'wb', 1)
3501
workaround_zealous_crypto_random()
3507
coverage.process_startup()
3509
# Leave stderr and stdout open so we can see test noise
3510
# Close stdin so that the child goes away if it decides to
3511
# read from stdin (otherwise its a roulette to see what
3512
# child actually gets keystrokes for pdb etc).
3514
subunit_result = AutoTimingTestResultDecorator(
3515
SubUnitBzrProtocolClientv1(stream))
3516
process_suite.run(subunit_result)
3518
# Try and report traceback on stream, but exit with error even
3519
# if stream couldn't be created or something else goes wrong.
3520
# The traceback is formatted to a string and written in one go
3521
# to avoid interleaving lines from multiple failing children.
3523
stream.write(traceback.format_exc())
3529
stream = os.fdopen(c2pread, 'rb', 1)
3530
test = TestInOtherProcess(stream, pid)
3535
def reinvoke_for_tests(suite):
3536
"""Take suite and start up one runner per CPU using subprocess().
3538
:return: An iterable of TestCase-like objects which can each have
3539
run(result) called on them to feed tests to result.
3541
concurrency = osutils.local_concurrency()
3543
from subunit import ProtocolTestCase
3544
class TestInSubprocess(ProtocolTestCase):
3545
def __init__(self, process, name):
3546
ProtocolTestCase.__init__(self, process.stdout)
3547
self.process = process
3548
self.process.stdin.close()
3551
def run(self, result):
3553
ProtocolTestCase.run(self, result)
3556
os.unlink(self.name)
3557
# print "pid %d finished" % finished_process
3558
test_blocks = partition_tests(suite, concurrency)
3559
for process_tests in test_blocks:
3560
# ugly; currently reimplement rather than reuses TestCase methods.
3561
bzr_path = os.path.dirname(os.path.dirname(breezy.__file__))+'/bzr'
3562
if not os.path.isfile(bzr_path):
3563
# We are probably installed. Assume sys.argv is the right file
3564
bzr_path = sys.argv[0]
3565
bzr_path = [bzr_path]
3566
if sys.platform == "win32":
3567
# if we're on windows, we can't execute the bzr script directly
3568
bzr_path = [sys.executable] + bzr_path
3569
fd, test_list_file_name = tempfile.mkstemp()
3570
test_list_file = os.fdopen(fd, 'wb', 1)
3571
for test in process_tests:
3572
test_list_file.write(test.id() + '\n')
3573
test_list_file.close()
3575
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3577
if '--no-plugins' in sys.argv:
3578
argv.append('--no-plugins')
3579
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3580
# noise on stderr it can interrupt the subunit protocol.
3581
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3582
stdout=subprocess.PIPE,
3583
stderr=subprocess.PIPE,
3585
test = TestInSubprocess(process, test_list_file_name)
3588
os.unlink(test_list_file_name)
3593
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3594
"""Generate profiling data for all activity between start and success.
3596
The profile data is appended to the test's _benchcalls attribute and can
3597
be accessed by the forwarded-to TestResult.
3599
While it might be cleaner do accumulate this in stopTest, addSuccess is
3600
where our existing output support for lsprof is, and this class aims to
3601
fit in with that: while it could be moved it's not necessary to accomplish
3602
test profiling, nor would it be dramatically cleaner.
3605
def startTest(self, test):
3606
self.profiler = breezy.lsprof.BzrProfiler()
3607
# Prevent deadlocks in tests that use lsprof: those tests will
3609
breezy.lsprof.BzrProfiler.profiler_block = 0
3610
self.profiler.start()
3611
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3613
def addSuccess(self, test):
3614
stats = self.profiler.stop()
3616
calls = test._benchcalls
3617
except AttributeError:
3618
test._benchcalls = []
3619
calls = test._benchcalls
3620
calls.append(((test.id(), "", ""), stats))
3621
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3623
def stopTest(self, test):
3624
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3625
self.profiler = None
3628
# Controlled by "brz selftest -E=..." option
3629
# Currently supported:
3630
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3631
# preserves any flags supplied at the command line.
3632
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3633
# rather than failing tests. And no longer raise
3634
# LockContention when fctnl locks are not being used
3635
# with proper exclusion rules.
3636
# -Ethreads Will display thread ident at creation/join time to
3637
# help track thread leaks
3638
# -Euncollected_cases Display the identity of any test cases that weren't
3639
# deallocated after being completed.
3640
# -Econfig_stats Will collect statistics using addDetail
3641
selftest_debug_flags = set()
3644
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3646
test_suite_factory=None,
3649
matching_tests_first=None,
3652
exclude_pattern=None,
3658
suite_decorators=None,
3662
"""Run the whole test suite under the enhanced runner"""
3663
# XXX: Very ugly way to do this...
3664
# Disable warning about old formats because we don't want it to disturb
3665
# any blackbox tests.
3666
from breezy import repository
3667
repository._deprecation_warning_done = True
3669
global default_transport
3670
if transport is None:
3671
transport = default_transport
3672
old_transport = default_transport
3673
default_transport = transport
3674
global selftest_debug_flags
3675
old_debug_flags = selftest_debug_flags
3676
if debug_flags is not None:
3677
selftest_debug_flags = set(debug_flags)
3679
if load_list is None:
3682
keep_only = load_test_id_list(load_list)
3684
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3685
for start in starting_with]
3686
# Always consider 'unittest' an interesting name so that failed
3687
# suites wrapped as test cases appear in the output.
3688
starting_with.append('unittest')
3689
if test_suite_factory is None:
3690
# Reduce loading time by loading modules based on the starting_with
3692
suite = test_suite(keep_only, starting_with)
3694
suite = test_suite_factory()
3696
# But always filter as requested.
3697
suite = filter_suite_by_id_startswith(suite, starting_with)
3698
result_decorators = []
3700
result_decorators.append(ProfileResult)
3701
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3702
stop_on_failure=stop_on_failure,
3703
transport=transport,
3704
lsprof_timed=lsprof_timed,
3705
bench_history=bench_history,
3706
matching_tests_first=matching_tests_first,
3707
list_only=list_only,
3708
random_seed=random_seed,
3709
exclude_pattern=exclude_pattern,
3711
runner_class=runner_class,
3712
suite_decorators=suite_decorators,
3714
result_decorators=result_decorators,
3717
default_transport = old_transport
3718
selftest_debug_flags = old_debug_flags
3721
def load_test_id_list(file_name):
3722
"""Load a test id list from a text file.
3724
The format is one test id by line. No special care is taken to impose
3725
strict rules, these test ids are used to filter the test suite so a test id
3726
that do not match an existing test will do no harm. This allows user to add
3727
comments, leave blank lines, etc.
3731
ftest = open(file_name, 'rt')
3732
except IOError as e:
3733
if e.errno != errno.ENOENT:
3736
raise errors.NoSuchFile(file_name)
3738
for test_name in ftest.readlines():
3739
test_list.append(test_name.strip())
3744
def suite_matches_id_list(test_suite, id_list):
3745
"""Warns about tests not appearing or appearing more than once.
3747
:param test_suite: A TestSuite object.
3748
:param test_id_list: The list of test ids that should be found in
3751
:return: (absents, duplicates) absents is a list containing the test found
3752
in id_list but not in test_suite, duplicates is a list containing the
3753
tests found multiple times in test_suite.
3755
When using a prefined test id list, it may occurs that some tests do not
3756
exist anymore or that some tests use the same id. This function warns the
3757
tester about potential problems in his workflow (test lists are volatile)
3758
or in the test suite itself (using the same id for several tests does not
3759
help to localize defects).
3761
# Build a dict counting id occurrences
3763
for test in iter_suite_tests(test_suite):
3765
tests[id] = tests.get(id, 0) + 1
3770
occurs = tests.get(id, 0)
3772
not_found.append(id)
3774
duplicates.append(id)
3776
return not_found, duplicates
3779
class TestIdList(object):
3780
"""Test id list to filter a test suite.
3782
Relying on the assumption that test ids are built as:
3783
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3784
notation, this class offers methods to :
3785
- avoid building a test suite for modules not refered to in the test list,
3786
- keep only the tests listed from the module test suite.
3789
def __init__(self, test_id_list):
3790
# When a test suite needs to be filtered against us we compare test ids
3791
# for equality, so a simple dict offers a quick and simple solution.
3792
self.tests = dict().fromkeys(test_id_list, True)
3794
# While unittest.TestCase have ids like:
3795
# <module>.<class>.<method>[(<param+)],
3796
# doctest.DocTestCase can have ids like:
3799
# <module>.<function>
3800
# <module>.<class>.<method>
3802
# Since we can't predict a test class from its name only, we settle on
3803
# a simple constraint: a test id always begins with its module name.
3806
for test_id in test_id_list:
3807
parts = test_id.split('.')
3808
mod_name = parts.pop(0)
3809
modules[mod_name] = True
3811
mod_name += '.' + part
3812
modules[mod_name] = True
3813
self.modules = modules
3815
def refers_to(self, module_name):
3816
"""Is there tests for the module or one of its sub modules."""
3817
return module_name in self.modules
3819
def includes(self, test_id):
3820
return test_id in self.tests
3823
class TestPrefixAliasRegistry(registry.Registry):
3824
"""A registry for test prefix aliases.
3826
This helps implement shorcuts for the --starting-with selftest
3827
option. Overriding existing prefixes is not allowed but not fatal (a
3828
warning will be emitted).
3831
def register(self, key, obj, help=None, info=None,
3832
override_existing=False):
3833
"""See Registry.register.
3835
Trying to override an existing alias causes a warning to be emitted,
3836
not a fatal execption.
3839
super(TestPrefixAliasRegistry, self).register(
3840
key, obj, help=help, info=info, override_existing=False)
3842
actual = self.get(key)
3844
'Test prefix alias %s is already used for %s, ignoring %s'
3845
% (key, actual, obj))
3847
def resolve_alias(self, id_start):
3848
"""Replace the alias by the prefix in the given string.
3850
Using an unknown prefix is an error to help catching typos.
3852
parts = id_start.split('.')
3854
parts[0] = self.get(parts[0])
3856
raise errors.BzrCommandError(
3857
'%s is not a known test prefix alias' % parts[0])
3858
return '.'.join(parts)
3861
test_prefix_alias_registry = TestPrefixAliasRegistry()
3862
"""Registry of test prefix aliases."""
3865
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3866
# appear prefixed ('breezy.' is "replaced" by 'breezy.').
3867
test_prefix_alias_registry.register('breezy', 'breezy')
3869
# Obvious highest levels prefixes, feel free to add your own via a plugin
3870
test_prefix_alias_registry.register('bd', 'breezy.doc')
3871
test_prefix_alias_registry.register('bu', 'breezy.utils')
3872
test_prefix_alias_registry.register('bt', 'breezy.tests')
3873
test_prefix_alias_registry.register('bb', 'breezy.tests.blackbox')
3874
test_prefix_alias_registry.register('bp', 'breezy.plugins')
3877
def _test_suite_testmod_names():
3878
"""Return the standard list of test module names to test."""
3881
'breezy.tests.blackbox',
3882
'breezy.tests.commands',
3883
'breezy.tests.per_branch',
3884
'breezy.tests.per_bzrdir',
3885
'breezy.tests.per_controldir',
3886
'breezy.tests.per_controldir_colo',
3887
'breezy.tests.per_foreign_vcs',
3888
'breezy.tests.per_interrepository',
3889
'breezy.tests.per_intertree',
3890
'breezy.tests.per_inventory',
3891
'breezy.tests.per_interbranch',
3892
'breezy.tests.per_lock',
3893
'breezy.tests.per_merger',
3894
'breezy.tests.per_transport',
3895
'breezy.tests.per_tree',
3896
'breezy.tests.per_pack_repository',
3897
'breezy.tests.per_repository',
3898
'breezy.tests.per_repository_chk',
3899
'breezy.tests.per_repository_reference',
3900
'breezy.tests.per_repository_vf',
3901
'breezy.tests.per_uifactory',
3902
'breezy.tests.per_versionedfile',
3903
'breezy.tests.per_workingtree',
3904
'breezy.tests.test__annotator',
3905
'breezy.tests.test__bencode',
3906
'breezy.tests.test__btree_serializer',
3907
'breezy.tests.test__chk_map',
3908
'breezy.tests.test__dirstate_helpers',
3909
'breezy.tests.test__groupcompress',
3910
'breezy.tests.test__known_graph',
3911
'breezy.tests.test__rio',
3912
'breezy.tests.test__simple_set',
3913
'breezy.tests.test__static_tuple',
3914
'breezy.tests.test__walkdirs_win32',
3915
'breezy.tests.test_ancestry',
3916
'breezy.tests.test_annotate',
3917
'breezy.tests.test_atomicfile',
3918
'breezy.tests.test_bad_files',
3919
'breezy.tests.test_bisect',
3920
'breezy.tests.test_bisect_multi',
3921
'breezy.tests.test_branch',
3922
'breezy.tests.test_branchbuilder',
3923
'breezy.tests.test_btree_index',
3924
'breezy.tests.test_bugtracker',
3925
'breezy.tests.test_bundle',
3926
'breezy.tests.test_bzrdir',
3927
'breezy.tests.test__chunks_to_lines',
3928
'breezy.tests.test_cache_utf8',
3929
'breezy.tests.test_chk_map',
3930
'breezy.tests.test_chk_serializer',
3931
'breezy.tests.test_chunk_writer',
3932
'breezy.tests.test_clean_tree',
3933
'breezy.tests.test_cleanup',
3934
'breezy.tests.test_cmdline',
3935
'breezy.tests.test_commands',
3936
'breezy.tests.test_commit',
3937
'breezy.tests.test_commit_merge',
3938
'breezy.tests.test_config',
3939
'breezy.tests.test_conflicts',
3940
'breezy.tests.test_controldir',
3941
'breezy.tests.test_counted_lock',
3942
'breezy.tests.test_crash',
3943
'breezy.tests.test_decorators',
3944
'breezy.tests.test_delta',
3945
'breezy.tests.test_debug',
3946
'breezy.tests.test_diff',
3947
'breezy.tests.test_directory_service',
3948
'breezy.tests.test_dirstate',
3949
'breezy.tests.test_email_message',
3950
'breezy.tests.test_eol_filters',
3951
'breezy.tests.test_errors',
3952
'breezy.tests.test_estimate_compressed_size',
3953
'breezy.tests.test_export',
3954
'breezy.tests.test_export_pot',
3955
'breezy.tests.test_extract',
3956
'breezy.tests.test_features',
3957
'breezy.tests.test_fetch',
3958
'breezy.tests.test_fetch_ghosts',
3959
'breezy.tests.test_fixtures',
3960
'breezy.tests.test_fifo_cache',
3961
'breezy.tests.test_filters',
3962
'breezy.tests.test_filter_tree',
3963
'breezy.tests.test_foreign',
3964
'breezy.tests.test_generate_docs',
3965
'breezy.tests.test_generate_ids',
3966
'breezy.tests.test_globbing',
3967
'breezy.tests.test_gpg',
3968
'breezy.tests.test_graph',
3969
'breezy.tests.test_groupcompress',
3970
'breezy.tests.test_hashcache',
3971
'breezy.tests.test_help',
3972
'breezy.tests.test_hooks',
3973
'breezy.tests.test_http',
3974
'breezy.tests.test_http_response',
3975
'breezy.tests.test_https_ca_bundle',
3976
'breezy.tests.test_https_urllib',
3977
'breezy.tests.test_i18n',
3978
'breezy.tests.test_identitymap',
3979
'breezy.tests.test_ignores',
3980
'breezy.tests.test_index',
3981
'breezy.tests.test_import_tariff',
3982
'breezy.tests.test_info',
3983
'breezy.tests.test_inv',
3984
'breezy.tests.test_inventory_delta',
3985
'breezy.tests.test_knit',
3986
'breezy.tests.test_lazy_import',
3987
'breezy.tests.test_lazy_regex',
3988
'breezy.tests.test_library_state',
3989
'breezy.tests.test_lock',
3990
'breezy.tests.test_lockable_files',
3991
'breezy.tests.test_lockdir',
3992
'breezy.tests.test_log',
3993
'breezy.tests.test_lru_cache',
3994
'breezy.tests.test_lsprof',
3995
'breezy.tests.test_mail_client',
3996
'breezy.tests.test_matchers',
3997
'breezy.tests.test_memorytree',
3998
'breezy.tests.test_merge',
3999
'breezy.tests.test_merge3',
4000
'breezy.tests.test_merge_core',
4001
'breezy.tests.test_merge_directive',
4002
'breezy.tests.test_mergetools',
4003
'breezy.tests.test_missing',
4004
'breezy.tests.test_msgeditor',
4005
'breezy.tests.test_multiparent',
4006
'breezy.tests.test_mutabletree',
4007
'breezy.tests.test_nonascii',
4008
'breezy.tests.test_options',
4009
'breezy.tests.test_osutils',
4010
'breezy.tests.test_osutils_encodings',
4011
'breezy.tests.test_pack',
4012
'breezy.tests.test_patch',
4013
'breezy.tests.test_patches',
4014
'breezy.tests.test_permissions',
4015
'breezy.tests.test_plugins',
4016
'breezy.tests.test_progress',
4017
'breezy.tests.test_pyutils',
4018
'breezy.tests.test_read_bundle',
4019
'breezy.tests.test_reconcile',
4020
'breezy.tests.test_reconfigure',
4021
'breezy.tests.test_registry',
4022
'breezy.tests.test_remote',
4023
'breezy.tests.test_rename_map',
4024
'breezy.tests.test_repository',
4025
'breezy.tests.test_revert',
4026
'breezy.tests.test_revision',
4027
'breezy.tests.test_revisionspec',
4028
'breezy.tests.test_revisiontree',
4029
'breezy.tests.test_rio',
4030
'breezy.tests.test_rules',
4031
'breezy.tests.test_url_policy_open',
4032
'breezy.tests.test_sampler',
4033
'breezy.tests.test_scenarios',
4034
'breezy.tests.test_script',
4035
'breezy.tests.test_selftest',
4036
'breezy.tests.test_serializer',
4037
'breezy.tests.test_setup',
4038
'breezy.tests.test_sftp_transport',
4039
'breezy.tests.test_shelf',
4040
'breezy.tests.test_shelf_ui',
4041
'breezy.tests.test_smart',
4042
'breezy.tests.test_smart_add',
4043
'breezy.tests.test_smart_request',
4044
'breezy.tests.test_smart_signals',
4045
'breezy.tests.test_smart_transport',
4046
'breezy.tests.test_smtp_connection',
4047
'breezy.tests.test_source',
4048
'breezy.tests.test_ssh_transport',
4049
'breezy.tests.test_status',
4050
'breezy.tests.test_strace',
4051
'breezy.tests.test_subsume',
4052
'breezy.tests.test_switch',
4053
'breezy.tests.test_symbol_versioning',
4054
'breezy.tests.test_tag',
4055
'breezy.tests.test_test_server',
4056
'breezy.tests.test_testament',
4057
'breezy.tests.test_textfile',
4058
'breezy.tests.test_textmerge',
4059
'breezy.tests.test_cethread',
4060
'breezy.tests.test_timestamp',
4061
'breezy.tests.test_trace',
4062
'breezy.tests.test_transactions',
4063
'breezy.tests.test_transform',
4064
'breezy.tests.test_transport',
4065
'breezy.tests.test_transport_log',
4066
'breezy.tests.test_tree',
4067
'breezy.tests.test_treebuilder',
4068
'breezy.tests.test_treeshape',
4069
'breezy.tests.test_tsort',
4070
'breezy.tests.test_tuned_gzip',
4071
'breezy.tests.test_ui',
4072
'breezy.tests.test_uncommit',
4073
'breezy.tests.test_upgrade',
4074
'breezy.tests.test_upgrade_stacked',
4075
'breezy.tests.test_upstream_import',
4076
'breezy.tests.test_urlutils',
4077
'breezy.tests.test_utextwrap',
4078
'breezy.tests.test_version',
4079
'breezy.tests.test_version_info',
4080
'breezy.tests.test_versionedfile',
4081
'breezy.tests.test_vf_search',
4082
'breezy.tests.test_views',
4083
'breezy.tests.test_weave',
4084
'breezy.tests.test_whitebox',
4085
'breezy.tests.test_win32utils',
4086
'breezy.tests.test_workingtree',
4087
'breezy.tests.test_workingtree_4',
4088
'breezy.tests.test_wsgi',
4089
'breezy.tests.test_xml',
4093
def _test_suite_modules_to_doctest():
4094
"""Return the list of modules to doctest."""
4096
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4100
'breezy.branchbuilder',
4101
'breezy.bzr.inventory',
4102
'breezy.decorators',
4103
'breezy.iterablefile',
4108
'breezy.symbol_versioning',
4110
'breezy.tests.fixtures',
4112
'breezy.transport.http',
4113
'breezy.version_info_formats.format_custom',
4117
def test_suite(keep_only=None, starting_with=None):
4118
"""Build and return TestSuite for the whole of breezy.
4120
:param keep_only: A list of test ids limiting the suite returned.
4122
:param starting_with: An id limiting the suite returned to the tests
4125
This function can be replaced if you need to change the default test
4126
suite on a global basis, but it is not encouraged.
4129
loader = TestUtil.TestLoader()
4131
if keep_only is not None:
4132
id_filter = TestIdList(keep_only)
4134
# We take precedence over keep_only because *at loading time* using
4135
# both options means we will load less tests for the same final result.
4136
def interesting_module(name):
4137
for start in starting_with:
4139
# Either the module name starts with the specified string
4140
name.startswith(start)
4141
# or it may contain tests starting with the specified string
4142
or start.startswith(name)
4146
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4148
elif keep_only is not None:
4149
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4150
def interesting_module(name):
4151
return id_filter.refers_to(name)
4154
loader = TestUtil.TestLoader()
4155
def interesting_module(name):
4156
# No filtering, all modules are interesting
4159
suite = loader.suiteClass()
4161
# modules building their suite with loadTestsFromModuleNames
4162
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4164
for mod in _test_suite_modules_to_doctest():
4165
if not interesting_module(mod):
4166
# No tests to keep here, move along
4169
# note that this really does mean "report only" -- doctest
4170
# still runs the rest of the examples
4171
doc_suite = IsolatedDocTestSuite(
4172
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
4173
except ValueError as e:
4174
print('**failed to get doctest for: %s\n%s' % (mod, e))
4176
if len(doc_suite._tests) == 0:
4177
raise errors.BzrError("no doctests found in %s" % (mod,))
4178
suite.addTest(doc_suite)
4180
default_encoding = sys.getdefaultencoding()
4181
for name, plugin in _mod_plugin.plugins().items():
4182
if not interesting_module(plugin.module.__name__):
4184
plugin_suite = plugin.test_suite()
4185
# We used to catch ImportError here and turn it into just a warning,
4186
# but really if you don't have --no-plugins this should be a failure.
4187
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4188
if plugin_suite is None:
4189
plugin_suite = plugin.load_plugin_tests(loader)
4190
if plugin_suite is not None:
4191
suite.addTest(plugin_suite)
4192
if default_encoding != sys.getdefaultencoding():
4194
'Plugin "%s" tried to reset default encoding to: %s', name,
4195
sys.getdefaultencoding())
4197
sys.setdefaultencoding(default_encoding)
4199
if keep_only is not None:
4200
# Now that the referred modules have loaded their tests, keep only the
4202
suite = filter_suite_by_id_list(suite, id_filter)
4203
# Do some sanity checks on the id_list filtering
4204
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4206
# The tester has used both keep_only and starting_with, so he is
4207
# already aware that some tests are excluded from the list, there
4208
# is no need to tell him which.
4211
# Some tests mentioned in the list are not in the test suite. The
4212
# list may be out of date, report to the tester.
4213
for id in not_found:
4214
trace.warning('"%s" not found in the test suite', id)
4215
for id in duplicates:
4216
trace.warning('"%s" is used as an id by several tests', id)
4221
def multiply_scenarios(*scenarios):
4222
"""Multiply two or more iterables of scenarios.
4224
It is safe to pass scenario generators or iterators.
4226
:returns: A list of compound scenarios: the cross-product of all
4227
scenarios, with the names concatenated and the parameters
4230
return functools.reduce(_multiply_two_scenarios, map(list, scenarios))
4233
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4234
"""Multiply two sets of scenarios.
4236
:returns: the cartesian product of the two sets of scenarios, that is
4237
a scenario for every possible combination of a left scenario and a
4241
('%s,%s' % (left_name, right_name),
4242
dict(left_dict, **right_dict))
4243
for left_name, left_dict in scenarios_left
4244
for right_name, right_dict in scenarios_right]
4247
def multiply_tests(tests, scenarios, result):
4248
"""Multiply tests_list by scenarios into result.
4250
This is the core workhorse for test parameterisation.
4252
Typically the load_tests() method for a per-implementation test suite will
4253
call multiply_tests and return the result.
4255
:param tests: The tests to parameterise.
4256
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4257
scenario_param_dict).
4258
:param result: A TestSuite to add created tests to.
4260
This returns the passed in result TestSuite with the cross product of all
4261
the tests repeated once for each scenario. Each test is adapted by adding
4262
the scenario name at the end of its id(), and updating the test object's
4263
__dict__ with the scenario_param_dict.
4265
>>> import breezy.tests.test_sampler
4266
>>> r = multiply_tests(
4267
... breezy.tests.test_sampler.DemoTest('test_nothing'),
4268
... [('one', dict(param=1)),
4269
... ('two', dict(param=2))],
4270
... TestUtil.TestSuite())
4271
>>> tests = list(iter_suite_tests(r))
4275
'breezy.tests.test_sampler.DemoTest.test_nothing(one)'
4281
for test in iter_suite_tests(tests):
4282
apply_scenarios(test, scenarios, result)
4286
def apply_scenarios(test, scenarios, result):
4287
"""Apply the scenarios in scenarios to test and add to result.
4289
:param test: The test to apply scenarios to.
4290
:param scenarios: An iterable of scenarios to apply to test.
4292
:seealso: apply_scenario
4294
for scenario in scenarios:
4295
result.addTest(apply_scenario(test, scenario))
4299
def apply_scenario(test, scenario):
4300
"""Copy test and apply scenario to it.
4302
:param test: A test to adapt.
4303
:param scenario: A tuple describing the scenario.
4304
The first element of the tuple is the new test id.
4305
The second element is a dict containing attributes to set on the
4307
:return: The adapted test.
4309
new_id = "%s(%s)" % (test.id(), scenario[0])
4310
new_test = clone_test(test, new_id)
4311
for name, value in scenario[1].items():
4312
setattr(new_test, name, value)
4316
def clone_test(test, new_id):
4317
"""Clone a test giving it a new id.
4319
:param test: The test to clone.
4320
:param new_id: The id to assign to it.
4321
:return: The new test.
4323
new_test = copy.copy(test)
4324
new_test.id = lambda: new_id
4325
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4326
# causes cloned tests to share the 'details' dict. This makes it hard to
4327
# read the test output for parameterized tests, because tracebacks will be
4328
# associated with irrelevant tests.
4330
details = new_test._TestCase__details
4331
except AttributeError:
4332
# must be a different version of testtools than expected. Do nothing.
4335
# Reset the '__details' dict.
4336
new_test._TestCase__details = {}
4340
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4342
"""Helper for permutating tests against an extension module.
4344
This is meant to be used inside a modules 'load_tests()' function. It will
4345
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4346
against both implementations. Setting 'test.module' to the appropriate
4347
module. See breezy.tests.test__chk_map.load_tests as an example.
4349
:param standard_tests: A test suite to permute
4350
:param loader: A TestLoader
4351
:param py_module_name: The python path to a python module that can always
4352
be loaded, and will be considered the 'python' implementation. (eg
4353
'breezy._chk_map_py')
4354
:param ext_module_name: The python path to an extension module. If the
4355
module cannot be loaded, a single test will be added, which notes that
4356
the module is not available. If it can be loaded, all standard_tests
4357
will be run against that module.
4358
:return: (suite, feature) suite is a test-suite that has all the permuted
4359
tests. feature is the Feature object that can be used to determine if
4360
the module is available.
4363
from .features import ModuleAvailableFeature
4364
py_module = pyutils.get_named_object(py_module_name)
4366
('python', {'module': py_module}),
4368
suite = loader.suiteClass()
4369
feature = ModuleAvailableFeature(ext_module_name)
4370
if feature.available():
4371
scenarios.append(('C', {'module': feature.module}))
4373
# the compiled module isn't available, so we add a failing test
4374
class FailWithoutFeature(TestCase):
4375
def test_fail(self):
4376
self.requireFeature(feature)
4377
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4378
result = multiply_tests(standard_tests, scenarios, suite)
4379
return result, feature
4382
def _rmtree_temp_dir(dirname, test_id=None):
4383
# If LANG=C we probably have created some bogus paths
4384
# which rmtree(unicode) will fail to delete
4385
# so make sure we are using rmtree(str) to delete everything
4386
# except on win32, where rmtree(str) will fail
4387
# since it doesn't have the property of byte-stream paths
4388
# (they are either ascii or mbcs)
4389
if sys.platform == 'win32' and isinstance(dirname, bytes):
4390
# make sure we are using the unicode win32 api
4391
dirname = dirname.decode('mbcs')
4393
dirname = dirname.encode(sys.getfilesystemencoding())
4395
osutils.rmtree(dirname)
4396
except OSError as e:
4397
# We don't want to fail here because some useful display will be lost
4398
# otherwise. Polluting the tmp dir is bad, but not giving all the
4399
# possible info to the test runner is even worse.
4401
ui.ui_factory.clear_term()
4402
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4403
# Ugly, but the last thing we want here is fail, so bear with it.
4404
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4405
).encode('ascii', 'replace')
4406
sys.stderr.write('Unable to remove testing dir %s\n%s'
4407
% (os.path.basename(dirname), printable_e))
4410
def probe_unicode_in_user_encoding():
4411
"""Try to encode several unicode strings to use in unicode-aware tests.
4412
Return first successfull match.
4414
:return: (unicode value, encoded plain string value) or (None, None)
4416
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4417
for uni_val in possible_vals:
4419
str_val = uni_val.encode(osutils.get_user_encoding())
4420
except UnicodeEncodeError:
4421
# Try a different character
4424
return uni_val, str_val
4428
def probe_bad_non_ascii(encoding):
4429
"""Try to find [bad] character with code [128..255]
4430
that cannot be decoded to unicode in some encoding.
4431
Return None if all non-ascii characters is valid
4434
for i in range(128, 256):
4437
char.decode(encoding)
4438
except UnicodeDecodeError:
4443
# Only define SubUnitBzrRunner if subunit is available.
4445
from subunit import TestProtocolClient
4446
from subunit.test_results import AutoTimingTestResultDecorator
4448
class SubUnitBzrProtocolClientv1(TestProtocolClient):
4450
def stopTest(self, test):
4451
super(SubUnitBzrProtocolClientv1, self).stopTest(test)
4452
_clear__type_equality_funcs(test)
4454
def addSuccess(self, test, details=None):
4455
# The subunit client always includes the details in the subunit
4456
# stream, but we don't want to include it in ours.
4457
if details is not None and 'log' in details:
4459
return super(SubUnitBzrProtocolClientv1, self).addSuccess(
4462
class SubUnitBzrRunnerv1(TextTestRunner):
4464
def run(self, test):
4465
result = AutoTimingTestResultDecorator(
4466
SubUnitBzrProtocolClientv1(self.stream))
4474
from subunit.run import SubunitTestRunner
4476
class SubUnitBzrRunnerv2(TextTestRunner, SubunitTestRunner):
4478
def __init__(self, stream=sys.stderr, descriptions=0, verbosity=1,
4479
bench_history=None, strict=False, result_decorators=None):
4480
TextTestRunner.__init__(
4481
self, stream=stream,
4482
descriptions=descriptions, verbosity=verbosity,
4483
bench_history=bench_history, strict=strict,
4484
result_decorators=result_decorators)
4485
SubunitTestRunner.__init__(self, verbosity=verbosity,
4488
run = SubunitTestRunner.run
added
removed
breezy/tests/__init__.py
