1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Testing framework extensions"""
19
from __future__ import absolute_import
21
# NOTE: Some classes in here use camelCaseNaming() rather than
22
# underscore_naming(). That's for consistency with unittest; it's not the
23
# general style of bzrlib. Please continue that consistency when adding e.g.
24
# new assertFoo() methods.
29
from cStringIO import StringIO
53
# nb: check this before importing anything else from within it
54
_testtools_version = getattr(testtools, '__version__', ())
55
if _testtools_version < (0, 9, 5):
56
raise ImportError("need at least testtools 0.9.5: %s is %r"
57
% (testtools.__file__, _testtools_version))
58
from testtools import content
65
commands as _mod_commands,
75
plugin as _mod_plugin,
82
transport as _mod_transport,
88
# lsprof not available
90
from bzrlib.smart import client, request
91
from bzrlib.transport import (
95
from bzrlib.symbol_versioning import (
99
from bzrlib.tests import (
105
from bzrlib.ui import NullProgressView
106
from bzrlib.ui.text import TextUIFactory
107
from bzrlib.tests.features import _CompatabilityThunkFeature
109
# Mark this python module as being part of the implementation
110
# of unittest: this gives us better tracebacks where the last
111
# shown frame is the test code, not our assertXYZ.
114
default_transport = test_server.LocalURLServer
117
_unitialized_attr = object()
118
"""A sentinel needed to act as a default value in a method signature."""
121
# Subunit result codes, defined here to prevent a hard dependency on subunit.
125
# These are intentionally brought into this namespace. That way plugins, etc
126
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
127
TestSuite = TestUtil.TestSuite
128
TestLoader = TestUtil.TestLoader
130
# Tests should run in a clean and clearly defined environment. The goal is to
131
# keep them isolated from the running environment as mush as possible. The test
132
# framework ensures the variables defined below are set (or deleted if the
133
# value is None) before a test is run and reset to their original value after
134
# the test is run. Generally if some code depends on an environment variable,
135
# the tests should start without this variable in the environment. There are a
136
# few exceptions but you shouldn't violate this rule lightly.
140
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
141
# tests do check our impls match APPDATA
142
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
146
'BZREMAIL': None, # may still be present in the environment
147
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
148
'BZR_PROGRESS_BAR': None,
149
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
150
# as a base class instead of TestCaseInTempDir. Tests inheriting from
151
# TestCase should not use disk resources, BZR_LOG is one.
152
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
153
'BZR_PLUGIN_PATH': None,
154
'BZR_DISABLE_PLUGINS': None,
155
'BZR_PLUGINS_AT': None,
156
'BZR_CONCURRENCY': None,
157
# Make sure that any text ui tests are consistent regardless of
158
# the environment the test case is run in; you may want tests that
159
# test other combinations. 'dumb' is a reasonable guess for tests
160
# going to a pipe or a StringIO.
166
'SSH_AUTH_SOCK': None,
176
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
177
# least. If you do (care), please update this comment
181
'BZR_REMOTE_PATH': None,
182
# Generally speaking, we don't want apport reporting on crashes in
183
# the test envirnoment unless we're specifically testing apport,
184
# so that it doesn't leak into the real system environment. We
185
# use an env var so it propagates to subprocesses.
186
'APPORT_DISABLE': '1',
190
def override_os_environ(test, env=None):
191
"""Modify os.environ keeping a copy.
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)
193
:param test: A test instance
195
:param env: A dict containing variable definitions to be installed
198
env = isolated_environ
199
test._original_os_environ = dict([(var, value)
200
for var, value in os.environ.iteritems()])
201
for var, value in env.iteritems():
202
osutils.set_or_unset_env(var, value)
203
if var not in test._original_os_environ:
204
# The var is new, add it with a value of None, so
205
# restore_os_environ will delete it
206
test._original_os_environ[var] = None
209
def restore_os_environ(test):
210
"""Restore os.environ to its original state.
212
:param test: A test instance previously passed to override_os_environ.
214
for var, value in test._original_os_environ.iteritems():
215
# Restore the original value (or delete it if the value has been set to
216
# None in override_os_environ).
217
osutils.set_or_unset_env(var, value)
220
def _clear__type_equality_funcs(test):
221
"""Cleanup bound methods stored on TestCase instances
223
Clear the dict breaking a few (mostly) harmless cycles in the affected
224
unittests released with Python 2.6 and initial Python 2.7 versions.
226
For a few revisions between Python 2.7.1 and Python 2.7.2 that annoyingly
227
shipped in Oneiric, an object with no clear method was used, hence the
228
extra complications, see bug 809048 for details.
230
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
231
if type_equality_funcs is not None:
232
tef_clear = getattr(type_equality_funcs, "clear", None)
233
if tef_clear is None:
234
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
235
if tef_instance_dict is not None:
236
tef_clear = tef_instance_dict.clear
237
if tef_clear is not None:
241
class ExtendedTestResult(testtools.TextTestResult):
242
"""Accepts, reports and accumulates the results of running tests.
244
Compared to the unittest version this class adds support for
245
profiling, benchmarking, stopping as soon as a test fails, and
246
skipping tests. There are further-specialized subclasses for
247
different types of display.
249
When a test finishes, in whatever way, it calls one of the addSuccess,
250
addFailure or addError classes. These in turn may redirect to a more
251
specific case for the special test results supported by our extended
254
Note that just one of these objects is fed the results from many tests.
259
def __init__(self, stream, descriptions, verbosity,
263
"""Construct new TestResult.
265
:param bench_history: Optionally, a writable file object to accumulate
268
testtools.TextTestResult.__init__(self, stream)
269
if bench_history is not None:
270
from bzrlib.version import _get_bzr_source_tree
271
src_tree = _get_bzr_source_tree()
274
revision_id = src_tree.get_parent_ids()[0]
276
# XXX: if this is a brand new tree, do the same as if there
280
# XXX: If there's no branch, what should we do?
282
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
283
self._bench_history = bench_history
284
self.ui = ui.ui_factory
287
self.failure_count = 0
288
self.known_failure_count = 0
290
self.not_applicable_count = 0
291
self.unsupported = {}
293
self._overall_start_time = time.time()
294
self._strict = strict
295
self._first_thread_leaker_id = None
296
self._tests_leaking_threads_count = 0
297
self._traceback_from_test = None
299
def stopTestRun(self):
302
stopTime = time.time()
303
timeTaken = stopTime - self.startTime
304
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
305
# the parent class method is similar have to duplicate
306
self._show_list('ERROR', self.errors)
307
self._show_list('FAIL', self.failures)
308
self.stream.write(self.sep2)
309
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
310
run, run != 1 and "s" or "", timeTaken))
311
if not self.wasSuccessful():
312
self.stream.write("FAILED (")
313
failed, errored = map(len, (self.failures, self.errors))
315
self.stream.write("failures=%d" % failed)
317
if failed: self.stream.write(", ")
318
self.stream.write("errors=%d" % errored)
319
if self.known_failure_count:
320
if failed or errored: self.stream.write(", ")
321
self.stream.write("known_failure_count=%d" %
322
self.known_failure_count)
323
self.stream.write(")\n")
325
if self.known_failure_count:
326
self.stream.write("OK (known_failures=%d)\n" %
327
self.known_failure_count)
329
self.stream.write("OK\n")
330
if self.skip_count > 0:
331
skipped = self.skip_count
332
self.stream.write('%d test%s skipped\n' %
333
(skipped, skipped != 1 and "s" or ""))
335
for feature, count in sorted(self.unsupported.items()):
336
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
339
ok = self.wasStrictlySuccessful()
341
ok = self.wasSuccessful()
342
if self._first_thread_leaker_id:
344
'%s is leaking threads among %d leaking tests.\n' % (
345
self._first_thread_leaker_id,
346
self._tests_leaking_threads_count))
347
# We don't report the main thread as an active one.
349
'%d non-main threads were left active in the end.\n'
350
% (len(self._active_threads) - 1))
352
def getDescription(self, test):
355
def _extractBenchmarkTime(self, testCase, details=None):
356
"""Add a benchmark time for the current test case."""
357
if details and 'benchtime' in details:
358
return float(''.join(details['benchtime'].iter_bytes()))
359
return getattr(testCase, "_benchtime", None)
361
def _elapsedTestTimeString(self):
362
"""Return a time string for the overall time the current test has taken."""
363
return self._formatTime(self._delta_to_float(
364
self._now() - self._start_datetime))
366
def _testTimeString(self, testCase):
367
benchmark_time = self._extractBenchmarkTime(testCase)
368
if benchmark_time is not None:
369
return self._formatTime(benchmark_time) + "*"
371
return self._elapsedTestTimeString()
373
def _formatTime(self, seconds):
374
"""Format seconds as milliseconds with leading spaces."""
375
# some benchmarks can take thousands of seconds to run, so we need 8
377
return "%8dms" % (1000 * seconds)
379
def _shortened_test_description(self, test):
381
what = re.sub(r'^bzrlib\.tests\.', '', what)
384
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
385
# multiple times in a row, because the handler is added for
386
# each test but the container list is shared between cases.
387
# See lp:498869 lp:625574 and lp:637725 for background.
388
def _record_traceback_from_test(self, exc_info):
389
"""Store the traceback from passed exc_info tuple till"""
390
self._traceback_from_test = exc_info[2]
392
def startTest(self, test):
393
super(ExtendedTestResult, self).startTest(test)
397
self.report_test_start(test)
398
test.number = self.count
399
self._recordTestStartTime()
400
# Make testtools cases give us the real traceback on failure
401
addOnException = getattr(test, "addOnException", None)
402
if addOnException is not None:
403
addOnException(self._record_traceback_from_test)
404
# Only check for thread leaks on bzrlib derived test cases
405
if isinstance(test, TestCase):
406
test.addCleanup(self._check_leaked_threads, test)
408
def stopTest(self, test):
409
super(ExtendedTestResult, self).stopTest(test)
410
# Manually break cycles, means touching various private things but hey
411
getDetails = getattr(test, "getDetails", None)
412
if getDetails is not None:
414
_clear__type_equality_funcs(test)
415
self._traceback_from_test = None
417
def startTests(self):
418
self.report_tests_starting()
419
self._active_threads = threading.enumerate()
421
def _check_leaked_threads(self, test):
422
"""See if any threads have leaked since last call
424
A sample of live threads is stored in the _active_threads attribute,
425
when this method runs it compares the current live threads and any not
426
in the previous sample are treated as having leaked.
428
now_active_threads = set(threading.enumerate())
429
threads_leaked = now_active_threads.difference(self._active_threads)
431
self._report_thread_leak(test, threads_leaked, now_active_threads)
432
self._tests_leaking_threads_count += 1
433
if self._first_thread_leaker_id is None:
434
self._first_thread_leaker_id = test.id()
435
self._active_threads = now_active_threads
437
def _recordTestStartTime(self):
438
"""Record that a test has started."""
439
self._start_datetime = self._now()
441
def addError(self, test, err):
442
"""Tell result that test finished with an error.
444
Called from the TestCase run() method when the test
445
fails with an unexpected error.
447
self._post_mortem(self._traceback_from_test)
448
super(ExtendedTestResult, self).addError(test, err)
449
self.error_count += 1
450
self.report_error(test, err)
454
def addFailure(self, test, err):
455
"""Tell result that test failed.
457
Called from the TestCase run() method when the test
458
fails because e.g. an assert() method failed.
460
self._post_mortem(self._traceback_from_test)
461
super(ExtendedTestResult, self).addFailure(test, err)
462
self.failure_count += 1
463
self.report_failure(test, err)
467
def addSuccess(self, test, details=None):
468
"""Tell result that test completed successfully.
470
Called from the TestCase run()
472
if self._bench_history is not None:
473
benchmark_time = self._extractBenchmarkTime(test, details)
474
if benchmark_time is not None:
475
self._bench_history.write("%s %s\n" % (
476
self._formatTime(benchmark_time),
478
self.report_success(test)
479
super(ExtendedTestResult, self).addSuccess(test)
480
test._log_contents = ''
482
def addExpectedFailure(self, test, err):
483
self.known_failure_count += 1
484
self.report_known_failure(test, err)
486
def addUnexpectedSuccess(self, test, details=None):
487
"""Tell result the test unexpectedly passed, counting as a failure
489
When the minimum version of testtools required becomes 0.9.8 this
490
can be updated to use the new handling there.
492
super(ExtendedTestResult, self).addFailure(test, details=details)
493
self.failure_count += 1
494
self.report_unexpected_success(test,
495
"".join(details["reason"].iter_text()))
499
def addNotSupported(self, test, feature):
500
"""The test will not be run because of a missing feature.
502
# this can be called in two different ways: it may be that the
503
# test started running, and then raised (through requireFeature)
504
# UnavailableFeature. Alternatively this method can be called
505
# while probing for features before running the test code proper; in
506
# that case we will see startTest and stopTest, but the test will
507
# never actually run.
508
self.unsupported.setdefault(str(feature), 0)
509
self.unsupported[str(feature)] += 1
510
self.report_unsupported(test, feature)
512
def addSkip(self, test, reason):
513
"""A test has not run for 'reason'."""
515
self.report_skip(test, reason)
517
def addNotApplicable(self, test, reason):
518
self.not_applicable_count += 1
519
self.report_not_applicable(test, reason)
521
def _count_stored_tests(self):
522
"""Count of tests instances kept alive due to not succeeding"""
523
return self.error_count + self.failure_count + self.known_failure_count
525
def _post_mortem(self, tb=None):
526
"""Start a PDB post mortem session."""
527
if os.environ.get('BZR_TEST_PDB', None):
531
def progress(self, offset, whence):
532
"""The test is adjusting the count of tests to run."""
533
if whence == SUBUNIT_SEEK_SET:
534
self.num_tests = offset
535
elif whence == SUBUNIT_SEEK_CUR:
536
self.num_tests += offset
538
raise errors.BzrError("Unknown whence %r" % whence)
540
def report_tests_starting(self):
541
"""Display information before the test run begins"""
542
if getattr(sys, 'frozen', None) is None:
543
bzr_path = osutils.realpath(sys.argv[0])
545
bzr_path = sys.executable
547
'bzr selftest: %s\n' % (bzr_path,))
550
bzrlib.__path__[0],))
552
' bzr-%s python-%s %s\n' % (
553
bzrlib.version_string,
554
bzrlib._format_version_tuple(sys.version_info),
555
platform.platform(aliased=1),
557
self.stream.write('\n')
559
def report_test_start(self, test):
560
"""Display information on the test just about to be run"""
562
def _report_thread_leak(self, test, leaked_threads, active_threads):
563
"""Display information on a test that leaked one or more threads"""
564
# GZ 2010-09-09: A leak summary reported separately from the general
565
# thread debugging would be nice. Tests under subunit
566
# need something not using stream, perhaps adding a
567
# testtools details object would be fitting.
568
if 'threads' in selftest_debug_flags:
569
self.stream.write('%s is leaking, active is now %d\n' %
570
(test.id(), len(active_threads)))
572
def startTestRun(self):
573
self.startTime = time.time()
575
def report_success(self, test):
578
def wasStrictlySuccessful(self):
579
if self.unsupported or self.known_failure_count:
581
return self.wasSuccessful()
584
class TextTestResult(ExtendedTestResult):
585
"""Displays progress and results of tests in text form"""
587
def __init__(self, stream, descriptions, verbosity,
592
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
593
bench_history, strict)
594
# We no longer pass them around, but just rely on the UIFactory stack
597
warnings.warn("Passing pb to TextTestResult is deprecated")
598
self.pb = self.ui.nested_progress_bar()
599
self.pb.show_pct = False
600
self.pb.show_spinner = False
601
self.pb.show_eta = False,
602
self.pb.show_count = False
603
self.pb.show_bar = False
604
self.pb.update_latency = 0
605
self.pb.show_transport_activity = False
607
def stopTestRun(self):
608
# called when the tests that are going to run have run
611
super(TextTestResult, self).stopTestRun()
613
def report_tests_starting(self):
614
super(TextTestResult, self).report_tests_starting()
615
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
617
def _progress_prefix_text(self):
618
# the longer this text, the less space we have to show the test
620
a = '[%d' % self.count # total that have been run
621
# tests skipped as known not to be relevant are not important enough
623
## if self.skip_count:
624
## a += ', %d skip' % self.skip_count
625
## if self.known_failure_count:
626
## a += '+%dX' % self.known_failure_count
628
a +='/%d' % self.num_tests
630
runtime = time.time() - self._overall_start_time
632
a += '%dm%ds' % (runtime / 60, runtime % 60)
635
total_fail_count = self.error_count + self.failure_count
637
a += ', %d failed' % total_fail_count
638
# if self.unsupported:
639
# a += ', %d missing' % len(self.unsupported)
643
def report_test_start(self, test):
645
self._progress_prefix_text()
647
+ self._shortened_test_description(test))
649
def _test_description(self, test):
650
return self._shortened_test_description(test)
652
def report_error(self, test, err):
653
self.stream.write('ERROR: %s\n %s\n' % (
654
self._test_description(test),
658
def report_failure(self, test, err):
659
self.stream.write('FAIL: %s\n %s\n' % (
660
self._test_description(test),
664
def report_known_failure(self, test, err):
667
def report_unexpected_success(self, test, reason):
668
self.stream.write('FAIL: %s\n %s: %s\n' % (
669
self._test_description(test),
670
"Unexpected success. Should have failed",
674
def report_skip(self, test, reason):
677
def report_not_applicable(self, test, reason):
680
def report_unsupported(self, test, feature):
681
"""test cannot be run because feature is missing."""
684
class VerboseTestResult(ExtendedTestResult):
685
"""Produce long output, with one line per test run plus times"""
687
def _ellipsize_to_right(self, a_string, final_width):
688
"""Truncate and pad a string, keeping the right hand side"""
689
if len(a_string) > final_width:
690
result = '...' + a_string[3-final_width:]
693
return result.ljust(final_width)
695
def report_tests_starting(self):
696
self.stream.write('running %d tests...\n' % self.num_tests)
697
super(VerboseTestResult, self).report_tests_starting()
699
def report_test_start(self, test):
700
name = self._shortened_test_description(test)
701
width = osutils.terminal_width()
702
if width is not None:
703
# width needs space for 6 char status, plus 1 for slash, plus an
704
# 11-char time string, plus a trailing blank
705
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
707
self.stream.write(self._ellipsize_to_right(name, width-18))
709
self.stream.write(name)
712
def _error_summary(self, err):
714
return '%s%s' % (indent, err[1])
716
def report_error(self, test, err):
717
self.stream.write('ERROR %s\n%s\n'
718
% (self._testTimeString(test),
719
self._error_summary(err)))
721
def report_failure(self, test, err):
722
self.stream.write(' FAIL %s\n%s\n'
723
% (self._testTimeString(test),
724
self._error_summary(err)))
726
def report_known_failure(self, test, err):
727
self.stream.write('XFAIL %s\n%s\n'
728
% (self._testTimeString(test),
729
self._error_summary(err)))
731
def report_unexpected_success(self, test, reason):
732
self.stream.write(' FAIL %s\n%s: %s\n'
733
% (self._testTimeString(test),
734
"Unexpected success. Should have failed",
737
def report_success(self, test):
738
self.stream.write(' OK %s\n' % self._testTimeString(test))
739
for bench_called, stats in getattr(test, '_benchcalls', []):
740
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
741
stats.pprint(file=self.stream)
742
# flush the stream so that we get smooth output. This verbose mode is
743
# used to show the output in PQM.
746
def report_skip(self, test, reason):
747
self.stream.write(' SKIP %s\n%s\n'
748
% (self._testTimeString(test), reason))
750
def report_not_applicable(self, test, reason):
751
self.stream.write(' N/A %s\n %s\n'
752
% (self._testTimeString(test), reason))
754
def report_unsupported(self, test, feature):
755
"""test cannot be run because feature is missing."""
756
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
757
%(self._testTimeString(test), feature))
760
class TextTestRunner(object):
761
stop_on_failure = False
769
result_decorators=None,
771
"""Create a TextTestRunner.
773
:param result_decorators: An optional list of decorators to apply
774
to the result object being used by the runner. Decorators are
775
applied left to right - the first element in the list is the
778
# stream may know claim to know to write unicode strings, but in older
779
# pythons this goes sufficiently wrong that it is a bad idea. (
780
# specifically a built in file with encoding 'UTF-8' will still try
781
# to encode using ascii.
782
new_encoding = osutils.get_terminal_encoding()
783
codec = codecs.lookup(new_encoding)
784
if type(codec) is tuple:
788
encode = codec.encode
789
# GZ 2010-09-08: Really we don't want to be writing arbitrary bytes,
790
# so should swap to the plain codecs.StreamWriter
791
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream,
793
stream.encoding = new_encoding
795
self.descriptions = descriptions
796
self.verbosity = verbosity
797
self._bench_history = bench_history
798
self._strict = strict
799
self._result_decorators = result_decorators or []
802
"Run the given test case or test suite."
803
if self.verbosity == 1:
804
result_class = TextTestResult
805
elif self.verbosity >= 2:
806
result_class = VerboseTestResult
807
original_result = result_class(self.stream,
810
bench_history=self._bench_history,
813
# Signal to result objects that look at stop early policy to stop,
814
original_result.stop_early = self.stop_on_failure
815
result = original_result
816
for decorator in self._result_decorators:
817
result = decorator(result)
818
result.stop_early = self.stop_on_failure
819
result.startTestRun()
824
# higher level code uses our extended protocol to determine
825
# what exit code to give.
826
return original_result
829
def iter_suite_tests(suite):
830
"""Return all tests in a suite, recursing through nested suites"""
831
if isinstance(suite, unittest.TestCase):
833
elif isinstance(suite, unittest.TestSuite):
835
for r in iter_suite_tests(item):
838
raise Exception('unknown type %r for object %r'
839
% (type(suite), suite))
842
TestSkipped = testtools.testcase.TestSkipped
845
class TestNotApplicable(TestSkipped):
846
"""A test is not applicable to the situation where it was run.
848
This is only normally raised by parameterized tests, if they find that
849
the instance they're constructed upon does not support one aspect
854
# traceback._some_str fails to format exceptions that have the default
855
# __str__ which does an implicit ascii conversion. However, repr() on those
856
# objects works, for all that its not quite what the doctor may have ordered.
857
def _clever_some_str(value):
862
return repr(value).replace('\\n', '\n')
864
return '<unprintable %s object>' % type(value).__name__
866
traceback._some_str = _clever_some_str
869
# deprecated - use self.knownFailure(), or self.expectFailure.
870
KnownFailure = testtools.testcase._ExpectedFailure
873
class UnavailableFeature(Exception):
874
"""A feature required for this test was not available.
876
This can be considered a specialised form of SkippedTest.
878
The feature should be used to construct the exception.
882
class StringIOWrapper(object):
883
"""A wrapper around cStringIO which just adds an encoding attribute.
885
Internally we can check sys.stdout to see what the output encoding
886
should be. However, cStringIO has no encoding attribute that we can
887
set. So we wrap it instead.
892
def __init__(self, s=None):
894
self.__dict__['_cstring'] = StringIO(s)
896
self.__dict__['_cstring'] = StringIO()
898
def __getattr__(self, name, getattr=getattr):
899
return getattr(self.__dict__['_cstring'], name)
901
def __setattr__(self, name, val):
902
if name == 'encoding':
903
self.__dict__['encoding'] = val
905
return setattr(self._cstring, name, val)
908
class TestUIFactory(TextUIFactory):
909
"""A UI Factory for testing.
911
Hide the progress bar but emit note()s.
913
Allows get_password to be tested without real tty attached.
915
See also CannedInputUIFactory which lets you provide programmatic input in
918
# TODO: Capture progress events at the model level and allow them to be
919
# observed by tests that care.
921
# XXX: Should probably unify more with CannedInputUIFactory or a
922
# particular configuration of TextUIFactory, or otherwise have a clearer
923
# idea of how they're supposed to be different.
924
# See https://bugs.launchpad.net/bzr/+bug/408213
926
def __init__(self, stdout=None, stderr=None, stdin=None):
927
if stdin is not None:
928
# We use a StringIOWrapper to be able to test various
929
# encodings, but the user is still responsible to
930
# encode the string and to set the encoding attribute
931
# of StringIOWrapper.
932
stdin = StringIOWrapper(stdin)
933
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
935
def get_non_echoed_password(self):
936
"""Get password from stdin without trying to handle the echo mode"""
937
password = self.stdin.readline()
940
if password[-1] == '\n':
941
password = password[:-1]
944
def make_progress_view(self):
945
return NullProgressView()
948
def isolated_doctest_setUp(test):
949
override_os_environ(test)
952
def isolated_doctest_tearDown(test):
953
restore_os_environ(test)
956
def IsolatedDocTestSuite(*args, **kwargs):
957
"""Overrides doctest.DocTestSuite to handle isolation.
959
The method is really a factory and users are expected to use it as such.
962
kwargs['setUp'] = isolated_doctest_setUp
963
kwargs['tearDown'] = isolated_doctest_tearDown
964
return doctest.DocTestSuite(*args, **kwargs)
967
class TestCase(testtools.TestCase):
968
"""Base class for bzr unit tests.
970
Tests that need access to disk resources should subclass
971
TestCaseInTempDir not TestCase.
973
Error and debug log messages are redirected from their usual
974
location into a temporary file, the contents of which can be
975
retrieved by _get_log(). We use a real OS file, not an in-memory object,
976
so that it can also capture file IO. When the test completes this file
977
is read into memory and removed from disk.
979
There are also convenience functions to invoke bzr's command-line
980
routine, and to build and check bzr trees.
982
In addition to the usual method of overriding tearDown(), this class also
983
allows subclasses to register cleanup functions via addCleanup, which are
984
run in order as the object is torn down. It's less likely this will be
985
accidentally overlooked.
989
# record lsprof data when performing benchmark calls.
990
_gather_lsprof_in_benchmarks = False
992
def __init__(self, methodName='testMethod'):
993
super(TestCase, self).__init__(methodName)
994
self._directory_isolation = True
995
self.exception_handlers.insert(0,
996
(UnavailableFeature, self._do_unsupported_or_skip))
997
self.exception_handlers.insert(0,
998
(TestNotApplicable, self._do_not_applicable))
1001
super(TestCase, self).setUp()
1003
timeout = config.GlobalStack().get('selftest.timeout')
1005
timeout_fixture = fixtures.TimeoutFixture(timeout)
1006
timeout_fixture.setUp()
1007
self.addCleanup(timeout_fixture.cleanUp)
1009
for feature in getattr(self, '_test_needs_features', []):
1010
self.requireFeature(feature)
1011
self._cleanEnvironment()
1013
if bzrlib.global_state is not None:
1014
self.overrideAttr(bzrlib.global_state, 'cmdline_overrides',
1015
config.CommandLineStore())
1018
self._startLogFile()
1019
self._benchcalls = []
1020
self._benchtime = None
1022
self._track_transports()
1024
self._clear_debug_flags()
1025
# Isolate global verbosity level, to make sure it's reproducible
1026
# between tests. We should get rid of this altogether: bug 656694. --
1028
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
1029
# Isolate config option expansion until its default value for bzrlib is
1030
# settled on or a the FIXME associated with _get_expand_default_value
1031
# is addressed -- vila 20110219
1032
self.overrideAttr(config, '_expand_default_value', None)
1033
self._log_files = set()
1034
# Each key in the ``_counters`` dict holds a value for a different
1035
# counter. When the test ends, addDetail() should be used to output the
1036
# counter values. This happens in install_counter_hook().
1038
if 'config_stats' in selftest_debug_flags:
1039
self._install_config_stats_hooks()
1040
# Do not use i18n for tests (unless the test reverses this)
1046
# The sys preserved stdin/stdout should allow blackbox tests debugging
1047
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
1048
).set_trace(sys._getframe().f_back)
1050
def discardDetail(self, name):
1051
"""Extend the addDetail, getDetails api so we can remove a detail.
1053
eg. bzr always adds the 'log' detail at startup, but we don't want to
1054
include it for skipped, xfail, etc tests.
1056
It is safe to call this for a detail that doesn't exist, in case this
1057
gets called multiple times.
1059
# We cheat. details is stored in __details which means we shouldn't
1060
# touch it. but getDetails() returns the dict directly, so we can
1062
details = self.getDetails()
1066
def install_counter_hook(self, hooks, name, counter_name=None):
1067
"""Install a counting hook.
1069
Any hook can be counted as long as it doesn't need to return a value.
1071
:param hooks: Where the hook should be installed.
1073
:param name: The hook name that will be counted.
1075
:param counter_name: The counter identifier in ``_counters``, defaults
1078
_counters = self._counters # Avoid closing over self
1079
if counter_name is None:
1081
if _counters.has_key(counter_name):
1082
raise AssertionError('%s is already used as a counter name'
1084
_counters[counter_name] = 0
1085
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1086
lambda: ['%d' % (_counters[counter_name],)]))
1087
def increment_counter(*args, **kwargs):
1088
_counters[counter_name] += 1
1089
label = 'count %s calls' % (counter_name,)
1090
hooks.install_named_hook(name, increment_counter, label)
1091
self.addCleanup(hooks.uninstall_named_hook, name, label)
1093
def _install_config_stats_hooks(self):
1094
"""Install config hooks to count hook calls.
1097
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1098
self.install_counter_hook(config.ConfigHooks, hook_name,
1099
'config.%s' % (hook_name,))
1101
# The OldConfigHooks are private and need special handling to protect
1102
# against recursive tests (tests that run other tests), so we just do
1103
# manually what registering them into _builtin_known_hooks will provide
1105
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1106
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1107
self.install_counter_hook(config.OldConfigHooks, hook_name,
1108
'old_config.%s' % (hook_name,))
1110
def _clear_debug_flags(self):
1111
"""Prevent externally set debug flags affecting tests.
1113
Tests that want to use debug flags can just set them in the
1114
debug_flags set during setup/teardown.
1116
# Start with a copy of the current debug flags we can safely modify.
1117
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1118
if 'allow_debug' not in selftest_debug_flags:
1119
debug.debug_flags.clear()
1120
if 'disable_lock_checks' not in selftest_debug_flags:
1121
debug.debug_flags.add('strict_locks')
1123
def _clear_hooks(self):
1124
# prevent hooks affecting tests
1125
known_hooks = hooks.known_hooks
1126
self._preserved_hooks = {}
1127
for key, (parent, name) in known_hooks.iter_parent_objects():
1128
current_hooks = getattr(parent, name)
1129
self._preserved_hooks[parent] = (name, current_hooks)
1130
self._preserved_lazy_hooks = hooks._lazy_hooks
1131
hooks._lazy_hooks = {}
1132
self.addCleanup(self._restoreHooks)
1133
for key, (parent, name) in known_hooks.iter_parent_objects():
1134
factory = known_hooks.get(key)
1135
setattr(parent, name, factory())
1136
# this hook should always be installed
1137
request._install_hook()
1139
def disable_directory_isolation(self):
1140
"""Turn off directory isolation checks."""
1141
self._directory_isolation = False
1143
def enable_directory_isolation(self):
1144
"""Enable directory isolation checks."""
1145
self._directory_isolation = True
1147
def _silenceUI(self):
1148
"""Turn off UI for duration of test"""
1149
# by default the UI is off; tests can turn it on if they want it.
1150
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1152
def _check_locks(self):
1153
"""Check that all lock take/release actions have been paired."""
1154
# We always check for mismatched locks. If a mismatch is found, we
1155
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1156
# case we just print a warning.
1158
acquired_locks = [lock for action, lock in self._lock_actions
1159
if action == 'acquired']
1160
released_locks = [lock for action, lock in self._lock_actions
1161
if action == 'released']
1162
broken_locks = [lock for action, lock in self._lock_actions
1163
if action == 'broken']
1164
# trivially, given the tests for lock acquistion and release, if we
1165
# have as many in each list, it should be ok. Some lock tests also
1166
# break some locks on purpose and should be taken into account by
1167
# considering that breaking a lock is just a dirty way of releasing it.
1168
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1170
'Different number of acquired and '
1171
'released or broken locks.\n'
1175
(acquired_locks, released_locks, broken_locks))
1176
if not self._lock_check_thorough:
1177
# Rather than fail, just warn
1178
print "Broken test %s: %s" % (self, message)
1182
def _track_locks(self):
1183
"""Track lock activity during tests."""
1184
self._lock_actions = []
1185
if 'disable_lock_checks' in selftest_debug_flags:
1186
self._lock_check_thorough = False
1188
self._lock_check_thorough = True
1190
self.addCleanup(self._check_locks)
1191
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1192
self._lock_acquired, None)
1193
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1194
self._lock_released, None)
1195
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1196
self._lock_broken, None)
1198
def _lock_acquired(self, result):
1199
self._lock_actions.append(('acquired', result))
1201
def _lock_released(self, result):
1202
self._lock_actions.append(('released', result))
1204
def _lock_broken(self, result):
1205
self._lock_actions.append(('broken', result))
1207
def permit_dir(self, name):
1208
"""Permit a directory to be used by this test. See permit_url."""
1209
name_transport = _mod_transport.get_transport_from_path(name)
1210
self.permit_url(name)
1211
self.permit_url(name_transport.base)
1213
def permit_url(self, url):
1214
"""Declare that url is an ok url to use in this test.
1216
Do this for memory transports, temporary test directory etc.
1218
Do not do this for the current working directory, /tmp, or any other
1219
preexisting non isolated url.
1221
if not url.endswith('/'):
1223
self._bzr_selftest_roots.append(url)
1225
def permit_source_tree_branch_repo(self):
1226
"""Permit the source tree bzr is running from to be opened.
1228
Some code such as bzrlib.version attempts to read from the bzr branch
1229
that bzr is executing from (if any). This method permits that directory
1230
to be used in the test suite.
1232
path = self.get_source_path()
1233
self.record_directory_isolation()
1236
workingtree.WorkingTree.open(path)
1237
except (errors.NotBranchError, errors.NoWorkingTree):
1238
raise TestSkipped('Needs a working tree of bzr sources')
1240
self.enable_directory_isolation()
1242
def _preopen_isolate_transport(self, transport):
1243
"""Check that all transport openings are done in the test work area."""
1244
while isinstance(transport, pathfilter.PathFilteringTransport):
1245
# Unwrap pathfiltered transports
1246
transport = transport.server.backing_transport.clone(
1247
transport._filter('.'))
1248
url = transport.base
1249
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1250
# urls it is given by prepending readonly+. This is appropriate as the
1251
# client shouldn't know that the server is readonly (or not readonly).
1252
# We could register all servers twice, with readonly+ prepending, but
1253
# that makes for a long list; this is about the same but easier to
1255
if url.startswith('readonly+'):
1256
url = url[len('readonly+'):]
1257
self._preopen_isolate_url(url)
1259
def _preopen_isolate_url(self, url):
1260
if not self._directory_isolation:
1262
if self._directory_isolation == 'record':
1263
self._bzr_selftest_roots.append(url)
1265
# This prevents all transports, including e.g. sftp ones backed on disk
1266
# from working unless they are explicitly granted permission. We then
1267
# depend on the code that sets up test transports to check that they are
1268
# appropriately isolated and enable their use by calling
1269
# self.permit_transport()
1270
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1271
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1272
% (url, self._bzr_selftest_roots))
1274
def record_directory_isolation(self):
1275
"""Gather accessed directories to permit later access.
1277
This is used for tests that access the branch bzr is running from.
1279
self._directory_isolation = "record"
1281
def start_server(self, transport_server, backing_server=None):
1282
"""Start transport_server for this test.
1284
This starts the server, registers a cleanup for it and permits the
1285
server's urls to be used.
1287
if backing_server is None:
1288
transport_server.start_server()
1290
transport_server.start_server(backing_server)
1291
self.addCleanup(transport_server.stop_server)
1292
# Obtain a real transport because if the server supplies a password, it
1293
# will be hidden from the base on the client side.
1294
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1295
# Some transport servers effectively chroot the backing transport;
1296
# others like SFTPServer don't - users of the transport can walk up the
1297
# transport to read the entire backing transport. This wouldn't matter
1298
# except that the workdir tests are given - and that they expect the
1299
# server's url to point at - is one directory under the safety net. So
1300
# Branch operations into the transport will attempt to walk up one
1301
# directory. Chrooting all servers would avoid this but also mean that
1302
# we wouldn't be testing directly against non-root urls. Alternatively
1303
# getting the test framework to start the server with a backing server
1304
# at the actual safety net directory would work too, but this then
1305
# means that the self.get_url/self.get_transport methods would need
1306
# to transform all their results. On balance its cleaner to handle it
1307
# here, and permit a higher url when we have one of these transports.
1308
if t.base.endswith('/work/'):
1309
# we have safety net/test root/work
1310
t = t.clone('../..')
1311
elif isinstance(transport_server,
1312
test_server.SmartTCPServer_for_testing):
1313
# The smart server adds a path similar to work, which is traversed
1314
# up from by the client. But the server is chrooted - the actual
1315
# backing transport is not escaped from, and VFS requests to the
1316
# root will error (because they try to escape the chroot).
1318
while t2.base != t.base:
1321
self.permit_url(t.base)
1323
def _track_transports(self):
1324
"""Install checks for transport usage."""
1325
# TestCase has no safe place it can write to.
1326
self._bzr_selftest_roots = []
1327
# Currently the easiest way to be sure that nothing is going on is to
1328
# hook into bzr dir opening. This leaves a small window of error for
1329
# transport tests, but they are well known, and we can improve on this
1331
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1332
self._preopen_isolate_transport, "Check bzr directories are safe.")
1334
def _ndiff_strings(self, a, b):
1335
"""Return ndiff between two strings containing lines.
1337
A trailing newline is added if missing to make the strings
1339
if b and b[-1] != '\n':
1341
if a and a[-1] != '\n':
1343
difflines = difflib.ndiff(a.splitlines(True),
1345
linejunk=lambda x: False,
1346
charjunk=lambda x: False)
1347
return ''.join(difflines)
1349
def assertEqual(self, a, b, message=''):
1353
except UnicodeError, e:
1354
# If we can't compare without getting a UnicodeError, then
1355
# obviously they are different
1356
trace.mutter('UnicodeError: %s', e)
1359
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1361
pprint.pformat(a), pprint.pformat(b)))
1363
assertEquals = assertEqual
1365
def assertEqualDiff(self, a, b, message=None):
1366
"""Assert two texts are equal, if not raise an exception.
1368
This is intended for use with multi-line strings where it can
1369
be hard to find the differences by eye.
1371
# TODO: perhaps override assertEquals to call this for strings?
1375
message = "texts not equal:\n"
1377
message = 'first string is missing a final newline.\n'
1379
message = 'second string is missing a final newline.\n'
1380
raise AssertionError(message +
1381
self._ndiff_strings(a, b))
1383
def assertEqualMode(self, mode, mode_test):
1384
self.assertEqual(mode, mode_test,
1385
'mode mismatch %o != %o' % (mode, mode_test))
1387
def assertEqualStat(self, expected, actual):
1388
"""assert that expected and actual are the same stat result.
1390
:param expected: A stat result.
1391
:param actual: A stat result.
1392
:raises AssertionError: If the expected and actual stat values differ
1393
other than by atime.
1395
self.assertEqual(expected.st_size, actual.st_size,
1396
'st_size did not match')
1397
self.assertEqual(expected.st_mtime, actual.st_mtime,
1398
'st_mtime did not match')
1399
self.assertEqual(expected.st_ctime, actual.st_ctime,
1400
'st_ctime did not match')
1401
if sys.platform == 'win32':
1402
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1403
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1404
# odd. We just force it to always be 0 to avoid any problems.
1405
self.assertEqual(0, expected.st_dev)
1406
self.assertEqual(0, actual.st_dev)
1407
self.assertEqual(0, expected.st_ino)
1408
self.assertEqual(0, actual.st_ino)
1410
self.assertEqual(expected.st_dev, actual.st_dev,
1411
'st_dev did not match')
1412
self.assertEqual(expected.st_ino, actual.st_ino,
1413
'st_ino did not match')
1414
self.assertEqual(expected.st_mode, actual.st_mode,
1415
'st_mode did not match')
1417
def assertLength(self, length, obj_with_len):
1418
"""Assert that obj_with_len is of length length."""
1419
if len(obj_with_len) != length:
1420
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1421
length, len(obj_with_len), obj_with_len))
1423
def assertLogsError(self, exception_class, func, *args, **kwargs):
1424
"""Assert that `func(*args, **kwargs)` quietly logs a specific error.
1427
orig_log_exception_quietly = trace.log_exception_quietly
1430
orig_log_exception_quietly()
1431
captured.append(sys.exc_info()[1])
1432
trace.log_exception_quietly = capture
1433
func(*args, **kwargs)
1435
trace.log_exception_quietly = orig_log_exception_quietly
1436
self.assertLength(1, captured)
1438
self.assertIsInstance(err, exception_class)
1441
def assertPositive(self, val):
1442
"""Assert that val is greater than 0."""
1443
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1445
def assertNegative(self, val):
1446
"""Assert that val is less than 0."""
1447
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1449
def assertStartsWith(self, s, prefix):
1450
if not s.startswith(prefix):
1451
raise AssertionError('string %r does not start with %r' % (s, prefix))
1453
def assertEndsWith(self, s, suffix):
1454
"""Asserts that s ends with suffix."""
1455
if not s.endswith(suffix):
1456
raise AssertionError('string %r does not end with %r' % (s, suffix))
1458
def assertContainsRe(self, haystack, needle_re, flags=0):
1459
"""Assert that a contains something matching a regular expression."""
1460
if not re.search(needle_re, haystack, flags):
1461
if '\n' in haystack or len(haystack) > 60:
1462
# a long string, format it in a more readable way
1463
raise AssertionError(
1464
'pattern "%s" not found in\n"""\\\n%s"""\n'
1465
% (needle_re, haystack))
1467
raise AssertionError('pattern "%s" not found in "%s"'
1468
% (needle_re, haystack))
1470
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1471
"""Assert that a does not match a regular expression"""
1472
if re.search(needle_re, haystack, flags):
1473
raise AssertionError('pattern "%s" found in "%s"'
1474
% (needle_re, haystack))
1476
def assertContainsString(self, haystack, needle):
1477
if haystack.find(needle) == -1:
1478
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1480
def assertNotContainsString(self, haystack, needle):
1481
if haystack.find(needle) != -1:
1482
self.fail("string %r found in '''%s'''" % (needle, haystack))
1484
def assertSubset(self, sublist, superlist):
1485
"""Assert that every entry in sublist is present in superlist."""
1486
missing = set(sublist) - set(superlist)
1487
if len(missing) > 0:
1488
raise AssertionError("value(s) %r not present in container %r" %
1489
(missing, superlist))
1491
def assertListRaises(self, excClass, func, *args, **kwargs):
1492
"""Fail unless excClass is raised when the iterator from func is used.
1494
Many functions can return generators this makes sure
1495
to wrap them in a list() call to make sure the whole generator
1496
is run, and that the proper exception is raised.
1499
list(func(*args, **kwargs))
1503
if getattr(excClass,'__name__', None) is not None:
1504
excName = excClass.__name__
1506
excName = str(excClass)
1507
raise self.failureException, "%s not raised" % excName
1509
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1510
"""Assert that a callable raises a particular exception.
1512
:param excClass: As for the except statement, this may be either an
1513
exception class, or a tuple of classes.
1514
:param callableObj: A callable, will be passed ``*args`` and
1517
Returns the exception so that you can examine it.
1520
callableObj(*args, **kwargs)
1524
if getattr(excClass,'__name__', None) is not None:
1525
excName = excClass.__name__
1528
excName = str(excClass)
1529
raise self.failureException, "%s not raised" % excName
1531
def assertIs(self, left, right, message=None):
1532
if not (left is right):
1533
if message is not None:
1534
raise AssertionError(message)
1536
raise AssertionError("%r is not %r." % (left, right))
1538
def assertIsNot(self, left, right, message=None):
1540
if message is not None:
1541
raise AssertionError(message)
1543
raise AssertionError("%r is %r." % (left, right))
1545
def assertTransportMode(self, transport, path, mode):
1546
"""Fail if a path does not have mode "mode".
1548
If modes are not supported on this transport, the assertion is ignored.
1550
if not transport._can_roundtrip_unix_modebits():
1552
path_stat = transport.stat(path)
1553
actual_mode = stat.S_IMODE(path_stat.st_mode)
1554
self.assertEqual(mode, actual_mode,
1555
'mode of %r incorrect (%s != %s)'
1556
% (path, oct(mode), oct(actual_mode)))
1558
def assertIsSameRealPath(self, path1, path2):
1559
"""Fail if path1 and path2 points to different files"""
1560
self.assertEqual(osutils.realpath(path1),
1561
osutils.realpath(path2),
1562
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1564
def assertIsInstance(self, obj, kls, msg=None):
1565
"""Fail if obj is not an instance of kls
1567
:param msg: Supplementary message to show if the assertion fails.
1569
if not isinstance(obj, kls):
1570
m = "%r is an instance of %s rather than %s" % (
1571
obj, obj.__class__, kls)
1576
def assertFileEqual(self, content, path):
1577
"""Fail if path does not contain 'content'."""
1578
self.assertPathExists(path)
1579
f = file(path, 'rb')
1584
self.assertEqualDiff(content, s)
1586
def assertDocstring(self, expected_docstring, obj):
1587
"""Fail if obj does not have expected_docstring"""
1589
# With -OO the docstring should be None instead
1590
self.assertIs(obj.__doc__, None)
1592
self.assertEqual(expected_docstring, obj.__doc__)
1594
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1595
def failUnlessExists(self, path):
1596
return self.assertPathExists(path)
1598
def assertPathExists(self, path):
1599
"""Fail unless path or paths, which may be abs or relative, exist."""
1600
if not isinstance(path, basestring):
1602
self.assertPathExists(p)
1604
self.assertTrue(osutils.lexists(path),
1605
path + " does not exist")
1607
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1608
def failIfExists(self, path):
1609
return self.assertPathDoesNotExist(path)
1611
def assertPathDoesNotExist(self, path):
1612
"""Fail if path or paths, which may be abs or relative, exist."""
1613
if not isinstance(path, basestring):
1615
self.assertPathDoesNotExist(p)
1617
self.assertFalse(osutils.lexists(path),
1620
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1621
"""A helper for callDeprecated and applyDeprecated.
1623
:param a_callable: A callable to call.
1624
:param args: The positional arguments for the callable
1625
:param kwargs: The keyword arguments for the callable
1626
:return: A tuple (warnings, result). result is the result of calling
1627
a_callable(``*args``, ``**kwargs``).
1630
def capture_warnings(msg, cls=None, stacklevel=None):
1631
# we've hooked into a deprecation specific callpath,
1632
# only deprecations should getting sent via it.
1633
self.assertEqual(cls, DeprecationWarning)
1634
local_warnings.append(msg)
1635
original_warning_method = symbol_versioning.warn
1636
symbol_versioning.set_warning_method(capture_warnings)
1638
result = a_callable(*args, **kwargs)
1640
symbol_versioning.set_warning_method(original_warning_method)
1641
return (local_warnings, result)
1643
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1644
"""Call a deprecated callable without warning the user.
1646
Note that this only captures warnings raised by symbol_versioning.warn,
1647
not other callers that go direct to the warning module.
1649
To test that a deprecated method raises an error, do something like
1650
this (remember that both assertRaises and applyDeprecated delays *args
1651
and **kwargs passing)::
1653
self.assertRaises(errors.ReservedId,
1654
self.applyDeprecated,
1655
deprecated_in((1, 5, 0)),
1659
:param deprecation_format: The deprecation format that the callable
1660
should have been deprecated with. This is the same type as the
1661
parameter to deprecated_method/deprecated_function. If the
1662
callable is not deprecated with this format, an assertion error
1664
:param a_callable: A callable to call. This may be a bound method or
1665
a regular function. It will be called with ``*args`` and
1667
:param args: The positional arguments for the callable
1668
:param kwargs: The keyword arguments for the callable
1669
:return: The result of a_callable(``*args``, ``**kwargs``)
1671
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1673
expected_first_warning = symbol_versioning.deprecation_string(
1674
a_callable, deprecation_format)
1675
if len(call_warnings) == 0:
1676
self.fail("No deprecation warning generated by call to %s" %
1678
self.assertEqual(expected_first_warning, call_warnings[0])
1681
def callCatchWarnings(self, fn, *args, **kw):
1682
"""Call a callable that raises python warnings.
1684
The caller's responsible for examining the returned warnings.
1686
If the callable raises an exception, the exception is not
1687
caught and propagates up to the caller. In that case, the list
1688
of warnings is not available.
1690
:returns: ([warning_object, ...], fn_result)
1692
# XXX: This is not perfect, because it completely overrides the
1693
# warnings filters, and some code may depend on suppressing particular
1694
# warnings. It's the easiest way to insulate ourselves from -Werror,
1695
# though. -- Andrew, 20071062
1697
def _catcher(message, category, filename, lineno, file=None, line=None):
1698
# despite the name, 'message' is normally(?) a Warning subclass
1700
wlist.append(message)
1701
saved_showwarning = warnings.showwarning
1702
saved_filters = warnings.filters
1704
warnings.showwarning = _catcher
1705
warnings.filters = []
1706
result = fn(*args, **kw)
1708
warnings.showwarning = saved_showwarning
1709
warnings.filters = saved_filters
1710
return wlist, result
1712
def callDeprecated(self, expected, callable, *args, **kwargs):
1713
"""Assert that a callable is deprecated in a particular way.
1715
This is a very precise test for unusual requirements. The
1716
applyDeprecated helper function is probably more suited for most tests
1717
as it allows you to simply specify the deprecation format being used
1718
and will ensure that that is issued for the function being called.
1720
Note that this only captures warnings raised by symbol_versioning.warn,
1721
not other callers that go direct to the warning module. To catch
1722
general warnings, use callCatchWarnings.
1724
:param expected: a list of the deprecation warnings expected, in order
1725
:param callable: The callable to call
1726
:param args: The positional arguments for the callable
1727
:param kwargs: The keyword arguments for the callable
1729
call_warnings, result = self._capture_deprecation_warnings(callable,
1731
self.assertEqual(expected, call_warnings)
1734
def _startLogFile(self):
1735
"""Setup a in-memory target for bzr and testcase log messages"""
1736
pseudo_log_file = StringIO()
1737
def _get_log_contents_for_weird_testtools_api():
1738
return [pseudo_log_file.getvalue().decode(
1739
"utf-8", "replace").encode("utf-8")]
1740
self.addDetail("log", content.Content(content.ContentType("text",
1741
"plain", {"charset": "utf8"}),
1742
_get_log_contents_for_weird_testtools_api))
1743
self._log_file = pseudo_log_file
1744
self._log_memento = trace.push_log_file(self._log_file)
1745
self.addCleanup(self._finishLogFile)
1747
def _finishLogFile(self):
1748
"""Flush and dereference the in-memory log for this testcase"""
1749
if trace._trace_file:
1750
# flush the log file, to get all content
1751
trace._trace_file.flush()
1752
trace.pop_log_file(self._log_memento)
1753
# The logging module now tracks references for cleanup so discard ours
1754
del self._log_memento
1756
def thisFailsStrictLockCheck(self):
1757
"""It is known that this test would fail with -Dstrict_locks.
1759
By default, all tests are run with strict lock checking unless
1760
-Edisable_lock_checks is supplied. However there are some tests which
1761
we know fail strict locks at this point that have not been fixed.
1762
They should call this function to disable the strict checking.
1764
This should be used sparingly, it is much better to fix the locking
1765
issues rather than papering over the problem by calling this function.
1767
debug.debug_flags.discard('strict_locks')
1769
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1770
"""Overrides an object attribute restoring it after the test.
1772
:note: This should be used with discretion; you should think about
1773
whether it's better to make the code testable without monkey-patching.
1775
:param obj: The object that will be mutated.
1777
:param attr_name: The attribute name we want to preserve/override in
1780
:param new: The optional value we want to set the attribute to.
1782
:returns: The actual attr value.
1784
value = getattr(obj, attr_name)
1785
# The actual value is captured by the call below
1786
self.addCleanup(setattr, obj, attr_name, value)
1787
if new is not _unitialized_attr:
1788
setattr(obj, attr_name, new)
1791
def overrideEnv(self, name, new):
1792
"""Set an environment variable, and reset it after the test.
1794
:param name: The environment variable name.
1796
:param new: The value to set the variable to. If None, the
1797
variable is deleted from the environment.
1799
:returns: The actual variable value.
1801
value = osutils.set_or_unset_env(name, new)
1802
self.addCleanup(osutils.set_or_unset_env, name, value)
1805
def recordCalls(self, obj, attr_name):
1806
"""Monkeypatch in a wrapper that will record calls.
1808
The monkeypatch is automatically removed when the test concludes.
1810
:param obj: The namespace holding the reference to be replaced;
1811
typically a module, class, or object.
1812
:param attr_name: A string for the name of the attribute to
1814
:returns: A list that will be extended with one item every time the
1815
function is called, with a tuple of (args, kwargs).
1819
def decorator(*args, **kwargs):
1820
calls.append((args, kwargs))
1821
return orig(*args, **kwargs)
1822
orig = self.overrideAttr(obj, attr_name, decorator)
1825
def _cleanEnvironment(self):
1826
for name, value in isolated_environ.iteritems():
1827
self.overrideEnv(name, value)
1829
def _restoreHooks(self):
1830
for klass, (name, hooks) in self._preserved_hooks.items():
1831
setattr(klass, name, hooks)
1832
self._preserved_hooks.clear()
1833
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1834
self._preserved_lazy_hooks.clear()
1836
def knownFailure(self, reason):
1837
"""Declare that this test fails for a known reason
1839
Tests that are known to fail should generally be using expectedFailure
1840
with an appropriate reverse assertion if a change could cause the test
1841
to start passing. Conversely if the test has no immediate prospect of
1842
succeeding then using skip is more suitable.
1844
When this method is called while an exception is being handled, that
1845
traceback will be used, otherwise a new exception will be thrown to
1846
provide one but won't be reported.
1848
self._add_reason(reason)
1850
exc_info = sys.exc_info()
1851
if exc_info != (None, None, None):
1852
self._report_traceback(exc_info)
1855
raise self.failureException(reason)
1856
except self.failureException:
1857
exc_info = sys.exc_info()
1858
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1859
raise testtools.testcase._ExpectedFailure(exc_info)
1863
def _suppress_log(self):
1864
"""Remove the log info from details."""
1865
self.discardDetail('log')
1867
def _do_skip(self, result, reason):
1868
self._suppress_log()
1869
addSkip = getattr(result, 'addSkip', None)
1870
if not callable(addSkip):
1871
result.addSuccess(result)
1873
addSkip(self, reason)
1876
def _do_known_failure(self, result, e):
1877
self._suppress_log()
1878
err = sys.exc_info()
1879
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1880
if addExpectedFailure is not None:
1881
addExpectedFailure(self, err)
1883
result.addSuccess(self)
1886
def _do_not_applicable(self, result, e):
1888
reason = 'No reason given'
1891
self._suppress_log ()
1892
addNotApplicable = getattr(result, 'addNotApplicable', None)
1893
if addNotApplicable is not None:
1894
result.addNotApplicable(self, reason)
1896
self._do_skip(result, reason)
1899
def _report_skip(self, result, err):
1900
"""Override the default _report_skip.
1902
We want to strip the 'log' detail. If we waint until _do_skip, it has
1903
already been formatted into the 'reason' string, and we can't pull it
1906
self._suppress_log()
1907
super(TestCase, self)._report_skip(self, result, err)
1910
def _report_expected_failure(self, result, err):
1913
See _report_skip for motivation.
1915
self._suppress_log()
1916
super(TestCase, self)._report_expected_failure(self, result, err)
1919
def _do_unsupported_or_skip(self, result, e):
1921
self._suppress_log()
1922
addNotSupported = getattr(result, 'addNotSupported', None)
1923
if addNotSupported is not None:
1924
result.addNotSupported(self, reason)
1926
self._do_skip(result, reason)
1928
def time(self, callable, *args, **kwargs):
1929
"""Run callable and accrue the time it takes to the benchmark time.
1931
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1932
this will cause lsprofile statistics to be gathered and stored in
1935
if self._benchtime is None:
1936
self.addDetail('benchtime', content.Content(content.ContentType(
1937
"text", "plain"), lambda:[str(self._benchtime)]))
1941
if not self._gather_lsprof_in_benchmarks:
1942
return callable(*args, **kwargs)
1944
# record this benchmark
1945
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1947
self._benchcalls.append(((callable, args, kwargs), stats))
1950
self._benchtime += time.time() - start
1952
def log(self, *args):
1956
"""Get a unicode string containing the log from bzrlib.trace.
1958
Undecodable characters are replaced.
1960
return u"".join(self.getDetails()['log'].iter_text())
1962
def requireFeature(self, feature):
1963
"""This test requires a specific feature is available.
1965
:raises UnavailableFeature: When feature is not available.
1967
if not feature.available():
1968
raise UnavailableFeature(feature)
1970
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1972
"""Run bazaar command line, splitting up a string command line."""
1973
if isinstance(args, basestring):
1974
# shlex don't understand unicode strings,
1975
# so args should be plain string (bialix 20070906)
1976
args = list(shlex.split(str(args)))
1977
return self._run_bzr_core(args, retcode=retcode,
1978
encoding=encoding, stdin=stdin, working_dir=working_dir,
1981
def _run_bzr_core(self, args, retcode, encoding, stdin,
1983
# Clear chk_map page cache, because the contents are likely to mask
1985
chk_map.clear_cache()
1986
if encoding is None:
1987
encoding = osutils.get_user_encoding()
1988
stdout = StringIOWrapper()
1989
stderr = StringIOWrapper()
1990
stdout.encoding = encoding
1991
stderr.encoding = encoding
1993
self.log('run bzr: %r', args)
1994
# FIXME: don't call into logging here
1995
handler = trace.EncodedStreamHandler(stderr, errors="replace",
1997
logger = logging.getLogger('')
1998
logger.addHandler(handler)
1999
old_ui_factory = ui.ui_factory
2000
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
2003
if working_dir is not None:
2004
cwd = osutils.getcwd()
2005
os.chdir(working_dir)
2009
result = self.apply_redirected(
2010
ui.ui_factory.stdin,
2012
_mod_commands.run_bzr_catch_user_errors,
2014
except KeyboardInterrupt:
2015
# Reraise KeyboardInterrupt with contents of redirected stdout
2016
# and stderr as arguments, for tests which are interested in
2017
# stdout and stderr and are expecting the exception.
2018
out = stdout.getvalue()
2019
err = stderr.getvalue()
2021
self.log('output:\n%r', out)
2023
self.log('errors:\n%r', err)
2024
raise KeyboardInterrupt(out, err)
2026
logger.removeHandler(handler)
2027
ui.ui_factory = old_ui_factory
2031
out = stdout.getvalue()
2032
err = stderr.getvalue()
2034
self.log('output:\n%r', out)
2036
self.log('errors:\n%r', err)
2037
if retcode is not None:
2038
self.assertEquals(retcode, result,
2039
message='Unexpected return code')
2040
return result, out, err
2042
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
2043
working_dir=None, error_regexes=[], output_encoding=None):
2044
"""Invoke bzr, as if it were run from the command line.
2046
The argument list should not include the bzr program name - the
2047
first argument is normally the bzr command. Arguments may be
2048
passed in three ways:
2050
1- A list of strings, eg ["commit", "a"]. This is recommended
2051
when the command contains whitespace or metacharacters, or
2052
is built up at run time.
2054
2- A single string, eg "add a". This is the most convenient
2055
for hardcoded commands.
2057
This runs bzr through the interface that catches and reports
2058
errors, and with logging set to something approximating the
2059
default, so that error reporting can be checked.
2061
This should be the main method for tests that want to exercise the
2062
overall behavior of the bzr application (rather than a unit test
2063
or a functional test of the library.)
2065
This sends the stdout/stderr results into the test's log,
2066
where it may be useful for debugging. See also run_captured.
2068
:keyword stdin: A string to be used as stdin for the command.
2069
:keyword retcode: The status code the command should return;
2071
:keyword working_dir: The directory to run the command in
2072
:keyword error_regexes: A list of expected error messages. If
2073
specified they must be seen in the error output of the command.
2075
retcode, out, err = self._run_bzr_autosplit(
2080
working_dir=working_dir,
2082
self.assertIsInstance(error_regexes, (list, tuple))
2083
for regex in error_regexes:
2084
self.assertContainsRe(err, regex)
2087
def run_bzr_error(self, error_regexes, *args, **kwargs):
2088
"""Run bzr, and check that stderr contains the supplied regexes
2090
:param error_regexes: Sequence of regular expressions which
2091
must each be found in the error output. The relative ordering
2093
:param args: command-line arguments for bzr
2094
:param kwargs: Keyword arguments which are interpreted by run_bzr
2095
This function changes the default value of retcode to be 3,
2096
since in most cases this is run when you expect bzr to fail.
2098
:return: (out, err) The actual output of running the command (in case
2099
you want to do more inspection)
2103
# Make sure that commit is failing because there is nothing to do
2104
self.run_bzr_error(['no changes to commit'],
2105
['commit', '-m', 'my commit comment'])
2106
# Make sure --strict is handling an unknown file, rather than
2107
# giving us the 'nothing to do' error
2108
self.build_tree(['unknown'])
2109
self.run_bzr_error(['Commit refused because there are unknown files'],
2110
['commit', --strict', '-m', 'my commit comment'])
2112
kwargs.setdefault('retcode', 3)
2113
kwargs['error_regexes'] = error_regexes
2114
out, err = self.run_bzr(*args, **kwargs)
2117
def run_bzr_subprocess(self, *args, **kwargs):
2118
"""Run bzr in a subprocess for testing.
2120
This starts a new Python interpreter and runs bzr in there.
2121
This should only be used for tests that have a justifiable need for
2122
this isolation: e.g. they are testing startup time, or signal
2123
handling, or early startup code, etc. Subprocess code can't be
2124
profiled or debugged so easily.
2126
:keyword retcode: The status code that is expected. Defaults to 0. If
2127
None is supplied, the status code is not checked.
2128
:keyword env_changes: A dictionary which lists changes to environment
2129
variables. A value of None will unset the env variable.
2130
The values must be strings. The change will only occur in the
2131
child, so you don't need to fix the environment after running.
2132
:keyword universal_newlines: Convert CRLF => LF
2133
:keyword allow_plugins: By default the subprocess is run with
2134
--no-plugins to ensure test reproducibility. Also, it is possible
2135
for system-wide plugins to create unexpected output on stderr,
2136
which can cause unnecessary test failures.
2138
env_changes = kwargs.get('env_changes', {})
2139
working_dir = kwargs.get('working_dir', None)
2140
allow_plugins = kwargs.get('allow_plugins', False)
2142
if isinstance(args[0], list):
2144
elif isinstance(args[0], basestring):
2145
args = list(shlex.split(args[0]))
2147
raise ValueError("passing varargs to run_bzr_subprocess")
2148
process = self.start_bzr_subprocess(args, env_changes=env_changes,
2149
working_dir=working_dir,
2150
allow_plugins=allow_plugins)
2151
# We distinguish between retcode=None and retcode not passed.
2152
supplied_retcode = kwargs.get('retcode', 0)
2153
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
2154
universal_newlines=kwargs.get('universal_newlines', False),
2157
def start_bzr_subprocess(self, process_args, env_changes=None,
2158
skip_if_plan_to_signal=False,
2160
allow_plugins=False, stderr=subprocess.PIPE):
2161
"""Start bzr in a subprocess for testing.
2163
This starts a new Python interpreter and runs bzr in there.
2164
This should only be used for tests that have a justifiable need for
2165
this isolation: e.g. they are testing startup time, or signal
2166
handling, or early startup code, etc. Subprocess code can't be
2167
profiled or debugged so easily.
2169
:param process_args: a list of arguments to pass to the bzr executable,
2170
for example ``['--version']``.
2171
:param env_changes: A dictionary which lists changes to environment
2172
variables. A value of None will unset the env variable.
2173
The values must be strings. The change will only occur in the
2174
child, so you don't need to fix the environment after running.
2175
:param skip_if_plan_to_signal: raise TestSkipped when true and system
2176
doesn't support signalling subprocesses.
2177
:param allow_plugins: If False (default) pass --no-plugins to bzr.
2178
:param stderr: file to use for the subprocess's stderr. Valid values
2179
are those valid for the stderr argument of `subprocess.Popen`.
2180
Default value is ``subprocess.PIPE``.
2182
:returns: Popen object for the started process.
2184
if skip_if_plan_to_signal:
2185
if os.name != "posix":
2186
raise TestSkipped("Sending signals not supported")
2188
if env_changes is None:
2190
# Because $HOME is set to a tempdir for the context of a test, modules
2191
# installed in the user dir will not be found unless $PYTHONUSERBASE
2192
# gets set to the computed directory of this parent process.
2193
if site.USER_BASE is not None:
2194
env_changes["PYTHONUSERBASE"] = site.USER_BASE
2197
def cleanup_environment():
2198
for env_var, value in env_changes.iteritems():
2199
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2201
def restore_environment():
2202
for env_var, value in old_env.iteritems():
2203
osutils.set_or_unset_env(env_var, value)
2205
bzr_path = self.get_bzr_path()
2208
if working_dir is not None:
2209
cwd = osutils.getcwd()
2210
os.chdir(working_dir)
2213
# win32 subprocess doesn't support preexec_fn
2214
# so we will avoid using it on all platforms, just to
2215
# make sure the code path is used, and we don't break on win32
2216
cleanup_environment()
2217
# Include the subprocess's log file in the test details, in case
2218
# the test fails due to an error in the subprocess.
2219
self._add_subprocess_log(trace._get_bzr_log_filename())
2220
command = [sys.executable]
2221
# frozen executables don't need the path to bzr
2222
if getattr(sys, "frozen", None) is None:
2223
command.append(bzr_path)
2224
if not allow_plugins:
2225
command.append('--no-plugins')
2226
command.extend(process_args)
2227
process = self._popen(command, stdin=subprocess.PIPE,
2228
stdout=subprocess.PIPE,
2231
restore_environment()
2237
def _add_subprocess_log(self, log_file_path):
2238
if len(self._log_files) == 0:
2239
# Register an addCleanup func. We do this on the first call to
2240
# _add_subprocess_log rather than in TestCase.setUp so that this
2241
# addCleanup is registered after any cleanups for tempdirs that
2242
# subclasses might create, which will probably remove the log file
2244
self.addCleanup(self._subprocess_log_cleanup)
2245
# self._log_files is a set, so if a log file is reused we won't grab it
2247
self._log_files.add(log_file_path)
2249
def _subprocess_log_cleanup(self):
2250
for count, log_file_path in enumerate(self._log_files):
2251
# We use buffer_now=True to avoid holding the file open beyond
2252
# the life of this function, which might interfere with e.g.
2253
# cleaning tempdirs on Windows.
2254
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
2255
#detail_content = content.content_from_file(
2256
# log_file_path, buffer_now=True)
2257
with open(log_file_path, 'rb') as log_file:
2258
log_file_bytes = log_file.read()
2259
detail_content = content.Content(content.ContentType("text",
2260
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
2261
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
2264
def _popen(self, *args, **kwargs):
2265
"""Place a call to Popen.
2267
Allows tests to override this method to intercept the calls made to
2268
Popen for introspection.
2270
return subprocess.Popen(*args, **kwargs)
2272
def get_source_path(self):
2273
"""Return the path of the directory containing bzrlib."""
2274
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2276
def get_bzr_path(self):
2277
"""Return the path of the 'bzr' executable for this test suite."""
2278
bzr_path = os.path.join(self.get_source_path(), "bzr")
2279
if not os.path.isfile(bzr_path):
2280
# We are probably installed. Assume sys.argv is the right file
2281
bzr_path = sys.argv[0]
2284
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2285
universal_newlines=False, process_args=None):
2286
"""Finish the execution of process.
2288
:param process: the Popen object returned from start_bzr_subprocess.
2289
:param retcode: The status code that is expected. Defaults to 0. If
2290
None is supplied, the status code is not checked.
2291
:param send_signal: an optional signal to send to the process.
2292
:param universal_newlines: Convert CRLF => LF
2293
:returns: (stdout, stderr)
2295
if send_signal is not None:
2296
os.kill(process.pid, send_signal)
2297
out, err = process.communicate()
2299
if universal_newlines:
2300
out = out.replace('\r\n', '\n')
2301
err = err.replace('\r\n', '\n')
2303
if retcode is not None and retcode != process.returncode:
2304
if process_args is None:
2305
process_args = "(unknown args)"
2306
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2307
trace.mutter('Error for bzr %s:\n%s', process_args, err)
2308
self.fail('Command bzr %s failed with retcode %s != %s'
2309
% (process_args, retcode, process.returncode))
2312
def check_tree_shape(self, tree, shape):
2313
"""Compare a tree to a list of expected names.
2315
Fail if they are not precisely equal.
2318
shape = list(shape) # copy
2319
for path, ie in tree.iter_entries_by_dir():
2320
name = path.replace('\\', '/')
2321
if ie.kind == 'directory':
2324
pass # ignore root entry
2330
self.fail("expected paths not found in inventory: %r" % shape)
2332
self.fail("unexpected paths found in inventory: %r" % extras)
2334
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2335
a_callable=None, *args, **kwargs):
2336
"""Call callable with redirected std io pipes.
2338
Returns the return code."""
2339
if not callable(a_callable):
2340
raise ValueError("a_callable must be callable.")
2342
stdin = StringIO("")
2344
if getattr(self, "_log_file", None) is not None:
2345
stdout = self._log_file
2349
if getattr(self, "_log_file", None is not None):
2350
stderr = self._log_file
2353
real_stdin = sys.stdin
2354
real_stdout = sys.stdout
2355
real_stderr = sys.stderr
2360
return a_callable(*args, **kwargs)
2362
sys.stdout = real_stdout
2363
sys.stderr = real_stderr
2364
sys.stdin = real_stdin
2366
def reduceLockdirTimeout(self):
2367
"""Reduce the default lock timeout for the duration of the test, so that
2368
if LockContention occurs during a test, it does so quickly.
2370
Tests that expect to provoke LockContention errors should call this.
2372
self.overrideAttr(lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2374
def make_utf8_encoded_stringio(self, encoding_type=None):
2375
"""Return a StringIOWrapper instance, that will encode Unicode
2378
if encoding_type is None:
2379
encoding_type = 'strict'
2381
output_encoding = 'utf-8'
2382
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2383
sio.encoding = output_encoding
2386
def disable_verb(self, verb):
2387
"""Disable a smart server verb for one test."""
2388
from bzrlib.smart import request
2389
request_handlers = request.request_handlers
2390
orig_method = request_handlers.get(verb)
2391
orig_info = request_handlers.get_info(verb)
2392
request_handlers.remove(verb)
2393
self.addCleanup(request_handlers.register, verb, orig_method,
2397
class CapturedCall(object):
2398
"""A helper for capturing smart server calls for easy debug analysis."""
2400
def __init__(self, params, prefix_length):
2401
"""Capture the call with params and skip prefix_length stack frames."""
2404
# The last 5 frames are the __init__, the hook frame, and 3 smart
2405
# client frames. Beyond this we could get more clever, but this is good
2407
stack = traceback.extract_stack()[prefix_length:-5]
2408
self.stack = ''.join(traceback.format_list(stack))
2411
return self.call.method
2414
return self.call.method
2420
class TestCaseWithMemoryTransport(TestCase):
2421
"""Common test class for tests that do not need disk resources.
2423
Tests that need disk resources should derive from TestCaseInTempDir
2424
orTestCaseWithTransport.
2426
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2428
For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
2429
a directory which does not exist. This serves to help ensure test isolation
2430
is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
2431
must exist. However, TestCaseWithMemoryTransport does not offer local file
2432
defaults for the transport in tests, nor does it obey the command line
2433
override, so tests that accidentally write to the common directory should
2436
:cvar TEST_ROOT: Directory containing all temporary directories, plus a
2437
``.bzr`` directory that stops us ascending higher into the filesystem.
2443
def __init__(self, methodName='runTest'):
2444
# allow test parameterization after test construction and before test
2445
# execution. Variables that the parameterizer sets need to be
2446
# ones that are not set by setUp, or setUp will trash them.
2447
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2448
self.vfs_transport_factory = default_transport
2449
self.transport_server = None
2450
self.transport_readonly_server = None
2451
self.__vfs_server = None
2453
def get_transport(self, relpath=None):
2454
"""Return a writeable transport.
2456
This transport is for the test scratch space relative to
2459
:param relpath: a path relative to the base url.
2461
t = _mod_transport.get_transport_from_url(self.get_url(relpath))
2462
self.assertFalse(t.is_readonly())
2465
def get_readonly_transport(self, relpath=None):
2466
"""Return a readonly transport for the test scratch space
2468
This can be used to test that operations which should only need
2469
readonly access in fact do not try to write.
2471
:param relpath: a path relative to the base url.
2473
t = _mod_transport.get_transport_from_url(
2474
self.get_readonly_url(relpath))
2475
self.assertTrue(t.is_readonly())
2478
def create_transport_readonly_server(self):
2479
"""Create a transport server from class defined at init.
2481
This is mostly a hook for daughter classes.
2483
return self.transport_readonly_server()
2485
def get_readonly_server(self):
2486
"""Get the server instance for the readonly transport
2488
This is useful for some tests with specific servers to do diagnostics.
2490
if self.__readonly_server is None:
2491
if self.transport_readonly_server is None:
2492
# readonly decorator requested
2493
self.__readonly_server = test_server.ReadonlyServer()
2495
# explicit readonly transport.
2496
self.__readonly_server = self.create_transport_readonly_server()
2497
self.start_server(self.__readonly_server,
2498
self.get_vfs_only_server())
2499
return self.__readonly_server
2501
def get_readonly_url(self, relpath=None):
2502
"""Get a URL for the readonly transport.
2504
This will either be backed by '.' or a decorator to the transport
2505
used by self.get_url()
2506
relpath provides for clients to get a path relative to the base url.
2507
These should only be downwards relative, not upwards.
2509
base = self.get_readonly_server().get_url()
2510
return self._adjust_url(base, relpath)
2512
def get_vfs_only_server(self):
2513
"""Get the vfs only read/write server instance.
2515
This is useful for some tests with specific servers that need
2518
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2519
is no means to override it.
2521
if self.__vfs_server is None:
2522
self.__vfs_server = memory.MemoryServer()
2523
self.start_server(self.__vfs_server)
2524
return self.__vfs_server
2526
def get_server(self):
2527
"""Get the read/write server instance.
2529
This is useful for some tests with specific servers that need
2532
This is built from the self.transport_server factory. If that is None,
2533
then the self.get_vfs_server is returned.
2535
if self.__server is None:
2536
if (self.transport_server is None or self.transport_server is
2537
self.vfs_transport_factory):
2538
self.__server = self.get_vfs_only_server()
2540
# bring up a decorated means of access to the vfs only server.
2541
self.__server = self.transport_server()
2542
self.start_server(self.__server, self.get_vfs_only_server())
2543
return self.__server
2545
def _adjust_url(self, base, relpath):
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
if relpath is not None and relpath != '.':
2554
if not base.endswith('/'):
2556
# XXX: Really base should be a url; we did after all call
2557
# get_url()! But sometimes it's just a path (from
2558
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2559
# to a non-escaped local path.
2560
if base.startswith('./') or base.startswith('/'):
2563
base += urlutils.escape(relpath)
2566
def get_url(self, relpath=None):
2567
"""Get a URL (or maybe a path) for the readwrite transport.
2569
This will either be backed by '.' or to an equivalent non-file based
2571
relpath provides for clients to get a path relative to the base url.
2572
These should only be downwards relative, not upwards.
2574
base = self.get_server().get_url()
2575
return self._adjust_url(base, relpath)
2577
def get_vfs_only_url(self, relpath=None):
2578
"""Get a URL (or maybe a path for the plain old vfs transport.
2580
This will never be a smart protocol. It always has all the
2581
capabilities of the local filesystem, but it might actually be a
2582
MemoryTransport or some other similar virtual filesystem.
2584
This is the backing transport (if any) of the server returned by
2585
get_url and get_readonly_url.
2587
:param relpath: provides for clients to get a path relative to the base
2588
url. These should only be downwards relative, not upwards.
2591
base = self.get_vfs_only_server().get_url()
2592
return self._adjust_url(base, relpath)
2594
def _create_safety_net(self):
2595
"""Make a fake bzr directory.
2597
This prevents any tests propagating up onto the TEST_ROOT directory's
2600
root = TestCaseWithMemoryTransport.TEST_ROOT
2601
# Make sure we get a readable and accessible home for .bzr.log
2602
# and/or config files, and not fallback to weird defaults (see
2603
# http://pad.lv/825027).
2604
self.assertIs(None, os.environ.get('BZR_HOME', None))
2605
os.environ['BZR_HOME'] = root
2606
wt = bzrdir.BzrDir.create_standalone_workingtree(root)
2607
del os.environ['BZR_HOME']
2608
# Hack for speed: remember the raw bytes of the dirstate file so that
2609
# we don't need to re-open the wt to check it hasn't changed.
2610
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
2611
wt.control_transport.get_bytes('dirstate'))
2613
def _check_safety_net(self):
2614
"""Check that the safety .bzr directory have not been touched.
2616
_make_test_root have created a .bzr directory to prevent tests from
2617
propagating. This method ensures than a test did not leaked.
2619
root = TestCaseWithMemoryTransport.TEST_ROOT
2620
t = _mod_transport.get_transport_from_path(root)
2621
self.permit_url(t.base)
2622
if (t.get_bytes('.bzr/checkout/dirstate') !=
2623
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
2624
# The current test have modified the /bzr directory, we need to
2625
# recreate a new one or all the followng tests will fail.
2626
# If you need to inspect its content uncomment the following line
2627
# import pdb; pdb.set_trace()
2628
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2629
self._create_safety_net()
2630
raise AssertionError('%s/.bzr should not be modified' % root)
2632
def _make_test_root(self):
2633
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2634
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2635
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2637
TestCaseWithMemoryTransport.TEST_ROOT = root
2639
self._create_safety_net()
2641
# The same directory is used by all tests, and we're not
2642
# specifically told when all tests are finished. This will do.
2643
atexit.register(_rmtree_temp_dir, root)
2645
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2646
self.addCleanup(self._check_safety_net)
2648
def makeAndChdirToTestDir(self):
2649
"""Create a temporary directories for this one test.
2651
This must set self.test_home_dir and self.test_dir and chdir to
2654
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2656
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2657
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2658
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2659
self.permit_dir(self.test_dir)
2661
def make_branch(self, relpath, format=None):
2662
"""Create a branch on the transport at relpath."""
2663
repo = self.make_repository(relpath, format=format)
2664
return repo.bzrdir.create_branch(append_revisions_only=False)
2666
def get_default_format(self):
2669
def resolve_format(self, format):
2670
"""Resolve an object to a ControlDir format object.
2672
The initial format object can either already be
2673
a ControlDirFormat, None (for the default format),
2674
or a string with the name of the control dir format.
2676
:param format: Object to resolve
2677
:return A ControlDirFormat instance
2680
format = self.get_default_format()
2681
if isinstance(format, basestring):
2682
format = bzrdir.format_registry.make_bzrdir(format)
2685
def make_bzrdir(self, relpath, format=None):
2687
# might be a relative or absolute path
2688
maybe_a_url = self.get_url(relpath)
2689
segments = maybe_a_url.rsplit('/', 1)
2690
t = _mod_transport.get_transport(maybe_a_url)
2691
if len(segments) > 1 and segments[-1] not in ('', '.'):
2693
format = self.resolve_format(format)
2694
return format.initialize_on_transport(t)
2695
except errors.UninitializableFormat:
2696
raise TestSkipped("Format %s is not initializable." % format)
2698
def make_repository(self, relpath, shared=None, format=None):
2699
"""Create a repository on our default transport at relpath.
2701
Note that relpath must be a relative path, not a full url.
2703
# FIXME: If you create a remoterepository this returns the underlying
2704
# real format, which is incorrect. Actually we should make sure that
2705
# RemoteBzrDir returns a RemoteRepository.
2706
# maybe mbp 20070410
2707
made_control = self.make_bzrdir(relpath, format=format)
2708
return made_control.create_repository(shared=shared)
2710
def make_smart_server(self, path, backing_server=None):
2711
if backing_server is None:
2712
backing_server = self.get_server()
2713
smart_server = test_server.SmartTCPServer_for_testing()
2714
self.start_server(smart_server, backing_server)
2715
remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
2717
return remote_transport
2719
def make_branch_and_memory_tree(self, relpath, format=None):
2720
"""Create a branch on the default transport and a MemoryTree for it."""
2721
b = self.make_branch(relpath, format=format)
2722
return memorytree.MemoryTree.create_on_branch(b)
2724
def make_branch_builder(self, relpath, format=None):
2725
branch = self.make_branch(relpath, format=format)
2726
return branchbuilder.BranchBuilder(branch=branch)
2728
def overrideEnvironmentForTesting(self):
2729
test_home_dir = self.test_home_dir
2730
if isinstance(test_home_dir, unicode):
2731
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2732
self.overrideEnv('HOME', test_home_dir)
2733
self.overrideEnv('BZR_HOME', test_home_dir)
2736
super(TestCaseWithMemoryTransport, self).setUp()
2738
def _add_disconnect_cleanup(transport):
2739
"""Schedule disconnection of given transport at test cleanup
2741
This needs to happen for all connected transports or leaks occur.
2743
Note reconnections may mean we call disconnect multiple times per
2744
transport which is suboptimal but seems harmless.
2746
self.addCleanup(transport.disconnect)
2748
_mod_transport.Transport.hooks.install_named_hook('post_connect',
2749
_add_disconnect_cleanup, None)
2751
self._make_test_root()
2752
self.addCleanup(os.chdir, os.getcwdu())
2753
self.makeAndChdirToTestDir()
2754
self.overrideEnvironmentForTesting()
2755
self.__readonly_server = None
2756
self.__server = None
2757
self.reduceLockdirTimeout()
2759
def setup_smart_server_with_call_log(self):
2760
"""Sets up a smart server as the transport server with a call log."""
2761
self.transport_server = test_server.SmartTCPServer_for_testing
2762
self.hpss_connections = []
2763
self.hpss_calls = []
2765
# Skip the current stack down to the caller of
2766
# setup_smart_server_with_call_log
2767
prefix_length = len(traceback.extract_stack()) - 2
2768
def capture_hpss_call(params):
2769
self.hpss_calls.append(
2770
CapturedCall(params, prefix_length))
2771
def capture_connect(transport):
2772
self.hpss_connections.append(transport)
2773
client._SmartClient.hooks.install_named_hook(
2774
'call', capture_hpss_call, None)
2775
_mod_transport.Transport.hooks.install_named_hook(
2776
'post_connect', capture_connect, None)
2778
def reset_smart_call_log(self):
2779
self.hpss_calls = []
2780
self.hpss_connections = []
2783
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2784
"""Derived class that runs a test within a temporary directory.
2786
This is useful for tests that need to create a branch, etc.
2788
The directory is created in a slightly complex way: for each
2789
Python invocation, a new temporary top-level directory is created.
2790
All test cases create their own directory within that. If the
2791
tests complete successfully, the directory is removed.
2793
:ivar test_base_dir: The path of the top-level directory for this
2794
test, which contains a home directory and a work directory.
2796
:ivar test_home_dir: An initially empty directory under test_base_dir
2797
which is used as $HOME for this test.
2799
:ivar test_dir: A directory under test_base_dir used as the current
2800
directory when the test proper is run.
2803
OVERRIDE_PYTHON = 'python'
2806
super(TestCaseInTempDir, self).setUp()
2807
# Remove the protection set in isolated_environ, we have a proper
2808
# access to disk resources now.
2809
self.overrideEnv('BZR_LOG', None)
2811
def check_file_contents(self, filename, expect):
2812
self.log("check contents of file %s" % filename)
2818
if contents != expect:
2819
self.log("expected: %r" % expect)
2820
self.log("actually: %r" % contents)
2821
self.fail("contents of %s not as expected" % filename)
2823
def _getTestDirPrefix(self):
2824
# create a directory within the top level test directory
2825
if sys.platform in ('win32', 'cygwin'):
2826
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2827
# windows is likely to have path-length limits so use a short name
2828
name_prefix = name_prefix[-30:]
2830
name_prefix = re.sub('[/]', '_', self.id())
2833
def makeAndChdirToTestDir(self):
2834
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2836
For TestCaseInTempDir we create a temporary directory based on the test
2837
name and then create two subdirs - test and home under it.
2839
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2840
self._getTestDirPrefix())
2842
for i in range(100):
2843
if os.path.exists(name):
2844
name = name_prefix + '_' + str(i)
2846
# now create test and home directories within this dir
2847
self.test_base_dir = name
2848
self.addCleanup(self.deleteTestDir)
2849
os.mkdir(self.test_base_dir)
2851
self.permit_dir(self.test_base_dir)
2852
# 'sprouting' and 'init' of a branch both walk up the tree to find
2853
# stacking policy to honour; create a bzr dir with an unshared
2854
# repository (but not a branch - our code would be trying to escape
2855
# then!) to stop them, and permit it to be read.
2856
# control = bzrdir.BzrDir.create(self.test_base_dir)
2857
# control.create_repository()
2858
self.test_home_dir = self.test_base_dir + '/home'
2859
os.mkdir(self.test_home_dir)
2860
self.test_dir = self.test_base_dir + '/work'
2861
os.mkdir(self.test_dir)
2862
os.chdir(self.test_dir)
2863
# put name of test inside
2864
f = file(self.test_base_dir + '/name', 'w')
2870
def deleteTestDir(self):
2871
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2872
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2874
def build_tree(self, shape, line_endings='binary', transport=None):
2875
"""Build a test tree according to a pattern.
2877
shape is a sequence of file specifications. If the final
2878
character is '/', a directory is created.
2880
This assumes that all the elements in the tree being built are new.
2882
This doesn't add anything to a branch.
2884
:type shape: list or tuple.
2885
:param line_endings: Either 'binary' or 'native'
2886
in binary mode, exact contents are written in native mode, the
2887
line endings match the default platform endings.
2888
:param transport: A transport to write to, for building trees on VFS's.
2889
If the transport is readonly or None, "." is opened automatically.
2892
if type(shape) not in (list, tuple):
2893
raise AssertionError("Parameter 'shape' should be "
2894
"a list or a tuple. Got %r instead" % (shape,))
2895
# It's OK to just create them using forward slashes on windows.
2896
if transport is None or transport.is_readonly():
2897
transport = _mod_transport.get_transport_from_path(".")
2899
self.assertIsInstance(name, basestring)
2901
transport.mkdir(urlutils.escape(name[:-1]))
2903
if line_endings == 'binary':
2905
elif line_endings == 'native':
2908
raise errors.BzrError(
2909
'Invalid line ending request %r' % line_endings)
2910
content = "contents of %s%s" % (name.encode('utf-8'), end)
2911
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2913
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2915
def assertInWorkingTree(self, path, root_path='.', tree=None):
2916
"""Assert whether path or paths are in the WorkingTree"""
2918
tree = workingtree.WorkingTree.open(root_path)
2919
if not isinstance(path, basestring):
2921
self.assertInWorkingTree(p, tree=tree)
2923
self.assertIsNot(tree.path2id(path), None,
2924
path+' not in working tree.')
2926
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2927
"""Assert whether path or paths are not in the WorkingTree"""
2929
tree = workingtree.WorkingTree.open(root_path)
2930
if not isinstance(path, basestring):
2932
self.assertNotInWorkingTree(p,tree=tree)
2934
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2937
class TestCaseWithTransport(TestCaseInTempDir):
2938
"""A test case that provides get_url and get_readonly_url facilities.
2940
These back onto two transport servers, one for readonly access and one for
2943
If no explicit class is provided for readonly access, a
2944
ReadonlyTransportDecorator is used instead which allows the use of non disk
2945
based read write transports.
2947
If an explicit class is provided for readonly access, that server and the
2948
readwrite one must both define get_url() as resolving to os.getcwd().
2951
def get_vfs_only_server(self):
2952
"""See TestCaseWithMemoryTransport.
2954
This is useful for some tests with specific servers that need
2957
if self.__vfs_server is None:
2958
self.__vfs_server = self.vfs_transport_factory()
2959
self.start_server(self.__vfs_server)
2960
return self.__vfs_server
2962
def make_branch_and_tree(self, relpath, format=None):
2963
"""Create a branch on the transport and a tree locally.
2965
If the transport is not a LocalTransport, the Tree can't be created on
2966
the transport. In that case if the vfs_transport_factory is
2967
LocalURLServer the working tree is created in the local
2968
directory backing the transport, and the returned tree's branch and
2969
repository will also be accessed locally. Otherwise a lightweight
2970
checkout is created and returned.
2972
We do this because we can't physically create a tree in the local
2973
path, with a branch reference to the transport_factory url, and
2974
a branch + repository in the vfs_transport, unless the vfs_transport
2975
namespace is distinct from the local disk - the two branch objects
2976
would collide. While we could construct a tree with its branch object
2977
pointing at the transport_factory transport in memory, reopening it
2978
would behaving unexpectedly, and has in the past caused testing bugs
2979
when we tried to do it that way.
2981
:param format: The BzrDirFormat.
2982
:returns: the WorkingTree.
2984
# TODO: always use the local disk path for the working tree,
2985
# this obviously requires a format that supports branch references
2986
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2988
format = self.resolve_format(format=format)
2989
if not format.supports_workingtrees:
2990
b = self.make_branch(relpath+'.branch', format=format)
2991
return b.create_checkout(relpath, lightweight=True)
2992
b = self.make_branch(relpath, format=format)
2994
return b.bzrdir.create_workingtree()
2995
except errors.NotLocalUrl:
2996
# We can only make working trees locally at the moment. If the
2997
# transport can't support them, then we keep the non-disk-backed
2998
# branch and create a local checkout.
2999
if self.vfs_transport_factory is test_server.LocalURLServer:
3000
# the branch is colocated on disk, we cannot create a checkout.
3001
# hopefully callers will expect this.
3002
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
3003
wt = local_controldir.create_workingtree()
3004
if wt.branch._format != b._format:
3006
# Make sure that assigning to wt._branch fixes wt.branch,
3007
# in case the implementation details of workingtree objects
3009
self.assertIs(b, wt.branch)
3012
return b.create_checkout(relpath, lightweight=True)
3014
def assertIsDirectory(self, relpath, transport):
3015
"""Assert that relpath within transport is a directory.
3017
This may not be possible on all transports; in that case it propagates
3018
a TransportNotPossible.
3021
mode = transport.stat(relpath).st_mode
3022
except errors.NoSuchFile:
3023
self.fail("path %s is not a directory; no such file"
3025
if not stat.S_ISDIR(mode):
3026
self.fail("path %s is not a directory; has mode %#o"
3029
def assertTreesEqual(self, left, right):
3030
"""Check that left and right have the same content and properties."""
3031
# we use a tree delta to check for equality of the content, and we
3032
# manually check for equality of other things such as the parents list.
3033
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
3034
differences = left.changes_from(right)
3035
self.assertFalse(differences.has_changed(),
3036
"Trees %r and %r are different: %r" % (left, right, differences))
3039
super(TestCaseWithTransport, self).setUp()
3040
self.__vfs_server = None
3042
def disable_missing_extensions_warning(self):
3043
"""Some tests expect a precise stderr content.
3045
There is no point in forcing them to duplicate the extension related
3048
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
3051
class ChrootedTestCase(TestCaseWithTransport):
3052
"""A support class that provides readonly urls outside the local namespace.
3054
This is done by checking if self.transport_server is a MemoryServer. if it
3055
is then we are chrooted already, if it is not then an HttpServer is used
3058
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
3059
be used without needed to redo it when a different
3060
subclass is in use ?
3064
from bzrlib.tests import http_server
3065
super(ChrootedTestCase, self).setUp()
3066
if not self.vfs_transport_factory == memory.MemoryServer:
3067
self.transport_readonly_server = http_server.HttpServer
3070
def condition_id_re(pattern):
3071
"""Create a condition filter which performs a re check on a test's id.
3073
:param pattern: A regular expression string.
3074
:return: A callable that returns True if the re matches.
3076
filter_re = re.compile(pattern, 0)
3077
def condition(test):
3079
return filter_re.search(test_id)
3083
def condition_isinstance(klass_or_klass_list):
3084
"""Create a condition filter which returns isinstance(param, klass).
3086
:return: A callable which when called with one parameter obj return the
3087
result of isinstance(obj, klass_or_klass_list).
3090
return isinstance(obj, klass_or_klass_list)
3094
def condition_id_in_list(id_list):
3095
"""Create a condition filter which verify that test's id in a list.
3097
:param id_list: A TestIdList object.
3098
:return: A callable that returns True if the test's id appears in the list.
3100
def condition(test):
3101
return id_list.includes(test.id())
3105
def condition_id_startswith(starts):
3106
"""Create a condition filter verifying that test's id starts with a string.
3108
:param starts: A list of string.
3109
:return: A callable that returns True if the test's id starts with one of
3112
def condition(test):
3113
for start in starts:
3114
if test.id().startswith(start):
3120
def exclude_tests_by_condition(suite, condition):
3121
"""Create a test suite which excludes some tests from suite.
3123
:param suite: The suite to get tests from.
3124
:param condition: A callable whose result evaluates True when called with a
3125
test case which should be excluded from the result.
3126
:return: A suite which contains the tests found in suite that fail
3130
for test in iter_suite_tests(suite):
3131
if not condition(test):
3133
return TestUtil.TestSuite(result)
3136
def filter_suite_by_condition(suite, condition):
3137
"""Create a test suite by filtering another one.
3139
:param suite: The source suite.
3140
:param condition: A callable whose result evaluates True when called with a
3141
test case which should be included in the result.
3142
:return: A suite which contains the tests found in suite that pass
3146
for test in iter_suite_tests(suite):
3149
return TestUtil.TestSuite(result)
3152
def filter_suite_by_re(suite, pattern):
3153
"""Create a test suite by filtering another one.
3155
:param suite: the source suite
3156
:param pattern: pattern that names must match
3157
:returns: the newly created suite
3159
condition = condition_id_re(pattern)
3160
result_suite = filter_suite_by_condition(suite, condition)
3164
def filter_suite_by_id_list(suite, test_id_list):
3165
"""Create a test suite by filtering another one.
3167
:param suite: The source suite.
3168
:param test_id_list: A list of the test ids to keep as strings.
3169
:returns: the newly created suite
3171
condition = condition_id_in_list(test_id_list)
3172
result_suite = filter_suite_by_condition(suite, condition)
3176
def filter_suite_by_id_startswith(suite, start):
3177
"""Create a test suite by filtering another one.
3179
:param suite: The source suite.
3180
:param start: A list of string the test id must start with one of.
3181
:returns: the newly created suite
3183
condition = condition_id_startswith(start)
3184
result_suite = filter_suite_by_condition(suite, condition)
3188
def exclude_tests_by_re(suite, pattern):
3189
"""Create a test suite which excludes some tests from suite.
3191
:param suite: The suite to get tests from.
3192
:param pattern: A regular expression string. Test ids that match this
3193
pattern will be excluded from the result.
3194
:return: A TestSuite that contains all the tests from suite without the
3195
tests that matched pattern. The order of tests is the same as it was in
3198
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3201
def preserve_input(something):
3202
"""A helper for performing test suite transformation chains.
3204
:param something: Anything you want to preserve.
3210
def randomize_suite(suite):
3211
"""Return a new TestSuite with suite's tests in random order.
3213
The tests in the input suite are flattened into a single suite in order to
3214
accomplish this. Any nested TestSuites are removed to provide global
3217
tests = list(iter_suite_tests(suite))
3218
random.shuffle(tests)
3219
return TestUtil.TestSuite(tests)
3222
def split_suite_by_condition(suite, condition):
3223
"""Split a test suite into two by a condition.
3225
:param suite: The suite to split.
3226
:param condition: The condition to match on. Tests that match this
3227
condition are returned in the first test suite, ones that do not match
3228
are in the second suite.
3229
:return: A tuple of two test suites, where the first contains tests from
3230
suite matching the condition, and the second contains the remainder
3231
from suite. The order within each output suite is the same as it was in
3236
for test in iter_suite_tests(suite):
3238
matched.append(test)
3240
did_not_match.append(test)
3241
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3244
def split_suite_by_re(suite, pattern):
3245
"""Split a test suite into two by a regular expression.
3247
:param suite: The suite to split.
3248
:param pattern: A regular expression string. Test ids that match this
3249
pattern will be in the first test suite returned, and the others in the
3250
second test suite returned.
3251
:return: A tuple of two test suites, where the first contains tests from
3252
suite matching pattern, and the second contains the remainder from
3253
suite. The order within each output suite is the same as it was in
3256
return split_suite_by_condition(suite, condition_id_re(pattern))
3259
def run_suite(suite, name='test', verbose=False, pattern=".*",
3260
stop_on_failure=False,
3261
transport=None, lsprof_timed=None, bench_history=None,
3262
matching_tests_first=None,
3265
exclude_pattern=None,
3268
suite_decorators=None,
3270
result_decorators=None,
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,
3272
"""Run a test suite for bzr selftest.
3274
:param runner_class: The class of runner to use. Must support the
3275
constructor arguments passed by run_suite which are more than standard
3277
:return: A boolean indicating success.
3279
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3284
if runner_class is None:
3285
runner_class = TextTestRunner
3288
runner = runner_class(stream=stream,
3290
verbosity=verbosity,
3291
bench_history=bench_history,
3293
result_decorators=result_decorators,
3295
runner.stop_on_failure=stop_on_failure
3296
if isinstance(suite, unittest.TestSuite):
3297
# Empty out _tests list of passed suite and populate new TestSuite
3298
suite._tests[:], suite = [], TestSuite(suite)
3299
# built in decorator factories:
3301
random_order(random_seed, runner),
3302
exclude_tests(exclude_pattern),
3304
if matching_tests_first:
3305
decorators.append(tests_first(pattern))
3307
decorators.append(filter_tests(pattern))
3308
if suite_decorators:
3309
decorators.extend(suite_decorators)
3310
# tell the result object how many tests will be running: (except if
3311
# --parallel=fork is being used. Robert said he will provide a better
3312
# progress design later -- vila 20090817)
3313
if fork_decorator not in decorators:
3314
decorators.append(CountingDecorator)
3315
for decorator in decorators:
3316
suite = decorator(suite)
3318
# Done after test suite decoration to allow randomisation etc
3319
# to take effect, though that is of marginal benefit.
3321
stream.write("Listing tests only ...\n")
3322
for t in iter_suite_tests(suite):
3323
stream.write("%s\n" % (t.id()))
3325
result = runner.run(suite)
3327
return result.wasStrictlySuccessful()
3329
return result.wasSuccessful()
3332
# A registry where get() returns a suite decorator.
3333
parallel_registry = registry.Registry()
3336
def fork_decorator(suite):
3337
if getattr(os, "fork", None) is None:
3338
raise errors.BzrCommandError("platform does not support fork,"
3339
" try --parallel=subprocess instead.")
3340
concurrency = osutils.local_concurrency()
3341
if concurrency == 1:
3343
from testtools import ConcurrentTestSuite
3344
return ConcurrentTestSuite(suite, fork_for_tests)
3345
parallel_registry.register('fork', fork_decorator)
3348
def subprocess_decorator(suite):
3349
concurrency = osutils.local_concurrency()
3350
if concurrency == 1:
3352
from testtools import ConcurrentTestSuite
3353
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3354
parallel_registry.register('subprocess', subprocess_decorator)
3357
def exclude_tests(exclude_pattern):
3358
"""Return a test suite decorator that excludes tests."""
3359
if exclude_pattern is None:
3360
return identity_decorator
3361
def decorator(suite):
3362
return ExcludeDecorator(suite, exclude_pattern)
3366
def filter_tests(pattern):
3368
return identity_decorator
3369
def decorator(suite):
3370
return FilterTestsDecorator(suite, pattern)
3374
def random_order(random_seed, runner):
3375
"""Return a test suite decorator factory for randomising tests order.
3377
:param random_seed: now, a string which casts to a long, or a long.
3378
:param runner: A test runner with a stream attribute to report on.
3380
if random_seed is None:
3381
return identity_decorator
3382
def decorator(suite):
3383
return RandomDecorator(suite, random_seed, runner.stream)
3387
def tests_first(pattern):
3389
return identity_decorator
3390
def decorator(suite):
3391
return TestFirstDecorator(suite, pattern)
3395
def identity_decorator(suite):
3400
class TestDecorator(TestUtil.TestSuite):
3401
"""A decorator for TestCase/TestSuite objects.
3403
Contains rather than flattening suite passed on construction
3406
def __init__(self, suite=None):
3407
super(TestDecorator, self).__init__()
3408
if suite is not None:
3411
# Don't need subclass run method with suite emptying
3412
run = unittest.TestSuite.run
3415
class CountingDecorator(TestDecorator):
3416
"""A decorator which calls result.progress(self.countTestCases)."""
3418
def run(self, result):
3419
progress_method = getattr(result, 'progress', None)
3420
if callable(progress_method):
3421
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3422
return super(CountingDecorator, self).run(result)
3425
class ExcludeDecorator(TestDecorator):
3426
"""A decorator which excludes test matching an exclude pattern."""
3428
def __init__(self, suite, exclude_pattern):
3429
super(ExcludeDecorator, self).__init__(
3430
exclude_tests_by_re(suite, exclude_pattern))
3433
class FilterTestsDecorator(TestDecorator):
3434
"""A decorator which filters tests to those matching a pattern."""
3436
def __init__(self, suite, pattern):
3437
super(FilterTestsDecorator, self).__init__(
3438
filter_suite_by_re(suite, pattern))
3441
class RandomDecorator(TestDecorator):
3442
"""A decorator which randomises the order of its tests."""
3444
def __init__(self, suite, random_seed, stream):
3445
random_seed = self.actual_seed(random_seed)
3446
stream.write("Randomizing test order using seed %s\n\n" %
3448
# Initialise the random number generator.
3449
random.seed(random_seed)
3450
super(RandomDecorator, self).__init__(randomize_suite(suite))
3453
def actual_seed(seed):
3455
# We convert the seed to a long to make it reuseable across
3456
# invocations (because the user can reenter it).
3457
return long(time.time())
3459
# Convert the seed to a long if we can
3462
except (TypeError, ValueError):
3467
class TestFirstDecorator(TestDecorator):
3468
"""A decorator which moves named tests to the front."""
3470
def __init__(self, suite, pattern):
3471
super(TestFirstDecorator, self).__init__()
3472
self.addTests(split_suite_by_re(suite, pattern))
3475
def partition_tests(suite, count):
3476
"""Partition suite into count lists of tests."""
3477
# This just assigns tests in a round-robin fashion. On one hand this
3478
# splits up blocks of related tests that might run faster if they shared
3479
# resources, but on the other it avoids assigning blocks of slow tests to
3480
# just one partition. So the slowest partition shouldn't be much slower
3482
partitions = [list() for i in range(count)]
3483
tests = iter_suite_tests(suite)
3484
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3485
partition.append(test)
3489
def workaround_zealous_crypto_random():
3490
"""Crypto.Random want to help us being secure, but we don't care here.
3492
This workaround some test failure related to the sftp server. Once paramiko
3493
stop using the controversial API in Crypto.Random, we may get rid of it.
3496
from Crypto.Random import atfork
3502
def fork_for_tests(suite):
3503
"""Take suite and start up one runner per CPU by forking()
3505
:return: An iterable of TestCase-like objects which can each have
3506
run(result) called on them to feed tests to result.
3508
concurrency = osutils.local_concurrency()
3510
from subunit import ProtocolTestCase
3511
from subunit.test_results import AutoTimingTestResultDecorator
3512
class TestInOtherProcess(ProtocolTestCase):
3513
# Should be in subunit, I think. RBC.
3514
def __init__(self, stream, pid):
3515
ProtocolTestCase.__init__(self, stream)
3518
def run(self, result):
3520
ProtocolTestCase.run(self, result)
3522
pid, status = os.waitpid(self.pid, 0)
3523
# GZ 2011-10-18: If status is nonzero, should report to the result
3524
# that something went wrong.
3526
test_blocks = partition_tests(suite, concurrency)
3527
# Clear the tests from the original suite so it doesn't keep them alive
3528
suite._tests[:] = []
3529
for process_tests in test_blocks:
3530
process_suite = TestUtil.TestSuite(process_tests)
3531
# Also clear each split list so new suite has only reference
3532
process_tests[:] = []
3533
c2pread, c2pwrite = os.pipe()
3537
stream = os.fdopen(c2pwrite, 'wb', 1)
3538
workaround_zealous_crypto_random()
3540
# Leave stderr and stdout open so we can see test noise
3541
# Close stdin so that the child goes away if it decides to
3542
# read from stdin (otherwise its a roulette to see what
3543
# child actually gets keystrokes for pdb etc).
3545
subunit_result = AutoTimingTestResultDecorator(
3546
SubUnitBzrProtocolClient(stream))
3547
process_suite.run(subunit_result)
3549
# Try and report traceback on stream, but exit with error even
3550
# if stream couldn't be created or something else goes wrong.
3551
# The traceback is formatted to a string and written in one go
3552
# to avoid interleaving lines from multiple failing children.
3554
stream.write(traceback.format_exc())
3560
stream = os.fdopen(c2pread, 'rb', 1)
3561
test = TestInOtherProcess(stream, pid)
3566
def reinvoke_for_tests(suite):
3567
"""Take suite and start up one runner per CPU using subprocess().
3569
:return: An iterable of TestCase-like objects which can each have
3570
run(result) called on them to feed tests to result.
3572
concurrency = osutils.local_concurrency()
3574
from subunit import ProtocolTestCase
3575
class TestInSubprocess(ProtocolTestCase):
3576
def __init__(self, process, name):
3577
ProtocolTestCase.__init__(self, process.stdout)
3578
self.process = process
3579
self.process.stdin.close()
3582
def run(self, result):
3584
ProtocolTestCase.run(self, result)
3587
os.unlink(self.name)
3588
# print "pid %d finished" % finished_process
3589
test_blocks = partition_tests(suite, concurrency)
3590
for process_tests in test_blocks:
3591
# ugly; currently reimplement rather than reuses TestCase methods.
3592
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3593
if not os.path.isfile(bzr_path):
3594
# We are probably installed. Assume sys.argv is the right file
3595
bzr_path = sys.argv[0]
3596
bzr_path = [bzr_path]
3597
if sys.platform == "win32":
3598
# if we're on windows, we can't execute the bzr script directly
3599
bzr_path = [sys.executable] + bzr_path
3600
fd, test_list_file_name = tempfile.mkstemp()
3601
test_list_file = os.fdopen(fd, 'wb', 1)
3602
for test in process_tests:
3603
test_list_file.write(test.id() + '\n')
3604
test_list_file.close()
3606
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3608
if '--no-plugins' in sys.argv:
3609
argv.append('--no-plugins')
3610
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3611
# noise on stderr it can interrupt the subunit protocol.
3612
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3613
stdout=subprocess.PIPE,
3614
stderr=subprocess.PIPE,
3616
test = TestInSubprocess(process, test_list_file_name)
3619
os.unlink(test_list_file_name)
3624
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3625
"""Generate profiling data for all activity between start and success.
3627
The profile data is appended to the test's _benchcalls attribute and can
3628
be accessed by the forwarded-to TestResult.
3630
While it might be cleaner do accumulate this in stopTest, addSuccess is
3631
where our existing output support for lsprof is, and this class aims to
3632
fit in with that: while it could be moved it's not necessary to accomplish
3633
test profiling, nor would it be dramatically cleaner.
3636
def startTest(self, test):
3637
self.profiler = bzrlib.lsprof.BzrProfiler()
3638
# Prevent deadlocks in tests that use lsprof: those tests will
3640
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3641
self.profiler.start()
3642
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3644
def addSuccess(self, test):
3645
stats = self.profiler.stop()
3647
calls = test._benchcalls
3648
except AttributeError:
3649
test._benchcalls = []
3650
calls = test._benchcalls
3651
calls.append(((test.id(), "", ""), stats))
3652
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3654
def stopTest(self, test):
3655
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3656
self.profiler = None
3659
# Controlled by "bzr selftest -E=..." option
3660
# Currently supported:
3661
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3662
# preserves any flags supplied at the command line.
3663
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3664
# rather than failing tests. And no longer raise
3665
# LockContention when fctnl locks are not being used
3666
# with proper exclusion rules.
3667
# -Ethreads Will display thread ident at creation/join time to
3668
# help track thread leaks
3669
# -Euncollected_cases Display the identity of any test cases that weren't
3670
# deallocated after being completed.
3671
# -Econfig_stats Will collect statistics using addDetail
3672
selftest_debug_flags = set()
3675
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3677
test_suite_factory=None,
3680
matching_tests_first=None,
3683
exclude_pattern=None,
3689
suite_decorators=None,
3693
"""Run the whole test suite under the enhanced runner"""
3694
# XXX: Very ugly way to do this...
3695
# Disable warning about old formats because we don't want it to disturb
3696
# any blackbox tests.
3697
from bzrlib import repository
3698
repository._deprecation_warning_done = True
3700
global default_transport
3701
if transport is None:
3702
transport = default_transport
3703
old_transport = default_transport
3704
default_transport = transport
3705
global selftest_debug_flags
3706
old_debug_flags = selftest_debug_flags
3707
if debug_flags is not None:
3708
selftest_debug_flags = set(debug_flags)
3710
if load_list is None:
3713
keep_only = load_test_id_list(load_list)
3715
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3716
for start in starting_with]
3717
if test_suite_factory is None:
3718
# Reduce loading time by loading modules based on the starting_with
3720
suite = test_suite(keep_only, starting_with)
3722
suite = test_suite_factory()
3724
# But always filter as requested.
3725
suite = filter_suite_by_id_startswith(suite, starting_with)
3726
result_decorators = []
3728
result_decorators.append(ProfileResult)
3729
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3730
stop_on_failure=stop_on_failure,
3731
transport=transport,
3732
lsprof_timed=lsprof_timed,
3733
bench_history=bench_history,
3734
matching_tests_first=matching_tests_first,
3735
list_only=list_only,
3736
random_seed=random_seed,
3737
exclude_pattern=exclude_pattern,
3739
runner_class=runner_class,
3740
suite_decorators=suite_decorators,
3742
result_decorators=result_decorators,
3745
default_transport = old_transport
3746
selftest_debug_flags = old_debug_flags
3749
def load_test_id_list(file_name):
3750
"""Load a test id list from a text file.
3752
The format is one test id by line. No special care is taken to impose
3753
strict rules, these test ids are used to filter the test suite so a test id
3754
that do not match an existing test will do no harm. This allows user to add
3755
comments, leave blank lines, etc.
3759
ftest = open(file_name, 'rt')
3761
if e.errno != errno.ENOENT:
3764
raise errors.NoSuchFile(file_name)
3766
for test_name in ftest.readlines():
3767
test_list.append(test_name.strip())
3772
def suite_matches_id_list(test_suite, id_list):
3773
"""Warns about tests not appearing or appearing more than once.
3775
:param test_suite: A TestSuite object.
3776
:param test_id_list: The list of test ids that should be found in
3779
:return: (absents, duplicates) absents is a list containing the test found
3780
in id_list but not in test_suite, duplicates is a list containing the
3781
test found multiple times in test_suite.
3783
When using a prefined test id list, it may occurs that some tests do not
3784
exist anymore or that some tests use the same id. This function warns the
3785
tester about potential problems in his workflow (test lists are volatile)
3786
or in the test suite itself (using the same id for several tests does not
3787
help to localize defects).
3789
# Build a dict counting id occurrences
3791
for test in iter_suite_tests(test_suite):
3793
tests[id] = tests.get(id, 0) + 1
3798
occurs = tests.get(id, 0)
3800
not_found.append(id)
3802
duplicates.append(id)
3804
return not_found, duplicates
3807
class TestIdList(object):
3808
"""Test id list to filter a test suite.
3810
Relying on the assumption that test ids are built as:
3811
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3812
notation, this class offers methods to :
3813
- avoid building a test suite for modules not refered to in the test list,
3814
- keep only the tests listed from the module test suite.
3817
def __init__(self, test_id_list):
3818
# When a test suite needs to be filtered against us we compare test ids
3819
# for equality, so a simple dict offers a quick and simple solution.
3820
self.tests = dict().fromkeys(test_id_list, True)
3822
# While unittest.TestCase have ids like:
3823
# <module>.<class>.<method>[(<param+)],
3824
# doctest.DocTestCase can have ids like:
3827
# <module>.<function>
3828
# <module>.<class>.<method>
3830
# Since we can't predict a test class from its name only, we settle on
3831
# a simple constraint: a test id always begins with its module name.
3834
for test_id in test_id_list:
3835
parts = test_id.split('.')
3836
mod_name = parts.pop(0)
3837
modules[mod_name] = True
3839
mod_name += '.' + part
3840
modules[mod_name] = True
3841
self.modules = modules
3843
def refers_to(self, module_name):
3844
"""Is there tests for the module or one of its sub modules."""
3845
return self.modules.has_key(module_name)
3847
def includes(self, test_id):
3848
return self.tests.has_key(test_id)
3851
class TestPrefixAliasRegistry(registry.Registry):
3852
"""A registry for test prefix aliases.
3854
This helps implement shorcuts for the --starting-with selftest
3855
option. Overriding existing prefixes is not allowed but not fatal (a
3856
warning will be emitted).
3859
def register(self, key, obj, help=None, info=None,
3860
override_existing=False):
3861
"""See Registry.register.
3863
Trying to override an existing alias causes a warning to be emitted,
3864
not a fatal execption.
3867
super(TestPrefixAliasRegistry, self).register(
3868
key, obj, help=help, info=info, override_existing=False)
3870
actual = self.get(key)
3872
'Test prefix alias %s is already used for %s, ignoring %s'
3873
% (key, actual, obj))
3875
def resolve_alias(self, id_start):
3876
"""Replace the alias by the prefix in the given string.
3878
Using an unknown prefix is an error to help catching typos.
3880
parts = id_start.split('.')
3882
parts[0] = self.get(parts[0])
3884
raise errors.BzrCommandError(
3885
'%s is not a known test prefix alias' % parts[0])
3886
return '.'.join(parts)
3889
test_prefix_alias_registry = TestPrefixAliasRegistry()
3890
"""Registry of test prefix aliases."""
3893
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3894
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3895
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3897
# Obvious highest levels prefixes, feel free to add your own via a plugin
3898
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3899
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3900
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3901
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3902
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3905
def _test_suite_testmod_names():
3906
"""Return the standard list of test module names to test."""
3909
'bzrlib.tests.blackbox',
3910
'bzrlib.tests.commands',
3911
'bzrlib.tests.doc_generate',
3912
'bzrlib.tests.per_branch',
3913
'bzrlib.tests.per_bzrdir',
3914
'bzrlib.tests.per_controldir',
3915
'bzrlib.tests.per_controldir_colo',
3916
'bzrlib.tests.per_foreign_vcs',
3917
'bzrlib.tests.per_interrepository',
3918
'bzrlib.tests.per_intertree',
3919
'bzrlib.tests.per_inventory',
3920
'bzrlib.tests.per_interbranch',
3921
'bzrlib.tests.per_lock',
3922
'bzrlib.tests.per_merger',
3923
'bzrlib.tests.per_transport',
3924
'bzrlib.tests.per_tree',
3925
'bzrlib.tests.per_pack_repository',
3926
'bzrlib.tests.per_repository',
3927
'bzrlib.tests.per_repository_chk',
3928
'bzrlib.tests.per_repository_reference',
3929
'bzrlib.tests.per_repository_vf',
3930
'bzrlib.tests.per_uifactory',
3931
'bzrlib.tests.per_versionedfile',
3932
'bzrlib.tests.per_workingtree',
3933
'bzrlib.tests.test__annotator',
3934
'bzrlib.tests.test__bencode',
3935
'bzrlib.tests.test__btree_serializer',
3936
'bzrlib.tests.test__chk_map',
3937
'bzrlib.tests.test__dirstate_helpers',
3938
'bzrlib.tests.test__groupcompress',
3939
'bzrlib.tests.test__known_graph',
3940
'bzrlib.tests.test__rio',
3941
'bzrlib.tests.test__simple_set',
3942
'bzrlib.tests.test__static_tuple',
3943
'bzrlib.tests.test__walkdirs_win32',
3944
'bzrlib.tests.test_ancestry',
3945
'bzrlib.tests.test_annotate',
3946
'bzrlib.tests.test_api',
3947
'bzrlib.tests.test_atomicfile',
3948
'bzrlib.tests.test_bad_files',
3949
'bzrlib.tests.test_bisect_multi',
3950
'bzrlib.tests.test_branch',
3951
'bzrlib.tests.test_branchbuilder',
3952
'bzrlib.tests.test_btree_index',
3953
'bzrlib.tests.test_bugtracker',
3954
'bzrlib.tests.test_bundle',
3955
'bzrlib.tests.test_bzrdir',
3956
'bzrlib.tests.test__chunks_to_lines',
3957
'bzrlib.tests.test_cache_utf8',
3958
'bzrlib.tests.test_chk_map',
3959
'bzrlib.tests.test_chk_serializer',
3960
'bzrlib.tests.test_chunk_writer',
3961
'bzrlib.tests.test_clean_tree',
3962
'bzrlib.tests.test_cleanup',
3963
'bzrlib.tests.test_cmdline',
3964
'bzrlib.tests.test_commands',
3965
'bzrlib.tests.test_commit',
3966
'bzrlib.tests.test_commit_merge',
3967
'bzrlib.tests.test_config',
3968
'bzrlib.tests.test_conflicts',
3969
'bzrlib.tests.test_controldir',
3970
'bzrlib.tests.test_counted_lock',
3971
'bzrlib.tests.test_crash',
3972
'bzrlib.tests.test_decorators',
3973
'bzrlib.tests.test_delta',
3974
'bzrlib.tests.test_debug',
3975
'bzrlib.tests.test_diff',
3976
'bzrlib.tests.test_directory_service',
3977
'bzrlib.tests.test_dirstate',
3978
'bzrlib.tests.test_email_message',
3979
'bzrlib.tests.test_eol_filters',
3980
'bzrlib.tests.test_errors',
3981
'bzrlib.tests.test_estimate_compressed_size',
3982
'bzrlib.tests.test_export',
3983
'bzrlib.tests.test_export_pot',
3984
'bzrlib.tests.test_extract',
3985
'bzrlib.tests.test_features',
3986
'bzrlib.tests.test_fetch',
3987
'bzrlib.tests.test_fixtures',
3988
'bzrlib.tests.test_fifo_cache',
3989
'bzrlib.tests.test_filters',
3990
'bzrlib.tests.test_filter_tree',
3991
'bzrlib.tests.test_ftp_transport',
3992
'bzrlib.tests.test_foreign',
3993
'bzrlib.tests.test_generate_docs',
3994
'bzrlib.tests.test_generate_ids',
3995
'bzrlib.tests.test_globbing',
3996
'bzrlib.tests.test_gpg',
3997
'bzrlib.tests.test_graph',
3998
'bzrlib.tests.test_groupcompress',
3999
'bzrlib.tests.test_hashcache',
4000
'bzrlib.tests.test_help',
4001
'bzrlib.tests.test_hooks',
4002
'bzrlib.tests.test_http',
4003
'bzrlib.tests.test_http_response',
4004
'bzrlib.tests.test_https_ca_bundle',
4005
'bzrlib.tests.test_i18n',
4006
'bzrlib.tests.test_identitymap',
4007
'bzrlib.tests.test_ignores',
4008
'bzrlib.tests.test_index',
4009
'bzrlib.tests.test_import_tariff',
4010
'bzrlib.tests.test_info',
4011
'bzrlib.tests.test_inv',
4012
'bzrlib.tests.test_inventory_delta',
4013
'bzrlib.tests.test_knit',
4014
'bzrlib.tests.test_lazy_import',
4015
'bzrlib.tests.test_lazy_regex',
4016
'bzrlib.tests.test_library_state',
4017
'bzrlib.tests.test_lock',
4018
'bzrlib.tests.test_lockable_files',
4019
'bzrlib.tests.test_lockdir',
4020
'bzrlib.tests.test_log',
4021
'bzrlib.tests.test_lru_cache',
4022
'bzrlib.tests.test_lsprof',
4023
'bzrlib.tests.test_mail_client',
4024
'bzrlib.tests.test_matchers',
4025
'bzrlib.tests.test_memorytree',
4026
'bzrlib.tests.test_merge',
4027
'bzrlib.tests.test_merge3',
4028
'bzrlib.tests.test_merge_core',
4029
'bzrlib.tests.test_merge_directive',
4030
'bzrlib.tests.test_mergetools',
4031
'bzrlib.tests.test_missing',
4032
'bzrlib.tests.test_msgeditor',
4033
'bzrlib.tests.test_multiparent',
4034
'bzrlib.tests.test_mutabletree',
4035
'bzrlib.tests.test_nonascii',
4036
'bzrlib.tests.test_options',
4037
'bzrlib.tests.test_osutils',
4038
'bzrlib.tests.test_osutils_encodings',
4039
'bzrlib.tests.test_pack',
4040
'bzrlib.tests.test_patch',
4041
'bzrlib.tests.test_patches',
4042
'bzrlib.tests.test_permissions',
4043
'bzrlib.tests.test_plugins',
4044
'bzrlib.tests.test_progress',
4045
'bzrlib.tests.test_pyutils',
4046
'bzrlib.tests.test_read_bundle',
4047
'bzrlib.tests.test_reconcile',
4048
'bzrlib.tests.test_reconfigure',
4049
'bzrlib.tests.test_registry',
4050
'bzrlib.tests.test_remote',
4051
'bzrlib.tests.test_rename_map',
4052
'bzrlib.tests.test_repository',
4053
'bzrlib.tests.test_revert',
4054
'bzrlib.tests.test_revision',
4055
'bzrlib.tests.test_revisionspec',
4056
'bzrlib.tests.test_revisiontree',
4057
'bzrlib.tests.test_rio',
4058
'bzrlib.tests.test_rules',
4059
'bzrlib.tests.test_sampler',
4060
'bzrlib.tests.test_scenarios',
4061
'bzrlib.tests.test_script',
4062
'bzrlib.tests.test_selftest',
4063
'bzrlib.tests.test_serializer',
4064
'bzrlib.tests.test_setup',
4065
'bzrlib.tests.test_sftp_transport',
4066
'bzrlib.tests.test_shelf',
4067
'bzrlib.tests.test_shelf_ui',
4068
'bzrlib.tests.test_smart',
4069
'bzrlib.tests.test_smart_add',
4070
'bzrlib.tests.test_smart_request',
4071
'bzrlib.tests.test_smart_signals',
4072
'bzrlib.tests.test_smart_transport',
4073
'bzrlib.tests.test_smtp_connection',
4074
'bzrlib.tests.test_source',
4075
'bzrlib.tests.test_ssh_transport',
4076
'bzrlib.tests.test_status',
4077
'bzrlib.tests.test_store',
4078
'bzrlib.tests.test_strace',
4079
'bzrlib.tests.test_subsume',
4080
'bzrlib.tests.test_switch',
4081
'bzrlib.tests.test_symbol_versioning',
4082
'bzrlib.tests.test_tag',
4083
'bzrlib.tests.test_test_server',
4084
'bzrlib.tests.test_testament',
4085
'bzrlib.tests.test_textfile',
4086
'bzrlib.tests.test_textmerge',
4087
'bzrlib.tests.test_cethread',
4088
'bzrlib.tests.test_timestamp',
4089
'bzrlib.tests.test_trace',
4090
'bzrlib.tests.test_transactions',
4091
'bzrlib.tests.test_transform',
4092
'bzrlib.tests.test_transport',
4093
'bzrlib.tests.test_transport_log',
4094
'bzrlib.tests.test_tree',
4095
'bzrlib.tests.test_treebuilder',
4096
'bzrlib.tests.test_treeshape',
4097
'bzrlib.tests.test_tsort',
4098
'bzrlib.tests.test_tuned_gzip',
4099
'bzrlib.tests.test_ui',
4100
'bzrlib.tests.test_uncommit',
4101
'bzrlib.tests.test_upgrade',
4102
'bzrlib.tests.test_upgrade_stacked',
4103
'bzrlib.tests.test_urlutils',
4104
'bzrlib.tests.test_utextwrap',
4105
'bzrlib.tests.test_version',
4106
'bzrlib.tests.test_version_info',
4107
'bzrlib.tests.test_versionedfile',
4108
'bzrlib.tests.test_vf_search',
4109
'bzrlib.tests.test_weave',
4110
'bzrlib.tests.test_whitebox',
4111
'bzrlib.tests.test_win32utils',
4112
'bzrlib.tests.test_workingtree',
4113
'bzrlib.tests.test_workingtree_4',
4114
'bzrlib.tests.test_wsgi',
4115
'bzrlib.tests.test_xml',
4119
def _test_suite_modules_to_doctest():
4120
"""Return the list of modules to doctest."""
4122
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4126
'bzrlib.branchbuilder',
4127
'bzrlib.decorators',
4129
'bzrlib.iterablefile',
4134
'bzrlib.symbol_versioning',
4136
'bzrlib.tests.fixtures',
4138
'bzrlib.transport.http',
4139
'bzrlib.version_info_formats.format_custom',
4143
def test_suite(keep_only=None, starting_with=None):
4144
"""Build and return TestSuite for the whole of bzrlib.
4146
:param keep_only: A list of test ids limiting the suite returned.
4148
:param starting_with: An id limiting the suite returned to the tests
4151
This function can be replaced if you need to change the default test
4152
suite on a global basis, but it is not encouraged.
4155
loader = TestUtil.TestLoader()
4157
if keep_only is not None:
4158
id_filter = TestIdList(keep_only)
4160
# We take precedence over keep_only because *at loading time* using
4161
# both options means we will load less tests for the same final result.
4162
def interesting_module(name):
4163
for start in starting_with:
4165
# Either the module name starts with the specified string
4166
name.startswith(start)
4167
# or it may contain tests starting with the specified string
4168
or start.startswith(name)
4172
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4174
elif keep_only is not None:
4175
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4176
def interesting_module(name):
4177
return id_filter.refers_to(name)
4180
loader = TestUtil.TestLoader()
4181
def interesting_module(name):
4182
# No filtering, all modules are interesting
4185
suite = loader.suiteClass()
4187
# modules building their suite with loadTestsFromModuleNames
4188
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4190
for mod in _test_suite_modules_to_doctest():
4191
if not interesting_module(mod):
4192
# No tests to keep here, move along
4195
# note that this really does mean "report only" -- doctest
4196
# still runs the rest of the examples
4197
doc_suite = IsolatedDocTestSuite(
4198
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
4199
except ValueError, e:
4200
print '**failed to get doctest for: %s\n%s' % (mod, e)
4202
if len(doc_suite._tests) == 0:
4203
raise errors.BzrError("no doctests found in %s" % (mod,))
4204
suite.addTest(doc_suite)
4206
default_encoding = sys.getdefaultencoding()
4207
for name, plugin in _mod_plugin.plugins().items():
4208
if not interesting_module(plugin.module.__name__):
4210
plugin_suite = plugin.test_suite()
4211
# We used to catch ImportError here and turn it into just a warning,
4212
# but really if you don't have --no-plugins this should be a failure.
4213
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4214
if plugin_suite is None:
4215
plugin_suite = plugin.load_plugin_tests(loader)
4216
if plugin_suite is not None:
4217
suite.addTest(plugin_suite)
4218
if default_encoding != sys.getdefaultencoding():
4220
'Plugin "%s" tried to reset default encoding to: %s', name,
4221
sys.getdefaultencoding())
4223
sys.setdefaultencoding(default_encoding)
4225
if keep_only is not None:
4226
# Now that the referred modules have loaded their tests, keep only the
4228
suite = filter_suite_by_id_list(suite, id_filter)
4229
# Do some sanity checks on the id_list filtering
4230
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4232
# The tester has used both keep_only and starting_with, so he is
4233
# already aware that some tests are excluded from the list, there
4234
# is no need to tell him which.
4237
# Some tests mentioned in the list are not in the test suite. The
4238
# list may be out of date, report to the tester.
4239
for id in not_found:
4240
trace.warning('"%s" not found in the test suite', id)
4241
for id in duplicates:
4242
trace.warning('"%s" is used as an id by several tests', id)
4247
def multiply_scenarios(*scenarios):
4248
"""Multiply two or more iterables of scenarios.
4250
It is safe to pass scenario generators or iterators.
4252
:returns: A list of compound scenarios: the cross-product of all
4253
scenarios, with the names concatenated and the parameters
4256
return reduce(_multiply_two_scenarios, map(list, scenarios))
4259
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4260
"""Multiply two sets of scenarios.
4262
:returns: the cartesian product of the two sets of scenarios, that is
4263
a scenario for every possible combination of a left scenario and a
4267
('%s,%s' % (left_name, right_name),
4268
dict(left_dict.items() + right_dict.items()))
4269
for left_name, left_dict in scenarios_left
4270
for right_name, right_dict in scenarios_right]
4273
def multiply_tests(tests, scenarios, result):
4274
"""Multiply tests_list by scenarios into result.
4276
This is the core workhorse for test parameterisation.
4278
Typically the load_tests() method for a per-implementation test suite will
4279
call multiply_tests and return the result.
4281
:param tests: The tests to parameterise.
4282
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4283
scenario_param_dict).
4284
:param result: A TestSuite to add created tests to.
4286
This returns the passed in result TestSuite with the cross product of all
4287
the tests repeated once for each scenario. Each test is adapted by adding
4288
the scenario name at the end of its id(), and updating the test object's
4289
__dict__ with the scenario_param_dict.
4291
>>> import bzrlib.tests.test_sampler
4292
>>> r = multiply_tests(
4293
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4294
... [('one', dict(param=1)),
4295
... ('two', dict(param=2))],
4296
... TestUtil.TestSuite())
4297
>>> tests = list(iter_suite_tests(r))
4301
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4307
for test in iter_suite_tests(tests):
4308
apply_scenarios(test, scenarios, result)
4312
def apply_scenarios(test, scenarios, result):
4313
"""Apply the scenarios in scenarios to test and add to result.
4315
:param test: The test to apply scenarios to.
4316
:param scenarios: An iterable of scenarios to apply to test.
4318
:seealso: apply_scenario
4320
for scenario in scenarios:
4321
result.addTest(apply_scenario(test, scenario))
4325
def apply_scenario(test, scenario):
4326
"""Copy test and apply scenario to it.
4328
:param test: A test to adapt.
4329
:param scenario: A tuple describing the scenarion.
4330
The first element of the tuple is the new test id.
4331
The second element is a dict containing attributes to set on the
4333
:return: The adapted test.
4335
new_id = "%s(%s)" % (test.id(), scenario[0])
4336
new_test = clone_test(test, new_id)
4337
for name, value in scenario[1].items():
4338
setattr(new_test, name, value)
4342
def clone_test(test, new_id):
4343
"""Clone a test giving it a new id.
4345
:param test: The test to clone.
4346
:param new_id: The id to assign to it.
4347
:return: The new test.
4349
new_test = copy.copy(test)
4350
new_test.id = lambda: new_id
4351
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4352
# causes cloned tests to share the 'details' dict. This makes it hard to
4353
# read the test output for parameterized tests, because tracebacks will be
4354
# associated with irrelevant tests.
4356
details = new_test._TestCase__details
4357
except AttributeError:
4358
# must be a different version of testtools than expected. Do nothing.
4361
# Reset the '__details' dict.
4362
new_test._TestCase__details = {}
4366
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4368
"""Helper for permutating tests against an extension module.
4370
This is meant to be used inside a modules 'load_tests()' function. It will
4371
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4372
against both implementations. Setting 'test.module' to the appropriate
4373
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4375
:param standard_tests: A test suite to permute
4376
:param loader: A TestLoader
4377
:param py_module_name: The python path to a python module that can always
4378
be loaded, and will be considered the 'python' implementation. (eg
4379
'bzrlib._chk_map_py')
4380
:param ext_module_name: The python path to an extension module. If the
4381
module cannot be loaded, a single test will be added, which notes that
4382
the module is not available. If it can be loaded, all standard_tests
4383
will be run against that module.
4384
:return: (suite, feature) suite is a test-suite that has all the permuted
4385
tests. feature is the Feature object that can be used to determine if
4386
the module is available.
4389
from bzrlib.tests.features import ModuleAvailableFeature
4390
py_module = pyutils.get_named_object(py_module_name)
4392
('python', {'module': py_module}),
4394
suite = loader.suiteClass()
4395
feature = ModuleAvailableFeature(ext_module_name)
4396
if feature.available():
4397
scenarios.append(('C', {'module': feature.module}))
4399
# the compiled module isn't available, so we add a failing test
4400
class FailWithoutFeature(TestCase):
4401
def test_fail(self):
4402
self.requireFeature(feature)
4403
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4404
result = multiply_tests(standard_tests, scenarios, suite)
4405
return result, feature
4408
def _rmtree_temp_dir(dirname, test_id=None):
4409
# If LANG=C we probably have created some bogus paths
4410
# which rmtree(unicode) will fail to delete
4411
# so make sure we are using rmtree(str) to delete everything
4412
# except on win32, where rmtree(str) will fail
4413
# since it doesn't have the property of byte-stream paths
4414
# (they are either ascii or mbcs)
4415
if sys.platform == 'win32':
4416
# make sure we are using the unicode win32 api
4417
dirname = unicode(dirname)
4419
dirname = dirname.encode(sys.getfilesystemencoding())
4421
osutils.rmtree(dirname)
4423
# We don't want to fail here because some useful display will be lost
4424
# otherwise. Polluting the tmp dir is bad, but not giving all the
4425
# possible info to the test runner is even worse.
4427
ui.ui_factory.clear_term()
4428
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4429
# Ugly, but the last thing we want here is fail, so bear with it.
4430
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4431
).encode('ascii', 'replace')
4432
sys.stderr.write('Unable to remove testing dir %s\n%s'
4433
% (os.path.basename(dirname), printable_e))
4436
def probe_unicode_in_user_encoding():
4437
"""Try to encode several unicode strings to use in unicode-aware tests.
4438
Return first successfull match.
4440
:return: (unicode value, encoded plain string value) or (None, None)
4442
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4443
for uni_val in possible_vals:
4445
str_val = uni_val.encode(osutils.get_user_encoding())
4446
except UnicodeEncodeError:
4447
# Try a different character
4450
return uni_val, str_val
4454
def probe_bad_non_ascii(encoding):
4455
"""Try to find [bad] character with code [128..255]
4456
that cannot be decoded to unicode in some encoding.
4457
Return None if all non-ascii characters is valid
4460
for i in xrange(128, 256):
4463
char.decode(encoding)
4464
except UnicodeDecodeError:
4469
# Only define SubUnitBzrRunner if subunit is available.
4471
from subunit import TestProtocolClient
4472
from subunit.test_results import AutoTimingTestResultDecorator
4473
class SubUnitBzrProtocolClient(TestProtocolClient):
4475
def stopTest(self, test):
4476
super(SubUnitBzrProtocolClient, self).stopTest(test)
4477
_clear__type_equality_funcs(test)
4479
def addSuccess(self, test, details=None):
4480
# The subunit client always includes the details in the subunit
4481
# stream, but we don't want to include it in ours.
4482
if details is not None and 'log' in details:
4484
return super(SubUnitBzrProtocolClient, self).addSuccess(
4487
class SubUnitBzrRunner(TextTestRunner):
4488
def run(self, test):
4489
result = AutoTimingTestResultDecorator(
4490
SubUnitBzrProtocolClient(self.stream))
4497
# API compatibility for old plugins; see bug 892622.
4500
'HTTPServerFeature',
4501
'ModuleAvailableFeature',
4502
'HTTPSServerFeature', 'SymlinkFeature', 'HardlinkFeature',
4503
'OsFifoFeature', 'UnicodeFilenameFeature',
4504
'ByteStringNamedFilesystem', 'UTF8Filesystem',
4505
'BreakinFeature', 'CaseInsCasePresFilenameFeature',
4506
'CaseInsensitiveFilesystemFeature', 'case_sensitive_filesystem_feature',
4507
'posix_permissions_feature',
4509
globals()[name] = _CompatabilityThunkFeature(
4510
symbol_versioning.deprecated_in((2, 5, 0)),
4511
'bzrlib.tests', name,
4512
name, 'bzrlib.tests.features')
4515
for (old_name, new_name) in [
4516
('UnicodeFilename', 'UnicodeFilenameFeature'),
4518
globals()[name] = _CompatabilityThunkFeature(
4519
symbol_versioning.deprecated_in((2, 5, 0)),
4520
'bzrlib.tests', old_name,
4521
new_name, 'bzrlib.tests.features')
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)
added
removed
bzrlib/selftest/__init__.py
