1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from testsweet import TestBase, run_suite, InTempDir
21
MODULES_TO_DOCTEST = []
23
def selftest(verbose=False):
24
from unittest import TestLoader, TestSuite
25
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
26
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
27
global MODULES_TO_TEST, MODULES_TO_DOCTEST
29
import bzrlib.selftest.whitebox
30
import bzrlib.selftest.blackbox
31
import bzrlib.selftest.versioning
32
import bzrlib.selftest.testmerge3
33
import bzrlib.selftest.testhashcache
34
import bzrlib.selftest.testrevisionnamespaces
35
import bzrlib.selftest.testbranch
36
import bzrlib.selftest.teststatus
37
import bzrlib.selftest.testinv
38
import bzrlib.merge_core
39
from doctest import DocTestSuite
46
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
47
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
48
if m not in MODULES_TO_DOCTEST:
49
MODULES_TO_DOCTEST.append(m)
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Testing framework extensions"""
19
# NOTE: Some classes in here use camelCaseNaming() rather than
20
# underscore_naming(). That's for consistency with unittest; it's not the
21
# general style of bzrlib. Please continue that consistency when adding e.g.
22
# new assertFoo() methods.
27
from cStringIO import StringIO
50
# nb: check this before importing anything else from within it
51
_testtools_version = getattr(testtools, '__version__', ())
52
if _testtools_version < (0, 9, 5):
53
raise ImportError("need at least testtools 0.9.5: %s is %r"
54
% (testtools.__file__, _testtools_version))
55
from testtools import content
62
commands as _mod_commands,
72
plugin as _mod_plugin,
79
transport as _mod_transport,
85
# lsprof not available
87
from bzrlib.smart import client, request
88
from bzrlib.transport import (
92
from bzrlib.symbol_versioning import (
96
from bzrlib.tests import (
101
from bzrlib.ui import NullProgressView
102
from bzrlib.ui.text import TextUIFactory
104
# Mark this python module as being part of the implementation
105
# of unittest: this gives us better tracebacks where the last
106
# shown frame is the test code, not our assertXYZ.
109
default_transport = test_server.LocalURLServer
112
_unitialized_attr = object()
113
"""A sentinel needed to act as a default value in a method signature."""
116
# Subunit result codes, defined here to prevent a hard dependency on subunit.
120
# These are intentionally brought into this namespace. That way plugins, etc
121
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
122
TestSuite = TestUtil.TestSuite
123
TestLoader = TestUtil.TestLoader
125
# Tests should run in a clean and clearly defined environment. The goal is to
126
# keep them isolated from the running environment as mush as possible. The test
127
# framework ensures the variables defined below are set (or deleted if the
128
# value is None) before a test is run and reset to their original value after
129
# the test is run. Generally if some code depends on an environment variable,
130
# the tests should start without this variable in the environment. There are a
131
# few exceptions but you shouldn't violate this rule lightly.
135
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
136
# tests do check our impls match APPDATA
137
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
141
'BZREMAIL': None, # may still be present in the environment
142
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
143
'BZR_PROGRESS_BAR': None,
144
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
145
# as a base class instead of TestCaseInTempDir. Tests inheriting from
146
# TestCase should not use disk resources, BZR_LOG is one.
147
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
148
'BZR_PLUGIN_PATH': None,
149
'BZR_DISABLE_PLUGINS': None,
150
'BZR_PLUGINS_AT': None,
151
'BZR_CONCURRENCY': None,
152
# Make sure that any text ui tests are consistent regardless of
153
# the environment the test case is run in; you may want tests that
154
# test other combinations. 'dumb' is a reasonable guess for tests
155
# going to a pipe or a StringIO.
161
'SSH_AUTH_SOCK': None,
171
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
172
# least. If you do (care), please update this comment
176
'BZR_REMOTE_PATH': None,
177
# Generally speaking, we don't want apport reporting on crashes in
178
# the test envirnoment unless we're specifically testing apport,
179
# so that it doesn't leak into the real system environment. We
180
# use an env var so it propagates to subprocesses.
181
'APPORT_DISABLE': '1',
185
def override_os_environ(test, env=None):
186
"""Modify os.environ keeping a copy.
52
for m in (bzrlib.selftest.whitebox,
53
bzrlib.selftest.versioning,
54
bzrlib.selftest.testinv,
55
bzrlib.selftest.testmerge3,
56
bzrlib.selftest.testhashcache,
57
bzrlib.selftest.teststatus,
58
bzrlib.selftest.blackbox,
59
bzrlib.selftest.testhashcache,
60
bzrlib.selftest.testrevisionnamespaces,
61
bzrlib.selftest.testbranch,
188
:param test: A test instance
190
:param env: A dict containing variable definitions to be installed
193
env = isolated_environ
194
test._original_os_environ = dict([(var, value)
195
for var, value in os.environ.iteritems()])
196
for var, value in env.iteritems():
197
osutils.set_or_unset_env(var, value)
198
if var not in test._original_os_environ:
199
# The var is new, add it with a value of None, so
200
# restore_os_environ will delete it
201
test._original_os_environ[var] = None
204
def restore_os_environ(test):
205
"""Restore os.environ to its original state.
207
:param test: A test instance previously passed to override_os_environ.
209
for var, value in test._original_os_environ.iteritems():
210
# Restore the original value (or delete it if the value has been set to
211
# None in override_os_environ).
212
osutils.set_or_unset_env(var, value)
215
def _clear__type_equality_funcs(test):
216
"""Cleanup bound methods stored on TestCase instances
218
Clear the dict breaking a few (mostly) harmless cycles in the affected
219
unittests released with Python 2.6 and initial Python 2.7 versions.
221
For a few revisions between Python 2.7.1 and Python 2.7.2 that annoyingly
222
shipped in Oneiric, an object with no clear method was used, hence the
223
extra complications, see bug 809048 for details.
225
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
226
if type_equality_funcs is not None:
227
tef_clear = getattr(type_equality_funcs, "clear", None)
228
if tef_clear is None:
229
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
230
if tef_instance_dict is not None:
231
tef_clear = tef_instance_dict.clear
232
if tef_clear is not None:
236
class ExtendedTestResult(testtools.TextTestResult):
237
"""Accepts, reports and accumulates the results of running tests.
239
Compared to the unittest version this class adds support for
240
profiling, benchmarking, stopping as soon as a test fails, and
241
skipping tests. There are further-specialized subclasses for
242
different types of display.
244
When a test finishes, in whatever way, it calls one of the addSuccess,
245
addFailure or addError classes. These in turn may redirect to a more
246
specific case for the special test results supported by our extended
249
Note that just one of these objects is fed the results from many tests.
254
def __init__(self, stream, descriptions, verbosity,
258
"""Construct new TestResult.
260
:param bench_history: Optionally, a writable file object to accumulate
263
testtools.TextTestResult.__init__(self, stream)
264
if bench_history is not None:
265
from bzrlib.version import _get_bzr_source_tree
266
src_tree = _get_bzr_source_tree()
269
revision_id = src_tree.get_parent_ids()[0]
271
# XXX: if this is a brand new tree, do the same as if there
275
# XXX: If there's no branch, what should we do?
277
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
278
self._bench_history = bench_history
279
self.ui = ui.ui_factory
282
self.failure_count = 0
283
self.known_failure_count = 0
285
self.not_applicable_count = 0
286
self.unsupported = {}
288
self._overall_start_time = time.time()
289
self._strict = strict
290
self._first_thread_leaker_id = None
291
self._tests_leaking_threads_count = 0
292
self._traceback_from_test = None
294
def stopTestRun(self):
297
stopTime = time.time()
298
timeTaken = stopTime - self.startTime
299
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
300
# the parent class method is similar have to duplicate
301
self._show_list('ERROR', self.errors)
302
self._show_list('FAIL', self.failures)
303
self.stream.write(self.sep2)
304
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
305
run, run != 1 and "s" or "", timeTaken))
306
if not self.wasSuccessful():
307
self.stream.write("FAILED (")
308
failed, errored = map(len, (self.failures, self.errors))
310
self.stream.write("failures=%d" % failed)
312
if failed: self.stream.write(", ")
313
self.stream.write("errors=%d" % errored)
314
if self.known_failure_count:
315
if failed or errored: self.stream.write(", ")
316
self.stream.write("known_failure_count=%d" %
317
self.known_failure_count)
318
self.stream.write(")\n")
320
if self.known_failure_count:
321
self.stream.write("OK (known_failures=%d)\n" %
322
self.known_failure_count)
324
self.stream.write("OK\n")
325
if self.skip_count > 0:
326
skipped = self.skip_count
327
self.stream.write('%d test%s skipped\n' %
328
(skipped, skipped != 1 and "s" or ""))
330
for feature, count in sorted(self.unsupported.items()):
331
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
334
ok = self.wasStrictlySuccessful()
336
ok = self.wasSuccessful()
337
if self._first_thread_leaker_id:
339
'%s is leaking threads among %d leaking tests.\n' % (
340
self._first_thread_leaker_id,
341
self._tests_leaking_threads_count))
342
# We don't report the main thread as an active one.
344
'%d non-main threads were left active in the end.\n'
345
% (len(self._active_threads) - 1))
347
def getDescription(self, test):
350
def _extractBenchmarkTime(self, testCase, details=None):
351
"""Add a benchmark time for the current test case."""
352
if details and 'benchtime' in details:
353
return float(''.join(details['benchtime'].iter_bytes()))
354
return getattr(testCase, "_benchtime", None)
356
def _elapsedTestTimeString(self):
357
"""Return a time string for the overall time the current test has taken."""
358
return self._formatTime(self._delta_to_float(
359
self._now() - self._start_datetime))
361
def _testTimeString(self, testCase):
362
benchmark_time = self._extractBenchmarkTime(testCase)
363
if benchmark_time is not None:
364
return self._formatTime(benchmark_time) + "*"
366
return self._elapsedTestTimeString()
368
def _formatTime(self, seconds):
369
"""Format seconds as milliseconds with leading spaces."""
370
# some benchmarks can take thousands of seconds to run, so we need 8
372
return "%8dms" % (1000 * seconds)
374
def _shortened_test_description(self, test):
376
what = re.sub(r'^bzrlib\.tests\.', '', what)
379
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
380
# multiple times in a row, because the handler is added for
381
# each test but the container list is shared between cases.
382
# See lp:498869 lp:625574 and lp:637725 for background.
383
def _record_traceback_from_test(self, exc_info):
384
"""Store the traceback from passed exc_info tuple till"""
385
self._traceback_from_test = exc_info[2]
387
def startTest(self, test):
388
super(ExtendedTestResult, self).startTest(test)
392
self.report_test_start(test)
393
test.number = self.count
394
self._recordTestStartTime()
395
# Make testtools cases give us the real traceback on failure
396
addOnException = getattr(test, "addOnException", None)
397
if addOnException is not None:
398
addOnException(self._record_traceback_from_test)
399
# Only check for thread leaks on bzrlib derived test cases
400
if isinstance(test, TestCase):
401
test.addCleanup(self._check_leaked_threads, test)
403
def stopTest(self, test):
404
super(ExtendedTestResult, self).stopTest(test)
405
# Manually break cycles, means touching various private things but hey
406
getDetails = getattr(test, "getDetails", None)
407
if getDetails is not None:
409
_clear__type_equality_funcs(test)
410
self._traceback_from_test = None
412
def startTests(self):
413
self.report_tests_starting()
414
self._active_threads = threading.enumerate()
416
def _check_leaked_threads(self, test):
417
"""See if any threads have leaked since last call
419
A sample of live threads is stored in the _active_threads attribute,
420
when this method runs it compares the current live threads and any not
421
in the previous sample are treated as having leaked.
423
now_active_threads = set(threading.enumerate())
424
threads_leaked = now_active_threads.difference(self._active_threads)
426
self._report_thread_leak(test, threads_leaked, now_active_threads)
427
self._tests_leaking_threads_count += 1
428
if self._first_thread_leaker_id is None:
429
self._first_thread_leaker_id = test.id()
430
self._active_threads = now_active_threads
432
def _recordTestStartTime(self):
433
"""Record that a test has started."""
434
self._start_datetime = self._now()
436
def addError(self, test, err):
437
"""Tell result that test finished with an error.
439
Called from the TestCase run() method when the test
440
fails with an unexpected error.
442
self._post_mortem(self._traceback_from_test)
443
super(ExtendedTestResult, self).addError(test, err)
444
self.error_count += 1
445
self.report_error(test, err)
449
def addFailure(self, test, err):
450
"""Tell result that test failed.
452
Called from the TestCase run() method when the test
453
fails because e.g. an assert() method failed.
455
self._post_mortem(self._traceback_from_test)
456
super(ExtendedTestResult, self).addFailure(test, err)
457
self.failure_count += 1
458
self.report_failure(test, err)
462
def addSuccess(self, test, details=None):
463
"""Tell result that test completed successfully.
465
Called from the TestCase run()
467
if self._bench_history is not None:
468
benchmark_time = self._extractBenchmarkTime(test, details)
469
if benchmark_time is not None:
470
self._bench_history.write("%s %s\n" % (
471
self._formatTime(benchmark_time),
473
self.report_success(test)
474
super(ExtendedTestResult, self).addSuccess(test)
475
test._log_contents = ''
477
def addExpectedFailure(self, test, err):
478
self.known_failure_count += 1
479
self.report_known_failure(test, err)
481
def addUnexpectedSuccess(self, test, details=None):
482
"""Tell result the test unexpectedly passed, counting as a failure
484
When the minimum version of testtools required becomes 0.9.8 this
485
can be updated to use the new handling there.
487
super(ExtendedTestResult, self).addFailure(test, details=details)
488
self.failure_count += 1
489
self.report_unexpected_success(test,
490
"".join(details["reason"].iter_text()))
494
def addNotSupported(self, test, feature):
495
"""The test will not be run because of a missing feature.
497
# this can be called in two different ways: it may be that the
498
# test started running, and then raised (through requireFeature)
499
# UnavailableFeature. Alternatively this method can be called
500
# while probing for features before running the test code proper; in
501
# that case we will see startTest and stopTest, but the test will
502
# never actually run.
503
self.unsupported.setdefault(str(feature), 0)
504
self.unsupported[str(feature)] += 1
505
self.report_unsupported(test, feature)
507
def addSkip(self, test, reason):
508
"""A test has not run for 'reason'."""
510
self.report_skip(test, reason)
512
def addNotApplicable(self, test, reason):
513
self.not_applicable_count += 1
514
self.report_not_applicable(test, reason)
516
def _count_stored_tests(self):
517
"""Count of tests instances kept alive due to not succeeding"""
518
return self.error_count + self.failure_count + self.known_failure_count
520
def _post_mortem(self, tb=None):
521
"""Start a PDB post mortem session."""
522
if os.environ.get('BZR_TEST_PDB', None):
526
def progress(self, offset, whence):
527
"""The test is adjusting the count of tests to run."""
528
if whence == SUBUNIT_SEEK_SET:
529
self.num_tests = offset
530
elif whence == SUBUNIT_SEEK_CUR:
531
self.num_tests += offset
533
raise errors.BzrError("Unknown whence %r" % whence)
535
def report_tests_starting(self):
536
"""Display information before the test run begins"""
537
if getattr(sys, 'frozen', None) is None:
538
bzr_path = osutils.realpath(sys.argv[0])
540
bzr_path = sys.executable
542
'bzr selftest: %s\n' % (bzr_path,))
545
bzrlib.__path__[0],))
547
' bzr-%s python-%s %s\n' % (
548
bzrlib.version_string,
549
bzrlib._format_version_tuple(sys.version_info),
550
platform.platform(aliased=1),
552
self.stream.write('\n')
554
def report_test_start(self, test):
555
"""Display information on the test just about to be run"""
557
def _report_thread_leak(self, test, leaked_threads, active_threads):
558
"""Display information on a test that leaked one or more threads"""
559
# GZ 2010-09-09: A leak summary reported separately from the general
560
# thread debugging would be nice. Tests under subunit
561
# need something not using stream, perhaps adding a
562
# testtools details object would be fitting.
563
if 'threads' in selftest_debug_flags:
564
self.stream.write('%s is leaking, active is now %d\n' %
565
(test.id(), len(active_threads)))
567
def startTestRun(self):
568
self.startTime = time.time()
570
def report_success(self, test):
573
def wasStrictlySuccessful(self):
574
if self.unsupported or self.known_failure_count:
576
return self.wasSuccessful()
579
class TextTestResult(ExtendedTestResult):
580
"""Displays progress and results of tests in text form"""
582
def __init__(self, stream, descriptions, verbosity,
587
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
588
bench_history, strict)
589
# We no longer pass them around, but just rely on the UIFactory stack
592
warnings.warn("Passing pb to TextTestResult is deprecated")
593
self.pb = self.ui.nested_progress_bar()
594
self.pb.show_pct = False
595
self.pb.show_spinner = False
596
self.pb.show_eta = False,
597
self.pb.show_count = False
598
self.pb.show_bar = False
599
self.pb.update_latency = 0
600
self.pb.show_transport_activity = False
602
def stopTestRun(self):
603
# called when the tests that are going to run have run
606
super(TextTestResult, self).stopTestRun()
608
def report_tests_starting(self):
609
super(TextTestResult, self).report_tests_starting()
610
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
612
def _progress_prefix_text(self):
613
# the longer this text, the less space we have to show the test
615
a = '[%d' % self.count # total that have been run
616
# tests skipped as known not to be relevant are not important enough
618
## if self.skip_count:
619
## a += ', %d skip' % self.skip_count
620
## if self.known_failure_count:
621
## a += '+%dX' % self.known_failure_count
623
a +='/%d' % self.num_tests
625
runtime = time.time() - self._overall_start_time
627
a += '%dm%ds' % (runtime / 60, runtime % 60)
630
total_fail_count = self.error_count + self.failure_count
632
a += ', %d failed' % total_fail_count
633
# if self.unsupported:
634
# a += ', %d missing' % len(self.unsupported)
638
def report_test_start(self, test):
640
self._progress_prefix_text()
642
+ self._shortened_test_description(test))
644
def _test_description(self, test):
645
return self._shortened_test_description(test)
647
def report_error(self, test, err):
648
self.stream.write('ERROR: %s\n %s\n' % (
649
self._test_description(test),
653
def report_failure(self, test, err):
654
self.stream.write('FAIL: %s\n %s\n' % (
655
self._test_description(test),
659
def report_known_failure(self, test, err):
662
def report_unexpected_success(self, test, reason):
663
self.stream.write('FAIL: %s\n %s: %s\n' % (
664
self._test_description(test),
665
"Unexpected success. Should have failed",
669
def report_skip(self, test, reason):
672
def report_not_applicable(self, test, reason):
675
def report_unsupported(self, test, feature):
676
"""test cannot be run because feature is missing."""
679
class VerboseTestResult(ExtendedTestResult):
680
"""Produce long output, with one line per test run plus times"""
682
def _ellipsize_to_right(self, a_string, final_width):
683
"""Truncate and pad a string, keeping the right hand side"""
684
if len(a_string) > final_width:
685
result = '...' + a_string[3-final_width:]
688
return result.ljust(final_width)
690
def report_tests_starting(self):
691
self.stream.write('running %d tests...\n' % self.num_tests)
692
super(VerboseTestResult, self).report_tests_starting()
694
def report_test_start(self, test):
695
name = self._shortened_test_description(test)
696
width = osutils.terminal_width()
697
if width is not None:
698
# width needs space for 6 char status, plus 1 for slash, plus an
699
# 11-char time string, plus a trailing blank
700
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
702
self.stream.write(self._ellipsize_to_right(name, width-18))
704
self.stream.write(name)
707
def _error_summary(self, err):
709
return '%s%s' % (indent, err[1])
711
def report_error(self, test, err):
712
self.stream.write('ERROR %s\n%s\n'
713
% (self._testTimeString(test),
714
self._error_summary(err)))
716
def report_failure(self, test, err):
717
self.stream.write(' FAIL %s\n%s\n'
718
% (self._testTimeString(test),
719
self._error_summary(err)))
721
def report_known_failure(self, test, err):
722
self.stream.write('XFAIL %s\n%s\n'
723
% (self._testTimeString(test),
724
self._error_summary(err)))
726
def report_unexpected_success(self, test, reason):
727
self.stream.write(' FAIL %s\n%s: %s\n'
728
% (self._testTimeString(test),
729
"Unexpected success. Should have failed",
732
def report_success(self, test):
733
self.stream.write(' OK %s\n' % self._testTimeString(test))
734
for bench_called, stats in getattr(test, '_benchcalls', []):
735
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
736
stats.pprint(file=self.stream)
737
# flush the stream so that we get smooth output. This verbose mode is
738
# used to show the output in PQM.
741
def report_skip(self, test, reason):
742
self.stream.write(' SKIP %s\n%s\n'
743
% (self._testTimeString(test), reason))
745
def report_not_applicable(self, test, reason):
746
self.stream.write(' N/A %s\n %s\n'
747
% (self._testTimeString(test), reason))
749
def report_unsupported(self, test, feature):
750
"""test cannot be run because feature is missing."""
751
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
752
%(self._testTimeString(test), feature))
755
class TextTestRunner(object):
756
stop_on_failure = False
764
result_decorators=None,
766
"""Create a TextTestRunner.
768
:param result_decorators: An optional list of decorators to apply
769
to the result object being used by the runner. Decorators are
770
applied left to right - the first element in the list is the
773
# stream may know claim to know to write unicode strings, but in older
774
# pythons this goes sufficiently wrong that it is a bad idea. (
775
# specifically a built in file with encoding 'UTF-8' will still try
776
# to encode using ascii.
777
new_encoding = osutils.get_terminal_encoding()
778
codec = codecs.lookup(new_encoding)
779
if type(codec) is tuple:
783
encode = codec.encode
784
# GZ 2010-09-08: Really we don't want to be writing arbitrary bytes,
785
# so should swap to the plain codecs.StreamWriter
786
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream,
788
stream.encoding = new_encoding
790
self.descriptions = descriptions
791
self.verbosity = verbosity
792
self._bench_history = bench_history
793
self._strict = strict
794
self._result_decorators = result_decorators or []
797
"Run the given test case or test suite."
798
if self.verbosity == 1:
799
result_class = TextTestResult
800
elif self.verbosity >= 2:
801
result_class = VerboseTestResult
802
original_result = result_class(self.stream,
805
bench_history=self._bench_history,
808
# Signal to result objects that look at stop early policy to stop,
809
original_result.stop_early = self.stop_on_failure
810
result = original_result
811
for decorator in self._result_decorators:
812
result = decorator(result)
813
result.stop_early = self.stop_on_failure
814
result.startTestRun()
819
# higher level code uses our extended protocol to determine
820
# what exit code to give.
821
return original_result
824
def iter_suite_tests(suite):
825
"""Return all tests in a suite, recursing through nested suites"""
826
if isinstance(suite, unittest.TestCase):
828
elif isinstance(suite, unittest.TestSuite):
830
for r in iter_suite_tests(item):
833
raise Exception('unknown type %r for object %r'
834
% (type(suite), suite))
837
TestSkipped = testtools.testcase.TestSkipped
840
class TestNotApplicable(TestSkipped):
841
"""A test is not applicable to the situation where it was run.
843
This is only normally raised by parameterized tests, if they find that
844
the instance they're constructed upon does not support one aspect
849
# traceback._some_str fails to format exceptions that have the default
850
# __str__ which does an implicit ascii conversion. However, repr() on those
851
# objects works, for all that its not quite what the doctor may have ordered.
852
def _clever_some_str(value):
857
return repr(value).replace('\\n', '\n')
859
return '<unprintable %s object>' % type(value).__name__
861
traceback._some_str = _clever_some_str
864
# deprecated - use self.knownFailure(), or self.expectFailure.
865
KnownFailure = testtools.testcase._ExpectedFailure
868
class UnavailableFeature(Exception):
869
"""A feature required for this test was not available.
871
This can be considered a specialised form of SkippedTest.
873
The feature should be used to construct the exception.
877
class StringIOWrapper(object):
878
"""A wrapper around cStringIO which just adds an encoding attribute.
880
Internally we can check sys.stdout to see what the output encoding
881
should be. However, cStringIO has no encoding attribute that we can
882
set. So we wrap it instead.
887
def __init__(self, s=None):
889
self.__dict__['_cstring'] = StringIO(s)
891
self.__dict__['_cstring'] = StringIO()
893
def __getattr__(self, name, getattr=getattr):
894
return getattr(self.__dict__['_cstring'], name)
896
def __setattr__(self, name, val):
897
if name == 'encoding':
898
self.__dict__['encoding'] = val
900
return setattr(self._cstring, name, val)
903
class TestUIFactory(TextUIFactory):
904
"""A UI Factory for testing.
906
Hide the progress bar but emit note()s.
908
Allows get_password to be tested without real tty attached.
910
See also CannedInputUIFactory which lets you provide programmatic input in
913
# TODO: Capture progress events at the model level and allow them to be
914
# observed by tests that care.
916
# XXX: Should probably unify more with CannedInputUIFactory or a
917
# particular configuration of TextUIFactory, or otherwise have a clearer
918
# idea of how they're supposed to be different.
919
# See https://bugs.launchpad.net/bzr/+bug/408213
921
def __init__(self, stdout=None, stderr=None, stdin=None):
922
if stdin is not None:
923
# We use a StringIOWrapper to be able to test various
924
# encodings, but the user is still responsible to
925
# encode the string and to set the encoding attribute
926
# of StringIOWrapper.
927
stdin = StringIOWrapper(stdin)
928
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
930
def get_non_echoed_password(self):
931
"""Get password from stdin without trying to handle the echo mode"""
932
password = self.stdin.readline()
935
if password[-1] == '\n':
936
password = password[:-1]
939
def make_progress_view(self):
940
return NullProgressView()
943
def isolated_doctest_setUp(test):
944
override_os_environ(test)
947
def isolated_doctest_tearDown(test):
948
restore_os_environ(test)
951
def IsolatedDocTestSuite(*args, **kwargs):
952
"""Overrides doctest.DocTestSuite to handle isolation.
954
The method is really a factory and users are expected to use it as such.
957
kwargs['setUp'] = isolated_doctest_setUp
958
kwargs['tearDown'] = isolated_doctest_tearDown
959
return doctest.DocTestSuite(*args, **kwargs)
962
class TestCase(testtools.TestCase):
963
"""Base class for bzr unit tests.
965
Tests that need access to disk resources should subclass
966
TestCaseInTempDir not TestCase.
968
Error and debug log messages are redirected from their usual
969
location into a temporary file, the contents of which can be
970
retrieved by _get_log(). We use a real OS file, not an in-memory object,
971
so that it can also capture file IO. When the test completes this file
972
is read into memory and removed from disk.
974
There are also convenience functions to invoke bzr's command-line
975
routine, and to build and check bzr trees.
977
In addition to the usual method of overriding tearDown(), this class also
978
allows subclasses to register cleanup functions via addCleanup, which are
979
run in order as the object is torn down. It's less likely this will be
980
accidentally overlooked.
984
# record lsprof data when performing benchmark calls.
985
_gather_lsprof_in_benchmarks = False
987
def __init__(self, methodName='testMethod'):
988
super(TestCase, self).__init__(methodName)
989
self._directory_isolation = True
990
self.exception_handlers.insert(0,
991
(UnavailableFeature, self._do_unsupported_or_skip))
992
self.exception_handlers.insert(0,
993
(TestNotApplicable, self._do_not_applicable))
996
super(TestCase, self).setUp()
997
for feature in getattr(self, '_test_needs_features', []):
998
self.requireFeature(feature)
999
self._cleanEnvironment()
1000
if bzrlib.global_state is not None:
1001
self.overrideAttr(bzrlib.global_state, 'cmdline_overrides',
1002
config.CommandLineSection())
1004
self._startLogFile()
1005
self._benchcalls = []
1006
self._benchtime = None
1008
self._track_transports()
1010
self._clear_debug_flags()
1011
# Isolate global verbosity level, to make sure it's reproducible
1012
# between tests. We should get rid of this altogether: bug 656694. --
1014
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
1015
# Isolate config option expansion until its default value for bzrlib is
1016
# settled on or a the FIXME associated with _get_expand_default_value
1017
# is addressed -- vila 20110219
1018
self.overrideAttr(config, '_expand_default_value', None)
1019
self._log_files = set()
1020
# Each key in the ``_counters`` dict holds a value for a different
1021
# counter. When the test ends, addDetail() should be used to output the
1022
# counter values. This happens in install_counter_hook().
1024
if 'config_stats' in selftest_debug_flags:
1025
self._install_config_stats_hooks()
1026
# Do not use i18n for tests (unless the test reverses this)
1032
# The sys preserved stdin/stdout should allow blackbox tests debugging
1033
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
1034
).set_trace(sys._getframe().f_back)
1036
def discardDetail(self, name):
1037
"""Extend the addDetail, getDetails api so we can remove a detail.
1039
eg. bzr always adds the 'log' detail at startup, but we don't want to
1040
include it for skipped, xfail, etc tests.
1042
It is safe to call this for a detail that doesn't exist, in case this
1043
gets called multiple times.
1045
# We cheat. details is stored in __details which means we shouldn't
1046
# touch it. but getDetails() returns the dict directly, so we can
1048
details = self.getDetails()
1052
def install_counter_hook(self, hooks, name, counter_name=None):
1053
"""Install a counting hook.
1055
Any hook can be counted as long as it doesn't need to return a value.
1057
:param hooks: Where the hook should be installed.
1059
:param name: The hook name that will be counted.
1061
:param counter_name: The counter identifier in ``_counters``, defaults
1064
_counters = self._counters # Avoid closing over self
1065
if counter_name is None:
1067
if _counters.has_key(counter_name):
1068
raise AssertionError('%s is already used as a counter name'
1070
_counters[counter_name] = 0
1071
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1072
lambda: ['%d' % (_counters[counter_name],)]))
1073
def increment_counter(*args, **kwargs):
1074
_counters[counter_name] += 1
1075
label = 'count %s calls' % (counter_name,)
1076
hooks.install_named_hook(name, increment_counter, label)
1077
self.addCleanup(hooks.uninstall_named_hook, name, label)
1079
def _install_config_stats_hooks(self):
1080
"""Install config hooks to count hook calls.
1083
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1084
self.install_counter_hook(config.ConfigHooks, hook_name,
1085
'config.%s' % (hook_name,))
1087
# The OldConfigHooks are private and need special handling to protect
1088
# against recursive tests (tests that run other tests), so we just do
1089
# manually what registering them into _builtin_known_hooks will provide
1091
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1092
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1093
self.install_counter_hook(config.OldConfigHooks, hook_name,
1094
'old_config.%s' % (hook_name,))
1096
def _clear_debug_flags(self):
1097
"""Prevent externally set debug flags affecting tests.
1099
Tests that want to use debug flags can just set them in the
1100
debug_flags set during setup/teardown.
1102
# Start with a copy of the current debug flags we can safely modify.
1103
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1104
if 'allow_debug' not in selftest_debug_flags:
1105
debug.debug_flags.clear()
1106
if 'disable_lock_checks' not in selftest_debug_flags:
1107
debug.debug_flags.add('strict_locks')
1109
def _clear_hooks(self):
1110
# prevent hooks affecting tests
1111
known_hooks = hooks.known_hooks
1112
self._preserved_hooks = {}
1113
for key, (parent, name) in known_hooks.iter_parent_objects():
1114
current_hooks = getattr(parent, name)
1115
self._preserved_hooks[parent] = (name, current_hooks)
1116
self._preserved_lazy_hooks = hooks._lazy_hooks
1117
hooks._lazy_hooks = {}
1118
self.addCleanup(self._restoreHooks)
1119
for key, (parent, name) in known_hooks.iter_parent_objects():
1120
factory = known_hooks.get(key)
1121
setattr(parent, name, factory())
1122
# this hook should always be installed
1123
request._install_hook()
1125
def disable_directory_isolation(self):
1126
"""Turn off directory isolation checks."""
1127
self._directory_isolation = False
1129
def enable_directory_isolation(self):
1130
"""Enable directory isolation checks."""
1131
self._directory_isolation = True
1133
def _silenceUI(self):
1134
"""Turn off UI for duration of test"""
1135
# by default the UI is off; tests can turn it on if they want it.
1136
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1138
def _check_locks(self):
1139
"""Check that all lock take/release actions have been paired."""
1140
# We always check for mismatched locks. If a mismatch is found, we
1141
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1142
# case we just print a warning.
1144
acquired_locks = [lock for action, lock in self._lock_actions
1145
if action == 'acquired']
1146
released_locks = [lock for action, lock in self._lock_actions
1147
if action == 'released']
1148
broken_locks = [lock for action, lock in self._lock_actions
1149
if action == 'broken']
1150
# trivially, given the tests for lock acquistion and release, if we
1151
# have as many in each list, it should be ok. Some lock tests also
1152
# break some locks on purpose and should be taken into account by
1153
# considering that breaking a lock is just a dirty way of releasing it.
1154
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1156
'Different number of acquired and '
1157
'released or broken locks.\n'
1161
(acquired_locks, released_locks, broken_locks))
1162
if not self._lock_check_thorough:
1163
# Rather than fail, just warn
1164
print "Broken test %s: %s" % (self, message)
1168
def _track_locks(self):
1169
"""Track lock activity during tests."""
1170
self._lock_actions = []
1171
if 'disable_lock_checks' in selftest_debug_flags:
1172
self._lock_check_thorough = False
1174
self._lock_check_thorough = True
1176
self.addCleanup(self._check_locks)
1177
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1178
self._lock_acquired, None)
1179
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1180
self._lock_released, None)
1181
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1182
self._lock_broken, None)
1184
def _lock_acquired(self, result):
1185
self._lock_actions.append(('acquired', result))
1187
def _lock_released(self, result):
1188
self._lock_actions.append(('released', result))
1190
def _lock_broken(self, result):
1191
self._lock_actions.append(('broken', result))
1193
def permit_dir(self, name):
1194
"""Permit a directory to be used by this test. See permit_url."""
1195
name_transport = _mod_transport.get_transport_from_path(name)
1196
self.permit_url(name)
1197
self.permit_url(name_transport.base)
1199
def permit_url(self, url):
1200
"""Declare that url is an ok url to use in this test.
1202
Do this for memory transports, temporary test directory etc.
1204
Do not do this for the current working directory, /tmp, or any other
1205
preexisting non isolated url.
1207
if not url.endswith('/'):
1209
self._bzr_selftest_roots.append(url)
1211
def permit_source_tree_branch_repo(self):
1212
"""Permit the source tree bzr is running from to be opened.
1214
Some code such as bzrlib.version attempts to read from the bzr branch
1215
that bzr is executing from (if any). This method permits that directory
1216
to be used in the test suite.
1218
path = self.get_source_path()
1219
self.record_directory_isolation()
1222
workingtree.WorkingTree.open(path)
1223
except (errors.NotBranchError, errors.NoWorkingTree):
1224
raise TestSkipped('Needs a working tree of bzr sources')
1226
self.enable_directory_isolation()
1228
def _preopen_isolate_transport(self, transport):
1229
"""Check that all transport openings are done in the test work area."""
1230
while isinstance(transport, pathfilter.PathFilteringTransport):
1231
# Unwrap pathfiltered transports
1232
transport = transport.server.backing_transport.clone(
1233
transport._filter('.'))
1234
url = transport.base
1235
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1236
# urls it is given by prepending readonly+. This is appropriate as the
1237
# client shouldn't know that the server is readonly (or not readonly).
1238
# We could register all servers twice, with readonly+ prepending, but
1239
# that makes for a long list; this is about the same but easier to
1241
if url.startswith('readonly+'):
1242
url = url[len('readonly+'):]
1243
self._preopen_isolate_url(url)
1245
def _preopen_isolate_url(self, url):
1246
if not self._directory_isolation:
1248
if self._directory_isolation == 'record':
1249
self._bzr_selftest_roots.append(url)
1251
# This prevents all transports, including e.g. sftp ones backed on disk
1252
# from working unless they are explicitly granted permission. We then
1253
# depend on the code that sets up test transports to check that they are
1254
# appropriately isolated and enable their use by calling
1255
# self.permit_transport()
1256
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1257
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1258
% (url, self._bzr_selftest_roots))
1260
def record_directory_isolation(self):
1261
"""Gather accessed directories to permit later access.
1263
This is used for tests that access the branch bzr is running from.
1265
self._directory_isolation = "record"
1267
def start_server(self, transport_server, backing_server=None):
1268
"""Start transport_server for this test.
1270
This starts the server, registers a cleanup for it and permits the
1271
server's urls to be used.
1273
if backing_server is None:
1274
transport_server.start_server()
1276
transport_server.start_server(backing_server)
1277
self.addCleanup(transport_server.stop_server)
1278
# Obtain a real transport because if the server supplies a password, it
1279
# will be hidden from the base on the client side.
1280
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1281
# Some transport servers effectively chroot the backing transport;
1282
# others like SFTPServer don't - users of the transport can walk up the
1283
# transport to read the entire backing transport. This wouldn't matter
1284
# except that the workdir tests are given - and that they expect the
1285
# server's url to point at - is one directory under the safety net. So
1286
# Branch operations into the transport will attempt to walk up one
1287
# directory. Chrooting all servers would avoid this but also mean that
1288
# we wouldn't be testing directly against non-root urls. Alternatively
1289
# getting the test framework to start the server with a backing server
1290
# at the actual safety net directory would work too, but this then
1291
# means that the self.get_url/self.get_transport methods would need
1292
# to transform all their results. On balance its cleaner to handle it
1293
# here, and permit a higher url when we have one of these transports.
1294
if t.base.endswith('/work/'):
1295
# we have safety net/test root/work
1296
t = t.clone('../..')
1297
elif isinstance(transport_server,
1298
test_server.SmartTCPServer_for_testing):
1299
# The smart server adds a path similar to work, which is traversed
1300
# up from by the client. But the server is chrooted - the actual
1301
# backing transport is not escaped from, and VFS requests to the
1302
# root will error (because they try to escape the chroot).
1304
while t2.base != t.base:
1307
self.permit_url(t.base)
1309
def _track_transports(self):
1310
"""Install checks for transport usage."""
1311
# TestCase has no safe place it can write to.
1312
self._bzr_selftest_roots = []
1313
# Currently the easiest way to be sure that nothing is going on is to
1314
# hook into bzr dir opening. This leaves a small window of error for
1315
# transport tests, but they are well known, and we can improve on this
1317
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1318
self._preopen_isolate_transport, "Check bzr directories are safe.")
1320
def _ndiff_strings(self, a, b):
1321
"""Return ndiff between two strings containing lines.
1323
A trailing newline is added if missing to make the strings
1325
if b and b[-1] != '\n':
1327
if a and a[-1] != '\n':
1329
difflines = difflib.ndiff(a.splitlines(True),
1331
linejunk=lambda x: False,
1332
charjunk=lambda x: False)
1333
return ''.join(difflines)
1335
def assertEqual(self, a, b, message=''):
1339
except UnicodeError, e:
1340
# If we can't compare without getting a UnicodeError, then
1341
# obviously they are different
1342
trace.mutter('UnicodeError: %s', e)
1345
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1347
pprint.pformat(a), pprint.pformat(b)))
1349
assertEquals = assertEqual
1351
def assertEqualDiff(self, a, b, message=None):
1352
"""Assert two texts are equal, if not raise an exception.
1354
This is intended for use with multi-line strings where it can
1355
be hard to find the differences by eye.
1357
# TODO: perhaps override assertEquals to call this for strings?
1361
message = "texts not equal:\n"
1363
message = 'first string is missing a final newline.\n'
1365
message = 'second string is missing a final newline.\n'
1366
raise AssertionError(message +
1367
self._ndiff_strings(a, b))
1369
def assertEqualMode(self, mode, mode_test):
1370
self.assertEqual(mode, mode_test,
1371
'mode mismatch %o != %o' % (mode, mode_test))
1373
def assertEqualStat(self, expected, actual):
1374
"""assert that expected and actual are the same stat result.
1376
:param expected: A stat result.
1377
:param actual: A stat result.
1378
:raises AssertionError: If the expected and actual stat values differ
1379
other than by atime.
1381
self.assertEqual(expected.st_size, actual.st_size,
1382
'st_size did not match')
1383
self.assertEqual(expected.st_mtime, actual.st_mtime,
1384
'st_mtime did not match')
1385
self.assertEqual(expected.st_ctime, actual.st_ctime,
1386
'st_ctime did not match')
1387
if sys.platform == 'win32':
1388
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1389
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1390
# odd. We just force it to always be 0 to avoid any problems.
1391
self.assertEqual(0, expected.st_dev)
1392
self.assertEqual(0, actual.st_dev)
1393
self.assertEqual(0, expected.st_ino)
1394
self.assertEqual(0, actual.st_ino)
1396
self.assertEqual(expected.st_dev, actual.st_dev,
1397
'st_dev did not match')
1398
self.assertEqual(expected.st_ino, actual.st_ino,
1399
'st_ino did not match')
1400
self.assertEqual(expected.st_mode, actual.st_mode,
1401
'st_mode did not match')
1403
def assertLength(self, length, obj_with_len):
1404
"""Assert that obj_with_len is of length length."""
1405
if len(obj_with_len) != length:
1406
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1407
length, len(obj_with_len), obj_with_len))
1409
def assertLogsError(self, exception_class, func, *args, **kwargs):
1410
"""Assert that `func(*args, **kwargs)` quietly logs a specific error.
1413
orig_log_exception_quietly = trace.log_exception_quietly
1416
orig_log_exception_quietly()
1417
captured.append(sys.exc_info()[1])
1418
trace.log_exception_quietly = capture
1419
func(*args, **kwargs)
1421
trace.log_exception_quietly = orig_log_exception_quietly
1422
self.assertLength(1, captured)
1424
self.assertIsInstance(err, exception_class)
1427
def assertPositive(self, val):
1428
"""Assert that val is greater than 0."""
1429
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1431
def assertNegative(self, val):
1432
"""Assert that val is less than 0."""
1433
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1435
def assertStartsWith(self, s, prefix):
1436
if not s.startswith(prefix):
1437
raise AssertionError('string %r does not start with %r' % (s, prefix))
1439
def assertEndsWith(self, s, suffix):
1440
"""Asserts that s ends with suffix."""
1441
if not s.endswith(suffix):
1442
raise AssertionError('string %r does not end with %r' % (s, suffix))
1444
def assertContainsRe(self, haystack, needle_re, flags=0):
1445
"""Assert that a contains something matching a regular expression."""
1446
if not re.search(needle_re, haystack, flags):
1447
if '\n' in haystack or len(haystack) > 60:
1448
# a long string, format it in a more readable way
1449
raise AssertionError(
1450
'pattern "%s" not found in\n"""\\\n%s"""\n'
1451
% (needle_re, haystack))
1453
raise AssertionError('pattern "%s" not found in "%s"'
1454
% (needle_re, haystack))
1456
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1457
"""Assert that a does not match a regular expression"""
1458
if re.search(needle_re, haystack, flags):
1459
raise AssertionError('pattern "%s" found in "%s"'
1460
% (needle_re, haystack))
1462
def assertContainsString(self, haystack, needle):
1463
if haystack.find(needle) == -1:
1464
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1466
def assertNotContainsString(self, haystack, needle):
1467
if haystack.find(needle) != -1:
1468
self.fail("string %r found in '''%s'''" % (needle, haystack))
1470
def assertSubset(self, sublist, superlist):
1471
"""Assert that every entry in sublist is present in superlist."""
1472
missing = set(sublist) - set(superlist)
1473
if len(missing) > 0:
1474
raise AssertionError("value(s) %r not present in container %r" %
1475
(missing, superlist))
1477
def assertListRaises(self, excClass, func, *args, **kwargs):
1478
"""Fail unless excClass is raised when the iterator from func is used.
1480
Many functions can return generators this makes sure
1481
to wrap them in a list() call to make sure the whole generator
1482
is run, and that the proper exception is raised.
1485
list(func(*args, **kwargs))
1489
if getattr(excClass,'__name__', None) is not None:
1490
excName = excClass.__name__
1492
excName = str(excClass)
1493
raise self.failureException, "%s not raised" % excName
1495
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1496
"""Assert that a callable raises a particular exception.
1498
:param excClass: As for the except statement, this may be either an
1499
exception class, or a tuple of classes.
1500
:param callableObj: A callable, will be passed ``*args`` and
1503
Returns the exception so that you can examine it.
1506
callableObj(*args, **kwargs)
1510
if getattr(excClass,'__name__', None) is not None:
1511
excName = excClass.__name__
1514
excName = str(excClass)
1515
raise self.failureException, "%s not raised" % excName
1517
def assertIs(self, left, right, message=None):
1518
if not (left is right):
1519
if message is not None:
1520
raise AssertionError(message)
1522
raise AssertionError("%r is not %r." % (left, right))
1524
def assertIsNot(self, left, right, message=None):
1526
if message is not None:
1527
raise AssertionError(message)
1529
raise AssertionError("%r is %r." % (left, right))
1531
def assertTransportMode(self, transport, path, mode):
1532
"""Fail if a path does not have mode "mode".
1534
If modes are not supported on this transport, the assertion is ignored.
1536
if not transport._can_roundtrip_unix_modebits():
1538
path_stat = transport.stat(path)
1539
actual_mode = stat.S_IMODE(path_stat.st_mode)
1540
self.assertEqual(mode, actual_mode,
1541
'mode of %r incorrect (%s != %s)'
1542
% (path, oct(mode), oct(actual_mode)))
1544
def assertIsSameRealPath(self, path1, path2):
1545
"""Fail if path1 and path2 points to different files"""
1546
self.assertEqual(osutils.realpath(path1),
1547
osutils.realpath(path2),
1548
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1550
def assertIsInstance(self, obj, kls, msg=None):
1551
"""Fail if obj is not an instance of kls
1553
:param msg: Supplementary message to show if the assertion fails.
1555
if not isinstance(obj, kls):
1556
m = "%r is an instance of %s rather than %s" % (
1557
obj, obj.__class__, kls)
1562
def assertFileEqual(self, content, path):
1563
"""Fail if path does not contain 'content'."""
1564
self.assertPathExists(path)
1565
f = file(path, 'rb')
1570
self.assertEqualDiff(content, s)
1572
def assertDocstring(self, expected_docstring, obj):
1573
"""Fail if obj does not have expected_docstring"""
1575
# With -OO the docstring should be None instead
1576
self.assertIs(obj.__doc__, None)
1578
self.assertEqual(expected_docstring, obj.__doc__)
1580
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1581
def failUnlessExists(self, path):
1582
return self.assertPathExists(path)
1584
def assertPathExists(self, path):
1585
"""Fail unless path or paths, which may be abs or relative, exist."""
1586
if not isinstance(path, basestring):
1588
self.assertPathExists(p)
1590
self.assertTrue(osutils.lexists(path),
1591
path + " does not exist")
1593
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1594
def failIfExists(self, path):
1595
return self.assertPathDoesNotExist(path)
1597
def assertPathDoesNotExist(self, path):
1598
"""Fail if path or paths, which may be abs or relative, exist."""
1599
if not isinstance(path, basestring):
1601
self.assertPathDoesNotExist(p)
1603
self.assertFalse(osutils.lexists(path),
1606
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1607
"""A helper for callDeprecated and applyDeprecated.
1609
:param a_callable: A callable to call.
1610
:param args: The positional arguments for the callable
1611
:param kwargs: The keyword arguments for the callable
1612
:return: A tuple (warnings, result). result is the result of calling
1613
a_callable(``*args``, ``**kwargs``).
1616
def capture_warnings(msg, cls=None, stacklevel=None):
1617
# we've hooked into a deprecation specific callpath,
1618
# only deprecations should getting sent via it.
1619
self.assertEqual(cls, DeprecationWarning)
1620
local_warnings.append(msg)
1621
original_warning_method = symbol_versioning.warn
1622
symbol_versioning.set_warning_method(capture_warnings)
1624
result = a_callable(*args, **kwargs)
1626
symbol_versioning.set_warning_method(original_warning_method)
1627
return (local_warnings, result)
1629
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1630
"""Call a deprecated callable without warning the user.
1632
Note that this only captures warnings raised by symbol_versioning.warn,
1633
not other callers that go direct to the warning module.
1635
To test that a deprecated method raises an error, do something like
1636
this (remember that both assertRaises and applyDeprecated delays *args
1637
and **kwargs passing)::
1639
self.assertRaises(errors.ReservedId,
1640
self.applyDeprecated,
1641
deprecated_in((1, 5, 0)),
1645
:param deprecation_format: The deprecation format that the callable
1646
should have been deprecated with. This is the same type as the
1647
parameter to deprecated_method/deprecated_function. If the
1648
callable is not deprecated with this format, an assertion error
1650
:param a_callable: A callable to call. This may be a bound method or
1651
a regular function. It will be called with ``*args`` and
1653
:param args: The positional arguments for the callable
1654
:param kwargs: The keyword arguments for the callable
1655
:return: The result of a_callable(``*args``, ``**kwargs``)
1657
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1659
expected_first_warning = symbol_versioning.deprecation_string(
1660
a_callable, deprecation_format)
1661
if len(call_warnings) == 0:
1662
self.fail("No deprecation warning generated by call to %s" %
1664
self.assertEqual(expected_first_warning, call_warnings[0])
1667
def callCatchWarnings(self, fn, *args, **kw):
1668
"""Call a callable that raises python warnings.
1670
The caller's responsible for examining the returned warnings.
1672
If the callable raises an exception, the exception is not
1673
caught and propagates up to the caller. In that case, the list
1674
of warnings is not available.
1676
:returns: ([warning_object, ...], fn_result)
1678
# XXX: This is not perfect, because it completely overrides the
1679
# warnings filters, and some code may depend on suppressing particular
1680
# warnings. It's the easiest way to insulate ourselves from -Werror,
1681
# though. -- Andrew, 20071062
1683
def _catcher(message, category, filename, lineno, file=None, line=None):
1684
# despite the name, 'message' is normally(?) a Warning subclass
1686
wlist.append(message)
1687
saved_showwarning = warnings.showwarning
1688
saved_filters = warnings.filters
1690
warnings.showwarning = _catcher
1691
warnings.filters = []
1692
result = fn(*args, **kw)
1694
warnings.showwarning = saved_showwarning
1695
warnings.filters = saved_filters
1696
return wlist, result
1698
def callDeprecated(self, expected, callable, *args, **kwargs):
1699
"""Assert that a callable is deprecated in a particular way.
1701
This is a very precise test for unusual requirements. The
1702
applyDeprecated helper function is probably more suited for most tests
1703
as it allows you to simply specify the deprecation format being used
1704
and will ensure that that is issued for the function being called.
1706
Note that this only captures warnings raised by symbol_versioning.warn,
1707
not other callers that go direct to the warning module. To catch
1708
general warnings, use callCatchWarnings.
1710
:param expected: a list of the deprecation warnings expected, in order
1711
:param callable: The callable to call
1712
:param args: The positional arguments for the callable
1713
:param kwargs: The keyword arguments for the callable
1715
call_warnings, result = self._capture_deprecation_warnings(callable,
1717
self.assertEqual(expected, call_warnings)
1720
def _startLogFile(self):
1721
"""Setup a in-memory target for bzr and testcase log messages"""
1722
pseudo_log_file = StringIO()
1723
def _get_log_contents_for_weird_testtools_api():
1724
return [pseudo_log_file.getvalue().decode(
1725
"utf-8", "replace").encode("utf-8")]
1726
self.addDetail("log", content.Content(content.ContentType("text",
1727
"plain", {"charset": "utf8"}),
1728
_get_log_contents_for_weird_testtools_api))
1729
self._log_file = pseudo_log_file
1730
self._log_memento = trace.push_log_file(self._log_file)
1731
self.addCleanup(self._finishLogFile)
1733
def _finishLogFile(self):
1734
"""Flush and dereference the in-memory log for this testcase"""
1735
if trace._trace_file:
1736
# flush the log file, to get all content
1737
trace._trace_file.flush()
1738
trace.pop_log_file(self._log_memento)
1739
# The logging module now tracks references for cleanup so discard ours
1740
del self._log_memento
1742
def thisFailsStrictLockCheck(self):
1743
"""It is known that this test would fail with -Dstrict_locks.
1745
By default, all tests are run with strict lock checking unless
1746
-Edisable_lock_checks is supplied. However there are some tests which
1747
we know fail strict locks at this point that have not been fixed.
1748
They should call this function to disable the strict checking.
1750
This should be used sparingly, it is much better to fix the locking
1751
issues rather than papering over the problem by calling this function.
1753
debug.debug_flags.discard('strict_locks')
1755
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1756
"""Overrides an object attribute restoring it after the test.
1758
:note: This should be used with discretion; you should think about
1759
whether it's better to make the code testable without monkey-patching.
1761
:param obj: The object that will be mutated.
1763
:param attr_name: The attribute name we want to preserve/override in
1766
:param new: The optional value we want to set the attribute to.
1768
:returns: The actual attr value.
1770
value = getattr(obj, attr_name)
1771
# The actual value is captured by the call below
1772
self.addCleanup(setattr, obj, attr_name, value)
1773
if new is not _unitialized_attr:
1774
setattr(obj, attr_name, new)
1777
def overrideEnv(self, name, new):
1778
"""Set an environment variable, and reset it after the test.
1780
:param name: The environment variable name.
1782
:param new: The value to set the variable to. If None, the
1783
variable is deleted from the environment.
1785
:returns: The actual variable value.
1787
value = osutils.set_or_unset_env(name, new)
1788
self.addCleanup(osutils.set_or_unset_env, name, value)
1791
def recordCalls(self, obj, attr_name):
1792
"""Monkeypatch in a wrapper that will record calls.
1794
The monkeypatch is automatically removed when the test concludes.
1796
:param obj: The namespace holding the reference to be replaced;
1797
typically a module, class, or object.
1798
:param attr_name: A string for the name of the attribute to
1800
:returns: A list that will be extended with one item every time the
1801
function is called, with a tuple of (args, kwargs).
1805
def decorator(*args, **kwargs):
1806
calls.append((args, kwargs))
1807
return orig(*args, **kwargs)
1808
orig = self.overrideAttr(obj, attr_name, decorator)
1811
def _cleanEnvironment(self):
1812
for name, value in isolated_environ.iteritems():
1813
self.overrideEnv(name, value)
1815
def _restoreHooks(self):
1816
for klass, (name, hooks) in self._preserved_hooks.items():
1817
setattr(klass, name, hooks)
1818
self._preserved_hooks.clear()
1819
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1820
self._preserved_lazy_hooks.clear()
1822
def knownFailure(self, reason):
1823
"""Declare that this test fails for a known reason
1825
Tests that are known to fail should generally be using expectedFailure
1826
with an appropriate reverse assertion if a change could cause the test
1827
to start passing. Conversely if the test has no immediate prospect of
1828
succeeding then using skip is more suitable.
1830
When this method is called while an exception is being handled, that
1831
traceback will be used, otherwise a new exception will be thrown to
1832
provide one but won't be reported.
1834
self._add_reason(reason)
1836
exc_info = sys.exc_info()
1837
if exc_info != (None, None, None):
1838
self._report_traceback(exc_info)
1841
raise self.failureException(reason)
1842
except self.failureException:
1843
exc_info = sys.exc_info()
1844
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1845
raise testtools.testcase._ExpectedFailure(exc_info)
1849
def _suppress_log(self):
1850
"""Remove the log info from details."""
1851
self.discardDetail('log')
1853
def _do_skip(self, result, reason):
1854
self._suppress_log()
1855
addSkip = getattr(result, 'addSkip', None)
1856
if not callable(addSkip):
1857
result.addSuccess(result)
1859
addSkip(self, reason)
1862
def _do_known_failure(self, result, e):
1863
self._suppress_log()
1864
err = sys.exc_info()
1865
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1866
if addExpectedFailure is not None:
1867
addExpectedFailure(self, err)
1869
result.addSuccess(self)
1872
def _do_not_applicable(self, result, e):
1874
reason = 'No reason given'
1877
self._suppress_log ()
1878
addNotApplicable = getattr(result, 'addNotApplicable', None)
1879
if addNotApplicable is not None:
1880
result.addNotApplicable(self, reason)
1882
self._do_skip(result, reason)
1885
def _report_skip(self, result, err):
1886
"""Override the default _report_skip.
1888
We want to strip the 'log' detail. If we waint until _do_skip, it has
1889
already been formatted into the 'reason' string, and we can't pull it
1892
self._suppress_log()
1893
super(TestCase, self)._report_skip(self, result, err)
1896
def _report_expected_failure(self, result, err):
1899
See _report_skip for motivation.
1901
self._suppress_log()
1902
super(TestCase, self)._report_expected_failure(self, result, err)
1905
def _do_unsupported_or_skip(self, result, e):
1907
self._suppress_log()
1908
addNotSupported = getattr(result, 'addNotSupported', None)
1909
if addNotSupported is not None:
1910
result.addNotSupported(self, reason)
1912
self._do_skip(result, reason)
1914
def time(self, callable, *args, **kwargs):
1915
"""Run callable and accrue the time it takes to the benchmark time.
1917
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1918
this will cause lsprofile statistics to be gathered and stored in
1921
if self._benchtime is None:
1922
self.addDetail('benchtime', content.Content(content.ContentType(
1923
"text", "plain"), lambda:[str(self._benchtime)]))
1927
if not self._gather_lsprof_in_benchmarks:
1928
return callable(*args, **kwargs)
1930
# record this benchmark
1931
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1933
self._benchcalls.append(((callable, args, kwargs), stats))
1936
self._benchtime += time.time() - start
1938
def log(self, *args):
1942
"""Get a unicode string containing the log from bzrlib.trace.
1944
Undecodable characters are replaced.
1946
return u"".join(self.getDetails()['log'].iter_text())
1948
def requireFeature(self, feature):
1949
"""This test requires a specific feature is available.
1951
:raises UnavailableFeature: When feature is not available.
1953
if not feature.available():
1954
raise UnavailableFeature(feature)
1956
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1958
"""Run bazaar command line, splitting up a string command line."""
1959
if isinstance(args, basestring):
1960
# shlex don't understand unicode strings,
1961
# so args should be plain string (bialix 20070906)
1962
args = list(shlex.split(str(args)))
1963
return self._run_bzr_core(args, retcode=retcode,
1964
encoding=encoding, stdin=stdin, working_dir=working_dir,
1967
def _run_bzr_core(self, args, retcode, encoding, stdin,
1969
# Clear chk_map page cache, because the contents are likely to mask
1971
chk_map.clear_cache()
1972
if encoding is None:
1973
encoding = osutils.get_user_encoding()
1974
stdout = StringIOWrapper()
1975
stderr = StringIOWrapper()
1976
stdout.encoding = encoding
1977
stderr.encoding = encoding
1979
self.log('run bzr: %r', args)
1980
# FIXME: don't call into logging here
1981
handler = logging.StreamHandler(stderr)
1982
handler.setLevel(logging.INFO)
1983
logger = logging.getLogger('')
1984
logger.addHandler(handler)
1985
old_ui_factory = ui.ui_factory
1986
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1989
if working_dir is not None:
1990
cwd = osutils.getcwd()
1991
os.chdir(working_dir)
1995
result = self.apply_redirected(
1996
ui.ui_factory.stdin,
1998
_mod_commands.run_bzr_catch_user_errors,
2000
except KeyboardInterrupt:
2001
# Reraise KeyboardInterrupt with contents of redirected stdout
2002
# and stderr as arguments, for tests which are interested in
2003
# stdout and stderr and are expecting the exception.
2004
out = stdout.getvalue()
2005
err = stderr.getvalue()
2007
self.log('output:\n%r', out)
2009
self.log('errors:\n%r', err)
2010
raise KeyboardInterrupt(out, err)
2012
logger.removeHandler(handler)
2013
ui.ui_factory = old_ui_factory
2017
out = stdout.getvalue()
2018
err = stderr.getvalue()
2020
self.log('output:\n%r', out)
2022
self.log('errors:\n%r', err)
2023
if retcode is not None:
2024
self.assertEquals(retcode, result,
2025
message='Unexpected return code')
2026
return result, out, err
2028
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
2029
working_dir=None, error_regexes=[], output_encoding=None):
2030
"""Invoke bzr, as if it were run from the command line.
2032
The argument list should not include the bzr program name - the
2033
first argument is normally the bzr command. Arguments may be
2034
passed in three ways:
2036
1- A list of strings, eg ["commit", "a"]. This is recommended
2037
when the command contains whitespace or metacharacters, or
2038
is built up at run time.
2040
2- A single string, eg "add a". This is the most convenient
2041
for hardcoded commands.
2043
This runs bzr through the interface that catches and reports
2044
errors, and with logging set to something approximating the
2045
default, so that error reporting can be checked.
2047
This should be the main method for tests that want to exercise the
2048
overall behavior of the bzr application (rather than a unit test
2049
or a functional test of the library.)
2051
This sends the stdout/stderr results into the test's log,
2052
where it may be useful for debugging. See also run_captured.
2054
:keyword stdin: A string to be used as stdin for the command.
2055
:keyword retcode: The status code the command should return;
2057
:keyword working_dir: The directory to run the command in
2058
:keyword error_regexes: A list of expected error messages. If
2059
specified they must be seen in the error output of the command.
2061
retcode, out, err = self._run_bzr_autosplit(
2066
working_dir=working_dir,
2068
self.assertIsInstance(error_regexes, (list, tuple))
2069
for regex in error_regexes:
2070
self.assertContainsRe(err, regex)
2073
def run_bzr_error(self, error_regexes, *args, **kwargs):
2074
"""Run bzr, and check that stderr contains the supplied regexes
2076
:param error_regexes: Sequence of regular expressions which
2077
must each be found in the error output. The relative ordering
2079
:param args: command-line arguments for bzr
2080
:param kwargs: Keyword arguments which are interpreted by run_bzr
2081
This function changes the default value of retcode to be 3,
2082
since in most cases this is run when you expect bzr to fail.
2084
:return: (out, err) The actual output of running the command (in case
2085
you want to do more inspection)
2089
# Make sure that commit is failing because there is nothing to do
2090
self.run_bzr_error(['no changes to commit'],
2091
['commit', '-m', 'my commit comment'])
2092
# Make sure --strict is handling an unknown file, rather than
2093
# giving us the 'nothing to do' error
2094
self.build_tree(['unknown'])
2095
self.run_bzr_error(['Commit refused because there are unknown files'],
2096
['commit', --strict', '-m', 'my commit comment'])
2098
kwargs.setdefault('retcode', 3)
2099
kwargs['error_regexes'] = error_regexes
2100
out, err = self.run_bzr(*args, **kwargs)
2103
def run_bzr_subprocess(self, *args, **kwargs):
2104
"""Run bzr in a subprocess for testing.
2106
This starts a new Python interpreter and runs bzr in there.
2107
This should only be used for tests that have a justifiable need for
2108
this isolation: e.g. they are testing startup time, or signal
2109
handling, or early startup code, etc. Subprocess code can't be
2110
profiled or debugged so easily.
2112
:keyword retcode: The status code that is expected. Defaults to 0. If
2113
None is supplied, the status code is not checked.
2114
:keyword env_changes: A dictionary which lists changes to environment
2115
variables. A value of None will unset the env variable.
2116
The values must be strings. The change will only occur in the
2117
child, so you don't need to fix the environment after running.
2118
:keyword universal_newlines: Convert CRLF => LF
2119
:keyword allow_plugins: By default the subprocess is run with
2120
--no-plugins to ensure test reproducibility. Also, it is possible
2121
for system-wide plugins to create unexpected output on stderr,
2122
which can cause unnecessary test failures.
2124
env_changes = kwargs.get('env_changes', {})
2125
working_dir = kwargs.get('working_dir', None)
2126
allow_plugins = kwargs.get('allow_plugins', False)
2128
if isinstance(args[0], list):
2130
elif isinstance(args[0], basestring):
2131
args = list(shlex.split(args[0]))
2133
raise ValueError("passing varargs to run_bzr_subprocess")
2134
process = self.start_bzr_subprocess(args, env_changes=env_changes,
2135
working_dir=working_dir,
2136
allow_plugins=allow_plugins)
2137
# We distinguish between retcode=None and retcode not passed.
2138
supplied_retcode = kwargs.get('retcode', 0)
2139
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
2140
universal_newlines=kwargs.get('universal_newlines', False),
2143
def start_bzr_subprocess(self, process_args, env_changes=None,
2144
skip_if_plan_to_signal=False,
2146
allow_plugins=False, stderr=subprocess.PIPE):
2147
"""Start bzr in a subprocess for testing.
2149
This starts a new Python interpreter and runs bzr in there.
2150
This should only be used for tests that have a justifiable need for
2151
this isolation: e.g. they are testing startup time, or signal
2152
handling, or early startup code, etc. Subprocess code can't be
2153
profiled or debugged so easily.
2155
:param process_args: a list of arguments to pass to the bzr executable,
2156
for example ``['--version']``.
2157
:param env_changes: A dictionary which lists changes to environment
2158
variables. A value of None will unset the env variable.
2159
The values must be strings. The change will only occur in the
2160
child, so you don't need to fix the environment after running.
2161
:param skip_if_plan_to_signal: raise TestSkipped when true and system
2162
doesn't support signalling subprocesses.
2163
:param allow_plugins: If False (default) pass --no-plugins to bzr.
2164
:param stderr: file to use for the subprocess's stderr. Valid values
2165
are those valid for the stderr argument of `subprocess.Popen`.
2166
Default value is ``subprocess.PIPE``.
2168
:returns: Popen object for the started process.
2170
if skip_if_plan_to_signal:
2171
if os.name != "posix":
2172
raise TestSkipped("Sending signals not supported")
2174
if env_changes is None:
2178
def cleanup_environment():
2179
for env_var, value in env_changes.iteritems():
2180
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2182
def restore_environment():
2183
for env_var, value in old_env.iteritems():
2184
osutils.set_or_unset_env(env_var, value)
2186
bzr_path = self.get_bzr_path()
2189
if working_dir is not None:
2190
cwd = osutils.getcwd()
2191
os.chdir(working_dir)
2194
# win32 subprocess doesn't support preexec_fn
2195
# so we will avoid using it on all platforms, just to
2196
# make sure the code path is used, and we don't break on win32
2197
cleanup_environment()
2198
# Include the subprocess's log file in the test details, in case
2199
# the test fails due to an error in the subprocess.
2200
self._add_subprocess_log(trace._get_bzr_log_filename())
2201
command = [sys.executable]
2202
# frozen executables don't need the path to bzr
2203
if getattr(sys, "frozen", None) is None:
2204
command.append(bzr_path)
2205
if not allow_plugins:
2206
command.append('--no-plugins')
2207
command.extend(process_args)
2208
process = self._popen(command, stdin=subprocess.PIPE,
2209
stdout=subprocess.PIPE,
2212
restore_environment()
2218
def _add_subprocess_log(self, log_file_path):
2219
if len(self._log_files) == 0:
2220
# Register an addCleanup func. We do this on the first call to
2221
# _add_subprocess_log rather than in TestCase.setUp so that this
2222
# addCleanup is registered after any cleanups for tempdirs that
2223
# subclasses might create, which will probably remove the log file
2225
self.addCleanup(self._subprocess_log_cleanup)
2226
# self._log_files is a set, so if a log file is reused we won't grab it
2228
self._log_files.add(log_file_path)
2230
def _subprocess_log_cleanup(self):
2231
for count, log_file_path in enumerate(self._log_files):
2232
# We use buffer_now=True to avoid holding the file open beyond
2233
# the life of this function, which might interfere with e.g.
2234
# cleaning tempdirs on Windows.
2235
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
2236
#detail_content = content.content_from_file(
2237
# log_file_path, buffer_now=True)
2238
with open(log_file_path, 'rb') as log_file:
2239
log_file_bytes = log_file.read()
2240
detail_content = content.Content(content.ContentType("text",
2241
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
2242
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
2245
def _popen(self, *args, **kwargs):
2246
"""Place a call to Popen.
2248
Allows tests to override this method to intercept the calls made to
2249
Popen for introspection.
2251
return subprocess.Popen(*args, **kwargs)
2253
def get_source_path(self):
2254
"""Return the path of the directory containing bzrlib."""
2255
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2257
def get_bzr_path(self):
2258
"""Return the path of the 'bzr' executable for this test suite."""
2259
bzr_path = os.path.join(self.get_source_path(), "bzr")
2260
if not os.path.isfile(bzr_path):
2261
# We are probably installed. Assume sys.argv is the right file
2262
bzr_path = sys.argv[0]
2265
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2266
universal_newlines=False, process_args=None):
2267
"""Finish the execution of process.
2269
:param process: the Popen object returned from start_bzr_subprocess.
2270
:param retcode: The status code that is expected. Defaults to 0. If
2271
None is supplied, the status code is not checked.
2272
:param send_signal: an optional signal to send to the process.
2273
:param universal_newlines: Convert CRLF => LF
2274
:returns: (stdout, stderr)
2276
if send_signal is not None:
2277
os.kill(process.pid, send_signal)
2278
out, err = process.communicate()
2280
if universal_newlines:
2281
out = out.replace('\r\n', '\n')
2282
err = err.replace('\r\n', '\n')
2284
if retcode is not None and retcode != process.returncode:
2285
if process_args is None:
2286
process_args = "(unknown args)"
2287
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2288
trace.mutter('Error for bzr %s:\n%s', process_args, err)
2289
self.fail('Command bzr %s failed with retcode %s != %s'
2290
% (process_args, retcode, process.returncode))
2293
def check_tree_shape(self, tree, shape):
2294
"""Compare a tree to a list of expected names.
2296
Fail if they are not precisely equal.
2299
shape = list(shape) # copy
2300
for path, ie in tree.iter_entries_by_dir():
2301
name = path.replace('\\', '/')
2302
if ie.kind == 'directory':
2305
pass # ignore root entry
2311
self.fail("expected paths not found in inventory: %r" % shape)
2313
self.fail("unexpected paths found in inventory: %r" % extras)
2315
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2316
a_callable=None, *args, **kwargs):
2317
"""Call callable with redirected std io pipes.
2319
Returns the return code."""
2320
if not callable(a_callable):
2321
raise ValueError("a_callable must be callable.")
2323
stdin = StringIO("")
2325
if getattr(self, "_log_file", None) is not None:
2326
stdout = self._log_file
2330
if getattr(self, "_log_file", None is not None):
2331
stderr = self._log_file
2334
real_stdin = sys.stdin
2335
real_stdout = sys.stdout
2336
real_stderr = sys.stderr
2341
return a_callable(*args, **kwargs)
2343
sys.stdout = real_stdout
2344
sys.stderr = real_stderr
2345
sys.stdin = real_stdin
2347
def reduceLockdirTimeout(self):
2348
"""Reduce the default lock timeout for the duration of the test, so that
2349
if LockContention occurs during a test, it does so quickly.
2351
Tests that expect to provoke LockContention errors should call this.
2353
self.overrideAttr(lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2355
def make_utf8_encoded_stringio(self, encoding_type=None):
2356
"""Return a StringIOWrapper instance, that will encode Unicode
2359
if encoding_type is None:
2360
encoding_type = 'strict'
2362
output_encoding = 'utf-8'
2363
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2364
sio.encoding = output_encoding
2367
def disable_verb(self, verb):
2368
"""Disable a smart server verb for one test."""
2369
from bzrlib.smart import request
2370
request_handlers = request.request_handlers
2371
orig_method = request_handlers.get(verb)
2372
request_handlers.remove(verb)
2373
self.addCleanup(request_handlers.register, verb, orig_method)
2376
class CapturedCall(object):
2377
"""A helper for capturing smart server calls for easy debug analysis."""
2379
def __init__(self, params, prefix_length):
2380
"""Capture the call with params and skip prefix_length stack frames."""
2383
# The last 5 frames are the __init__, the hook frame, and 3 smart
2384
# client frames. Beyond this we could get more clever, but this is good
2386
stack = traceback.extract_stack()[prefix_length:-5]
2387
self.stack = ''.join(traceback.format_list(stack))
2390
return self.call.method
2393
return self.call.method
2399
class TestCaseWithMemoryTransport(TestCase):
2400
"""Common test class for tests that do not need disk resources.
2402
Tests that need disk resources should derive from TestCaseInTempDir
2403
orTestCaseWithTransport.
2405
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2407
For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
2408
a directory which does not exist. This serves to help ensure test isolation
2409
is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
2410
must exist. However, TestCaseWithMemoryTransport does not offer local file
2411
defaults for the transport in tests, nor does it obey the command line
2412
override, so tests that accidentally write to the common directory should
2415
:cvar TEST_ROOT: Directory containing all temporary directories, plus a
2416
``.bzr`` directory that stops us ascending higher into the filesystem.
2422
def __init__(self, methodName='runTest'):
2423
# allow test parameterization after test construction and before test
2424
# execution. Variables that the parameterizer sets need to be
2425
# ones that are not set by setUp, or setUp will trash them.
2426
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2427
self.vfs_transport_factory = default_transport
2428
self.transport_server = None
2429
self.transport_readonly_server = None
2430
self.__vfs_server = None
2432
def get_transport(self, relpath=None):
2433
"""Return a writeable transport.
2435
This transport is for the test scratch space relative to
2438
:param relpath: a path relative to the base url.
2440
t = _mod_transport.get_transport_from_url(self.get_url(relpath))
2441
self.assertFalse(t.is_readonly())
2444
def get_readonly_transport(self, relpath=None):
2445
"""Return a readonly transport for the test scratch space
2447
This can be used to test that operations which should only need
2448
readonly access in fact do not try to write.
2450
:param relpath: a path relative to the base url.
2452
t = _mod_transport.get_transport_from_url(
2453
self.get_readonly_url(relpath))
2454
self.assertTrue(t.is_readonly())
2457
def create_transport_readonly_server(self):
2458
"""Create a transport server from class defined at init.
2460
This is mostly a hook for daughter classes.
2462
return self.transport_readonly_server()
2464
def get_readonly_server(self):
2465
"""Get the server instance for the readonly transport
2467
This is useful for some tests with specific servers to do diagnostics.
2469
if self.__readonly_server is None:
2470
if self.transport_readonly_server is None:
2471
# readonly decorator requested
2472
self.__readonly_server = test_server.ReadonlyServer()
2474
# explicit readonly transport.
2475
self.__readonly_server = self.create_transport_readonly_server()
2476
self.start_server(self.__readonly_server,
2477
self.get_vfs_only_server())
2478
return self.__readonly_server
2480
def get_readonly_url(self, relpath=None):
2481
"""Get a URL for the readonly transport.
2483
This will either be backed by '.' or a decorator to the transport
2484
used by self.get_url()
2485
relpath provides for clients to get a path relative to the base url.
2486
These should only be downwards relative, not upwards.
2488
base = self.get_readonly_server().get_url()
2489
return self._adjust_url(base, relpath)
2491
def get_vfs_only_server(self):
2492
"""Get the vfs only read/write server instance.
2494
This is useful for some tests with specific servers that need
2497
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2498
is no means to override it.
2500
if self.__vfs_server is None:
2501
self.__vfs_server = memory.MemoryServer()
2502
self.start_server(self.__vfs_server)
2503
return self.__vfs_server
2505
def get_server(self):
2506
"""Get the read/write server instance.
2508
This is useful for some tests with specific servers that need
2511
This is built from the self.transport_server factory. If that is None,
2512
then the self.get_vfs_server is returned.
2514
if self.__server is None:
2515
if (self.transport_server is None or self.transport_server is
2516
self.vfs_transport_factory):
2517
self.__server = self.get_vfs_only_server()
2519
# bring up a decorated means of access to the vfs only server.
2520
self.__server = self.transport_server()
2521
self.start_server(self.__server, self.get_vfs_only_server())
2522
return self.__server
2524
def _adjust_url(self, base, relpath):
2525
"""Get a URL (or maybe a path) for the readwrite transport.
2527
This will either be backed by '.' or to an equivalent non-file based
2529
relpath provides for clients to get a path relative to the base url.
2530
These should only be downwards relative, not upwards.
2532
if relpath is not None and relpath != '.':
2533
if not base.endswith('/'):
2535
# XXX: Really base should be a url; we did after all call
2536
# get_url()! But sometimes it's just a path (from
2537
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2538
# to a non-escaped local path.
2539
if base.startswith('./') or base.startswith('/'):
2542
base += urlutils.escape(relpath)
2545
def get_url(self, relpath=None):
2546
"""Get a URL (or maybe a path) for the readwrite transport.
2548
This will either be backed by '.' or to an equivalent non-file based
2550
relpath provides for clients to get a path relative to the base url.
2551
These should only be downwards relative, not upwards.
2553
base = self.get_server().get_url()
2554
return self._adjust_url(base, relpath)
2556
def get_vfs_only_url(self, relpath=None):
2557
"""Get a URL (or maybe a path for the plain old vfs transport.
2559
This will never be a smart protocol. It always has all the
2560
capabilities of the local filesystem, but it might actually be a
2561
MemoryTransport or some other similar virtual filesystem.
2563
This is the backing transport (if any) of the server returned by
2564
get_url and get_readonly_url.
2566
:param relpath: provides for clients to get a path relative to the base
2567
url. These should only be downwards relative, not upwards.
2570
base = self.get_vfs_only_server().get_url()
2571
return self._adjust_url(base, relpath)
2573
def _create_safety_net(self):
2574
"""Make a fake bzr directory.
2576
This prevents any tests propagating up onto the TEST_ROOT directory's
2579
root = TestCaseWithMemoryTransport.TEST_ROOT
2580
# Make sure we get a readable and accessible home for .bzr.log
2581
# and/or config files, and not fallback to weird defaults (see
2582
# http://pad.lv/825027).
2583
self.assertIs(None, os.environ.get('BZR_HOME', None))
2584
os.environ['BZR_HOME'] = root
2585
wt = bzrdir.BzrDir.create_standalone_workingtree(root)
2586
del os.environ['BZR_HOME']
2587
# Hack for speed: remember the raw bytes of the dirstate file so that
2588
# we don't need to re-open the wt to check it hasn't changed.
2589
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
2590
wt.control_transport.get_bytes('dirstate'))
2592
def _check_safety_net(self):
2593
"""Check that the safety .bzr directory have not been touched.
2595
_make_test_root have created a .bzr directory to prevent tests from
2596
propagating. This method ensures than a test did not leaked.
2598
root = TestCaseWithMemoryTransport.TEST_ROOT
2599
t = _mod_transport.get_transport_from_path(root)
2600
self.permit_url(t.base)
2601
if (t.get_bytes('.bzr/checkout/dirstate') !=
2602
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
2603
# The current test have modified the /bzr directory, we need to
2604
# recreate a new one or all the followng tests will fail.
2605
# If you need to inspect its content uncomment the following line
2606
# import pdb; pdb.set_trace()
2607
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2608
self._create_safety_net()
2609
raise AssertionError('%s/.bzr should not be modified' % root)
2611
def _make_test_root(self):
2612
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2613
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2614
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2616
TestCaseWithMemoryTransport.TEST_ROOT = root
2618
self._create_safety_net()
2620
# The same directory is used by all tests, and we're not
2621
# specifically told when all tests are finished. This will do.
2622
atexit.register(_rmtree_temp_dir, root)
2624
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2625
self.addCleanup(self._check_safety_net)
2627
def makeAndChdirToTestDir(self):
2628
"""Create a temporary directories for this one test.
2630
This must set self.test_home_dir and self.test_dir and chdir to
2633
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2635
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2636
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2637
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2638
self.permit_dir(self.test_dir)
2640
def make_branch(self, relpath, format=None):
2641
"""Create a branch on the transport at relpath."""
2642
repo = self.make_repository(relpath, format=format)
2643
return repo.bzrdir.create_branch(append_revisions_only=False)
2645
def get_default_format(self):
2648
def resolve_format(self, format):
2649
"""Resolve an object to a ControlDir format object.
2651
The initial format object can either already be
2652
a ControlDirFormat, None (for the default format),
2653
or a string with the name of the control dir format.
2655
:param format: Object to resolve
2656
:return A ControlDirFormat instance
2659
format = self.get_default_format()
2660
if isinstance(format, basestring):
2661
format = bzrdir.format_registry.make_bzrdir(format)
2664
def make_bzrdir(self, relpath, format=None):
2666
# might be a relative or absolute path
2667
maybe_a_url = self.get_url(relpath)
2668
segments = maybe_a_url.rsplit('/', 1)
2669
t = _mod_transport.get_transport(maybe_a_url)
2670
if len(segments) > 1 and segments[-1] not in ('', '.'):
2672
format = self.resolve_format(format)
2673
return format.initialize_on_transport(t)
2674
except errors.UninitializableFormat:
2675
raise TestSkipped("Format %s is not initializable." % format)
2677
def make_repository(self, relpath, shared=None, format=None):
2678
"""Create a repository on our default transport at relpath.
2680
Note that relpath must be a relative path, not a full url.
2682
# FIXME: If you create a remoterepository this returns the underlying
2683
# real format, which is incorrect. Actually we should make sure that
2684
# RemoteBzrDir returns a RemoteRepository.
2685
# maybe mbp 20070410
2686
made_control = self.make_bzrdir(relpath, format=format)
2687
return made_control.create_repository(shared=shared)
2689
def make_smart_server(self, path, backing_server=None):
2690
if backing_server is None:
2691
backing_server = self.get_server()
2692
smart_server = test_server.SmartTCPServer_for_testing()
2693
self.start_server(smart_server, backing_server)
2694
remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
2696
return remote_transport
2698
def make_branch_and_memory_tree(self, relpath, format=None):
2699
"""Create a branch on the default transport and a MemoryTree for it."""
2700
b = self.make_branch(relpath, format=format)
2701
return memorytree.MemoryTree.create_on_branch(b)
2703
def make_branch_builder(self, relpath, format=None):
2704
branch = self.make_branch(relpath, format=format)
2705
return branchbuilder.BranchBuilder(branch=branch)
2707
def overrideEnvironmentForTesting(self):
2708
test_home_dir = self.test_home_dir
2709
if isinstance(test_home_dir, unicode):
2710
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2711
self.overrideEnv('HOME', test_home_dir)
2712
self.overrideEnv('BZR_HOME', test_home_dir)
2715
super(TestCaseWithMemoryTransport, self).setUp()
2716
# Ensure that ConnectedTransport doesn't leak sockets
2717
def get_transport_from_url_with_cleanup(*args, **kwargs):
2718
t = orig_get_transport_from_url(*args, **kwargs)
2719
if isinstance(t, _mod_transport.ConnectedTransport):
2720
self.addCleanup(t.disconnect)
2723
orig_get_transport_from_url = self.overrideAttr(
2724
_mod_transport, 'get_transport_from_url',
2725
get_transport_from_url_with_cleanup)
2726
self._make_test_root()
2727
self.addCleanup(os.chdir, os.getcwdu())
2728
self.makeAndChdirToTestDir()
2729
self.overrideEnvironmentForTesting()
2730
self.__readonly_server = None
2731
self.__server = None
2732
self.reduceLockdirTimeout()
2734
def setup_smart_server_with_call_log(self):
2735
"""Sets up a smart server as the transport server with a call log."""
2736
self.transport_server = test_server.SmartTCPServer_for_testing
2737
self.hpss_calls = []
2739
# Skip the current stack down to the caller of
2740
# setup_smart_server_with_call_log
2741
prefix_length = len(traceback.extract_stack()) - 2
2742
def capture_hpss_call(params):
2743
self.hpss_calls.append(
2744
CapturedCall(params, prefix_length))
2745
client._SmartClient.hooks.install_named_hook(
2746
'call', capture_hpss_call, None)
2748
def reset_smart_call_log(self):
2749
self.hpss_calls = []
2752
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2753
"""Derived class that runs a test within a temporary directory.
2755
This is useful for tests that need to create a branch, etc.
2757
The directory is created in a slightly complex way: for each
2758
Python invocation, a new temporary top-level directory is created.
2759
All test cases create their own directory within that. If the
2760
tests complete successfully, the directory is removed.
2762
:ivar test_base_dir: The path of the top-level directory for this
2763
test, which contains a home directory and a work directory.
2765
:ivar test_home_dir: An initially empty directory under test_base_dir
2766
which is used as $HOME for this test.
2768
:ivar test_dir: A directory under test_base_dir used as the current
2769
directory when the test proper is run.
2772
OVERRIDE_PYTHON = 'python'
2775
super(TestCaseInTempDir, self).setUp()
2776
# Remove the protection set in isolated_environ, we have a proper
2777
# access to disk resources now.
2778
self.overrideEnv('BZR_LOG', None)
2780
def check_file_contents(self, filename, expect):
2781
self.log("check contents of file %s" % filename)
2787
if contents != expect:
2788
self.log("expected: %r" % expect)
2789
self.log("actually: %r" % contents)
2790
self.fail("contents of %s not as expected" % filename)
2792
def _getTestDirPrefix(self):
2793
# create a directory within the top level test directory
2794
if sys.platform in ('win32', 'cygwin'):
2795
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2796
# windows is likely to have path-length limits so use a short name
2797
name_prefix = name_prefix[-30:]
2799
name_prefix = re.sub('[/]', '_', self.id())
2802
def makeAndChdirToTestDir(self):
2803
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2805
For TestCaseInTempDir we create a temporary directory based on the test
2806
name and then create two subdirs - test and home under it.
2808
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2809
self._getTestDirPrefix())
2811
for i in range(100):
2812
if os.path.exists(name):
2813
name = name_prefix + '_' + str(i)
2815
# now create test and home directories within this dir
2816
self.test_base_dir = name
2817
self.addCleanup(self.deleteTestDir)
2818
os.mkdir(self.test_base_dir)
2820
self.permit_dir(self.test_base_dir)
2821
# 'sprouting' and 'init' of a branch both walk up the tree to find
2822
# stacking policy to honour; create a bzr dir with an unshared
2823
# repository (but not a branch - our code would be trying to escape
2824
# then!) to stop them, and permit it to be read.
2825
# control = bzrdir.BzrDir.create(self.test_base_dir)
2826
# control.create_repository()
2827
self.test_home_dir = self.test_base_dir + '/home'
2828
os.mkdir(self.test_home_dir)
2829
self.test_dir = self.test_base_dir + '/work'
2830
os.mkdir(self.test_dir)
2831
os.chdir(self.test_dir)
2832
# put name of test inside
2833
f = file(self.test_base_dir + '/name', 'w')
2839
def deleteTestDir(self):
2840
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2841
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2843
def build_tree(self, shape, line_endings='binary', transport=None):
2844
"""Build a test tree according to a pattern.
2846
shape is a sequence of file specifications. If the final
2847
character is '/', a directory is created.
2849
This assumes that all the elements in the tree being built are new.
2851
This doesn't add anything to a branch.
2853
:type shape: list or tuple.
2854
:param line_endings: Either 'binary' or 'native'
2855
in binary mode, exact contents are written in native mode, the
2856
line endings match the default platform endings.
2857
:param transport: A transport to write to, for building trees on VFS's.
2858
If the transport is readonly or None, "." is opened automatically.
2861
if type(shape) not in (list, tuple):
2862
raise AssertionError("Parameter 'shape' should be "
2863
"a list or a tuple. Got %r instead" % (shape,))
2864
# It's OK to just create them using forward slashes on windows.
2865
if transport is None or transport.is_readonly():
2866
transport = _mod_transport.get_transport_from_path(".")
2868
self.assertIsInstance(name, basestring)
2870
transport.mkdir(urlutils.escape(name[:-1]))
2872
if line_endings == 'binary':
2874
elif line_endings == 'native':
2877
raise errors.BzrError(
2878
'Invalid line ending request %r' % line_endings)
2879
content = "contents of %s%s" % (name.encode('utf-8'), end)
2880
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2882
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2884
def assertInWorkingTree(self, path, root_path='.', tree=None):
2885
"""Assert whether path or paths are in the WorkingTree"""
2887
tree = workingtree.WorkingTree.open(root_path)
2888
if not isinstance(path, basestring):
2890
self.assertInWorkingTree(p, tree=tree)
2892
self.assertIsNot(tree.path2id(path), None,
2893
path+' not in working tree.')
2895
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2896
"""Assert whether path or paths are not in the WorkingTree"""
2898
tree = workingtree.WorkingTree.open(root_path)
2899
if not isinstance(path, basestring):
2901
self.assertNotInWorkingTree(p,tree=tree)
2903
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2906
class TestCaseWithTransport(TestCaseInTempDir):
2907
"""A test case that provides get_url and get_readonly_url facilities.
2909
These back onto two transport servers, one for readonly access and one for
2912
If no explicit class is provided for readonly access, a
2913
ReadonlyTransportDecorator is used instead which allows the use of non disk
2914
based read write transports.
2916
If an explicit class is provided for readonly access, that server and the
2917
readwrite one must both define get_url() as resolving to os.getcwd().
2920
def get_vfs_only_server(self):
2921
"""See TestCaseWithMemoryTransport.
2923
This is useful for some tests with specific servers that need
2926
if self.__vfs_server is None:
2927
self.__vfs_server = self.vfs_transport_factory()
2928
self.start_server(self.__vfs_server)
2929
return self.__vfs_server
2931
def make_branch_and_tree(self, relpath, format=None):
2932
"""Create a branch on the transport and a tree locally.
2934
If the transport is not a LocalTransport, the Tree can't be created on
2935
the transport. In that case if the vfs_transport_factory is
2936
LocalURLServer the working tree is created in the local
2937
directory backing the transport, and the returned tree's branch and
2938
repository will also be accessed locally. Otherwise a lightweight
2939
checkout is created and returned.
2941
We do this because we can't physically create a tree in the local
2942
path, with a branch reference to the transport_factory url, and
2943
a branch + repository in the vfs_transport, unless the vfs_transport
2944
namespace is distinct from the local disk - the two branch objects
2945
would collide. While we could construct a tree with its branch object
2946
pointing at the transport_factory transport in memory, reopening it
2947
would behaving unexpectedly, and has in the past caused testing bugs
2948
when we tried to do it that way.
2950
:param format: The BzrDirFormat.
2951
:returns: the WorkingTree.
2953
# TODO: always use the local disk path for the working tree,
2954
# this obviously requires a format that supports branch references
2955
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2957
format = self.resolve_format(format=format)
2958
if not format.supports_workingtrees:
2959
b = self.make_branch(relpath+'.branch', format=format)
2960
return b.create_checkout(relpath, lightweight=True)
2961
b = self.make_branch(relpath, format=format)
2963
return b.bzrdir.create_workingtree()
2964
except errors.NotLocalUrl:
2965
# We can only make working trees locally at the moment. If the
2966
# transport can't support them, then we keep the non-disk-backed
2967
# branch and create a local checkout.
2968
if self.vfs_transport_factory is test_server.LocalURLServer:
2969
# the branch is colocated on disk, we cannot create a checkout.
2970
# hopefully callers will expect this.
2971
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2972
wt = local_controldir.create_workingtree()
2973
if wt.branch._format != b._format:
2975
# Make sure that assigning to wt._branch fixes wt.branch,
2976
# in case the implementation details of workingtree objects
2978
self.assertIs(b, wt.branch)
2981
return b.create_checkout(relpath, lightweight=True)
2983
def assertIsDirectory(self, relpath, transport):
2984
"""Assert that relpath within transport is a directory.
2986
This may not be possible on all transports; in that case it propagates
2987
a TransportNotPossible.
2990
mode = transport.stat(relpath).st_mode
2991
except errors.NoSuchFile:
2992
self.fail("path %s is not a directory; no such file"
2994
if not stat.S_ISDIR(mode):
2995
self.fail("path %s is not a directory; has mode %#o"
2998
def assertTreesEqual(self, left, right):
2999
"""Check that left and right have the same content and properties."""
3000
# we use a tree delta to check for equality of the content, and we
3001
# manually check for equality of other things such as the parents list.
3002
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
3003
differences = left.changes_from(right)
3004
self.assertFalse(differences.has_changed(),
3005
"Trees %r and %r are different: %r" % (left, right, differences))
3008
super(TestCaseWithTransport, self).setUp()
3009
self.__vfs_server = None
3011
def disable_missing_extensions_warning(self):
3012
"""Some tests expect a precise stderr content.
3014
There is no point in forcing them to duplicate the extension related
3017
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
3020
class ChrootedTestCase(TestCaseWithTransport):
3021
"""A support class that provides readonly urls outside the local namespace.
3023
This is done by checking if self.transport_server is a MemoryServer. if it
3024
is then we are chrooted already, if it is not then an HttpServer is used
3027
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
3028
be used without needed to redo it when a different
3029
subclass is in use ?
3033
from bzrlib.tests import http_server
3034
super(ChrootedTestCase, self).setUp()
3035
if not self.vfs_transport_factory == memory.MemoryServer:
3036
self.transport_readonly_server = http_server.HttpServer
3039
def condition_id_re(pattern):
3040
"""Create a condition filter which performs a re check on a test's id.
3042
:param pattern: A regular expression string.
3043
:return: A callable that returns True if the re matches.
3045
filter_re = re.compile(pattern, 0)
3046
def condition(test):
3048
return filter_re.search(test_id)
3052
def condition_isinstance(klass_or_klass_list):
3053
"""Create a condition filter which returns isinstance(param, klass).
3055
:return: A callable which when called with one parameter obj return the
3056
result of isinstance(obj, klass_or_klass_list).
3059
return isinstance(obj, klass_or_klass_list)
3063
def condition_id_in_list(id_list):
3064
"""Create a condition filter which verify that test's id in a list.
3066
:param id_list: A TestIdList object.
3067
:return: A callable that returns True if the test's id appears in the list.
3069
def condition(test):
3070
return id_list.includes(test.id())
3074
def condition_id_startswith(starts):
3075
"""Create a condition filter verifying that test's id starts with a string.
3077
:param starts: A list of string.
3078
:return: A callable that returns True if the test's id starts with one of
3081
def condition(test):
3082
for start in starts:
3083
if test.id().startswith(start):
3089
def exclude_tests_by_condition(suite, condition):
3090
"""Create a test suite which excludes some tests from suite.
3092
:param suite: The suite to get tests from.
3093
:param condition: A callable whose result evaluates True when called with a
3094
test case which should be excluded from the result.
3095
:return: A suite which contains the tests found in suite that fail
3099
for test in iter_suite_tests(suite):
3100
if not condition(test):
3102
return TestUtil.TestSuite(result)
3105
def filter_suite_by_condition(suite, condition):
3106
"""Create a test suite by filtering another one.
3108
:param suite: The source suite.
3109
:param condition: A callable whose result evaluates True when called with a
3110
test case which should be included in the result.
3111
:return: A suite which contains the tests found in suite that pass
3115
for test in iter_suite_tests(suite):
3118
return TestUtil.TestSuite(result)
3121
def filter_suite_by_re(suite, pattern):
3122
"""Create a test suite by filtering another one.
3124
:param suite: the source suite
3125
:param pattern: pattern that names must match
3126
:returns: the newly created suite
3128
condition = condition_id_re(pattern)
3129
result_suite = filter_suite_by_condition(suite, condition)
3133
def filter_suite_by_id_list(suite, test_id_list):
3134
"""Create a test suite by filtering another one.
3136
:param suite: The source suite.
3137
:param test_id_list: A list of the test ids to keep as strings.
3138
:returns: the newly created suite
3140
condition = condition_id_in_list(test_id_list)
3141
result_suite = filter_suite_by_condition(suite, condition)
3145
def filter_suite_by_id_startswith(suite, start):
3146
"""Create a test suite by filtering another one.
3148
:param suite: The source suite.
3149
:param start: A list of string the test id must start with one of.
3150
:returns: the newly created suite
3152
condition = condition_id_startswith(start)
3153
result_suite = filter_suite_by_condition(suite, condition)
3157
def exclude_tests_by_re(suite, pattern):
3158
"""Create a test suite which excludes some tests from suite.
3160
:param suite: The suite to get tests from.
3161
:param pattern: A regular expression string. Test ids that match this
3162
pattern will be excluded from the result.
3163
:return: A TestSuite that contains all the tests from suite without the
3164
tests that matched pattern. The order of tests is the same as it was in
3167
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3170
def preserve_input(something):
3171
"""A helper for performing test suite transformation chains.
3173
:param something: Anything you want to preserve.
3179
def randomize_suite(suite):
3180
"""Return a new TestSuite with suite's tests in random order.
3182
The tests in the input suite are flattened into a single suite in order to
3183
accomplish this. Any nested TestSuites are removed to provide global
3186
tests = list(iter_suite_tests(suite))
3187
random.shuffle(tests)
3188
return TestUtil.TestSuite(tests)
3191
def split_suite_by_condition(suite, condition):
3192
"""Split a test suite into two by a condition.
3194
:param suite: The suite to split.
3195
:param condition: The condition to match on. Tests that match this
3196
condition are returned in the first test suite, ones that do not match
3197
are in the second suite.
3198
:return: A tuple of two test suites, where the first contains tests from
3199
suite matching the condition, and the second contains the remainder
3200
from suite. The order within each output suite is the same as it was in
3205
for test in iter_suite_tests(suite):
3207
matched.append(test)
3209
did_not_match.append(test)
3210
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3213
def split_suite_by_re(suite, pattern):
3214
"""Split a test suite into two by a regular expression.
3216
:param suite: The suite to split.
3217
:param pattern: A regular expression string. Test ids that match this
3218
pattern will be in the first test suite returned, and the others in the
3219
second test suite returned.
3220
:return: A tuple of two test suites, where the first contains tests from
3221
suite matching pattern, and the second contains the remainder from
3222
suite. The order within each output suite is the same as it was in
3225
return split_suite_by_condition(suite, condition_id_re(pattern))
3228
def run_suite(suite, name='test', verbose=False, pattern=".*",
3229
stop_on_failure=False,
3230
transport=None, lsprof_timed=None, bench_history=None,
3231
matching_tests_first=None,
3234
exclude_pattern=None,
3237
suite_decorators=None,
3239
result_decorators=None,
63
if m not in MODULES_TO_TEST:
64
MODULES_TO_TEST.append(m)
67
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
68
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
74
# should also test bzrlib.merge_core, but they seem to be out of date with
78
# XXX: python2.3's TestLoader() doesn't seem to find all the
79
# tests; don't know why
80
for m in MODULES_TO_TEST:
81
suite.addTest(TestLoader().loadTestsFromModule(m))
83
for m in (MODULES_TO_DOCTEST):
84
suite.addTest(DocTestSuite(m))
86
for p in bzrlib.plugin.all_plugins:
87
if hasattr(p, 'test_suite'):
88
suite.addTest(p.test_suite())
90
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
92
return run_suite(suite, 'testbzr', verbose=verbose)
3241
"""Run a test suite for bzr selftest.
3243
:param runner_class: The class of runner to use. Must support the
3244
constructor arguments passed by run_suite which are more than standard
3246
:return: A boolean indicating success.
3248
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3253
if runner_class is None:
3254
runner_class = TextTestRunner
3257
runner = runner_class(stream=stream,
3259
verbosity=verbosity,
3260
bench_history=bench_history,
3262
result_decorators=result_decorators,
3264
runner.stop_on_failure=stop_on_failure
3265
if isinstance(suite, unittest.TestSuite):
3266
# Empty out _tests list of passed suite and populate new TestSuite
3267
suite._tests[:], suite = [], TestSuite(suite)
3268
# built in decorator factories:
3270
random_order(random_seed, runner),
3271
exclude_tests(exclude_pattern),
3273
if matching_tests_first:
3274
decorators.append(tests_first(pattern))
3276
decorators.append(filter_tests(pattern))
3277
if suite_decorators:
3278
decorators.extend(suite_decorators)
3279
# tell the result object how many tests will be running: (except if
3280
# --parallel=fork is being used. Robert said he will provide a better
3281
# progress design later -- vila 20090817)
3282
if fork_decorator not in decorators:
3283
decorators.append(CountingDecorator)
3284
for decorator in decorators:
3285
suite = decorator(suite)
3287
# Done after test suite decoration to allow randomisation etc
3288
# to take effect, though that is of marginal benefit.
3290
stream.write("Listing tests only ...\n")
3291
for t in iter_suite_tests(suite):
3292
stream.write("%s\n" % (t.id()))
3294
result = runner.run(suite)
3296
return result.wasStrictlySuccessful()
3298
return result.wasSuccessful()
3301
# A registry where get() returns a suite decorator.
3302
parallel_registry = registry.Registry()
3305
def fork_decorator(suite):
3306
if getattr(os, "fork", None) is None:
3307
raise errors.BzrCommandError("platform does not support fork,"
3308
" try --parallel=subprocess instead.")
3309
concurrency = osutils.local_concurrency()
3310
if concurrency == 1:
3312
from testtools import ConcurrentTestSuite
3313
return ConcurrentTestSuite(suite, fork_for_tests)
3314
parallel_registry.register('fork', fork_decorator)
3317
def subprocess_decorator(suite):
3318
concurrency = osutils.local_concurrency()
3319
if concurrency == 1:
3321
from testtools import ConcurrentTestSuite
3322
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3323
parallel_registry.register('subprocess', subprocess_decorator)
3326
def exclude_tests(exclude_pattern):
3327
"""Return a test suite decorator that excludes tests."""
3328
if exclude_pattern is None:
3329
return identity_decorator
3330
def decorator(suite):
3331
return ExcludeDecorator(suite, exclude_pattern)
3335
def filter_tests(pattern):
3337
return identity_decorator
3338
def decorator(suite):
3339
return FilterTestsDecorator(suite, pattern)
3343
def random_order(random_seed, runner):
3344
"""Return a test suite decorator factory for randomising tests order.
3346
:param random_seed: now, a string which casts to a long, or a long.
3347
:param runner: A test runner with a stream attribute to report on.
3349
if random_seed is None:
3350
return identity_decorator
3351
def decorator(suite):
3352
return RandomDecorator(suite, random_seed, runner.stream)
3356
def tests_first(pattern):
3358
return identity_decorator
3359
def decorator(suite):
3360
return TestFirstDecorator(suite, pattern)
3364
def identity_decorator(suite):
3369
class TestDecorator(TestUtil.TestSuite):
3370
"""A decorator for TestCase/TestSuite objects.
3372
Contains rather than flattening suite passed on construction
3375
def __init__(self, suite=None):
3376
super(TestDecorator, self).__init__()
3377
if suite is not None:
3380
# Don't need subclass run method with suite emptying
3381
run = unittest.TestSuite.run
3384
class CountingDecorator(TestDecorator):
3385
"""A decorator which calls result.progress(self.countTestCases)."""
3387
def run(self, result):
3388
progress_method = getattr(result, 'progress', None)
3389
if callable(progress_method):
3390
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3391
return super(CountingDecorator, self).run(result)
3394
class ExcludeDecorator(TestDecorator):
3395
"""A decorator which excludes test matching an exclude pattern."""
3397
def __init__(self, suite, exclude_pattern):
3398
super(ExcludeDecorator, self).__init__(
3399
exclude_tests_by_re(suite, exclude_pattern))
3402
class FilterTestsDecorator(TestDecorator):
3403
"""A decorator which filters tests to those matching a pattern."""
3405
def __init__(self, suite, pattern):
3406
super(FilterTestsDecorator, self).__init__(
3407
filter_suite_by_re(suite, pattern))
3410
class RandomDecorator(TestDecorator):
3411
"""A decorator which randomises the order of its tests."""
3413
def __init__(self, suite, random_seed, stream):
3414
random_seed = self.actual_seed(random_seed)
3415
stream.write("Randomizing test order using seed %s\n\n" %
3417
# Initialise the random number generator.
3418
random.seed(random_seed)
3419
super(RandomDecorator, self).__init__(randomize_suite(suite))
3422
def actual_seed(seed):
3424
# We convert the seed to a long to make it reuseable across
3425
# invocations (because the user can reenter it).
3426
return long(time.time())
3428
# Convert the seed to a long if we can
3431
except (TypeError, ValueError):
3436
class TestFirstDecorator(TestDecorator):
3437
"""A decorator which moves named tests to the front."""
3439
def __init__(self, suite, pattern):
3440
super(TestFirstDecorator, self).__init__()
3441
self.addTests(split_suite_by_re(suite, pattern))
3444
def partition_tests(suite, count):
3445
"""Partition suite into count lists of tests."""
3446
# This just assigns tests in a round-robin fashion. On one hand this
3447
# splits up blocks of related tests that might run faster if they shared
3448
# resources, but on the other it avoids assigning blocks of slow tests to
3449
# just one partition. So the slowest partition shouldn't be much slower
3451
partitions = [list() for i in range(count)]
3452
tests = iter_suite_tests(suite)
3453
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3454
partition.append(test)
3458
def workaround_zealous_crypto_random():
3459
"""Crypto.Random want to help us being secure, but we don't care here.
3461
This workaround some test failure related to the sftp server. Once paramiko
3462
stop using the controversial API in Crypto.Random, we may get rid of it.
3465
from Crypto.Random import atfork
3471
def fork_for_tests(suite):
3472
"""Take suite and start up one runner per CPU by forking()
3474
:return: An iterable of TestCase-like objects which can each have
3475
run(result) called on them to feed tests to result.
3477
concurrency = osutils.local_concurrency()
3479
from subunit import ProtocolTestCase
3480
from subunit.test_results import AutoTimingTestResultDecorator
3481
class TestInOtherProcess(ProtocolTestCase):
3482
# Should be in subunit, I think. RBC.
3483
def __init__(self, stream, pid):
3484
ProtocolTestCase.__init__(self, stream)
3487
def run(self, result):
3489
ProtocolTestCase.run(self, result)
3491
pid, status = os.waitpid(self.pid, 0)
3492
# GZ 2011-10-18: If status is nonzero, should report to the result
3493
# that something went wrong.
3495
test_blocks = partition_tests(suite, concurrency)
3496
# Clear the tests from the original suite so it doesn't keep them alive
3497
suite._tests[:] = []
3498
for process_tests in test_blocks:
3499
process_suite = TestUtil.TestSuite(process_tests)
3500
# Also clear each split list so new suite has only reference
3501
process_tests[:] = []
3502
c2pread, c2pwrite = os.pipe()
3506
stream = os.fdopen(c2pwrite, 'wb', 1)
3507
workaround_zealous_crypto_random()
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
SubUnitBzrProtocolClient(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(bzrlib.__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 = bzrlib.lsprof.BzrProfiler()
3607
# Prevent deadlocks in tests that use lsprof: those tests will
3609
bzrlib.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 "bzr 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 bzrlib 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
if test_suite_factory is None:
3687
# Reduce loading time by loading modules based on the starting_with
3689
suite = test_suite(keep_only, starting_with)
3691
suite = test_suite_factory()
3693
# But always filter as requested.
3694
suite = filter_suite_by_id_startswith(suite, starting_with)
3695
result_decorators = []
3697
result_decorators.append(ProfileResult)
3698
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3699
stop_on_failure=stop_on_failure,
3700
transport=transport,
3701
lsprof_timed=lsprof_timed,
3702
bench_history=bench_history,
3703
matching_tests_first=matching_tests_first,
3704
list_only=list_only,
3705
random_seed=random_seed,
3706
exclude_pattern=exclude_pattern,
3708
runner_class=runner_class,
3709
suite_decorators=suite_decorators,
3711
result_decorators=result_decorators,
3714
default_transport = old_transport
3715
selftest_debug_flags = old_debug_flags
3718
def load_test_id_list(file_name):
3719
"""Load a test id list from a text file.
3721
The format is one test id by line. No special care is taken to impose
3722
strict rules, these test ids are used to filter the test suite so a test id
3723
that do not match an existing test will do no harm. This allows user to add
3724
comments, leave blank lines, etc.
3728
ftest = open(file_name, 'rt')
3730
if e.errno != errno.ENOENT:
3733
raise errors.NoSuchFile(file_name)
3735
for test_name in ftest.readlines():
3736
test_list.append(test_name.strip())
3741
def suite_matches_id_list(test_suite, id_list):
3742
"""Warns about tests not appearing or appearing more than once.
3744
:param test_suite: A TestSuite object.
3745
:param test_id_list: The list of test ids that should be found in
3748
:return: (absents, duplicates) absents is a list containing the test found
3749
in id_list but not in test_suite, duplicates is a list containing the
3750
test found multiple times in test_suite.
3752
When using a prefined test id list, it may occurs that some tests do not
3753
exist anymore or that some tests use the same id. This function warns the
3754
tester about potential problems in his workflow (test lists are volatile)
3755
or in the test suite itself (using the same id for several tests does not
3756
help to localize defects).
3758
# Build a dict counting id occurrences
3760
for test in iter_suite_tests(test_suite):
3762
tests[id] = tests.get(id, 0) + 1
3767
occurs = tests.get(id, 0)
3769
not_found.append(id)
3771
duplicates.append(id)
3773
return not_found, duplicates
3776
class TestIdList(object):
3777
"""Test id list to filter a test suite.
3779
Relying on the assumption that test ids are built as:
3780
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3781
notation, this class offers methods to :
3782
- avoid building a test suite for modules not refered to in the test list,
3783
- keep only the tests listed from the module test suite.
3786
def __init__(self, test_id_list):
3787
# When a test suite needs to be filtered against us we compare test ids
3788
# for equality, so a simple dict offers a quick and simple solution.
3789
self.tests = dict().fromkeys(test_id_list, True)
3791
# While unittest.TestCase have ids like:
3792
# <module>.<class>.<method>[(<param+)],
3793
# doctest.DocTestCase can have ids like:
3796
# <module>.<function>
3797
# <module>.<class>.<method>
3799
# Since we can't predict a test class from its name only, we settle on
3800
# a simple constraint: a test id always begins with its module name.
3803
for test_id in test_id_list:
3804
parts = test_id.split('.')
3805
mod_name = parts.pop(0)
3806
modules[mod_name] = True
3808
mod_name += '.' + part
3809
modules[mod_name] = True
3810
self.modules = modules
3812
def refers_to(self, module_name):
3813
"""Is there tests for the module or one of its sub modules."""
3814
return self.modules.has_key(module_name)
3816
def includes(self, test_id):
3817
return self.tests.has_key(test_id)
3820
class TestPrefixAliasRegistry(registry.Registry):
3821
"""A registry for test prefix aliases.
3823
This helps implement shorcuts for the --starting-with selftest
3824
option. Overriding existing prefixes is not allowed but not fatal (a
3825
warning will be emitted).
3828
def register(self, key, obj, help=None, info=None,
3829
override_existing=False):
3830
"""See Registry.register.
3832
Trying to override an existing alias causes a warning to be emitted,
3833
not a fatal execption.
3836
super(TestPrefixAliasRegistry, self).register(
3837
key, obj, help=help, info=info, override_existing=False)
3839
actual = self.get(key)
3841
'Test prefix alias %s is already used for %s, ignoring %s'
3842
% (key, actual, obj))
3844
def resolve_alias(self, id_start):
3845
"""Replace the alias by the prefix in the given string.
3847
Using an unknown prefix is an error to help catching typos.
3849
parts = id_start.split('.')
3851
parts[0] = self.get(parts[0])
3853
raise errors.BzrCommandError(
3854
'%s is not a known test prefix alias' % parts[0])
3855
return '.'.join(parts)
3858
test_prefix_alias_registry = TestPrefixAliasRegistry()
3859
"""Registry of test prefix aliases."""
3862
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3863
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3864
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3866
# Obvious highest levels prefixes, feel free to add your own via a plugin
3867
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3868
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3869
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3870
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3871
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3874
def _test_suite_testmod_names():
3875
"""Return the standard list of test module names to test."""
3878
'bzrlib.tests.blackbox',
3879
'bzrlib.tests.commands',
3880
'bzrlib.tests.doc_generate',
3881
'bzrlib.tests.per_branch',
3882
'bzrlib.tests.per_bzrdir',
3883
'bzrlib.tests.per_controldir',
3884
'bzrlib.tests.per_controldir_colo',
3885
'bzrlib.tests.per_foreign_vcs',
3886
'bzrlib.tests.per_interrepository',
3887
'bzrlib.tests.per_intertree',
3888
'bzrlib.tests.per_inventory',
3889
'bzrlib.tests.per_interbranch',
3890
'bzrlib.tests.per_lock',
3891
'bzrlib.tests.per_merger',
3892
'bzrlib.tests.per_transport',
3893
'bzrlib.tests.per_tree',
3894
'bzrlib.tests.per_pack_repository',
3895
'bzrlib.tests.per_repository',
3896
'bzrlib.tests.per_repository_chk',
3897
'bzrlib.tests.per_repository_reference',
3898
'bzrlib.tests.per_repository_vf',
3899
'bzrlib.tests.per_uifactory',
3900
'bzrlib.tests.per_versionedfile',
3901
'bzrlib.tests.per_workingtree',
3902
'bzrlib.tests.test__annotator',
3903
'bzrlib.tests.test__bencode',
3904
'bzrlib.tests.test__btree_serializer',
3905
'bzrlib.tests.test__chk_map',
3906
'bzrlib.tests.test__dirstate_helpers',
3907
'bzrlib.tests.test__groupcompress',
3908
'bzrlib.tests.test__known_graph',
3909
'bzrlib.tests.test__rio',
3910
'bzrlib.tests.test__simple_set',
3911
'bzrlib.tests.test__static_tuple',
3912
'bzrlib.tests.test__walkdirs_win32',
3913
'bzrlib.tests.test_ancestry',
3914
'bzrlib.tests.test_annotate',
3915
'bzrlib.tests.test_api',
3916
'bzrlib.tests.test_atomicfile',
3917
'bzrlib.tests.test_bad_files',
3918
'bzrlib.tests.test_bisect_multi',
3919
'bzrlib.tests.test_branch',
3920
'bzrlib.tests.test_branchbuilder',
3921
'bzrlib.tests.test_btree_index',
3922
'bzrlib.tests.test_bugtracker',
3923
'bzrlib.tests.test_bundle',
3924
'bzrlib.tests.test_bzrdir',
3925
'bzrlib.tests.test__chunks_to_lines',
3926
'bzrlib.tests.test_cache_utf8',
3927
'bzrlib.tests.test_chk_map',
3928
'bzrlib.tests.test_chk_serializer',
3929
'bzrlib.tests.test_chunk_writer',
3930
'bzrlib.tests.test_clean_tree',
3931
'bzrlib.tests.test_cleanup',
3932
'bzrlib.tests.test_cmdline',
3933
'bzrlib.tests.test_commands',
3934
'bzrlib.tests.test_commit',
3935
'bzrlib.tests.test_commit_merge',
3936
'bzrlib.tests.test_config',
3937
'bzrlib.tests.test_conflicts',
3938
'bzrlib.tests.test_controldir',
3939
'bzrlib.tests.test_counted_lock',
3940
'bzrlib.tests.test_crash',
3941
'bzrlib.tests.test_decorators',
3942
'bzrlib.tests.test_delta',
3943
'bzrlib.tests.test_debug',
3944
'bzrlib.tests.test_diff',
3945
'bzrlib.tests.test_directory_service',
3946
'bzrlib.tests.test_dirstate',
3947
'bzrlib.tests.test_email_message',
3948
'bzrlib.tests.test_eol_filters',
3949
'bzrlib.tests.test_errors',
3950
'bzrlib.tests.test_estimate_compressed_size',
3951
'bzrlib.tests.test_export',
3952
'bzrlib.tests.test_export_pot',
3953
'bzrlib.tests.test_extract',
3954
'bzrlib.tests.test_features',
3955
'bzrlib.tests.test_fetch',
3956
'bzrlib.tests.test_fixtures',
3957
'bzrlib.tests.test_fifo_cache',
3958
'bzrlib.tests.test_filters',
3959
'bzrlib.tests.test_filter_tree',
3960
'bzrlib.tests.test_ftp_transport',
3961
'bzrlib.tests.test_foreign',
3962
'bzrlib.tests.test_generate_docs',
3963
'bzrlib.tests.test_generate_ids',
3964
'bzrlib.tests.test_globbing',
3965
'bzrlib.tests.test_gpg',
3966
'bzrlib.tests.test_graph',
3967
'bzrlib.tests.test_groupcompress',
3968
'bzrlib.tests.test_hashcache',
3969
'bzrlib.tests.test_help',
3970
'bzrlib.tests.test_hooks',
3971
'bzrlib.tests.test_http',
3972
'bzrlib.tests.test_http_response',
3973
'bzrlib.tests.test_https_ca_bundle',
3974
'bzrlib.tests.test_i18n',
3975
'bzrlib.tests.test_identitymap',
3976
'bzrlib.tests.test_ignores',
3977
'bzrlib.tests.test_index',
3978
'bzrlib.tests.test_import_tariff',
3979
'bzrlib.tests.test_info',
3980
'bzrlib.tests.test_inv',
3981
'bzrlib.tests.test_inventory_delta',
3982
'bzrlib.tests.test_knit',
3983
'bzrlib.tests.test_lazy_import',
3984
'bzrlib.tests.test_lazy_regex',
3985
'bzrlib.tests.test_library_state',
3986
'bzrlib.tests.test_lock',
3987
'bzrlib.tests.test_lockable_files',
3988
'bzrlib.tests.test_lockdir',
3989
'bzrlib.tests.test_log',
3990
'bzrlib.tests.test_lru_cache',
3991
'bzrlib.tests.test_lsprof',
3992
'bzrlib.tests.test_mail_client',
3993
'bzrlib.tests.test_matchers',
3994
'bzrlib.tests.test_memorytree',
3995
'bzrlib.tests.test_merge',
3996
'bzrlib.tests.test_merge3',
3997
'bzrlib.tests.test_merge_core',
3998
'bzrlib.tests.test_merge_directive',
3999
'bzrlib.tests.test_mergetools',
4000
'bzrlib.tests.test_missing',
4001
'bzrlib.tests.test_msgeditor',
4002
'bzrlib.tests.test_multiparent',
4003
'bzrlib.tests.test_mutabletree',
4004
'bzrlib.tests.test_nonascii',
4005
'bzrlib.tests.test_options',
4006
'bzrlib.tests.test_osutils',
4007
'bzrlib.tests.test_osutils_encodings',
4008
'bzrlib.tests.test_pack',
4009
'bzrlib.tests.test_patch',
4010
'bzrlib.tests.test_patches',
4011
'bzrlib.tests.test_permissions',
4012
'bzrlib.tests.test_plugins',
4013
'bzrlib.tests.test_progress',
4014
'bzrlib.tests.test_pyutils',
4015
'bzrlib.tests.test_read_bundle',
4016
'bzrlib.tests.test_reconcile',
4017
'bzrlib.tests.test_reconfigure',
4018
'bzrlib.tests.test_registry',
4019
'bzrlib.tests.test_remote',
4020
'bzrlib.tests.test_rename_map',
4021
'bzrlib.tests.test_repository',
4022
'bzrlib.tests.test_revert',
4023
'bzrlib.tests.test_revision',
4024
'bzrlib.tests.test_revisionspec',
4025
'bzrlib.tests.test_revisiontree',
4026
'bzrlib.tests.test_rio',
4027
'bzrlib.tests.test_rules',
4028
'bzrlib.tests.test_sampler',
4029
'bzrlib.tests.test_scenarios',
4030
'bzrlib.tests.test_script',
4031
'bzrlib.tests.test_selftest',
4032
'bzrlib.tests.test_serializer',
4033
'bzrlib.tests.test_setup',
4034
'bzrlib.tests.test_sftp_transport',
4035
'bzrlib.tests.test_shelf',
4036
'bzrlib.tests.test_shelf_ui',
4037
'bzrlib.tests.test_smart',
4038
'bzrlib.tests.test_smart_add',
4039
'bzrlib.tests.test_smart_request',
4040
'bzrlib.tests.test_smart_signals',
4041
'bzrlib.tests.test_smart_transport',
4042
'bzrlib.tests.test_smtp_connection',
4043
'bzrlib.tests.test_source',
4044
'bzrlib.tests.test_ssh_transport',
4045
'bzrlib.tests.test_status',
4046
'bzrlib.tests.test_store',
4047
'bzrlib.tests.test_strace',
4048
'bzrlib.tests.test_subsume',
4049
'bzrlib.tests.test_switch',
4050
'bzrlib.tests.test_symbol_versioning',
4051
'bzrlib.tests.test_tag',
4052
'bzrlib.tests.test_test_server',
4053
'bzrlib.tests.test_testament',
4054
'bzrlib.tests.test_textfile',
4055
'bzrlib.tests.test_textmerge',
4056
'bzrlib.tests.test_cethread',
4057
'bzrlib.tests.test_timestamp',
4058
'bzrlib.tests.test_trace',
4059
'bzrlib.tests.test_transactions',
4060
'bzrlib.tests.test_transform',
4061
'bzrlib.tests.test_transport',
4062
'bzrlib.tests.test_transport_log',
4063
'bzrlib.tests.test_tree',
4064
'bzrlib.tests.test_treebuilder',
4065
'bzrlib.tests.test_treeshape',
4066
'bzrlib.tests.test_tsort',
4067
'bzrlib.tests.test_tuned_gzip',
4068
'bzrlib.tests.test_ui',
4069
'bzrlib.tests.test_uncommit',
4070
'bzrlib.tests.test_upgrade',
4071
'bzrlib.tests.test_upgrade_stacked',
4072
'bzrlib.tests.test_urlutils',
4073
'bzrlib.tests.test_utextwrap',
4074
'bzrlib.tests.test_version',
4075
'bzrlib.tests.test_version_info',
4076
'bzrlib.tests.test_versionedfile',
4077
'bzrlib.tests.test_weave',
4078
'bzrlib.tests.test_whitebox',
4079
'bzrlib.tests.test_win32utils',
4080
'bzrlib.tests.test_workingtree',
4081
'bzrlib.tests.test_workingtree_4',
4082
'bzrlib.tests.test_wsgi',
4083
'bzrlib.tests.test_xml',
4087
def _test_suite_modules_to_doctest():
4088
"""Return the list of modules to doctest."""
4090
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4094
'bzrlib.branchbuilder',
4095
'bzrlib.decorators',
4097
'bzrlib.iterablefile',
4102
'bzrlib.symbol_versioning',
4104
'bzrlib.tests.fixtures',
4106
'bzrlib.transport.http',
4107
'bzrlib.version_info_formats.format_custom',
4111
def test_suite(keep_only=None, starting_with=None):
4112
"""Build and return TestSuite for the whole of bzrlib.
4114
:param keep_only: A list of test ids limiting the suite returned.
4116
:param starting_with: An id limiting the suite returned to the tests
4119
This function can be replaced if you need to change the default test
4120
suite on a global basis, but it is not encouraged.
4123
loader = TestUtil.TestLoader()
4125
if keep_only is not None:
4126
id_filter = TestIdList(keep_only)
4128
# We take precedence over keep_only because *at loading time* using
4129
# both options means we will load less tests for the same final result.
4130
def interesting_module(name):
4131
for start in starting_with:
4133
# Either the module name starts with the specified string
4134
name.startswith(start)
4135
# or it may contain tests starting with the specified string
4136
or start.startswith(name)
4140
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4142
elif keep_only is not None:
4143
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4144
def interesting_module(name):
4145
return id_filter.refers_to(name)
4148
loader = TestUtil.TestLoader()
4149
def interesting_module(name):
4150
# No filtering, all modules are interesting
4153
suite = loader.suiteClass()
4155
# modules building their suite with loadTestsFromModuleNames
4156
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4158
for mod in _test_suite_modules_to_doctest():
4159
if not interesting_module(mod):
4160
# No tests to keep here, move along
4163
# note that this really does mean "report only" -- doctest
4164
# still runs the rest of the examples
4165
doc_suite = IsolatedDocTestSuite(
4166
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
4167
except ValueError, e:
4168
print '**failed to get doctest for: %s\n%s' % (mod, e)
4170
if len(doc_suite._tests) == 0:
4171
raise errors.BzrError("no doctests found in %s" % (mod,))
4172
suite.addTest(doc_suite)
4174
default_encoding = sys.getdefaultencoding()
4175
for name, plugin in _mod_plugin.plugins().items():
4176
if not interesting_module(plugin.module.__name__):
4178
plugin_suite = plugin.test_suite()
4179
# We used to catch ImportError here and turn it into just a warning,
4180
# but really if you don't have --no-plugins this should be a failure.
4181
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4182
if plugin_suite is None:
4183
plugin_suite = plugin.load_plugin_tests(loader)
4184
if plugin_suite is not None:
4185
suite.addTest(plugin_suite)
4186
if default_encoding != sys.getdefaultencoding():
4188
'Plugin "%s" tried to reset default encoding to: %s', name,
4189
sys.getdefaultencoding())
4191
sys.setdefaultencoding(default_encoding)
4193
if keep_only is not None:
4194
# Now that the referred modules have loaded their tests, keep only the
4196
suite = filter_suite_by_id_list(suite, id_filter)
4197
# Do some sanity checks on the id_list filtering
4198
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4200
# The tester has used both keep_only and starting_with, so he is
4201
# already aware that some tests are excluded from the list, there
4202
# is no need to tell him which.
4205
# Some tests mentioned in the list are not in the test suite. The
4206
# list may be out of date, report to the tester.
4207
for id in not_found:
4208
trace.warning('"%s" not found in the test suite', id)
4209
for id in duplicates:
4210
trace.warning('"%s" is used as an id by several tests', id)
4215
def multiply_scenarios(*scenarios):
4216
"""Multiply two or more iterables of scenarios.
4218
It is safe to pass scenario generators or iterators.
4220
:returns: A list of compound scenarios: the cross-product of all
4221
scenarios, with the names concatenated and the parameters
4224
return reduce(_multiply_two_scenarios, map(list, scenarios))
4227
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4228
"""Multiply two sets of scenarios.
4230
:returns: the cartesian product of the two sets of scenarios, that is
4231
a scenario for every possible combination of a left scenario and a
4235
('%s,%s' % (left_name, right_name),
4236
dict(left_dict.items() + right_dict.items()))
4237
for left_name, left_dict in scenarios_left
4238
for right_name, right_dict in scenarios_right]
4241
def multiply_tests(tests, scenarios, result):
4242
"""Multiply tests_list by scenarios into result.
4244
This is the core workhorse for test parameterisation.
4246
Typically the load_tests() method for a per-implementation test suite will
4247
call multiply_tests and return the result.
4249
:param tests: The tests to parameterise.
4250
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4251
scenario_param_dict).
4252
:param result: A TestSuite to add created tests to.
4254
This returns the passed in result TestSuite with the cross product of all
4255
the tests repeated once for each scenario. Each test is adapted by adding
4256
the scenario name at the end of its id(), and updating the test object's
4257
__dict__ with the scenario_param_dict.
4259
>>> import bzrlib.tests.test_sampler
4260
>>> r = multiply_tests(
4261
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4262
... [('one', dict(param=1)),
4263
... ('two', dict(param=2))],
4264
... TestUtil.TestSuite())
4265
>>> tests = list(iter_suite_tests(r))
4269
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4275
for test in iter_suite_tests(tests):
4276
apply_scenarios(test, scenarios, result)
4280
def apply_scenarios(test, scenarios, result):
4281
"""Apply the scenarios in scenarios to test and add to result.
4283
:param test: The test to apply scenarios to.
4284
:param scenarios: An iterable of scenarios to apply to test.
4286
:seealso: apply_scenario
4288
for scenario in scenarios:
4289
result.addTest(apply_scenario(test, scenario))
4293
def apply_scenario(test, scenario):
4294
"""Copy test and apply scenario to it.
4296
:param test: A test to adapt.
4297
:param scenario: A tuple describing the scenarion.
4298
The first element of the tuple is the new test id.
4299
The second element is a dict containing attributes to set on the
4301
:return: The adapted test.
4303
new_id = "%s(%s)" % (test.id(), scenario[0])
4304
new_test = clone_test(test, new_id)
4305
for name, value in scenario[1].items():
4306
setattr(new_test, name, value)
4310
def clone_test(test, new_id):
4311
"""Clone a test giving it a new id.
4313
:param test: The test to clone.
4314
:param new_id: The id to assign to it.
4315
:return: The new test.
4317
new_test = copy.copy(test)
4318
new_test.id = lambda: new_id
4319
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4320
# causes cloned tests to share the 'details' dict. This makes it hard to
4321
# read the test output for parameterized tests, because tracebacks will be
4322
# associated with irrelevant tests.
4324
details = new_test._TestCase__details
4325
except AttributeError:
4326
# must be a different version of testtools than expected. Do nothing.
4329
# Reset the '__details' dict.
4330
new_test._TestCase__details = {}
4334
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4336
"""Helper for permutating tests against an extension module.
4338
This is meant to be used inside a modules 'load_tests()' function. It will
4339
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4340
against both implementations. Setting 'test.module' to the appropriate
4341
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4343
:param standard_tests: A test suite to permute
4344
:param loader: A TestLoader
4345
:param py_module_name: The python path to a python module that can always
4346
be loaded, and will be considered the 'python' implementation. (eg
4347
'bzrlib._chk_map_py')
4348
:param ext_module_name: The python path to an extension module. If the
4349
module cannot be loaded, a single test will be added, which notes that
4350
the module is not available. If it can be loaded, all standard_tests
4351
will be run against that module.
4352
:return: (suite, feature) suite is a test-suite that has all the permuted
4353
tests. feature is the Feature object that can be used to determine if
4354
the module is available.
4357
from bzrlib.tests.features import ModuleAvailableFeature
4358
py_module = pyutils.get_named_object(py_module_name)
4360
('python', {'module': py_module}),
4362
suite = loader.suiteClass()
4363
feature = ModuleAvailableFeature(ext_module_name)
4364
if feature.available():
4365
scenarios.append(('C', {'module': feature.module}))
4367
# the compiled module isn't available, so we add a failing test
4368
class FailWithoutFeature(TestCase):
4369
def test_fail(self):
4370
self.requireFeature(feature)
4371
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4372
result = multiply_tests(standard_tests, scenarios, suite)
4373
return result, feature
4376
def _rmtree_temp_dir(dirname, test_id=None):
4377
# If LANG=C we probably have created some bogus paths
4378
# which rmtree(unicode) will fail to delete
4379
# so make sure we are using rmtree(str) to delete everything
4380
# except on win32, where rmtree(str) will fail
4381
# since it doesn't have the property of byte-stream paths
4382
# (they are either ascii or mbcs)
4383
if sys.platform == 'win32':
4384
# make sure we are using the unicode win32 api
4385
dirname = unicode(dirname)
4387
dirname = dirname.encode(sys.getfilesystemencoding())
4389
osutils.rmtree(dirname)
4391
# We don't want to fail here because some useful display will be lost
4392
# otherwise. Polluting the tmp dir is bad, but not giving all the
4393
# possible info to the test runner is even worse.
4395
ui.ui_factory.clear_term()
4396
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4397
# Ugly, but the last thing we want here is fail, so bear with it.
4398
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4399
).encode('ascii', 'replace')
4400
sys.stderr.write('Unable to remove testing dir %s\n%s'
4401
% (os.path.basename(dirname), printable_e))
4404
def probe_unicode_in_user_encoding():
4405
"""Try to encode several unicode strings to use in unicode-aware tests.
4406
Return first successfull match.
4408
:return: (unicode value, encoded plain string value) or (None, None)
4410
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4411
for uni_val in possible_vals:
4413
str_val = uni_val.encode(osutils.get_user_encoding())
4414
except UnicodeEncodeError:
4415
# Try a different character
4418
return uni_val, str_val
4422
def probe_bad_non_ascii(encoding):
4423
"""Try to find [bad] character with code [128..255]
4424
that cannot be decoded to unicode in some encoding.
4425
Return None if all non-ascii characters is valid
4428
for i in xrange(128, 256):
4431
char.decode(encoding)
4432
except UnicodeDecodeError:
4437
# Only define SubUnitBzrRunner if subunit is available.
4439
from subunit import TestProtocolClient
4440
from subunit.test_results import AutoTimingTestResultDecorator
4441
class SubUnitBzrProtocolClient(TestProtocolClient):
4443
def stopTest(self, test):
4444
super(SubUnitBzrProtocolClient, self).stopTest(test)
4445
_clear__type_equality_funcs(test)
4447
def addSuccess(self, test, details=None):
4448
# The subunit client always includes the details in the subunit
4449
# stream, but we don't want to include it in ours.
4450
if details is not None and 'log' in details:
4452
return super(SubUnitBzrProtocolClient, self).addSuccess(
4455
class SubUnitBzrRunner(TextTestRunner):
4456
def run(self, test):
4457
result = AutoTimingTestResultDecorator(
4458
SubUnitBzrProtocolClient(self.stream))
4465
@deprecated_function(deprecated_in((2, 5, 0)))
4466
def ModuleAvailableFeature(name):
4467
from bzrlib.tests import features
4468
return features.ModuleAvailableFeature(name)
added
removed
bzrlib/tests/__init__.py
