1
# Copyright (C) 2005-2011 Canonical Ltd
1
# Copyright (C) 2005 by Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Testing framework extensions"""
19
# NOTE: Some classes in here use camelCaseNaming() rather than
20
# underscore_naming(). That's for consistency with unittest; it's not the
21
# general style of bzrlib. Please continue that consistency when adding e.g.
22
# new assertFoo() methods.
27
from cStringIO import StringIO
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
50
# nb: check this before importing anything else from within it
51
_testtools_version = getattr(testtools, '__version__', ())
52
if _testtools_version < (0, 9, 5):
53
raise ImportError("need at least testtools 0.9.5: %s is %r"
54
% (testtools.__file__, _testtools_version))
55
from testtools import content
62
commands as _mod_commands,
72
plugin as _mod_plugin,
79
transport as _mod_transport,
85
# lsprof not available
28
import bzrlib.commands
35
MODULES_TO_DOCTEST = []
37
from logging import debug, warning, error
39
class CommandFailed(Exception):
87
from bzrlib.smart import client, request
88
from bzrlib.transport import (
92
from bzrlib.symbol_versioning import (
96
from bzrlib.tests import (
101
from bzrlib.ui import NullProgressView
102
from bzrlib.ui.text import TextUIFactory
104
# Mark this python module as being part of the implementation
105
# of unittest: this gives us better tracebacks where the last
106
# shown frame is the test code, not our assertXYZ.
109
default_transport = test_server.LocalURLServer
112
_unitialized_attr = object()
113
"""A sentinel needed to act as a default value in a method signature."""
116
# Subunit result codes, defined here to prevent a hard dependency on subunit.
120
# These are intentionally brought into this namespace. That way plugins, etc
121
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
122
TestSuite = TestUtil.TestSuite
123
TestLoader = TestUtil.TestLoader
125
# Tests should run in a clean and clearly defined environment. The goal is to
126
# keep them isolated from the running environment as mush as possible. The test
127
# framework ensures the variables defined below are set (or deleted if the
128
# value is None) before a test is run and reset to their original value after
129
# the test is run. Generally if some code depends on an environment variable,
130
# the tests should start without this variable in the environment. There are a
131
# few exceptions but you shouldn't violate this rule lightly.
135
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
136
# tests do check our impls match APPDATA
137
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
141
'BZREMAIL': None, # may still be present in the environment
142
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
143
'BZR_PROGRESS_BAR': None,
144
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
145
# as a base class instead of TestCaseInTempDir. Tests inheriting from
146
# TestCase should not use disk resources, BZR_LOG is one.
147
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
148
'BZR_PLUGIN_PATH': None,
149
'BZR_DISABLE_PLUGINS': None,
150
'BZR_PLUGINS_AT': None,
151
'BZR_CONCURRENCY': None,
152
# Make sure that any text ui tests are consistent regardless of
153
# the environment the test case is run in; you may want tests that
154
# test other combinations. 'dumb' is a reasonable guess for tests
155
# going to a pipe or a StringIO.
161
'SSH_AUTH_SOCK': None,
171
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
172
# least. If you do (care), please update this comment
176
'BZR_REMOTE_PATH': None,
177
# Generally speaking, we don't want apport reporting on crashes in
178
# the test envirnoment unless we're specifically testing apport,
179
# so that it doesn't leak into the real system environment. We
180
# use an env var so it propagates to subprocesses.
181
'APPORT_DISABLE': '1',
185
def override_os_environ(test, env=None):
186
"""Modify os.environ keeping a copy.
188
:param test: A test instance
190
:param env: A dict containing variable definitions to be installed
193
env = isolated_environ
194
test._original_os_environ = dict([(var, value)
195
for var, value in os.environ.iteritems()])
196
for var, value in env.iteritems():
197
osutils.set_or_unset_env(var, value)
198
if var not in test._original_os_environ:
199
# The var is new, add it with a value of None, so
200
# restore_os_environ will delete it
201
test._original_os_environ[var] = None
204
def restore_os_environ(test):
205
"""Restore os.environ to its original state.
207
:param test: A test instance previously passed to override_os_environ.
209
for var, value in test._original_os_environ.iteritems():
210
# Restore the original value (or delete it if the value has been set to
211
# None in override_os_environ).
212
osutils.set_or_unset_env(var, value)
215
class ExtendedTestResult(testtools.TextTestResult):
216
"""Accepts, reports and accumulates the results of running tests.
218
Compared to the unittest version this class adds support for
219
profiling, benchmarking, stopping as soon as a test fails, and
220
skipping tests. There are further-specialized subclasses for
221
different types of display.
223
When a test finishes, in whatever way, it calls one of the addSuccess,
224
addFailure or addError classes. These in turn may redirect to a more
225
specific case for the special test results supported by our extended
228
Note that just one of these objects is fed the results from many tests.
233
def __init__(self, stream, descriptions, verbosity,
237
"""Construct new TestResult.
239
:param bench_history: Optionally, a writable file object to accumulate
242
testtools.TextTestResult.__init__(self, stream)
243
if bench_history is not None:
244
from bzrlib.version import _get_bzr_source_tree
245
src_tree = _get_bzr_source_tree()
248
revision_id = src_tree.get_parent_ids()[0]
250
# XXX: if this is a brand new tree, do the same as if there
254
# XXX: If there's no branch, what should we do?
256
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
257
self._bench_history = bench_history
258
self.ui = ui.ui_factory
261
self.failure_count = 0
262
self.known_failure_count = 0
264
self.not_applicable_count = 0
265
self.unsupported = {}
267
self._overall_start_time = time.time()
268
self._strict = strict
269
self._first_thread_leaker_id = None
270
self._tests_leaking_threads_count = 0
271
self._traceback_from_test = None
273
def stopTestRun(self):
276
stopTime = time.time()
277
timeTaken = stopTime - self.startTime
278
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
279
# the parent class method is similar have to duplicate
280
self._show_list('ERROR', self.errors)
281
self._show_list('FAIL', self.failures)
282
self.stream.write(self.sep2)
283
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
284
run, run != 1 and "s" or "", timeTaken))
285
if not self.wasSuccessful():
286
self.stream.write("FAILED (")
287
failed, errored = map(len, (self.failures, self.errors))
289
self.stream.write("failures=%d" % failed)
291
if failed: self.stream.write(", ")
292
self.stream.write("errors=%d" % errored)
293
if self.known_failure_count:
294
if failed or errored: self.stream.write(", ")
295
self.stream.write("known_failure_count=%d" %
296
self.known_failure_count)
297
self.stream.write(")\n")
299
if self.known_failure_count:
300
self.stream.write("OK (known_failures=%d)\n" %
301
self.known_failure_count)
303
self.stream.write("OK\n")
304
if self.skip_count > 0:
305
skipped = self.skip_count
306
self.stream.write('%d test%s skipped\n' %
307
(skipped, skipped != 1 and "s" or ""))
309
for feature, count in sorted(self.unsupported.items()):
310
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
313
ok = self.wasStrictlySuccessful()
315
ok = self.wasSuccessful()
316
if self._first_thread_leaker_id:
318
'%s is leaking threads among %d leaking tests.\n' % (
319
self._first_thread_leaker_id,
320
self._tests_leaking_threads_count))
321
# We don't report the main thread as an active one.
323
'%d non-main threads were left active in the end.\n'
324
% (len(self._active_threads) - 1))
326
def getDescription(self, test):
329
def _extractBenchmarkTime(self, testCase, details=None):
330
"""Add a benchmark time for the current test case."""
331
if details and 'benchtime' in details:
332
return float(''.join(details['benchtime'].iter_bytes()))
333
return getattr(testCase, "_benchtime", None)
335
def _elapsedTestTimeString(self):
336
"""Return a time string for the overall time the current test has taken."""
337
return self._formatTime(self._delta_to_float(
338
self._now() - self._start_datetime))
340
def _testTimeString(self, testCase):
341
benchmark_time = self._extractBenchmarkTime(testCase)
342
if benchmark_time is not None:
343
return self._formatTime(benchmark_time) + "*"
345
return self._elapsedTestTimeString()
347
def _formatTime(self, seconds):
348
"""Format seconds as milliseconds with leading spaces."""
349
# some benchmarks can take thousands of seconds to run, so we need 8
351
return "%8dms" % (1000 * seconds)
353
def _shortened_test_description(self, test):
355
what = re.sub(r'^bzrlib\.tests\.', '', what)
358
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
359
# multiple times in a row, because the handler is added for
360
# each test but the container list is shared between cases.
361
# See lp:498869 lp:625574 and lp:637725 for background.
362
def _record_traceback_from_test(self, exc_info):
363
"""Store the traceback from passed exc_info tuple till"""
364
self._traceback_from_test = exc_info[2]
366
def startTest(self, test):
367
super(ExtendedTestResult, self).startTest(test)
371
self.report_test_start(test)
372
test.number = self.count
373
self._recordTestStartTime()
374
# Make testtools cases give us the real traceback on failure
375
addOnException = getattr(test, "addOnException", None)
376
if addOnException is not None:
377
addOnException(self._record_traceback_from_test)
378
# Only check for thread leaks on bzrlib derived test cases
379
if isinstance(test, TestCase):
380
test.addCleanup(self._check_leaked_threads, test)
382
def stopTest(self, test):
383
super(ExtendedTestResult, self).stopTest(test)
384
# Manually break cycles, means touching various private things but hey
385
getDetails = getattr(test, "getDetails", None)
386
if getDetails is not None:
388
# Clear _type_equality_funcs to try to stop TestCase instances
389
# from wasting memory. 'clear' is not available in all Python
390
# versions (bug 809048)
391
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
392
if type_equality_funcs is not None:
393
tef_clear = getattr(type_equality_funcs, "clear", None)
394
if tef_clear is None:
395
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
396
if tef_instance_dict is not None:
397
tef_clear = tef_instance_dict.clear
398
if tef_clear is not None:
400
self._traceback_from_test = None
402
def startTests(self):
403
self.report_tests_starting()
404
self._active_threads = threading.enumerate()
406
def _check_leaked_threads(self, test):
407
"""See if any threads have leaked since last call
409
A sample of live threads is stored in the _active_threads attribute,
410
when this method runs it compares the current live threads and any not
411
in the previous sample are treated as having leaked.
413
now_active_threads = set(threading.enumerate())
414
threads_leaked = now_active_threads.difference(self._active_threads)
416
self._report_thread_leak(test, threads_leaked, now_active_threads)
417
self._tests_leaking_threads_count += 1
418
if self._first_thread_leaker_id is None:
419
self._first_thread_leaker_id = test.id()
420
self._active_threads = now_active_threads
422
def _recordTestStartTime(self):
423
"""Record that a test has started."""
424
self._start_datetime = self._now()
426
def addError(self, test, err):
427
"""Tell result that test finished with an error.
429
Called from the TestCase run() method when the test
430
fails with an unexpected error.
432
self._post_mortem(self._traceback_from_test)
433
super(ExtendedTestResult, self).addError(test, err)
434
self.error_count += 1
435
self.report_error(test, err)
439
def addFailure(self, test, err):
440
"""Tell result that test failed.
442
Called from the TestCase run() method when the test
443
fails because e.g. an assert() method failed.
445
self._post_mortem(self._traceback_from_test)
446
super(ExtendedTestResult, self).addFailure(test, err)
447
self.failure_count += 1
448
self.report_failure(test, err)
452
def addSuccess(self, test, details=None):
453
"""Tell result that test completed successfully.
455
Called from the TestCase run()
457
if self._bench_history is not None:
458
benchmark_time = self._extractBenchmarkTime(test, details)
459
if benchmark_time is not None:
460
self._bench_history.write("%s %s\n" % (
461
self._formatTime(benchmark_time),
463
self.report_success(test)
464
super(ExtendedTestResult, self).addSuccess(test)
465
test._log_contents = ''
467
def addExpectedFailure(self, test, err):
468
self.known_failure_count += 1
469
self.report_known_failure(test, err)
471
def addUnexpectedSuccess(self, test, details=None):
472
"""Tell result the test unexpectedly passed, counting as a failure
474
When the minimum version of testtools required becomes 0.9.8 this
475
can be updated to use the new handling there.
477
super(ExtendedTestResult, self).addFailure(test, details=details)
478
self.failure_count += 1
479
self.report_unexpected_success(test,
480
"".join(details["reason"].iter_text()))
484
def addNotSupported(self, test, feature):
485
"""The test will not be run because of a missing feature.
487
# this can be called in two different ways: it may be that the
488
# test started running, and then raised (through requireFeature)
489
# UnavailableFeature. Alternatively this method can be called
490
# while probing for features before running the test code proper; in
491
# that case we will see startTest and stopTest, but the test will
492
# never actually run.
493
self.unsupported.setdefault(str(feature), 0)
494
self.unsupported[str(feature)] += 1
495
self.report_unsupported(test, feature)
497
def addSkip(self, test, reason):
498
"""A test has not run for 'reason'."""
500
self.report_skip(test, reason)
502
def addNotApplicable(self, test, reason):
503
self.not_applicable_count += 1
504
self.report_not_applicable(test, reason)
506
def _post_mortem(self, tb=None):
507
"""Start a PDB post mortem session."""
508
if os.environ.get('BZR_TEST_PDB', None):
512
def progress(self, offset, whence):
513
"""The test is adjusting the count of tests to run."""
514
if whence == SUBUNIT_SEEK_SET:
515
self.num_tests = offset
516
elif whence == SUBUNIT_SEEK_CUR:
517
self.num_tests += offset
519
raise errors.BzrError("Unknown whence %r" % whence)
521
def report_tests_starting(self):
522
"""Display information before the test run begins"""
523
if getattr(sys, 'frozen', None) is None:
524
bzr_path = osutils.realpath(sys.argv[0])
526
bzr_path = sys.executable
528
'bzr selftest: %s\n' % (bzr_path,))
531
bzrlib.__path__[0],))
533
' bzr-%s python-%s %s\n' % (
534
bzrlib.version_string,
535
bzrlib._format_version_tuple(sys.version_info),
536
platform.platform(aliased=1),
538
self.stream.write('\n')
540
def report_test_start(self, test):
541
"""Display information on the test just about to be run"""
543
def _report_thread_leak(self, test, leaked_threads, active_threads):
544
"""Display information on a test that leaked one or more threads"""
545
# GZ 2010-09-09: A leak summary reported separately from the general
546
# thread debugging would be nice. Tests under subunit
547
# need something not using stream, perhaps adding a
548
# testtools details object would be fitting.
549
if 'threads' in selftest_debug_flags:
550
self.stream.write('%s is leaking, active is now %d\n' %
551
(test.id(), len(active_threads)))
553
def startTestRun(self):
554
self.startTime = time.time()
556
def report_success(self, test):
559
def wasStrictlySuccessful(self):
560
if self.unsupported or self.known_failure_count:
562
return self.wasSuccessful()
565
class TextTestResult(ExtendedTestResult):
566
"""Displays progress and results of tests in text form"""
568
def __init__(self, stream, descriptions, verbosity,
573
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
574
bench_history, strict)
575
# We no longer pass them around, but just rely on the UIFactory stack
578
warnings.warn("Passing pb to TextTestResult is deprecated")
579
self.pb = self.ui.nested_progress_bar()
580
self.pb.show_pct = False
581
self.pb.show_spinner = False
582
self.pb.show_eta = False,
583
self.pb.show_count = False
584
self.pb.show_bar = False
585
self.pb.update_latency = 0
586
self.pb.show_transport_activity = False
588
def stopTestRun(self):
589
# called when the tests that are going to run have run
592
super(TextTestResult, self).stopTestRun()
594
def report_tests_starting(self):
595
super(TextTestResult, self).report_tests_starting()
596
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
598
def _progress_prefix_text(self):
599
# the longer this text, the less space we have to show the test
601
a = '[%d' % self.count # total that have been run
602
# tests skipped as known not to be relevant are not important enough
604
## if self.skip_count:
605
## a += ', %d skip' % self.skip_count
606
## if self.known_failure_count:
607
## a += '+%dX' % self.known_failure_count
609
a +='/%d' % self.num_tests
611
runtime = time.time() - self._overall_start_time
613
a += '%dm%ds' % (runtime / 60, runtime % 60)
616
total_fail_count = self.error_count + self.failure_count
618
a += ', %d failed' % total_fail_count
619
# if self.unsupported:
620
# a += ', %d missing' % len(self.unsupported)
624
def report_test_start(self, test):
626
self._progress_prefix_text()
628
+ self._shortened_test_description(test))
630
def _test_description(self, test):
631
return self._shortened_test_description(test)
633
def report_error(self, test, err):
634
self.stream.write('ERROR: %s\n %s\n' % (
635
self._test_description(test),
639
def report_failure(self, test, err):
640
self.stream.write('FAIL: %s\n %s\n' % (
641
self._test_description(test),
645
def report_known_failure(self, test, err):
648
def report_unexpected_success(self, test, reason):
649
self.stream.write('FAIL: %s\n %s: %s\n' % (
650
self._test_description(test),
651
"Unexpected success. Should have failed",
655
def report_skip(self, test, reason):
658
def report_not_applicable(self, test, reason):
661
def report_unsupported(self, test, feature):
662
"""test cannot be run because feature is missing."""
665
class VerboseTestResult(ExtendedTestResult):
666
"""Produce long output, with one line per test run plus times"""
668
def _ellipsize_to_right(self, a_string, final_width):
669
"""Truncate and pad a string, keeping the right hand side"""
670
if len(a_string) > final_width:
671
result = '...' + a_string[3-final_width:]
674
return result.ljust(final_width)
676
def report_tests_starting(self):
677
self.stream.write('running %d tests...\n' % self.num_tests)
678
super(VerboseTestResult, self).report_tests_starting()
680
def report_test_start(self, test):
681
name = self._shortened_test_description(test)
682
width = osutils.terminal_width()
683
if width is not None:
684
# width needs space for 6 char status, plus 1 for slash, plus an
685
# 11-char time string, plus a trailing blank
686
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
688
self.stream.write(self._ellipsize_to_right(name, width-18))
690
self.stream.write(name)
693
def _error_summary(self, err):
695
return '%s%s' % (indent, err[1])
697
def report_error(self, test, err):
698
self.stream.write('ERROR %s\n%s\n'
699
% (self._testTimeString(test),
700
self._error_summary(err)))
702
def report_failure(self, test, err):
703
self.stream.write(' FAIL %s\n%s\n'
704
% (self._testTimeString(test),
705
self._error_summary(err)))
707
def report_known_failure(self, test, err):
708
self.stream.write('XFAIL %s\n%s\n'
709
% (self._testTimeString(test),
710
self._error_summary(err)))
712
def report_unexpected_success(self, test, reason):
713
self.stream.write(' FAIL %s\n%s: %s\n'
714
% (self._testTimeString(test),
715
"Unexpected success. Should have failed",
718
def report_success(self, test):
719
self.stream.write(' OK %s\n' % self._testTimeString(test))
720
for bench_called, stats in getattr(test, '_benchcalls', []):
721
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
722
stats.pprint(file=self.stream)
723
# flush the stream so that we get smooth output. This verbose mode is
724
# used to show the output in PQM.
727
def report_skip(self, test, reason):
728
self.stream.write(' SKIP %s\n%s\n'
729
% (self._testTimeString(test), reason))
731
def report_not_applicable(self, test, reason):
732
self.stream.write(' N/A %s\n %s\n'
733
% (self._testTimeString(test), reason))
735
def report_unsupported(self, test, feature):
736
"""test cannot be run because feature is missing."""
737
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
738
%(self._testTimeString(test), feature))
741
class TextTestRunner(object):
742
stop_on_failure = False
750
result_decorators=None,
752
"""Create a TextTestRunner.
754
:param result_decorators: An optional list of decorators to apply
755
to the result object being used by the runner. Decorators are
756
applied left to right - the first element in the list is the
759
# stream may know claim to know to write unicode strings, but in older
760
# pythons this goes sufficiently wrong that it is a bad idea. (
761
# specifically a built in file with encoding 'UTF-8' will still try
762
# to encode using ascii.
763
new_encoding = osutils.get_terminal_encoding()
764
codec = codecs.lookup(new_encoding)
765
if type(codec) is tuple:
769
encode = codec.encode
770
# GZ 2010-09-08: Really we don't want to be writing arbitrary bytes,
771
# so should swap to the plain codecs.StreamWriter
772
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream,
774
stream.encoding = new_encoding
776
self.descriptions = descriptions
777
self.verbosity = verbosity
778
self._bench_history = bench_history
779
self._strict = strict
780
self._result_decorators = result_decorators or []
783
"Run the given test case or test suite."
784
if self.verbosity == 1:
785
result_class = TextTestResult
786
elif self.verbosity >= 2:
787
result_class = VerboseTestResult
788
original_result = result_class(self.stream,
791
bench_history=self._bench_history,
794
# Signal to result objects that look at stop early policy to stop,
795
original_result.stop_early = self.stop_on_failure
796
result = original_result
797
for decorator in self._result_decorators:
798
result = decorator(result)
799
result.stop_early = self.stop_on_failure
800
result.startTestRun()
805
# higher level code uses our extended protocol to determine
806
# what exit code to give.
807
return original_result
810
def iter_suite_tests(suite):
811
"""Return all tests in a suite, recursing through nested suites"""
812
if isinstance(suite, unittest.TestCase):
814
elif isinstance(suite, unittest.TestSuite):
816
for r in iter_suite_tests(item):
819
raise Exception('unknown type %r for object %r'
820
% (type(suite), suite))
823
TestSkipped = testtools.testcase.TestSkipped
826
class TestNotApplicable(TestSkipped):
827
"""A test is not applicable to the situation where it was run.
829
This is only normally raised by parameterized tests, if they find that
830
the instance they're constructed upon does not support one aspect
835
# traceback._some_str fails to format exceptions that have the default
836
# __str__ which does an implicit ascii conversion. However, repr() on those
837
# objects works, for all that its not quite what the doctor may have ordered.
838
def _clever_some_str(value):
843
return repr(value).replace('\\n', '\n')
845
return '<unprintable %s object>' % type(value).__name__
847
traceback._some_str = _clever_some_str
850
# deprecated - use self.knownFailure(), or self.expectFailure.
851
KnownFailure = testtools.testcase._ExpectedFailure
854
class UnavailableFeature(Exception):
855
"""A feature required for this test was not available.
857
This can be considered a specialised form of SkippedTest.
859
The feature should be used to construct the exception.
863
class StringIOWrapper(object):
864
"""A wrapper around cStringIO which just adds an encoding attribute.
866
Internally we can check sys.stdout to see what the output encoding
867
should be. However, cStringIO has no encoding attribute that we can
868
set. So we wrap it instead.
873
def __init__(self, s=None):
875
self.__dict__['_cstring'] = StringIO(s)
877
self.__dict__['_cstring'] = StringIO()
879
def __getattr__(self, name, getattr=getattr):
880
return getattr(self.__dict__['_cstring'], name)
882
def __setattr__(self, name, val):
883
if name == 'encoding':
884
self.__dict__['encoding'] = val
886
return setattr(self._cstring, name, val)
889
class TestUIFactory(TextUIFactory):
890
"""A UI Factory for testing.
892
Hide the progress bar but emit note()s.
894
Allows get_password to be tested without real tty attached.
896
See also CannedInputUIFactory which lets you provide programmatic input in
899
# TODO: Capture progress events at the model level and allow them to be
900
# observed by tests that care.
902
# XXX: Should probably unify more with CannedInputUIFactory or a
903
# particular configuration of TextUIFactory, or otherwise have a clearer
904
# idea of how they're supposed to be different.
905
# See https://bugs.launchpad.net/bzr/+bug/408213
907
def __init__(self, stdout=None, stderr=None, stdin=None):
908
if stdin is not None:
909
# We use a StringIOWrapper to be able to test various
910
# encodings, but the user is still responsible to
911
# encode the string and to set the encoding attribute
912
# of StringIOWrapper.
913
stdin = StringIOWrapper(stdin)
914
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
916
def get_non_echoed_password(self):
917
"""Get password from stdin without trying to handle the echo mode"""
918
password = self.stdin.readline()
921
if password[-1] == '\n':
922
password = password[:-1]
925
def make_progress_view(self):
926
return NullProgressView()
929
def isolated_doctest_setUp(test):
930
override_os_environ(test)
933
def isolated_doctest_tearDown(test):
934
restore_os_environ(test)
937
def IsolatedDocTestSuite(*args, **kwargs):
938
"""Overrides doctest.DocTestSuite to handle isolation.
940
The method is really a factory and users are expected to use it as such.
943
kwargs['setUp'] = isolated_doctest_setUp
944
kwargs['tearDown'] = isolated_doctest_tearDown
945
return doctest.DocTestSuite(*args, **kwargs)
948
class TestCase(testtools.TestCase):
42
class TestCase(unittest.TestCase):
949
43
"""Base class for bzr unit tests.
951
Tests that need access to disk resources should subclass
45
Tests that need access to disk resources should subclass
952
46
TestCaseInTempDir not TestCase.
954
48
Error and debug log messages are redirected from their usual
955
49
location into a temporary file, the contents of which can be
956
retrieved by _get_log(). We use a real OS file, not an in-memory object,
957
so that it can also capture file IO. When the test completes this file
958
is read into memory and removed from disk.
50
retrieved by _get_log().
960
52
There are also convenience functions to invoke bzr's command-line
961
routine, and to build and check bzr trees.
963
In addition to the usual method of overriding tearDown(), this class also
964
allows subclasses to register cleanup functions via addCleanup, which are
965
run in order as the object is torn down. It's less likely this will be
966
accidentally overlooked.
970
# record lsprof data when performing benchmark calls.
971
_gather_lsprof_in_benchmarks = False
973
def __init__(self, methodName='testMethod'):
974
super(TestCase, self).__init__(methodName)
975
self._directory_isolation = True
976
self.exception_handlers.insert(0,
977
(UnavailableFeature, self._do_unsupported_or_skip))
978
self.exception_handlers.insert(0,
979
(TestNotApplicable, self._do_not_applicable))
53
routine, and to build and check bzr trees."""
982
super(TestCase, self).setUp()
983
for feature in getattr(self, '_test_needs_features', []):
984
self.requireFeature(feature)
985
self._cleanEnvironment()
988
self._benchcalls = []
989
self._benchtime = None
991
self._track_transports()
993
self._clear_debug_flags()
994
# Isolate global verbosity level, to make sure it's reproducible
995
# between tests. We should get rid of this altogether: bug 656694. --
997
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
998
# Isolate config option expansion until its default value for bzrlib is
999
# settled on or a the FIXME associated with _get_expand_default_value
1000
# is addressed -- vila 20110219
1001
self.overrideAttr(config, '_expand_default_value', None)
1002
self._log_files = set()
1003
# Each key in the ``_counters`` dict holds a value for a different
1004
# counter. When the test ends, addDetail() should be used to output the
1005
# counter values. This happens in install_counter_hook().
1007
if 'config_stats' in selftest_debug_flags:
1008
self._install_config_stats_hooks()
1009
# Do not use i18n for tests (unless the test reverses this)
1015
# The sys preserved stdin/stdout should allow blackbox tests debugging
1016
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
1017
).set_trace(sys._getframe().f_back)
1019
def discardDetail(self, name):
1020
"""Extend the addDetail, getDetails api so we can remove a detail.
1022
eg. bzr always adds the 'log' detail at startup, but we don't want to
1023
include it for skipped, xfail, etc tests.
1025
It is safe to call this for a detail that doesn't exist, in case this
1026
gets called multiple times.
1028
# We cheat. details is stored in __details which means we shouldn't
1029
# touch it. but getDetails() returns the dict directly, so we can
1031
details = self.getDetails()
1035
def install_counter_hook(self, hooks, name, counter_name=None):
1036
"""Install a counting hook.
1038
Any hook can be counted as long as it doesn't need to return a value.
1040
:param hooks: Where the hook should be installed.
1042
:param name: The hook name that will be counted.
1044
:param counter_name: The counter identifier in ``_counters``, defaults
1047
_counters = self._counters # Avoid closing over self
1048
if counter_name is None:
1050
if _counters.has_key(counter_name):
1051
raise AssertionError('%s is already used as a counter name'
1053
_counters[counter_name] = 0
1054
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1055
lambda: ['%d' % (_counters[counter_name],)]))
1056
def increment_counter(*args, **kwargs):
1057
_counters[counter_name] += 1
1058
label = 'count %s calls' % (counter_name,)
1059
hooks.install_named_hook(name, increment_counter, label)
1060
self.addCleanup(hooks.uninstall_named_hook, name, label)
1062
def _install_config_stats_hooks(self):
1063
"""Install config hooks to count hook calls.
1066
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1067
self.install_counter_hook(config.ConfigHooks, hook_name,
1068
'config.%s' % (hook_name,))
1070
# The OldConfigHooks are private and need special handling to protect
1071
# against recursive tests (tests that run other tests), so we just do
1072
# manually what registering them into _builtin_known_hooks will provide
1074
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1075
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1076
self.install_counter_hook(config.OldConfigHooks, hook_name,
1077
'old_config.%s' % (hook_name,))
1079
def _clear_debug_flags(self):
1080
"""Prevent externally set debug flags affecting tests.
1082
Tests that want to use debug flags can just set them in the
1083
debug_flags set during setup/teardown.
1085
# Start with a copy of the current debug flags we can safely modify.
1086
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
1087
if 'allow_debug' not in selftest_debug_flags:
1088
debug.debug_flags.clear()
1089
if 'disable_lock_checks' not in selftest_debug_flags:
1090
debug.debug_flags.add('strict_locks')
1092
def _clear_hooks(self):
1093
# prevent hooks affecting tests
1094
known_hooks = hooks.known_hooks
1095
self._preserved_hooks = {}
1096
for key, (parent, name) in known_hooks.iter_parent_objects():
1097
current_hooks = getattr(parent, name)
1098
self._preserved_hooks[parent] = (name, current_hooks)
1099
self._preserved_lazy_hooks = hooks._lazy_hooks
1100
hooks._lazy_hooks = {}
1101
self.addCleanup(self._restoreHooks)
1102
for key, (parent, name) in known_hooks.iter_parent_objects():
1103
factory = known_hooks.get(key)
1104
setattr(parent, name, factory())
1105
# this hook should always be installed
1106
request._install_hook()
1108
def disable_directory_isolation(self):
1109
"""Turn off directory isolation checks."""
1110
self._directory_isolation = False
1112
def enable_directory_isolation(self):
1113
"""Enable directory isolation checks."""
1114
self._directory_isolation = True
1116
def _silenceUI(self):
1117
"""Turn off UI for duration of test"""
1118
# by default the UI is off; tests can turn it on if they want it.
1119
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
1121
def _check_locks(self):
1122
"""Check that all lock take/release actions have been paired."""
1123
# We always check for mismatched locks. If a mismatch is found, we
1124
# fail unless -Edisable_lock_checks is supplied to selftest, in which
1125
# case we just print a warning.
1127
acquired_locks = [lock for action, lock in self._lock_actions
1128
if action == 'acquired']
1129
released_locks = [lock for action, lock in self._lock_actions
1130
if action == 'released']
1131
broken_locks = [lock for action, lock in self._lock_actions
1132
if action == 'broken']
1133
# trivially, given the tests for lock acquistion and release, if we
1134
# have as many in each list, it should be ok. Some lock tests also
1135
# break some locks on purpose and should be taken into account by
1136
# considering that breaking a lock is just a dirty way of releasing it.
1137
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
1139
'Different number of acquired and '
1140
'released or broken locks.\n'
1144
(acquired_locks, released_locks, broken_locks))
1145
if not self._lock_check_thorough:
1146
# Rather than fail, just warn
1147
print "Broken test %s: %s" % (self, message)
1151
def _track_locks(self):
1152
"""Track lock activity during tests."""
1153
self._lock_actions = []
1154
if 'disable_lock_checks' in selftest_debug_flags:
1155
self._lock_check_thorough = False
1157
self._lock_check_thorough = True
1159
self.addCleanup(self._check_locks)
1160
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
1161
self._lock_acquired, None)
1162
_mod_lock.Lock.hooks.install_named_hook('lock_released',
1163
self._lock_released, None)
1164
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
1165
self._lock_broken, None)
1167
def _lock_acquired(self, result):
1168
self._lock_actions.append(('acquired', result))
1170
def _lock_released(self, result):
1171
self._lock_actions.append(('released', result))
1173
def _lock_broken(self, result):
1174
self._lock_actions.append(('broken', result))
1176
def permit_dir(self, name):
1177
"""Permit a directory to be used by this test. See permit_url."""
1178
name_transport = _mod_transport.get_transport_from_path(name)
1179
self.permit_url(name)
1180
self.permit_url(name_transport.base)
1182
def permit_url(self, url):
1183
"""Declare that url is an ok url to use in this test.
1185
Do this for memory transports, temporary test directory etc.
1187
Do not do this for the current working directory, /tmp, or any other
1188
preexisting non isolated url.
1190
if not url.endswith('/'):
1192
self._bzr_selftest_roots.append(url)
1194
def permit_source_tree_branch_repo(self):
1195
"""Permit the source tree bzr is running from to be opened.
1197
Some code such as bzrlib.version attempts to read from the bzr branch
1198
that bzr is executing from (if any). This method permits that directory
1199
to be used in the test suite.
1201
path = self.get_source_path()
1202
self.record_directory_isolation()
1205
workingtree.WorkingTree.open(path)
1206
except (errors.NotBranchError, errors.NoWorkingTree):
1207
raise TestSkipped('Needs a working tree of bzr sources')
1209
self.enable_directory_isolation()
1211
def _preopen_isolate_transport(self, transport):
1212
"""Check that all transport openings are done in the test work area."""
1213
while isinstance(transport, pathfilter.PathFilteringTransport):
1214
# Unwrap pathfiltered transports
1215
transport = transport.server.backing_transport.clone(
1216
transport._filter('.'))
1217
url = transport.base
1218
# ReadonlySmartTCPServer_for_testing decorates the backing transport
1219
# urls it is given by prepending readonly+. This is appropriate as the
1220
# client shouldn't know that the server is readonly (or not readonly).
1221
# We could register all servers twice, with readonly+ prepending, but
1222
# that makes for a long list; this is about the same but easier to
1224
if url.startswith('readonly+'):
1225
url = url[len('readonly+'):]
1226
self._preopen_isolate_url(url)
1228
def _preopen_isolate_url(self, url):
1229
if not self._directory_isolation:
1231
if self._directory_isolation == 'record':
1232
self._bzr_selftest_roots.append(url)
1234
# This prevents all transports, including e.g. sftp ones backed on disk
1235
# from working unless they are explicitly granted permission. We then
1236
# depend on the code that sets up test transports to check that they are
1237
# appropriately isolated and enable their use by calling
1238
# self.permit_transport()
1239
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1240
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1241
% (url, self._bzr_selftest_roots))
1243
def record_directory_isolation(self):
1244
"""Gather accessed directories to permit later access.
1246
This is used for tests that access the branch bzr is running from.
1248
self._directory_isolation = "record"
1250
def start_server(self, transport_server, backing_server=None):
1251
"""Start transport_server for this test.
1253
This starts the server, registers a cleanup for it and permits the
1254
server's urls to be used.
1256
if backing_server is None:
1257
transport_server.start_server()
1259
transport_server.start_server(backing_server)
1260
self.addCleanup(transport_server.stop_server)
1261
# Obtain a real transport because if the server supplies a password, it
1262
# will be hidden from the base on the client side.
1263
t = _mod_transport.get_transport_from_url(transport_server.get_url())
1264
# Some transport servers effectively chroot the backing transport;
1265
# others like SFTPServer don't - users of the transport can walk up the
1266
# transport to read the entire backing transport. This wouldn't matter
1267
# except that the workdir tests are given - and that they expect the
1268
# server's url to point at - is one directory under the safety net. So
1269
# Branch operations into the transport will attempt to walk up one
1270
# directory. Chrooting all servers would avoid this but also mean that
1271
# we wouldn't be testing directly against non-root urls. Alternatively
1272
# getting the test framework to start the server with a backing server
1273
# at the actual safety net directory would work too, but this then
1274
# means that the self.get_url/self.get_transport methods would need
1275
# to transform all their results. On balance its cleaner to handle it
1276
# here, and permit a higher url when we have one of these transports.
1277
if t.base.endswith('/work/'):
1278
# we have safety net/test root/work
1279
t = t.clone('../..')
1280
elif isinstance(transport_server,
1281
test_server.SmartTCPServer_for_testing):
1282
# The smart server adds a path similar to work, which is traversed
1283
# up from by the client. But the server is chrooted - the actual
1284
# backing transport is not escaped from, and VFS requests to the
1285
# root will error (because they try to escape the chroot).
1287
while t2.base != t.base:
1290
self.permit_url(t.base)
1292
def _track_transports(self):
1293
"""Install checks for transport usage."""
1294
# TestCase has no safe place it can write to.
1295
self._bzr_selftest_roots = []
1296
# Currently the easiest way to be sure that nothing is going on is to
1297
# hook into bzr dir opening. This leaves a small window of error for
1298
# transport tests, but they are well known, and we can improve on this
1300
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1301
self._preopen_isolate_transport, "Check bzr directories are safe.")
1303
def _ndiff_strings(self, a, b):
1304
"""Return ndiff between two strings containing lines.
1306
A trailing newline is added if missing to make the strings
1308
if b and b[-1] != '\n':
1310
if a and a[-1] != '\n':
1312
difflines = difflib.ndiff(a.splitlines(True),
1314
linejunk=lambda x: False,
1315
charjunk=lambda x: False)
1316
return ''.join(difflines)
1318
def assertEqual(self, a, b, message=''):
1322
except UnicodeError, e:
1323
# If we can't compare without getting a UnicodeError, then
1324
# obviously they are different
1325
trace.mutter('UnicodeError: %s', e)
1328
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1330
pprint.pformat(a), pprint.pformat(b)))
1332
assertEquals = assertEqual
1334
def assertEqualDiff(self, a, b, message=None):
1335
"""Assert two texts are equal, if not raise an exception.
1337
This is intended for use with multi-line strings where it can
1338
be hard to find the differences by eye.
1340
# TODO: perhaps override assertEquals to call this for strings?
1344
message = "texts not equal:\n"
1346
message = 'first string is missing a final newline.\n'
1348
message = 'second string is missing a final newline.\n'
1349
raise AssertionError(message +
1350
self._ndiff_strings(a, b))
1352
def assertEqualMode(self, mode, mode_test):
1353
self.assertEqual(mode, mode_test,
1354
'mode mismatch %o != %o' % (mode, mode_test))
1356
def assertEqualStat(self, expected, actual):
1357
"""assert that expected and actual are the same stat result.
1359
:param expected: A stat result.
1360
:param actual: A stat result.
1361
:raises AssertionError: If the expected and actual stat values differ
1362
other than by atime.
1364
self.assertEqual(expected.st_size, actual.st_size,
1365
'st_size did not match')
1366
self.assertEqual(expected.st_mtime, actual.st_mtime,
1367
'st_mtime did not match')
1368
self.assertEqual(expected.st_ctime, actual.st_ctime,
1369
'st_ctime did not match')
1370
if sys.platform == 'win32':
1371
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1372
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1373
# odd. We just force it to always be 0 to avoid any problems.
1374
self.assertEqual(0, expected.st_dev)
1375
self.assertEqual(0, actual.st_dev)
1376
self.assertEqual(0, expected.st_ino)
1377
self.assertEqual(0, actual.st_ino)
1379
self.assertEqual(expected.st_dev, actual.st_dev,
1380
'st_dev did not match')
1381
self.assertEqual(expected.st_ino, actual.st_ino,
1382
'st_ino did not match')
1383
self.assertEqual(expected.st_mode, actual.st_mode,
1384
'st_mode did not match')
1386
def assertLength(self, length, obj_with_len):
1387
"""Assert that obj_with_len is of length length."""
1388
if len(obj_with_len) != length:
1389
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1390
length, len(obj_with_len), obj_with_len))
1392
def assertLogsError(self, exception_class, func, *args, **kwargs):
1393
"""Assert that `func(*args, **kwargs)` quietly logs a specific error.
1396
orig_log_exception_quietly = trace.log_exception_quietly
1399
orig_log_exception_quietly()
1400
captured.append(sys.exc_info()[1])
1401
trace.log_exception_quietly = capture
1402
func(*args, **kwargs)
1404
trace.log_exception_quietly = orig_log_exception_quietly
1405
self.assertLength(1, captured)
1407
self.assertIsInstance(err, exception_class)
1410
def assertPositive(self, val):
1411
"""Assert that val is greater than 0."""
1412
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1414
def assertNegative(self, val):
1415
"""Assert that val is less than 0."""
1416
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1418
def assertStartsWith(self, s, prefix):
1419
if not s.startswith(prefix):
1420
raise AssertionError('string %r does not start with %r' % (s, prefix))
1422
def assertEndsWith(self, s, suffix):
1423
"""Asserts that s ends with suffix."""
1424
if not s.endswith(suffix):
1425
raise AssertionError('string %r does not end with %r' % (s, suffix))
1427
def assertContainsRe(self, haystack, needle_re, flags=0):
1428
"""Assert that a contains something matching a regular expression."""
1429
if not re.search(needle_re, haystack, flags):
1430
if '\n' in haystack or len(haystack) > 60:
1431
# a long string, format it in a more readable way
1432
raise AssertionError(
1433
'pattern "%s" not found in\n"""\\\n%s"""\n'
1434
% (needle_re, haystack))
1436
raise AssertionError('pattern "%s" not found in "%s"'
1437
% (needle_re, haystack))
1439
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1440
"""Assert that a does not match a regular expression"""
1441
if re.search(needle_re, haystack, flags):
1442
raise AssertionError('pattern "%s" found in "%s"'
1443
% (needle_re, haystack))
1445
def assertContainsString(self, haystack, needle):
1446
if haystack.find(needle) == -1:
1447
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1449
def assertNotContainsString(self, haystack, needle):
1450
if haystack.find(needle) != -1:
1451
self.fail("string %r found in '''%s'''" % (needle, haystack))
1453
def assertSubset(self, sublist, superlist):
1454
"""Assert that every entry in sublist is present in superlist."""
1455
missing = set(sublist) - set(superlist)
1456
if len(missing) > 0:
1457
raise AssertionError("value(s) %r not present in container %r" %
1458
(missing, superlist))
1460
def assertListRaises(self, excClass, func, *args, **kwargs):
1461
"""Fail unless excClass is raised when the iterator from func is used.
1463
Many functions can return generators this makes sure
1464
to wrap them in a list() call to make sure the whole generator
1465
is run, and that the proper exception is raised.
1468
list(func(*args, **kwargs))
1472
if getattr(excClass,'__name__', None) is not None:
1473
excName = excClass.__name__
1475
excName = str(excClass)
1476
raise self.failureException, "%s not raised" % excName
1478
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1479
"""Assert that a callable raises a particular exception.
1481
:param excClass: As for the except statement, this may be either an
1482
exception class, or a tuple of classes.
1483
:param callableObj: A callable, will be passed ``*args`` and
1486
Returns the exception so that you can examine it.
1489
callableObj(*args, **kwargs)
1493
if getattr(excClass,'__name__', None) is not None:
1494
excName = excClass.__name__
1497
excName = str(excClass)
1498
raise self.failureException, "%s not raised" % excName
1500
def assertIs(self, left, right, message=None):
1501
if not (left is right):
1502
if message is not None:
1503
raise AssertionError(message)
1505
raise AssertionError("%r is not %r." % (left, right))
1507
def assertIsNot(self, left, right, message=None):
1509
if message is not None:
1510
raise AssertionError(message)
1512
raise AssertionError("%r is %r." % (left, right))
1514
def assertTransportMode(self, transport, path, mode):
1515
"""Fail if a path does not have mode "mode".
1517
If modes are not supported on this transport, the assertion is ignored.
1519
if not transport._can_roundtrip_unix_modebits():
1521
path_stat = transport.stat(path)
1522
actual_mode = stat.S_IMODE(path_stat.st_mode)
1523
self.assertEqual(mode, actual_mode,
1524
'mode of %r incorrect (%s != %s)'
1525
% (path, oct(mode), oct(actual_mode)))
1527
def assertIsSameRealPath(self, path1, path2):
1528
"""Fail if path1 and path2 points to different files"""
1529
self.assertEqual(osutils.realpath(path1),
1530
osutils.realpath(path2),
1531
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1533
def assertIsInstance(self, obj, kls, msg=None):
1534
"""Fail if obj is not an instance of kls
1536
:param msg: Supplementary message to show if the assertion fails.
1538
if not isinstance(obj, kls):
1539
m = "%r is an instance of %s rather than %s" % (
1540
obj, obj.__class__, kls)
1545
def assertFileEqual(self, content, path):
1546
"""Fail if path does not contain 'content'."""
1547
self.assertPathExists(path)
1548
f = file(path, 'rb')
1553
self.assertEqualDiff(content, s)
1555
def assertDocstring(self, expected_docstring, obj):
1556
"""Fail if obj does not have expected_docstring"""
1558
# With -OO the docstring should be None instead
1559
self.assertIs(obj.__doc__, None)
1561
self.assertEqual(expected_docstring, obj.__doc__)
1563
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1564
def failUnlessExists(self, path):
1565
return self.assertPathExists(path)
1567
def assertPathExists(self, path):
1568
"""Fail unless path or paths, which may be abs or relative, exist."""
1569
if not isinstance(path, basestring):
1571
self.assertPathExists(p)
1573
self.assertTrue(osutils.lexists(path),
1574
path + " does not exist")
1576
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1577
def failIfExists(self, path):
1578
return self.assertPathDoesNotExist(path)
1580
def assertPathDoesNotExist(self, path):
1581
"""Fail if path or paths, which may be abs or relative, exist."""
1582
if not isinstance(path, basestring):
1584
self.assertPathDoesNotExist(p)
1586
self.assertFalse(osutils.lexists(path),
1589
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1590
"""A helper for callDeprecated and applyDeprecated.
1592
:param a_callable: A callable to call.
1593
:param args: The positional arguments for the callable
1594
:param kwargs: The keyword arguments for the callable
1595
:return: A tuple (warnings, result). result is the result of calling
1596
a_callable(``*args``, ``**kwargs``).
1599
def capture_warnings(msg, cls=None, stacklevel=None):
1600
# we've hooked into a deprecation specific callpath,
1601
# only deprecations should getting sent via it.
1602
self.assertEqual(cls, DeprecationWarning)
1603
local_warnings.append(msg)
1604
original_warning_method = symbol_versioning.warn
1605
symbol_versioning.set_warning_method(capture_warnings)
1607
result = a_callable(*args, **kwargs)
1609
symbol_versioning.set_warning_method(original_warning_method)
1610
return (local_warnings, result)
1612
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1613
"""Call a deprecated callable without warning the user.
1615
Note that this only captures warnings raised by symbol_versioning.warn,
1616
not other callers that go direct to the warning module.
1618
To test that a deprecated method raises an error, do something like
1619
this (remember that both assertRaises and applyDeprecated delays *args
1620
and **kwargs passing)::
1622
self.assertRaises(errors.ReservedId,
1623
self.applyDeprecated,
1624
deprecated_in((1, 5, 0)),
1628
:param deprecation_format: The deprecation format that the callable
1629
should have been deprecated with. This is the same type as the
1630
parameter to deprecated_method/deprecated_function. If the
1631
callable is not deprecated with this format, an assertion error
1633
:param a_callable: A callable to call. This may be a bound method or
1634
a regular function. It will be called with ``*args`` and
1636
:param args: The positional arguments for the callable
1637
:param kwargs: The keyword arguments for the callable
1638
:return: The result of a_callable(``*args``, ``**kwargs``)
1640
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1642
expected_first_warning = symbol_versioning.deprecation_string(
1643
a_callable, deprecation_format)
1644
if len(call_warnings) == 0:
1645
self.fail("No deprecation warning generated by call to %s" %
1647
self.assertEqual(expected_first_warning, call_warnings[0])
1650
def callCatchWarnings(self, fn, *args, **kw):
1651
"""Call a callable that raises python warnings.
1653
The caller's responsible for examining the returned warnings.
1655
If the callable raises an exception, the exception is not
1656
caught and propagates up to the caller. In that case, the list
1657
of warnings is not available.
1659
:returns: ([warning_object, ...], fn_result)
1661
# XXX: This is not perfect, because it completely overrides the
1662
# warnings filters, and some code may depend on suppressing particular
1663
# warnings. It's the easiest way to insulate ourselves from -Werror,
1664
# though. -- Andrew, 20071062
1666
def _catcher(message, category, filename, lineno, file=None, line=None):
1667
# despite the name, 'message' is normally(?) a Warning subclass
1669
wlist.append(message)
1670
saved_showwarning = warnings.showwarning
1671
saved_filters = warnings.filters
1673
warnings.showwarning = _catcher
1674
warnings.filters = []
1675
result = fn(*args, **kw)
1677
warnings.showwarning = saved_showwarning
1678
warnings.filters = saved_filters
1679
return wlist, result
1681
def callDeprecated(self, expected, callable, *args, **kwargs):
1682
"""Assert that a callable is deprecated in a particular way.
1684
This is a very precise test for unusual requirements. The
1685
applyDeprecated helper function is probably more suited for most tests
1686
as it allows you to simply specify the deprecation format being used
1687
and will ensure that that is issued for the function being called.
1689
Note that this only captures warnings raised by symbol_versioning.warn,
1690
not other callers that go direct to the warning module. To catch
1691
general warnings, use callCatchWarnings.
1693
:param expected: a list of the deprecation warnings expected, in order
1694
:param callable: The callable to call
1695
:param args: The positional arguments for the callable
1696
:param kwargs: The keyword arguments for the callable
1698
call_warnings, result = self._capture_deprecation_warnings(callable,
1700
self.assertEqual(expected, call_warnings)
1703
def _startLogFile(self):
1704
"""Send bzr and test log messages to a temporary file.
1706
The file is removed as the test is torn down.
1708
pseudo_log_file = StringIO()
1709
def _get_log_contents_for_weird_testtools_api():
1710
return [pseudo_log_file.getvalue().decode(
1711
"utf-8", "replace").encode("utf-8")]
1712
self.addDetail("log", content.Content(content.ContentType("text",
1713
"plain", {"charset": "utf8"}),
1714
_get_log_contents_for_weird_testtools_api))
1715
self._log_file = pseudo_log_file
1716
self._log_memento = trace.push_log_file(self._log_file)
1717
self.addCleanup(self._finishLogFile)
1719
def _finishLogFile(self):
1720
"""Finished with the log file.
1722
Close the file and delete it.
1724
if trace._trace_file:
1725
# flush the log file, to get all content
1726
trace._trace_file.flush()
1727
trace.pop_log_file(self._log_memento)
1729
def thisFailsStrictLockCheck(self):
1730
"""It is known that this test would fail with -Dstrict_locks.
1732
By default, all tests are run with strict lock checking unless
1733
-Edisable_lock_checks is supplied. However there are some tests which
1734
we know fail strict locks at this point that have not been fixed.
1735
They should call this function to disable the strict checking.
1737
This should be used sparingly, it is much better to fix the locking
1738
issues rather than papering over the problem by calling this function.
1740
debug.debug_flags.discard('strict_locks')
1742
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1743
"""Overrides an object attribute restoring it after the test.
1745
:note: This should be used with discretion; you should think about
1746
whether it's better to make the code testable without monkey-patching.
1748
:param obj: The object that will be mutated.
1750
:param attr_name: The attribute name we want to preserve/override in
1753
:param new: The optional value we want to set the attribute to.
1755
:returns: The actual attr value.
1757
value = getattr(obj, attr_name)
1758
# The actual value is captured by the call below
1759
self.addCleanup(setattr, obj, attr_name, value)
1760
if new is not _unitialized_attr:
1761
setattr(obj, attr_name, new)
1764
def overrideEnv(self, name, new):
1765
"""Set an environment variable, and reset it after the test.
1767
:param name: The environment variable name.
1769
:param new: The value to set the variable to. If None, the
1770
variable is deleted from the environment.
1772
:returns: The actual variable value.
1774
value = osutils.set_or_unset_env(name, new)
1775
self.addCleanup(osutils.set_or_unset_env, name, value)
1778
def recordCalls(self, obj, attr_name):
1779
"""Monkeypatch in a wrapper that will record calls.
1781
The monkeypatch is automatically removed when the test concludes.
1783
:param obj: The namespace holding the reference to be replaced;
1784
typically a module, class, or object.
1785
:param attr_name: A string for the name of the attribute to
1787
:returns: A list that will be extended with one item every time the
1788
function is called, with a tuple of (args, kwargs).
1792
def decorator(*args, **kwargs):
1793
calls.append((args, kwargs))
1794
return orig(*args, **kwargs)
1795
orig = self.overrideAttr(obj, attr_name, decorator)
1798
def _cleanEnvironment(self):
1799
for name, value in isolated_environ.iteritems():
1800
self.overrideEnv(name, value)
1802
def _restoreHooks(self):
1803
for klass, (name, hooks) in self._preserved_hooks.items():
1804
setattr(klass, name, hooks)
1805
self._preserved_hooks.clear()
1806
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1807
self._preserved_lazy_hooks.clear()
1809
def knownFailure(self, reason):
1810
"""Declare that this test fails for a known reason
1812
Tests that are known to fail should generally be using expectedFailure
1813
with an appropriate reverse assertion if a change could cause the test
1814
to start passing. Conversely if the test has no immediate prospect of
1815
succeeding then using skip is more suitable.
1817
When this method is called while an exception is being handled, that
1818
traceback will be used, otherwise a new exception will be thrown to
1819
provide one but won't be reported.
1821
self._add_reason(reason)
1823
exc_info = sys.exc_info()
1824
if exc_info != (None, None, None):
1825
self._report_traceback(exc_info)
1828
raise self.failureException(reason)
1829
except self.failureException:
1830
exc_info = sys.exc_info()
1831
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1832
raise testtools.testcase._ExpectedFailure(exc_info)
1836
def _suppress_log(self):
1837
"""Remove the log info from details."""
1838
self.discardDetail('log')
1840
def _do_skip(self, result, reason):
1841
self._suppress_log()
1842
addSkip = getattr(result, 'addSkip', None)
1843
if not callable(addSkip):
1844
result.addSuccess(result)
1846
addSkip(self, reason)
1849
def _do_known_failure(self, result, e):
1850
self._suppress_log()
1851
err = sys.exc_info()
1852
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1853
if addExpectedFailure is not None:
1854
addExpectedFailure(self, err)
1856
result.addSuccess(self)
1859
def _do_not_applicable(self, result, e):
1861
reason = 'No reason given'
1864
self._suppress_log ()
1865
addNotApplicable = getattr(result, 'addNotApplicable', None)
1866
if addNotApplicable is not None:
1867
result.addNotApplicable(self, reason)
1869
self._do_skip(result, reason)
1872
def _report_skip(self, result, err):
1873
"""Override the default _report_skip.
1875
We want to strip the 'log' detail. If we waint until _do_skip, it has
1876
already been formatted into the 'reason' string, and we can't pull it
1879
self._suppress_log()
1880
super(TestCase, self)._report_skip(self, result, err)
1883
def _report_expected_failure(self, result, err):
1886
See _report_skip for motivation.
1888
self._suppress_log()
1889
super(TestCase, self)._report_expected_failure(self, result, err)
1892
def _do_unsupported_or_skip(self, result, e):
1894
self._suppress_log()
1895
addNotSupported = getattr(result, 'addNotSupported', None)
1896
if addNotSupported is not None:
1897
result.addNotSupported(self, reason)
1899
self._do_skip(result, reason)
1901
def time(self, callable, *args, **kwargs):
1902
"""Run callable and accrue the time it takes to the benchmark time.
1904
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1905
this will cause lsprofile statistics to be gathered and stored in
1908
if self._benchtime is None:
1909
self.addDetail('benchtime', content.Content(content.ContentType(
1910
"text", "plain"), lambda:[str(self._benchtime)]))
1914
if not self._gather_lsprof_in_benchmarks:
1915
return callable(*args, **kwargs)
1917
# record this benchmark
1918
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1920
self._benchcalls.append(((callable, args, kwargs), stats))
1923
self._benchtime += time.time() - start
58
# this replaces the default testsweet.TestCase; we don't want logging changed
59
unittest.TestCase.setUp(self)
60
bzrlib.trace.disable_default_logging()
61
self._enable_file_logging()
64
def _enable_file_logging(self):
65
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
67
self._log_file = os.fdopen(fileno, 'w+')
69
hdlr = logging.StreamHandler(self._log_file)
70
hdlr.setLevel(logging.DEBUG)
71
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
72
logging.getLogger('').addHandler(hdlr)
73
logging.getLogger('').setLevel(logging.DEBUG)
75
debug('opened log file %s', name)
77
self._log_file_name = name
81
logging.getLogger('').removeHandler(self._log_hdlr)
82
bzrlib.trace.enable_default_logging()
83
logging.debug('%s teardown', self.id())
84
self._log_file.close()
85
unittest.TestCase.tearDown(self)
1925
88
def log(self, *args):
1929
"""Get a unicode string containing the log from bzrlib.trace.
1931
Undecodable characters are replaced.
1933
return u"".join(self.getDetails()['log'].iter_text())
1935
def requireFeature(self, feature):
1936
"""This test requires a specific feature is available.
1938
:raises UnavailableFeature: When feature is not available.
1940
if not feature.available():
1941
raise UnavailableFeature(feature)
1943
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1945
"""Run bazaar command line, splitting up a string command line."""
1946
if isinstance(args, basestring):
1947
# shlex don't understand unicode strings,
1948
# so args should be plain string (bialix 20070906)
1949
args = list(shlex.split(str(args)))
1950
return self._run_bzr_core(args, retcode=retcode,
1951
encoding=encoding, stdin=stdin, working_dir=working_dir,
1954
def _run_bzr_core(self, args, retcode, encoding, stdin,
1956
# Clear chk_map page cache, because the contents are likely to mask
1958
chk_map.clear_cache()
1959
if encoding is None:
1960
encoding = osutils.get_user_encoding()
1961
stdout = StringIOWrapper()
1962
stderr = StringIOWrapper()
1963
stdout.encoding = encoding
1964
stderr.encoding = encoding
1966
self.log('run bzr: %r', args)
1967
# FIXME: don't call into logging here
1968
handler = logging.StreamHandler(stderr)
1969
handler.setLevel(logging.INFO)
1970
logger = logging.getLogger('')
1971
logger.addHandler(handler)
1972
old_ui_factory = ui.ui_factory
1973
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1976
if working_dir is not None:
1977
cwd = osutils.getcwd()
1978
os.chdir(working_dir)
1982
result = self.apply_redirected(
1983
ui.ui_factory.stdin,
1985
_mod_commands.run_bzr_catch_user_errors,
1987
except KeyboardInterrupt:
1988
# Reraise KeyboardInterrupt with contents of redirected stdout
1989
# and stderr as arguments, for tests which are interested in
1990
# stdout and stderr and are expecting the exception.
1991
out = stdout.getvalue()
1992
err = stderr.getvalue()
1994
self.log('output:\n%r', out)
1996
self.log('errors:\n%r', err)
1997
raise KeyboardInterrupt(out, err)
1999
logger.removeHandler(handler)
2000
ui.ui_factory = old_ui_factory
2004
out = stdout.getvalue()
2005
err = stderr.getvalue()
2007
self.log('output:\n%r', out)
2009
self.log('errors:\n%r', err)
2010
if retcode is not None:
2011
self.assertEquals(retcode, result,
2012
message='Unexpected return code')
2013
return result, out, err
2015
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
2016
working_dir=None, error_regexes=[], output_encoding=None):
92
"""Return as a string the log for this test"""
93
return open(self._log_file_name).read()
95
def run_bzr(self, *args, **kwargs):
2017
96
"""Invoke bzr, as if it were run from the command line.
2019
The argument list should not include the bzr program name - the
2020
first argument is normally the bzr command. Arguments may be
2021
passed in three ways:
2023
1- A list of strings, eg ["commit", "a"]. This is recommended
2024
when the command contains whitespace or metacharacters, or
2025
is built up at run time.
2027
2- A single string, eg "add a". This is the most convenient
2028
for hardcoded commands.
2030
This runs bzr through the interface that catches and reports
2031
errors, and with logging set to something approximating the
2032
default, so that error reporting can be checked.
2034
98
This should be the main method for tests that want to exercise the
2035
99
overall behavior of the bzr application (rather than a unit test
2036
100
or a functional test of the library.)
2038
This sends the stdout/stderr results into the test's log,
2039
where it may be useful for debugging. See also run_captured.
2041
:keyword stdin: A string to be used as stdin for the command.
2042
:keyword retcode: The status code the command should return;
2044
:keyword working_dir: The directory to run the command in
2045
:keyword error_regexes: A list of expected error messages. If
2046
specified they must be seen in the error output of the command.
2048
retcode, out, err = self._run_bzr_autosplit(
2053
working_dir=working_dir,
2055
self.assertIsInstance(error_regexes, (list, tuple))
2056
for regex in error_regexes:
2057
self.assertContainsRe(err, regex)
2060
def run_bzr_error(self, error_regexes, *args, **kwargs):
2061
"""Run bzr, and check that stderr contains the supplied regexes
2063
:param error_regexes: Sequence of regular expressions which
2064
must each be found in the error output. The relative ordering
2066
:param args: command-line arguments for bzr
2067
:param kwargs: Keyword arguments which are interpreted by run_bzr
2068
This function changes the default value of retcode to be 3,
2069
since in most cases this is run when you expect bzr to fail.
2071
:return: (out, err) The actual output of running the command (in case
2072
you want to do more inspection)
2076
# Make sure that commit is failing because there is nothing to do
2077
self.run_bzr_error(['no changes to commit'],
2078
['commit', '-m', 'my commit comment'])
2079
# Make sure --strict is handling an unknown file, rather than
2080
# giving us the 'nothing to do' error
2081
self.build_tree(['unknown'])
2082
self.run_bzr_error(['Commit refused because there are unknown files'],
2083
['commit', --strict', '-m', 'my commit comment'])
2085
kwargs.setdefault('retcode', 3)
2086
kwargs['error_regexes'] = error_regexes
2087
out, err = self.run_bzr(*args, **kwargs)
2090
def run_bzr_subprocess(self, *args, **kwargs):
2091
"""Run bzr in a subprocess for testing.
2093
This starts a new Python interpreter and runs bzr in there.
2094
This should only be used for tests that have a justifiable need for
2095
this isolation: e.g. they are testing startup time, or signal
2096
handling, or early startup code, etc. Subprocess code can't be
2097
profiled or debugged so easily.
2099
:keyword retcode: The status code that is expected. Defaults to 0. If
2100
None is supplied, the status code is not checked.
2101
:keyword env_changes: A dictionary which lists changes to environment
2102
variables. A value of None will unset the env variable.
2103
The values must be strings. The change will only occur in the
2104
child, so you don't need to fix the environment after running.
2105
:keyword universal_newlines: Convert CRLF => LF
2106
:keyword allow_plugins: By default the subprocess is run with
2107
--no-plugins to ensure test reproducibility. Also, it is possible
2108
for system-wide plugins to create unexpected output on stderr,
2109
which can cause unnecessary test failures.
2111
env_changes = kwargs.get('env_changes', {})
2112
working_dir = kwargs.get('working_dir', None)
2113
allow_plugins = kwargs.get('allow_plugins', False)
2115
if isinstance(args[0], list):
2117
elif isinstance(args[0], basestring):
2118
args = list(shlex.split(args[0]))
2120
raise ValueError("passing varargs to run_bzr_subprocess")
2121
process = self.start_bzr_subprocess(args, env_changes=env_changes,
2122
working_dir=working_dir,
2123
allow_plugins=allow_plugins)
2124
# We distinguish between retcode=None and retcode not passed.
2125
supplied_retcode = kwargs.get('retcode', 0)
2126
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
2127
universal_newlines=kwargs.get('universal_newlines', False),
2130
def start_bzr_subprocess(self, process_args, env_changes=None,
2131
skip_if_plan_to_signal=False,
2133
allow_plugins=False, stderr=subprocess.PIPE):
2134
"""Start bzr in a subprocess for testing.
2136
This starts a new Python interpreter and runs bzr in there.
2137
This should only be used for tests that have a justifiable need for
2138
this isolation: e.g. they are testing startup time, or signal
2139
handling, or early startup code, etc. Subprocess code can't be
2140
profiled or debugged so easily.
2142
:param process_args: a list of arguments to pass to the bzr executable,
2143
for example ``['--version']``.
2144
:param env_changes: A dictionary which lists changes to environment
2145
variables. A value of None will unset the env variable.
2146
The values must be strings. The change will only occur in the
2147
child, so you don't need to fix the environment after running.
2148
:param skip_if_plan_to_signal: raise TestSkipped when true and system
2149
doesn't support signalling subprocesses.
2150
:param allow_plugins: If False (default) pass --no-plugins to bzr.
2151
:param stderr: file to use for the subprocess's stderr. Valid values
2152
are those valid for the stderr argument of `subprocess.Popen`.
2153
Default value is ``subprocess.PIPE``.
2155
:returns: Popen object for the started process.
2157
if skip_if_plan_to_signal:
2158
if os.name != "posix":
2159
raise TestSkipped("Sending signals not supported")
2161
if env_changes is None:
2165
def cleanup_environment():
2166
for env_var, value in env_changes.iteritems():
2167
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
2169
def restore_environment():
2170
for env_var, value in old_env.iteritems():
2171
osutils.set_or_unset_env(env_var, value)
2173
bzr_path = self.get_bzr_path()
2176
if working_dir is not None:
2177
cwd = osutils.getcwd()
2178
os.chdir(working_dir)
2181
# win32 subprocess doesn't support preexec_fn
2182
# so we will avoid using it on all platforms, just to
2183
# make sure the code path is used, and we don't break on win32
2184
cleanup_environment()
2185
# Include the subprocess's log file in the test details, in case
2186
# the test fails due to an error in the subprocess.
2187
self._add_subprocess_log(trace._get_bzr_log_filename())
2188
command = [sys.executable]
2189
# frozen executables don't need the path to bzr
2190
if getattr(sys, "frozen", None) is None:
2191
command.append(bzr_path)
2192
if not allow_plugins:
2193
command.append('--no-plugins')
2194
command.extend(process_args)
2195
process = self._popen(command, stdin=subprocess.PIPE,
2196
stdout=subprocess.PIPE,
2199
restore_environment()
2205
def _add_subprocess_log(self, log_file_path):
2206
if len(self._log_files) == 0:
2207
# Register an addCleanup func. We do this on the first call to
2208
# _add_subprocess_log rather than in TestCase.setUp so that this
2209
# addCleanup is registered after any cleanups for tempdirs that
2210
# subclasses might create, which will probably remove the log file
2212
self.addCleanup(self._subprocess_log_cleanup)
2213
# self._log_files is a set, so if a log file is reused we won't grab it
2215
self._log_files.add(log_file_path)
2217
def _subprocess_log_cleanup(self):
2218
for count, log_file_path in enumerate(self._log_files):
2219
# We use buffer_now=True to avoid holding the file open beyond
2220
# the life of this function, which might interfere with e.g.
2221
# cleaning tempdirs on Windows.
2222
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
2223
#detail_content = content.content_from_file(
2224
# log_file_path, buffer_now=True)
2225
with open(log_file_path, 'rb') as log_file:
2226
log_file_bytes = log_file.read()
2227
detail_content = content.Content(content.ContentType("text",
2228
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
2229
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
2232
def _popen(self, *args, **kwargs):
2233
"""Place a call to Popen.
2235
Allows tests to override this method to intercept the calls made to
2236
Popen for introspection.
2238
return subprocess.Popen(*args, **kwargs)
2240
def get_source_path(self):
2241
"""Return the path of the directory containing bzrlib."""
2242
return os.path.dirname(os.path.dirname(bzrlib.__file__))
2244
def get_bzr_path(self):
2245
"""Return the path of the 'bzr' executable for this test suite."""
2246
bzr_path = os.path.join(self.get_source_path(), "bzr")
2247
if not os.path.isfile(bzr_path):
2248
# We are probably installed. Assume sys.argv is the right file
2249
bzr_path = sys.argv[0]
2252
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
2253
universal_newlines=False, process_args=None):
2254
"""Finish the execution of process.
2256
:param process: the Popen object returned from start_bzr_subprocess.
2257
:param retcode: The status code that is expected. Defaults to 0. If
2258
None is supplied, the status code is not checked.
2259
:param send_signal: an optional signal to send to the process.
2260
:param universal_newlines: Convert CRLF => LF
2261
:returns: (stdout, stderr)
2263
if send_signal is not None:
2264
os.kill(process.pid, send_signal)
2265
out, err = process.communicate()
2267
if universal_newlines:
2268
out = out.replace('\r\n', '\n')
2269
err = err.replace('\r\n', '\n')
2271
if retcode is not None and retcode != process.returncode:
2272
if process_args is None:
2273
process_args = "(unknown args)"
2274
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2275
trace.mutter('Error for bzr %s:\n%s', process_args, err)
2276
self.fail('Command bzr %s failed with retcode %s != %s'
2277
% (process_args, retcode, process.returncode))
2280
def check_tree_shape(self, tree, shape):
2281
"""Compare a tree to a list of expected names.
102
Much of the old code runs bzr by forking a new copy of Python, but
103
that is slower, harder to debug, and generally not necessary.
105
retcode = kwargs.get('retcode', 0)
106
result = self.apply_redirected(None, None, None,
107
bzrlib.commands.run_bzr, args)
108
self.assertEquals(result, retcode)
111
def check_inventory_shape(self, inv, shape):
113
Compare an inventory to a list of expected names.
2283
115
Fail if they are not precisely equal.
2286
118
shape = list(shape) # copy
2287
for path, ie in tree.iter_entries_by_dir():
119
for path, ie in inv.entries():
2288
120
name = path.replace('\\', '/')
2289
if ie.kind == 'directory':
2290
122
name = name + '/'
2292
pass # ignore root entry
2294
124
shape.remove(name)
2296
126
extras.append(name)
2762
170
All test cases create their own directory within that. If the
2763
171
tests complete successfully, the directory is removed.
2765
:ivar test_base_dir: The path of the top-level directory for this
2766
test, which contains a home directory and a work directory.
2768
:ivar test_home_dir: An initially empty directory under test_base_dir
2769
which is used as $HOME for this test.
2771
:ivar test_dir: A directory under test_base_dir used as the current
2772
directory when the test proper is run.
173
InTempDir is an old alias for FunctionalTestCase.
2775
178
OVERRIDE_PYTHON = 'python'
2778
super(TestCaseInTempDir, self).setUp()
2779
# Remove the protection set in isolated_environ, we have a proper
2780
# access to disk resources now.
2781
self.overrideEnv('BZR_LOG', None)
2783
180
def check_file_contents(self, filename, expect):
2784
181
self.log("check contents of file %s" % filename)
182
contents = file(filename, 'r').read()
2790
183
if contents != expect:
2791
184
self.log("expected: %r" % expect)
2792
185
self.log("actually: %r" % contents)
2793
self.fail("contents of %s not as expected" % filename)
2795
def _getTestDirPrefix(self):
2796
# create a directory within the top level test directory
2797
if sys.platform in ('win32', 'cygwin'):
2798
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2799
# windows is likely to have path-length limits so use a short name
2800
name_prefix = name_prefix[-30:]
2802
name_prefix = re.sub('[/]', '_', self.id())
2805
def makeAndChdirToTestDir(self):
2806
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2808
For TestCaseInTempDir we create a temporary directory based on the test
2809
name and then create two subdirs - test and home under it.
2811
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2812
self._getTestDirPrefix())
2814
for i in range(100):
2815
if os.path.exists(name):
2816
name = name_prefix + '_' + str(i)
2818
# now create test and home directories within this dir
2819
self.test_base_dir = name
2820
self.addCleanup(self.deleteTestDir)
2821
os.mkdir(self.test_base_dir)
2823
self.permit_dir(self.test_base_dir)
2824
# 'sprouting' and 'init' of a branch both walk up the tree to find
2825
# stacking policy to honour; create a bzr dir with an unshared
2826
# repository (but not a branch - our code would be trying to escape
2827
# then!) to stop them, and permit it to be read.
2828
# control = bzrdir.BzrDir.create(self.test_base_dir)
2829
# control.create_repository()
2830
self.test_home_dir = self.test_base_dir + '/home'
2831
os.mkdir(self.test_home_dir)
2832
self.test_dir = self.test_base_dir + '/work'
186
self.fail("contents of %s not as expected")
188
def _make_test_root(self):
189
if TestCaseInTempDir.TEST_ROOT is not None:
193
root = 'test%04d.tmp' % i
197
if e.errno == errno.EEXIST:
202
# successfully created
203
TestCaseInTempDir.TEST_ROOT = os.path.abspath(root)
205
# make a fake bzr directory there to prevent any tests propagating
206
# up onto the source directory's real branch
207
os.mkdir(os.path.join(TestCaseInTempDir.TEST_ROOT, '.bzr'))
210
super(TestCaseInTempDir, self).setUp()
212
self._make_test_root()
213
self._currentdir = os.getcwdu()
214
short_id = self.id().replace('bzrlib.selftest.', '') \
215
.replace('__main__.', '')
216
self.test_dir = os.path.join(self.TEST_ROOT, short_id)
2833
217
os.mkdir(self.test_dir)
2834
218
os.chdir(self.test_dir)
2835
# put name of test inside
2836
f = file(self.test_base_dir + '/name', 'w')
2842
def deleteTestDir(self):
2843
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2844
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2846
def build_tree(self, shape, line_endings='binary', transport=None):
222
os.chdir(self._currentdir)
223
super(TestCaseInTempDir, self).tearDown()
225
def _formcmd(self, cmd):
226
if isinstance(cmd, basestring):
229
cmd[0] = self.BZRPATH
230
if self.OVERRIDE_PYTHON:
231
cmd.insert(0, self.OVERRIDE_PYTHON)
232
self.log('$ %r' % cmd)
235
def runcmd(self, cmd, retcode=0):
236
"""Run one command and check the return code.
238
Returns a tuple of (stdout,stderr) strings.
240
If a single string is based, it is split into words.
241
For commands that are not simple space-separated words, please
242
pass a list instead."""
243
cmd = self._formcmd(cmd)
244
self.log('$ ' + ' '.join(cmd))
245
actual_retcode = subprocess.call(cmd, stdout=self._log_file,
246
stderr=self._log_file)
247
if retcode != actual_retcode:
248
raise CommandFailed("test failed: %r returned %d, expected %d"
249
% (cmd, actual_retcode, retcode))
251
def backtick(self, cmd, retcode=0):
252
"""Run a command and return its output"""
253
cmd = self._formcmd(cmd)
254
child = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=self._log_file)
255
outd, errd = child.communicate()
257
actual_retcode = child.wait()
259
outd = outd.replace('\r', '')
261
if retcode != actual_retcode:
262
raise CommandFailed("test failed: %r returned %d, expected %d"
263
% (cmd, actual_retcode, retcode))
269
def build_tree(self, shape):
2847
270
"""Build a test tree according to a pattern.
2849
272
shape is a sequence of file specifications. If the final
2850
273
character is '/', a directory is created.
2852
This assumes that all the elements in the tree being built are new.
2854
275
This doesn't add anything to a branch.
2856
:type shape: list or tuple.
2857
:param line_endings: Either 'binary' or 'native'
2858
in binary mode, exact contents are written in native mode, the
2859
line endings match the default platform endings.
2860
:param transport: A transport to write to, for building trees on VFS's.
2861
If the transport is readonly or None, "." is opened automatically.
2864
if type(shape) not in (list, tuple):
2865
raise AssertionError("Parameter 'shape' should be "
2866
"a list or a tuple. Got %r instead" % (shape,))
2867
# It's OK to just create them using forward slashes on windows.
2868
if transport is None or transport.is_readonly():
2869
transport = _mod_transport.get_transport_from_path(".")
277
# XXX: It's OK to just create them using forward slashes on windows?
2870
279
for name in shape:
2871
self.assertIsInstance(name, basestring)
280
assert isinstance(name, basestring)
2872
281
if name[-1] == '/':
2873
transport.mkdir(urlutils.escape(name[:-1]))
2875
if line_endings == 'binary':
2877
elif line_endings == 'native':
2880
raise errors.BzrError(
2881
'Invalid line ending request %r' % line_endings)
2882
content = "contents of %s%s" % (name.encode('utf-8'), end)
2883
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2885
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2887
def assertInWorkingTree(self, path, root_path='.', tree=None):
2888
"""Assert whether path or paths are in the WorkingTree"""
2890
tree = workingtree.WorkingTree.open(root_path)
2891
if not isinstance(path, basestring):
2893
self.assertInWorkingTree(p, tree=tree)
2895
self.assertIsNot(tree.path2id(path), None,
2896
path+' not in working tree.')
2898
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2899
"""Assert whether path or paths are not in the WorkingTree"""
2901
tree = workingtree.WorkingTree.open(root_path)
2902
if not isinstance(path, basestring):
2904
self.assertNotInWorkingTree(p,tree=tree)
2906
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2909
class TestCaseWithTransport(TestCaseInTempDir):
2910
"""A test case that provides get_url and get_readonly_url facilities.
2912
These back onto two transport servers, one for readonly access and one for
2915
If no explicit class is provided for readonly access, a
2916
ReadonlyTransportDecorator is used instead which allows the use of non disk
2917
based read write transports.
2919
If an explicit class is provided for readonly access, that server and the
2920
readwrite one must both define get_url() as resolving to os.getcwd().
2923
def get_vfs_only_server(self):
2924
"""See TestCaseWithMemoryTransport.
2926
This is useful for some tests with specific servers that need
2929
if self.__vfs_server is None:
2930
self.__vfs_server = self.vfs_transport_factory()
2931
self.start_server(self.__vfs_server)
2932
return self.__vfs_server
2934
def make_branch_and_tree(self, relpath, format=None):
2935
"""Create a branch on the transport and a tree locally.
2937
If the transport is not a LocalTransport, the Tree can't be created on
2938
the transport. In that case if the vfs_transport_factory is
2939
LocalURLServer the working tree is created in the local
2940
directory backing the transport, and the returned tree's branch and
2941
repository will also be accessed locally. Otherwise a lightweight
2942
checkout is created and returned.
2944
We do this because we can't physically create a tree in the local
2945
path, with a branch reference to the transport_factory url, and
2946
a branch + repository in the vfs_transport, unless the vfs_transport
2947
namespace is distinct from the local disk - the two branch objects
2948
would collide. While we could construct a tree with its branch object
2949
pointing at the transport_factory transport in memory, reopening it
2950
would behaving unexpectedly, and has in the past caused testing bugs
2951
when we tried to do it that way.
2953
:param format: The BzrDirFormat.
2954
:returns: the WorkingTree.
2956
# TODO: always use the local disk path for the working tree,
2957
# this obviously requires a format that supports branch references
2958
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2960
b = self.make_branch(relpath, format=format)
2962
return b.bzrdir.create_workingtree()
2963
except errors.NotLocalUrl:
2964
# We can only make working trees locally at the moment. If the
2965
# transport can't support them, then we keep the non-disk-backed
2966
# branch and create a local checkout.
2967
if self.vfs_transport_factory is test_server.LocalURLServer:
2968
# the branch is colocated on disk, we cannot create a checkout.
2969
# hopefully callers will expect this.
2970
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2971
wt = local_controldir.create_workingtree()
2972
if wt.branch._format != b._format:
2974
# Make sure that assigning to wt._branch fixes wt.branch,
2975
# in case the implementation details of workingtree objects
2977
self.assertIs(b, wt.branch)
2980
return b.create_checkout(relpath, lightweight=True)
2982
def assertIsDirectory(self, relpath, transport):
2983
"""Assert that relpath within transport is a directory.
2985
This may not be possible on all transports; in that case it propagates
2986
a TransportNotPossible.
2989
mode = transport.stat(relpath).st_mode
2990
except errors.NoSuchFile:
2991
self.fail("path %s is not a directory; no such file"
2993
if not stat.S_ISDIR(mode):
2994
self.fail("path %s is not a directory; has mode %#o"
2997
def assertTreesEqual(self, left, right):
2998
"""Check that left and right have the same content and properties."""
2999
# we use a tree delta to check for equality of the content, and we
3000
# manually check for equality of other things such as the parents list.
3001
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
3002
differences = left.changes_from(right)
3003
self.assertFalse(differences.has_changed(),
3004
"Trees %r and %r are different: %r" % (left, right, differences))
3007
super(TestCaseWithTransport, self).setUp()
3008
self.__vfs_server = None
3010
def disable_missing_extensions_warning(self):
3011
"""Some tests expect a precise stderr content.
3013
There is no point in forcing them to duplicate the extension related
3016
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
3019
class ChrootedTestCase(TestCaseWithTransport):
3020
"""A support class that provides readonly urls outside the local namespace.
3022
This is done by checking if self.transport_server is a MemoryServer. if it
3023
is then we are chrooted already, if it is not then an HttpServer is used
3026
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
3027
be used without needed to redo it when a different
3028
subclass is in use ?
3032
from bzrlib.tests import http_server
3033
super(ChrootedTestCase, self).setUp()
3034
if not self.vfs_transport_factory == memory.MemoryServer:
3035
self.transport_readonly_server = http_server.HttpServer
3038
def condition_id_re(pattern):
3039
"""Create a condition filter which performs a re check on a test's id.
3041
:param pattern: A regular expression string.
3042
:return: A callable that returns True if the re matches.
3044
filter_re = re.compile(pattern, 0)
3045
def condition(test):
3047
return filter_re.search(test_id)
3051
def condition_isinstance(klass_or_klass_list):
3052
"""Create a condition filter which returns isinstance(param, klass).
3054
:return: A callable which when called with one parameter obj return the
3055
result of isinstance(obj, klass_or_klass_list).
3058
return isinstance(obj, klass_or_klass_list)
3062
def condition_id_in_list(id_list):
3063
"""Create a condition filter which verify that test's id in a list.
3065
:param id_list: A TestIdList object.
3066
:return: A callable that returns True if the test's id appears in the list.
3068
def condition(test):
3069
return id_list.includes(test.id())
3073
def condition_id_startswith(starts):
3074
"""Create a condition filter verifying that test's id starts with a string.
3076
:param starts: A list of string.
3077
:return: A callable that returns True if the test's id starts with one of
3080
def condition(test):
3081
for start in starts:
3082
if test.id().startswith(start):
3088
def exclude_tests_by_condition(suite, condition):
3089
"""Create a test suite which excludes some tests from suite.
3091
:param suite: The suite to get tests from.
3092
:param condition: A callable whose result evaluates True when called with a
3093
test case which should be excluded from the result.
3094
:return: A suite which contains the tests found in suite that fail
3098
for test in iter_suite_tests(suite):
3099
if not condition(test):
3101
return TestUtil.TestSuite(result)
3104
def filter_suite_by_condition(suite, condition):
3105
"""Create a test suite by filtering another one.
3107
:param suite: The source suite.
3108
:param condition: A callable whose result evaluates True when called with a
3109
test case which should be included in the result.
3110
:return: A suite which contains the tests found in suite that pass
3114
for test in iter_suite_tests(suite):
3117
return TestUtil.TestSuite(result)
3120
def filter_suite_by_re(suite, pattern):
3121
"""Create a test suite by filtering another one.
3123
:param suite: the source suite
3124
:param pattern: pattern that names must match
3125
:returns: the newly created suite
3127
condition = condition_id_re(pattern)
3128
result_suite = filter_suite_by_condition(suite, condition)
3132
def filter_suite_by_id_list(suite, test_id_list):
3133
"""Create a test suite by filtering another one.
3135
:param suite: The source suite.
3136
:param test_id_list: A list of the test ids to keep as strings.
3137
:returns: the newly created suite
3139
condition = condition_id_in_list(test_id_list)
3140
result_suite = filter_suite_by_condition(suite, condition)
3144
def filter_suite_by_id_startswith(suite, start):
3145
"""Create a test suite by filtering another one.
3147
:param suite: The source suite.
3148
:param start: A list of string the test id must start with one of.
3149
:returns: the newly created suite
3151
condition = condition_id_startswith(start)
3152
result_suite = filter_suite_by_condition(suite, condition)
3156
def exclude_tests_by_re(suite, pattern):
3157
"""Create a test suite which excludes some tests from suite.
3159
:param suite: The suite to get tests from.
3160
:param pattern: A regular expression string. Test ids that match this
3161
pattern will be excluded from the result.
3162
:return: A TestSuite that contains all the tests from suite without the
3163
tests that matched pattern. The order of tests is the same as it was in
3166
return exclude_tests_by_condition(suite, condition_id_re(pattern))
3169
def preserve_input(something):
3170
"""A helper for performing test suite transformation chains.
3172
:param something: Anything you want to preserve.
3178
def randomize_suite(suite):
3179
"""Return a new TestSuite with suite's tests in random order.
3181
The tests in the input suite are flattened into a single suite in order to
3182
accomplish this. Any nested TestSuites are removed to provide global
3185
tests = list(iter_suite_tests(suite))
3186
random.shuffle(tests)
3187
return TestUtil.TestSuite(tests)
3190
def split_suite_by_condition(suite, condition):
3191
"""Split a test suite into two by a condition.
3193
:param suite: The suite to split.
3194
:param condition: The condition to match on. Tests that match this
3195
condition are returned in the first test suite, ones that do not match
3196
are in the second suite.
3197
:return: A tuple of two test suites, where the first contains tests from
3198
suite matching the condition, and the second contains the remainder
3199
from suite. The order within each output suite is the same as it was in
3204
for test in iter_suite_tests(suite):
3206
matched.append(test)
3208
did_not_match.append(test)
3209
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
3212
def split_suite_by_re(suite, pattern):
3213
"""Split a test suite into two by a regular expression.
3215
:param suite: The suite to split.
3216
:param pattern: A regular expression string. Test ids that match this
3217
pattern will be in the first test suite returned, and the others in the
3218
second test suite returned.
3219
:return: A tuple of two test suites, where the first contains tests from
3220
suite matching pattern, and the second contains the remainder from
3221
suite. The order within each output suite is the same as it was in
3224
return split_suite_by_condition(suite, condition_id_re(pattern))
3227
def run_suite(suite, name='test', verbose=False, pattern=".*",
3228
stop_on_failure=False,
3229
transport=None, lsprof_timed=None, bench_history=None,
3230
matching_tests_first=None,
3233
exclude_pattern=None,
3236
suite_decorators=None,
3238
result_decorators=None,
3240
"""Run a test suite for bzr selftest.
3242
:param runner_class: The class of runner to use. Must support the
3243
constructor arguments passed by run_suite which are more than standard
3245
:return: A boolean indicating success.
3247
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
3252
if runner_class is None:
3253
runner_class = TextTestRunner
3256
runner = runner_class(stream=stream,
3258
verbosity=verbosity,
3259
bench_history=bench_history,
3261
result_decorators=result_decorators,
3263
runner.stop_on_failure=stop_on_failure
3264
# built in decorator factories:
3266
random_order(random_seed, runner),
3267
exclude_tests(exclude_pattern),
3269
if matching_tests_first:
3270
decorators.append(tests_first(pattern))
3272
decorators.append(filter_tests(pattern))
3273
if suite_decorators:
3274
decorators.extend(suite_decorators)
3275
# tell the result object how many tests will be running: (except if
3276
# --parallel=fork is being used. Robert said he will provide a better
3277
# progress design later -- vila 20090817)
3278
if fork_decorator not in decorators:
3279
decorators.append(CountingDecorator)
3280
for decorator in decorators:
3281
suite = decorator(suite)
3283
# Done after test suite decoration to allow randomisation etc
3284
# to take effect, though that is of marginal benefit.
3286
stream.write("Listing tests only ...\n")
3287
for t in iter_suite_tests(suite):
3288
stream.write("%s\n" % (t.id()))
3290
result = runner.run(suite)
3292
return result.wasStrictlySuccessful()
3294
return result.wasSuccessful()
3297
# A registry where get() returns a suite decorator.
3298
parallel_registry = registry.Registry()
3301
def fork_decorator(suite):
3302
if getattr(os, "fork", None) is None:
3303
raise errors.BzrCommandError("platform does not support fork,"
3304
" try --parallel=subprocess instead.")
3305
concurrency = osutils.local_concurrency()
3306
if concurrency == 1:
3308
from testtools import ConcurrentTestSuite
3309
return ConcurrentTestSuite(suite, fork_for_tests)
3310
parallel_registry.register('fork', fork_decorator)
3313
def subprocess_decorator(suite):
3314
concurrency = osutils.local_concurrency()
3315
if concurrency == 1:
3317
from testtools import ConcurrentTestSuite
3318
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3319
parallel_registry.register('subprocess', subprocess_decorator)
3322
def exclude_tests(exclude_pattern):
3323
"""Return a test suite decorator that excludes tests."""
3324
if exclude_pattern is None:
3325
return identity_decorator
3326
def decorator(suite):
3327
return ExcludeDecorator(suite, exclude_pattern)
3331
def filter_tests(pattern):
3333
return identity_decorator
3334
def decorator(suite):
3335
return FilterTestsDecorator(suite, pattern)
3339
def random_order(random_seed, runner):
3340
"""Return a test suite decorator factory for randomising tests order.
3342
:param random_seed: now, a string which casts to a long, or a long.
3343
:param runner: A test runner with a stream attribute to report on.
3345
if random_seed is None:
3346
return identity_decorator
3347
def decorator(suite):
3348
return RandomDecorator(suite, random_seed, runner.stream)
3352
def tests_first(pattern):
3354
return identity_decorator
3355
def decorator(suite):
3356
return TestFirstDecorator(suite, pattern)
3360
def identity_decorator(suite):
3365
class TestDecorator(TestUtil.TestSuite):
3366
"""A decorator for TestCase/TestSuite objects.
3368
Usually, subclasses should override __iter__(used when flattening test
3369
suites), which we do to filter, reorder, parallelise and so on, run() and
3373
def __init__(self, suite):
3374
TestUtil.TestSuite.__init__(self)
3377
def countTestCases(self):
3380
cases += test.countTestCases()
3387
def run(self, result):
3388
# Use iteration on self, not self._tests, to allow subclasses to hook
3391
if result.shouldStop:
3397
class CountingDecorator(TestDecorator):
3398
"""A decorator which calls result.progress(self.countTestCases)."""
3400
def run(self, result):
3401
progress_method = getattr(result, 'progress', None)
3402
if callable(progress_method):
3403
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3404
return super(CountingDecorator, self).run(result)
3407
class ExcludeDecorator(TestDecorator):
3408
"""A decorator which excludes test matching an exclude pattern."""
3410
def __init__(self, suite, exclude_pattern):
3411
TestDecorator.__init__(self, suite)
3412
self.exclude_pattern = exclude_pattern
3413
self.excluded = False
3417
return iter(self._tests)
3418
self.excluded = True
3419
suite = exclude_tests_by_re(self, self.exclude_pattern)
3421
self.addTests(suite)
3422
return iter(self._tests)
3425
class FilterTestsDecorator(TestDecorator):
3426
"""A decorator which filters tests to those matching a pattern."""
3428
def __init__(self, suite, pattern):
3429
TestDecorator.__init__(self, suite)
3430
self.pattern = pattern
3431
self.filtered = False
3435
return iter(self._tests)
3436
self.filtered = True
3437
suite = filter_suite_by_re(self, self.pattern)
3439
self.addTests(suite)
3440
return iter(self._tests)
3443
class RandomDecorator(TestDecorator):
3444
"""A decorator which randomises the order of its tests."""
3446
def __init__(self, suite, random_seed, stream):
3447
TestDecorator.__init__(self, suite)
3448
self.random_seed = random_seed
3449
self.randomised = False
3450
self.stream = stream
3454
return iter(self._tests)
3455
self.randomised = True
3456
self.stream.write("Randomizing test order using seed %s\n\n" %
3457
(self.actual_seed()))
3458
# Initialise the random number generator.
3459
random.seed(self.actual_seed())
3460
suite = randomize_suite(self)
3462
self.addTests(suite)
3463
return iter(self._tests)
3465
def actual_seed(self):
3466
if self.random_seed == "now":
3467
# We convert the seed to a long to make it reuseable across
3468
# invocations (because the user can reenter it).
3469
self.random_seed = long(time.time())
3471
# Convert the seed to a long if we can
3473
self.random_seed = long(self.random_seed)
3476
return self.random_seed
3479
class TestFirstDecorator(TestDecorator):
3480
"""A decorator which moves named tests to the front."""
3482
def __init__(self, suite, pattern):
3483
TestDecorator.__init__(self, suite)
3484
self.pattern = pattern
3485
self.filtered = False
3489
return iter(self._tests)
3490
self.filtered = True
3491
suites = split_suite_by_re(self, self.pattern)
3493
self.addTests(suites)
3494
return iter(self._tests)
3497
def partition_tests(suite, count):
3498
"""Partition suite into count lists of tests."""
3499
# This just assigns tests in a round-robin fashion. On one hand this
3500
# splits up blocks of related tests that might run faster if they shared
3501
# resources, but on the other it avoids assigning blocks of slow tests to
3502
# just one partition. So the slowest partition shouldn't be much slower
3504
partitions = [list() for i in range(count)]
3505
tests = iter_suite_tests(suite)
3506
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3507
partition.append(test)
3511
def workaround_zealous_crypto_random():
3512
"""Crypto.Random want to help us being secure, but we don't care here.
3514
This workaround some test failure related to the sftp server. Once paramiko
3515
stop using the controversial API in Crypto.Random, we may get rid of it.
3518
from Crypto.Random import atfork
3524
def fork_for_tests(suite):
3525
"""Take suite and start up one runner per CPU by forking()
3527
:return: An iterable of TestCase-like objects which can each have
3528
run(result) called on them to feed tests to result.
3530
concurrency = osutils.local_concurrency()
3532
from subunit import TestProtocolClient, ProtocolTestCase
3533
from subunit.test_results import AutoTimingTestResultDecorator
3534
class TestInOtherProcess(ProtocolTestCase):
3535
# Should be in subunit, I think. RBC.
3536
def __init__(self, stream, pid):
3537
ProtocolTestCase.__init__(self, stream)
3540
def run(self, result):
3542
ProtocolTestCase.run(self, result)
3544
os.waitpid(self.pid, 0)
3546
test_blocks = partition_tests(suite, concurrency)
3547
for process_tests in test_blocks:
3548
process_suite = TestUtil.TestSuite()
3549
process_suite.addTests(process_tests)
3550
c2pread, c2pwrite = os.pipe()
3553
workaround_zealous_crypto_random()
3556
# Leave stderr and stdout open so we can see test noise
3557
# Close stdin so that the child goes away if it decides to
3558
# read from stdin (otherwise its a roulette to see what
3559
# child actually gets keystrokes for pdb etc).
3562
stream = os.fdopen(c2pwrite, 'wb', 1)
3563
subunit_result = AutoTimingTestResultDecorator(
3564
TestProtocolClient(stream))
3565
process_suite.run(subunit_result)
3570
stream = os.fdopen(c2pread, 'rb', 1)
3571
test = TestInOtherProcess(stream, pid)
3576
def reinvoke_for_tests(suite):
3577
"""Take suite and start up one runner per CPU using subprocess().
3579
:return: An iterable of TestCase-like objects which can each have
3580
run(result) called on them to feed tests to result.
3582
concurrency = osutils.local_concurrency()
3584
from subunit import ProtocolTestCase
3585
class TestInSubprocess(ProtocolTestCase):
3586
def __init__(self, process, name):
3587
ProtocolTestCase.__init__(self, process.stdout)
3588
self.process = process
3589
self.process.stdin.close()
3592
def run(self, result):
3594
ProtocolTestCase.run(self, result)
3597
os.unlink(self.name)
3598
# print "pid %d finished" % finished_process
3599
test_blocks = partition_tests(suite, concurrency)
3600
for process_tests in test_blocks:
3601
# ugly; currently reimplement rather than reuses TestCase methods.
3602
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3603
if not os.path.isfile(bzr_path):
3604
# We are probably installed. Assume sys.argv is the right file
3605
bzr_path = sys.argv[0]
3606
bzr_path = [bzr_path]
3607
if sys.platform == "win32":
3608
# if we're on windows, we can't execute the bzr script directly
3609
bzr_path = [sys.executable] + bzr_path
3610
fd, test_list_file_name = tempfile.mkstemp()
3611
test_list_file = os.fdopen(fd, 'wb', 1)
3612
for test in process_tests:
3613
test_list_file.write(test.id() + '\n')
3614
test_list_file.close()
3616
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3618
if '--no-plugins' in sys.argv:
3619
argv.append('--no-plugins')
3620
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3621
# noise on stderr it can interrupt the subunit protocol.
3622
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3623
stdout=subprocess.PIPE,
3624
stderr=subprocess.PIPE,
3626
test = TestInSubprocess(process, test_list_file_name)
3629
os.unlink(test_list_file_name)
3634
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3635
"""Generate profiling data for all activity between start and success.
3637
The profile data is appended to the test's _benchcalls attribute and can
3638
be accessed by the forwarded-to TestResult.
3640
While it might be cleaner do accumulate this in stopTest, addSuccess is
3641
where our existing output support for lsprof is, and this class aims to
3642
fit in with that: while it could be moved it's not necessary to accomplish
3643
test profiling, nor would it be dramatically cleaner.
3646
def startTest(self, test):
3647
self.profiler = bzrlib.lsprof.BzrProfiler()
3648
# Prevent deadlocks in tests that use lsprof: those tests will
3650
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3651
self.profiler.start()
3652
testtools.ExtendedToOriginalDecorator.startTest(self, test)
3654
def addSuccess(self, test):
3655
stats = self.profiler.stop()
3657
calls = test._benchcalls
3658
except AttributeError:
3659
test._benchcalls = []
3660
calls = test._benchcalls
3661
calls.append(((test.id(), "", ""), stats))
3662
testtools.ExtendedToOriginalDecorator.addSuccess(self, test)
3664
def stopTest(self, test):
3665
testtools.ExtendedToOriginalDecorator.stopTest(self, test)
3666
self.profiler = None
3669
# Controlled by "bzr selftest -E=..." option
3670
# Currently supported:
3671
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3672
# preserves any flags supplied at the command line.
3673
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3674
# rather than failing tests. And no longer raise
3675
# LockContention when fctnl locks are not being used
3676
# with proper exclusion rules.
3677
# -Ethreads Will display thread ident at creation/join time to
3678
# help track thread leaks
3680
# -Econfig_stats Will collect statistics using addDetail
3681
selftest_debug_flags = set()
3684
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3686
test_suite_factory=None,
3689
matching_tests_first=None,
3692
exclude_pattern=None,
3698
suite_decorators=None,
285
print >>f, "contents of", name
290
class MetaTestLog(TestCase):
291
def test_logging(self):
292
"""Test logs are captured when a test fails."""
293
logging.info('an info message')
294
warning('something looks dodgy...')
295
logging.debug('hello, test is running')
299
def selftest(verbose=False, pattern=".*"):
3702
300
"""Run the whole test suite under the enhanced runner"""
3703
# XXX: Very ugly way to do this...
3704
# Disable warning about old formats because we don't want it to disturb
3705
# any blackbox tests.
3706
from bzrlib import repository
3707
repository._deprecation_warning_done = True
3709
global default_transport
3710
if transport is None:
3711
transport = default_transport
3712
old_transport = default_transport
3713
default_transport = transport
3714
global selftest_debug_flags
3715
old_debug_flags = selftest_debug_flags
3716
if debug_flags is not None:
3717
selftest_debug_flags = set(debug_flags)
3719
if load_list is None:
3722
keep_only = load_test_id_list(load_list)
3724
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3725
for start in starting_with]
3726
if test_suite_factory is None:
3727
# Reduce loading time by loading modules based on the starting_with
3729
suite = test_suite(keep_only, starting_with)
3731
suite = test_suite_factory()
3733
# But always filter as requested.
3734
suite = filter_suite_by_id_startswith(suite, starting_with)
3735
result_decorators = []
3737
result_decorators.append(ProfileResult)
3738
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3739
stop_on_failure=stop_on_failure,
3740
transport=transport,
3741
lsprof_timed=lsprof_timed,
3742
bench_history=bench_history,
3743
matching_tests_first=matching_tests_first,
3744
list_only=list_only,
3745
random_seed=random_seed,
3746
exclude_pattern=exclude_pattern,
3748
runner_class=runner_class,
3749
suite_decorators=suite_decorators,
3751
result_decorators=result_decorators,
3754
default_transport = old_transport
3755
selftest_debug_flags = old_debug_flags
3758
def load_test_id_list(file_name):
3759
"""Load a test id list from a text file.
3761
The format is one test id by line. No special care is taken to impose
3762
strict rules, these test ids are used to filter the test suite so a test id
3763
that do not match an existing test will do no harm. This allows user to add
3764
comments, leave blank lines, etc.
3768
ftest = open(file_name, 'rt')
3770
if e.errno != errno.ENOENT:
3773
raise errors.NoSuchFile(file_name)
3775
for test_name in ftest.readlines():
3776
test_list.append(test_name.strip())
3781
def suite_matches_id_list(test_suite, id_list):
3782
"""Warns about tests not appearing or appearing more than once.
3784
:param test_suite: A TestSuite object.
3785
:param test_id_list: The list of test ids that should be found in
3788
:return: (absents, duplicates) absents is a list containing the test found
3789
in id_list but not in test_suite, duplicates is a list containing the
3790
test found multiple times in test_suite.
3792
When using a prefined test id list, it may occurs that some tests do not
3793
exist anymore or that some tests use the same id. This function warns the
3794
tester about potential problems in his workflow (test lists are volatile)
3795
or in the test suite itself (using the same id for several tests does not
3796
help to localize defects).
3798
# Build a dict counting id occurrences
3800
for test in iter_suite_tests(test_suite):
3802
tests[id] = tests.get(id, 0) + 1
3807
occurs = tests.get(id, 0)
3809
not_found.append(id)
3811
duplicates.append(id)
3813
return not_found, duplicates
3816
class TestIdList(object):
3817
"""Test id list to filter a test suite.
3819
Relying on the assumption that test ids are built as:
3820
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3821
notation, this class offers methods to :
3822
- avoid building a test suite for modules not refered to in the test list,
3823
- keep only the tests listed from the module test suite.
3826
def __init__(self, test_id_list):
3827
# When a test suite needs to be filtered against us we compare test ids
3828
# for equality, so a simple dict offers a quick and simple solution.
3829
self.tests = dict().fromkeys(test_id_list, True)
3831
# While unittest.TestCase have ids like:
3832
# <module>.<class>.<method>[(<param+)],
3833
# doctest.DocTestCase can have ids like:
3836
# <module>.<function>
3837
# <module>.<class>.<method>
3839
# Since we can't predict a test class from its name only, we settle on
3840
# a simple constraint: a test id always begins with its module name.
3843
for test_id in test_id_list:
3844
parts = test_id.split('.')
3845
mod_name = parts.pop(0)
3846
modules[mod_name] = True
3848
mod_name += '.' + part
3849
modules[mod_name] = True
3850
self.modules = modules
3852
def refers_to(self, module_name):
3853
"""Is there tests for the module or one of its sub modules."""
3854
return self.modules.has_key(module_name)
3856
def includes(self, test_id):
3857
return self.tests.has_key(test_id)
3860
class TestPrefixAliasRegistry(registry.Registry):
3861
"""A registry for test prefix aliases.
3863
This helps implement shorcuts for the --starting-with selftest
3864
option. Overriding existing prefixes is not allowed but not fatal (a
3865
warning will be emitted).
3868
def register(self, key, obj, help=None, info=None,
3869
override_existing=False):
3870
"""See Registry.register.
3872
Trying to override an existing alias causes a warning to be emitted,
3873
not a fatal execption.
3876
super(TestPrefixAliasRegistry, self).register(
3877
key, obj, help=help, info=info, override_existing=False)
3879
actual = self.get(key)
3881
'Test prefix alias %s is already used for %s, ignoring %s'
3882
% (key, actual, obj))
3884
def resolve_alias(self, id_start):
3885
"""Replace the alias by the prefix in the given string.
3887
Using an unknown prefix is an error to help catching typos.
3889
parts = id_start.split('.')
3891
parts[0] = self.get(parts[0])
3893
raise errors.BzrCommandError(
3894
'%s is not a known test prefix alias' % parts[0])
3895
return '.'.join(parts)
3898
test_prefix_alias_registry = TestPrefixAliasRegistry()
3899
"""Registry of test prefix aliases."""
3902
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3903
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3904
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3906
# Obvious highest levels prefixes, feel free to add your own via a plugin
3907
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3908
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3909
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3910
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3911
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3914
def _test_suite_testmod_names():
3915
"""Return the standard list of test module names to test."""
3918
'bzrlib.tests.blackbox',
3919
'bzrlib.tests.commands',
3920
'bzrlib.tests.doc_generate',
3921
'bzrlib.tests.per_branch',
3922
'bzrlib.tests.per_bzrdir',
3923
'bzrlib.tests.per_controldir',
3924
'bzrlib.tests.per_controldir_colo',
3925
'bzrlib.tests.per_foreign_vcs',
3926
'bzrlib.tests.per_interrepository',
3927
'bzrlib.tests.per_intertree',
3928
'bzrlib.tests.per_inventory',
3929
'bzrlib.tests.per_interbranch',
3930
'bzrlib.tests.per_lock',
3931
'bzrlib.tests.per_merger',
3932
'bzrlib.tests.per_transport',
3933
'bzrlib.tests.per_tree',
3934
'bzrlib.tests.per_pack_repository',
3935
'bzrlib.tests.per_repository',
3936
'bzrlib.tests.per_repository_chk',
3937
'bzrlib.tests.per_repository_reference',
3938
'bzrlib.tests.per_repository_vf',
3939
'bzrlib.tests.per_uifactory',
3940
'bzrlib.tests.per_versionedfile',
3941
'bzrlib.tests.per_workingtree',
3942
'bzrlib.tests.test__annotator',
3943
'bzrlib.tests.test__bencode',
3944
'bzrlib.tests.test__btree_serializer',
3945
'bzrlib.tests.test__chk_map',
3946
'bzrlib.tests.test__dirstate_helpers',
3947
'bzrlib.tests.test__groupcompress',
3948
'bzrlib.tests.test__known_graph',
3949
'bzrlib.tests.test__rio',
3950
'bzrlib.tests.test__simple_set',
3951
'bzrlib.tests.test__static_tuple',
3952
'bzrlib.tests.test__walkdirs_win32',
3953
'bzrlib.tests.test_ancestry',
3954
'bzrlib.tests.test_annotate',
3955
'bzrlib.tests.test_api',
3956
'bzrlib.tests.test_atomicfile',
3957
'bzrlib.tests.test_bad_files',
3958
'bzrlib.tests.test_bisect_multi',
3959
'bzrlib.tests.test_branch',
3960
'bzrlib.tests.test_branchbuilder',
3961
'bzrlib.tests.test_btree_index',
3962
'bzrlib.tests.test_bugtracker',
3963
'bzrlib.tests.test_bundle',
3964
'bzrlib.tests.test_bzrdir',
3965
'bzrlib.tests.test__chunks_to_lines',
3966
'bzrlib.tests.test_cache_utf8',
3967
'bzrlib.tests.test_chk_map',
3968
'bzrlib.tests.test_chk_serializer',
3969
'bzrlib.tests.test_chunk_writer',
3970
'bzrlib.tests.test_clean_tree',
3971
'bzrlib.tests.test_cleanup',
3972
'bzrlib.tests.test_cmdline',
3973
'bzrlib.tests.test_commands',
3974
'bzrlib.tests.test_commit',
3975
'bzrlib.tests.test_commit_merge',
3976
'bzrlib.tests.test_config',
3977
'bzrlib.tests.test_conflicts',
3978
'bzrlib.tests.test_controldir',
3979
'bzrlib.tests.test_counted_lock',
3980
'bzrlib.tests.test_crash',
3981
'bzrlib.tests.test_decorators',
3982
'bzrlib.tests.test_delta',
3983
'bzrlib.tests.test_debug',
3984
'bzrlib.tests.test_diff',
3985
'bzrlib.tests.test_directory_service',
3986
'bzrlib.tests.test_dirstate',
3987
'bzrlib.tests.test_email_message',
3988
'bzrlib.tests.test_eol_filters',
3989
'bzrlib.tests.test_errors',
3990
'bzrlib.tests.test_estimate_compressed_size',
3991
'bzrlib.tests.test_export',
3992
'bzrlib.tests.test_export_pot',
3993
'bzrlib.tests.test_extract',
3994
'bzrlib.tests.test_features',
3995
'bzrlib.tests.test_fetch',
3996
'bzrlib.tests.test_fixtures',
3997
'bzrlib.tests.test_fifo_cache',
3998
'bzrlib.tests.test_filters',
3999
'bzrlib.tests.test_filter_tree',
4000
'bzrlib.tests.test_ftp_transport',
4001
'bzrlib.tests.test_foreign',
4002
'bzrlib.tests.test_generate_docs',
4003
'bzrlib.tests.test_generate_ids',
4004
'bzrlib.tests.test_globbing',
4005
'bzrlib.tests.test_gpg',
4006
'bzrlib.tests.test_graph',
4007
'bzrlib.tests.test_groupcompress',
4008
'bzrlib.tests.test_hashcache',
4009
'bzrlib.tests.test_help',
4010
'bzrlib.tests.test_hooks',
4011
'bzrlib.tests.test_http',
4012
'bzrlib.tests.test_http_response',
4013
'bzrlib.tests.test_https_ca_bundle',
4014
'bzrlib.tests.test_i18n',
4015
'bzrlib.tests.test_identitymap',
4016
'bzrlib.tests.test_ignores',
4017
'bzrlib.tests.test_index',
4018
'bzrlib.tests.test_import_tariff',
4019
'bzrlib.tests.test_info',
4020
'bzrlib.tests.test_inv',
4021
'bzrlib.tests.test_inventory_delta',
4022
'bzrlib.tests.test_knit',
4023
'bzrlib.tests.test_lazy_import',
4024
'bzrlib.tests.test_lazy_regex',
4025
'bzrlib.tests.test_library_state',
4026
'bzrlib.tests.test_lock',
4027
'bzrlib.tests.test_lockable_files',
4028
'bzrlib.tests.test_lockdir',
4029
'bzrlib.tests.test_log',
4030
'bzrlib.tests.test_lru_cache',
4031
'bzrlib.tests.test_lsprof',
4032
'bzrlib.tests.test_mail_client',
4033
'bzrlib.tests.test_matchers',
4034
'bzrlib.tests.test_memorytree',
4035
'bzrlib.tests.test_merge',
4036
'bzrlib.tests.test_merge3',
4037
'bzrlib.tests.test_merge_core',
4038
'bzrlib.tests.test_merge_directive',
4039
'bzrlib.tests.test_mergetools',
4040
'bzrlib.tests.test_missing',
4041
'bzrlib.tests.test_msgeditor',
4042
'bzrlib.tests.test_multiparent',
4043
'bzrlib.tests.test_mutabletree',
4044
'bzrlib.tests.test_nonascii',
4045
'bzrlib.tests.test_options',
4046
'bzrlib.tests.test_osutils',
4047
'bzrlib.tests.test_osutils_encodings',
4048
'bzrlib.tests.test_pack',
4049
'bzrlib.tests.test_patch',
4050
'bzrlib.tests.test_patches',
4051
'bzrlib.tests.test_permissions',
4052
'bzrlib.tests.test_plugins',
4053
'bzrlib.tests.test_progress',
4054
'bzrlib.tests.test_pyutils',
4055
'bzrlib.tests.test_read_bundle',
4056
'bzrlib.tests.test_reconcile',
4057
'bzrlib.tests.test_reconfigure',
4058
'bzrlib.tests.test_registry',
4059
'bzrlib.tests.test_remote',
4060
'bzrlib.tests.test_rename_map',
4061
'bzrlib.tests.test_repository',
4062
'bzrlib.tests.test_revert',
4063
'bzrlib.tests.test_revision',
4064
'bzrlib.tests.test_revisionspec',
4065
'bzrlib.tests.test_revisiontree',
4066
'bzrlib.tests.test_rio',
4067
'bzrlib.tests.test_rules',
4068
'bzrlib.tests.test_sampler',
4069
'bzrlib.tests.test_scenarios',
4070
'bzrlib.tests.test_script',
4071
'bzrlib.tests.test_selftest',
4072
'bzrlib.tests.test_serializer',
4073
'bzrlib.tests.test_setup',
4074
'bzrlib.tests.test_sftp_transport',
4075
'bzrlib.tests.test_shelf',
4076
'bzrlib.tests.test_shelf_ui',
4077
'bzrlib.tests.test_smart',
4078
'bzrlib.tests.test_smart_add',
4079
'bzrlib.tests.test_smart_request',
4080
'bzrlib.tests.test_smart_transport',
4081
'bzrlib.tests.test_smtp_connection',
4082
'bzrlib.tests.test_source',
4083
'bzrlib.tests.test_ssh_transport',
4084
'bzrlib.tests.test_status',
4085
'bzrlib.tests.test_store',
4086
'bzrlib.tests.test_strace',
4087
'bzrlib.tests.test_subsume',
4088
'bzrlib.tests.test_switch',
4089
'bzrlib.tests.test_symbol_versioning',
4090
'bzrlib.tests.test_tag',
4091
'bzrlib.tests.test_test_server',
4092
'bzrlib.tests.test_testament',
4093
'bzrlib.tests.test_textfile',
4094
'bzrlib.tests.test_textmerge',
4095
'bzrlib.tests.test_cethread',
4096
'bzrlib.tests.test_timestamp',
4097
'bzrlib.tests.test_trace',
4098
'bzrlib.tests.test_transactions',
4099
'bzrlib.tests.test_transform',
4100
'bzrlib.tests.test_transport',
4101
'bzrlib.tests.test_transport_log',
4102
'bzrlib.tests.test_tree',
4103
'bzrlib.tests.test_treebuilder',
4104
'bzrlib.tests.test_treeshape',
4105
'bzrlib.tests.test_tsort',
4106
'bzrlib.tests.test_tuned_gzip',
4107
'bzrlib.tests.test_ui',
4108
'bzrlib.tests.test_uncommit',
4109
'bzrlib.tests.test_upgrade',
4110
'bzrlib.tests.test_upgrade_stacked',
4111
'bzrlib.tests.test_urlutils',
4112
'bzrlib.tests.test_utextwrap',
4113
'bzrlib.tests.test_version',
4114
'bzrlib.tests.test_version_info',
4115
'bzrlib.tests.test_versionedfile',
4116
'bzrlib.tests.test_weave',
4117
'bzrlib.tests.test_whitebox',
4118
'bzrlib.tests.test_win32utils',
4119
'bzrlib.tests.test_workingtree',
4120
'bzrlib.tests.test_workingtree_4',
4121
'bzrlib.tests.test_wsgi',
4122
'bzrlib.tests.test_xml',
4126
def _test_suite_modules_to_doctest():
4127
"""Return the list of modules to doctest."""
4129
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
4133
'bzrlib.branchbuilder',
4134
'bzrlib.decorators',
4136
'bzrlib.iterablefile',
4141
'bzrlib.symbol_versioning',
4143
'bzrlib.tests.fixtures',
4145
'bzrlib.transport.http',
4146
'bzrlib.version_info_formats.format_custom',
4150
def test_suite(keep_only=None, starting_with=None):
4151
"""Build and return TestSuite for the whole of bzrlib.
4153
:param keep_only: A list of test ids limiting the suite returned.
4155
:param starting_with: An id limiting the suite returned to the tests
4158
This function can be replaced if you need to change the default test
4159
suite on a global basis, but it is not encouraged.
4162
loader = TestUtil.TestLoader()
4164
if keep_only is not None:
4165
id_filter = TestIdList(keep_only)
4167
# We take precedence over keep_only because *at loading time* using
4168
# both options means we will load less tests for the same final result.
4169
def interesting_module(name):
4170
for start in starting_with:
4172
# Either the module name starts with the specified string
4173
name.startswith(start)
4174
# or it may contain tests starting with the specified string
4175
or start.startswith(name)
4179
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
4181
elif keep_only is not None:
4182
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
4183
def interesting_module(name):
4184
return id_filter.refers_to(name)
4187
loader = TestUtil.TestLoader()
4188
def interesting_module(name):
4189
# No filtering, all modules are interesting
4192
suite = loader.suiteClass()
4194
# modules building their suite with loadTestsFromModuleNames
4195
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
4197
for mod in _test_suite_modules_to_doctest():
4198
if not interesting_module(mod):
4199
# No tests to keep here, move along
4202
# note that this really does mean "report only" -- doctest
4203
# still runs the rest of the examples
4204
doc_suite = IsolatedDocTestSuite(
4205
mod, optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
4206
except ValueError, e:
4207
print '**failed to get doctest for: %s\n%s' % (mod, e)
4209
if len(doc_suite._tests) == 0:
4210
raise errors.BzrError("no doctests found in %s" % (mod,))
4211
suite.addTest(doc_suite)
4213
default_encoding = sys.getdefaultencoding()
4214
for name, plugin in _mod_plugin.plugins().items():
4215
if not interesting_module(plugin.module.__name__):
4217
plugin_suite = plugin.test_suite()
4218
# We used to catch ImportError here and turn it into just a warning,
4219
# but really if you don't have --no-plugins this should be a failure.
4220
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
4221
if plugin_suite is None:
4222
plugin_suite = plugin.load_plugin_tests(loader)
4223
if plugin_suite is not None:
4224
suite.addTest(plugin_suite)
4225
if default_encoding != sys.getdefaultencoding():
4227
'Plugin "%s" tried to reset default encoding to: %s', name,
4228
sys.getdefaultencoding())
4230
sys.setdefaultencoding(default_encoding)
4232
if keep_only is not None:
4233
# Now that the referred modules have loaded their tests, keep only the
4235
suite = filter_suite_by_id_list(suite, id_filter)
4236
# Do some sanity checks on the id_list filtering
4237
not_found, duplicates = suite_matches_id_list(suite, keep_only)
4239
# The tester has used both keep_only and starting_with, so he is
4240
# already aware that some tests are excluded from the list, there
4241
# is no need to tell him which.
4244
# Some tests mentioned in the list are not in the test suite. The
4245
# list may be out of date, report to the tester.
4246
for id in not_found:
4247
trace.warning('"%s" not found in the test suite', id)
4248
for id in duplicates:
4249
trace.warning('"%s" is used as an id by several tests', id)
301
return testsweet.run_suite(test_suite(), 'testbzr', verbose=verbose, pattern=pattern)
305
"""Build and return TestSuite for the whole program."""
306
from bzrlib.selftest.TestUtil import TestLoader, TestSuite
307
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
308
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
309
from doctest import DocTestSuite
315
global MODULES_TO_TEST, MODULES_TO_DOCTEST
318
['bzrlib.selftest.MetaTestLog',
319
'bzrlib.selftest.testinv',
320
'bzrlib.selftest.test_commit',
321
'bzrlib.selftest.versioning',
322
'bzrlib.selftest.testmerge3',
323
'bzrlib.selftest.testhashcache',
324
'bzrlib.selftest.teststatus',
325
'bzrlib.selftest.testlog',
326
'bzrlib.selftest.testrevisionnamespaces',
327
'bzrlib.selftest.testbranch',
328
# 'bzrlib.selftest.testrevision',
329
# 'bzrlib.selftest.test_merge_core',
330
'bzrlib.selftest.test_smart_add',
331
'bzrlib.selftest.testdiff',
332
# 'bzrlib.selftest.test_parent',
333
'bzrlib.selftest.test_xml',
334
'bzrlib.selftest.test_weave',
335
# 'bzrlib.selftest.testfetch',
336
# 'bzrlib.selftest.whitebox',
337
'bzrlib.selftest.teststore',
338
# 'bzrlib.selftest.blackbox',
341
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
342
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
343
if m not in MODULES_TO_DOCTEST:
344
MODULES_TO_DOCTEST.append(m)
346
TestCase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
347
print '%-30s %s' % ('bzr binary', TestCase.BZRPATH)
350
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
351
for m in MODULES_TO_TEST:
352
suite.addTest(TestLoader().loadTestsFromModule(m))
353
for m in (MODULES_TO_DOCTEST):
354
suite.addTest(DocTestSuite(m))
355
for p in bzrlib.plugin.all_plugins:
356
if hasattr(p, 'test_suite'):
357
suite.addTest(p.test_suite())
4254
def multiply_scenarios(*scenarios):
4255
"""Multiply two or more iterables of scenarios.
4257
It is safe to pass scenario generators or iterators.
4259
:returns: A list of compound scenarios: the cross-product of all
4260
scenarios, with the names concatenated and the parameters
4263
return reduce(_multiply_two_scenarios, map(list, scenarios))
4266
def _multiply_two_scenarios(scenarios_left, scenarios_right):
4267
"""Multiply two sets of scenarios.
4269
:returns: the cartesian product of the two sets of scenarios, that is
4270
a scenario for every possible combination of a left scenario and a
4274
('%s,%s' % (left_name, right_name),
4275
dict(left_dict.items() + right_dict.items()))
4276
for left_name, left_dict in scenarios_left
4277
for right_name, right_dict in scenarios_right]
4280
def multiply_tests(tests, scenarios, result):
4281
"""Multiply tests_list by scenarios into result.
4283
This is the core workhorse for test parameterisation.
4285
Typically the load_tests() method for a per-implementation test suite will
4286
call multiply_tests and return the result.
4288
:param tests: The tests to parameterise.
4289
:param scenarios: The scenarios to apply: pairs of (scenario_name,
4290
scenario_param_dict).
4291
:param result: A TestSuite to add created tests to.
4293
This returns the passed in result TestSuite with the cross product of all
4294
the tests repeated once for each scenario. Each test is adapted by adding
4295
the scenario name at the end of its id(), and updating the test object's
4296
__dict__ with the scenario_param_dict.
4298
>>> import bzrlib.tests.test_sampler
4299
>>> r = multiply_tests(
4300
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
4301
... [('one', dict(param=1)),
4302
... ('two', dict(param=2))],
4303
... TestUtil.TestSuite())
4304
>>> tests = list(iter_suite_tests(r))
4308
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
4314
for test in iter_suite_tests(tests):
4315
apply_scenarios(test, scenarios, result)
4319
def apply_scenarios(test, scenarios, result):
4320
"""Apply the scenarios in scenarios to test and add to result.
4322
:param test: The test to apply scenarios to.
4323
:param scenarios: An iterable of scenarios to apply to test.
4325
:seealso: apply_scenario
4327
for scenario in scenarios:
4328
result.addTest(apply_scenario(test, scenario))
4332
def apply_scenario(test, scenario):
4333
"""Copy test and apply scenario to it.
4335
:param test: A test to adapt.
4336
:param scenario: A tuple describing the scenarion.
4337
The first element of the tuple is the new test id.
4338
The second element is a dict containing attributes to set on the
4340
:return: The adapted test.
4342
new_id = "%s(%s)" % (test.id(), scenario[0])
4343
new_test = clone_test(test, new_id)
4344
for name, value in scenario[1].items():
4345
setattr(new_test, name, value)
4349
def clone_test(test, new_id):
4350
"""Clone a test giving it a new id.
4352
:param test: The test to clone.
4353
:param new_id: The id to assign to it.
4354
:return: The new test.
4356
new_test = copy.copy(test)
4357
new_test.id = lambda: new_id
4358
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4359
# causes cloned tests to share the 'details' dict. This makes it hard to
4360
# read the test output for parameterized tests, because tracebacks will be
4361
# associated with irrelevant tests.
4363
details = new_test._TestCase__details
4364
except AttributeError:
4365
# must be a different version of testtools than expected. Do nothing.
4368
# Reset the '__details' dict.
4369
new_test._TestCase__details = {}
4373
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4375
"""Helper for permutating tests against an extension module.
4377
This is meant to be used inside a modules 'load_tests()' function. It will
4378
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4379
against both implementations. Setting 'test.module' to the appropriate
4380
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4382
:param standard_tests: A test suite to permute
4383
:param loader: A TestLoader
4384
:param py_module_name: The python path to a python module that can always
4385
be loaded, and will be considered the 'python' implementation. (eg
4386
'bzrlib._chk_map_py')
4387
:param ext_module_name: The python path to an extension module. If the
4388
module cannot be loaded, a single test will be added, which notes that
4389
the module is not available. If it can be loaded, all standard_tests
4390
will be run against that module.
4391
:return: (suite, feature) suite is a test-suite that has all the permuted
4392
tests. feature is the Feature object that can be used to determine if
4393
the module is available.
4396
from bzrlib.tests.features import ModuleAvailableFeature
4397
py_module = pyutils.get_named_object(py_module_name)
4399
('python', {'module': py_module}),
4401
suite = loader.suiteClass()
4402
feature = ModuleAvailableFeature(ext_module_name)
4403
if feature.available():
4404
scenarios.append(('C', {'module': feature.module}))
4406
# the compiled module isn't available, so we add a failing test
4407
class FailWithoutFeature(TestCase):
4408
def test_fail(self):
4409
self.requireFeature(feature)
4410
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4411
result = multiply_tests(standard_tests, scenarios, suite)
4412
return result, feature
4415
def _rmtree_temp_dir(dirname, test_id=None):
4416
# If LANG=C we probably have created some bogus paths
4417
# which rmtree(unicode) will fail to delete
4418
# so make sure we are using rmtree(str) to delete everything
4419
# except on win32, where rmtree(str) will fail
4420
# since it doesn't have the property of byte-stream paths
4421
# (they are either ascii or mbcs)
4422
if sys.platform == 'win32':
4423
# make sure we are using the unicode win32 api
4424
dirname = unicode(dirname)
4426
dirname = dirname.encode(sys.getfilesystemencoding())
4428
osutils.rmtree(dirname)
4430
# We don't want to fail here because some useful display will be lost
4431
# otherwise. Polluting the tmp dir is bad, but not giving all the
4432
# possible info to the test runner is even worse.
4434
ui.ui_factory.clear_term()
4435
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4436
# Ugly, but the last thing we want here is fail, so bear with it.
4437
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4438
).encode('ascii', 'replace')
4439
sys.stderr.write('Unable to remove testing dir %s\n%s'
4440
% (os.path.basename(dirname), printable_e))
4443
def probe_unicode_in_user_encoding():
4444
"""Try to encode several unicode strings to use in unicode-aware tests.
4445
Return first successfull match.
4447
:return: (unicode value, encoded plain string value) or (None, None)
4449
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4450
for uni_val in possible_vals:
4452
str_val = uni_val.encode(osutils.get_user_encoding())
4453
except UnicodeEncodeError:
4454
# Try a different character
4457
return uni_val, str_val
4461
def probe_bad_non_ascii(encoding):
4462
"""Try to find [bad] character with code [128..255]
4463
that cannot be decoded to unicode in some encoding.
4464
Return None if all non-ascii characters is valid
4467
for i in xrange(128, 256):
4470
char.decode(encoding)
4471
except UnicodeDecodeError:
4476
# Only define SubUnitBzrRunner if subunit is available.
4478
from subunit import TestProtocolClient
4479
from subunit.test_results import AutoTimingTestResultDecorator
4480
class SubUnitBzrProtocolClient(TestProtocolClient):
4482
def addSuccess(self, test, details=None):
4483
# The subunit client always includes the details in the subunit
4484
# stream, but we don't want to include it in ours.
4485
if details is not None and 'log' in details:
4487
return super(SubUnitBzrProtocolClient, self).addSuccess(
4490
class SubUnitBzrRunner(TextTestRunner):
4491
def run(self, test):
4492
result = AutoTimingTestResultDecorator(
4493
SubUnitBzrProtocolClient(self.stream))
4500
@deprecated_function(deprecated_in((2, 5, 0)))
4501
def ModuleAvailableFeature(name):
4502
from bzrlib.tests import features
4503
return features.ModuleAvailableFeature(name)
added
removed
bzrlib/selftest/__init__.py
