1
# Copyright (C) 2005 by Canonical Ltd
1
# Copyright (C) 2005-2011 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from testsweet import TestBase, run_suite, InTempDir
21
MODULES_TO_DOCTEST = []
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.merge_core
38
from doctest import DocTestSuite
45
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
46
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
47
if m not in MODULES_TO_DOCTEST:
48
MODULES_TO_DOCTEST.append(m)
50
for m in (bzrlib.selftest.whitebox,
51
bzrlib.selftest.versioning,
52
bzrlib.selftest.testmerge3,
53
bzrlib.selftest.testhashcache,
54
bzrlib.selftest.teststatus,
55
bzrlib.selftest.blackbox,
56
bzrlib.selftest.testhashcache,
57
bzrlib.selftest.testrevisionnamespaces,
58
bzrlib.selftest.testbranch,
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
'XDG_CONFIG_HOME': None,
141
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
142
# tests do check our impls match APPDATA
143
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
147
'BZREMAIL': None, # may still be present in the environment
148
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
149
'BZR_PROGRESS_BAR': None,
150
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
151
# as a base class instead of TestCaseInTempDir. Tests inheriting from
152
# TestCase should not use disk resources, BZR_LOG is one.
153
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
154
'BZR_PLUGIN_PATH': None,
155
'BZR_DISABLE_PLUGINS': None,
156
'BZR_PLUGINS_AT': None,
157
'BZR_CONCURRENCY': None,
158
# Make sure that any text ui tests are consistent regardless of
159
# the environment the test case is run in; you may want tests that
160
# test other combinations. 'dumb' is a reasonable guess for tests
161
# going to a pipe or a StringIO.
167
'SSH_AUTH_SOCK': None,
177
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
178
# least. If you do (care), please update this comment
182
'BZR_REMOTE_PATH': None,
183
# Generally speaking, we don't want apport reporting on crashes in
184
# the test envirnoment unless we're specifically testing apport,
185
# so that it doesn't leak into the real system environment. We
186
# use an env var so it propagates to subprocesses.
187
'APPORT_DISABLE': '1',
191
def override_os_environ(test, env=None):
192
"""Modify os.environ keeping a copy.
194
:param test: A test instance
196
:param env: A dict containing variable definitions to be installed
199
env = isolated_environ
200
test._original_os_environ = dict([(var, value)
201
for var, value in os.environ.iteritems()])
202
for var, value in env.iteritems():
203
osutils.set_or_unset_env(var, value)
204
if var not in test._original_os_environ:
205
# The var is new, add it with a value of None, so
206
# restore_os_environ will delete it
207
test._original_os_environ[var] = None
210
def restore_os_environ(test):
211
"""Restore os.environ to its original state.
213
:param test: A test instance previously passed to override_os_environ.
215
for var, value in test._original_os_environ.iteritems():
216
# Restore the original value (or delete it if the value has been set to
217
# None in override_os_environ).
218
osutils.set_or_unset_env(var, value)
221
def _clear__type_equality_funcs(test):
222
"""Cleanup bound methods stored on TestCase instances
224
Clear the dict breaking a few (mostly) harmless cycles in the affected
225
unittests released with Python 2.6 and initial Python 2.7 versions.
227
For a few revisions between Python 2.7.1 and Python 2.7.2 that annoyingly
228
shipped in Oneiric, an object with no clear method was used, hence the
229
extra complications, see bug 809048 for details.
231
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
232
if type_equality_funcs is not None:
233
tef_clear = getattr(type_equality_funcs, "clear", None)
234
if tef_clear is None:
235
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
236
if tef_instance_dict is not None:
237
tef_clear = tef_instance_dict.clear
238
if tef_clear is not None:
242
class ExtendedTestResult(testtools.TextTestResult):
243
"""Accepts, reports and accumulates the results of running tests.
245
Compared to the unittest version this class adds support for
246
profiling, benchmarking, stopping as soon as a test fails, and
247
skipping tests. There are further-specialized subclasses for
248
different types of display.
250
When a test finishes, in whatever way, it calls one of the addSuccess,
251
addFailure or addError methods. These in turn may redirect to a more
252
specific case for the special test results supported by our extended
255
Note that just one of these objects is fed the results from many tests.
260
def __init__(self, stream, descriptions, verbosity,
264
"""Construct new TestResult.
266
:param bench_history: Optionally, a writable file object to accumulate
269
testtools.TextTestResult.__init__(self, stream)
270
if bench_history is not None:
271
from bzrlib.version import _get_bzr_source_tree
272
src_tree = _get_bzr_source_tree()
275
revision_id = src_tree.get_parent_ids()[0]
277
# XXX: if this is a brand new tree, do the same as if there
281
# XXX: If there's no branch, what should we do?
283
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
284
self._bench_history = bench_history
285
self.ui = ui.ui_factory
288
self.failure_count = 0
289
self.known_failure_count = 0
291
self.not_applicable_count = 0
292
self.unsupported = {}
294
self._overall_start_time = time.time()
295
self._strict = strict
296
self._first_thread_leaker_id = None
297
self._tests_leaking_threads_count = 0
298
self._traceback_from_test = None
300
def stopTestRun(self):
303
stopTime = time.time()
304
timeTaken = stopTime - self.startTime
305
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
306
# the parent class method is similar have to duplicate
307
self._show_list('ERROR', self.errors)
308
self._show_list('FAIL', self.failures)
309
self.stream.write(self.sep2)
310
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
311
run, run != 1 and "s" or "", timeTaken))
312
if not self.wasSuccessful():
313
self.stream.write("FAILED (")
314
failed, errored = map(len, (self.failures, self.errors))
316
self.stream.write("failures=%d" % failed)
318
if failed: self.stream.write(", ")
319
self.stream.write("errors=%d" % errored)
320
if self.known_failure_count:
321
if failed or errored: self.stream.write(", ")
322
self.stream.write("known_failure_count=%d" %
323
self.known_failure_count)
324
self.stream.write(")\n")
326
if self.known_failure_count:
327
self.stream.write("OK (known_failures=%d)\n" %
328
self.known_failure_count)
330
self.stream.write("OK\n")
331
if self.skip_count > 0:
332
skipped = self.skip_count
333
self.stream.write('%d test%s skipped\n' %
334
(skipped, skipped != 1 and "s" or ""))
336
for feature, count in sorted(self.unsupported.items()):
337
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
340
ok = self.wasStrictlySuccessful()
342
ok = self.wasSuccessful()
343
if self._first_thread_leaker_id:
345
'%s is leaking threads among %d leaking tests.\n' % (
346
self._first_thread_leaker_id,
347
self._tests_leaking_threads_count))
348
# We don't report the main thread as an active one.
350
'%d non-main threads were left active in the end.\n'
351
% (len(self._active_threads) - 1))
353
def getDescription(self, test):
356
def _extractBenchmarkTime(self, testCase, details=None):
357
"""Add a benchmark time for the current test case."""
358
if details and 'benchtime' in details:
359
return float(''.join(details['benchtime'].iter_bytes()))
360
return getattr(testCase, "_benchtime", None)
362
def _elapsedTestTimeString(self):
363
"""Return a time string for the overall time the current test has taken."""
364
return self._formatTime(self._delta_to_float(
365
self._now() - self._start_datetime))
367
def _testTimeString(self, testCase):
368
benchmark_time = self._extractBenchmarkTime(testCase)
369
if benchmark_time is not None:
370
return self._formatTime(benchmark_time) + "*"
372
return self._elapsedTestTimeString()
374
def _formatTime(self, seconds):
375
"""Format seconds as milliseconds with leading spaces."""
376
# some benchmarks can take thousands of seconds to run, so we need 8
378
return "%8dms" % (1000 * seconds)
380
def _shortened_test_description(self, test):
382
what = re.sub(r'^bzrlib\.tests\.', '', what)
385
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
386
# multiple times in a row, because the handler is added for
387
# each test but the container list is shared between cases.
388
# See lp:498869 lp:625574 and lp:637725 for background.
389
def _record_traceback_from_test(self, exc_info):
390
"""Store the traceback from passed exc_info tuple till"""
391
self._traceback_from_test = exc_info[2]
393
def startTest(self, test):
394
super(ExtendedTestResult, self).startTest(test)
398
self.report_test_start(test)
399
test.number = self.count
400
self._recordTestStartTime()
401
# Make testtools cases give us the real traceback on failure
402
addOnException = getattr(test, "addOnException", None)
403
if addOnException is not None:
404
addOnException(self._record_traceback_from_test)
405
# Only check for thread leaks on bzrlib derived test cases
406
if isinstance(test, TestCase):
407
test.addCleanup(self._check_leaked_threads, test)
409
def stopTest(self, test):
410
super(ExtendedTestResult, self).stopTest(test)
411
# Manually break cycles, means touching various private things but hey
412
getDetails = getattr(test, "getDetails", None)
413
if getDetails is not None:
415
_clear__type_equality_funcs(test)
416
self._traceback_from_test = None
418
def startTests(self):
419
self.report_tests_starting()
420
self._active_threads = threading.enumerate()
422
def _check_leaked_threads(self, test):
423
"""See if any threads have leaked since last call
425
A sample of live threads is stored in the _active_threads attribute,
426
when this method runs it compares the current live threads and any not
427
in the previous sample are treated as having leaked.
429
now_active_threads = set(threading.enumerate())
430
threads_leaked = now_active_threads.difference(self._active_threads)
432
self._report_thread_leak(test, threads_leaked, now_active_threads)
433
self._tests_leaking_threads_count += 1
434
if self._first_thread_leaker_id is None:
435
self._first_thread_leaker_id = test.id()
436
self._active_threads = now_active_threads
438
def _recordTestStartTime(self):
439
"""Record that a test has started."""
440
self._start_datetime = self._now()
442
def addError(self, test, err):
443
"""Tell result that test finished with an error.
445
Called from the TestCase run() method when the test
446
fails with an unexpected error.
448
self._post_mortem(self._traceback_from_test)
449
super(ExtendedTestResult, self).addError(test, err)
450
self.error_count += 1
451
self.report_error(test, err)
455
def addFailure(self, test, err):
456
"""Tell result that test failed.
458
Called from the TestCase run() method when the test
459
fails because e.g. an assert() method failed.
461
self._post_mortem(self._traceback_from_test)
462
super(ExtendedTestResult, self).addFailure(test, err)
463
self.failure_count += 1
464
self.report_failure(test, err)
468
def addSuccess(self, test, details=None):
469
"""Tell result that test completed successfully.
471
Called from the TestCase run()
473
if self._bench_history is not None:
474
benchmark_time = self._extractBenchmarkTime(test, details)
475
if benchmark_time is not None:
476
self._bench_history.write("%s %s\n" % (
477
self._formatTime(benchmark_time),
479
self.report_success(test)
480
super(ExtendedTestResult, self).addSuccess(test)
481
test._log_contents = ''
483
def addExpectedFailure(self, test, err):
484
self.known_failure_count += 1
485
self.report_known_failure(test, err)
487
def addUnexpectedSuccess(self, test, details=None):
488
"""Tell result the test unexpectedly passed, counting as a failure
490
When the minimum version of testtools required becomes 0.9.8 this
491
can be updated to use the new handling there.
493
super(ExtendedTestResult, self).addFailure(test, details=details)
494
self.failure_count += 1
495
self.report_unexpected_success(test,
496
"".join(details["reason"].iter_text()))
500
def addNotSupported(self, test, feature):
501
"""The test will not be run because of a missing feature.
503
# this can be called in two different ways: it may be that the
504
# test started running, and then raised (through requireFeature)
505
# UnavailableFeature. Alternatively this method can be called
506
# while probing for features before running the test code proper; in
507
# that case we will see startTest and stopTest, but the test will
508
# never actually run.
509
self.unsupported.setdefault(str(feature), 0)
510
self.unsupported[str(feature)] += 1
511
self.report_unsupported(test, feature)
513
def addSkip(self, test, reason):
514
"""A test has not run for 'reason'."""
516
self.report_skip(test, reason)
518
def addNotApplicable(self, test, reason):
519
self.not_applicable_count += 1
520
self.report_not_applicable(test, reason)
522
def _count_stored_tests(self):
523
"""Count of tests instances kept alive due to not succeeding"""
524
return self.error_count + self.failure_count + self.known_failure_count
526
def _post_mortem(self, tb=None):
527
"""Start a PDB post mortem session."""
528
if os.environ.get('BZR_TEST_PDB', None):
532
def progress(self, offset, whence):
533
"""The test is adjusting the count of tests to run."""
534
if whence == SUBUNIT_SEEK_SET:
535
self.num_tests = offset
536
elif whence == SUBUNIT_SEEK_CUR:
537
self.num_tests += offset
539
raise errors.BzrError("Unknown whence %r" % whence)
541
def report_tests_starting(self):
542
"""Display information before the test run begins"""
543
if getattr(sys, 'frozen', None) is None:
544
bzr_path = osutils.realpath(sys.argv[0])
546
bzr_path = sys.executable
548
'bzr selftest: %s\n' % (bzr_path,))
551
bzrlib.__path__[0],))
553
' bzr-%s python-%s %s\n' % (
554
bzrlib.version_string,
555
bzrlib._format_version_tuple(sys.version_info),
556
platform.platform(aliased=1),
558
self.stream.write('\n')
560
def report_test_start(self, test):
561
"""Display information on the test just about to be run"""
563
def _report_thread_leak(self, test, leaked_threads, active_threads):
564
"""Display information on a test that leaked one or more threads"""
565
# GZ 2010-09-09: A leak summary reported separately from the general
566
# thread debugging would be nice. Tests under subunit
567
# need something not using stream, perhaps adding a
568
# testtools details object would be fitting.
569
if 'threads' in selftest_debug_flags:
570
self.stream.write('%s is leaking, active is now %d\n' %
571
(test.id(), len(active_threads)))
573
def startTestRun(self):
574
self.startTime = time.time()
576
def report_success(self, test):
579
def wasStrictlySuccessful(self):
580
if self.unsupported or self.known_failure_count:
582
return self.wasSuccessful()
585
class TextTestResult(ExtendedTestResult):
586
"""Displays progress and results of tests in text form"""
588
def __init__(self, stream, descriptions, verbosity,
593
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
594
bench_history, strict)
595
# We no longer pass them around, but just rely on the UIFactory stack
598
warnings.warn("Passing pb to TextTestResult is deprecated")
599
self.pb = self.ui.nested_progress_bar()
600
self.pb.show_pct = False
601
self.pb.show_spinner = False
602
self.pb.show_eta = False,
603
self.pb.show_count = False
604
self.pb.show_bar = False
605
self.pb.update_latency = 0
606
self.pb.show_transport_activity = False
608
def stopTestRun(self):
609
# called when the tests that are going to run have run
612
super(TextTestResult, self).stopTestRun()
614
def report_tests_starting(self):
615
super(TextTestResult, self).report_tests_starting()
616
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
618
def _progress_prefix_text(self):
619
# the longer this text, the less space we have to show the test
621
a = '[%d' % self.count # total that have been run
622
# tests skipped as known not to be relevant are not important enough
624
## if self.skip_count:
625
## a += ', %d skip' % self.skip_count
626
## if self.known_failure_count:
627
## a += '+%dX' % self.known_failure_count
629
a +='/%d' % self.num_tests
631
runtime = time.time() - self._overall_start_time
633
a += '%dm%ds' % (runtime / 60, runtime % 60)
636
total_fail_count = self.error_count + self.failure_count
638
a += ', %d failed' % total_fail_count
639
# if self.unsupported:
640
# a += ', %d missing' % len(self.unsupported)
644
def report_test_start(self, test):
646
self._progress_prefix_text()
648
+ self._shortened_test_description(test))
650
def _test_description(self, test):
651
return self._shortened_test_description(test)
653
def report_error(self, test, err):
654
self.stream.write('ERROR: %s\n %s\n' % (
655
self._test_description(test),
659
def report_failure(self, test, err):
660
self.stream.write('FAIL: %s\n %s\n' % (
661
self._test_description(test),
665
def report_known_failure(self, test, err):
668
def report_unexpected_success(self, test, reason):
669
self.stream.write('FAIL: %s\n %s: %s\n' % (
670
self._test_description(test),
671
"Unexpected success. Should have failed",
675
def report_skip(self, test, reason):
678
def report_not_applicable(self, test, reason):
681
def report_unsupported(self, test, feature):
682
"""test cannot be run because feature is missing."""
685
class VerboseTestResult(ExtendedTestResult):
686
"""Produce long output, with one line per test run plus times"""
688
def _ellipsize_to_right(self, a_string, final_width):
689
"""Truncate and pad a string, keeping the right hand side"""
690
if len(a_string) > final_width:
691
result = '...' + a_string[3-final_width:]
694
return result.ljust(final_width)
696
def report_tests_starting(self):
697
self.stream.write('running %d tests...\n' % self.num_tests)
698
super(VerboseTestResult, self).report_tests_starting()
700
def report_test_start(self, test):
701
name = self._shortened_test_description(test)
702
width = osutils.terminal_width()
703
if width is not None:
704
# width needs space for 6 char status, plus 1 for slash, plus an
705
# 11-char time string, plus a trailing blank
706
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
708
self.stream.write(self._ellipsize_to_right(name, width-18))
710
self.stream.write(name)
713
def _error_summary(self, err):
715
return '%s%s' % (indent, err[1])
717
def report_error(self, test, err):
718
self.stream.write('ERROR %s\n%s\n'
719
% (self._testTimeString(test),
720
self._error_summary(err)))
722
def report_failure(self, test, err):
723
self.stream.write(' FAIL %s\n%s\n'
724
% (self._testTimeString(test),
725
self._error_summary(err)))
727
def report_known_failure(self, test, err):
728
self.stream.write('XFAIL %s\n%s\n'
729
% (self._testTimeString(test),
730
self._error_summary(err)))
732
def report_unexpected_success(self, test, reason):
733
self.stream.write(' FAIL %s\n%s: %s\n'
734
% (self._testTimeString(test),
735
"Unexpected success. Should have failed",
738
def report_success(self, test):
739
self.stream.write(' OK %s\n' % self._testTimeString(test))
740
for bench_called, stats in getattr(test, '_benchcalls', []):
741
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
742
stats.pprint(file=self.stream)
743
# flush the stream so that we get smooth output. This verbose mode is
744
# used to show the output in PQM.
747
def report_skip(self, test, reason):
748
self.stream.write(' SKIP %s\n%s\n'
749
% (self._testTimeString(test), reason))
751
def report_not_applicable(self, test, reason):
752
self.stream.write(' N/A %s\n %s\n'
753
% (self._testTimeString(test), reason))
755
def report_unsupported(self, test, feature):
756
"""test cannot be run because feature is missing."""
757
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
758
%(self._testTimeString(test), feature))
761
class TextTestRunner(object):
762
stop_on_failure = False
770
result_decorators=None,
772
"""Create a TextTestRunner.
774
:param result_decorators: An optional list of decorators to apply
775
to the result object being used by the runner. Decorators are
776
applied left to right - the first element in the list is the
779
# stream may know claim to know to write unicode strings, but in older
780
# pythons this goes sufficiently wrong that it is a bad idea. (
781
# specifically a built in file with encoding 'UTF-8' will still try
782
# to encode using ascii.
783
new_encoding = osutils.get_terminal_encoding()
784
codec = codecs.lookup(new_encoding)
785
if type(codec) is tuple:
789
encode = codec.encode
790
# GZ 2010-09-08: Really we don't want to be writing arbitrary bytes,
791
# so should swap to the plain codecs.StreamWriter
792
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream,
794
stream.encoding = new_encoding
796
self.descriptions = descriptions
797
self.verbosity = verbosity
798
self._bench_history = bench_history
799
self._strict = strict
800
self._result_decorators = result_decorators or []
803
"Run the given test case or test suite."
804
if self.verbosity == 1:
805
result_class = TextTestResult
806
elif self.verbosity >= 2:
807
result_class = VerboseTestResult
808
original_result = result_class(self.stream,
811
bench_history=self._bench_history,
814
# Signal to result objects that look at stop early policy to stop,
815
original_result.stop_early = self.stop_on_failure
816
result = original_result
817
for decorator in self._result_decorators:
818
result = decorator(result)
819
result.stop_early = self.stop_on_failure
820
result.startTestRun()
825
# higher level code uses our extended protocol to determine
826
# what exit code to give.
827
return original_result
830
def iter_suite_tests(suite):
831
"""Return all tests in a suite, recursing through nested suites"""
832
if isinstance(suite, unittest.TestCase):
834
elif isinstance(suite, unittest.TestSuite):
836
for r in iter_suite_tests(item):
839
raise Exception('unknown type %r for object %r'
840
% (type(suite), suite))
843
TestSkipped = testtools.testcase.TestSkipped
846
class TestNotApplicable(TestSkipped):
847
"""A test is not applicable to the situation where it was run.
849
This is only normally raised by parameterized tests, if they find that
850
the instance they're constructed upon does not support one aspect
855
# traceback._some_str fails to format exceptions that have the default
856
# __str__ which does an implicit ascii conversion. However, repr() on those
857
# objects works, for all that its not quite what the doctor may have ordered.
858
def _clever_some_str(value):
863
return repr(value).replace('\\n', '\n')
865
return '<unprintable %s object>' % type(value).__name__
867
traceback._some_str = _clever_some_str
870
# deprecated - use self.knownFailure(), or self.expectFailure.
871
KnownFailure = testtools.testcase._ExpectedFailure
874
class UnavailableFeature(Exception):
875
"""A feature required for this test was not available.
877
This can be considered a specialised form of SkippedTest.
879
The feature should be used to construct the exception.
883
class StringIOWrapper(object):
884
"""A wrapper around cStringIO which just adds an encoding attribute.
886
Internally we can check sys.stdout to see what the output encoding
887
should be. However, cStringIO has no encoding attribute that we can
888
set. So we wrap it instead.
893
def __init__(self, s=None):
895
self.__dict__['_cstring'] = StringIO(s)
897
self.__dict__['_cstring'] = StringIO()
899
def __getattr__(self, name, getattr=getattr):
900
return getattr(self.__dict__['_cstring'], name)
902
def __setattr__(self, name, val):
903
if name == 'encoding':
904
self.__dict__['encoding'] = val
906
return setattr(self._cstring, name, val)
909
class TestUIFactory(TextUIFactory):
910
"""A UI Factory for testing.
912
Hide the progress bar but emit note()s.
914
Allows get_password to be tested without real tty attached.
916
See also CannedInputUIFactory which lets you provide programmatic input in
919
# TODO: Capture progress events at the model level and allow them to be
920
# observed by tests that care.
922
# XXX: Should probably unify more with CannedInputUIFactory or a
923
# particular configuration of TextUIFactory, or otherwise have a clearer
924
# idea of how they're supposed to be different.
925
# See https://bugs.launchpad.net/bzr/+bug/408213
927
def __init__(self, stdout=None, stderr=None, stdin=None):
928
if stdin is not None:
929
# We use a StringIOWrapper to be able to test various
930
# encodings, but the user is still responsible to
931
# encode the string and to set the encoding attribute
932
# of StringIOWrapper.
933
stdin = StringIOWrapper(stdin)
934
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
936
def get_non_echoed_password(self):
937
"""Get password from stdin without trying to handle the echo mode"""
938
password = self.stdin.readline()
941
if password[-1] == '\n':
942
password = password[:-1]
945
def make_progress_view(self):
946
return NullProgressView()
949
def isolated_doctest_setUp(test):
950
override_os_environ(test)
953
def isolated_doctest_tearDown(test):
954
restore_os_environ(test)
957
def IsolatedDocTestSuite(*args, **kwargs):
958
"""Overrides doctest.DocTestSuite to handle isolation.
960
The method is really a factory and users are expected to use it as such.
963
kwargs['setUp'] = isolated_doctest_setUp
964
kwargs['tearDown'] = isolated_doctest_tearDown
965
return doctest.DocTestSuite(*args, **kwargs)
968
class TestCase(testtools.TestCase):
969
"""Base class for bzr unit tests.
971
Tests that need access to disk resources should subclass
972
TestCaseInTempDir not TestCase.
974
Error and debug log messages are redirected from their usual
975
location into a temporary file, the contents of which can be
976
retrieved by _get_log(). We use a real OS file, not an in-memory object,
977
so that it can also capture file IO. When the test completes this file
978
is read into memory and removed from disk.
980
There are also convenience functions to invoke bzr's command-line
981
routine, and to build and check bzr trees.
983
In addition to the usual method of overriding tearDown(), this class also
984
allows subclasses to register cleanup functions via addCleanup, which are
985
run in order as the object is torn down. It's less likely this will be
986
accidentally overlooked.
990
# record lsprof data when performing benchmark calls.
991
_gather_lsprof_in_benchmarks = False
993
def __init__(self, methodName='testMethod'):
994
super(TestCase, self).__init__(methodName)
995
self._directory_isolation = True
996
self.exception_handlers.insert(0,
997
(UnavailableFeature, self._do_unsupported_or_skip))
998
self.exception_handlers.insert(0,
999
(TestNotApplicable, self._do_not_applicable))
1002
super(TestCase, self).setUp()
1004
# At this point we're still accessing the config files in $BZR_HOME (as
1005
# set by the user running selftest).
1006
timeout = config.GlobalStack().get('selftest.timeout')
1008
timeout_fixture = fixtures.TimeoutFixture(timeout)
1009
timeout_fixture.setUp()
1010
self.addCleanup(timeout_fixture.cleanUp)
1012
for feature in getattr(self, '_test_needs_features', []):
1013
self.requireFeature(feature)
1014
self._cleanEnvironment()
1016
if bzrlib.global_state is not None:
1017
self.overrideAttr(bzrlib.global_state, 'cmdline_overrides',
1018
config.CommandLineStore())
1021
self._startLogFile()
1022
self._benchcalls = []
1023
self._benchtime = None
1025
self._track_transports()
1027
self._clear_debug_flags()
1028
# Isolate global verbosity level, to make sure it's reproducible
1029
# between tests. We should get rid of this altogether: bug 656694. --
1031
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
1032
self._log_files = set()
1033
# Each key in the ``_counters`` dict holds a value for a different
1034
# counter. When the test ends, addDetail() should be used to output the
1035
# counter values. This happens in install_counter_hook().
1037
if 'config_stats' in selftest_debug_flags:
1038
self._install_config_stats_hooks()
1039
# Do not use i18n for tests (unless the test reverses this)
1045
# The sys preserved stdin/stdout should allow blackbox tests debugging
1046
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
1047
).set_trace(sys._getframe().f_back)
1049
def discardDetail(self, name):
1050
"""Extend the addDetail, getDetails api so we can remove a detail.
1052
eg. bzr always adds the 'log' detail at startup, but we don't want to
1053
include it for skipped, xfail, etc tests.
1055
It is safe to call this for a detail that doesn't exist, in case this
1056
gets called multiple times.
1058
# We cheat. details is stored in __details which means we shouldn't
1059
# touch it. but getDetails() returns the dict directly, so we can
1061
details = self.getDetails()
1065
def install_counter_hook(self, hooks, name, counter_name=None):
1066
"""Install a counting hook.
1068
Any hook can be counted as long as it doesn't need to return a value.
1070
:param hooks: Where the hook should be installed.
1072
:param name: The hook name that will be counted.
1074
:param counter_name: The counter identifier in ``_counters``, defaults
1077
_counters = self._counters # Avoid closing over self
1078
if counter_name is None:
1080
if _counters.has_key(counter_name):
1081
raise AssertionError('%s is already used as a counter name'
1083
_counters[counter_name] = 0
1084
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1085
lambda: ['%d' % (_counters[counter_name],)]))
1086
def increment_counter(*args, **kwargs):
1087
_counters[counter_name] += 1
1088
label = 'count %s calls' % (counter_name,)
1089
hooks.install_named_hook(name, increment_counter, label)
1090
self.addCleanup(hooks.uninstall_named_hook, name, label)
1092
def _install_config_stats_hooks(self):
1093
"""Install config hooks to count hook calls.
1096
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1097
self.install_counter_hook(config.ConfigHooks, hook_name,
1098
'config.%s' % (hook_name,))
1100
# The OldConfigHooks are private and need special handling to protect
1101
# against recursive tests (tests that run other tests), so we just do
1102
# manually what registering them into _builtin_known_hooks will provide
1104
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1105
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1106
self.install_counter_hook(config.OldConfigHooks, hook_name,
1107
'old_config.%s' % (hook_name,))
1109
def _clear_debug_flags(self):
1110
"""Prevent externally set debug flags affecting tests.
1112
Tests that want to use debug flags can just set them in the
1113
debug_flags set during setup/teardown.
1115
# Start with a copy of the current debug flags we can safely modify.
1116
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1117
if 'allow_debug' not in selftest_debug_flags:
1118
debug.debug_flags.clear()
1119
if 'disable_lock_checks' not in selftest_debug_flags:
1120
debug.debug_flags.add('strict_locks')
1122
def _clear_hooks(self):
1123
# prevent hooks affecting tests
1124
known_hooks = hooks.known_hooks
1125
self._preserved_hooks = {}
1126
for key, (parent, name) in known_hooks.iter_parent_objects():
1127
current_hooks = getattr(parent, name)
1128
self._preserved_hooks[parent] = (name, current_hooks)
1129
self._preserved_lazy_hooks = hooks._lazy_hooks
1130
hooks._lazy_hooks = {}
1131
self.addCleanup(self._restoreHooks)
1132
for key, (parent, name) in known_hooks.iter_parent_objects():
1133
factory = known_hooks.get(key)
1134
setattr(parent, name, factory())
1135
# this hook should always be installed
1136
request._install_hook()
1138
def disable_directory_isolation(self):
1139
"""Turn off directory isolation checks."""
1140
self._directory_isolation = False
1142
def enable_directory_isolation(self):
1143
"""Enable directory isolation checks."""
1144
self._directory_isolation = True
1146
def _silenceUI(self):
1147
"""Turn off UI for duration of test"""
1148
# by default the UI is off; tests can turn it on if they want it.
1149
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1151
def _check_locks(self):
1152
"""Check that all lock take/release actions have been paired."""
1153
# We always check for mismatched locks. If a mismatch is found, we
1154
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1155
# case we just print a warning.
1157
acquired_locks = [lock for action, lock in self._lock_actions
1158
if action == 'acquired']
1159
released_locks = [lock for action, lock in self._lock_actions
1160
if action == 'released']
1161
broken_locks = [lock for action, lock in self._lock_actions
1162
if action == 'broken']
1163
# trivially, given the tests for lock acquistion and release, if we
1164
# have as many in each list, it should be ok. Some lock tests also
1165
# break some locks on purpose and should be taken into account by
1166
# considering that breaking a lock is just a dirty way of releasing it.
1167
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1169
'Different number of acquired and '
1170
'released or broken locks.\n'
1174
(acquired_locks, released_locks, broken_locks))
1175
if not self._lock_check_thorough:
1176
# Rather than fail, just warn
1177
print "Broken test %s: %s" % (self, message)
1181
def _track_locks(self):
1182
"""Track lock activity during tests."""
1183
self._lock_actions = []
1184
if 'disable_lock_checks' in selftest_debug_flags:
1185
self._lock_check_thorough = False
1187
self._lock_check_thorough = True
1189
self.addCleanup(self._check_locks)
1190
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1191
self._lock_acquired, None)
1192
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1193
self._lock_released, None)
1194
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1195
self._lock_broken, None)
1197
def _lock_acquired(self, result):
1198
self._lock_actions.append(('acquired', result))
1200
def _lock_released(self, result):
1201
self._lock_actions.append(('released', result))
1203
def _lock_broken(self, result):
1204
self._lock_actions.append(('broken', result))
1206
def permit_dir(self, name):
1207
"""Permit a directory to be used by this test. See permit_url."""
1208
name_transport = _mod_transport.get_transport_from_path(name)
1209
self.permit_url(name)
1210
self.permit_url(name_transport.base)
1212
def permit_url(self, url):
1213
"""Declare that url is an ok url to use in this test.
1215
Do this for memory transports, temporary test directory etc.
1217
Do not do this for the current working directory, /tmp, or any other
1218
preexisting non isolated url.
1220
if not url.endswith('/'):
1222
self._bzr_selftest_roots.append(url)
1224
def permit_source_tree_branch_repo(self):
1225
"""Permit the source tree bzr is running from to be opened.
1227
Some code such as bzrlib.version attempts to read from the bzr branch
1228
that bzr is executing from (if any). This method permits that directory
1229
to be used in the test suite.
1231
path = self.get_source_path()
1232
self.record_directory_isolation()
1235
workingtree.WorkingTree.open(path)
1236
except (errors.NotBranchError, errors.NoWorkingTree):
1237
raise TestSkipped('Needs a working tree of bzr sources')
1239
self.enable_directory_isolation()
1241
def _preopen_isolate_transport(self, transport):
1242
"""Check that all transport openings are done in the test work area."""
1243
while isinstance(transport, pathfilter.PathFilteringTransport):
1244
# Unwrap pathfiltered transports
1245
transport = transport.server.backing_transport.clone(
1246
transport._filter('.'))
1247
url = transport.base
1248
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1249
# urls it is given by prepending readonly+. This is appropriate as the
1250
# client shouldn't know that the server is readonly (or not readonly).
1251
# We could register all servers twice, with readonly+ prepending, but
1252
# that makes for a long list; this is about the same but easier to
1254
if url.startswith('readonly+'):
1255
url = url[len('readonly+'):]
1256
self._preopen_isolate_url(url)
1258
def _preopen_isolate_url(self, url):
1259
if not self._directory_isolation:
1261
if self._directory_isolation == 'record':
1262
self._bzr_selftest_roots.append(url)
1264
# This prevents all transports, including e.g. sftp ones backed on disk
1265
# from working unless they are explicitly granted permission. We then
1266
# depend on the code that sets up test transports to check that they are
1267
# appropriately isolated and enable their use by calling
1268
# self.permit_transport()
1269
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1270
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1271
% (url, self._bzr_selftest_roots))
1273
def record_directory_isolation(self):
1274
"""Gather accessed directories to permit later access.
1276
This is used for tests that access the branch bzr is running from.
1278
self._directory_isolation = "record"
1280
def start_server(self, transport_server, backing_server=None):
1281
"""Start transport_server for this test.
1283
This starts the server, registers a cleanup for it and permits the
1284
server's urls to be used.
1286
if backing_server is None:
1287
transport_server.start_server()
1289
transport_server.start_server(backing_server)
1290
self.addCleanup(transport_server.stop_server)
1291
# Obtain a real transport because if the server supplies a password, it
1292
# will be hidden from the base on the client side.
1293
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1294
# Some transport servers effectively chroot the backing transport;
1295
# others like SFTPServer don't - users of the transport can walk up the
1296
# transport to read the entire backing transport. This wouldn't matter
1297
# except that the workdir tests are given - and that they expect the
1298
# server's url to point at - is one directory under the safety net. So
1299
# Branch operations into the transport will attempt to walk up one
1300
# directory. Chrooting all servers would avoid this but also mean that
1301
# we wouldn't be testing directly against non-root urls. Alternatively
1302
# getting the test framework to start the server with a backing server
1303
# at the actual safety net directory would work too, but this then
1304
# means that the self.get_url/self.get_transport methods would need
1305
# to transform all their results. On balance its cleaner to handle it
1306
# here, and permit a higher url when we have one of these transports.
1307
if t.base.endswith('/work/'):
1308
# we have safety net/test root/work
1309
t = t.clone('../..')
1310
elif isinstance(transport_server,
1311
test_server.SmartTCPServer_for_testing):
1312
# The smart server adds a path similar to work, which is traversed
1313
# up from by the client. But the server is chrooted - the actual
1314
# backing transport is not escaped from, and VFS requests to the
1315
# root will error (because they try to escape the chroot).
1317
while t2.base != t.base:
1320
self.permit_url(t.base)
1322
def _track_transports(self):
1323
"""Install checks for transport usage."""
1324
# TestCase has no safe place it can write to.
1325
self._bzr_selftest_roots = []
1326
# Currently the easiest way to be sure that nothing is going on is to
1327
# hook into bzr dir opening. This leaves a small window of error for
1328
# transport tests, but they are well known, and we can improve on this
1330
controldir.ControlDir.hooks.install_named_hook("pre_open",
1331
self._preopen_isolate_transport, "Check bzr directories are safe.")
1333
def _ndiff_strings(self, a, b):
1334
"""Return ndiff between two strings containing lines.
1336
A trailing newline is added if missing to make the strings
1338
if b and b[-1] != '\n':
1340
if a and a[-1] != '\n':
1342
difflines = difflib.ndiff(a.splitlines(True),
1344
linejunk=lambda x: False,
1345
charjunk=lambda x: False)
1346
return ''.join(difflines)
1348
def assertEqual(self, a, b, message=''):
1352
except UnicodeError, e:
1353
# If we can't compare without getting a UnicodeError, then
1354
# obviously they are different
1355
trace.mutter('UnicodeError: %s', e)
1358
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1360
pprint.pformat(a), pprint.pformat(b)))
1362
assertEquals = assertEqual
1364
def assertEqualDiff(self, a, b, message=None):
1365
"""Assert two texts are equal, if not raise an exception.
1367
This is intended for use with multi-line strings where it can
1368
be hard to find the differences by eye.
1370
# TODO: perhaps override assertEquals to call this for strings?
1374
message = "texts not equal:\n"
1376
message = 'first string is missing a final newline.\n'
1378
message = 'second string is missing a final newline.\n'
1379
raise AssertionError(message +
1380
self._ndiff_strings(a, b))
1382
def assertEqualMode(self, mode, mode_test):
1383
self.assertEqual(mode, mode_test,
1384
'mode mismatch %o != %o' % (mode, mode_test))
1386
def assertEqualStat(self, expected, actual):
1387
"""assert that expected and actual are the same stat result.
1389
:param expected: A stat result.
1390
:param actual: A stat result.
1391
:raises AssertionError: If the expected and actual stat values differ
1392
other than by atime.
1394
self.assertEqual(expected.st_size, actual.st_size,
1395
'st_size did not match')
1396
self.assertEqual(expected.st_mtime, actual.st_mtime,
1397
'st_mtime did not match')
1398
self.assertEqual(expected.st_ctime, actual.st_ctime,
1399
'st_ctime did not match')
1400
if sys.platform == 'win32':
1401
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1402
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1403
# odd. We just force it to always be 0 to avoid any problems.
1404
self.assertEqual(0, expected.st_dev)
1405
self.assertEqual(0, actual.st_dev)
1406
self.assertEqual(0, expected.st_ino)
1407
self.assertEqual(0, actual.st_ino)
1409
self.assertEqual(expected.st_dev, actual.st_dev,
1410
'st_dev did not match')
1411
self.assertEqual(expected.st_ino, actual.st_ino,
1412
'st_ino did not match')
1413
self.assertEqual(expected.st_mode, actual.st_mode,
1414
'st_mode did not match')
1416
def assertLength(self, length, obj_with_len):
1417
"""Assert that obj_with_len is of length length."""
1418
if len(obj_with_len) != length:
1419
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1420
length, len(obj_with_len), obj_with_len))
1422
def assertLogsError(self, exception_class, func, *args, **kwargs):
1423
"""Assert that `func(*args, **kwargs)` quietly logs a specific error.
1426
orig_log_exception_quietly = trace.log_exception_quietly
1429
orig_log_exception_quietly()
1430
captured.append(sys.exc_info()[1])
1431
trace.log_exception_quietly = capture
1432
func(*args, **kwargs)
1434
trace.log_exception_quietly = orig_log_exception_quietly
1435
self.assertLength(1, captured)
1437
self.assertIsInstance(err, exception_class)
1440
def assertPositive(self, val):
1441
"""Assert that val is greater than 0."""
1442
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1444
def assertNegative(self, val):
1445
"""Assert that val is less than 0."""
1446
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1448
def assertStartsWith(self, s, prefix):
1449
if not s.startswith(prefix):
1450
raise AssertionError('string %r does not start with %r' % (s, prefix))
1452
def assertEndsWith(self, s, suffix):
1453
"""Asserts that s ends with suffix."""
1454
if not s.endswith(suffix):
1455
raise AssertionError('string %r does not end with %r' % (s, suffix))
1457
def assertContainsRe(self, haystack, needle_re, flags=0):
1458
"""Assert that a contains something matching a regular expression."""
1459
if not re.search(needle_re, haystack, flags):
1460
if '\n' in haystack or len(haystack) > 60:
1461
# a long string, format it in a more readable way
1462
raise AssertionError(
1463
'pattern "%s" not found in\n"""\\\n%s"""\n'
1464
% (needle_re, haystack))
1466
raise AssertionError('pattern "%s" not found in "%s"'
1467
% (needle_re, haystack))
1469
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1470
"""Assert that a does not match a regular expression"""
1471
if re.search(needle_re, haystack, flags):
1472
raise AssertionError('pattern "%s" found in "%s"'
1473
% (needle_re, haystack))
1475
def assertContainsString(self, haystack, needle):
1476
if haystack.find(needle) == -1:
1477
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1479
def assertNotContainsString(self, haystack, needle):
1480
if haystack.find(needle) != -1:
1481
self.fail("string %r found in '''%s'''" % (needle, haystack))
1483
def assertSubset(self, sublist, superlist):
1484
"""Assert that every entry in sublist is present in superlist."""
1485
missing = set(sublist) - set(superlist)
1486
if len(missing) > 0:
1487
raise AssertionError("value(s) %r not present in container %r" %
1488
(missing, superlist))
1490
def assertListRaises(self, excClass, func, *args, **kwargs):
1491
"""Fail unless excClass is raised when the iterator from func is used.
1493
Many functions can return generators this makes sure
1494
to wrap them in a list() call to make sure the whole generator
1495
is run, and that the proper exception is raised.
1498
list(func(*args, **kwargs))
1502
if getattr(excClass,'__name__', None) is not None:
1503
excName = excClass.__name__
1505
excName = str(excClass)
1506
raise self.failureException, "%s not raised" % excName
1508
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1509
"""Assert that a callable raises a particular exception.
1511
:param excClass: As for the except statement, this may be either an
1512
exception class, or a tuple of classes.
1513
:param callableObj: A callable, will be passed ``*args`` and
1516
Returns the exception so that you can examine it.
1519
callableObj(*args, **kwargs)
1523
if getattr(excClass,'__name__', None) is not None:
1524
excName = excClass.__name__
1527
excName = str(excClass)
1528
raise self.failureException, "%s not raised" % excName
1530
def assertIs(self, left, right, message=None):
1531
if not (left is right):
1532
if message is not None:
1533
raise AssertionError(message)
1535
raise AssertionError("%r is not %r." % (left, right))
1537
def assertIsNot(self, left, right, message=None):
1539
if message is not None:
1540
raise AssertionError(message)
1542
raise AssertionError("%r is %r." % (left, right))
1544
def assertTransportMode(self, transport, path, mode):
1545
"""Fail if a path does not have mode "mode".
1547
If modes are not supported on this transport, the assertion is ignored.
1549
if not transport._can_roundtrip_unix_modebits():
1551
path_stat = transport.stat(path)
1552
actual_mode = stat.S_IMODE(path_stat.st_mode)
1553
self.assertEqual(mode, actual_mode,
1554
'mode of %r incorrect (%s != %s)'
1555
% (path, oct(mode), oct(actual_mode)))
1557
def assertIsSameRealPath(self, path1, path2):
1558
"""Fail if path1 and path2 points to different files"""
1559
self.assertEqual(osutils.realpath(path1),
1560
osutils.realpath(path2),
1561
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1563
def assertIsInstance(self, obj, kls, msg=None):
1564
"""Fail if obj is not an instance of kls
1566
:param msg: Supplementary message to show if the assertion fails.
1568
if not isinstance(obj, kls):
1569
m = "%r is an instance of %s rather than %s" % (
1570
obj, obj.__class__, kls)
1575
def assertFileEqual(self, content, path):
1576
"""Fail if path does not contain 'content'."""
1577
self.assertPathExists(path)
1578
f = file(path, 'rb')
1583
self.assertEqualDiff(content, s)
1585
def assertDocstring(self, expected_docstring, obj):
1586
"""Fail if obj does not have expected_docstring"""
1588
# With -OO the docstring should be None instead
1589
self.assertIs(obj.__doc__, None)
1591
self.assertEqual(expected_docstring, obj.__doc__)
1593
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1594
def failUnlessExists(self, path):
1595
return self.assertPathExists(path)
1597
def assertPathExists(self, path):
1598
"""Fail unless path or paths, which may be abs or relative, exist."""
1599
if not isinstance(path, basestring):
1601
self.assertPathExists(p)
1603
self.assertTrue(osutils.lexists(path),
1604
path + " does not exist")
1606
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1607
def failIfExists(self, path):
1608
return self.assertPathDoesNotExist(path)
1610
def assertPathDoesNotExist(self, path):
1611
"""Fail if path or paths, which may be abs or relative, exist."""
1612
if not isinstance(path, basestring):
1614
self.assertPathDoesNotExist(p)
1616
self.assertFalse(osutils.lexists(path),
1619
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1620
"""A helper for callDeprecated and applyDeprecated.
1622
:param a_callable: A callable to call.
1623
:param args: The positional arguments for the callable
1624
:param kwargs: The keyword arguments for the callable
1625
:return: A tuple (warnings, result). result is the result of calling
1626
a_callable(``*args``, ``**kwargs``).
1629
def capture_warnings(msg, cls=None, stacklevel=None):
1630
# we've hooked into a deprecation specific callpath,
1631
# only deprecations should getting sent via it.
1632
self.assertEqual(cls, DeprecationWarning)
1633
local_warnings.append(msg)
1634
original_warning_method = symbol_versioning.warn
1635
symbol_versioning.set_warning_method(capture_warnings)
1637
result = a_callable(*args, **kwargs)
1639
symbol_versioning.set_warning_method(original_warning_method)
1640
return (local_warnings, result)
1642
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1643
"""Call a deprecated callable without warning the user.
1645
Note that this only captures warnings raised by symbol_versioning.warn,
1646
not other callers that go direct to the warning module.
1648
To test that a deprecated method raises an error, do something like
1649
this (remember that both assertRaises and applyDeprecated delays *args
1650
and **kwargs passing)::
1652
self.assertRaises(errors.ReservedId,
1653
self.applyDeprecated,
1654
deprecated_in((1, 5, 0)),
1658
:param deprecation_format: The deprecation format that the callable
1659
should have been deprecated with. This is the same type as the
1660
parameter to deprecated_method/deprecated_function. If the
1661
callable is not deprecated with this format, an assertion error
1663
:param a_callable: A callable to call. This may be a bound method or
1664
a regular function. It will be called with ``*args`` and
1666
:param args: The positional arguments for the callable
1667
:param kwargs: The keyword arguments for the callable
1668
:return: The result of a_callable(``*args``, ``**kwargs``)
1670
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1672
expected_first_warning = symbol_versioning.deprecation_string(
1673
a_callable, deprecation_format)
1674
if len(call_warnings) == 0:
1675
self.fail("No deprecation warning generated by call to %s" %
1677
self.assertEqual(expected_first_warning, call_warnings[0])
1680
def callCatchWarnings(self, fn, *args, **kw):
1681
"""Call a callable that raises python warnings.
1683
The caller's responsible for examining the returned warnings.
1685
If the callable raises an exception, the exception is not
1686
caught and propagates up to the caller. In that case, the list
1687
of warnings is not available.
1689
:returns: ([warning_object, ...], fn_result)
1691
# XXX: This is not perfect, because it completely overrides the
1692
# warnings filters, and some code may depend on suppressing particular
1693
# warnings. It's the easiest way to insulate ourselves from -Werror,
1694
# though. -- Andrew, 20071062
1696
def _catcher(message, category, filename, lineno, file=None, line=None):
1697
# despite the name, 'message' is normally(?) a Warning subclass
1699
wlist.append(message)
1700
saved_showwarning = warnings.showwarning
1701
saved_filters = warnings.filters
1703
warnings.showwarning = _catcher
1704
warnings.filters = []
1705
result = fn(*args, **kw)
1707
warnings.showwarning = saved_showwarning
1708
warnings.filters = saved_filters
1709
return wlist, result
1711
def callDeprecated(self, expected, callable, *args, **kwargs):
1712
"""Assert that a callable is deprecated in a particular way.
1714
This is a very precise test for unusual requirements. The
1715
applyDeprecated helper function is probably more suited for most tests
1716
as it allows you to simply specify the deprecation format being used
1717
and will ensure that that is issued for the function being called.
1719
Note that this only captures warnings raised by symbol_versioning.warn,
1720
not other callers that go direct to the warning module. To catch
1721
general warnings, use callCatchWarnings.
1723
:param expected: a list of the deprecation warnings expected, in order
1724
:param callable: The callable to call
1725
:param args: The positional arguments for the callable
1726
:param kwargs: The keyword arguments for the callable
1728
call_warnings, result = self._capture_deprecation_warnings(callable,
1730
self.assertEqual(expected, call_warnings)
1733
def _startLogFile(self):
1734
"""Setup a in-memory target for bzr and testcase log messages"""
1735
pseudo_log_file = StringIO()
1736
def _get_log_contents_for_weird_testtools_api():
1737
return [pseudo_log_file.getvalue().decode(
1738
"utf-8", "replace").encode("utf-8")]
1739
self.addDetail("log", content.Content(content.ContentType("text",
1740
"plain", {"charset": "utf8"}),
1741
_get_log_contents_for_weird_testtools_api))
1742
self._log_file = pseudo_log_file
1743
self._log_memento = trace.push_log_file(self._log_file)
1744
self.addCleanup(self._finishLogFile)
1746
def _finishLogFile(self):
1747
"""Flush and dereference the in-memory log for this testcase"""
1748
if trace._trace_file:
1749
# flush the log file, to get all content
1750
trace._trace_file.flush()
1751
trace.pop_log_file(self._log_memento)
1752
# The logging module now tracks references for cleanup so discard ours
1753
del self._log_memento
1755
def thisFailsStrictLockCheck(self):
1756
"""It is known that this test would fail with -Dstrict_locks.
1758
By default, all tests are run with strict lock checking unless
1759
-Edisable_lock_checks is supplied. However there are some tests which
1760
we know fail strict locks at this point that have not been fixed.
1761
They should call this function to disable the strict checking.
1763
This should be used sparingly, it is much better to fix the locking
1764
issues rather than papering over the problem by calling this function.
1766
debug.debug_flags.discard('strict_locks')
1768
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1769
"""Overrides an object attribute restoring it after the test.
1771
:note: This should be used with discretion; you should think about
1772
whether it's better to make the code testable without monkey-patching.
1774
:param obj: The object that will be mutated.
1776
:param attr_name: The attribute name we want to preserve/override in
1779
:param new: The optional value we want to set the attribute to.
1781
:returns: The actual attr value.
1783
# The actual value is captured by the call below
1784
value = getattr(obj, attr_name, _unitialized_attr)
1785
if value is _unitialized_attr:
1786
# When the test completes, the attribute should not exist, but if
1787
# we aren't setting a value, we don't need to do anything.
1788
if new is not _unitialized_attr:
1789
self.addCleanup(delattr, obj, attr_name)
1791
self.addCleanup(setattr, obj, attr_name, value)
1792
if new is not _unitialized_attr:
1793
setattr(obj, attr_name, new)
1796
def overrideEnv(self, name, new):
1797
"""Set an environment variable, and reset it after the test.
1799
:param name: The environment variable name.
1801
:param new: The value to set the variable to. If None, the
1802
variable is deleted from the environment.
1804
:returns: The actual variable value.
1806
value = osutils.set_or_unset_env(name, new)
1807
self.addCleanup(osutils.set_or_unset_env, name, value)
1810
def recordCalls(self, obj, attr_name):
1811
"""Monkeypatch in a wrapper that will record calls.
1813
The monkeypatch is automatically removed when the test concludes.
1815
:param obj: The namespace holding the reference to be replaced;
1816
typically a module, class, or object.
1817
:param attr_name: A string for the name of the attribute to
1819
:returns: A list that will be extended with one item every time the
1820
function is called, with a tuple of (args, kwargs).
1824
def decorator(*args, **kwargs):
1825
calls.append((args, kwargs))
1826
return orig(*args, **kwargs)
1827
orig = self.overrideAttr(obj, attr_name, decorator)
1830
def _cleanEnvironment(self):
1831
for name, value in isolated_environ.iteritems():
1832
self.overrideEnv(name, value)
1834
def _restoreHooks(self):
1835
for klass, (name, hooks) in self._preserved_hooks.items():
1836
setattr(klass, name, hooks)
1837
self._preserved_hooks.clear()
1838
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1839
self._preserved_lazy_hooks.clear()
1841
def knownFailure(self, reason):
1842
"""Declare that this test fails for a known reason
1844
Tests that are known to fail should generally be using expectedFailure
1845
with an appropriate reverse assertion if a change could cause the test
1846
to start passing. Conversely if the test has no immediate prospect of
1847
succeeding then using skip is more suitable.
1849
When this method is called while an exception is being handled, that
1850
traceback will be used, otherwise a new exception will be thrown to
1851
provide one but won't be reported.
1853
self._add_reason(reason)
1855
exc_info = sys.exc_info()
1856
if exc_info != (None, None, None):
1857
self._report_traceback(exc_info)
1860
raise self.failureException(reason)
1861
except self.failureException:
1862
exc_info = sys.exc_info()
1863
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1864
raise testtools.testcase._ExpectedFailure(exc_info)
1868
def _suppress_log(self):
1869
"""Remove the log info from details."""
1870
self.discardDetail('log')
1872
def _do_skip(self, result, reason):
1873
self._suppress_log()
1874
addSkip = getattr(result, 'addSkip', None)
1875
if not callable(addSkip):
1876
result.addSuccess(result)
1878
addSkip(self, reason)
1881
def _do_known_failure(self, result, e):
1882
self._suppress_log()
1883
err = sys.exc_info()
1884
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1885
if addExpectedFailure is not None:
1886
addExpectedFailure(self, err)
1888
result.addSuccess(self)
1891
def _do_not_applicable(self, result, e):
1893
reason = 'No reason given'
1896
self._suppress_log ()
1897
addNotApplicable = getattr(result, 'addNotApplicable', None)
1898
if addNotApplicable is not None:
1899
result.addNotApplicable(self, reason)
1901
self._do_skip(result, reason)
1904
def _report_skip(self, result, err):
1905
"""Override the default _report_skip.
1907
We want to strip the 'log' detail. If we waint until _do_skip, it has
1908
already been formatted into the 'reason' string, and we can't pull it
1911
self._suppress_log()
1912
super(TestCase, self)._report_skip(self, result, err)
1915
def _report_expected_failure(self, result, err):
1918
See _report_skip for motivation.
1920
self._suppress_log()
1921
super(TestCase, self)._report_expected_failure(self, result, err)
1924
def _do_unsupported_or_skip(self, result, e):
1926
self._suppress_log()
1927
addNotSupported = getattr(result, 'addNotSupported', None)
1928
if addNotSupported is not None:
1929
result.addNotSupported(self, reason)
1931
self._do_skip(result, reason)
1933
def time(self, callable, *args, **kwargs):
1934
"""Run callable and accrue the time it takes to the benchmark time.
1936
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1937
this will cause lsprofile statistics to be gathered and stored in
1940
if self._benchtime is None:
1941
self.addDetail('benchtime', content.Content(content.ContentType(
1942
"text", "plain"), lambda:[str(self._benchtime)]))
1946
if not self._gather_lsprof_in_benchmarks:
1947
return callable(*args, **kwargs)
1949
# record this benchmark
1950
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1952
self._benchcalls.append(((callable, args, kwargs), stats))
1955
self._benchtime += time.time() - start
1957
def log(self, *args):
1961
"""Get a unicode string containing the log from bzrlib.trace.
1963
Undecodable characters are replaced.
1965
return u"".join(self.getDetails()['log'].iter_text())
1967
def requireFeature(self, feature):
1968
"""This test requires a specific feature is available.
1970
:raises UnavailableFeature: When feature is not available.
1972
if not feature.available():
1973
raise UnavailableFeature(feature)
1975
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1977
"""Run bazaar command line, splitting up a string command line."""
1978
if isinstance(args, basestring):
1979
# shlex don't understand unicode strings,
1980
# so args should be plain string (bialix 20070906)
1981
args = list(shlex.split(str(args)))
1982
return self._run_bzr_core(args, retcode=retcode,
1983
encoding=encoding, stdin=stdin, working_dir=working_dir,
1986
def _run_bzr_core(self, args, retcode, encoding, stdin,
1988
# Clear chk_map page cache, because the contents are likely to mask
1990
chk_map.clear_cache()
1991
if encoding is None:
1992
encoding = osutils.get_user_encoding()
1993
stdout = StringIOWrapper()
1994
stderr = StringIOWrapper()
1995
stdout.encoding = encoding
1996
stderr.encoding = encoding
1998
self.log('run bzr: %r', args)
1999
# FIXME: don't call into logging here
2000
handler = trace.EncodedStreamHandler(stderr, errors="replace",
2002
logger = logging.getLogger('')
2003
logger.addHandler(handler)
2004
old_ui_factory = ui.ui_factory
2005
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
2008
if working_dir is not None:
2009
cwd = osutils.getcwd()
2010
os.chdir(working_dir)
2014
result = self.apply_redirected(
2015
ui.ui_factory.stdin,
2017
_mod_commands.run_bzr_catch_user_errors,
2019
except KeyboardInterrupt:
2020
# Reraise KeyboardInterrupt with contents of redirected stdout
2021
# and stderr as arguments, for tests which are interested in
2022
# stdout and stderr and are expecting the exception.
2023
out = stdout.getvalue()
2024
err = stderr.getvalue()
2026
self.log('output:\n%r', out)
2028
self.log('errors:\n%r', err)
2029
raise KeyboardInterrupt(out, err)
2031
logger.removeHandler(handler)
2032
ui.ui_factory = old_ui_factory
2036
out = stdout.getvalue()
2037
err = stderr.getvalue()
2039
self.log('output:\n%r', out)
2041
self.log('errors:\n%r', err)
2042
if retcode is not None:
2043
self.assertEquals(retcode, result,
2044
message='Unexpected return code')
2045
return result, out, err
2047
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
2048
working_dir=None, error_regexes=[], output_encoding=None):
2049
"""Invoke bzr, as if it were run from the command line.
2051
The argument list should not include the bzr program name - the
2052
first argument is normally the bzr command. Arguments may be
2053
passed in three ways:
2055
1- A list of strings, eg ["commit", "a"]. This is recommended
2056
when the command contains whitespace or metacharacters, or
2057
is built up at run time.
2059
2- A single string, eg "add a". This is the most convenient
2060
for hardcoded commands.
2062
This runs bzr through the interface that catches and reports
2063
errors, and with logging set to something approximating the
2064
default, so that error reporting can be checked.
2066
This should be the main method for tests that want to exercise the
2067
overall behavior of the bzr application (rather than a unit test
2068
or a functional test of the library.)
2070
This sends the stdout/stderr results into the test's log,
2071
where it may be useful for debugging. See also run_captured.
2073
:keyword stdin: A string to be used as stdin for the command.
2074
:keyword retcode: The status code the command should return;
2076
:keyword working_dir: The directory to run the command in
2077
:keyword error_regexes: A list of expected error messages. If
2078
specified they must be seen in the error output of the command.
2080
retcode, out, err = self._run_bzr_autosplit(
2085
working_dir=working_dir,
2087
self.assertIsInstance(error_regexes, (list, tuple))
2088
for regex in error_regexes:
2089
self.assertContainsRe(err, regex)
2092
def run_bzr_error(self, error_regexes, *args, **kwargs):
2093
"""Run bzr, and check that stderr contains the supplied regexes
2095
:param error_regexes: Sequence of regular expressions which
2096
must each be found in the error output. The relative ordering
2098
:param args: command-line arguments for bzr
2099
:param kwargs: Keyword arguments which are interpreted by run_bzr
2100
This function changes the default value of retcode to be 3,
2101
since in most cases this is run when you expect bzr to fail.
2103
:return: (out, err) The actual output of running the command (in case
2104
you want to do more inspection)
2108
# Make sure that commit is failing because there is nothing to do
2109
self.run_bzr_error(['no changes to commit'],
2110
['commit', '-m', 'my commit comment'])
2111
# Make sure --strict is handling an unknown file, rather than
2112
# giving us the 'nothing to do' error
2113
self.build_tree(['unknown'])
2114
self.run_bzr_error(['Commit refused because there are unknown files'],
2115
['commit', --strict', '-m', 'my commit comment'])
2117
kwargs.setdefault('retcode', 3)
2118
kwargs['error_regexes'] = error_regexes
2119
out, err = self.run_bzr(*args, **kwargs)
2122
def run_bzr_subprocess(self, *args, **kwargs):
2123
"""Run bzr in a subprocess for testing.
2125
This starts a new Python interpreter and runs bzr in there.
2126
This should only be used for tests that have a justifiable need for
2127
this isolation: e.g. they are testing startup time, or signal
2128
handling, or early startup code, etc. Subprocess code can't be
2129
profiled or debugged so easily.
2131
:keyword retcode: The status code that is expected. Defaults to 0. If
2132
None is supplied, the status code is not checked.
2133
:keyword env_changes: A dictionary which lists changes to environment
2134
variables. A value of None will unset the env variable.
2135
The values must be strings. The change will only occur in the
2136
child, so you don't need to fix the environment after running.
2137
:keyword universal_newlines: Convert CRLF => LF
2138
:keyword allow_plugins: By default the subprocess is run with
2139
--no-plugins to ensure test reproducibility. Also, it is possible
2140
for system-wide plugins to create unexpected output on stderr,
2141
which can cause unnecessary test failures.
2143
env_changes = kwargs.get('env_changes', {})
2144
working_dir = kwargs.get('working_dir', None)
2145
allow_plugins = kwargs.get('allow_plugins', False)
2147
if isinstance(args[0], list):
2149
elif isinstance(args[0], basestring):
2150
args = list(shlex.split(args[0]))
2152
raise ValueError("passing varargs to run_bzr_subprocess")
2153
process = self.start_bzr_subprocess(args, env_changes=env_changes,
2154
working_dir=working_dir,
2155
allow_plugins=allow_plugins)
2156
# We distinguish between retcode=None and retcode not passed.
2157
supplied_retcode = kwargs.get('retcode', 0)
2158
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
2159
universal_newlines=kwargs.get('universal_newlines', False),
2162
def start_bzr_subprocess(self, process_args, env_changes=None,
2163
skip_if_plan_to_signal=False,
2165
allow_plugins=False, stderr=subprocess.PIPE):
2166
"""Start bzr in a subprocess for testing.
2168
This starts a new Python interpreter and runs bzr in there.
2169
This should only be used for tests that have a justifiable need for
2170
this isolation: e.g. they are testing startup time, or signal
2171
handling, or early startup code, etc. Subprocess code can't be
2172
profiled or debugged so easily.
2174
:param process_args: a list of arguments to pass to the bzr executable,
2175
for example ``['--version']``.
2176
:param env_changes: A dictionary which lists changes to environment
2177
variables. A value of None will unset the env variable.
2178
The values must be strings. The change will only occur in the
2179
child, so you don't need to fix the environment after running.
2180
:param skip_if_plan_to_signal: raise TestSkipped when true and system
2181
doesn't support signalling subprocesses.
2182
:param allow_plugins: If False (default) pass --no-plugins to bzr.
2183
:param stderr: file to use for the subprocess's stderr. Valid values
2184
are those valid for the stderr argument of `subprocess.Popen`.
2185
Default value is ``subprocess.PIPE``.
2187
:returns: Popen object for the started process.
2189
if skip_if_plan_to_signal:
2190
if os.name != "posix":
2191
raise TestSkipped("Sending signals not supported")
2193
if env_changes is None:
2195
# Because $HOME is set to a tempdir for the context of a test, modules
2196
# installed in the user dir will not be found unless $PYTHONUSERBASE
2197
# gets set to the computed directory of this parent process.
2198
if site.USER_BASE is not None:
2199
env_changes["PYTHONUSERBASE"] = site.USER_BASE
2202
def cleanup_environment():
2203
for env_var, value in env_changes.iteritems():
2204
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2206
def restore_environment():
2207
for env_var, value in old_env.iteritems():
2208
osutils.set_or_unset_env(env_var, value)
2210
bzr_path = self.get_bzr_path()
2213
if working_dir is not None:
2214
cwd = osutils.getcwd()
2215
os.chdir(working_dir)
2218
# win32 subprocess doesn't support preexec_fn
2219
# so we will avoid using it on all platforms, just to
2220
# make sure the code path is used, and we don't break on win32
2221
cleanup_environment()
2222
# Include the subprocess's log file in the test details, in case
2223
# the test fails due to an error in the subprocess.
2224
self._add_subprocess_log(trace._get_bzr_log_filename())
2225
command = [sys.executable]
2226
# frozen executables don't need the path to bzr
2227
if getattr(sys, "frozen", None) is None:
2228
command.append(bzr_path)
2229
if not allow_plugins:
2230
command.append('--no-plugins')
2231
command.extend(process_args)
2232
process = self._popen(command, stdin=subprocess.PIPE,
2233
stdout=subprocess.PIPE,
2236
restore_environment()
2242
def _add_subprocess_log(self, log_file_path):
2243
if len(self._log_files) == 0:
2244
# Register an addCleanup func. We do this on the first call to
2245
# _add_subprocess_log rather than in TestCase.setUp so that this
2246
# addCleanup is registered after any cleanups for tempdirs that
2247
# subclasses might create, which will probably remove the log file
2249
self.addCleanup(self._subprocess_log_cleanup)
2250
# self._log_files is a set, so if a log file is reused we won't grab it
2252
self._log_files.add(log_file_path)
2254
def _subprocess_log_cleanup(self):
2255
for count, log_file_path in enumerate(self._log_files):
2256
# We use buffer_now=True to avoid holding the file open beyond
2257
# the life of this function, which might interfere with e.g.
2258
# cleaning tempdirs on Windows.
2259
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
2260
#detail_content = content.content_from_file(
2261
# log_file_path, buffer_now=True)
2262
with open(log_file_path, 'rb') as log_file:
2263
log_file_bytes = log_file.read()
2264
detail_content = content.Content(content.ContentType("text",
2265
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
2266
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
2269
def _popen(self, *args, **kwargs):
2270
"""Place a call to Popen.
2272
Allows tests to override this method to intercept the calls made to
2273
Popen for introspection.
2275
return subprocess.Popen(*args, **kwargs)
2277
def get_source_path(self):
2278
"""Return the path of the directory containing bzrlib."""
2279
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2281
def get_bzr_path(self):
2282
"""Return the path of the 'bzr' executable for this test suite."""
2283
bzr_path = os.path.join(self.get_source_path(), "bzr")
2284
if not os.path.isfile(bzr_path):
2285
# We are probably installed. Assume sys.argv is the right file
2286
bzr_path = sys.argv[0]
2289
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2290
universal_newlines=False, process_args=None):
2291
"""Finish the execution of process.
2293
:param process: the Popen object returned from start_bzr_subprocess.
2294
:param retcode: The status code that is expected. Defaults to 0. If
2295
None is supplied, the status code is not checked.
2296
:param send_signal: an optional signal to send to the process.
2297
:param universal_newlines: Convert CRLF => LF
2298
:returns: (stdout, stderr)
2300
if send_signal is not None:
2301
os.kill(process.pid, send_signal)
2302
out, err = process.communicate()
2304
if universal_newlines:
2305
out = out.replace('\r\n', '\n')
2306
err = err.replace('\r\n', '\n')
2308
if retcode is not None and retcode != process.returncode:
2309
if process_args is None:
2310
process_args = "(unknown args)"
2311
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2312
trace.mutter('Error for bzr %s:\n%s', process_args, err)
2313
self.fail('Command bzr %s failed with retcode %s != %s'
2314
% (process_args, retcode, process.returncode))
2317
def check_tree_shape(self, tree, shape):
2318
"""Compare a tree to a list of expected names.
2320
Fail if they are not precisely equal.
2323
shape = list(shape) # copy
2324
for path, ie in tree.iter_entries_by_dir():
2325
name = path.replace('\\', '/')
2326
if ie.kind == 'directory':
2329
pass # ignore root entry
2335
self.fail("expected paths not found in inventory: %r" % shape)
2337
self.fail("unexpected paths found in inventory: %r" % extras)
2339
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2340
a_callable=None, *args, **kwargs):
2341
"""Call callable with redirected std io pipes.
2343
Returns the return code."""
2344
if not callable(a_callable):
2345
raise ValueError("a_callable must be callable.")
2347
stdin = StringIO("")
2349
if getattr(self, "_log_file", None) is not None:
2350
stdout = self._log_file
2354
if getattr(self, "_log_file", None is not None):
2355
stderr = self._log_file
2358
real_stdin = sys.stdin
2359
real_stdout = sys.stdout
2360
real_stderr = sys.stderr
2365
return a_callable(*args, **kwargs)
2367
sys.stdout = real_stdout
2368
sys.stderr = real_stderr
2369
sys.stdin = real_stdin
2371
def reduceLockdirTimeout(self):
2372
"""Reduce the default lock timeout for the duration of the test, so that
2373
if LockContention occurs during a test, it does so quickly.
2375
Tests that expect to provoke LockContention errors should call this.
2377
self.overrideAttr(lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2379
def make_utf8_encoded_stringio(self, encoding_type=None):
2380
"""Return a StringIOWrapper instance, that will encode Unicode
2383
if encoding_type is None:
2384
encoding_type = 'strict'
2386
output_encoding = 'utf-8'
2387
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2388
sio.encoding = output_encoding
2391
def disable_verb(self, verb):
2392
"""Disable a smart server verb for one test."""
2393
from bzrlib.smart import request
2394
request_handlers = request.request_handlers
2395
orig_method = request_handlers.get(verb)
2396
orig_info = request_handlers.get_info(verb)
2397
request_handlers.remove(verb)
2398
self.addCleanup(request_handlers.register, verb, orig_method,
2402
class CapturedCall(object):
2403
"""A helper for capturing smart server calls for easy debug analysis."""
2405
def __init__(self, params, prefix_length):
2406
"""Capture the call with params and skip prefix_length stack frames."""
2409
# The last 5 frames are the __init__, the hook frame, and 3 smart
2410
# client frames. Beyond this we could get more clever, but this is good
2412
stack = traceback.extract_stack()[prefix_length:-5]
2413
self.stack = ''.join(traceback.format_list(stack))
2416
return self.call.method
2419
return self.call.method
2425
class TestCaseWithMemoryTransport(TestCase):
2426
"""Common test class for tests that do not need disk resources.
2428
Tests that need disk resources should derive from TestCaseInTempDir
2429
orTestCaseWithTransport.
2431
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2433
For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
2434
a directory which does not exist. This serves to help ensure test isolation
2435
is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
2436
must exist. However, TestCaseWithMemoryTransport does not offer local file
2437
defaults for the transport in tests, nor does it obey the command line
2438
override, so tests that accidentally write to the common directory should
2441
:cvar TEST_ROOT: Directory containing all temporary directories, plus a
2442
``.bzr`` directory that stops us ascending higher into the filesystem.
2448
def __init__(self, methodName='runTest'):
2449
# allow test parameterization after test construction and before test
2450
# execution. Variables that the parameterizer sets need to be
2451
# ones that are not set by setUp, or setUp will trash them.
2452
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2453
self.vfs_transport_factory = default_transport
2454
self.transport_server = None
2455
self.transport_readonly_server = None
2456
self.__vfs_server = None
2459
super(TestCaseWithMemoryTransport, self).setUp()
2461
def _add_disconnect_cleanup(transport):
2462
"""Schedule disconnection of given transport at test cleanup
2464
This needs to happen for all connected transports or leaks occur.
2466
Note reconnections may mean we call disconnect multiple times per
2467
transport which is suboptimal but seems harmless.
2469
self.addCleanup(transport.disconnect)
2471
_mod_transport.Transport.hooks.install_named_hook('post_connect',
2472
_add_disconnect_cleanup, None)
2474
self._make_test_root()
2475
self.addCleanup(os.chdir, os.getcwdu())
2476
self.makeAndChdirToTestDir()
2477
self.overrideEnvironmentForTesting()
2478
self.__readonly_server = None
2479
self.__server = None
2480
self.reduceLockdirTimeout()
2481
# Each test may use its own config files even if the local config files
2482
# don't actually exist. They'll rightly fail if they try to create them
2484
self.overrideAttr(config, '_shared_stores', {})
2486
def get_transport(self, relpath=None):
2487
"""Return a writeable transport.
2489
This transport is for the test scratch space relative to
2492
:param relpath: a path relative to the base url.
2494
t = _mod_transport.get_transport_from_url(self.get_url(relpath))
2495
self.assertFalse(t.is_readonly())
2498
def get_readonly_transport(self, relpath=None):
2499
"""Return a readonly transport for the test scratch space
2501
This can be used to test that operations which should only need
2502
readonly access in fact do not try to write.
2504
:param relpath: a path relative to the base url.
2506
t = _mod_transport.get_transport_from_url(
2507
self.get_readonly_url(relpath))
2508
self.assertTrue(t.is_readonly())
2511
def create_transport_readonly_server(self):
2512
"""Create a transport server from class defined at init.
2514
This is mostly a hook for daughter classes.
2516
return self.transport_readonly_server()
2518
def get_readonly_server(self):
2519
"""Get the server instance for the readonly transport
2521
This is useful for some tests with specific servers to do diagnostics.
2523
if self.__readonly_server is None:
2524
if self.transport_readonly_server is None:
2525
# readonly decorator requested
2526
self.__readonly_server = test_server.ReadonlyServer()
2528
# explicit readonly transport.
2529
self.__readonly_server = self.create_transport_readonly_server()
2530
self.start_server(self.__readonly_server,
2531
self.get_vfs_only_server())
2532
return self.__readonly_server
2534
def get_readonly_url(self, relpath=None):
2535
"""Get a URL for the readonly transport.
2537
This will either be backed by '.' or a decorator to the transport
2538
used by self.get_url()
2539
relpath provides for clients to get a path relative to the base url.
2540
These should only be downwards relative, not upwards.
2542
base = self.get_readonly_server().get_url()
2543
return self._adjust_url(base, relpath)
2545
def get_vfs_only_server(self):
2546
"""Get the vfs only read/write server instance.
2548
This is useful for some tests with specific servers that need
2551
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2552
is no means to override it.
2554
if self.__vfs_server is None:
2555
self.__vfs_server = memory.MemoryServer()
2556
self.start_server(self.__vfs_server)
2557
return self.__vfs_server
2559
def get_server(self):
2560
"""Get the read/write server instance.
2562
This is useful for some tests with specific servers that need
2565
This is built from the self.transport_server factory. If that is None,
2566
then the self.get_vfs_server is returned.
2568
if self.__server is None:
2569
if (self.transport_server is None or self.transport_server is
2570
self.vfs_transport_factory):
2571
self.__server = self.get_vfs_only_server()
2573
# bring up a decorated means of access to the vfs only server.
2574
self.__server = self.transport_server()
2575
self.start_server(self.__server, self.get_vfs_only_server())
2576
return self.__server
2578
def _adjust_url(self, base, relpath):
2579
"""Get a URL (or maybe a path) for the readwrite transport.
2581
This will either be backed by '.' or to an equivalent non-file based
2583
relpath provides for clients to get a path relative to the base url.
2584
These should only be downwards relative, not upwards.
2586
if relpath is not None and relpath != '.':
2587
if not base.endswith('/'):
2589
# XXX: Really base should be a url; we did after all call
2590
# get_url()! But sometimes it's just a path (from
2591
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2592
# to a non-escaped local path.
2593
if base.startswith('./') or base.startswith('/'):
2596
base += urlutils.escape(relpath)
2599
def get_url(self, relpath=None):
2600
"""Get a URL (or maybe a path) for the readwrite transport.
2602
This will either be backed by '.' or to an equivalent non-file based
2604
relpath provides for clients to get a path relative to the base url.
2605
These should only be downwards relative, not upwards.
2607
base = self.get_server().get_url()
2608
return self._adjust_url(base, relpath)
2610
def get_vfs_only_url(self, relpath=None):
2611
"""Get a URL (or maybe a path for the plain old vfs transport.
2613
This will never be a smart protocol. It always has all the
2614
capabilities of the local filesystem, but it might actually be a
2615
MemoryTransport or some other similar virtual filesystem.
2617
This is the backing transport (if any) of the server returned by
2618
get_url and get_readonly_url.
2620
:param relpath: provides for clients to get a path relative to the base
2621
url. These should only be downwards relative, not upwards.
2624
base = self.get_vfs_only_server().get_url()
2625
return self._adjust_url(base, relpath)
2627
def _create_safety_net(self):
2628
"""Make a fake bzr directory.
2630
This prevents any tests propagating up onto the TEST_ROOT directory's
2633
root = TestCaseWithMemoryTransport.TEST_ROOT
2635
# Make sure we get a readable and accessible home for .bzr.log
2636
# and/or config files, and not fallback to weird defaults (see
2637
# http://pad.lv/825027).
2638
self.assertIs(None, os.environ.get('BZR_HOME', None))
2639
os.environ['BZR_HOME'] = root
2640
wt = controldir.ControlDir.create_standalone_workingtree(root)
2641
del os.environ['BZR_HOME']
2642
except Exception, e:
2643
self.fail("Fail to initialize the safety net: %r\n" % (e,))
2644
# Hack for speed: remember the raw bytes of the dirstate file so that
2645
# we don't need to re-open the wt to check it hasn't changed.
2646
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE = (
2647
wt.control_transport.get_bytes('dirstate'))
2649
def _check_safety_net(self):
2650
"""Check that the safety .bzr directory have not been touched.
2652
_make_test_root have created a .bzr directory to prevent tests from
2653
propagating. This method ensures than a test did not leaked.
2655
root = TestCaseWithMemoryTransport.TEST_ROOT
2656
t = _mod_transport.get_transport_from_path(root)
2657
self.permit_url(t.base)
2658
if (t.get_bytes('.bzr/checkout/dirstate') !=
2659
TestCaseWithMemoryTransport._SAFETY_NET_PRISTINE_DIRSTATE):
2660
# The current test have modified the /bzr directory, we need to
2661
# recreate a new one or all the followng tests will fail.
2662
# If you need to inspect its content uncomment the following line
2663
# import pdb; pdb.set_trace()
2664
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2665
self._create_safety_net()
2666
raise AssertionError('%s/.bzr should not be modified' % root)
2668
def _make_test_root(self):
2669
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2670
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2671
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2673
TestCaseWithMemoryTransport.TEST_ROOT = root
2675
self._create_safety_net()
2677
# The same directory is used by all tests, and we're not
2678
# specifically told when all tests are finished. This will do.
2679
atexit.register(_rmtree_temp_dir, root)
2681
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2682
self.addCleanup(self._check_safety_net)
2684
def makeAndChdirToTestDir(self):
2685
"""Create a temporary directories for this one test.
2687
This must set self.test_home_dir and self.test_dir and chdir to
2690
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2692
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2693
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2694
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2695
self.permit_dir(self.test_dir)
2697
def make_branch(self, relpath, format=None, name=None):
2698
"""Create a branch on the transport at relpath."""
2699
repo = self.make_repository(relpath, format=format)
2700
return repo.bzrdir.create_branch(append_revisions_only=False,
2703
def get_default_format(self):
2706
def resolve_format(self, format):
2707
"""Resolve an object to a ControlDir format object.
2709
The initial format object can either already be
2710
a ControlDirFormat, None (for the default format),
2711
or a string with the name of the control dir format.
2713
:param format: Object to resolve
2714
:return A ControlDirFormat instance
2717
format = self.get_default_format()
2718
if isinstance(format, basestring):
2719
format = controldir.format_registry.make_bzrdir(format)
2722
def make_bzrdir(self, relpath, format=None):
2724
# might be a relative or absolute path
2725
maybe_a_url = self.get_url(relpath)
2726
segments = maybe_a_url.rsplit('/', 1)
2727
t = _mod_transport.get_transport(maybe_a_url)
2728
if len(segments) > 1 and segments[-1] not in ('', '.'):
2730
format = self.resolve_format(format)
2731
return format.initialize_on_transport(t)
2732
except errors.UninitializableFormat:
2733
raise TestSkipped("Format %s is not initializable." % format)
2735
def make_repository(self, relpath, shared=None, format=None):
2736
"""Create a repository on our default transport at relpath.
2738
Note that relpath must be a relative path, not a full url.
2740
# FIXME: If you create a remoterepository this returns the underlying
2741
# real format, which is incorrect. Actually we should make sure that
2742
# RemoteBzrDir returns a RemoteRepository.
2743
# maybe mbp 20070410
2744
made_control = self.make_bzrdir(relpath, format=format)
2745
return made_control.create_repository(shared=shared)
2747
def make_smart_server(self, path, backing_server=None):
2748
if backing_server is None:
2749
backing_server = self.get_server()
2750
smart_server = test_server.SmartTCPServer_for_testing()
2751
self.start_server(smart_server, backing_server)
2752
remote_transport = _mod_transport.get_transport_from_url(smart_server.get_url()
2754
return remote_transport
2756
def make_branch_and_memory_tree(self, relpath, format=None):
2757
"""Create a branch on the default transport and a MemoryTree for it."""
2758
b = self.make_branch(relpath, format=format)
2759
return memorytree.MemoryTree.create_on_branch(b)
2761
def make_branch_builder(self, relpath, format=None):
2762
branch = self.make_branch(relpath, format=format)
2763
return branchbuilder.BranchBuilder(branch=branch)
2765
def overrideEnvironmentForTesting(self):
2766
test_home_dir = self.test_home_dir
2767
if isinstance(test_home_dir, unicode):
2768
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2769
self.overrideEnv('HOME', test_home_dir)
2770
self.overrideEnv('BZR_HOME', test_home_dir)
2772
def setup_smart_server_with_call_log(self):
2773
"""Sets up a smart server as the transport server with a call log."""
2774
self.transport_server = test_server.SmartTCPServer_for_testing
2775
self.hpss_connections = []
2776
self.hpss_calls = []
2778
# Skip the current stack down to the caller of
2779
# setup_smart_server_with_call_log
2780
prefix_length = len(traceback.extract_stack()) - 2
2781
def capture_hpss_call(params):
2782
self.hpss_calls.append(
2783
CapturedCall(params, prefix_length))
2784
def capture_connect(transport):
2785
self.hpss_connections.append(transport)
2786
client._SmartClient.hooks.install_named_hook(
2787
'call', capture_hpss_call, None)
2788
_mod_transport.Transport.hooks.install_named_hook(
2789
'post_connect', capture_connect, None)
2791
def reset_smart_call_log(self):
2792
self.hpss_calls = []
2793
self.hpss_connections = []
2796
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2797
"""Derived class that runs a test within a temporary directory.
2799
This is useful for tests that need to create a branch, etc.
2801
The directory is created in a slightly complex way: for each
2802
Python invocation, a new temporary top-level directory is created.
2803
All test cases create their own directory within that. If the
2804
tests complete successfully, the directory is removed.
2806
:ivar test_base_dir: The path of the top-level directory for this
2807
test, which contains a home directory and a work directory.
2809
:ivar test_home_dir: An initially empty directory under test_base_dir
2810
which is used as $HOME for this test.
2812
:ivar test_dir: A directory under test_base_dir used as the current
2813
directory when the test proper is run.
2816
OVERRIDE_PYTHON = 'python'
2819
super(TestCaseInTempDir, self).setUp()
2820
# Remove the protection set in isolated_environ, we have a proper
2821
# access to disk resources now.
2822
self.overrideEnv('BZR_LOG', None)
2824
def check_file_contents(self, filename, expect):
2825
self.log("check contents of file %s" % filename)
2831
if contents != expect:
2832
self.log("expected: %r" % expect)
2833
self.log("actually: %r" % contents)
2834
self.fail("contents of %s not as expected" % filename)
2836
def _getTestDirPrefix(self):
2837
# create a directory within the top level test directory
2838
if sys.platform in ('win32', 'cygwin'):
2839
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2840
# windows is likely to have path-length limits so use a short name
2841
name_prefix = name_prefix[-30:]
2843
name_prefix = re.sub('[/]', '_', self.id())
2846
def makeAndChdirToTestDir(self):
2847
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2849
For TestCaseInTempDir we create a temporary directory based on the test
2850
name and then create two subdirs - test and home under it.
2852
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2853
self._getTestDirPrefix())
2855
for i in range(100):
2856
if os.path.exists(name):
2857
name = name_prefix + '_' + str(i)
2859
# now create test and home directories within this dir
2860
self.test_base_dir = name
2861
self.addCleanup(self.deleteTestDir)
2862
os.mkdir(self.test_base_dir)
2864
self.permit_dir(self.test_base_dir)
2865
# 'sprouting' and 'init' of a branch both walk up the tree to find
2866
# stacking policy to honour; create a bzr dir with an unshared
2867
# repository (but not a branch - our code would be trying to escape
2868
# then!) to stop them, and permit it to be read.
2869
# control = controldir.ControlDir.create(self.test_base_dir)
2870
# control.create_repository()
2871
self.test_home_dir = self.test_base_dir + '/home'
2872
os.mkdir(self.test_home_dir)
2873
self.test_dir = self.test_base_dir + '/work'
2874
os.mkdir(self.test_dir)
2875
os.chdir(self.test_dir)
2876
# put name of test inside
2877
f = file(self.test_base_dir + '/name', 'w')
2883
def deleteTestDir(self):
2884
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2885
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2887
def build_tree(self, shape, line_endings='binary', transport=None):
2888
"""Build a test tree according to a pattern.
2890
shape is a sequence of file specifications. If the final
2891
character is '/', a directory is created.
2893
This assumes that all the elements in the tree being built are new.
2895
This doesn't add anything to a branch.
2897
:type shape: list or tuple.
2898
:param line_endings: Either 'binary' or 'native'
2899
in binary mode, exact contents are written in native mode, the
2900
line endings match the default platform endings.
2901
:param transport: A transport to write to, for building trees on VFS's.
2902
If the transport is readonly or None, "." is opened automatically.
2905
if type(shape) not in (list, tuple):
2906
raise AssertionError("Parameter 'shape' should be "
2907
"a list or a tuple. Got %r instead" % (shape,))
2908
# It's OK to just create them using forward slashes on windows.
2909
if transport is None or transport.is_readonly():
2910
transport = _mod_transport.get_transport_from_path(".")
2912
self.assertIsInstance(name, basestring)
2914
transport.mkdir(urlutils.escape(name[:-1]))
2916
if line_endings == 'binary':
2918
elif line_endings == 'native':
2921
raise errors.BzrError(
2922
'Invalid line ending request %r' % line_endings)
2923
content = "contents of %s%s" % (name.encode('utf-8'), end)
2924
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2926
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2928
def assertInWorkingTree(self, path, root_path='.', tree=None):
2929
"""Assert whether path or paths are in the WorkingTree"""
2931
tree = workingtree.WorkingTree.open(root_path)
2932
if not isinstance(path, basestring):
2934
self.assertInWorkingTree(p, tree=tree)
2936
self.assertIsNot(tree.path2id(path), None,
2937
path+' not in working tree.')
2939
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2940
"""Assert whether path or paths are not in the WorkingTree"""
2942
tree = workingtree.WorkingTree.open(root_path)
2943
if not isinstance(path, basestring):
2945
self.assertNotInWorkingTree(p,tree=tree)
2947
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2950
class TestCaseWithTransport(TestCaseInTempDir):
2951
"""A test case that provides get_url and get_readonly_url facilities.
2953
These back onto two transport servers, one for readonly access and one for
2956
If no explicit class is provided for readonly access, a
2957
ReadonlyTransportDecorator is used instead which allows the use of non disk
2958
based read write transports.
2960
If an explicit class is provided for readonly access, that server and the
2961
readwrite one must both define get_url() as resolving to os.getcwd().
2965
super(TestCaseWithTransport, self).setUp()
2966
self.__vfs_server = None
2968
def get_vfs_only_server(self):
2969
"""See TestCaseWithMemoryTransport.
2971
This is useful for some tests with specific servers that need
2974
if self.__vfs_server is None:
2975
self.__vfs_server = self.vfs_transport_factory()
2976
self.start_server(self.__vfs_server)
2977
return self.__vfs_server
2979
def make_branch_and_tree(self, relpath, format=None):
2980
"""Create a branch on the transport and a tree locally.
2982
If the transport is not a LocalTransport, the Tree can't be created on
2983
the transport. In that case if the vfs_transport_factory is
2984
LocalURLServer the working tree is created in the local
2985
directory backing the transport, and the returned tree's branch and
2986
repository will also be accessed locally. Otherwise a lightweight
2987
checkout is created and returned.
2989
We do this because we can't physically create a tree in the local
2990
path, with a branch reference to the transport_factory url, and
2991
a branch + repository in the vfs_transport, unless the vfs_transport
2992
namespace is distinct from the local disk - the two branch objects
2993
would collide. While we could construct a tree with its branch object
2994
pointing at the transport_factory transport in memory, reopening it
2995
would behaving unexpectedly, and has in the past caused testing bugs
2996
when we tried to do it that way.
2998
:param format: The BzrDirFormat.
2999
:returns: the WorkingTree.
3001
# TODO: always use the local disk path for the working tree,
3002
# this obviously requires a format that supports branch references
3003
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
3005
format = self.resolve_format(format=format)
3006
if not format.supports_workingtrees:
3007
b = self.make_branch(relpath+'.branch', format=format)
3008
return b.create_checkout(relpath, lightweight=True)
3009
b = self.make_branch(relpath, format=format)
3011
return b.bzrdir.create_workingtree()
3012
except errors.NotLocalUrl:
3013
# We can only make working trees locally at the moment. If the
3014
# transport can't support them, then we keep the non-disk-backed
3015
# branch and create a local checkout.
3016
if self.vfs_transport_factory is test_server.LocalURLServer:
3017
# the branch is colocated on disk, we cannot create a checkout.
3018
# hopefully callers will expect this.
3019
local_controldir = controldir.ControlDir.open(
3020
self.get_vfs_only_url(relpath))
3021
wt = local_controldir.create_workingtree()
3022
if wt.branch._format != b._format:
3024
# Make sure that assigning to wt._branch fixes wt.branch,
3025
# in case the implementation details of workingtree objects
3027
self.assertIs(b, wt.branch)
3030
return b.create_checkout(relpath, lightweight=True)
3032
def assertIsDirectory(self, relpath, transport):
3033
"""Assert that relpath within transport is a directory.
3035
This may not be possible on all transports; in that case it propagates
3036
a TransportNotPossible.
3039
mode = transport.stat(relpath).st_mode
3040
except errors.NoSuchFile:
3041
self.fail("path %s is not a directory; no such file"
3043
if not stat.S_ISDIR(mode):
3044
self.fail("path %s is not a directory; has mode %#o"
3047
def assertTreesEqual(self, left, right):
3048
"""Check that left and right have the same content and properties."""
3049
# we use a tree delta to check for equality of the content, and we
3050
# manually check for equality of other things such as the parents list.
3051
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
3052
differences = left.changes_from(right)
3053
self.assertFalse(differences.has_changed(),
3054
"Trees %r and %r are different: %r" % (left, right, differences))
3056
def disable_missing_extensions_warning(self):
3057
"""Some tests expect a precise stderr content.
3059
There is no point in forcing them to duplicate the extension related
3062
config.GlobalStack().set('ignore_missing_extensions', True)
3065
class ChrootedTestCase(TestCaseWithTransport):
3066
"""A support class that provides readonly urls outside the local namespace.
3068
This is done by checking if self.transport_server is a MemoryServer. if it
3069
is then we are chrooted already, if it is not then an HttpServer is used
3072
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
3073
be used without needed to redo it when a different
3074
subclass is in use ?
3078
from bzrlib.tests import http_server
3079
super(ChrootedTestCase, self).setUp()
3080
if not self.vfs_transport_factory == memory.MemoryServer:
3081
self.transport_readonly_server = http_server.HttpServer
3084
def condition_id_re(pattern):
3085
"""Create a condition filter which performs a re check on a test's id.
3087
:param pattern: A regular expression string.
3088
:return: A callable that returns True if the re matches.
3090
filter_re = re.compile(pattern, 0)
3091
def condition(test):
3093
return filter_re.search(test_id)
3097
def condition_isinstance(klass_or_klass_list):
3098
"""Create a condition filter which returns isinstance(param, klass).
3100
:return: A callable which when called with one parameter obj return the
3101
result of isinstance(obj, klass_or_klass_list).
3104
return isinstance(obj, klass_or_klass_list)
3108
def condition_id_in_list(id_list):
3109
"""Create a condition filter which verify that test's id in a list.
3111
:param id_list: A TestIdList object.
3112
:return: A callable that returns True if the test's id appears in the list.
3114
def condition(test):
3115
return id_list.includes(test.id())
3119
def condition_id_startswith(starts):
3120
"""Create a condition filter verifying that test's id starts with a string.
3122
:param starts: A list of string.
3123
:return: A callable that returns True if the test's id starts with one of
3126
def condition(test):
3127
for start in starts:
3128
if test.id().startswith(start):
3134
def exclude_tests_by_condition(suite, condition):
3135
"""Create a test suite which excludes some tests from suite.
3137
:param suite: The suite to get tests from.
3138
:param condition: A callable whose result evaluates True when called with a
3139
test case which should be excluded from the result.
3140
:return: A suite which contains the tests found in suite that fail
3144
for test in iter_suite_tests(suite):
3145
if not condition(test):
3147
return TestUtil.TestSuite(result)
3150
def filter_suite_by_condition(suite, condition):
3151
"""Create a test suite by filtering another one.
3153
:param suite: The source suite.
3154
:param condition: A callable whose result evaluates True when called with a
3155
test case which should be included in the result.
3156
:return: A suite which contains the tests found in suite that pass
3160
for test in iter_suite_tests(suite):
3163
return TestUtil.TestSuite(result)
3166
def filter_suite_by_re(suite, pattern):
3167
"""Create a test suite by filtering another one.
3169
:param suite: the source suite
3170
:param pattern: pattern that names must match
3171
:returns: the newly created suite
3173
condition = condition_id_re(pattern)
3174
result_suite = filter_suite_by_condition(suite, condition)
3178
def filter_suite_by_id_list(suite, test_id_list):
3179
"""Create a test suite by filtering another one.
3181
:param suite: The source suite.
3182
:param test_id_list: A list of the test ids to keep as strings.
3183
:returns: the newly created suite
3185
condition = condition_id_in_list(test_id_list)
3186
result_suite = filter_suite_by_condition(suite, condition)
3190
def filter_suite_by_id_startswith(suite, start):
3191
"""Create a test suite by filtering another one.
3193
:param suite: The source suite.
3194
:param start: A list of string the test id must start with one of.
3195
:returns: the newly created suite
3197
condition = condition_id_startswith(start)
3198
result_suite = filter_suite_by_condition(suite, condition)
3202
def exclude_tests_by_re(suite, pattern):
3203
"""Create a test suite which excludes some tests from suite.
3205
:param suite: The suite to get tests from.
3206
:param pattern: A regular expression string. Test ids that match this
3207
pattern will be excluded from the result.
3208
:return: A TestSuite that contains all the tests from suite without the
3209
tests that matched pattern. The order of tests is the same as it was in
3212
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3215
def preserve_input(something):
3216
"""A helper for performing test suite transformation chains.
3218
:param something: Anything you want to preserve.
3224
def randomize_suite(suite):
3225
"""Return a new TestSuite with suite's tests in random order.
3227
The tests in the input suite are flattened into a single suite in order to
3228
accomplish this. Any nested TestSuites are removed to provide global
3231
tests = list(iter_suite_tests(suite))
3232
random.shuffle(tests)
3233
return TestUtil.TestSuite(tests)
3236
def split_suite_by_condition(suite, condition):
3237
"""Split a test suite into two by a condition.
3239
:param suite: The suite to split.
3240
:param condition: The condition to match on. Tests that match this
3241
condition are returned in the first test suite, ones that do not match
3242
are in the second suite.
3243
:return: A tuple of two test suites, where the first contains tests from
3244
suite matching the condition, and the second contains the remainder
3245
from suite. The order within each output suite is the same as it was in
3250
for test in iter_suite_tests(suite):
3252
matched.append(test)
3254
did_not_match.append(test)
3255
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3258
def split_suite_by_re(suite, pattern):
3259
"""Split a test suite into two by a regular expression.
3261
:param suite: The suite to split.
3262
:param pattern: A regular expression string. Test ids that match this
3263
pattern will be in the first test suite returned, and the others in the
3264
second test suite returned.
3265
:return: A tuple of two test suites, where the first contains tests from
3266
suite matching pattern, and the second contains the remainder from
3267
suite. The order within each output suite is the same as it was in
3270
return split_suite_by_condition(suite, condition_id_re(pattern))
3273
def run_suite(suite, name='test', verbose=False, pattern=".*",
3274
stop_on_failure=False,
3275
transport=None, lsprof_timed=None, bench_history=None,
3276
matching_tests_first=None,
3279
exclude_pattern=None,
3282
suite_decorators=None,
3284
result_decorators=None,
60
if m not in MODULES_TO_TEST:
61
MODULES_TO_TEST.append(m)
64
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
65
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
71
# should also test bzrlib.merge_core, but they seem to be out of date with
75
# XXX: python2.3's TestLoader() doesn't seem to find all the
76
# tests; don't know why
77
for m in MODULES_TO_TEST:
78
suite.addTest(TestLoader().loadTestsFromModule(m))
80
for m in (MODULES_TO_DOCTEST):
81
suite.addTest(DocTestSuite(m))
83
for p in bzrlib.plugin.all_plugins:
84
if hasattr(p, 'test_suite'):
85
suite.addTest(p.test_suite())
87
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
89
return run_suite(suite, 'testbzr')
3286
"""Run a test suite for bzr selftest.
3288
:param runner_class: The class of runner to use. Must support the
3289
constructor arguments passed by run_suite which are more than standard
3291
:return: A boolean indicating success.
3293
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3298
if runner_class is None:
3299
runner_class = TextTestRunner
3302
runner = runner_class(stream=stream,
3304
verbosity=verbosity,
3305
bench_history=bench_history,
3307
result_decorators=result_decorators,
3309
runner.stop_on_failure=stop_on_failure
3310
if isinstance(suite, unittest.TestSuite):
3311
# Empty out _tests list of passed suite and populate new TestSuite
3312
suite._tests[:], suite = [], TestSuite(suite)
3313
# built in decorator factories:
3315
random_order(random_seed, runner),
3316
exclude_tests(exclude_pattern),
3318
if matching_tests_first:
3319
decorators.append(tests_first(pattern))
3321
decorators.append(filter_tests(pattern))
3322
if suite_decorators:
3323
decorators.extend(suite_decorators)
3324
# tell the result object how many tests will be running: (except if
3325
# --parallel=fork is being used. Robert said he will provide a better
3326
# progress design later -- vila 20090817)
3327
if fork_decorator not in decorators:
3328
decorators.append(CountingDecorator)
3329
for decorator in decorators:
3330
suite = decorator(suite)
3332
# Done after test suite decoration to allow randomisation etc
3333
# to take effect, though that is of marginal benefit.
3335
stream.write("Listing tests only ...\n")
3336
for t in iter_suite_tests(suite):
3337
stream.write("%s\n" % (t.id()))
3339
result = runner.run(suite)
3341
return result.wasStrictlySuccessful()
3343
return result.wasSuccessful()
3346
# A registry where get() returns a suite decorator.
3347
parallel_registry = registry.Registry()
3350
def fork_decorator(suite):
3351
if getattr(os, "fork", None) is None:
3352
raise errors.BzrCommandError("platform does not support fork,"
3353
" try --parallel=subprocess instead.")
3354
concurrency = osutils.local_concurrency()
3355
if concurrency == 1:
3357
from testtools import ConcurrentTestSuite
3358
return ConcurrentTestSuite(suite, fork_for_tests)
3359
parallel_registry.register('fork', fork_decorator)
3362
def subprocess_decorator(suite):
3363
concurrency = osutils.local_concurrency()
3364
if concurrency == 1:
3366
from testtools import ConcurrentTestSuite
3367
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3368
parallel_registry.register('subprocess', subprocess_decorator)
3371
def exclude_tests(exclude_pattern):
3372
"""Return a test suite decorator that excludes tests."""
3373
if exclude_pattern is None:
3374
return identity_decorator
3375
def decorator(suite):
3376
return ExcludeDecorator(suite, exclude_pattern)
3380
def filter_tests(pattern):
3382
return identity_decorator
3383
def decorator(suite):
3384
return FilterTestsDecorator(suite, pattern)
3388
def random_order(random_seed, runner):
3389
"""Return a test suite decorator factory for randomising tests order.
3391
:param random_seed: now, a string which casts to a long, or a long.
3392
:param runner: A test runner with a stream attribute to report on.
3394
if random_seed is None:
3395
return identity_decorator
3396
def decorator(suite):
3397
return RandomDecorator(suite, random_seed, runner.stream)
3401
def tests_first(pattern):
3403
return identity_decorator
3404
def decorator(suite):
3405
return TestFirstDecorator(suite, pattern)
3409
def identity_decorator(suite):
3414
class TestDecorator(TestUtil.TestSuite):
3415
"""A decorator for TestCase/TestSuite objects.
3417
Contains rather than flattening suite passed on construction
3420
def __init__(self, suite=None):
3421
super(TestDecorator, self).__init__()
3422
if suite is not None:
3425
# Don't need subclass run method with suite emptying
3426
run = unittest.TestSuite.run
3429
class CountingDecorator(TestDecorator):
3430
"""A decorator which calls result.progress(self.countTestCases)."""
3432
def run(self, result):
3433
progress_method = getattr(result, 'progress', None)
3434
if callable(progress_method):
3435
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3436
return super(CountingDecorator, self).run(result)
3439
class ExcludeDecorator(TestDecorator):
3440
"""A decorator which excludes test matching an exclude pattern."""
3442
def __init__(self, suite, exclude_pattern):
3443
super(ExcludeDecorator, self).__init__(
3444
exclude_tests_by_re(suite, exclude_pattern))
3447
class FilterTestsDecorator(TestDecorator):
3448
"""A decorator which filters tests to those matching a pattern."""
3450
def __init__(self, suite, pattern):
3451
super(FilterTestsDecorator, self).__init__(
3452
filter_suite_by_re(suite, pattern))
3455
class RandomDecorator(TestDecorator):
3456
"""A decorator which randomises the order of its tests."""
3458
def __init__(self, suite, random_seed, stream):
3459
random_seed = self.actual_seed(random_seed)
3460
stream.write("Randomizing test order using seed %s\n\n" %
3462
# Initialise the random number generator.
3463
random.seed(random_seed)
3464
super(RandomDecorator, self).__init__(randomize_suite(suite))
3467
def actual_seed(seed):
3469
# We convert the seed to a long to make it reuseable across
3470
# invocations (because the user can reenter it).
3471
return long(time.time())
3473
# Convert the seed to a long if we can
3476
except (TypeError, ValueError):
3481
class TestFirstDecorator(TestDecorator):
3482
"""A decorator which moves named tests to the front."""
3484
def __init__(self, suite, pattern):
3485
super(TestFirstDecorator, self).__init__()
3486
self.addTests(split_suite_by_re(suite, pattern))
3489
def partition_tests(suite, count):
3490
"""Partition suite into count lists of tests."""
3491
# This just assigns tests in a round-robin fashion. On one hand this
3492
# splits up blocks of related tests that might run faster if they shared
3493
# resources, but on the other it avoids assigning blocks of slow tests to
3494
# just one partition. So the slowest partition shouldn't be much slower
3496
partitions = [list() for i in range(count)]
3497
tests = iter_suite_tests(suite)
3498
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3499
partition.append(test)
3503
def workaround_zealous_crypto_random():
3504
"""Crypto.Random want to help us being secure, but we don't care here.
3506
This workaround some test failure related to the sftp server. Once paramiko
3507
stop using the controversial API in Crypto.Random, we may get rid of it.
3510
from Crypto.Random import atfork
3516
def fork_for_tests(suite):
3517
"""Take suite and start up one runner per CPU by forking()
3519
:return: An iterable of TestCase-like objects which can each have
3520
run(result) called on them to feed tests to result.
3522
concurrency = osutils.local_concurrency()
3524
from subunit import ProtocolTestCase
3525
from subunit.test_results import AutoTimingTestResultDecorator
3526
class TestInOtherProcess(ProtocolTestCase):
3527
# Should be in subunit, I think. RBC.
3528
def __init__(self, stream, pid):
3529
ProtocolTestCase.__init__(self, stream)
3532
def run(self, result):
3534
ProtocolTestCase.run(self, result)
3536
pid, status = os.waitpid(self.pid, 0)
3537
# GZ 2011-10-18: If status is nonzero, should report to the result
3538
# that something went wrong.
3540
test_blocks = partition_tests(suite, concurrency)
3541
# Clear the tests from the original suite so it doesn't keep them alive
3542
suite._tests[:] = []
3543
for process_tests in test_blocks:
3544
process_suite = TestUtil.TestSuite(process_tests)
3545
# Also clear each split list so new suite has only reference
3546
process_tests[:] = []
3547
c2pread, c2pwrite = os.pipe()
3551
stream = os.fdopen(c2pwrite, 'wb', 1)
3552
workaround_zealous_crypto_random()
3554
# Leave stderr and stdout open so we can see test noise
3555
# Close stdin so that the child goes away if it decides to
3556
# read from stdin (otherwise its a roulette to see what
3557
# child actually gets keystrokes for pdb etc).
3559
subunit_result = AutoTimingTestResultDecorator(
3560
SubUnitBzrProtocolClient(stream))
3561
process_suite.run(subunit_result)
3563
# Try and report traceback on stream, but exit with error even
3564
# if stream couldn't be created or something else goes wrong.
3565
# The traceback is formatted to a string and written in one go
3566
# to avoid interleaving lines from multiple failing children.
3568
stream.write(traceback.format_exc())
3574
stream = os.fdopen(c2pread, 'rb', 1)
3575
test = TestInOtherProcess(stream, pid)
3580
def reinvoke_for_tests(suite):
3581
"""Take suite and start up one runner per CPU using subprocess().
3583
:return: An iterable of TestCase-like objects which can each have
3584
run(result) called on them to feed tests to result.
3586
concurrency = osutils.local_concurrency()
3588
from subunit import ProtocolTestCase
3589
class TestInSubprocess(ProtocolTestCase):
3590
def __init__(self, process, name):
3591
ProtocolTestCase.__init__(self, process.stdout)
3592
self.process = process
3593
self.process.stdin.close()
3596
def run(self, result):
3598
ProtocolTestCase.run(self, result)
3601
os.unlink(self.name)
3602
# print "pid %d finished" % finished_process
3603
test_blocks = partition_tests(suite, concurrency)
3604
for process_tests in test_blocks:
3605
# ugly; currently reimplement rather than reuses TestCase methods.
3606
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3607
if not os.path.isfile(bzr_path):
3608
# We are probably installed. Assume sys.argv is the right file
3609
bzr_path = sys.argv[0]
3610
bzr_path = [bzr_path]
3611
if sys.platform == "win32":
3612
# if we're on windows, we can't execute the bzr script directly
3613
bzr_path = [sys.executable] + bzr_path
3614
fd, test_list_file_name = tempfile.mkstemp()
3615
test_list_file = os.fdopen(fd, 'wb', 1)
3616
for test in process_tests:
3617
test_list_file.write(test.id() + '\n')
3618
test_list_file.close()
3620
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3622
if '--no-plugins' in sys.argv:
3623
argv.append('--no-plugins')
3624
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3625
# noise on stderr it can interrupt the subunit protocol.
3626
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3627
stdout=subprocess.PIPE,
3628
stderr=subprocess.PIPE,
3630
test = TestInSubprocess(process, test_list_file_name)
3633
os.unlink(test_list_file_name)
3638
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3639
"""Generate profiling data for all activity between start and success.
3641
The profile data is appended to the test's _benchcalls attribute and can
3642
be accessed by the forwarded-to TestResult.
3644
While it might be cleaner do accumulate this in stopTest, addSuccess is
3645
where our existing output support for lsprof is, and this class aims to
3646
fit in with that: while it could be moved it's not necessary to accomplish
3647
test profiling, nor would it be dramatically cleaner.
3650
def startTest(self, test):
3651
self.profiler = bzrlib.lsprof.BzrProfiler()
3652
# Prevent deadlocks in tests that use lsprof: those tests will
3654
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3655
self.profiler.start()
3656
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3658
def addSuccess(self, test):
3659
stats = self.profiler.stop()
3661
calls = test._benchcalls
3662
except AttributeError:
3663
test._benchcalls = []
3664
calls = test._benchcalls
3665
calls.append(((test.id(), "", ""), stats))
3666
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3668
def stopTest(self, test):
3669
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3670
self.profiler = None
3673
# Controlled by "bzr selftest -E=..." option
3674
# Currently supported:
3675
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3676
# preserves any flags supplied at the command line.
3677
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3678
# rather than failing tests. And no longer raise
3679
# LockContention when fctnl locks are not being used
3680
# with proper exclusion rules.
3681
# -Ethreads Will display thread ident at creation/join time to
3682
# help track thread leaks
3683
# -Euncollected_cases Display the identity of any test cases that weren't
3684
# deallocated after being completed.
3685
# -Econfig_stats Will collect statistics using addDetail
3686
selftest_debug_flags = set()
3689
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3691
test_suite_factory=None,
3694
matching_tests_first=None,
3697
exclude_pattern=None,
3703
suite_decorators=None,
3707
"""Run the whole test suite under the enhanced runner"""
3708
# XXX: Very ugly way to do this...
3709
# Disable warning about old formats because we don't want it to disturb
3710
# any blackbox tests.
3711
from bzrlib import repository
3712
repository._deprecation_warning_done = True
3714
global default_transport
3715
if transport is None:
3716
transport = default_transport
3717
old_transport = default_transport
3718
default_transport = transport
3719
global selftest_debug_flags
3720
old_debug_flags = selftest_debug_flags
3721
if debug_flags is not None:
3722
selftest_debug_flags = set(debug_flags)
3724
if load_list is None:
3727
keep_only = load_test_id_list(load_list)
3729
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3730
for start in starting_with]
3731
if test_suite_factory is None:
3732
# Reduce loading time by loading modules based on the starting_with
3734
suite = test_suite(keep_only, starting_with)
3736
suite = test_suite_factory()
3738
# But always filter as requested.
3739
suite = filter_suite_by_id_startswith(suite, starting_with)
3740
result_decorators = []
3742
result_decorators.append(ProfileResult)
3743
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3744
stop_on_failure=stop_on_failure,
3745
transport=transport,
3746
lsprof_timed=lsprof_timed,
3747
bench_history=bench_history,
3748
matching_tests_first=matching_tests_first,
3749
list_only=list_only,
3750
random_seed=random_seed,
3751
exclude_pattern=exclude_pattern,
3753
runner_class=runner_class,
3754
suite_decorators=suite_decorators,
3756
result_decorators=result_decorators,
3759
default_transport = old_transport
3760
selftest_debug_flags = old_debug_flags
3763
def load_test_id_list(file_name):
3764
"""Load a test id list from a text file.
3766
The format is one test id by line. No special care is taken to impose
3767
strict rules, these test ids are used to filter the test suite so a test id
3768
that do not match an existing test will do no harm. This allows user to add
3769
comments, leave blank lines, etc.
3773
ftest = open(file_name, 'rt')
3775
if e.errno != errno.ENOENT:
3778
raise errors.NoSuchFile(file_name)
3780
for test_name in ftest.readlines():
3781
test_list.append(test_name.strip())
3786
def suite_matches_id_list(test_suite, id_list):
3787
"""Warns about tests not appearing or appearing more than once.
3789
:param test_suite: A TestSuite object.
3790
:param test_id_list: The list of test ids that should be found in
3793
:return: (absents, duplicates) absents is a list containing the test found
3794
in id_list but not in test_suite, duplicates is a list containing the
3795
test found multiple times in test_suite.
3797
When using a prefined test id list, it may occurs that some tests do not
3798
exist anymore or that some tests use the same id. This function warns the
3799
tester about potential problems in his workflow (test lists are volatile)
3800
or in the test suite itself (using the same id for several tests does not
3801
help to localize defects).
3803
# Build a dict counting id occurrences
3805
for test in iter_suite_tests(test_suite):
3807
tests[id] = tests.get(id, 0) + 1
3812
occurs = tests.get(id, 0)
3814
not_found.append(id)
3816
duplicates.append(id)
3818
return not_found, duplicates
3821
class TestIdList(object):
3822
"""Test id list to filter a test suite.
3824
Relying on the assumption that test ids are built as:
3825
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3826
notation, this class offers methods to :
3827
- avoid building a test suite for modules not refered to in the test list,
3828
- keep only the tests listed from the module test suite.
3831
def __init__(self, test_id_list):
3832
# When a test suite needs to be filtered against us we compare test ids
3833
# for equality, so a simple dict offers a quick and simple solution.
3834
self.tests = dict().fromkeys(test_id_list, True)
3836
# While unittest.TestCase have ids like:
3837
# <module>.<class>.<method>[(<param+)],
3838
# doctest.DocTestCase can have ids like:
3841
# <module>.<function>
3842
# <module>.<class>.<method>
3844
# Since we can't predict a test class from its name only, we settle on
3845
# a simple constraint: a test id always begins with its module name.
3848
for test_id in test_id_list:
3849
parts = test_id.split('.')
3850
mod_name = parts.pop(0)
3851
modules[mod_name] = True
3853
mod_name += '.' + part
3854
modules[mod_name] = True
3855
self.modules = modules
3857
def refers_to(self, module_name):
3858
"""Is there tests for the module or one of its sub modules."""
3859
return self.modules.has_key(module_name)
3861
def includes(self, test_id):
3862
return self.tests.has_key(test_id)
3865
class TestPrefixAliasRegistry(registry.Registry):
3866
"""A registry for test prefix aliases.
3868
This helps implement shorcuts for the --starting-with selftest
3869
option. Overriding existing prefixes is not allowed but not fatal (a
3870
warning will be emitted).
3873
def register(self, key, obj, help=None, info=None,
3874
override_existing=False):
3875
"""See Registry.register.
3877
Trying to override an existing alias causes a warning to be emitted,
3878
not a fatal execption.
3881
super(TestPrefixAliasRegistry, self).register(
3882
key, obj, help=help, info=info, override_existing=False)
3884
actual = self.get(key)
3886
'Test prefix alias %s is already used for %s, ignoring %s'
3887
% (key, actual, obj))
3889
def resolve_alias(self, id_start):
3890
"""Replace the alias by the prefix in the given string.
3892
Using an unknown prefix is an error to help catching typos.
3894
parts = id_start.split('.')
3896
parts[0] = self.get(parts[0])
3898
raise errors.BzrCommandError(
3899
'%s is not a known test prefix alias' % parts[0])
3900
return '.'.join(parts)
3903
test_prefix_alias_registry = TestPrefixAliasRegistry()
3904
"""Registry of test prefix aliases."""
3907
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3908
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3909
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3911
# Obvious highest levels prefixes, feel free to add your own via a plugin
3912
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3913
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3914
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3915
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3916
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3919
def _test_suite_testmod_names():
3920
"""Return the standard list of test module names to test."""
3923
'bzrlib.tests.blackbox',
3924
'bzrlib.tests.commands',
3925
'bzrlib.tests.per_branch',
3926
'bzrlib.tests.per_bzrdir',
3927
'bzrlib.tests.per_controldir',
3928
'bzrlib.tests.per_controldir_colo',
3929
'bzrlib.tests.per_foreign_vcs',
3930
'bzrlib.tests.per_interrepository',
3931
'bzrlib.tests.per_intertree',
3932
'bzrlib.tests.per_inventory',
3933
'bzrlib.tests.per_interbranch',
3934
'bzrlib.tests.per_lock',
3935
'bzrlib.tests.per_merger',
3936
'bzrlib.tests.per_transport',
3937
'bzrlib.tests.per_tree',
3938
'bzrlib.tests.per_pack_repository',
3939
'bzrlib.tests.per_repository',
3940
'bzrlib.tests.per_repository_chk',
3941
'bzrlib.tests.per_repository_reference',
3942
'bzrlib.tests.per_repository_vf',
3943
'bzrlib.tests.per_uifactory',
3944
'bzrlib.tests.per_versionedfile',
3945
'bzrlib.tests.per_workingtree',
3946
'bzrlib.tests.test__annotator',
3947
'bzrlib.tests.test__bencode',
3948
'bzrlib.tests.test__btree_serializer',
3949
'bzrlib.tests.test__chk_map',
3950
'bzrlib.tests.test__dirstate_helpers',
3951
'bzrlib.tests.test__groupcompress',
3952
'bzrlib.tests.test__known_graph',
3953
'bzrlib.tests.test__rio',
3954
'bzrlib.tests.test__simple_set',
3955
'bzrlib.tests.test__static_tuple',
3956
'bzrlib.tests.test__walkdirs_win32',
3957
'bzrlib.tests.test_ancestry',
3958
'bzrlib.tests.test_annotate',
3959
'bzrlib.tests.test_api',
3960
'bzrlib.tests.test_atomicfile',
3961
'bzrlib.tests.test_bad_files',
3962
'bzrlib.tests.test_bisect_multi',
3963
'bzrlib.tests.test_branch',
3964
'bzrlib.tests.test_branchbuilder',
3965
'bzrlib.tests.test_btree_index',
3966
'bzrlib.tests.test_bugtracker',
3967
'bzrlib.tests.test_bundle',
3968
'bzrlib.tests.test_bzrdir',
3969
'bzrlib.tests.test__chunks_to_lines',
3970
'bzrlib.tests.test_cache_utf8',
3971
'bzrlib.tests.test_chk_map',
3972
'bzrlib.tests.test_chk_serializer',
3973
'bzrlib.tests.test_chunk_writer',
3974
'bzrlib.tests.test_clean_tree',
3975
'bzrlib.tests.test_cleanup',
3976
'bzrlib.tests.test_cmdline',
3977
'bzrlib.tests.test_commands',
3978
'bzrlib.tests.test_commit',
3979
'bzrlib.tests.test_commit_merge',
3980
'bzrlib.tests.test_config',
3981
'bzrlib.tests.test_conflicts',
3982
'bzrlib.tests.test_controldir',
3983
'bzrlib.tests.test_counted_lock',
3984
'bzrlib.tests.test_crash',
3985
'bzrlib.tests.test_decorators',
3986
'bzrlib.tests.test_delta',
3987
'bzrlib.tests.test_debug',
3988
'bzrlib.tests.test_diff',
3989
'bzrlib.tests.test_directory_service',
3990
'bzrlib.tests.test_dirstate',
3991
'bzrlib.tests.test_email_message',
3992
'bzrlib.tests.test_eol_filters',
3993
'bzrlib.tests.test_errors',
3994
'bzrlib.tests.test_estimate_compressed_size',
3995
'bzrlib.tests.test_export',
3996
'bzrlib.tests.test_export_pot',
3997
'bzrlib.tests.test_extract',
3998
'bzrlib.tests.test_features',
3999
'bzrlib.tests.test_fetch',
4000
'bzrlib.tests.test_fixtures',
4001
'bzrlib.tests.test_fifo_cache',
4002
'bzrlib.tests.test_filters',
4003
'bzrlib.tests.test_filter_tree',
4004
'bzrlib.tests.test_ftp_transport',
4005
'bzrlib.tests.test_foreign',
4006
'bzrlib.tests.test_generate_docs',
4007
'bzrlib.tests.test_generate_ids',
4008
'bzrlib.tests.test_globbing',
4009
'bzrlib.tests.test_gpg',
4010
'bzrlib.tests.test_graph',
4011
'bzrlib.tests.test_groupcompress',
4012
'bzrlib.tests.test_hashcache',
4013
'bzrlib.tests.test_help',
4014
'bzrlib.tests.test_hooks',
4015
'bzrlib.tests.test_http',
4016
'bzrlib.tests.test_http_response',
4017
'bzrlib.tests.test_https_ca_bundle',
4018
'bzrlib.tests.test_https_urllib',
4019
'bzrlib.tests.test_i18n',
4020
'bzrlib.tests.test_identitymap',
4021
'bzrlib.tests.test_ignores',
4022
'bzrlib.tests.test_index',
4023
'bzrlib.tests.test_import_tariff',
4024
'bzrlib.tests.test_info',
4025
'bzrlib.tests.test_inv',
4026
'bzrlib.tests.test_inventory_delta',
4027
'bzrlib.tests.test_knit',
4028
'bzrlib.tests.test_lazy_import',
4029
'bzrlib.tests.test_lazy_regex',
4030
'bzrlib.tests.test_library_state',
4031
'bzrlib.tests.test_lock',
4032
'bzrlib.tests.test_lockable_files',
4033
'bzrlib.tests.test_lockdir',
4034
'bzrlib.tests.test_log',
4035
'bzrlib.tests.test_lru_cache',
4036
'bzrlib.tests.test_lsprof',
4037
'bzrlib.tests.test_mail_client',
4038
'bzrlib.tests.test_matchers',
4039
'bzrlib.tests.test_memorytree',
4040
'bzrlib.tests.test_merge',
4041
'bzrlib.tests.test_merge3',
4042
'bzrlib.tests.test_merge_core',
4043
'bzrlib.tests.test_merge_directive',
4044
'bzrlib.tests.test_mergetools',
4045
'bzrlib.tests.test_missing',
4046
'bzrlib.tests.test_msgeditor',
4047
'bzrlib.tests.test_multiparent',
4048
'bzrlib.tests.test_mutabletree',
4049
'bzrlib.tests.test_nonascii',
4050
'bzrlib.tests.test_options',
4051
'bzrlib.tests.test_osutils',
4052
'bzrlib.tests.test_osutils_encodings',
4053
'bzrlib.tests.test_pack',
4054
'bzrlib.tests.test_patch',
4055
'bzrlib.tests.test_patches',
4056
'bzrlib.tests.test_permissions',
4057
'bzrlib.tests.test_plugins',
4058
'bzrlib.tests.test_progress',
4059
'bzrlib.tests.test_pyutils',
4060
'bzrlib.tests.test_read_bundle',
4061
'bzrlib.tests.test_reconcile',
4062
'bzrlib.tests.test_reconfigure',
4063
'bzrlib.tests.test_registry',
4064
'bzrlib.tests.test_remote',
4065
'bzrlib.tests.test_rename_map',
4066
'bzrlib.tests.test_repository',
4067
'bzrlib.tests.test_revert',
4068
'bzrlib.tests.test_revision',
4069
'bzrlib.tests.test_revisionspec',
4070
'bzrlib.tests.test_revisiontree',
4071
'bzrlib.tests.test_rio',
4072
'bzrlib.tests.test_rules',
4073
'bzrlib.tests.test_url_policy_open',
4074
'bzrlib.tests.test_sampler',
4075
'bzrlib.tests.test_scenarios',
4076
'bzrlib.tests.test_script',
4077
'bzrlib.tests.test_selftest',
4078
'bzrlib.tests.test_serializer',
4079
'bzrlib.tests.test_setup',
4080
'bzrlib.tests.test_sftp_transport',
4081
'bzrlib.tests.test_shelf',
4082
'bzrlib.tests.test_shelf_ui',
4083
'bzrlib.tests.test_smart',
4084
'bzrlib.tests.test_smart_add',
4085
'bzrlib.tests.test_smart_request',
4086
'bzrlib.tests.test_smart_signals',
4087
'bzrlib.tests.test_smart_transport',
4088
'bzrlib.tests.test_smtp_connection',
4089
'bzrlib.tests.test_source',
4090
'bzrlib.tests.test_ssh_transport',
4091
'bzrlib.tests.test_status',
4092
'bzrlib.tests.test_store',
4093
'bzrlib.tests.test_strace',
4094
'bzrlib.tests.test_subsume',
4095
'bzrlib.tests.test_switch',
4096
'bzrlib.tests.test_symbol_versioning',
4097
'bzrlib.tests.test_tag',
4098
'bzrlib.tests.test_test_server',
4099
'bzrlib.tests.test_testament',
4100
'bzrlib.tests.test_textfile',
4101
'bzrlib.tests.test_textmerge',
4102
'bzrlib.tests.test_cethread',
4103
'bzrlib.tests.test_timestamp',
4104
'bzrlib.tests.test_trace',
4105
'bzrlib.tests.test_transactions',
4106
'bzrlib.tests.test_transform',
4107
'bzrlib.tests.test_transport',
4108
'bzrlib.tests.test_transport_log',
4109
'bzrlib.tests.test_tree',
4110
'bzrlib.tests.test_treebuilder',
4111
'bzrlib.tests.test_treeshape',
4112
'bzrlib.tests.test_tsort',
4113
'bzrlib.tests.test_tuned_gzip',
4114
'bzrlib.tests.test_ui',
4115
'bzrlib.tests.test_uncommit',
4116
'bzrlib.tests.test_upgrade',
4117
'bzrlib.tests.test_upgrade_stacked',
4118
'bzrlib.tests.test_urlutils',
4119
'bzrlib.tests.test_utextwrap',
4120
'bzrlib.tests.test_version',
4121
'bzrlib.tests.test_version_info',
4122
'bzrlib.tests.test_versionedfile',
4123
'bzrlib.tests.test_vf_search',
4124
'bzrlib.tests.test_weave',
4125
'bzrlib.tests.test_whitebox',
4126
'bzrlib.tests.test_win32utils',
4127
'bzrlib.tests.test_workingtree',
4128
'bzrlib.tests.test_workingtree_4',
4129
'bzrlib.tests.test_wsgi',
4130
'bzrlib.tests.test_xml',
4134
def _test_suite_modules_to_doctest():
4135
"""Return the list of modules to doctest."""
4137
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4141
'bzrlib.branchbuilder',
4142
'bzrlib.decorators',
4144
'bzrlib.iterablefile',
4149
'bzrlib.symbol_versioning',
4151
'bzrlib.tests.fixtures',
4153
'bzrlib.transport.http',
4154
'bzrlib.version_info_formats.format_custom',
4158
def test_suite(keep_only=None, starting_with=None):
4159
"""Build and return TestSuite for the whole of bzrlib.
4161
:param keep_only: A list of test ids limiting the suite returned.
4163
:param starting_with: An id limiting the suite returned to the tests
4166
This function can be replaced if you need to change the default test
4167
suite on a global basis, but it is not encouraged.
4170
loader = TestUtil.TestLoader()
4172
if keep_only is not None:
4173
id_filter = TestIdList(keep_only)
4175
# We take precedence over keep_only because *at loading time* using
4176
# both options means we will load less tests for the same final result.
4177
def interesting_module(name):
4178
for start in starting_with:
4180
# Either the module name starts with the specified string
4181
name.startswith(start)
4182
# or it may contain tests starting with the specified string
4183
or start.startswith(name)
4187
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4189
elif keep_only is not None:
4190
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4191
def interesting_module(name):
4192
return id_filter.refers_to(name)
4195
loader = TestUtil.TestLoader()
4196
def interesting_module(name):
4197
# No filtering, all modules are interesting
4200
suite = loader.suiteClass()
4202
# modules building their suite with loadTestsFromModuleNames
4203
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4205
for mod in _test_suite_modules_to_doctest():
4206
if not interesting_module(mod):
4207
# No tests to keep here, move along
4210
# note that this really does mean "report only" -- doctest
4211
# still runs the rest of the examples
4212
doc_suite = IsolatedDocTestSuite(
4213
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
4214
except ValueError, e:
4215
print '**failed to get doctest for: %s\n%s' % (mod, e)
4217
if len(doc_suite._tests) == 0:
4218
raise errors.BzrError("no doctests found in %s" % (mod,))
4219
suite.addTest(doc_suite)
4221
default_encoding = sys.getdefaultencoding()
4222
for name, plugin in _mod_plugin.plugins().items():
4223
if not interesting_module(plugin.module.__name__):
4225
plugin_suite = plugin.test_suite()
4226
# We used to catch ImportError here and turn it into just a warning,
4227
# but really if you don't have --no-plugins this should be a failure.
4228
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4229
if plugin_suite is None:
4230
plugin_suite = plugin.load_plugin_tests(loader)
4231
if plugin_suite is not None:
4232
suite.addTest(plugin_suite)
4233
if default_encoding != sys.getdefaultencoding():
4235
'Plugin "%s" tried to reset default encoding to: %s', name,
4236
sys.getdefaultencoding())
4238
sys.setdefaultencoding(default_encoding)
4240
if keep_only is not None:
4241
# Now that the referred modules have loaded their tests, keep only the
4243
suite = filter_suite_by_id_list(suite, id_filter)
4244
# Do some sanity checks on the id_list filtering
4245
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4247
# The tester has used both keep_only and starting_with, so he is
4248
# already aware that some tests are excluded from the list, there
4249
# is no need to tell him which.
4252
# Some tests mentioned in the list are not in the test suite. The
4253
# list may be out of date, report to the tester.
4254
for id in not_found:
4255
trace.warning('"%s" not found in the test suite', id)
4256
for id in duplicates:
4257
trace.warning('"%s" is used as an id by several tests', id)
4262
def multiply_scenarios(*scenarios):
4263
"""Multiply two or more iterables of scenarios.
4265
It is safe to pass scenario generators or iterators.
4267
:returns: A list of compound scenarios: the cross-product of all
4268
scenarios, with the names concatenated and the parameters
4271
return reduce(_multiply_two_scenarios, map(list, scenarios))
4274
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4275
"""Multiply two sets of scenarios.
4277
:returns: the cartesian product of the two sets of scenarios, that is
4278
a scenario for every possible combination of a left scenario and a
4282
('%s,%s' % (left_name, right_name),
4283
dict(left_dict.items() + right_dict.items()))
4284
for left_name, left_dict in scenarios_left
4285
for right_name, right_dict in scenarios_right]
4288
def multiply_tests(tests, scenarios, result):
4289
"""Multiply tests_list by scenarios into result.
4291
This is the core workhorse for test parameterisation.
4293
Typically the load_tests() method for a per-implementation test suite will
4294
call multiply_tests and return the result.
4296
:param tests: The tests to parameterise.
4297
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4298
scenario_param_dict).
4299
:param result: A TestSuite to add created tests to.
4301
This returns the passed in result TestSuite with the cross product of all
4302
the tests repeated once for each scenario. Each test is adapted by adding
4303
the scenario name at the end of its id(), and updating the test object's
4304
__dict__ with the scenario_param_dict.
4306
>>> import bzrlib.tests.test_sampler
4307
>>> r = multiply_tests(
4308
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4309
... [('one', dict(param=1)),
4310
... ('two', dict(param=2))],
4311
... TestUtil.TestSuite())
4312
>>> tests = list(iter_suite_tests(r))
4316
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4322
for test in iter_suite_tests(tests):
4323
apply_scenarios(test, scenarios, result)
4327
def apply_scenarios(test, scenarios, result):
4328
"""Apply the scenarios in scenarios to test and add to result.
4330
:param test: The test to apply scenarios to.
4331
:param scenarios: An iterable of scenarios to apply to test.
4333
:seealso: apply_scenario
4335
for scenario in scenarios:
4336
result.addTest(apply_scenario(test, scenario))
4340
def apply_scenario(test, scenario):
4341
"""Copy test and apply scenario to it.
4343
:param test: A test to adapt.
4344
:param scenario: A tuple describing the scenarion.
4345
The first element of the tuple is the new test id.
4346
The second element is a dict containing attributes to set on the
4348
:return: The adapted test.
4350
new_id = "%s(%s)" % (test.id(), scenario[0])
4351
new_test = clone_test(test, new_id)
4352
for name, value in scenario[1].items():
4353
setattr(new_test, name, value)
4357
def clone_test(test, new_id):
4358
"""Clone a test giving it a new id.
4360
:param test: The test to clone.
4361
:param new_id: The id to assign to it.
4362
:return: The new test.
4364
new_test = copy.copy(test)
4365
new_test.id = lambda: new_id
4366
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4367
# causes cloned tests to share the 'details' dict. This makes it hard to
4368
# read the test output for parameterized tests, because tracebacks will be
4369
# associated with irrelevant tests.
4371
details = new_test._TestCase__details
4372
except AttributeError:
4373
# must be a different version of testtools than expected. Do nothing.
4376
# Reset the '__details' dict.
4377
new_test._TestCase__details = {}
4381
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4383
"""Helper for permutating tests against an extension module.
4385
This is meant to be used inside a modules 'load_tests()' function. It will
4386
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4387
against both implementations. Setting 'test.module' to the appropriate
4388
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4390
:param standard_tests: A test suite to permute
4391
:param loader: A TestLoader
4392
:param py_module_name: The python path to a python module that can always
4393
be loaded, and will be considered the 'python' implementation. (eg
4394
'bzrlib._chk_map_py')
4395
:param ext_module_name: The python path to an extension module. If the
4396
module cannot be loaded, a single test will be added, which notes that
4397
the module is not available. If it can be loaded, all standard_tests
4398
will be run against that module.
4399
:return: (suite, feature) suite is a test-suite that has all the permuted
4400
tests. feature is the Feature object that can be used to determine if
4401
the module is available.
4404
from bzrlib.tests.features import ModuleAvailableFeature
4405
py_module = pyutils.get_named_object(py_module_name)
4407
('python', {'module': py_module}),
4409
suite = loader.suiteClass()
4410
feature = ModuleAvailableFeature(ext_module_name)
4411
if feature.available():
4412
scenarios.append(('C', {'module': feature.module}))
4414
# the compiled module isn't available, so we add a failing test
4415
class FailWithoutFeature(TestCase):
4416
def test_fail(self):
4417
self.requireFeature(feature)
4418
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4419
result = multiply_tests(standard_tests, scenarios, suite)
4420
return result, feature
4423
def _rmtree_temp_dir(dirname, test_id=None):
4424
# If LANG=C we probably have created some bogus paths
4425
# which rmtree(unicode) will fail to delete
4426
# so make sure we are using rmtree(str) to delete everything
4427
# except on win32, where rmtree(str) will fail
4428
# since it doesn't have the property of byte-stream paths
4429
# (they are either ascii or mbcs)
4430
if sys.platform == 'win32':
4431
# make sure we are using the unicode win32 api
4432
dirname = unicode(dirname)
4434
dirname = dirname.encode(sys.getfilesystemencoding())
4436
osutils.rmtree(dirname)
4438
# We don't want to fail here because some useful display will be lost
4439
# otherwise. Polluting the tmp dir is bad, but not giving all the
4440
# possible info to the test runner is even worse.
4442
ui.ui_factory.clear_term()
4443
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4444
# Ugly, but the last thing we want here is fail, so bear with it.
4445
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4446
).encode('ascii', 'replace')
4447
sys.stderr.write('Unable to remove testing dir %s\n%s'
4448
% (os.path.basename(dirname), printable_e))
4451
def probe_unicode_in_user_encoding():
4452
"""Try to encode several unicode strings to use in unicode-aware tests.
4453
Return first successfull match.
4455
:return: (unicode value, encoded plain string value) or (None, None)
4457
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4458
for uni_val in possible_vals:
4460
str_val = uni_val.encode(osutils.get_user_encoding())
4461
except UnicodeEncodeError:
4462
# Try a different character
4465
return uni_val, str_val
4469
def probe_bad_non_ascii(encoding):
4470
"""Try to find [bad] character with code [128..255]
4471
that cannot be decoded to unicode in some encoding.
4472
Return None if all non-ascii characters is valid
4475
for i in xrange(128, 256):
4478
char.decode(encoding)
4479
except UnicodeDecodeError:
4484
# Only define SubUnitBzrRunner if subunit is available.
4486
from subunit import TestProtocolClient
4487
from subunit.test_results import AutoTimingTestResultDecorator
4488
class SubUnitBzrProtocolClient(TestProtocolClient):
4490
def stopTest(self, test):
4491
super(SubUnitBzrProtocolClient, self).stopTest(test)
4492
_clear__type_equality_funcs(test)
4494
def addSuccess(self, test, details=None):
4495
# The subunit client always includes the details in the subunit
4496
# stream, but we don't want to include it in ours.
4497
if details is not None and 'log' in details:
4499
return super(SubUnitBzrProtocolClient, self).addSuccess(
4502
class SubUnitBzrRunner(TextTestRunner):
4503
def run(self, test):
4504
result = AutoTimingTestResultDecorator(
4505
SubUnitBzrProtocolClient(self.stream))
4512
# API compatibility for old plugins; see bug 892622.
4515
'HTTPServerFeature',
4516
'ModuleAvailableFeature',
4517
'HTTPSServerFeature', 'SymlinkFeature', 'HardlinkFeature',
4518
'OsFifoFeature', 'UnicodeFilenameFeature',
4519
'ByteStringNamedFilesystem', 'UTF8Filesystem',
4520
'BreakinFeature', 'CaseInsCasePresFilenameFeature',
4521
'CaseInsensitiveFilesystemFeature', 'case_sensitive_filesystem_feature',
4522
'posix_permissions_feature',
4524
globals()[name] = _CompatabilityThunkFeature(
4525
symbol_versioning.deprecated_in((2, 5, 0)),
4526
'bzrlib.tests', name,
4527
name, 'bzrlib.tests.features')
4530
for (old_name, new_name) in [
4531
('UnicodeFilename', 'UnicodeFilenameFeature'),
4533
globals()[name] = _CompatabilityThunkFeature(
4534
symbol_versioning.deprecated_in((2, 5, 0)),
4535
'bzrlib.tests', old_name,
4536
new_name, 'bzrlib.tests.features')
added
removed
bzrlib/tests/__init__.py
