1
# Copyright (C) 2005-2010 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
# TODO: Perhaps there should be an API to find out if bzr running under the
20
# test suite -- some plugins might want to avoid making intrusive changes if
21
# this is the case. However, we want behaviour under to test to diverge as
22
# little as possible, so this should be used rarely if it's added at all.
23
# (Suggestion from j-a-meinel, 2005-11-24)
25
# NOTE: Some classes in here use camelCaseNaming() rather than
26
# underscore_naming(). That's for consistency with unittest; it's not the
27
# general style of bzrlib. Please continue that consistency when adding e.g.
28
# new assertFoo() methods.
33
from cStringIO import StringIO
56
# nb: check this before importing anything else from within it
57
_testtools_version = getattr(testtools, '__version__', ())
58
if _testtools_version < (0, 9, 2):
59
raise ImportError("need at least testtools 0.9.2: %s is %r"
60
% (testtools.__file__, _testtools_version))
61
from testtools import content
77
transport as _mod_transport,
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from testsweet import TestBase, run_suite, InTempDir
81
19
import bzrlib.commands
82
import bzrlib.timestamp
84
import bzrlib.inventory
85
import bzrlib.iterablefile
90
# lsprof not available
92
from bzrlib.merge import merge_inner
95
from bzrlib.smart import client, request, server
97
from bzrlib import symbol_versioning
98
from bzrlib.symbol_versioning import (
106
from bzrlib.transport import (
110
from bzrlib.trace import mutter, note
111
from bzrlib.tests import (
116
from bzrlib.ui import NullProgressView
117
from bzrlib.ui.text import TextUIFactory
118
import bzrlib.version_info_formats.format_custom
119
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
121
# Mark this python module as being part of the implementation
122
# of unittest: this gives us better tracebacks where the last
123
# shown frame is the test code, not our assertXYZ.
126
default_transport = test_server.LocalURLServer
129
_unitialized_attr = object()
130
"""A sentinel needed to act as a default value in a method signature."""
133
# Subunit result codes, defined here to prevent a hard dependency on subunit.
137
# These are intentionally brought into this namespace. That way plugins, etc
138
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
139
TestSuite = TestUtil.TestSuite
140
TestLoader = TestUtil.TestLoader
142
class ExtendedTestResult(testtools.TextTestResult):
143
"""Accepts, reports and accumulates the results of running tests.
145
Compared to the unittest version this class adds support for
146
profiling, benchmarking, stopping as soon as a test fails, and
147
skipping tests. There are further-specialized subclasses for
148
different types of display.
150
When a test finishes, in whatever way, it calls one of the addSuccess,
151
addFailure or addError classes. These in turn may redirect to a more
152
specific case for the special test results supported by our extended
155
Note that just one of these objects is fed the results from many tests.
160
def __init__(self, stream, descriptions, verbosity,
164
"""Construct new TestResult.
166
:param bench_history: Optionally, a writable file object to accumulate
169
testtools.TextTestResult.__init__(self, stream)
170
if bench_history is not None:
171
from bzrlib.version import _get_bzr_source_tree
172
src_tree = _get_bzr_source_tree()
175
revision_id = src_tree.get_parent_ids()[0]
177
# XXX: if this is a brand new tree, do the same as if there
181
# XXX: If there's no branch, what should we do?
183
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
184
self._bench_history = bench_history
185
self.ui = ui.ui_factory
188
self.failure_count = 0
189
self.known_failure_count = 0
191
self.not_applicable_count = 0
192
self.unsupported = {}
194
self._overall_start_time = time.time()
195
self._strict = strict
196
self._first_thread_leaker_id = None
197
self._tests_leaking_threads_count = 0
199
def stopTestRun(self):
202
stopTime = time.time()
203
timeTaken = stopTime - self.startTime
204
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
205
# the parent class method is similar have to duplicate
206
self._show_list('ERROR', self.errors)
207
self._show_list('FAIL', self.failures)
208
self.stream.write(self.sep2)
209
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
210
run, run != 1 and "s" or "", timeTaken))
211
if not self.wasSuccessful():
212
self.stream.write("FAILED (")
213
failed, errored = map(len, (self.failures, self.errors))
215
self.stream.write("failures=%d" % failed)
217
if failed: self.stream.write(", ")
218
self.stream.write("errors=%d" % errored)
219
if self.known_failure_count:
220
if failed or errored: self.stream.write(", ")
221
self.stream.write("known_failure_count=%d" %
222
self.known_failure_count)
223
self.stream.write(")\n")
225
if self.known_failure_count:
226
self.stream.write("OK (known_failures=%d)\n" %
227
self.known_failure_count)
229
self.stream.write("OK\n")
230
if self.skip_count > 0:
231
skipped = self.skip_count
232
self.stream.write('%d test%s skipped\n' %
233
(skipped, skipped != 1 and "s" or ""))
235
for feature, count in sorted(self.unsupported.items()):
236
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
239
ok = self.wasStrictlySuccessful()
241
ok = self.wasSuccessful()
242
if self._first_thread_leaker_id:
244
'%s is leaking threads among %d leaking tests.\n' % (
245
self._first_thread_leaker_id,
246
self._tests_leaking_threads_count))
247
# We don't report the main thread as an active one.
249
'%d non-main threads were left active in the end.\n'
250
% (len(self._active_threads) - 1))
252
def getDescription(self, test):
255
def _extractBenchmarkTime(self, testCase, details=None):
256
"""Add a benchmark time for the current test case."""
257
if details and 'benchtime' in details:
258
return float(''.join(details['benchtime'].iter_bytes()))
259
return getattr(testCase, "_benchtime", None)
261
def _elapsedTestTimeString(self):
262
"""Return a time string for the overall time the current test has taken."""
263
return self._formatTime(time.time() - self._start_time)
265
def _testTimeString(self, testCase):
266
benchmark_time = self._extractBenchmarkTime(testCase)
267
if benchmark_time is not None:
268
return self._formatTime(benchmark_time) + "*"
270
return self._elapsedTestTimeString()
272
def _formatTime(self, seconds):
273
"""Format seconds as milliseconds with leading spaces."""
274
# some benchmarks can take thousands of seconds to run, so we need 8
276
return "%8dms" % (1000 * seconds)
278
def _shortened_test_description(self, test):
280
what = re.sub(r'^bzrlib\.tests\.', '', what)
283
def startTest(self, test):
284
super(ExtendedTestResult, self).startTest(test)
288
self.report_test_start(test)
289
test.number = self.count
290
self._recordTestStartTime()
291
# Only check for thread leaks if the test case supports cleanups
292
addCleanup = getattr(test, "addCleanup", None)
293
if addCleanup is not None:
294
addCleanup(self._check_leaked_threads, test)
296
def startTests(self):
297
self.report_tests_starting()
298
self._active_threads = threading.enumerate()
300
def _check_leaked_threads(self, test):
301
"""See if any threads have leaked since last call
303
A sample of live threads is stored in the _active_threads attribute,
304
when this method runs it compares the current live threads and any not
305
in the previous sample are treated as having leaked.
307
now_active_threads = set(threading.enumerate())
308
threads_leaked = now_active_threads.difference(self._active_threads)
310
self._report_thread_leak(test, threads_leaked, now_active_threads)
311
self._tests_leaking_threads_count += 1
312
if self._first_thread_leaker_id is None:
313
self._first_thread_leaker_id = test.id()
314
self._active_threads = now_active_threads
316
def _recordTestStartTime(self):
317
"""Record that a test has started."""
318
self._start_time = time.time()
320
def addError(self, test, err):
321
"""Tell result that test finished with an error.
323
Called from the TestCase run() method when the test
324
fails with an unexpected error.
327
super(ExtendedTestResult, self).addError(test, err)
328
self.error_count += 1
329
self.report_error(test, err)
333
def addFailure(self, test, err):
334
"""Tell result that test failed.
336
Called from the TestCase run() method when the test
337
fails because e.g. an assert() method failed.
340
super(ExtendedTestResult, self).addFailure(test, err)
341
self.failure_count += 1
342
self.report_failure(test, err)
346
def addSuccess(self, test, details=None):
347
"""Tell result that test completed successfully.
349
Called from the TestCase run()
351
if self._bench_history is not None:
352
benchmark_time = self._extractBenchmarkTime(test, details)
353
if benchmark_time is not None:
354
self._bench_history.write("%s %s\n" % (
355
self._formatTime(benchmark_time),
357
self.report_success(test)
358
super(ExtendedTestResult, self).addSuccess(test)
359
test._log_contents = ''
361
def addExpectedFailure(self, test, err):
362
self.known_failure_count += 1
363
self.report_known_failure(test, err)
365
def addNotSupported(self, test, feature):
366
"""The test will not be run because of a missing feature.
368
# this can be called in two different ways: it may be that the
369
# test started running, and then raised (through requireFeature)
370
# UnavailableFeature. Alternatively this method can be called
371
# while probing for features before running the test code proper; in
372
# that case we will see startTest and stopTest, but the test will
373
# never actually run.
374
self.unsupported.setdefault(str(feature), 0)
375
self.unsupported[str(feature)] += 1
376
self.report_unsupported(test, feature)
378
def addSkip(self, test, reason):
379
"""A test has not run for 'reason'."""
381
self.report_skip(test, reason)
383
def addNotApplicable(self, test, reason):
384
self.not_applicable_count += 1
385
self.report_not_applicable(test, reason)
387
def _post_mortem(self):
388
"""Start a PDB post mortem session."""
389
if os.environ.get('BZR_TEST_PDB', None):
390
import pdb;pdb.post_mortem()
392
def progress(self, offset, whence):
393
"""The test is adjusting the count of tests to run."""
394
if whence == SUBUNIT_SEEK_SET:
395
self.num_tests = offset
396
elif whence == SUBUNIT_SEEK_CUR:
397
self.num_tests += offset
399
raise errors.BzrError("Unknown whence %r" % whence)
401
def report_tests_starting(self):
402
"""Display information before the test run begins"""
403
if getattr(sys, 'frozen', None) is None:
404
bzr_path = osutils.realpath(sys.argv[0])
406
bzr_path = sys.executable
408
'bzr selftest: %s\n' % (bzr_path,))
411
bzrlib.__path__[0],))
413
' bzr-%s python-%s %s\n' % (
414
bzrlib.version_string,
415
bzrlib._format_version_tuple(sys.version_info),
416
platform.platform(aliased=1),
418
self.stream.write('\n')
420
def report_test_start(self, test):
421
"""Display information on the test just about to be run"""
423
def _report_thread_leak(self, test, leaked_threads, active_threads):
424
"""Display information on a test that leaked one or more threads"""
425
# GZ 2010-09-09: A leak summary reported separately from the general
426
# thread debugging would be nice. Tests under subunit
427
# need something not using stream, perhaps adding a
428
# testtools details object would be fitting.
429
if 'threads' in selftest_debug_flags:
430
self.stream.write('%s is leaking, active is now %d\n' %
431
(test.id(), len(active_threads)))
433
def startTestRun(self):
434
self.startTime = time.time()
436
def report_success(self, test):
439
def wasStrictlySuccessful(self):
440
if self.unsupported or self.known_failure_count:
442
return self.wasSuccessful()
445
class TextTestResult(ExtendedTestResult):
446
"""Displays progress and results of tests in text form"""
448
def __init__(self, stream, descriptions, verbosity,
453
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
454
bench_history, strict)
455
# We no longer pass them around, but just rely on the UIFactory stack
458
warnings.warn("Passing pb to TextTestResult is deprecated")
459
self.pb = self.ui.nested_progress_bar()
460
self.pb.show_pct = False
461
self.pb.show_spinner = False
462
self.pb.show_eta = False,
463
self.pb.show_count = False
464
self.pb.show_bar = False
465
self.pb.update_latency = 0
466
self.pb.show_transport_activity = False
468
def stopTestRun(self):
469
# called when the tests that are going to run have run
472
super(TextTestResult, self).stopTestRun()
474
def report_tests_starting(self):
475
super(TextTestResult, self).report_tests_starting()
476
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
478
def _progress_prefix_text(self):
479
# the longer this text, the less space we have to show the test
481
a = '[%d' % self.count # total that have been run
482
# tests skipped as known not to be relevant are not important enough
484
## if self.skip_count:
485
## a += ', %d skip' % self.skip_count
486
## if self.known_failure_count:
487
## a += '+%dX' % self.known_failure_count
489
a +='/%d' % self.num_tests
491
runtime = time.time() - self._overall_start_time
493
a += '%dm%ds' % (runtime / 60, runtime % 60)
496
total_fail_count = self.error_count + self.failure_count
498
a += ', %d failed' % total_fail_count
499
# if self.unsupported:
500
# a += ', %d missing' % len(self.unsupported)
504
def report_test_start(self, test):
506
self._progress_prefix_text()
508
+ self._shortened_test_description(test))
510
def _test_description(self, test):
511
return self._shortened_test_description(test)
513
def report_error(self, test, err):
514
self.stream.write('ERROR: %s\n %s\n' % (
515
self._test_description(test),
519
def report_failure(self, test, err):
520
self.stream.write('FAIL: %s\n %s\n' % (
521
self._test_description(test),
525
def report_known_failure(self, test, err):
528
def report_skip(self, test, reason):
531
def report_not_applicable(self, test, reason):
534
def report_unsupported(self, test, feature):
535
"""test cannot be run because feature is missing."""
538
class VerboseTestResult(ExtendedTestResult):
539
"""Produce long output, with one line per test run plus times"""
541
def _ellipsize_to_right(self, a_string, final_width):
542
"""Truncate and pad a string, keeping the right hand side"""
543
if len(a_string) > final_width:
544
result = '...' + a_string[3-final_width:]
547
return result.ljust(final_width)
549
def report_tests_starting(self):
550
self.stream.write('running %d tests...\n' % self.num_tests)
551
super(VerboseTestResult, self).report_tests_starting()
553
def report_test_start(self, test):
554
name = self._shortened_test_description(test)
555
width = osutils.terminal_width()
556
if width is not None:
557
# width needs space for 6 char status, plus 1 for slash, plus an
558
# 11-char time string, plus a trailing blank
559
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
561
self.stream.write(self._ellipsize_to_right(name, width-18))
563
self.stream.write(name)
566
def _error_summary(self, err):
568
return '%s%s' % (indent, err[1])
570
def report_error(self, test, err):
571
self.stream.write('ERROR %s\n%s\n'
572
% (self._testTimeString(test),
573
self._error_summary(err)))
575
def report_failure(self, test, err):
576
self.stream.write(' FAIL %s\n%s\n'
577
% (self._testTimeString(test),
578
self._error_summary(err)))
580
def report_known_failure(self, test, err):
581
self.stream.write('XFAIL %s\n%s\n'
582
% (self._testTimeString(test),
583
self._error_summary(err)))
585
def report_success(self, test):
586
self.stream.write(' OK %s\n' % self._testTimeString(test))
587
for bench_called, stats in getattr(test, '_benchcalls', []):
588
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
589
stats.pprint(file=self.stream)
590
# flush the stream so that we get smooth output. This verbose mode is
591
# used to show the output in PQM.
594
def report_skip(self, test, reason):
595
self.stream.write(' SKIP %s\n%s\n'
596
% (self._testTimeString(test), reason))
598
def report_not_applicable(self, test, reason):
599
self.stream.write(' N/A %s\n %s\n'
600
% (self._testTimeString(test), reason))
602
def report_unsupported(self, test, feature):
603
"""test cannot be run because feature is missing."""
604
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
605
%(self._testTimeString(test), feature))
608
class TextTestRunner(object):
609
stop_on_failure = False
617
result_decorators=None,
619
"""Create a TextTestRunner.
621
:param result_decorators: An optional list of decorators to apply
622
to the result object being used by the runner. Decorators are
623
applied left to right - the first element in the list is the
626
# stream may know claim to know to write unicode strings, but in older
627
# pythons this goes sufficiently wrong that it is a bad idea. (
628
# specifically a built in file with encoding 'UTF-8' will still try
629
# to encode using ascii.
630
new_encoding = osutils.get_terminal_encoding()
631
codec = codecs.lookup(new_encoding)
632
if type(codec) is tuple:
636
encode = codec.encode
637
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
638
stream.encoding = new_encoding
640
self.descriptions = descriptions
641
self.verbosity = verbosity
642
self._bench_history = bench_history
643
self._strict = strict
644
self._result_decorators = result_decorators or []
647
"Run the given test case or test suite."
648
if self.verbosity == 1:
649
result_class = TextTestResult
650
elif self.verbosity >= 2:
651
result_class = VerboseTestResult
652
original_result = result_class(self.stream,
655
bench_history=self._bench_history,
658
# Signal to result objects that look at stop early policy to stop,
659
original_result.stop_early = self.stop_on_failure
660
result = original_result
661
for decorator in self._result_decorators:
662
result = decorator(result)
663
result.stop_early = self.stop_on_failure
664
result.startTestRun()
669
# higher level code uses our extended protocol to determine
670
# what exit code to give.
671
return original_result
674
def iter_suite_tests(suite):
675
"""Return all tests in a suite, recursing through nested suites"""
676
if isinstance(suite, unittest.TestCase):
678
elif isinstance(suite, unittest.TestSuite):
680
for r in iter_suite_tests(item):
683
raise Exception('unknown type %r for object %r'
684
% (type(suite), suite))
687
TestSkipped = testtools.testcase.TestSkipped
690
class TestNotApplicable(TestSkipped):
691
"""A test is not applicable to the situation where it was run.
693
This is only normally raised by parameterized tests, if they find that
694
the instance they're constructed upon does not support one aspect
699
# traceback._some_str fails to format exceptions that have the default
700
# __str__ which does an implicit ascii conversion. However, repr() on those
701
# objects works, for all that its not quite what the doctor may have ordered.
702
def _clever_some_str(value):
707
return repr(value).replace('\\n', '\n')
709
return '<unprintable %s object>' % type(value).__name__
711
traceback._some_str = _clever_some_str
714
# deprecated - use self.knownFailure(), or self.expectFailure.
715
KnownFailure = testtools.testcase._ExpectedFailure
718
class UnavailableFeature(Exception):
719
"""A feature required for this test was not available.
721
This can be considered a specialised form of SkippedTest.
723
The feature should be used to construct the exception.
727
class StringIOWrapper(object):
728
"""A wrapper around cStringIO which just adds an encoding attribute.
730
Internally we can check sys.stdout to see what the output encoding
731
should be. However, cStringIO has no encoding attribute that we can
732
set. So we wrap it instead.
737
def __init__(self, s=None):
739
self.__dict__['_cstring'] = StringIO(s)
741
self.__dict__['_cstring'] = StringIO()
743
def __getattr__(self, name, getattr=getattr):
744
return getattr(self.__dict__['_cstring'], name)
746
def __setattr__(self, name, val):
747
if name == 'encoding':
748
self.__dict__['encoding'] = val
750
return setattr(self._cstring, name, val)
753
class TestUIFactory(TextUIFactory):
754
"""A UI Factory for testing.
756
Hide the progress bar but emit note()s.
758
Allows get_password to be tested without real tty attached.
760
See also CannedInputUIFactory which lets you provide programmatic input in
763
# TODO: Capture progress events at the model level and allow them to be
764
# observed by tests that care.
766
# XXX: Should probably unify more with CannedInputUIFactory or a
767
# particular configuration of TextUIFactory, or otherwise have a clearer
768
# idea of how they're supposed to be different.
769
# See https://bugs.launchpad.net/bzr/+bug/408213
771
def __init__(self, stdout=None, stderr=None, stdin=None):
772
if stdin is not None:
773
# We use a StringIOWrapper to be able to test various
774
# encodings, but the user is still responsible to
775
# encode the string and to set the encoding attribute
776
# of StringIOWrapper.
777
stdin = StringIOWrapper(stdin)
778
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
780
def get_non_echoed_password(self):
781
"""Get password from stdin without trying to handle the echo mode"""
782
password = self.stdin.readline()
785
if password[-1] == '\n':
786
password = password[:-1]
789
def make_progress_view(self):
790
return NullProgressView()
793
class TestCase(testtools.TestCase):
794
"""Base class for bzr unit tests.
796
Tests that need access to disk resources should subclass
797
TestCaseInTempDir not TestCase.
799
Error and debug log messages are redirected from their usual
800
location into a temporary file, the contents of which can be
801
retrieved by _get_log(). We use a real OS file, not an in-memory object,
802
so that it can also capture file IO. When the test completes this file
803
is read into memory and removed from disk.
805
There are also convenience functions to invoke bzr's command-line
806
routine, and to build and check bzr trees.
808
In addition to the usual method of overriding tearDown(), this class also
809
allows subclasses to register cleanup functions via addCleanup, which are
810
run in order as the object is torn down. It's less likely this will be
811
accidentally overlooked.
815
# record lsprof data when performing benchmark calls.
816
_gather_lsprof_in_benchmarks = False
818
def __init__(self, methodName='testMethod'):
819
super(TestCase, self).__init__(methodName)
820
self._directory_isolation = True
821
self.exception_handlers.insert(0,
822
(UnavailableFeature, self._do_unsupported_or_skip))
823
self.exception_handlers.insert(0,
824
(TestNotApplicable, self._do_not_applicable))
827
super(TestCase, self).setUp()
828
for feature in getattr(self, '_test_needs_features', []):
829
self.requireFeature(feature)
830
self._log_contents = None
831
self.addDetail("log", content.Content(content.ContentType("text",
832
"plain", {"charset": "utf8"}),
833
lambda:[self._get_log(keep_log_file=True)]))
834
self._cleanEnvironment()
837
self._benchcalls = []
838
self._benchtime = None
840
self._track_transports()
842
self._clear_debug_flags()
847
pdb.Pdb().set_trace(sys._getframe().f_back)
849
def _clear_debug_flags(self):
850
"""Prevent externally set debug flags affecting tests.
852
Tests that want to use debug flags can just set them in the
853
debug_flags set during setup/teardown.
855
# Start with a copy of the current debug flags we can safely modify.
856
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
857
if 'allow_debug' not in selftest_debug_flags:
858
debug.debug_flags.clear()
859
if 'disable_lock_checks' not in selftest_debug_flags:
860
debug.debug_flags.add('strict_locks')
862
def _clear_hooks(self):
863
# prevent hooks affecting tests
864
self._preserved_hooks = {}
865
for key, factory in hooks.known_hooks.items():
866
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
867
current_hooks = hooks.known_hooks_key_to_object(key)
868
self._preserved_hooks[parent] = (name, current_hooks)
869
self.addCleanup(self._restoreHooks)
870
for key, factory in hooks.known_hooks.items():
871
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
872
setattr(parent, name, factory())
873
# this hook should always be installed
874
request._install_hook()
876
def disable_directory_isolation(self):
877
"""Turn off directory isolation checks."""
878
self._directory_isolation = False
880
def enable_directory_isolation(self):
881
"""Enable directory isolation checks."""
882
self._directory_isolation = True
884
def _silenceUI(self):
885
"""Turn off UI for duration of test"""
886
# by default the UI is off; tests can turn it on if they want it.
887
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
889
def _check_locks(self):
890
"""Check that all lock take/release actions have been paired."""
891
# We always check for mismatched locks. If a mismatch is found, we
892
# fail unless -Edisable_lock_checks is supplied to selftest, in which
893
# case we just print a warning.
895
acquired_locks = [lock for action, lock in self._lock_actions
896
if action == 'acquired']
897
released_locks = [lock for action, lock in self._lock_actions
898
if action == 'released']
899
broken_locks = [lock for action, lock in self._lock_actions
900
if action == 'broken']
901
# trivially, given the tests for lock acquistion and release, if we
902
# have as many in each list, it should be ok. Some lock tests also
903
# break some locks on purpose and should be taken into account by
904
# considering that breaking a lock is just a dirty way of releasing it.
905
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
906
message = ('Different number of acquired and '
907
'released or broken locks. (%s, %s + %s)' %
908
(acquired_locks, released_locks, broken_locks))
909
if not self._lock_check_thorough:
910
# Rather than fail, just warn
911
print "Broken test %s: %s" % (self, message)
915
def _track_locks(self):
916
"""Track lock activity during tests."""
917
self._lock_actions = []
918
if 'disable_lock_checks' in selftest_debug_flags:
919
self._lock_check_thorough = False
921
self._lock_check_thorough = True
923
self.addCleanup(self._check_locks)
924
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
925
self._lock_acquired, None)
926
_mod_lock.Lock.hooks.install_named_hook('lock_released',
927
self._lock_released, None)
928
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
929
self._lock_broken, None)
931
def _lock_acquired(self, result):
932
self._lock_actions.append(('acquired', result))
934
def _lock_released(self, result):
935
self._lock_actions.append(('released', result))
937
def _lock_broken(self, result):
938
self._lock_actions.append(('broken', result))
940
def permit_dir(self, name):
941
"""Permit a directory to be used by this test. See permit_url."""
942
name_transport = _mod_transport.get_transport(name)
943
self.permit_url(name)
944
self.permit_url(name_transport.base)
946
def permit_url(self, url):
947
"""Declare that url is an ok url to use in this test.
949
Do this for memory transports, temporary test directory etc.
951
Do not do this for the current working directory, /tmp, or any other
952
preexisting non isolated url.
954
if not url.endswith('/'):
956
self._bzr_selftest_roots.append(url)
958
def permit_source_tree_branch_repo(self):
959
"""Permit the source tree bzr is running from to be opened.
961
Some code such as bzrlib.version attempts to read from the bzr branch
962
that bzr is executing from (if any). This method permits that directory
963
to be used in the test suite.
965
path = self.get_source_path()
966
self.record_directory_isolation()
969
workingtree.WorkingTree.open(path)
970
except (errors.NotBranchError, errors.NoWorkingTree):
973
self.enable_directory_isolation()
975
def _preopen_isolate_transport(self, transport):
976
"""Check that all transport openings are done in the test work area."""
977
while isinstance(transport, pathfilter.PathFilteringTransport):
978
# Unwrap pathfiltered transports
979
transport = transport.server.backing_transport.clone(
980
transport._filter('.'))
982
# ReadonlySmartTCPServer_for_testing decorates the backing transport
983
# urls it is given by prepending readonly+. This is appropriate as the
984
# client shouldn't know that the server is readonly (or not readonly).
985
# We could register all servers twice, with readonly+ prepending, but
986
# that makes for a long list; this is about the same but easier to
988
if url.startswith('readonly+'):
989
url = url[len('readonly+'):]
990
self._preopen_isolate_url(url)
992
def _preopen_isolate_url(self, url):
993
if not self._directory_isolation:
995
if self._directory_isolation == 'record':
996
self._bzr_selftest_roots.append(url)
998
# This prevents all transports, including e.g. sftp ones backed on disk
999
# from working unless they are explicitly granted permission. We then
1000
# depend on the code that sets up test transports to check that they are
1001
# appropriately isolated and enable their use by calling
1002
# self.permit_transport()
1003
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1004
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1005
% (url, self._bzr_selftest_roots))
1007
def record_directory_isolation(self):
1008
"""Gather accessed directories to permit later access.
1010
This is used for tests that access the branch bzr is running from.
1012
self._directory_isolation = "record"
1014
def start_server(self, transport_server, backing_server=None):
1015
"""Start transport_server for this test.
1017
This starts the server, registers a cleanup for it and permits the
1018
server's urls to be used.
1020
if backing_server is None:
1021
transport_server.start_server()
1023
transport_server.start_server(backing_server)
1024
self.addCleanup(transport_server.stop_server)
1025
# Obtain a real transport because if the server supplies a password, it
1026
# will be hidden from the base on the client side.
1027
t = _mod_transport.get_transport(transport_server.get_url())
1028
# Some transport servers effectively chroot the backing transport;
1029
# others like SFTPServer don't - users of the transport can walk up the
1030
# transport to read the entire backing transport. This wouldn't matter
1031
# except that the workdir tests are given - and that they expect the
1032
# server's url to point at - is one directory under the safety net. So
1033
# Branch operations into the transport will attempt to walk up one
1034
# directory. Chrooting all servers would avoid this but also mean that
1035
# we wouldn't be testing directly against non-root urls. Alternatively
1036
# getting the test framework to start the server with a backing server
1037
# at the actual safety net directory would work too, but this then
1038
# means that the self.get_url/self.get_transport methods would need
1039
# to transform all their results. On balance its cleaner to handle it
1040
# here, and permit a higher url when we have one of these transports.
1041
if t.base.endswith('/work/'):
1042
# we have safety net/test root/work
1043
t = t.clone('../..')
1044
elif isinstance(transport_server,
1045
test_server.SmartTCPServer_for_testing):
1046
# The smart server adds a path similar to work, which is traversed
1047
# up from by the client. But the server is chrooted - the actual
1048
# backing transport is not escaped from, and VFS requests to the
1049
# root will error (because they try to escape the chroot).
1051
while t2.base != t.base:
1054
self.permit_url(t.base)
1056
def _track_transports(self):
1057
"""Install checks for transport usage."""
1058
# TestCase has no safe place it can write to.
1059
self._bzr_selftest_roots = []
1060
# Currently the easiest way to be sure that nothing is going on is to
1061
# hook into bzr dir opening. This leaves a small window of error for
1062
# transport tests, but they are well known, and we can improve on this
1064
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1065
self._preopen_isolate_transport, "Check bzr directories are safe.")
1067
def _ndiff_strings(self, a, b):
1068
"""Return ndiff between two strings containing lines.
1070
A trailing newline is added if missing to make the strings
1072
if b and b[-1] != '\n':
1074
if a and a[-1] != '\n':
1076
difflines = difflib.ndiff(a.splitlines(True),
1078
linejunk=lambda x: False,
1079
charjunk=lambda x: False)
1080
return ''.join(difflines)
1082
def assertEqual(self, a, b, message=''):
1086
except UnicodeError, e:
1087
# If we can't compare without getting a UnicodeError, then
1088
# obviously they are different
1089
mutter('UnicodeError: %s', e)
1092
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1094
pprint.pformat(a), pprint.pformat(b)))
1096
assertEquals = assertEqual
1098
def assertEqualDiff(self, a, b, message=None):
1099
"""Assert two texts are equal, if not raise an exception.
1101
This is intended for use with multi-line strings where it can
1102
be hard to find the differences by eye.
1104
# TODO: perhaps override assertEquals to call this for strings?
1108
message = "texts not equal:\n"
1110
message = 'first string is missing a final newline.\n'
1112
message = 'second string is missing a final newline.\n'
1113
raise AssertionError(message +
1114
self._ndiff_strings(a, b))
1116
def assertEqualMode(self, mode, mode_test):
1117
self.assertEqual(mode, mode_test,
1118
'mode mismatch %o != %o' % (mode, mode_test))
1120
def assertEqualStat(self, expected, actual):
1121
"""assert that expected and actual are the same stat result.
1123
:param expected: A stat result.
1124
:param actual: A stat result.
1125
:raises AssertionError: If the expected and actual stat values differ
1126
other than by atime.
1128
self.assertEqual(expected.st_size, actual.st_size,
1129
'st_size did not match')
1130
self.assertEqual(expected.st_mtime, actual.st_mtime,
1131
'st_mtime did not match')
1132
self.assertEqual(expected.st_ctime, actual.st_ctime,
1133
'st_ctime did not match')
1134
if sys.platform != 'win32':
1135
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1136
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1137
# odd. Regardless we shouldn't actually try to assert anything
1138
# about their values
1139
self.assertEqual(expected.st_dev, actual.st_dev,
1140
'st_dev did not match')
1141
self.assertEqual(expected.st_ino, actual.st_ino,
1142
'st_ino did not match')
1143
self.assertEqual(expected.st_mode, actual.st_mode,
1144
'st_mode did not match')
1146
def assertLength(self, length, obj_with_len):
1147
"""Assert that obj_with_len is of length length."""
1148
if len(obj_with_len) != length:
1149
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1150
length, len(obj_with_len), obj_with_len))
1152
def assertLogsError(self, exception_class, func, *args, **kwargs):
1153
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1155
from bzrlib import trace
1157
orig_log_exception_quietly = trace.log_exception_quietly
1160
orig_log_exception_quietly()
1161
captured.append(sys.exc_info())
1162
trace.log_exception_quietly = capture
1163
func(*args, **kwargs)
1165
trace.log_exception_quietly = orig_log_exception_quietly
1166
self.assertLength(1, captured)
1167
err = captured[0][1]
1168
self.assertIsInstance(err, exception_class)
1171
def assertPositive(self, val):
1172
"""Assert that val is greater than 0."""
1173
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1175
def assertNegative(self, val):
1176
"""Assert that val is less than 0."""
1177
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1179
def assertStartsWith(self, s, prefix):
1180
if not s.startswith(prefix):
1181
raise AssertionError('string %r does not start with %r' % (s, prefix))
1183
def assertEndsWith(self, s, suffix):
1184
"""Asserts that s ends with suffix."""
1185
if not s.endswith(suffix):
1186
raise AssertionError('string %r does not end with %r' % (s, suffix))
1188
def assertContainsRe(self, haystack, needle_re, flags=0):
1189
"""Assert that a contains something matching a regular expression."""
1190
if not re.search(needle_re, haystack, flags):
1191
if '\n' in haystack or len(haystack) > 60:
1192
# a long string, format it in a more readable way
1193
raise AssertionError(
1194
'pattern "%s" not found in\n"""\\\n%s"""\n'
1195
% (needle_re, haystack))
1197
raise AssertionError('pattern "%s" not found in "%s"'
1198
% (needle_re, haystack))
1200
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1201
"""Assert that a does not match a regular expression"""
1202
if re.search(needle_re, haystack, flags):
1203
raise AssertionError('pattern "%s" found in "%s"'
1204
% (needle_re, haystack))
1206
def assertContainsString(self, haystack, needle):
1207
if haystack.find(needle) == -1:
1208
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1210
def assertSubset(self, sublist, superlist):
1211
"""Assert that every entry in sublist is present in superlist."""
1212
missing = set(sublist) - set(superlist)
1213
if len(missing) > 0:
1214
raise AssertionError("value(s) %r not present in container %r" %
1215
(missing, superlist))
1217
def assertListRaises(self, excClass, func, *args, **kwargs):
1218
"""Fail unless excClass is raised when the iterator from func is used.
1220
Many functions can return generators this makes sure
1221
to wrap them in a list() call to make sure the whole generator
1222
is run, and that the proper exception is raised.
1225
list(func(*args, **kwargs))
1229
if getattr(excClass,'__name__', None) is not None:
1230
excName = excClass.__name__
1232
excName = str(excClass)
1233
raise self.failureException, "%s not raised" % excName
1235
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1236
"""Assert that a callable raises a particular exception.
1238
:param excClass: As for the except statement, this may be either an
1239
exception class, or a tuple of classes.
1240
:param callableObj: A callable, will be passed ``*args`` and
1243
Returns the exception so that you can examine it.
1246
callableObj(*args, **kwargs)
1250
if getattr(excClass,'__name__', None) is not None:
1251
excName = excClass.__name__
1254
excName = str(excClass)
1255
raise self.failureException, "%s not raised" % excName
1257
def assertIs(self, left, right, message=None):
1258
if not (left is right):
1259
if message is not None:
1260
raise AssertionError(message)
1262
raise AssertionError("%r is not %r." % (left, right))
1264
def assertIsNot(self, left, right, message=None):
1266
if message is not None:
1267
raise AssertionError(message)
1269
raise AssertionError("%r is %r." % (left, right))
1271
def assertTransportMode(self, transport, path, mode):
1272
"""Fail if a path does not have mode "mode".
1274
If modes are not supported on this transport, the assertion is ignored.
1276
if not transport._can_roundtrip_unix_modebits():
1278
path_stat = transport.stat(path)
1279
actual_mode = stat.S_IMODE(path_stat.st_mode)
1280
self.assertEqual(mode, actual_mode,
1281
'mode of %r incorrect (%s != %s)'
1282
% (path, oct(mode), oct(actual_mode)))
1284
def assertIsSameRealPath(self, path1, path2):
1285
"""Fail if path1 and path2 points to different files"""
1286
self.assertEqual(osutils.realpath(path1),
1287
osutils.realpath(path2),
1288
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1290
def assertIsInstance(self, obj, kls, msg=None):
1291
"""Fail if obj is not an instance of kls
1293
:param msg: Supplementary message to show if the assertion fails.
1295
if not isinstance(obj, kls):
1296
m = "%r is an instance of %s rather than %s" % (
1297
obj, obj.__class__, kls)
1302
def assertFileEqual(self, content, path):
1303
"""Fail if path does not contain 'content'."""
1304
self.failUnlessExists(path)
1305
f = file(path, 'rb')
1310
self.assertEqualDiff(content, s)
1312
def assertDocstring(self, expected_docstring, obj):
1313
"""Fail if obj does not have expected_docstring"""
1315
# With -OO the docstring should be None instead
1316
self.assertIs(obj.__doc__, None)
1318
self.assertEqual(expected_docstring, obj.__doc__)
1320
def failUnlessExists(self, path):
1321
"""Fail unless path or paths, which may be abs or relative, exist."""
1322
if not isinstance(path, basestring):
1324
self.failUnlessExists(p)
1326
self.failUnless(osutils.lexists(path),path+" does not exist")
1328
def failIfExists(self, path):
1329
"""Fail if path or paths, which may be abs or relative, exist."""
1330
if not isinstance(path, basestring):
1332
self.failIfExists(p)
1334
self.failIf(osutils.lexists(path),path+" exists")
1336
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1337
"""A helper for callDeprecated and applyDeprecated.
1339
:param a_callable: A callable to call.
1340
:param args: The positional arguments for the callable
1341
:param kwargs: The keyword arguments for the callable
1342
:return: A tuple (warnings, result). result is the result of calling
1343
a_callable(``*args``, ``**kwargs``).
1346
def capture_warnings(msg, cls=None, stacklevel=None):
1347
# we've hooked into a deprecation specific callpath,
1348
# only deprecations should getting sent via it.
1349
self.assertEqual(cls, DeprecationWarning)
1350
local_warnings.append(msg)
1351
original_warning_method = symbol_versioning.warn
1352
symbol_versioning.set_warning_method(capture_warnings)
1354
result = a_callable(*args, **kwargs)
1356
symbol_versioning.set_warning_method(original_warning_method)
1357
return (local_warnings, result)
1359
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1360
"""Call a deprecated callable without warning the user.
1362
Note that this only captures warnings raised by symbol_versioning.warn,
1363
not other callers that go direct to the warning module.
1365
To test that a deprecated method raises an error, do something like
1368
self.assertRaises(errors.ReservedId,
1369
self.applyDeprecated,
1370
deprecated_in((1, 5, 0)),
1374
:param deprecation_format: The deprecation format that the callable
1375
should have been deprecated with. This is the same type as the
1376
parameter to deprecated_method/deprecated_function. If the
1377
callable is not deprecated with this format, an assertion error
1379
:param a_callable: A callable to call. This may be a bound method or
1380
a regular function. It will be called with ``*args`` and
1382
:param args: The positional arguments for the callable
1383
:param kwargs: The keyword arguments for the callable
1384
:return: The result of a_callable(``*args``, ``**kwargs``)
1386
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1388
expected_first_warning = symbol_versioning.deprecation_string(
1389
a_callable, deprecation_format)
1390
if len(call_warnings) == 0:
1391
self.fail("No deprecation warning generated by call to %s" %
1393
self.assertEqual(expected_first_warning, call_warnings[0])
1396
def callCatchWarnings(self, fn, *args, **kw):
1397
"""Call a callable that raises python warnings.
1399
The caller's responsible for examining the returned warnings.
1401
If the callable raises an exception, the exception is not
1402
caught and propagates up to the caller. In that case, the list
1403
of warnings is not available.
1405
:returns: ([warning_object, ...], fn_result)
1407
# XXX: This is not perfect, because it completely overrides the
1408
# warnings filters, and some code may depend on suppressing particular
1409
# warnings. It's the easiest way to insulate ourselves from -Werror,
1410
# though. -- Andrew, 20071062
1412
def _catcher(message, category, filename, lineno, file=None, line=None):
1413
# despite the name, 'message' is normally(?) a Warning subclass
1415
wlist.append(message)
1416
saved_showwarning = warnings.showwarning
1417
saved_filters = warnings.filters
1419
warnings.showwarning = _catcher
1420
warnings.filters = []
1421
result = fn(*args, **kw)
1423
warnings.showwarning = saved_showwarning
1424
warnings.filters = saved_filters
1425
return wlist, result
1427
def callDeprecated(self, expected, callable, *args, **kwargs):
1428
"""Assert that a callable is deprecated in a particular way.
1430
This is a very precise test for unusual requirements. The
1431
applyDeprecated helper function is probably more suited for most tests
1432
as it allows you to simply specify the deprecation format being used
1433
and will ensure that that is issued for the function being called.
1435
Note that this only captures warnings raised by symbol_versioning.warn,
1436
not other callers that go direct to the warning module. To catch
1437
general warnings, use callCatchWarnings.
1439
:param expected: a list of the deprecation warnings expected, in order
1440
:param callable: The callable to call
1441
:param args: The positional arguments for the callable
1442
:param kwargs: The keyword arguments for the callable
1444
call_warnings, result = self._capture_deprecation_warnings(callable,
1446
self.assertEqual(expected, call_warnings)
1449
def _startLogFile(self):
1450
"""Send bzr and test log messages to a temporary file.
1452
The file is removed as the test is torn down.
1454
self._log_file = StringIO()
1455
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1456
self.addCleanup(self._finishLogFile)
1458
def _finishLogFile(self):
1459
"""Finished with the log file.
1461
Close the file and delete it, unless setKeepLogfile was called.
1463
if bzrlib.trace._trace_file:
1464
# flush the log file, to get all content
1465
bzrlib.trace._trace_file.flush()
1466
bzrlib.trace.pop_log_file(self._log_memento)
1467
# Cache the log result and delete the file on disk
1468
self._get_log(False)
1470
def thisFailsStrictLockCheck(self):
1471
"""It is known that this test would fail with -Dstrict_locks.
1473
By default, all tests are run with strict lock checking unless
1474
-Edisable_lock_checks is supplied. However there are some tests which
1475
we know fail strict locks at this point that have not been fixed.
1476
They should call this function to disable the strict checking.
1478
This should be used sparingly, it is much better to fix the locking
1479
issues rather than papering over the problem by calling this function.
1481
debug.debug_flags.discard('strict_locks')
1483
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1484
"""Overrides an object attribute restoring it after the test.
1486
:param obj: The object that will be mutated.
1488
:param attr_name: The attribute name we want to preserve/override in
1491
:param new: The optional value we want to set the attribute to.
1493
:returns: The actual attr value.
1495
value = getattr(obj, attr_name)
1496
# The actual value is captured by the call below
1497
self.addCleanup(setattr, obj, attr_name, value)
1498
if new is not _unitialized_attr:
1499
setattr(obj, attr_name, new)
1502
def _cleanEnvironment(self):
1504
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1505
'HOME': os.getcwd(),
1506
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1507
# tests do check our impls match APPDATA
1508
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1512
'BZREMAIL': None, # may still be present in the environment
1513
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
1514
'BZR_PROGRESS_BAR': None,
1516
'BZR_PLUGIN_PATH': None,
1517
'BZR_DISABLE_PLUGINS': None,
1518
'BZR_PLUGINS_AT': None,
1519
'BZR_CONCURRENCY': None,
1520
# Make sure that any text ui tests are consistent regardless of
1521
# the environment the test case is run in; you may want tests that
1522
# test other combinations. 'dumb' is a reasonable guess for tests
1523
# going to a pipe or a StringIO.
1527
'BZR_COLUMNS': '80',
1529
'SSH_AUTH_SOCK': None,
1533
'https_proxy': None,
1534
'HTTPS_PROXY': None,
1539
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1540
# least. If you do (care), please update this comment
1544
'BZR_REMOTE_PATH': None,
1545
# Generally speaking, we don't want apport reporting on crashes in
1546
# the test envirnoment unless we're specifically testing apport,
1547
# so that it doesn't leak into the real system environment. We
1548
# use an env var so it propagates to subprocesses.
1549
'APPORT_DISABLE': '1',
1552
self.addCleanup(self._restoreEnvironment)
1553
for name, value in new_env.iteritems():
1554
self._captureVar(name, value)
1556
def _captureVar(self, name, newvalue):
1557
"""Set an environment variable, and reset it when finished."""
1558
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1560
def _restoreEnvironment(self):
1561
for name, value in self._old_env.iteritems():
1562
osutils.set_or_unset_env(name, value)
1564
def _restoreHooks(self):
1565
for klass, (name, hooks) in self._preserved_hooks.items():
1566
setattr(klass, name, hooks)
1568
def knownFailure(self, reason):
1569
"""This test has failed for some known reason."""
1570
raise KnownFailure(reason)
1572
def _do_skip(self, result, reason):
1573
addSkip = getattr(result, 'addSkip', None)
1574
if not callable(addSkip):
1575
result.addSuccess(result)
1577
addSkip(self, reason)
1580
def _do_known_failure(self, result, e):
1581
err = sys.exc_info()
1582
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1583
if addExpectedFailure is not None:
1584
addExpectedFailure(self, err)
1586
result.addSuccess(self)
1589
def _do_not_applicable(self, result, e):
1591
reason = 'No reason given'
1594
addNotApplicable = getattr(result, 'addNotApplicable', None)
1595
if addNotApplicable is not None:
1596
result.addNotApplicable(self, reason)
1598
self._do_skip(result, reason)
1601
def _do_unsupported_or_skip(self, result, e):
1603
addNotSupported = getattr(result, 'addNotSupported', None)
1604
if addNotSupported is not None:
1605
result.addNotSupported(self, reason)
1607
self._do_skip(result, reason)
1609
def time(self, callable, *args, **kwargs):
1610
"""Run callable and accrue the time it takes to the benchmark time.
1612
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1613
this will cause lsprofile statistics to be gathered and stored in
1616
if self._benchtime is None:
1617
self.addDetail('benchtime', content.Content(content.ContentType(
1618
"text", "plain"), lambda:[str(self._benchtime)]))
1622
if not self._gather_lsprof_in_benchmarks:
1623
return callable(*args, **kwargs)
1625
# record this benchmark
1626
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1628
self._benchcalls.append(((callable, args, kwargs), stats))
1631
self._benchtime += time.time() - start
1633
def log(self, *args):
1636
def _get_log(self, keep_log_file=False):
1637
"""Internal helper to get the log from bzrlib.trace for this test.
1639
Please use self.getDetails, or self.get_log to access this in test case
1642
:param keep_log_file: When True, if the log is still a file on disk
1643
leave it as a file on disk. When False, if the log is still a file
1644
on disk, the log file is deleted and the log preserved as
1646
:return: A string containing the log.
1648
if self._log_contents is not None:
1650
self._log_contents.decode('utf8')
1651
except UnicodeDecodeError:
1652
unicodestr = self._log_contents.decode('utf8', 'replace')
1653
self._log_contents = unicodestr.encode('utf8')
1654
return self._log_contents
1655
if self._log_file is not None:
1656
log_contents = self._log_file.getvalue()
1658
log_contents.decode('utf8')
1659
except UnicodeDecodeError:
1660
unicodestr = log_contents.decode('utf8', 'replace')
1661
log_contents = unicodestr.encode('utf8')
1662
if not keep_log_file:
1663
self._log_file = None
1664
# Permit multiple calls to get_log until we clean it up in
1666
self._log_contents = log_contents
1669
return "No log file content."
1672
"""Get a unicode string containing the log from bzrlib.trace.
1674
Undecodable characters are replaced.
1676
return u"".join(self.getDetails()['log'].iter_text())
1678
def requireFeature(self, feature):
1679
"""This test requires a specific feature is available.
1681
:raises UnavailableFeature: When feature is not available.
1683
if not feature.available():
1684
raise UnavailableFeature(feature)
1686
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1688
"""Run bazaar command line, splitting up a string command line."""
1689
if isinstance(args, basestring):
1690
# shlex don't understand unicode strings,
1691
# so args should be plain string (bialix 20070906)
1692
args = list(shlex.split(str(args)))
1693
return self._run_bzr_core(args, retcode=retcode,
1694
encoding=encoding, stdin=stdin, working_dir=working_dir,
1697
def _run_bzr_core(self, args, retcode, encoding, stdin,
1699
# Clear chk_map page cache, because the contents are likely to mask
1701
chk_map.clear_cache()
1702
if encoding is None:
1703
encoding = osutils.get_user_encoding()
1704
stdout = StringIOWrapper()
1705
stderr = StringIOWrapper()
1706
stdout.encoding = encoding
1707
stderr.encoding = encoding
1709
self.log('run bzr: %r', args)
1710
# FIXME: don't call into logging here
1711
handler = logging.StreamHandler(stderr)
1712
handler.setLevel(logging.INFO)
1713
logger = logging.getLogger('')
1714
logger.addHandler(handler)
1715
old_ui_factory = ui.ui_factory
1716
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1719
if working_dir is not None:
1720
cwd = osutils.getcwd()
1721
os.chdir(working_dir)
1725
result = self.apply_redirected(ui.ui_factory.stdin,
1727
bzrlib.commands.run_bzr_catch_user_errors,
1729
except KeyboardInterrupt:
1730
# Reraise KeyboardInterrupt with contents of redirected stdout
1731
# and stderr as arguments, for tests which are interested in
1732
# stdout and stderr and are expecting the exception.
1733
out = stdout.getvalue()
1734
err = stderr.getvalue()
1736
self.log('output:\n%r', out)
1738
self.log('errors:\n%r', err)
1739
raise KeyboardInterrupt(out, err)
1741
logger.removeHandler(handler)
1742
ui.ui_factory = old_ui_factory
1746
out = stdout.getvalue()
1747
err = stderr.getvalue()
1749
self.log('output:\n%r', out)
1751
self.log('errors:\n%r', err)
1752
if retcode is not None:
1753
self.assertEquals(retcode, result,
1754
message='Unexpected return code')
1755
return result, out, err
1757
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1758
working_dir=None, error_regexes=[], output_encoding=None):
1759
"""Invoke bzr, as if it were run from the command line.
1761
The argument list should not include the bzr program name - the
1762
first argument is normally the bzr command. Arguments may be
1763
passed in three ways:
1765
1- A list of strings, eg ["commit", "a"]. This is recommended
1766
when the command contains whitespace or metacharacters, or
1767
is built up at run time.
1769
2- A single string, eg "add a". This is the most convenient
1770
for hardcoded commands.
1772
This runs bzr through the interface that catches and reports
1773
errors, and with logging set to something approximating the
1774
default, so that error reporting can be checked.
1776
This should be the main method for tests that want to exercise the
1777
overall behavior of the bzr application (rather than a unit test
1778
or a functional test of the library.)
1780
This sends the stdout/stderr results into the test's log,
1781
where it may be useful for debugging. See also run_captured.
1783
:keyword stdin: A string to be used as stdin for the command.
1784
:keyword retcode: The status code the command should return;
1786
:keyword working_dir: The directory to run the command in
1787
:keyword error_regexes: A list of expected error messages. If
1788
specified they must be seen in the error output of the command.
1790
retcode, out, err = self._run_bzr_autosplit(
1795
working_dir=working_dir,
1797
self.assertIsInstance(error_regexes, (list, tuple))
1798
for regex in error_regexes:
1799
self.assertContainsRe(err, regex)
1802
def run_bzr_error(self, error_regexes, *args, **kwargs):
1803
"""Run bzr, and check that stderr contains the supplied regexes
1805
:param error_regexes: Sequence of regular expressions which
1806
must each be found in the error output. The relative ordering
1808
:param args: command-line arguments for bzr
1809
:param kwargs: Keyword arguments which are interpreted by run_bzr
1810
This function changes the default value of retcode to be 3,
1811
since in most cases this is run when you expect bzr to fail.
1813
:return: (out, err) The actual output of running the command (in case
1814
you want to do more inspection)
1818
# Make sure that commit is failing because there is nothing to do
1819
self.run_bzr_error(['no changes to commit'],
1820
['commit', '-m', 'my commit comment'])
1821
# Make sure --strict is handling an unknown file, rather than
1822
# giving us the 'nothing to do' error
1823
self.build_tree(['unknown'])
1824
self.run_bzr_error(['Commit refused because there are unknown files'],
1825
['commit', --strict', '-m', 'my commit comment'])
1827
kwargs.setdefault('retcode', 3)
1828
kwargs['error_regexes'] = error_regexes
1829
out, err = self.run_bzr(*args, **kwargs)
1832
def run_bzr_subprocess(self, *args, **kwargs):
1833
"""Run bzr in a subprocess for testing.
1835
This starts a new Python interpreter and runs bzr in there.
1836
This should only be used for tests that have a justifiable need for
1837
this isolation: e.g. they are testing startup time, or signal
1838
handling, or early startup code, etc. Subprocess code can't be
1839
profiled or debugged so easily.
1841
:keyword retcode: The status code that is expected. Defaults to 0. If
1842
None is supplied, the status code is not checked.
1843
:keyword env_changes: A dictionary which lists changes to environment
1844
variables. A value of None will unset the env variable.
1845
The values must be strings. The change will only occur in the
1846
child, so you don't need to fix the environment after running.
1847
:keyword universal_newlines: Convert CRLF => LF
1848
:keyword allow_plugins: By default the subprocess is run with
1849
--no-plugins to ensure test reproducibility. Also, it is possible
1850
for system-wide plugins to create unexpected output on stderr,
1851
which can cause unnecessary test failures.
1853
env_changes = kwargs.get('env_changes', {})
1854
working_dir = kwargs.get('working_dir', None)
1855
allow_plugins = kwargs.get('allow_plugins', False)
1857
if isinstance(args[0], list):
1859
elif isinstance(args[0], basestring):
1860
args = list(shlex.split(args[0]))
1862
raise ValueError("passing varargs to run_bzr_subprocess")
1863
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1864
working_dir=working_dir,
1865
allow_plugins=allow_plugins)
1866
# We distinguish between retcode=None and retcode not passed.
1867
supplied_retcode = kwargs.get('retcode', 0)
1868
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1869
universal_newlines=kwargs.get('universal_newlines', False),
1872
def start_bzr_subprocess(self, process_args, env_changes=None,
1873
skip_if_plan_to_signal=False,
1875
allow_plugins=False):
1876
"""Start bzr in a subprocess for testing.
1878
This starts a new Python interpreter and runs bzr in there.
1879
This should only be used for tests that have a justifiable need for
1880
this isolation: e.g. they are testing startup time, or signal
1881
handling, or early startup code, etc. Subprocess code can't be
1882
profiled or debugged so easily.
1884
:param process_args: a list of arguments to pass to the bzr executable,
1885
for example ``['--version']``.
1886
:param env_changes: A dictionary which lists changes to environment
1887
variables. A value of None will unset the env variable.
1888
The values must be strings. The change will only occur in the
1889
child, so you don't need to fix the environment after running.
1890
:param skip_if_plan_to_signal: raise TestSkipped when true and system
1891
doesn't support signalling subprocesses.
1892
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1894
:returns: Popen object for the started process.
1896
if skip_if_plan_to_signal:
1897
if os.name != "posix":
1898
raise TestSkipped("Sending signals not supported")
1900
if env_changes is None:
1904
def cleanup_environment():
1905
for env_var, value in env_changes.iteritems():
1906
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1908
def restore_environment():
1909
for env_var, value in old_env.iteritems():
1910
osutils.set_or_unset_env(env_var, value)
1912
bzr_path = self.get_bzr_path()
1915
if working_dir is not None:
1916
cwd = osutils.getcwd()
1917
os.chdir(working_dir)
1920
# win32 subprocess doesn't support preexec_fn
1921
# so we will avoid using it on all platforms, just to
1922
# make sure the code path is used, and we don't break on win32
1923
cleanup_environment()
1924
command = [sys.executable]
1925
# frozen executables don't need the path to bzr
1926
if getattr(sys, "frozen", None) is None:
1927
command.append(bzr_path)
1928
if not allow_plugins:
1929
command.append('--no-plugins')
1930
command.extend(process_args)
1931
process = self._popen(command, stdin=subprocess.PIPE,
1932
stdout=subprocess.PIPE,
1933
stderr=subprocess.PIPE)
1935
restore_environment()
1941
def _popen(self, *args, **kwargs):
1942
"""Place a call to Popen.
1944
Allows tests to override this method to intercept the calls made to
1945
Popen for introspection.
1947
return subprocess.Popen(*args, **kwargs)
1949
def get_source_path(self):
1950
"""Return the path of the directory containing bzrlib."""
1951
return os.path.dirname(os.path.dirname(bzrlib.__file__))
1953
def get_bzr_path(self):
1954
"""Return the path of the 'bzr' executable for this test suite."""
1955
bzr_path = os.path.join(self.get_source_path(), "bzr")
1956
if not os.path.isfile(bzr_path):
1957
# We are probably installed. Assume sys.argv is the right file
1958
bzr_path = sys.argv[0]
1961
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1962
universal_newlines=False, process_args=None):
1963
"""Finish the execution of process.
1965
:param process: the Popen object returned from start_bzr_subprocess.
1966
:param retcode: The status code that is expected. Defaults to 0. If
1967
None is supplied, the status code is not checked.
1968
:param send_signal: an optional signal to send to the process.
1969
:param universal_newlines: Convert CRLF => LF
1970
:returns: (stdout, stderr)
1972
if send_signal is not None:
1973
os.kill(process.pid, send_signal)
1974
out, err = process.communicate()
1976
if universal_newlines:
1977
out = out.replace('\r\n', '\n')
1978
err = err.replace('\r\n', '\n')
1980
if retcode is not None and retcode != process.returncode:
1981
if process_args is None:
1982
process_args = "(unknown args)"
1983
mutter('Output of bzr %s:\n%s', process_args, out)
1984
mutter('Error for bzr %s:\n%s', process_args, err)
1985
self.fail('Command bzr %s failed with retcode %s != %s'
1986
% (process_args, retcode, process.returncode))
1989
def check_inventory_shape(self, inv, shape):
1990
"""Compare an inventory to a list of expected names.
1992
Fail if they are not precisely equal.
1995
shape = list(shape) # copy
1996
for path, ie in inv.entries():
1997
name = path.replace('\\', '/')
1998
if ie.kind == 'directory':
2005
self.fail("expected paths not found in inventory: %r" % shape)
2007
self.fail("unexpected paths found in inventory: %r" % extras)
2009
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2010
a_callable=None, *args, **kwargs):
2011
"""Call callable with redirected std io pipes.
2013
Returns the return code."""
2014
if not callable(a_callable):
2015
raise ValueError("a_callable must be callable.")
2017
stdin = StringIO("")
2019
if getattr(self, "_log_file", None) is not None:
2020
stdout = self._log_file
2024
if getattr(self, "_log_file", None is not None):
2025
stderr = self._log_file
2028
real_stdin = sys.stdin
2029
real_stdout = sys.stdout
2030
real_stderr = sys.stderr
2035
return a_callable(*args, **kwargs)
2037
sys.stdout = real_stdout
2038
sys.stderr = real_stderr
2039
sys.stdin = real_stdin
2041
def reduceLockdirTimeout(self):
2042
"""Reduce the default lock timeout for the duration of the test, so that
2043
if LockContention occurs during a test, it does so quickly.
2045
Tests that expect to provoke LockContention errors should call this.
2047
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2049
def make_utf8_encoded_stringio(self, encoding_type=None):
2050
"""Return a StringIOWrapper instance, that will encode Unicode
2053
if encoding_type is None:
2054
encoding_type = 'strict'
2056
output_encoding = 'utf-8'
2057
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2058
sio.encoding = output_encoding
2061
def disable_verb(self, verb):
2062
"""Disable a smart server verb for one test."""
2063
from bzrlib.smart import request
2064
request_handlers = request.request_handlers
2065
orig_method = request_handlers.get(verb)
2066
request_handlers.remove(verb)
2067
self.addCleanup(request_handlers.register, verb, orig_method)
2070
class CapturedCall(object):
2071
"""A helper for capturing smart server calls for easy debug analysis."""
2073
def __init__(self, params, prefix_length):
2074
"""Capture the call with params and skip prefix_length stack frames."""
2077
# The last 5 frames are the __init__, the hook frame, and 3 smart
2078
# client frames. Beyond this we could get more clever, but this is good
2080
stack = traceback.extract_stack()[prefix_length:-5]
2081
self.stack = ''.join(traceback.format_list(stack))
2084
return self.call.method
2087
return self.call.method
2093
class TestCaseWithMemoryTransport(TestCase):
2094
"""Common test class for tests that do not need disk resources.
2096
Tests that need disk resources should derive from TestCaseWithTransport.
2098
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2100
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2101
a directory which does not exist. This serves to help ensure test isolation
2102
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2103
must exist. However, TestCaseWithMemoryTransport does not offer local
2104
file defaults for the transport in tests, nor does it obey the command line
2105
override, so tests that accidentally write to the common directory should
2108
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2109
a .bzr directory that stops us ascending higher into the filesystem.
2115
def __init__(self, methodName='runTest'):
2116
# allow test parameterization after test construction and before test
2117
# execution. Variables that the parameterizer sets need to be
2118
# ones that are not set by setUp, or setUp will trash them.
2119
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2120
self.vfs_transport_factory = default_transport
2121
self.transport_server = None
2122
self.transport_readonly_server = None
2123
self.__vfs_server = None
2125
def get_transport(self, relpath=None):
2126
"""Return a writeable transport.
2128
This transport is for the test scratch space relative to
2131
:param relpath: a path relative to the base url.
2133
t = _mod_transport.get_transport(self.get_url(relpath))
2134
self.assertFalse(t.is_readonly())
2137
def get_readonly_transport(self, relpath=None):
2138
"""Return a readonly transport for the test scratch space
2140
This can be used to test that operations which should only need
2141
readonly access in fact do not try to write.
2143
:param relpath: a path relative to the base url.
2145
t = _mod_transport.get_transport(self.get_readonly_url(relpath))
2146
self.assertTrue(t.is_readonly())
2149
def create_transport_readonly_server(self):
2150
"""Create a transport server from class defined at init.
2152
This is mostly a hook for daughter classes.
2154
return self.transport_readonly_server()
2156
def get_readonly_server(self):
2157
"""Get the server instance for the readonly transport
2159
This is useful for some tests with specific servers to do diagnostics.
2161
if self.__readonly_server is None:
2162
if self.transport_readonly_server is None:
2163
# readonly decorator requested
2164
self.__readonly_server = test_server.ReadonlyServer()
2166
# explicit readonly transport.
2167
self.__readonly_server = self.create_transport_readonly_server()
2168
self.start_server(self.__readonly_server,
2169
self.get_vfs_only_server())
2170
return self.__readonly_server
2172
def get_readonly_url(self, relpath=None):
2173
"""Get a URL for the readonly transport.
2175
This will either be backed by '.' or a decorator to the transport
2176
used by self.get_url()
2177
relpath provides for clients to get a path relative to the base url.
2178
These should only be downwards relative, not upwards.
2180
base = self.get_readonly_server().get_url()
2181
return self._adjust_url(base, relpath)
2183
def get_vfs_only_server(self):
2184
"""Get the vfs only read/write server instance.
2186
This is useful for some tests with specific servers that need
2189
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2190
is no means to override it.
2192
if self.__vfs_server is None:
2193
self.__vfs_server = memory.MemoryServer()
2194
self.start_server(self.__vfs_server)
2195
return self.__vfs_server
2197
def get_server(self):
2198
"""Get the read/write server instance.
2200
This is useful for some tests with specific servers that need
2203
This is built from the self.transport_server factory. If that is None,
2204
then the self.get_vfs_server is returned.
2206
if self.__server is None:
2207
if (self.transport_server is None or self.transport_server is
2208
self.vfs_transport_factory):
2209
self.__server = self.get_vfs_only_server()
2211
# bring up a decorated means of access to the vfs only server.
2212
self.__server = self.transport_server()
2213
self.start_server(self.__server, self.get_vfs_only_server())
2214
return self.__server
2216
def _adjust_url(self, base, relpath):
2217
"""Get a URL (or maybe a path) for the readwrite transport.
2219
This will either be backed by '.' or to an equivalent non-file based
2221
relpath provides for clients to get a path relative to the base url.
2222
These should only be downwards relative, not upwards.
2224
if relpath is not None and relpath != '.':
2225
if not base.endswith('/'):
2227
# XXX: Really base should be a url; we did after all call
2228
# get_url()! But sometimes it's just a path (from
2229
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2230
# to a non-escaped local path.
2231
if base.startswith('./') or base.startswith('/'):
2234
base += urlutils.escape(relpath)
2237
def get_url(self, relpath=None):
2238
"""Get a URL (or maybe a path) for the readwrite transport.
2240
This will either be backed by '.' or to an equivalent non-file based
2242
relpath provides for clients to get a path relative to the base url.
2243
These should only be downwards relative, not upwards.
2245
base = self.get_server().get_url()
2246
return self._adjust_url(base, relpath)
2248
def get_vfs_only_url(self, relpath=None):
2249
"""Get a URL (or maybe a path for the plain old vfs transport.
2251
This will never be a smart protocol. It always has all the
2252
capabilities of the local filesystem, but it might actually be a
2253
MemoryTransport or some other similar virtual filesystem.
2255
This is the backing transport (if any) of the server returned by
2256
get_url and get_readonly_url.
2258
:param relpath: provides for clients to get a path relative to the base
2259
url. These should only be downwards relative, not upwards.
2262
base = self.get_vfs_only_server().get_url()
2263
return self._adjust_url(base, relpath)
2265
def _create_safety_net(self):
2266
"""Make a fake bzr directory.
2268
This prevents any tests propagating up onto the TEST_ROOT directory's
2271
root = TestCaseWithMemoryTransport.TEST_ROOT
2272
bzrdir.BzrDir.create_standalone_workingtree(root)
2274
def _check_safety_net(self):
2275
"""Check that the safety .bzr directory have not been touched.
2277
_make_test_root have created a .bzr directory to prevent tests from
2278
propagating. This method ensures than a test did not leaked.
2280
root = TestCaseWithMemoryTransport.TEST_ROOT
2281
self.permit_url(_mod_transport.get_transport(root).base)
2282
wt = workingtree.WorkingTree.open(root)
2283
last_rev = wt.last_revision()
2284
if last_rev != 'null:':
2285
# The current test have modified the /bzr directory, we need to
2286
# recreate a new one or all the followng tests will fail.
2287
# If you need to inspect its content uncomment the following line
2288
# import pdb; pdb.set_trace()
2289
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2290
self._create_safety_net()
2291
raise AssertionError('%s/.bzr should not be modified' % root)
2293
def _make_test_root(self):
2294
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2295
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2296
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2298
TestCaseWithMemoryTransport.TEST_ROOT = root
2300
self._create_safety_net()
2302
# The same directory is used by all tests, and we're not
2303
# specifically told when all tests are finished. This will do.
2304
atexit.register(_rmtree_temp_dir, root)
2306
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2307
self.addCleanup(self._check_safety_net)
2309
def makeAndChdirToTestDir(self):
2310
"""Create a temporary directories for this one test.
2312
This must set self.test_home_dir and self.test_dir and chdir to
2315
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2317
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2318
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2319
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2320
self.permit_dir(self.test_dir)
2322
def make_branch(self, relpath, format=None):
2323
"""Create a branch on the transport at relpath."""
2324
repo = self.make_repository(relpath, format=format)
2325
return repo.bzrdir.create_branch()
2327
def make_bzrdir(self, relpath, format=None):
2329
# might be a relative or absolute path
2330
maybe_a_url = self.get_url(relpath)
2331
segments = maybe_a_url.rsplit('/', 1)
2332
t = _mod_transport.get_transport(maybe_a_url)
2333
if len(segments) > 1 and segments[-1] not in ('', '.'):
2337
if isinstance(format, basestring):
2338
format = bzrdir.format_registry.make_bzrdir(format)
2339
return format.initialize_on_transport(t)
2340
except errors.UninitializableFormat:
2341
raise TestSkipped("Format %s is not initializable." % format)
2343
def make_repository(self, relpath, shared=False, format=None):
2344
"""Create a repository on our default transport at relpath.
2346
Note that relpath must be a relative path, not a full url.
2348
# FIXME: If you create a remoterepository this returns the underlying
2349
# real format, which is incorrect. Actually we should make sure that
2350
# RemoteBzrDir returns a RemoteRepository.
2351
# maybe mbp 20070410
2352
made_control = self.make_bzrdir(relpath, format=format)
2353
return made_control.create_repository(shared=shared)
2355
def make_smart_server(self, path, backing_server=None):
2356
if backing_server is None:
2357
backing_server = self.get_server()
2358
smart_server = test_server.SmartTCPServer_for_testing()
2359
self.start_server(smart_server, backing_server)
2360
remote_transport = _mod_transport.get_transport(smart_server.get_url()
2362
return remote_transport
2364
def make_branch_and_memory_tree(self, relpath, format=None):
2365
"""Create a branch on the default transport and a MemoryTree for it."""
2366
b = self.make_branch(relpath, format=format)
2367
return memorytree.MemoryTree.create_on_branch(b)
2369
def make_branch_builder(self, relpath, format=None):
2370
branch = self.make_branch(relpath, format=format)
2371
return branchbuilder.BranchBuilder(branch=branch)
2373
def overrideEnvironmentForTesting(self):
2374
test_home_dir = self.test_home_dir
2375
if isinstance(test_home_dir, unicode):
2376
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2377
os.environ['HOME'] = test_home_dir
2378
os.environ['BZR_HOME'] = test_home_dir
2381
super(TestCaseWithMemoryTransport, self).setUp()
2382
# Ensure that ConnectedTransport doesn't leak sockets
2383
def get_transport_with_cleanup(*args, **kwargs):
2384
t = orig_get_transport(*args, **kwargs)
2385
if isinstance(t, _mod_transport.ConnectedTransport):
2386
self.addCleanup(t.disconnect)
2389
orig_get_transport = self.overrideAttr(_mod_transport, 'get_transport',
2390
get_transport_with_cleanup)
2391
self._make_test_root()
2392
self.addCleanup(os.chdir, os.getcwdu())
2393
self.makeAndChdirToTestDir()
2394
self.overrideEnvironmentForTesting()
2395
self.__readonly_server = None
2396
self.__server = None
2397
self.reduceLockdirTimeout()
2399
def setup_smart_server_with_call_log(self):
2400
"""Sets up a smart server as the transport server with a call log."""
2401
self.transport_server = test_server.SmartTCPServer_for_testing
2402
self.hpss_calls = []
2404
# Skip the current stack down to the caller of
2405
# setup_smart_server_with_call_log
2406
prefix_length = len(traceback.extract_stack()) - 2
2407
def capture_hpss_call(params):
2408
self.hpss_calls.append(
2409
CapturedCall(params, prefix_length))
2410
client._SmartClient.hooks.install_named_hook(
2411
'call', capture_hpss_call, None)
2413
def reset_smart_call_log(self):
2414
self.hpss_calls = []
2417
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2418
"""Derived class that runs a test within a temporary directory.
2420
This is useful for tests that need to create a branch, etc.
2422
The directory is created in a slightly complex way: for each
2423
Python invocation, a new temporary top-level directory is created.
2424
All test cases create their own directory within that. If the
2425
tests complete successfully, the directory is removed.
2427
:ivar test_base_dir: The path of the top-level directory for this
2428
test, which contains a home directory and a work directory.
2430
:ivar test_home_dir: An initially empty directory under test_base_dir
2431
which is used as $HOME for this test.
2433
:ivar test_dir: A directory under test_base_dir used as the current
2434
directory when the test proper is run.
2437
OVERRIDE_PYTHON = 'python'
2439
def check_file_contents(self, filename, expect):
2440
self.log("check contents of file %s" % filename)
2446
if contents != expect:
2447
self.log("expected: %r" % expect)
2448
self.log("actually: %r" % contents)
2449
self.fail("contents of %s not as expected" % filename)
2451
def _getTestDirPrefix(self):
2452
# create a directory within the top level test directory
2453
if sys.platform in ('win32', 'cygwin'):
2454
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2455
# windows is likely to have path-length limits so use a short name
2456
name_prefix = name_prefix[-30:]
2458
name_prefix = re.sub('[/]', '_', self.id())
2461
def makeAndChdirToTestDir(self):
2462
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2464
For TestCaseInTempDir we create a temporary directory based on the test
2465
name and then create two subdirs - test and home under it.
2467
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2468
self._getTestDirPrefix())
2470
for i in range(100):
2471
if os.path.exists(name):
2472
name = name_prefix + '_' + str(i)
2474
# now create test and home directories within this dir
2475
self.test_base_dir = name
2476
self.addCleanup(self.deleteTestDir)
2477
os.mkdir(self.test_base_dir)
2479
self.permit_dir(self.test_base_dir)
2480
# 'sprouting' and 'init' of a branch both walk up the tree to find
2481
# stacking policy to honour; create a bzr dir with an unshared
2482
# repository (but not a branch - our code would be trying to escape
2483
# then!) to stop them, and permit it to be read.
2484
# control = bzrdir.BzrDir.create(self.test_base_dir)
2485
# control.create_repository()
2486
self.test_home_dir = self.test_base_dir + '/home'
2487
os.mkdir(self.test_home_dir)
2488
self.test_dir = self.test_base_dir + '/work'
2489
os.mkdir(self.test_dir)
2490
os.chdir(self.test_dir)
2491
# put name of test inside
2492
f = file(self.test_base_dir + '/name', 'w')
2498
def deleteTestDir(self):
2499
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2500
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2502
def build_tree(self, shape, line_endings='binary', transport=None):
2503
"""Build a test tree according to a pattern.
2505
shape is a sequence of file specifications. If the final
2506
character is '/', a directory is created.
2508
This assumes that all the elements in the tree being built are new.
2510
This doesn't add anything to a branch.
2512
:type shape: list or tuple.
2513
:param line_endings: Either 'binary' or 'native'
2514
in binary mode, exact contents are written in native mode, the
2515
line endings match the default platform endings.
2516
:param transport: A transport to write to, for building trees on VFS's.
2517
If the transport is readonly or None, "." is opened automatically.
2520
if type(shape) not in (list, tuple):
2521
raise AssertionError("Parameter 'shape' should be "
2522
"a list or a tuple. Got %r instead" % (shape,))
2523
# It's OK to just create them using forward slashes on windows.
2524
if transport is None or transport.is_readonly():
2525
transport = _mod_transport.get_transport(".")
2527
self.assertIsInstance(name, basestring)
2529
transport.mkdir(urlutils.escape(name[:-1]))
2531
if line_endings == 'binary':
2533
elif line_endings == 'native':
2536
raise errors.BzrError(
2537
'Invalid line ending request %r' % line_endings)
2538
content = "contents of %s%s" % (name.encode('utf-8'), end)
2539
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2541
build_tree_contents = staticmethod(treeshape.build_tree_contents)
2543
def assertInWorkingTree(self, path, root_path='.', tree=None):
2544
"""Assert whether path or paths are in the WorkingTree"""
2546
tree = workingtree.WorkingTree.open(root_path)
2547
if not isinstance(path, basestring):
2549
self.assertInWorkingTree(p, tree=tree)
2551
self.assertIsNot(tree.path2id(path), None,
2552
path+' not in working tree.')
2554
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2555
"""Assert whether path or paths are not in the WorkingTree"""
2557
tree = workingtree.WorkingTree.open(root_path)
2558
if not isinstance(path, basestring):
2560
self.assertNotInWorkingTree(p,tree=tree)
2562
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2565
class TestCaseWithTransport(TestCaseInTempDir):
2566
"""A test case that provides get_url and get_readonly_url facilities.
2568
These back onto two transport servers, one for readonly access and one for
2571
If no explicit class is provided for readonly access, a
2572
ReadonlyTransportDecorator is used instead which allows the use of non disk
2573
based read write transports.
2575
If an explicit class is provided for readonly access, that server and the
2576
readwrite one must both define get_url() as resolving to os.getcwd().
2579
def get_vfs_only_server(self):
2580
"""See TestCaseWithMemoryTransport.
2582
This is useful for some tests with specific servers that need
2585
if self.__vfs_server is None:
2586
self.__vfs_server = self.vfs_transport_factory()
2587
self.start_server(self.__vfs_server)
2588
return self.__vfs_server
2590
def make_branch_and_tree(self, relpath, format=None):
2591
"""Create a branch on the transport and a tree locally.
2593
If the transport is not a LocalTransport, the Tree can't be created on
2594
the transport. In that case if the vfs_transport_factory is
2595
LocalURLServer the working tree is created in the local
2596
directory backing the transport, and the returned tree's branch and
2597
repository will also be accessed locally. Otherwise a lightweight
2598
checkout is created and returned.
2600
We do this because we can't physically create a tree in the local
2601
path, with a branch reference to the transport_factory url, and
2602
a branch + repository in the vfs_transport, unless the vfs_transport
2603
namespace is distinct from the local disk - the two branch objects
2604
would collide. While we could construct a tree with its branch object
2605
pointing at the transport_factory transport in memory, reopening it
2606
would behaving unexpectedly, and has in the past caused testing bugs
2607
when we tried to do it that way.
2609
:param format: The BzrDirFormat.
2610
:returns: the WorkingTree.
2612
# TODO: always use the local disk path for the working tree,
2613
# this obviously requires a format that supports branch references
2614
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2616
b = self.make_branch(relpath, format=format)
2618
return b.bzrdir.create_workingtree()
2619
except errors.NotLocalUrl:
2620
# We can only make working trees locally at the moment. If the
2621
# transport can't support them, then we keep the non-disk-backed
2622
# branch and create a local checkout.
2623
if self.vfs_transport_factory is test_server.LocalURLServer:
2624
# the branch is colocated on disk, we cannot create a checkout.
2625
# hopefully callers will expect this.
2626
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2627
wt = local_controldir.create_workingtree()
2628
if wt.branch._format != b._format:
2630
# Make sure that assigning to wt._branch fixes wt.branch,
2631
# in case the implementation details of workingtree objects
2633
self.assertIs(b, wt.branch)
2636
return b.create_checkout(relpath, lightweight=True)
2638
def assertIsDirectory(self, relpath, transport):
2639
"""Assert that relpath within transport is a directory.
2641
This may not be possible on all transports; in that case it propagates
2642
a TransportNotPossible.
2645
mode = transport.stat(relpath).st_mode
2646
except errors.NoSuchFile:
2647
self.fail("path %s is not a directory; no such file"
2649
if not stat.S_ISDIR(mode):
2650
self.fail("path %s is not a directory; has mode %#o"
2653
def assertTreesEqual(self, left, right):
2654
"""Check that left and right have the same content and properties."""
2655
# we use a tree delta to check for equality of the content, and we
2656
# manually check for equality of other things such as the parents list.
2657
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2658
differences = left.changes_from(right)
2659
self.assertFalse(differences.has_changed(),
2660
"Trees %r and %r are different: %r" % (left, right, differences))
2663
super(TestCaseWithTransport, self).setUp()
2664
self.__vfs_server = None
2666
def disable_missing_extensions_warning(self):
2667
"""Some tests expect a precise stderr content.
2669
There is no point in forcing them to duplicate the extension related
2672
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2675
class ChrootedTestCase(TestCaseWithTransport):
2676
"""A support class that provides readonly urls outside the local namespace.
2678
This is done by checking if self.transport_server is a MemoryServer. if it
2679
is then we are chrooted already, if it is not then an HttpServer is used
2682
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2683
be used without needed to redo it when a different
2684
subclass is in use ?
2688
from bzrlib.tests import http_server
2689
super(ChrootedTestCase, self).setUp()
2690
if not self.vfs_transport_factory == memory.MemoryServer:
2691
self.transport_readonly_server = http_server.HttpServer
2694
def condition_id_re(pattern):
2695
"""Create a condition filter which performs a re check on a test's id.
2697
:param pattern: A regular expression string.
2698
:return: A callable that returns True if the re matches.
2700
filter_re = re.compile(pattern, 0)
2701
def condition(test):
2703
return filter_re.search(test_id)
2707
def condition_isinstance(klass_or_klass_list):
2708
"""Create a condition filter which returns isinstance(param, klass).
2710
:return: A callable which when called with one parameter obj return the
2711
result of isinstance(obj, klass_or_klass_list).
2714
return isinstance(obj, klass_or_klass_list)
2718
def condition_id_in_list(id_list):
2719
"""Create a condition filter which verify that test's id in a list.
2721
:param id_list: A TestIdList object.
2722
:return: A callable that returns True if the test's id appears in the list.
2724
def condition(test):
2725
return id_list.includes(test.id())
2729
def condition_id_startswith(starts):
2730
"""Create a condition filter verifying that test's id starts with a string.
2732
:param starts: A list of string.
2733
:return: A callable that returns True if the test's id starts with one of
2736
def condition(test):
2737
for start in starts:
2738
if test.id().startswith(start):
2744
def exclude_tests_by_condition(suite, condition):
2745
"""Create a test suite which excludes some tests from suite.
2747
:param suite: The suite to get tests from.
2748
:param condition: A callable whose result evaluates True when called with a
2749
test case which should be excluded from the result.
2750
:return: A suite which contains the tests found in suite that fail
2754
for test in iter_suite_tests(suite):
2755
if not condition(test):
2757
return TestUtil.TestSuite(result)
2760
def filter_suite_by_condition(suite, condition):
2761
"""Create a test suite by filtering another one.
2763
:param suite: The source suite.
2764
:param condition: A callable whose result evaluates True when called with a
2765
test case which should be included in the result.
2766
:return: A suite which contains the tests found in suite that pass
2770
for test in iter_suite_tests(suite):
2773
return TestUtil.TestSuite(result)
2776
def filter_suite_by_re(suite, pattern):
2777
"""Create a test suite by filtering another one.
2779
:param suite: the source suite
2780
:param pattern: pattern that names must match
2781
:returns: the newly created suite
2783
condition = condition_id_re(pattern)
2784
result_suite = filter_suite_by_condition(suite, condition)
2788
def filter_suite_by_id_list(suite, test_id_list):
2789
"""Create a test suite by filtering another one.
2791
:param suite: The source suite.
2792
:param test_id_list: A list of the test ids to keep as strings.
2793
:returns: the newly created suite
2795
condition = condition_id_in_list(test_id_list)
2796
result_suite = filter_suite_by_condition(suite, condition)
2800
def filter_suite_by_id_startswith(suite, start):
2801
"""Create a test suite by filtering another one.
2803
:param suite: The source suite.
2804
:param start: A list of string the test id must start with one of.
2805
:returns: the newly created suite
2807
condition = condition_id_startswith(start)
2808
result_suite = filter_suite_by_condition(suite, condition)
2812
def exclude_tests_by_re(suite, pattern):
2813
"""Create a test suite which excludes some tests from suite.
2815
:param suite: The suite to get tests from.
2816
:param pattern: A regular expression string. Test ids that match this
2817
pattern will be excluded from the result.
2818
:return: A TestSuite that contains all the tests from suite without the
2819
tests that matched pattern. The order of tests is the same as it was in
2822
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2825
def preserve_input(something):
2826
"""A helper for performing test suite transformation chains.
2828
:param something: Anything you want to preserve.
2834
def randomize_suite(suite):
2835
"""Return a new TestSuite with suite's tests in random order.
2837
The tests in the input suite are flattened into a single suite in order to
2838
accomplish this. Any nested TestSuites are removed to provide global
2841
tests = list(iter_suite_tests(suite))
2842
random.shuffle(tests)
2843
return TestUtil.TestSuite(tests)
2846
def split_suite_by_condition(suite, condition):
2847
"""Split a test suite into two by a condition.
2849
:param suite: The suite to split.
2850
:param condition: The condition to match on. Tests that match this
2851
condition are returned in the first test suite, ones that do not match
2852
are in the second suite.
2853
:return: A tuple of two test suites, where the first contains tests from
2854
suite matching the condition, and the second contains the remainder
2855
from suite. The order within each output suite is the same as it was in
2860
for test in iter_suite_tests(suite):
2862
matched.append(test)
2864
did_not_match.append(test)
2865
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2868
def split_suite_by_re(suite, pattern):
2869
"""Split a test suite into two by a regular expression.
2871
:param suite: The suite to split.
2872
:param pattern: A regular expression string. Test ids that match this
2873
pattern will be in the first test suite returned, and the others in the
2874
second test suite returned.
2875
:return: A tuple of two test suites, where the first contains tests from
2876
suite matching pattern, and the second contains the remainder from
2877
suite. The order within each output suite is the same as it was in
2880
return split_suite_by_condition(suite, condition_id_re(pattern))
2883
def run_suite(suite, name='test', verbose=False, pattern=".*",
2884
stop_on_failure=False,
2885
transport=None, lsprof_timed=None, bench_history=None,
2886
matching_tests_first=None,
2889
exclude_pattern=None,
2892
suite_decorators=None,
2894
result_decorators=None,
2896
"""Run a test suite for bzr selftest.
2898
:param runner_class: The class of runner to use. Must support the
2899
constructor arguments passed by run_suite which are more than standard
2901
:return: A boolean indicating success.
2903
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2908
if runner_class is None:
2909
runner_class = TextTestRunner
2912
runner = runner_class(stream=stream,
2914
verbosity=verbosity,
2915
bench_history=bench_history,
2917
result_decorators=result_decorators,
2919
runner.stop_on_failure=stop_on_failure
2920
# built in decorator factories:
2922
random_order(random_seed, runner),
2923
exclude_tests(exclude_pattern),
2925
if matching_tests_first:
2926
decorators.append(tests_first(pattern))
2928
decorators.append(filter_tests(pattern))
2929
if suite_decorators:
2930
decorators.extend(suite_decorators)
2931
# tell the result object how many tests will be running: (except if
2932
# --parallel=fork is being used. Robert said he will provide a better
2933
# progress design later -- vila 20090817)
2934
if fork_decorator not in decorators:
2935
decorators.append(CountingDecorator)
2936
for decorator in decorators:
2937
suite = decorator(suite)
2939
# Done after test suite decoration to allow randomisation etc
2940
# to take effect, though that is of marginal benefit.
2942
stream.write("Listing tests only ...\n")
2943
for t in iter_suite_tests(suite):
2944
stream.write("%s\n" % (t.id()))
2946
result = runner.run(suite)
2948
return result.wasStrictlySuccessful()
2950
return result.wasSuccessful()
2953
# A registry where get() returns a suite decorator.
2954
parallel_registry = registry.Registry()
2957
def fork_decorator(suite):
2958
if getattr(os, "fork", None) is None:
2959
raise errors.BzrCommandError("platform does not support fork,"
2960
" try --parallel=subprocess instead.")
2961
concurrency = osutils.local_concurrency()
2962
if concurrency == 1:
2964
from testtools import ConcurrentTestSuite
2965
return ConcurrentTestSuite(suite, fork_for_tests)
2966
parallel_registry.register('fork', fork_decorator)
2969
def subprocess_decorator(suite):
2970
concurrency = osutils.local_concurrency()
2971
if concurrency == 1:
2973
from testtools import ConcurrentTestSuite
2974
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2975
parallel_registry.register('subprocess', subprocess_decorator)
2978
def exclude_tests(exclude_pattern):
2979
"""Return a test suite decorator that excludes tests."""
2980
if exclude_pattern is None:
2981
return identity_decorator
2982
def decorator(suite):
2983
return ExcludeDecorator(suite, exclude_pattern)
2987
def filter_tests(pattern):
2989
return identity_decorator
2990
def decorator(suite):
2991
return FilterTestsDecorator(suite, pattern)
2995
def random_order(random_seed, runner):
2996
"""Return a test suite decorator factory for randomising tests order.
2998
:param random_seed: now, a string which casts to a long, or a long.
2999
:param runner: A test runner with a stream attribute to report on.
3001
if random_seed is None:
3002
return identity_decorator
3003
def decorator(suite):
3004
return RandomDecorator(suite, random_seed, runner.stream)
3008
def tests_first(pattern):
3010
return identity_decorator
3011
def decorator(suite):
3012
return TestFirstDecorator(suite, pattern)
3016
def identity_decorator(suite):
3021
class TestDecorator(TestUtil.TestSuite):
3022
"""A decorator for TestCase/TestSuite objects.
3024
Usually, subclasses should override __iter__(used when flattening test
3025
suites), which we do to filter, reorder, parallelise and so on, run() and
3029
def __init__(self, suite):
3030
TestUtil.TestSuite.__init__(self)
3033
def countTestCases(self):
3036
cases += test.countTestCases()
3043
def run(self, result):
3044
# Use iteration on self, not self._tests, to allow subclasses to hook
3047
if result.shouldStop:
3053
class CountingDecorator(TestDecorator):
3054
"""A decorator which calls result.progress(self.countTestCases)."""
3056
def run(self, result):
3057
progress_method = getattr(result, 'progress', None)
3058
if callable(progress_method):
3059
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3060
return super(CountingDecorator, self).run(result)
3063
class ExcludeDecorator(TestDecorator):
3064
"""A decorator which excludes test matching an exclude pattern."""
3066
def __init__(self, suite, exclude_pattern):
3067
TestDecorator.__init__(self, suite)
3068
self.exclude_pattern = exclude_pattern
3069
self.excluded = False
3073
return iter(self._tests)
3074
self.excluded = True
3075
suite = exclude_tests_by_re(self, self.exclude_pattern)
3077
self.addTests(suite)
3078
return iter(self._tests)
3081
class FilterTestsDecorator(TestDecorator):
3082
"""A decorator which filters tests to those matching a pattern."""
3084
def __init__(self, suite, pattern):
3085
TestDecorator.__init__(self, suite)
3086
self.pattern = pattern
3087
self.filtered = False
3091
return iter(self._tests)
3092
self.filtered = True
3093
suite = filter_suite_by_re(self, self.pattern)
3095
self.addTests(suite)
3096
return iter(self._tests)
3099
class RandomDecorator(TestDecorator):
3100
"""A decorator which randomises the order of its tests."""
3102
def __init__(self, suite, random_seed, stream):
3103
TestDecorator.__init__(self, suite)
3104
self.random_seed = random_seed
3105
self.randomised = False
3106
self.stream = stream
3110
return iter(self._tests)
3111
self.randomised = True
3112
self.stream.write("Randomizing test order using seed %s\n\n" %
3113
(self.actual_seed()))
3114
# Initialise the random number generator.
3115
random.seed(self.actual_seed())
3116
suite = randomize_suite(self)
3118
self.addTests(suite)
3119
return iter(self._tests)
3121
def actual_seed(self):
3122
if self.random_seed == "now":
3123
# We convert the seed to a long to make it reuseable across
3124
# invocations (because the user can reenter it).
3125
self.random_seed = long(time.time())
3127
# Convert the seed to a long if we can
3129
self.random_seed = long(self.random_seed)
3132
return self.random_seed
3135
class TestFirstDecorator(TestDecorator):
3136
"""A decorator which moves named tests to the front."""
3138
def __init__(self, suite, pattern):
3139
TestDecorator.__init__(self, suite)
3140
self.pattern = pattern
3141
self.filtered = False
3145
return iter(self._tests)
3146
self.filtered = True
3147
suites = split_suite_by_re(self, self.pattern)
3149
self.addTests(suites)
3150
return iter(self._tests)
3153
def partition_tests(suite, count):
3154
"""Partition suite into count lists of tests."""
3155
# This just assigns tests in a round-robin fashion. On one hand this
3156
# splits up blocks of related tests that might run faster if they shared
3157
# resources, but on the other it avoids assigning blocks of slow tests to
3158
# just one partition. So the slowest partition shouldn't be much slower
3160
partitions = [list() for i in range(count)]
3161
tests = iter_suite_tests(suite)
3162
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3163
partition.append(test)
3167
def workaround_zealous_crypto_random():
3168
"""Crypto.Random want to help us being secure, but we don't care here.
3170
This workaround some test failure related to the sftp server. Once paramiko
3171
stop using the controversial API in Crypto.Random, we may get rid of it.
3174
from Crypto.Random import atfork
3180
def fork_for_tests(suite):
3181
"""Take suite and start up one runner per CPU by forking()
3183
:return: An iterable of TestCase-like objects which can each have
3184
run(result) called on them to feed tests to result.
3186
concurrency = osutils.local_concurrency()
3188
from subunit import TestProtocolClient, ProtocolTestCase
3189
from subunit.test_results import AutoTimingTestResultDecorator
3190
class TestInOtherProcess(ProtocolTestCase):
3191
# Should be in subunit, I think. RBC.
3192
def __init__(self, stream, pid):
3193
ProtocolTestCase.__init__(self, stream)
3196
def run(self, result):
3198
ProtocolTestCase.run(self, result)
3200
os.waitpid(self.pid, 0)
3202
test_blocks = partition_tests(suite, concurrency)
3203
for process_tests in test_blocks:
3204
process_suite = TestUtil.TestSuite()
3205
process_suite.addTests(process_tests)
3206
c2pread, c2pwrite = os.pipe()
3209
workaround_zealous_crypto_random()
3212
# Leave stderr and stdout open so we can see test noise
3213
# Close stdin so that the child goes away if it decides to
3214
# read from stdin (otherwise its a roulette to see what
3215
# child actually gets keystrokes for pdb etc).
3218
stream = os.fdopen(c2pwrite, 'wb', 1)
3219
subunit_result = AutoTimingTestResultDecorator(
3220
TestProtocolClient(stream))
3221
process_suite.run(subunit_result)
3226
stream = os.fdopen(c2pread, 'rb', 1)
3227
test = TestInOtherProcess(stream, pid)
3232
def reinvoke_for_tests(suite):
3233
"""Take suite and start up one runner per CPU using subprocess().
3235
:return: An iterable of TestCase-like objects which can each have
3236
run(result) called on them to feed tests to result.
3238
concurrency = osutils.local_concurrency()
3240
from subunit import ProtocolTestCase
3241
class TestInSubprocess(ProtocolTestCase):
3242
def __init__(self, process, name):
3243
ProtocolTestCase.__init__(self, process.stdout)
3244
self.process = process
3245
self.process.stdin.close()
3248
def run(self, result):
3250
ProtocolTestCase.run(self, result)
3253
os.unlink(self.name)
3254
# print "pid %d finished" % finished_process
3255
test_blocks = partition_tests(suite, concurrency)
3256
for process_tests in test_blocks:
3257
# ugly; currently reimplement rather than reuses TestCase methods.
3258
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3259
if not os.path.isfile(bzr_path):
3260
# We are probably installed. Assume sys.argv is the right file
3261
bzr_path = sys.argv[0]
3262
bzr_path = [bzr_path]
3263
if sys.platform == "win32":
3264
# if we're on windows, we can't execute the bzr script directly
3265
bzr_path = [sys.executable] + bzr_path
3266
fd, test_list_file_name = tempfile.mkstemp()
3267
test_list_file = os.fdopen(fd, 'wb', 1)
3268
for test in process_tests:
3269
test_list_file.write(test.id() + '\n')
3270
test_list_file.close()
3272
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3274
if '--no-plugins' in sys.argv:
3275
argv.append('--no-plugins')
3276
# stderr=subprocess.STDOUT would be ideal, but until we prevent
3277
# noise on stderr it can interrupt the subunit protocol.
3278
process = subprocess.Popen(argv, stdin=subprocess.PIPE,
3279
stdout=subprocess.PIPE,
3280
stderr=subprocess.PIPE,
3282
test = TestInSubprocess(process, test_list_file_name)
3285
os.unlink(test_list_file_name)
3290
class ForwardingResult(unittest.TestResult):
3292
def __init__(self, target):
3293
unittest.TestResult.__init__(self)
3294
self.result = target
3296
def startTest(self, test):
3297
self.result.startTest(test)
3299
def stopTest(self, test):
3300
self.result.stopTest(test)
3302
def startTestRun(self):
3303
self.result.startTestRun()
3305
def stopTestRun(self):
3306
self.result.stopTestRun()
3308
def addSkip(self, test, reason):
3309
self.result.addSkip(test, reason)
3311
def addSuccess(self, test):
3312
self.result.addSuccess(test)
3314
def addError(self, test, err):
3315
self.result.addError(test, err)
3317
def addFailure(self, test, err):
3318
self.result.addFailure(test, err)
3319
ForwardingResult = testtools.ExtendedToOriginalDecorator
3322
class ProfileResult(ForwardingResult):
3323
"""Generate profiling data for all activity between start and success.
3325
The profile data is appended to the test's _benchcalls attribute and can
3326
be accessed by the forwarded-to TestResult.
3328
While it might be cleaner do accumulate this in stopTest, addSuccess is
3329
where our existing output support for lsprof is, and this class aims to
3330
fit in with that: while it could be moved it's not necessary to accomplish
3331
test profiling, nor would it be dramatically cleaner.
3334
def startTest(self, test):
3335
self.profiler = bzrlib.lsprof.BzrProfiler()
3336
# Prevent deadlocks in tests that use lsprof: those tests will
3338
bzrlib.lsprof.BzrProfiler.profiler_block = 0
3339
self.profiler.start()
3340
ForwardingResult.startTest(self, test)
3342
def addSuccess(self, test):
3343
stats = self.profiler.stop()
3345
calls = test._benchcalls
3346
except AttributeError:
3347
test._benchcalls = []
3348
calls = test._benchcalls
3349
calls.append(((test.id(), "", ""), stats))
3350
ForwardingResult.addSuccess(self, test)
3352
def stopTest(self, test):
3353
ForwardingResult.stopTest(self, test)
3354
self.profiler = None
3357
# Controlled by "bzr selftest -E=..." option
3358
# Currently supported:
3359
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3360
# preserves any flags supplied at the command line.
3361
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3362
# rather than failing tests. And no longer raise
3363
# LockContention when fctnl locks are not being used
3364
# with proper exclusion rules.
3365
# -Ethreads Will display thread ident at creation/join time to
3366
# help track thread leaks
3367
selftest_debug_flags = set()
3370
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3372
test_suite_factory=None,
3375
matching_tests_first=None,
3378
exclude_pattern=None,
3384
suite_decorators=None,
3388
"""Run the whole test suite under the enhanced runner"""
3389
# XXX: Very ugly way to do this...
3390
# Disable warning about old formats because we don't want it to disturb
3391
# any blackbox tests.
3392
from bzrlib import repository
3393
repository._deprecation_warning_done = True
3395
global default_transport
3396
if transport is None:
3397
transport = default_transport
3398
old_transport = default_transport
3399
default_transport = transport
3400
global selftest_debug_flags
3401
old_debug_flags = selftest_debug_flags
3402
if debug_flags is not None:
3403
selftest_debug_flags = set(debug_flags)
3405
if load_list is None:
3408
keep_only = load_test_id_list(load_list)
3410
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3411
for start in starting_with]
3412
if test_suite_factory is None:
3413
# Reduce loading time by loading modules based on the starting_with
3415
suite = test_suite(keep_only, starting_with)
3417
suite = test_suite_factory()
3419
# But always filter as requested.
3420
suite = filter_suite_by_id_startswith(suite, starting_with)
3421
result_decorators = []
3423
result_decorators.append(ProfileResult)
3424
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3425
stop_on_failure=stop_on_failure,
3426
transport=transport,
3427
lsprof_timed=lsprof_timed,
3428
bench_history=bench_history,
3429
matching_tests_first=matching_tests_first,
3430
list_only=list_only,
3431
random_seed=random_seed,
3432
exclude_pattern=exclude_pattern,
3434
runner_class=runner_class,
3435
suite_decorators=suite_decorators,
3437
result_decorators=result_decorators,
3440
default_transport = old_transport
3441
selftest_debug_flags = old_debug_flags
3444
def load_test_id_list(file_name):
3445
"""Load a test id list from a text file.
3447
The format is one test id by line. No special care is taken to impose
3448
strict rules, these test ids are used to filter the test suite so a test id
3449
that do not match an existing test will do no harm. This allows user to add
3450
comments, leave blank lines, etc.
3454
ftest = open(file_name, 'rt')
3456
if e.errno != errno.ENOENT:
3459
raise errors.NoSuchFile(file_name)
3461
for test_name in ftest.readlines():
3462
test_list.append(test_name.strip())
3467
def suite_matches_id_list(test_suite, id_list):
3468
"""Warns about tests not appearing or appearing more than once.
3470
:param test_suite: A TestSuite object.
3471
:param test_id_list: The list of test ids that should be found in
3474
:return: (absents, duplicates) absents is a list containing the test found
3475
in id_list but not in test_suite, duplicates is a list containing the
3476
test found multiple times in test_suite.
3478
When using a prefined test id list, it may occurs that some tests do not
3479
exist anymore or that some tests use the same id. This function warns the
3480
tester about potential problems in his workflow (test lists are volatile)
3481
or in the test suite itself (using the same id for several tests does not
3482
help to localize defects).
3484
# Build a dict counting id occurrences
3486
for test in iter_suite_tests(test_suite):
3488
tests[id] = tests.get(id, 0) + 1
3493
occurs = tests.get(id, 0)
3495
not_found.append(id)
3497
duplicates.append(id)
3499
return not_found, duplicates
3502
class TestIdList(object):
3503
"""Test id list to filter a test suite.
3505
Relying on the assumption that test ids are built as:
3506
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3507
notation, this class offers methods to :
3508
- avoid building a test suite for modules not refered to in the test list,
3509
- keep only the tests listed from the module test suite.
3512
def __init__(self, test_id_list):
3513
# When a test suite needs to be filtered against us we compare test ids
3514
# for equality, so a simple dict offers a quick and simple solution.
3515
self.tests = dict().fromkeys(test_id_list, True)
3517
# While unittest.TestCase have ids like:
3518
# <module>.<class>.<method>[(<param+)],
3519
# doctest.DocTestCase can have ids like:
3522
# <module>.<function>
3523
# <module>.<class>.<method>
3525
# Since we can't predict a test class from its name only, we settle on
3526
# a simple constraint: a test id always begins with its module name.
3529
for test_id in test_id_list:
3530
parts = test_id.split('.')
3531
mod_name = parts.pop(0)
3532
modules[mod_name] = True
3534
mod_name += '.' + part
3535
modules[mod_name] = True
3536
self.modules = modules
3538
def refers_to(self, module_name):
3539
"""Is there tests for the module or one of its sub modules."""
3540
return self.modules.has_key(module_name)
3542
def includes(self, test_id):
3543
return self.tests.has_key(test_id)
3546
class TestPrefixAliasRegistry(registry.Registry):
3547
"""A registry for test prefix aliases.
3549
This helps implement shorcuts for the --starting-with selftest
3550
option. Overriding existing prefixes is not allowed but not fatal (a
3551
warning will be emitted).
3554
def register(self, key, obj, help=None, info=None,
3555
override_existing=False):
3556
"""See Registry.register.
3558
Trying to override an existing alias causes a warning to be emitted,
3559
not a fatal execption.
3562
super(TestPrefixAliasRegistry, self).register(
3563
key, obj, help=help, info=info, override_existing=False)
3565
actual = self.get(key)
3566
note('Test prefix alias %s is already used for %s, ignoring %s'
3567
% (key, actual, obj))
3569
def resolve_alias(self, id_start):
3570
"""Replace the alias by the prefix in the given string.
3572
Using an unknown prefix is an error to help catching typos.
3574
parts = id_start.split('.')
3576
parts[0] = self.get(parts[0])
3578
raise errors.BzrCommandError(
3579
'%s is not a known test prefix alias' % parts[0])
3580
return '.'.join(parts)
3583
test_prefix_alias_registry = TestPrefixAliasRegistry()
3584
"""Registry of test prefix aliases."""
3587
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3588
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3589
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3591
# Obvious highest levels prefixes, feel free to add your own via a plugin
3592
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3593
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3594
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3595
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3596
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3599
def _test_suite_testmod_names():
3600
"""Return the standard list of test module names to test."""
3603
'bzrlib.tests.blackbox',
3604
'bzrlib.tests.commands',
3605
'bzrlib.tests.doc_generate',
3606
'bzrlib.tests.per_branch',
3607
'bzrlib.tests.per_bzrdir',
3608
'bzrlib.tests.per_controldir',
3609
'bzrlib.tests.per_controldir_colo',
3610
'bzrlib.tests.per_foreign_vcs',
3611
'bzrlib.tests.per_interrepository',
3612
'bzrlib.tests.per_intertree',
3613
'bzrlib.tests.per_inventory',
3614
'bzrlib.tests.per_interbranch',
3615
'bzrlib.tests.per_lock',
3616
'bzrlib.tests.per_merger',
3617
'bzrlib.tests.per_transport',
3618
'bzrlib.tests.per_tree',
3619
'bzrlib.tests.per_pack_repository',
3620
'bzrlib.tests.per_repository',
3621
'bzrlib.tests.per_repository_chk',
3622
'bzrlib.tests.per_repository_reference',
3623
'bzrlib.tests.per_uifactory',
3624
'bzrlib.tests.per_versionedfile',
3625
'bzrlib.tests.per_workingtree',
3626
'bzrlib.tests.test__annotator',
3627
'bzrlib.tests.test__bencode',
3628
'bzrlib.tests.test__btree_serializer',
3629
'bzrlib.tests.test__chk_map',
3630
'bzrlib.tests.test__dirstate_helpers',
3631
'bzrlib.tests.test__groupcompress',
3632
'bzrlib.tests.test__known_graph',
3633
'bzrlib.tests.test__rio',
3634
'bzrlib.tests.test__simple_set',
3635
'bzrlib.tests.test__static_tuple',
3636
'bzrlib.tests.test__walkdirs_win32',
3637
'bzrlib.tests.test_ancestry',
3638
'bzrlib.tests.test_annotate',
3639
'bzrlib.tests.test_api',
3640
'bzrlib.tests.test_atomicfile',
3641
'bzrlib.tests.test_bad_files',
3642
'bzrlib.tests.test_bisect_multi',
3643
'bzrlib.tests.test_branch',
3644
'bzrlib.tests.test_branchbuilder',
3645
'bzrlib.tests.test_btree_index',
3646
'bzrlib.tests.test_bugtracker',
3647
'bzrlib.tests.test_bundle',
3648
'bzrlib.tests.test_bzrdir',
3649
'bzrlib.tests.test__chunks_to_lines',
3650
'bzrlib.tests.test_cache_utf8',
3651
'bzrlib.tests.test_chk_map',
3652
'bzrlib.tests.test_chk_serializer',
3653
'bzrlib.tests.test_chunk_writer',
3654
'bzrlib.tests.test_clean_tree',
3655
'bzrlib.tests.test_cleanup',
3656
'bzrlib.tests.test_cmdline',
3657
'bzrlib.tests.test_commands',
3658
'bzrlib.tests.test_commit',
3659
'bzrlib.tests.test_commit_merge',
3660
'bzrlib.tests.test_config',
3661
'bzrlib.tests.test_conflicts',
3662
'bzrlib.tests.test_counted_lock',
3663
'bzrlib.tests.test_crash',
3664
'bzrlib.tests.test_decorators',
3665
'bzrlib.tests.test_delta',
3666
'bzrlib.tests.test_debug',
3667
'bzrlib.tests.test_deprecated_graph',
3668
'bzrlib.tests.test_diff',
3669
'bzrlib.tests.test_directory_service',
3670
'bzrlib.tests.test_dirstate',
3671
'bzrlib.tests.test_email_message',
3672
'bzrlib.tests.test_eol_filters',
3673
'bzrlib.tests.test_errors',
3674
'bzrlib.tests.test_export',
3675
'bzrlib.tests.test_extract',
3676
'bzrlib.tests.test_fetch',
3677
'bzrlib.tests.test_fixtures',
3678
'bzrlib.tests.test_fifo_cache',
3679
'bzrlib.tests.test_filters',
3680
'bzrlib.tests.test_ftp_transport',
3681
'bzrlib.tests.test_foreign',
3682
'bzrlib.tests.test_generate_docs',
3683
'bzrlib.tests.test_generate_ids',
3684
'bzrlib.tests.test_globbing',
3685
'bzrlib.tests.test_gpg',
3686
'bzrlib.tests.test_graph',
3687
'bzrlib.tests.test_groupcompress',
3688
'bzrlib.tests.test_hashcache',
3689
'bzrlib.tests.test_help',
3690
'bzrlib.tests.test_hooks',
3691
'bzrlib.tests.test_http',
3692
'bzrlib.tests.test_http_response',
3693
'bzrlib.tests.test_https_ca_bundle',
3694
'bzrlib.tests.test_identitymap',
3695
'bzrlib.tests.test_ignores',
3696
'bzrlib.tests.test_index',
3697
'bzrlib.tests.test_import_tariff',
3698
'bzrlib.tests.test_info',
3699
'bzrlib.tests.test_inv',
3700
'bzrlib.tests.test_inventory_delta',
3701
'bzrlib.tests.test_knit',
3702
'bzrlib.tests.test_lazy_import',
3703
'bzrlib.tests.test_lazy_regex',
3704
'bzrlib.tests.test_library_state',
3705
'bzrlib.tests.test_lock',
3706
'bzrlib.tests.test_lockable_files',
3707
'bzrlib.tests.test_lockdir',
3708
'bzrlib.tests.test_log',
3709
'bzrlib.tests.test_lru_cache',
3710
'bzrlib.tests.test_lsprof',
3711
'bzrlib.tests.test_mail_client',
3712
'bzrlib.tests.test_matchers',
3713
'bzrlib.tests.test_memorytree',
3714
'bzrlib.tests.test_merge',
3715
'bzrlib.tests.test_merge3',
3716
'bzrlib.tests.test_merge_core',
3717
'bzrlib.tests.test_merge_directive',
3718
'bzrlib.tests.test_missing',
3719
'bzrlib.tests.test_msgeditor',
3720
'bzrlib.tests.test_multiparent',
3721
'bzrlib.tests.test_mutabletree',
3722
'bzrlib.tests.test_nonascii',
3723
'bzrlib.tests.test_options',
3724
'bzrlib.tests.test_osutils',
3725
'bzrlib.tests.test_osutils_encodings',
3726
'bzrlib.tests.test_pack',
3727
'bzrlib.tests.test_patch',
3728
'bzrlib.tests.test_patches',
3729
'bzrlib.tests.test_permissions',
3730
'bzrlib.tests.test_plugins',
3731
'bzrlib.tests.test_progress',
3732
'bzrlib.tests.test_read_bundle',
3733
'bzrlib.tests.test_reconcile',
3734
'bzrlib.tests.test_reconfigure',
3735
'bzrlib.tests.test_registry',
3736
'bzrlib.tests.test_remote',
3737
'bzrlib.tests.test_rename_map',
3738
'bzrlib.tests.test_repository',
3739
'bzrlib.tests.test_revert',
3740
'bzrlib.tests.test_revision',
3741
'bzrlib.tests.test_revisionspec',
3742
'bzrlib.tests.test_revisiontree',
3743
'bzrlib.tests.test_rio',
3744
'bzrlib.tests.test_rules',
3745
'bzrlib.tests.test_sampler',
3746
'bzrlib.tests.test_script',
3747
'bzrlib.tests.test_selftest',
3748
'bzrlib.tests.test_serializer',
3749
'bzrlib.tests.test_setup',
3750
'bzrlib.tests.test_sftp_transport',
3751
'bzrlib.tests.test_shelf',
3752
'bzrlib.tests.test_shelf_ui',
3753
'bzrlib.tests.test_smart',
3754
'bzrlib.tests.test_smart_add',
3755
'bzrlib.tests.test_smart_request',
3756
'bzrlib.tests.test_smart_transport',
3757
'bzrlib.tests.test_smtp_connection',
3758
'bzrlib.tests.test_source',
3759
'bzrlib.tests.test_ssh_transport',
3760
'bzrlib.tests.test_status',
3761
'bzrlib.tests.test_store',
3762
'bzrlib.tests.test_strace',
3763
'bzrlib.tests.test_subsume',
3764
'bzrlib.tests.test_switch',
3765
'bzrlib.tests.test_symbol_versioning',
3766
'bzrlib.tests.test_tag',
3767
'bzrlib.tests.test_test_server',
3768
'bzrlib.tests.test_testament',
3769
'bzrlib.tests.test_textfile',
3770
'bzrlib.tests.test_textmerge',
3771
'bzrlib.tests.test_timestamp',
3772
'bzrlib.tests.test_trace',
3773
'bzrlib.tests.test_transactions',
3774
'bzrlib.tests.test_transform',
3775
'bzrlib.tests.test_transport',
3776
'bzrlib.tests.test_transport_log',
3777
'bzrlib.tests.test_tree',
3778
'bzrlib.tests.test_treebuilder',
3779
'bzrlib.tests.test_treeshape',
3780
'bzrlib.tests.test_tsort',
3781
'bzrlib.tests.test_tuned_gzip',
3782
'bzrlib.tests.test_ui',
3783
'bzrlib.tests.test_uncommit',
3784
'bzrlib.tests.test_upgrade',
3785
'bzrlib.tests.test_upgrade_stacked',
3786
'bzrlib.tests.test_urlutils',
3787
'bzrlib.tests.test_version',
3788
'bzrlib.tests.test_version_info',
3789
'bzrlib.tests.test_versionedfile',
3790
'bzrlib.tests.test_weave',
3791
'bzrlib.tests.test_whitebox',
3792
'bzrlib.tests.test_win32utils',
3793
'bzrlib.tests.test_workingtree',
3794
'bzrlib.tests.test_workingtree_4',
3795
'bzrlib.tests.test_wsgi',
3796
'bzrlib.tests.test_xml',
3800
def _test_suite_modules_to_doctest():
3801
"""Return the list of modules to doctest."""
3803
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3807
'bzrlib.branchbuilder',
3808
'bzrlib.decorators',
3811
'bzrlib.iterablefile',
3815
'bzrlib.symbol_versioning',
3817
'bzrlib.tests.fixtures',
3819
'bzrlib.version_info_formats.format_custom',
3823
def test_suite(keep_only=None, starting_with=None):
3824
"""Build and return TestSuite for the whole of bzrlib.
3826
:param keep_only: A list of test ids limiting the suite returned.
3828
:param starting_with: An id limiting the suite returned to the tests
3831
This function can be replaced if you need to change the default test
3832
suite on a global basis, but it is not encouraged.
3835
loader = TestUtil.TestLoader()
3837
if keep_only is not None:
3838
id_filter = TestIdList(keep_only)
3840
# We take precedence over keep_only because *at loading time* using
3841
# both options means we will load less tests for the same final result.
3842
def interesting_module(name):
3843
for start in starting_with:
3845
# Either the module name starts with the specified string
3846
name.startswith(start)
3847
# or it may contain tests starting with the specified string
3848
or start.startswith(name)
3852
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3854
elif keep_only is not None:
3855
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3856
def interesting_module(name):
3857
return id_filter.refers_to(name)
3860
loader = TestUtil.TestLoader()
3861
def interesting_module(name):
3862
# No filtering, all modules are interesting
3865
suite = loader.suiteClass()
3867
# modules building their suite with loadTestsFromModuleNames
3868
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3870
for mod in _test_suite_modules_to_doctest():
3871
if not interesting_module(mod):
3872
# No tests to keep here, move along
3875
# note that this really does mean "report only" -- doctest
3876
# still runs the rest of the examples
3877
doc_suite = doctest.DocTestSuite(mod,
3878
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3879
except ValueError, e:
3880
print '**failed to get doctest for: %s\n%s' % (mod, e)
3882
if len(doc_suite._tests) == 0:
3883
raise errors.BzrError("no doctests found in %s" % (mod,))
3884
suite.addTest(doc_suite)
3886
default_encoding = sys.getdefaultencoding()
3887
for name, plugin in bzrlib.plugin.plugins().items():
3888
if not interesting_module(plugin.module.__name__):
3890
plugin_suite = plugin.test_suite()
3891
# We used to catch ImportError here and turn it into just a warning,
3892
# but really if you don't have --no-plugins this should be a failure.
3893
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3894
if plugin_suite is None:
3895
plugin_suite = plugin.load_plugin_tests(loader)
3896
if plugin_suite is not None:
3897
suite.addTest(plugin_suite)
3898
if default_encoding != sys.getdefaultencoding():
3899
bzrlib.trace.warning(
3900
'Plugin "%s" tried to reset default encoding to: %s', name,
3901
sys.getdefaultencoding())
3903
sys.setdefaultencoding(default_encoding)
3905
if keep_only is not None:
3906
# Now that the referred modules have loaded their tests, keep only the
3908
suite = filter_suite_by_id_list(suite, id_filter)
3909
# Do some sanity checks on the id_list filtering
3910
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3912
# The tester has used both keep_only and starting_with, so he is
3913
# already aware that some tests are excluded from the list, there
3914
# is no need to tell him which.
3917
# Some tests mentioned in the list are not in the test suite. The
3918
# list may be out of date, report to the tester.
3919
for id in not_found:
3920
bzrlib.trace.warning('"%s" not found in the test suite', id)
3921
for id in duplicates:
3922
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3927
def multiply_scenarios(scenarios_left, scenarios_right):
3928
"""Multiply two sets of scenarios.
3930
:returns: the cartesian product of the two sets of scenarios, that is
3931
a scenario for every possible combination of a left scenario and a
3935
('%s,%s' % (left_name, right_name),
3936
dict(left_dict.items() + right_dict.items()))
3937
for left_name, left_dict in scenarios_left
3938
for right_name, right_dict in scenarios_right]
3941
def multiply_tests(tests, scenarios, result):
3942
"""Multiply tests_list by scenarios into result.
3944
This is the core workhorse for test parameterisation.
3946
Typically the load_tests() method for a per-implementation test suite will
3947
call multiply_tests and return the result.
3949
:param tests: The tests to parameterise.
3950
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3951
scenario_param_dict).
3952
:param result: A TestSuite to add created tests to.
3954
This returns the passed in result TestSuite with the cross product of all
3955
the tests repeated once for each scenario. Each test is adapted by adding
3956
the scenario name at the end of its id(), and updating the test object's
3957
__dict__ with the scenario_param_dict.
3959
>>> import bzrlib.tests.test_sampler
3960
>>> r = multiply_tests(
3961
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3962
... [('one', dict(param=1)),
3963
... ('two', dict(param=2))],
3964
... TestUtil.TestSuite())
3965
>>> tests = list(iter_suite_tests(r))
3969
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3975
for test in iter_suite_tests(tests):
3976
apply_scenarios(test, scenarios, result)
3980
def apply_scenarios(test, scenarios, result):
3981
"""Apply the scenarios in scenarios to test and add to result.
3983
:param test: The test to apply scenarios to.
3984
:param scenarios: An iterable of scenarios to apply to test.
3986
:seealso: apply_scenario
3988
for scenario in scenarios:
3989
result.addTest(apply_scenario(test, scenario))
3993
def apply_scenario(test, scenario):
3994
"""Copy test and apply scenario to it.
3996
:param test: A test to adapt.
3997
:param scenario: A tuple describing the scenarion.
3998
The first element of the tuple is the new test id.
3999
The second element is a dict containing attributes to set on the
4001
:return: The adapted test.
4003
new_id = "%s(%s)" % (test.id(), scenario[0])
4004
new_test = clone_test(test, new_id)
4005
for name, value in scenario[1].items():
4006
setattr(new_test, name, value)
4010
def clone_test(test, new_id):
4011
"""Clone a test giving it a new id.
4013
:param test: The test to clone.
4014
:param new_id: The id to assign to it.
4015
:return: The new test.
4017
new_test = copy.copy(test)
4018
new_test.id = lambda: new_id
4019
# XXX: Workaround <https://bugs.launchpad.net/testtools/+bug/637725>, which
4020
# causes cloned tests to share the 'details' dict. This makes it hard to
4021
# read the test output for parameterized tests, because tracebacks will be
4022
# associated with irrelevant tests.
4024
details = new_test._TestCase__details
4025
except AttributeError:
4026
# must be a different version of testtools than expected. Do nothing.
4029
# Reset the '__details' dict.
4030
new_test._TestCase__details = {}
4034
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4036
"""Helper for permutating tests against an extension module.
4038
This is meant to be used inside a modules 'load_tests()' function. It will
4039
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4040
against both implementations. Setting 'test.module' to the appropriate
4041
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4043
:param standard_tests: A test suite to permute
4044
:param loader: A TestLoader
4045
:param py_module_name: The python path to a python module that can always
4046
be loaded, and will be considered the 'python' implementation. (eg
4047
'bzrlib._chk_map_py')
4048
:param ext_module_name: The python path to an extension module. If the
4049
module cannot be loaded, a single test will be added, which notes that
4050
the module is not available. If it can be loaded, all standard_tests
4051
will be run against that module.
4052
:return: (suite, feature) suite is a test-suite that has all the permuted
4053
tests. feature is the Feature object that can be used to determine if
4054
the module is available.
4057
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4059
('python', {'module': py_module}),
4061
suite = loader.suiteClass()
4062
feature = ModuleAvailableFeature(ext_module_name)
4063
if feature.available():
4064
scenarios.append(('C', {'module': feature.module}))
4066
# the compiled module isn't available, so we add a failing test
4067
class FailWithoutFeature(TestCase):
4068
def test_fail(self):
4069
self.requireFeature(feature)
4070
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4071
result = multiply_tests(standard_tests, scenarios, suite)
4072
return result, feature
4075
def _rmtree_temp_dir(dirname, test_id=None):
4076
# If LANG=C we probably have created some bogus paths
4077
# which rmtree(unicode) will fail to delete
4078
# so make sure we are using rmtree(str) to delete everything
4079
# except on win32, where rmtree(str) will fail
4080
# since it doesn't have the property of byte-stream paths
4081
# (they are either ascii or mbcs)
4082
if sys.platform == 'win32':
4083
# make sure we are using the unicode win32 api
4084
dirname = unicode(dirname)
4086
dirname = dirname.encode(sys.getfilesystemencoding())
4088
osutils.rmtree(dirname)
4090
# We don't want to fail here because some useful display will be lost
4091
# otherwise. Polluting the tmp dir is bad, but not giving all the
4092
# possible info to the test runner is even worse.
4094
ui.ui_factory.clear_term()
4095
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4096
# Ugly, but the last thing we want here is fail, so bear with it.
4097
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4098
).encode('ascii', 'replace')
4099
sys.stderr.write('Unable to remove testing dir %s\n%s'
4100
% (os.path.basename(dirname), printable_e))
4103
class Feature(object):
4104
"""An operating system Feature."""
4107
self._available = None
4109
def available(self):
4110
"""Is the feature available?
4112
:return: True if the feature is available.
4114
if self._available is None:
4115
self._available = self._probe()
4116
return self._available
4119
"""Implement this method in concrete features.
4121
:return: True if the feature is available.
4123
raise NotImplementedError
4126
if getattr(self, 'feature_name', None):
4127
return self.feature_name()
4128
return self.__class__.__name__
4131
class _SymlinkFeature(Feature):
4134
return osutils.has_symlinks()
4136
def feature_name(self):
4139
SymlinkFeature = _SymlinkFeature()
4142
class _HardlinkFeature(Feature):
4145
return osutils.has_hardlinks()
4147
def feature_name(self):
4150
HardlinkFeature = _HardlinkFeature()
4153
class _OsFifoFeature(Feature):
4156
return getattr(os, 'mkfifo', None)
4158
def feature_name(self):
4159
return 'filesystem fifos'
4161
OsFifoFeature = _OsFifoFeature()
4164
class _UnicodeFilenameFeature(Feature):
4165
"""Does the filesystem support Unicode filenames?"""
4169
# Check for character combinations unlikely to be covered by any
4170
# single non-unicode encoding. We use the characters
4171
# - greek small letter alpha (U+03B1) and
4172
# - braille pattern dots-123456 (U+283F).
4173
os.stat(u'\u03b1\u283f')
4174
except UnicodeEncodeError:
4176
except (IOError, OSError):
4177
# The filesystem allows the Unicode filename but the file doesn't
4181
# The filesystem allows the Unicode filename and the file exists,
4185
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4188
class _CompatabilityThunkFeature(Feature):
4189
"""This feature is just a thunk to another feature.
4191
It issues a deprecation warning if it is accessed, to let you know that you
4192
should really use a different feature.
4195
def __init__(self, dep_version, module, name,
4196
replacement_name, replacement_module=None):
4197
super(_CompatabilityThunkFeature, self).__init__()
4198
self._module = module
4199
if replacement_module is None:
4200
replacement_module = module
4201
self._replacement_module = replacement_module
4203
self._replacement_name = replacement_name
4204
self._dep_version = dep_version
4205
self._feature = None
4208
if self._feature is None:
4209
depr_msg = self._dep_version % ('%s.%s'
4210
% (self._module, self._name))
4211
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4212
self._replacement_name)
4213
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4214
# Import the new feature and use it as a replacement for the
4216
mod = __import__(self._replacement_module, {}, {},
4217
[self._replacement_name])
4218
self._feature = getattr(mod, self._replacement_name)
4222
return self._feature._probe()
4225
class ModuleAvailableFeature(Feature):
4226
"""This is a feature than describes a module we want to be available.
4228
Declare the name of the module in __init__(), and then after probing, the
4229
module will be available as 'self.module'.
4231
:ivar module: The module if it is available, else None.
4234
def __init__(self, module_name):
4235
super(ModuleAvailableFeature, self).__init__()
4236
self.module_name = module_name
4240
self._module = __import__(self.module_name, {}, {}, [''])
4247
if self.available(): # Make sure the probe has been done
4251
def feature_name(self):
4252
return self.module_name
4255
# This is kept here for compatibility, it is recommended to use
4256
# 'bzrlib.tests.feature.paramiko' instead
4257
ParamikoFeature = _CompatabilityThunkFeature(
4258
deprecated_in((2,1,0)),
4259
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4262
def probe_unicode_in_user_encoding():
4263
"""Try to encode several unicode strings to use in unicode-aware tests.
4264
Return first successfull match.
4266
:return: (unicode value, encoded plain string value) or (None, None)
4268
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4269
for uni_val in possible_vals:
4271
str_val = uni_val.encode(osutils.get_user_encoding())
4272
except UnicodeEncodeError:
4273
# Try a different character
4276
return uni_val, str_val
4280
def probe_bad_non_ascii(encoding):
4281
"""Try to find [bad] character with code [128..255]
4282
that cannot be decoded to unicode in some encoding.
4283
Return None if all non-ascii characters is valid
4286
for i in xrange(128, 256):
4289
char.decode(encoding)
4290
except UnicodeDecodeError:
4295
class _HTTPSServerFeature(Feature):
4296
"""Some tests want an https Server, check if one is available.
4298
Right now, the only way this is available is under python2.6 which provides
4309
def feature_name(self):
4310
return 'HTTPSServer'
4313
HTTPSServerFeature = _HTTPSServerFeature()
4316
class _UnicodeFilename(Feature):
4317
"""Does the filesystem support Unicode filenames?"""
4322
except UnicodeEncodeError:
4324
except (IOError, OSError):
4325
# The filesystem allows the Unicode filename but the file doesn't
4329
# The filesystem allows the Unicode filename and the file exists,
4333
UnicodeFilename = _UnicodeFilename()
4336
class _ByteStringNamedFilesystem(Feature):
4337
"""Is the filesystem based on bytes?"""
4340
if os.name == "posix":
4344
ByteStringNamedFilesystem = _ByteStringNamedFilesystem()
4347
class _UTF8Filesystem(Feature):
4348
"""Is the filesystem UTF-8?"""
4351
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4355
UTF8Filesystem = _UTF8Filesystem()
4358
class _BreakinFeature(Feature):
4359
"""Does this platform support the breakin feature?"""
4362
from bzrlib import breakin
4363
if breakin.determine_signal() is None:
4365
if sys.platform == 'win32':
4366
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4367
# We trigger SIGBREAK via a Console api so we need ctypes to
4368
# access the function
4375
def feature_name(self):
4376
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4379
BreakinFeature = _BreakinFeature()
4382
class _CaseInsCasePresFilenameFeature(Feature):
4383
"""Is the file-system case insensitive, but case-preserving?"""
4386
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4388
# first check truly case-preserving for created files, then check
4389
# case insensitive when opening existing files.
4390
name = osutils.normpath(name)
4391
base, rel = osutils.split(name)
4392
found_rel = osutils.canonical_relpath(base, name)
4393
return (found_rel == rel
4394
and os.path.isfile(name.upper())
4395
and os.path.isfile(name.lower()))
4400
def feature_name(self):
4401
return "case-insensitive case-preserving filesystem"
4403
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4406
class _CaseInsensitiveFilesystemFeature(Feature):
4407
"""Check if underlying filesystem is case-insensitive but *not* case
4410
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4411
# more likely to be case preserving, so this case is rare.
4414
if CaseInsCasePresFilenameFeature.available():
4417
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4418
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4419
TestCaseWithMemoryTransport.TEST_ROOT = root
4421
root = TestCaseWithMemoryTransport.TEST_ROOT
4422
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4424
name_a = osutils.pathjoin(tdir, 'a')
4425
name_A = osutils.pathjoin(tdir, 'A')
4427
result = osutils.isdir(name_A)
4428
_rmtree_temp_dir(tdir)
4431
def feature_name(self):
4432
return 'case-insensitive filesystem'
4434
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4437
class _CaseSensitiveFilesystemFeature(Feature):
4440
if CaseInsCasePresFilenameFeature.available():
4442
elif CaseInsensitiveFilesystemFeature.available():
4447
def feature_name(self):
4448
return 'case-sensitive filesystem'
4450
# new coding style is for feature instances to be lowercase
4451
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4454
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4455
SubUnitFeature = _CompatabilityThunkFeature(
4456
deprecated_in((2,1,0)),
4457
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4458
# Only define SubUnitBzrRunner if subunit is available.
4460
from subunit import TestProtocolClient
4461
from subunit.test_results import AutoTimingTestResultDecorator
4462
class SubUnitBzrRunner(TextTestRunner):
4463
def run(self, test):
4464
result = AutoTimingTestResultDecorator(
4465
TestProtocolClient(self.stream))
4471
class _PosixPermissionsFeature(Feature):
4475
# create temporary file and check if specified perms are maintained.
4478
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4479
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4482
os.chmod(name, write_perms)
4484
read_perms = os.stat(name).st_mode & 0777
4486
return (write_perms == read_perms)
4488
return (os.name == 'posix') and has_perms()
4490
def feature_name(self):
4491
return 'POSIX permissions support'
4493
posix_permissions_feature = _PosixPermissionsFeature()
22
MODULES_TO_DOCTEST = []
25
class BzrTestBase(InTempDir):
26
"""bzr-specific test base class"""
27
def run_bzr(self, *args, **kwargs):
28
retcode = kwargs.get('retcode', 0)
29
self.assertEquals(bzrlib.commands.run_bzr(args), retcode)
32
def selftest(verbose=False):
33
from unittest import TestLoader, TestSuite
34
import bzrlib, bzrlib.store, bzrlib.inventory, bzrlib.branch
35
import bzrlib.osutils, bzrlib.commands, bzrlib.merge3, bzrlib.plugin
36
from doctest import DocTestSuite
43
global MODULES_TO_TEST, MODULES_TO_DOCTEST
46
['bzrlib.selftest.whitebox',
47
'bzrlib.selftest.versioning',
48
'bzrlib.selftest.testinv',
49
'bzrlib.selftest.testmerge3',
50
'bzrlib.selftest.testhashcache',
51
'bzrlib.selftest.teststatus',
52
'bzrlib.selftest.blackbox',
53
'bzrlib.selftest.testrevisionnamespaces',
54
'bzrlib.selftest.testbranch',
57
# XXX: should also test bzrlib.merge_core, but they seem to be out
58
# of date with the code.
60
for m in (bzrlib.store, bzrlib.inventory, bzrlib.branch,
61
bzrlib.osutils, bzrlib.commands, bzrlib.merge3):
62
if m not in MODULES_TO_DOCTEST:
63
MODULES_TO_DOCTEST.append(m)
66
TestBase.BZRPATH = os.path.join(os.path.realpath(os.path.dirname(bzrlib.__path__[0])), 'bzr')
67
print '%-30s %s' % ('bzr binary', TestBase.BZRPATH)
73
suite.addTest(TestLoader().loadTestsFromNames(testmod_names))
75
for m in MODULES_TO_TEST:
76
suite.addTest(TestLoader().loadTestsFromModule(m))
78
for m in (MODULES_TO_DOCTEST):
79
suite.addTest(DocTestSuite(m))
81
for p in bzrlib.plugin.all_plugins:
82
if hasattr(p, 'test_suite'):
83
suite.addTest(p.test_suite())
85
import bzrlib.merge_core
86
suite.addTest(unittest.makeSuite(bzrlib.merge_core.MergeTest, 'test_'))
88
return run_suite(suite, 'testbzr', verbose=verbose)
added
removed
bzrlib/selftest/__init__.py
