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
18
# TODO: Perhaps there should be an API to find out if bzr running under the
19
# test suite -- some plugins might want to avoid making intrusive changes if
20
# this is the case. However, we want behaviour under to test to diverge as
21
# little as possible, so this should be used rarely if it's added at all.
22
# (Suggestion from j-a-meinel, 2005-11-24)
24
# NOTE: Some classes in here use camelCaseNaming() rather than
25
# underscore_naming(). That's for consistency with unittest; it's not the
26
# general style of bzrlib. Please continue that consistency when adding e.g.
27
# new assertFoo() methods.
32
from cStringIO import StringIO
39
from pprint import pformat
44
from subprocess import Popen, PIPE, STDOUT
54
# nb: check this before importing anything else from within it
55
_testtools_version = getattr(testtools, '__version__', ())
56
if _testtools_version < (0, 9, 2):
57
raise ImportError("need at least testtools 0.9.2: %s is %r"
58
% (testtools.__file__, _testtools_version))
59
from testtools import content
79
import bzrlib.commands
80
import bzrlib.timestamp
82
import bzrlib.inventory
83
import bzrlib.iterablefile
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from unittest import TestResult, TestCase
88
# lsprof not available
22
from subprocess import call, Popen, PIPE
23
except ImportError, e:
24
sys.stderr.write("testbzr: sorry, this test suite requires the subprocess module\n"
25
"this is shipped with python2.4 and available separately for 2.3\n")
29
class CommandFailed(Exception):
90
from bzrlib.merge import merge_inner
93
from bzrlib.smart import client, request, server
95
from bzrlib import symbol_versioning
96
from bzrlib.symbol_versioning import (
104
from bzrlib.transport import (
109
import bzrlib.transport
110
from bzrlib.trace import mutter, note
111
from bzrlib.tests import (
115
from bzrlib.tests.http_server import HttpServer
116
from bzrlib.tests.TestUtil import (
120
from bzrlib.tests.treeshape import build_tree_contents
121
from bzrlib.ui import NullProgressView
122
from bzrlib.ui.text import TextUIFactory
123
import bzrlib.version_info_formats.format_custom
124
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
126
# Mark this python module as being part of the implementation
127
# of unittest: this gives us better tracebacks where the last
128
# shown frame is the test code, not our assertXYZ.
131
default_transport = test_server.LocalURLServer
134
_unitialized_attr = object()
135
"""A sentinel needed to act as a default value in a method signature."""
138
# Subunit result codes, defined here to prevent a hard dependency on subunit.
143
class ExtendedTestResult(unittest._TextTestResult):
144
"""Accepts, reports and accumulates the results of running tests.
146
Compared to the unittest version this class adds support for
147
profiling, benchmarking, stopping as soon as a test fails, and
148
skipping tests. There are further-specialized subclasses for
149
different types of display.
151
When a test finishes, in whatever way, it calls one of the addSuccess,
152
addFailure or addError classes. These in turn may redirect to a more
153
specific case for the special test results supported by our extended
156
Note that just one of these objects is fed the results from many tests.
161
def __init__(self, stream, descriptions, verbosity,
165
"""Construct new TestResult.
167
:param bench_history: Optionally, a writable file object to accumulate
170
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
171
if bench_history is not None:
172
from bzrlib.version import _get_bzr_source_tree
173
src_tree = _get_bzr_source_tree()
176
revision_id = src_tree.get_parent_ids()[0]
178
# XXX: if this is a brand new tree, do the same as if there
182
# XXX: If there's no branch, what should we do?
184
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
185
self._bench_history = bench_history
186
self.ui = ui.ui_factory
189
self.failure_count = 0
190
self.known_failure_count = 0
192
self.not_applicable_count = 0
193
self.unsupported = {}
195
self._overall_start_time = time.time()
196
self._strict = strict
198
def stopTestRun(self):
201
stopTime = time.time()
202
timeTaken = stopTime - self.startTime
204
self.stream.writeln(self.separator2)
205
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
206
run, run != 1 and "s" or "", timeTaken))
207
self.stream.writeln()
208
if not self.wasSuccessful():
209
self.stream.write("FAILED (")
210
failed, errored = map(len, (self.failures, self.errors))
212
self.stream.write("failures=%d" % failed)
214
if failed: self.stream.write(", ")
215
self.stream.write("errors=%d" % errored)
216
if self.known_failure_count:
217
if failed or errored: self.stream.write(", ")
218
self.stream.write("known_failure_count=%d" %
219
self.known_failure_count)
220
self.stream.writeln(")")
222
if self.known_failure_count:
223
self.stream.writeln("OK (known_failures=%d)" %
224
self.known_failure_count)
226
self.stream.writeln("OK")
227
if self.skip_count > 0:
228
skipped = self.skip_count
229
self.stream.writeln('%d test%s skipped' %
230
(skipped, skipped != 1 and "s" or ""))
232
for feature, count in sorted(self.unsupported.items()):
233
self.stream.writeln("Missing feature '%s' skipped %d tests." %
236
ok = self.wasStrictlySuccessful()
238
ok = self.wasSuccessful()
239
if TestCase._first_thread_leaker_id:
241
'%s is leaking threads among %d leaking tests.\n' % (
242
TestCase._first_thread_leaker_id,
243
TestCase._leaking_threads_tests))
244
# We don't report the main thread as an active one.
246
'%d non-main threads were left active in the end.\n'
247
% (TestCase._active_threads - 1))
249
def getDescription(self, test):
252
def _extractBenchmarkTime(self, testCase, details=None):
253
"""Add a benchmark time for the current test case."""
254
if details and 'benchtime' in details:
255
return float(''.join(details['benchtime'].iter_bytes()))
256
return getattr(testCase, "_benchtime", None)
258
def _elapsedTestTimeString(self):
259
"""Return a time string for the overall time the current test has taken."""
260
return self._formatTime(time.time() - self._start_time)
262
def _testTimeString(self, testCase):
263
benchmark_time = self._extractBenchmarkTime(testCase)
264
if benchmark_time is not None:
265
return self._formatTime(benchmark_time) + "*"
267
return self._elapsedTestTimeString()
269
def _formatTime(self, seconds):
270
"""Format seconds as milliseconds with leading spaces."""
271
# some benchmarks can take thousands of seconds to run, so we need 8
273
return "%8dms" % (1000 * seconds)
275
def _shortened_test_description(self, test):
277
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
280
def startTest(self, test):
281
unittest.TestResult.startTest(self, test)
284
self.report_test_start(test)
285
test.number = self.count
286
self._recordTestStartTime()
288
def startTests(self):
290
if getattr(sys, 'frozen', None) is None:
291
bzr_path = osutils.realpath(sys.argv[0])
293
bzr_path = sys.executable
295
'bzr selftest: %s\n' % (bzr_path,))
298
bzrlib.__path__[0],))
300
' bzr-%s python-%s %s\n' % (
301
bzrlib.version_string,
302
bzrlib._format_version_tuple(sys.version_info),
303
platform.platform(aliased=1),
305
self.stream.write('\n')
307
def _recordTestStartTime(self):
308
"""Record that a test has started."""
309
self._start_time = time.time()
311
def _cleanupLogFile(self, test):
312
# We can only do this if we have one of our TestCases, not if
314
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
315
if setKeepLogfile is not None:
318
def addError(self, test, err):
319
"""Tell result that test finished with an error.
321
Called from the TestCase run() method when the test
322
fails with an unexpected error.
325
unittest.TestResult.addError(self, test, err)
326
self.error_count += 1
327
self.report_error(test, err)
330
self._cleanupLogFile(test)
332
def addFailure(self, test, err):
333
"""Tell result that test failed.
335
Called from the TestCase run() method when the test
336
fails because e.g. an assert() method failed.
339
unittest.TestResult.addFailure(self, test, err)
340
self.failure_count += 1
341
self.report_failure(test, err)
344
self._cleanupLogFile(test)
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
self._cleanupLogFile(test)
359
unittest.TestResult.addSuccess(self, test)
360
test._log_contents = ''
362
def addExpectedFailure(self, test, err):
363
self.known_failure_count += 1
364
self.report_known_failure(test, err)
366
def addNotSupported(self, test, feature):
367
"""The test will not be run because of a missing feature.
369
# this can be called in two different ways: it may be that the
370
# test started running, and then raised (through requireFeature)
371
# UnavailableFeature. Alternatively this method can be called
372
# while probing for features before running the test code proper; in
373
# that case we will see startTest and stopTest, but the test will
374
# never actually run.
375
self.unsupported.setdefault(str(feature), 0)
376
self.unsupported[str(feature)] += 1
377
self.report_unsupported(test, feature)
379
def addSkip(self, test, reason):
380
"""A test has not run for 'reason'."""
382
self.report_skip(test, reason)
384
def addNotApplicable(self, test, reason):
385
self.not_applicable_count += 1
386
self.report_not_applicable(test, reason)
388
def _post_mortem(self):
389
"""Start a PDB post mortem session."""
390
if os.environ.get('BZR_TEST_PDB', None):
391
import pdb;pdb.post_mortem()
393
def progress(self, offset, whence):
394
"""The test is adjusting the count of tests to run."""
395
if whence == SUBUNIT_SEEK_SET:
396
self.num_tests = offset
397
elif whence == SUBUNIT_SEEK_CUR:
398
self.num_tests += offset
400
raise errors.BzrError("Unknown whence %r" % whence)
402
def report_cleaning_up(self):
405
def startTestRun(self):
406
self.startTime = time.time()
408
def report_success(self, test):
411
def wasStrictlySuccessful(self):
412
if self.unsupported or self.known_failure_count:
414
return self.wasSuccessful()
417
class TextTestResult(ExtendedTestResult):
418
"""Displays progress and results of tests in text form"""
420
def __init__(self, stream, descriptions, verbosity,
425
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
426
bench_history, strict)
427
# We no longer pass them around, but just rely on the UIFactory stack
430
warnings.warn("Passing pb to TextTestResult is deprecated")
431
self.pb = self.ui.nested_progress_bar()
432
self.pb.show_pct = False
433
self.pb.show_spinner = False
434
self.pb.show_eta = False,
435
self.pb.show_count = False
436
self.pb.show_bar = False
437
self.pb.update_latency = 0
438
self.pb.show_transport_activity = False
440
def stopTestRun(self):
441
# called when the tests that are going to run have run
444
super(TextTestResult, self).stopTestRun()
446
def startTestRun(self):
447
super(TextTestResult, self).startTestRun()
448
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
450
def printErrors(self):
451
# clear the pb to make room for the error listing
453
super(TextTestResult, self).printErrors()
455
def _progress_prefix_text(self):
456
# the longer this text, the less space we have to show the test
458
a = '[%d' % self.count # total that have been run
459
# tests skipped as known not to be relevant are not important enough
461
## if self.skip_count:
462
## a += ', %d skip' % self.skip_count
463
## if self.known_failure_count:
464
## a += '+%dX' % self.known_failure_count
466
a +='/%d' % self.num_tests
468
runtime = time.time() - self._overall_start_time
470
a += '%dm%ds' % (runtime / 60, runtime % 60)
473
total_fail_count = self.error_count + self.failure_count
475
a += ', %d failed' % total_fail_count
476
# if self.unsupported:
477
# a += ', %d missing' % len(self.unsupported)
481
def report_test_start(self, test):
484
self._progress_prefix_text()
486
+ self._shortened_test_description(test))
488
def _test_description(self, test):
489
return self._shortened_test_description(test)
491
def report_error(self, test, err):
492
self.ui.note('ERROR: %s\n %s\n' % (
493
self._test_description(test),
497
def report_failure(self, test, err):
498
self.ui.note('FAIL: %s\n %s\n' % (
499
self._test_description(test),
503
def report_known_failure(self, test, err):
506
def report_skip(self, test, reason):
509
def report_not_applicable(self, test, reason):
512
def report_unsupported(self, test, feature):
513
"""test cannot be run because feature is missing."""
515
def report_cleaning_up(self):
516
self.pb.update('Cleaning up')
519
class VerboseTestResult(ExtendedTestResult):
520
"""Produce long output, with one line per test run plus times"""
522
def _ellipsize_to_right(self, a_string, final_width):
523
"""Truncate and pad a string, keeping the right hand side"""
524
if len(a_string) > final_width:
525
result = '...' + a_string[3-final_width:]
528
return result.ljust(final_width)
530
def startTestRun(self):
531
super(VerboseTestResult, self).startTestRun()
532
self.stream.write('running %d tests...\n' % self.num_tests)
534
def report_test_start(self, test):
536
name = self._shortened_test_description(test)
537
width = osutils.terminal_width()
538
if width is not None:
539
# width needs space for 6 char status, plus 1 for slash, plus an
540
# 11-char time string, plus a trailing blank
541
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
543
self.stream.write(self._ellipsize_to_right(name, width-18))
545
self.stream.write(name)
548
def _error_summary(self, err):
550
return '%s%s' % (indent, err[1])
552
def report_error(self, test, err):
553
self.stream.writeln('ERROR %s\n%s'
554
% (self._testTimeString(test),
555
self._error_summary(err)))
557
def report_failure(self, test, err):
558
self.stream.writeln(' FAIL %s\n%s'
559
% (self._testTimeString(test),
560
self._error_summary(err)))
562
def report_known_failure(self, test, err):
563
self.stream.writeln('XFAIL %s\n%s'
564
% (self._testTimeString(test),
565
self._error_summary(err)))
567
def report_success(self, test):
568
self.stream.writeln(' OK %s' % self._testTimeString(test))
569
for bench_called, stats in getattr(test, '_benchcalls', []):
570
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
571
stats.pprint(file=self.stream)
572
# flush the stream so that we get smooth output. This verbose mode is
573
# used to show the output in PQM.
576
def report_skip(self, test, reason):
577
self.stream.writeln(' SKIP %s\n%s'
578
% (self._testTimeString(test), reason))
580
def report_not_applicable(self, test, reason):
581
self.stream.writeln(' N/A %s\n %s'
582
% (self._testTimeString(test), reason))
584
def report_unsupported(self, test, feature):
585
"""test cannot be run because feature is missing."""
586
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
587
%(self._testTimeString(test), feature))
590
class TextTestRunner(object):
591
stop_on_failure = False
599
result_decorators=None,
601
"""Create a TextTestRunner.
603
:param result_decorators: An optional list of decorators to apply
604
to the result object being used by the runner. Decorators are
605
applied left to right - the first element in the list is the
608
# stream may know claim to know to write unicode strings, but in older
609
# pythons this goes sufficiently wrong that it is a bad idea. (
610
# specifically a built in file with encoding 'UTF-8' will still try
611
# to encode using ascii.
612
new_encoding = osutils.get_terminal_encoding()
613
codec = codecs.lookup(new_encoding)
614
if type(codec) is tuple:
618
encode = codec.encode
619
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
620
stream.encoding = new_encoding
621
self.stream = unittest._WritelnDecorator(stream)
622
self.descriptions = descriptions
623
self.verbosity = verbosity
624
self._bench_history = bench_history
625
self._strict = strict
626
self._result_decorators = result_decorators or []
629
"Run the given test case or test suite."
630
if self.verbosity == 1:
631
result_class = TextTestResult
632
elif self.verbosity >= 2:
633
result_class = VerboseTestResult
634
original_result = result_class(self.stream,
637
bench_history=self._bench_history,
640
# Signal to result objects that look at stop early policy to stop,
641
original_result.stop_early = self.stop_on_failure
642
result = original_result
643
for decorator in self._result_decorators:
644
result = decorator(result)
645
result.stop_early = self.stop_on_failure
646
result.startTestRun()
651
# higher level code uses our extended protocol to determine
652
# what exit code to give.
653
return original_result
656
def iter_suite_tests(suite):
657
"""Return all tests in a suite, recursing through nested suites"""
658
if isinstance(suite, unittest.TestCase):
660
elif isinstance(suite, unittest.TestSuite):
662
for r in iter_suite_tests(item):
665
raise Exception('unknown type %r for object %r'
666
% (type(suite), suite))
669
TestSkipped = testtools.testcase.TestSkipped
672
class TestNotApplicable(TestSkipped):
673
"""A test is not applicable to the situation where it was run.
675
This is only normally raised by parameterized tests, if they find that
676
the instance they're constructed upon does not support one aspect
681
# traceback._some_str fails to format exceptions that have the default
682
# __str__ which does an implicit ascii conversion. However, repr() on those
683
# objects works, for all that its not quite what the doctor may have ordered.
684
def _clever_some_str(value):
689
return repr(value).replace('\\n', '\n')
691
return '<unprintable %s object>' % type(value).__name__
693
traceback._some_str = _clever_some_str
696
# deprecated - use self.knownFailure(), or self.expectFailure.
697
KnownFailure = testtools.testcase._ExpectedFailure
700
class UnavailableFeature(Exception):
701
"""A feature required for this test was not available.
703
This can be considered a specialised form of SkippedTest.
705
The feature should be used to construct the exception.
709
class StringIOWrapper(object):
710
"""A wrapper around cStringIO which just adds an encoding attribute.
712
Internally we can check sys.stdout to see what the output encoding
713
should be. However, cStringIO has no encoding attribute that we can
714
set. So we wrap it instead.
719
def __init__(self, s=None):
721
self.__dict__['_cstring'] = StringIO(s)
723
self.__dict__['_cstring'] = StringIO()
725
def __getattr__(self, name, getattr=getattr):
726
return getattr(self.__dict__['_cstring'], name)
728
def __setattr__(self, name, val):
729
if name == 'encoding':
730
self.__dict__['encoding'] = val
732
return setattr(self._cstring, name, val)
735
class TestUIFactory(TextUIFactory):
736
"""A UI Factory for testing.
738
Hide the progress bar but emit note()s.
740
Allows get_password to be tested without real tty attached.
742
See also CannedInputUIFactory which lets you provide programmatic input in
745
# TODO: Capture progress events at the model level and allow them to be
746
# observed by tests that care.
748
# XXX: Should probably unify more with CannedInputUIFactory or a
749
# particular configuration of TextUIFactory, or otherwise have a clearer
750
# idea of how they're supposed to be different.
751
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
753
def __init__(self, stdout=None, stderr=None, stdin=None):
754
if stdin is not None:
755
# We use a StringIOWrapper to be able to test various
756
# encodings, but the user is still responsible to
757
# encode the string and to set the encoding attribute
758
# of StringIOWrapper.
759
stdin = StringIOWrapper(stdin)
760
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
762
def get_non_echoed_password(self):
763
"""Get password from stdin without trying to handle the echo mode"""
764
password = self.stdin.readline()
767
if password[-1] == '\n':
768
password = password[:-1]
771
def make_progress_view(self):
772
return NullProgressView()
775
class TestCase(testtools.TestCase):
776
"""Base class for bzr unit tests.
778
Tests that need access to disk resources should subclass
779
TestCaseInTempDir not TestCase.
781
Error and debug log messages are redirected from their usual
782
location into a temporary file, the contents of which can be
783
retrieved by _get_log(). We use a real OS file, not an in-memory object,
784
so that it can also capture file IO. When the test completes this file
785
is read into memory and removed from disk.
787
There are also convenience functions to invoke bzr's command-line
788
routine, and to build and check bzr trees.
790
In addition to the usual method of overriding tearDown(), this class also
791
allows subclasses to register functions into the _cleanups list, which is
792
run in order as the object is torn down. It's less likely this will be
793
accidentally overlooked.
796
_active_threads = None
797
_leaking_threads_tests = 0
798
_first_thread_leaker_id = None
799
_log_file_name = None
800
# record lsprof data when performing benchmark calls.
801
_gather_lsprof_in_benchmarks = False
803
def __init__(self, methodName='testMethod'):
804
super(TestCase, self).__init__(methodName)
806
self._directory_isolation = True
807
self.exception_handlers.insert(0,
808
(UnavailableFeature, self._do_unsupported_or_skip))
809
self.exception_handlers.insert(0,
810
(TestNotApplicable, self._do_not_applicable))
813
super(TestCase, self).setUp()
814
for feature in getattr(self, '_test_needs_features', []):
815
self.requireFeature(feature)
816
self._log_contents = None
817
self.addDetail("log", content.Content(content.ContentType("text",
818
"plain", {"charset": "utf8"}),
819
lambda:[self._get_log(keep_log_file=True)]))
820
self._cleanEnvironment()
823
self._benchcalls = []
824
self._benchtime = None
826
self._track_transports()
828
self._clear_debug_flags()
829
TestCase._active_threads = threading.activeCount()
830
self.addCleanup(self._check_leaked_threads)
835
pdb.Pdb().set_trace(sys._getframe().f_back)
837
def _check_leaked_threads(self):
838
active = threading.activeCount()
839
leaked_threads = active - TestCase._active_threads
840
TestCase._active_threads = active
841
# If some tests make the number of threads *decrease*, we'll consider
842
# that they are just observing old threads dieing, not agressively kill
843
# random threads. So we don't report these tests as leaking. The risk
844
# is that we have false positives that way (the test see 2 threads
845
# going away but leak one) but it seems less likely than the actual
846
# false positives (the test see threads going away and does not leak).
847
if leaked_threads > 0:
848
TestCase._leaking_threads_tests += 1
849
if TestCase._first_thread_leaker_id is None:
850
TestCase._first_thread_leaker_id = self.id()
852
def _clear_debug_flags(self):
853
"""Prevent externally set debug flags affecting tests.
855
Tests that want to use debug flags can just set them in the
856
debug_flags set during setup/teardown.
858
# Start with a copy of the current debug flags we can safely modify.
859
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
860
if 'allow_debug' not in selftest_debug_flags:
861
debug.debug_flags.clear()
862
if 'disable_lock_checks' not in selftest_debug_flags:
863
debug.debug_flags.add('strict_locks')
865
def _clear_hooks(self):
866
# prevent hooks affecting tests
867
self._preserved_hooks = {}
868
for key, factory in hooks.known_hooks.items():
869
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
870
current_hooks = hooks.known_hooks_key_to_object(key)
871
self._preserved_hooks[parent] = (name, current_hooks)
872
self.addCleanup(self._restoreHooks)
873
for key, factory in hooks.known_hooks.items():
874
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
875
setattr(parent, name, factory())
876
# this hook should always be installed
877
request._install_hook()
879
def disable_directory_isolation(self):
880
"""Turn off directory isolation checks."""
881
self._directory_isolation = False
883
def enable_directory_isolation(self):
884
"""Enable directory isolation checks."""
885
self._directory_isolation = True
887
def _silenceUI(self):
888
"""Turn off UI for duration of test"""
889
# by default the UI is off; tests can turn it on if they want it.
890
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
892
def _check_locks(self):
893
"""Check that all lock take/release actions have been paired."""
894
# We always check for mismatched locks. If a mismatch is found, we
895
# fail unless -Edisable_lock_checks is supplied to selftest, in which
896
# case we just print a warning.
898
acquired_locks = [lock for action, lock in self._lock_actions
899
if action == 'acquired']
900
released_locks = [lock for action, lock in self._lock_actions
901
if action == 'released']
902
broken_locks = [lock for action, lock in self._lock_actions
903
if action == 'broken']
904
# trivially, given the tests for lock acquistion and release, if we
905
# have as many in each list, it should be ok. Some lock tests also
906
# break some locks on purpose and should be taken into account by
907
# considering that breaking a lock is just a dirty way of releasing it.
908
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
909
message = ('Different number of acquired and '
910
'released or broken locks. (%s, %s + %s)' %
911
(acquired_locks, released_locks, broken_locks))
912
if not self._lock_check_thorough:
913
# Rather than fail, just warn
914
print "Broken test %s: %s" % (self, message)
918
def _track_locks(self):
919
"""Track lock activity during tests."""
920
self._lock_actions = []
921
if 'disable_lock_checks' in selftest_debug_flags:
922
self._lock_check_thorough = False
924
self._lock_check_thorough = True
926
self.addCleanup(self._check_locks)
927
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
928
self._lock_acquired, None)
929
_mod_lock.Lock.hooks.install_named_hook('lock_released',
930
self._lock_released, None)
931
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
932
self._lock_broken, None)
934
def _lock_acquired(self, result):
935
self._lock_actions.append(('acquired', result))
937
def _lock_released(self, result):
938
self._lock_actions.append(('released', result))
940
def _lock_broken(self, result):
941
self._lock_actions.append(('broken', result))
943
def permit_dir(self, name):
944
"""Permit a directory to be used by this test. See permit_url."""
945
name_transport = get_transport(name)
946
self.permit_url(name)
947
self.permit_url(name_transport.base)
949
def permit_url(self, url):
950
"""Declare that url is an ok url to use in this test.
952
Do this for memory transports, temporary test directory etc.
954
Do not do this for the current working directory, /tmp, or any other
955
preexisting non isolated url.
957
if not url.endswith('/'):
959
self._bzr_selftest_roots.append(url)
961
def permit_source_tree_branch_repo(self):
962
"""Permit the source tree bzr is running from to be opened.
964
Some code such as bzrlib.version attempts to read from the bzr branch
965
that bzr is executing from (if any). This method permits that directory
966
to be used in the test suite.
968
path = self.get_source_path()
969
self.record_directory_isolation()
972
workingtree.WorkingTree.open(path)
973
except (errors.NotBranchError, errors.NoWorkingTree):
976
self.enable_directory_isolation()
978
def _preopen_isolate_transport(self, transport):
979
"""Check that all transport openings are done in the test work area."""
980
while isinstance(transport, pathfilter.PathFilteringTransport):
981
# Unwrap pathfiltered transports
982
transport = transport.server.backing_transport.clone(
983
transport._filter('.'))
985
# ReadonlySmartTCPServer_for_testing decorates the backing transport
986
# urls it is given by prepending readonly+. This is appropriate as the
987
# client shouldn't know that the server is readonly (or not readonly).
988
# We could register all servers twice, with readonly+ prepending, but
989
# that makes for a long list; this is about the same but easier to
991
if url.startswith('readonly+'):
992
url = url[len('readonly+'):]
993
self._preopen_isolate_url(url)
995
def _preopen_isolate_url(self, url):
996
if not self._directory_isolation:
998
if self._directory_isolation == 'record':
999
self._bzr_selftest_roots.append(url)
1001
# This prevents all transports, including e.g. sftp ones backed on disk
1002
# from working unless they are explicitly granted permission. We then
1003
# depend on the code that sets up test transports to check that they are
1004
# appropriately isolated and enable their use by calling
1005
# self.permit_transport()
1006
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1007
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1008
% (url, self._bzr_selftest_roots))
1010
def record_directory_isolation(self):
1011
"""Gather accessed directories to permit later access.
1013
This is used for tests that access the branch bzr is running from.
1015
self._directory_isolation = "record"
1017
def start_server(self, transport_server, backing_server=None):
1018
"""Start transport_server for this test.
1020
This starts the server, registers a cleanup for it and permits the
1021
server's urls to be used.
1023
if backing_server is None:
1024
transport_server.start_server()
1026
transport_server.start_server(backing_server)
1027
self.addCleanup(transport_server.stop_server)
1028
# Obtain a real transport because if the server supplies a password, it
1029
# will be hidden from the base on the client side.
1030
t = get_transport(transport_server.get_url())
1031
# Some transport servers effectively chroot the backing transport;
1032
# others like SFTPServer don't - users of the transport can walk up the
1033
# transport to read the entire backing transport. This wouldn't matter
1034
# except that the workdir tests are given - and that they expect the
1035
# server's url to point at - is one directory under the safety net. So
1036
# Branch operations into the transport will attempt to walk up one
1037
# directory. Chrooting all servers would avoid this but also mean that
1038
# we wouldn't be testing directly against non-root urls. Alternatively
1039
# getting the test framework to start the server with a backing server
1040
# at the actual safety net directory would work too, but this then
1041
# means that the self.get_url/self.get_transport methods would need
1042
# to transform all their results. On balance its cleaner to handle it
1043
# here, and permit a higher url when we have one of these transports.
1044
if t.base.endswith('/work/'):
1045
# we have safety net/test root/work
1046
t = t.clone('../..')
1047
elif isinstance(transport_server,
1048
test_server.SmartTCPServer_for_testing):
1049
# The smart server adds a path similar to work, which is traversed
1050
# up from by the client. But the server is chrooted - the actual
1051
# backing transport is not escaped from, and VFS requests to the
1052
# root will error (because they try to escape the chroot).
1054
while t2.base != t.base:
1057
self.permit_url(t.base)
1059
def _track_transports(self):
1060
"""Install checks for transport usage."""
1061
# TestCase has no safe place it can write to.
1062
self._bzr_selftest_roots = []
1063
# Currently the easiest way to be sure that nothing is going on is to
1064
# hook into bzr dir opening. This leaves a small window of error for
1065
# transport tests, but they are well known, and we can improve on this
1067
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1068
self._preopen_isolate_transport, "Check bzr directories are safe.")
1070
def _ndiff_strings(self, a, b):
1071
"""Return ndiff between two strings containing lines.
1073
A trailing newline is added if missing to make the strings
1075
if b and b[-1] != '\n':
1077
if a and a[-1] != '\n':
1079
difflines = difflib.ndiff(a.splitlines(True),
1081
linejunk=lambda x: False,
1082
charjunk=lambda x: False)
1083
return ''.join(difflines)
1085
def assertEqual(self, a, b, message=''):
1089
except UnicodeError, e:
1090
# If we can't compare without getting a UnicodeError, then
1091
# obviously they are different
1092
mutter('UnicodeError: %s', e)
1095
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
1097
pformat(a), pformat(b)))
1099
assertEquals = assertEqual
1101
def assertEqualDiff(self, a, b, message=None):
1102
"""Assert two texts are equal, if not raise an exception.
1104
This is intended for use with multi-line strings where it can
1105
be hard to find the differences by eye.
1107
# TODO: perhaps override assertEquals to call this for strings?
1111
message = "texts not equal:\n"
1113
message = 'first string is missing a final newline.\n'
1115
message = 'second string is missing a final newline.\n'
1116
raise AssertionError(message +
1117
self._ndiff_strings(a, b))
1119
def assertEqualMode(self, mode, mode_test):
1120
self.assertEqual(mode, mode_test,
1121
'mode mismatch %o != %o' % (mode, mode_test))
1123
def assertEqualStat(self, expected, actual):
1124
"""assert that expected and actual are the same stat result.
1126
:param expected: A stat result.
1127
:param actual: A stat result.
1128
:raises AssertionError: If the expected and actual stat values differ
1129
other than by atime.
1131
self.assertEqual(expected.st_size, actual.st_size,
1132
'st_size did not match')
1133
self.assertEqual(expected.st_mtime, actual.st_mtime,
1134
'st_mtime did not match')
1135
self.assertEqual(expected.st_ctime, actual.st_ctime,
1136
'st_ctime did not match')
1137
if sys.platform != 'win32':
1138
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1139
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1140
# odd. Regardless we shouldn't actually try to assert anything
1141
# about their values
1142
self.assertEqual(expected.st_dev, actual.st_dev,
1143
'st_dev did not match')
1144
self.assertEqual(expected.st_ino, actual.st_ino,
1145
'st_ino did not match')
1146
self.assertEqual(expected.st_mode, actual.st_mode,
1147
'st_mode did not match')
1149
def assertLength(self, length, obj_with_len):
1150
"""Assert that obj_with_len is of length length."""
1151
if len(obj_with_len) != length:
1152
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1153
length, len(obj_with_len), obj_with_len))
1155
def assertLogsError(self, exception_class, func, *args, **kwargs):
1156
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1158
from bzrlib import trace
1160
orig_log_exception_quietly = trace.log_exception_quietly
1163
orig_log_exception_quietly()
1164
captured.append(sys.exc_info())
1165
trace.log_exception_quietly = capture
1166
func(*args, **kwargs)
1168
trace.log_exception_quietly = orig_log_exception_quietly
1169
self.assertLength(1, captured)
1170
err = captured[0][1]
1171
self.assertIsInstance(err, exception_class)
1174
def assertPositive(self, val):
1175
"""Assert that val is greater than 0."""
1176
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1178
def assertNegative(self, val):
1179
"""Assert that val is less than 0."""
1180
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1182
def assertStartsWith(self, s, prefix):
1183
if not s.startswith(prefix):
1184
raise AssertionError('string %r does not start with %r' % (s, prefix))
1186
def assertEndsWith(self, s, suffix):
1187
"""Asserts that s ends with suffix."""
1188
if not s.endswith(suffix):
1189
raise AssertionError('string %r does not end with %r' % (s, suffix))
1191
def assertContainsRe(self, haystack, needle_re, flags=0):
1192
"""Assert that a contains something matching a regular expression."""
1193
if not re.search(needle_re, haystack, flags):
1194
if '\n' in haystack or len(haystack) > 60:
1195
# a long string, format it in a more readable way
1196
raise AssertionError(
1197
'pattern "%s" not found in\n"""\\\n%s"""\n'
1198
% (needle_re, haystack))
1200
raise AssertionError('pattern "%s" not found in "%s"'
1201
% (needle_re, haystack))
1203
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1204
"""Assert that a does not match a regular expression"""
1205
if re.search(needle_re, haystack, flags):
1206
raise AssertionError('pattern "%s" found in "%s"'
1207
% (needle_re, haystack))
1209
def assertContainsString(self, haystack, needle):
1210
if haystack.find(needle) == -1:
1211
self.fail("string %r not found in '''%s'''" % (needle, haystack))
1213
def assertSubset(self, sublist, superlist):
1214
"""Assert that every entry in sublist is present in superlist."""
1215
missing = set(sublist) - set(superlist)
1216
if len(missing) > 0:
1217
raise AssertionError("value(s) %r not present in container %r" %
1218
(missing, superlist))
1220
def assertListRaises(self, excClass, func, *args, **kwargs):
1221
"""Fail unless excClass is raised when the iterator from func is used.
1223
Many functions can return generators this makes sure
1224
to wrap them in a list() call to make sure the whole generator
1225
is run, and that the proper exception is raised.
1228
list(func(*args, **kwargs))
1232
if getattr(excClass,'__name__', None) is not None:
1233
excName = excClass.__name__
1235
excName = str(excClass)
1236
raise self.failureException, "%s not raised" % excName
1238
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1239
"""Assert that a callable raises a particular exception.
1241
:param excClass: As for the except statement, this may be either an
1242
exception class, or a tuple of classes.
1243
:param callableObj: A callable, will be passed ``*args`` and
1246
Returns the exception so that you can examine it.
1249
callableObj(*args, **kwargs)
1253
if getattr(excClass,'__name__', None) is not None:
1254
excName = excClass.__name__
1257
excName = str(excClass)
1258
raise self.failureException, "%s not raised" % excName
1260
def assertIs(self, left, right, message=None):
1261
if not (left is right):
1262
if message is not None:
1263
raise AssertionError(message)
1265
raise AssertionError("%r is not %r." % (left, right))
1267
def assertIsNot(self, left, right, message=None):
1269
if message is not None:
1270
raise AssertionError(message)
1272
raise AssertionError("%r is %r." % (left, right))
1274
def assertTransportMode(self, transport, path, mode):
1275
"""Fail if a path does not have mode "mode".
1277
If modes are not supported on this transport, the assertion is ignored.
1279
if not transport._can_roundtrip_unix_modebits():
1281
path_stat = transport.stat(path)
1282
actual_mode = stat.S_IMODE(path_stat.st_mode)
1283
self.assertEqual(mode, actual_mode,
1284
'mode of %r incorrect (%s != %s)'
1285
% (path, oct(mode), oct(actual_mode)))
1287
def assertIsSameRealPath(self, path1, path2):
1288
"""Fail if path1 and path2 points to different files"""
1289
self.assertEqual(osutils.realpath(path1),
1290
osutils.realpath(path2),
1291
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1293
def assertIsInstance(self, obj, kls, msg=None):
1294
"""Fail if obj is not an instance of kls
1296
:param msg: Supplementary message to show if the assertion fails.
1298
if not isinstance(obj, kls):
1299
m = "%r is an instance of %s rather than %s" % (
1300
obj, obj.__class__, kls)
1305
def assertFileEqual(self, content, path):
1306
"""Fail if path does not contain 'content'."""
1307
self.failUnlessExists(path)
1308
f = file(path, 'rb')
1313
self.assertEqualDiff(content, s)
1315
def failUnlessExists(self, path):
1316
"""Fail unless path or paths, which may be abs or relative, exist."""
1317
if not isinstance(path, basestring):
1319
self.failUnlessExists(p)
1321
self.failUnless(osutils.lexists(path),path+" does not exist")
1323
def failIfExists(self, path):
1324
"""Fail if path or paths, which may be abs or relative, exist."""
1325
if not isinstance(path, basestring):
1327
self.failIfExists(p)
1329
self.failIf(osutils.lexists(path),path+" exists")
1331
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1332
"""A helper for callDeprecated and applyDeprecated.
1334
:param a_callable: A callable to call.
1335
:param args: The positional arguments for the callable
1336
:param kwargs: The keyword arguments for the callable
1337
:return: A tuple (warnings, result). result is the result of calling
1338
a_callable(``*args``, ``**kwargs``).
1341
def capture_warnings(msg, cls=None, stacklevel=None):
1342
# we've hooked into a deprecation specific callpath,
1343
# only deprecations should getting sent via it.
1344
self.assertEqual(cls, DeprecationWarning)
1345
local_warnings.append(msg)
1346
original_warning_method = symbol_versioning.warn
1347
symbol_versioning.set_warning_method(capture_warnings)
1349
result = a_callable(*args, **kwargs)
1351
symbol_versioning.set_warning_method(original_warning_method)
1352
return (local_warnings, result)
1354
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1355
"""Call a deprecated callable without warning the user.
1357
Note that this only captures warnings raised by symbol_versioning.warn,
1358
not other callers that go direct to the warning module.
1360
To test that a deprecated method raises an error, do something like
1363
self.assertRaises(errors.ReservedId,
1364
self.applyDeprecated,
1365
deprecated_in((1, 5, 0)),
1369
:param deprecation_format: The deprecation format that the callable
1370
should have been deprecated with. This is the same type as the
1371
parameter to deprecated_method/deprecated_function. If the
1372
callable is not deprecated with this format, an assertion error
1374
:param a_callable: A callable to call. This may be a bound method or
1375
a regular function. It will be called with ``*args`` and
1377
:param args: The positional arguments for the callable
1378
:param kwargs: The keyword arguments for the callable
1379
:return: The result of a_callable(``*args``, ``**kwargs``)
1381
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1383
expected_first_warning = symbol_versioning.deprecation_string(
1384
a_callable, deprecation_format)
1385
if len(call_warnings) == 0:
1386
self.fail("No deprecation warning generated by call to %s" %
1388
self.assertEqual(expected_first_warning, call_warnings[0])
1391
def callCatchWarnings(self, fn, *args, **kw):
1392
"""Call a callable that raises python warnings.
1394
The caller's responsible for examining the returned warnings.
1396
If the callable raises an exception, the exception is not
1397
caught and propagates up to the caller. In that case, the list
1398
of warnings is not available.
1400
:returns: ([warning_object, ...], fn_result)
1402
# XXX: This is not perfect, because it completely overrides the
1403
# warnings filters, and some code may depend on suppressing particular
1404
# warnings. It's the easiest way to insulate ourselves from -Werror,
1405
# though. -- Andrew, 20071062
1407
def _catcher(message, category, filename, lineno, file=None, line=None):
1408
# despite the name, 'message' is normally(?) a Warning subclass
1410
wlist.append(message)
1411
saved_showwarning = warnings.showwarning
1412
saved_filters = warnings.filters
1414
warnings.showwarning = _catcher
1415
warnings.filters = []
1416
result = fn(*args, **kw)
1418
warnings.showwarning = saved_showwarning
1419
warnings.filters = saved_filters
1420
return wlist, result
1422
def callDeprecated(self, expected, callable, *args, **kwargs):
1423
"""Assert that a callable is deprecated in a particular way.
1425
This is a very precise test for unusual requirements. The
1426
applyDeprecated helper function is probably more suited for most tests
1427
as it allows you to simply specify the deprecation format being used
1428
and will ensure that that is issued for the function being called.
1430
Note that this only captures warnings raised by symbol_versioning.warn,
1431
not other callers that go direct to the warning module. To catch
1432
general warnings, use callCatchWarnings.
1434
:param expected: a list of the deprecation warnings expected, in order
1435
:param callable: The callable to call
1436
:param args: The positional arguments for the callable
1437
:param kwargs: The keyword arguments for the callable
1439
call_warnings, result = self._capture_deprecation_warnings(callable,
1441
self.assertEqual(expected, call_warnings)
1444
def _startLogFile(self):
1445
"""Send bzr and test log messages to a temporary file.
1447
The file is removed as the test is torn down.
1449
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1450
self._log_file = os.fdopen(fileno, 'w+')
1451
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1452
self._log_file_name = name
1453
self.addCleanup(self._finishLogFile)
1455
def _finishLogFile(self):
1456
"""Finished with the log file.
1458
Close the file and delete it, unless setKeepLogfile was called.
1460
if bzrlib.trace._trace_file:
1461
# flush the log file, to get all content
1462
bzrlib.trace._trace_file.flush()
1463
bzrlib.trace.pop_log_file(self._log_memento)
1464
# Cache the log result and delete the file on disk
1465
self._get_log(False)
1467
def thisFailsStrictLockCheck(self):
1468
"""It is known that this test would fail with -Dstrict_locks.
1470
By default, all tests are run with strict lock checking unless
1471
-Edisable_lock_checks is supplied. However there are some tests which
1472
we know fail strict locks at this point that have not been fixed.
1473
They should call this function to disable the strict checking.
1475
This should be used sparingly, it is much better to fix the locking
1476
issues rather than papering over the problem by calling this function.
1478
debug.debug_flags.discard('strict_locks')
1480
def addCleanup(self, callable, *args, **kwargs):
1481
"""Arrange to run a callable when this case is torn down.
1483
Callables are run in the reverse of the order they are registered,
1484
ie last-in first-out.
1486
self._cleanups.append((callable, args, kwargs))
1488
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1489
"""Overrides an object attribute restoring it after the test.
1491
:param obj: The object that will be mutated.
1493
:param attr_name: The attribute name we want to preserve/override in
1496
:param new: The optional value we want to set the attribute to.
1498
:returns: The actual attr value.
1500
value = getattr(obj, attr_name)
1501
# The actual value is captured by the call below
1502
self.addCleanup(setattr, obj, attr_name, value)
1503
if new is not _unitialized_attr:
1504
setattr(obj, attr_name, new)
1507
def _cleanEnvironment(self):
1509
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1510
'HOME': os.getcwd(),
1511
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1512
# tests do check our impls match APPDATA
1513
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1517
'BZREMAIL': None, # may still be present in the environment
1519
'BZR_PROGRESS_BAR': None,
1521
'BZR_PLUGIN_PATH': None,
1522
'BZR_CONCURRENCY': None,
1523
# Make sure that any text ui tests are consistent regardless of
1524
# the environment the test case is run in; you may want tests that
1525
# test other combinations. 'dumb' is a reasonable guess for tests
1526
# going to a pipe or a StringIO.
1530
'BZR_COLUMNS': '80',
1532
'SSH_AUTH_SOCK': None,
1536
'https_proxy': None,
1537
'HTTPS_PROXY': None,
1542
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1543
# least. If you do (care), please update this comment
1547
'BZR_REMOTE_PATH': None,
1548
# Generally speaking, we don't want apport reporting on crashes in
1549
# the test envirnoment unless we're specifically testing apport,
1550
# so that it doesn't leak into the real system environment. We
1551
# use an env var so it propagates to subprocesses.
1552
'APPORT_DISABLE': '1',
1555
self.addCleanup(self._restoreEnvironment)
1556
for name, value in new_env.iteritems():
1557
self._captureVar(name, value)
1559
def _captureVar(self, name, newvalue):
1560
"""Set an environment variable, and reset it when finished."""
1561
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1563
def _restoreEnvironment(self):
1564
for name, value in self._old_env.iteritems():
1565
osutils.set_or_unset_env(name, value)
1567
def _restoreHooks(self):
1568
for klass, (name, hooks) in self._preserved_hooks.items():
1569
setattr(klass, name, hooks)
1571
def knownFailure(self, reason):
1572
"""This test has failed for some known reason."""
1573
raise KnownFailure(reason)
1575
def _do_skip(self, result, reason):
1576
addSkip = getattr(result, 'addSkip', None)
1577
if not callable(addSkip):
1578
result.addSuccess(result)
1580
addSkip(self, reason)
1583
def _do_known_failure(self, result, e):
1584
err = sys.exc_info()
1585
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1586
if addExpectedFailure is not None:
1587
addExpectedFailure(self, err)
1589
result.addSuccess(self)
1592
def _do_not_applicable(self, result, e):
1594
reason = 'No reason given'
1597
addNotApplicable = getattr(result, 'addNotApplicable', None)
1598
if addNotApplicable is not None:
1599
result.addNotApplicable(self, reason)
1601
self._do_skip(result, reason)
1604
def _do_unsupported_or_skip(self, result, e):
1606
addNotSupported = getattr(result, 'addNotSupported', None)
1607
if addNotSupported is not None:
1608
result.addNotSupported(self, reason)
1610
self._do_skip(result, reason)
1612
def time(self, callable, *args, **kwargs):
1613
"""Run callable and accrue the time it takes to the benchmark time.
1615
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1616
this will cause lsprofile statistics to be gathered and stored in
1619
if self._benchtime is None:
1620
self.addDetail('benchtime', content.Content(content.ContentType(
1621
"text", "plain"), lambda:[str(self._benchtime)]))
1625
if not self._gather_lsprof_in_benchmarks:
1626
return callable(*args, **kwargs)
1628
# record this benchmark
1629
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1631
self._benchcalls.append(((callable, args, kwargs), stats))
1634
self._benchtime += time.time() - start
1636
def log(self, *args):
1639
def _get_log(self, keep_log_file=False):
1640
"""Internal helper to get the log from bzrlib.trace for this test.
1642
Please use self.getDetails, or self.get_log to access this in test case
1645
:param keep_log_file: When True, if the log is still a file on disk
1646
leave it as a file on disk. When False, if the log is still a file
1647
on disk, the log file is deleted and the log preserved as
1649
:return: A string containing the log.
1651
if self._log_contents is not None:
1653
self._log_contents.decode('utf8')
1654
except UnicodeDecodeError:
1655
unicodestr = self._log_contents.decode('utf8', 'replace')
1656
self._log_contents = unicodestr.encode('utf8')
1657
return self._log_contents
1659
if bzrlib.trace._trace_file:
1660
# flush the log file, to get all content
1661
bzrlib.trace._trace_file.flush()
1662
if self._log_file_name is not None:
1663
logfile = open(self._log_file_name)
1665
log_contents = logfile.read()
1669
log_contents.decode('utf8')
1670
except UnicodeDecodeError:
1671
unicodestr = log_contents.decode('utf8', 'replace')
1672
log_contents = unicodestr.encode('utf8')
1673
if not keep_log_file:
1674
self._log_file.close()
1675
self._log_file = None
1676
# Permit multiple calls to get_log until we clean it up in
1678
self._log_contents = log_contents
1680
os.remove(self._log_file_name)
1682
if sys.platform == 'win32' and e.errno == errno.EACCES:
1683
sys.stderr.write(('Unable to delete log file '
1684
' %r\n' % self._log_file_name))
1687
self._log_file_name = None
1690
return "No log file content and no log file name."
1693
"""Get a unicode string containing the log from bzrlib.trace.
1695
Undecodable characters are replaced.
1697
return u"".join(self.getDetails()['log'].iter_text())
1699
def requireFeature(self, feature):
1700
"""This test requires a specific feature is available.
1702
:raises UnavailableFeature: When feature is not available.
1704
if not feature.available():
1705
raise UnavailableFeature(feature)
1707
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1709
"""Run bazaar command line, splitting up a string command line."""
1710
if isinstance(args, basestring):
1711
# shlex don't understand unicode strings,
1712
# so args should be plain string (bialix 20070906)
1713
args = list(shlex.split(str(args)))
1714
return self._run_bzr_core(args, retcode=retcode,
1715
encoding=encoding, stdin=stdin, working_dir=working_dir,
1718
def _run_bzr_core(self, args, retcode, encoding, stdin,
1720
# Clear chk_map page cache, because the contents are likely to mask
1722
chk_map.clear_cache()
1723
if encoding is None:
1724
encoding = osutils.get_user_encoding()
1725
stdout = StringIOWrapper()
1726
stderr = StringIOWrapper()
1727
stdout.encoding = encoding
1728
stderr.encoding = encoding
1730
self.log('run bzr: %r', args)
1731
# FIXME: don't call into logging here
1732
handler = logging.StreamHandler(stderr)
1733
handler.setLevel(logging.INFO)
1734
logger = logging.getLogger('')
1735
logger.addHandler(handler)
1736
old_ui_factory = ui.ui_factory
1737
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1740
if working_dir is not None:
1741
cwd = osutils.getcwd()
1742
os.chdir(working_dir)
1746
result = self.apply_redirected(ui.ui_factory.stdin,
1748
bzrlib.commands.run_bzr_catch_user_errors,
1750
except KeyboardInterrupt:
1751
# Reraise KeyboardInterrupt with contents of redirected stdout
1752
# and stderr as arguments, for tests which are interested in
1753
# stdout and stderr and are expecting the exception.
1754
out = stdout.getvalue()
1755
err = stderr.getvalue()
1757
self.log('output:\n%r', out)
1759
self.log('errors:\n%r', err)
1760
raise KeyboardInterrupt(out, err)
1762
logger.removeHandler(handler)
1763
ui.ui_factory = old_ui_factory
1767
out = stdout.getvalue()
1768
err = stderr.getvalue()
1770
self.log('output:\n%r', out)
1772
self.log('errors:\n%r', err)
1773
if retcode is not None:
1774
self.assertEquals(retcode, result,
1775
message='Unexpected return code')
1776
return result, out, err
1778
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1779
working_dir=None, error_regexes=[], output_encoding=None):
1780
"""Invoke bzr, as if it were run from the command line.
1782
The argument list should not include the bzr program name - the
1783
first argument is normally the bzr command. Arguments may be
1784
passed in three ways:
1786
1- A list of strings, eg ["commit", "a"]. This is recommended
1787
when the command contains whitespace or metacharacters, or
1788
is built up at run time.
1790
2- A single string, eg "add a". This is the most convenient
1791
for hardcoded commands.
1793
This runs bzr through the interface that catches and reports
1794
errors, and with logging set to something approximating the
1795
default, so that error reporting can be checked.
1797
This should be the main method for tests that want to exercise the
1798
overall behavior of the bzr application (rather than a unit test
1799
or a functional test of the library.)
1801
This sends the stdout/stderr results into the test's log,
1802
where it may be useful for debugging. See also run_captured.
1804
:keyword stdin: A string to be used as stdin for the command.
1805
:keyword retcode: The status code the command should return;
1807
:keyword working_dir: The directory to run the command in
1808
:keyword error_regexes: A list of expected error messages. If
1809
specified they must be seen in the error output of the command.
1811
retcode, out, err = self._run_bzr_autosplit(
1816
working_dir=working_dir,
1818
self.assertIsInstance(error_regexes, (list, tuple))
1819
for regex in error_regexes:
1820
self.assertContainsRe(err, regex)
1823
def run_bzr_error(self, error_regexes, *args, **kwargs):
1824
"""Run bzr, and check that stderr contains the supplied regexes
1826
:param error_regexes: Sequence of regular expressions which
1827
must each be found in the error output. The relative ordering
1829
:param args: command-line arguments for bzr
1830
:param kwargs: Keyword arguments which are interpreted by run_bzr
1831
This function changes the default value of retcode to be 3,
1832
since in most cases this is run when you expect bzr to fail.
1834
:return: (out, err) The actual output of running the command (in case
1835
you want to do more inspection)
1839
# Make sure that commit is failing because there is nothing to do
1840
self.run_bzr_error(['no changes to commit'],
1841
['commit', '-m', 'my commit comment'])
1842
# Make sure --strict is handling an unknown file, rather than
1843
# giving us the 'nothing to do' error
1844
self.build_tree(['unknown'])
1845
self.run_bzr_error(['Commit refused because there are unknown files'],
1846
['commit', --strict', '-m', 'my commit comment'])
1848
kwargs.setdefault('retcode', 3)
1849
kwargs['error_regexes'] = error_regexes
1850
out, err = self.run_bzr(*args, **kwargs)
1853
def run_bzr_subprocess(self, *args, **kwargs):
1854
"""Run bzr in a subprocess for testing.
1856
This starts a new Python interpreter and runs bzr in there.
1857
This should only be used for tests that have a justifiable need for
1858
this isolation: e.g. they are testing startup time, or signal
1859
handling, or early startup code, etc. Subprocess code can't be
1860
profiled or debugged so easily.
1862
:keyword retcode: The status code that is expected. Defaults to 0. If
1863
None is supplied, the status code is not checked.
1864
:keyword env_changes: A dictionary which lists changes to environment
1865
variables. A value of None will unset the env variable.
1866
The values must be strings. The change will only occur in the
1867
child, so you don't need to fix the environment after running.
1868
:keyword universal_newlines: Convert CRLF => LF
1869
:keyword allow_plugins: By default the subprocess is run with
1870
--no-plugins to ensure test reproducibility. Also, it is possible
1871
for system-wide plugins to create unexpected output on stderr,
1872
which can cause unnecessary test failures.
1874
env_changes = kwargs.get('env_changes', {})
1875
working_dir = kwargs.get('working_dir', None)
1876
allow_plugins = kwargs.get('allow_plugins', False)
1878
if isinstance(args[0], list):
1880
elif isinstance(args[0], basestring):
1881
args = list(shlex.split(args[0]))
1883
raise ValueError("passing varargs to run_bzr_subprocess")
1884
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1885
working_dir=working_dir,
1886
allow_plugins=allow_plugins)
1887
# We distinguish between retcode=None and retcode not passed.
1888
supplied_retcode = kwargs.get('retcode', 0)
1889
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1890
universal_newlines=kwargs.get('universal_newlines', False),
1893
def start_bzr_subprocess(self, process_args, env_changes=None,
1894
skip_if_plan_to_signal=False,
1896
allow_plugins=False):
1897
"""Start bzr in a subprocess for testing.
1899
This starts a new Python interpreter and runs bzr in there.
1900
This should only be used for tests that have a justifiable need for
1901
this isolation: e.g. they are testing startup time, or signal
1902
handling, or early startup code, etc. Subprocess code can't be
1903
profiled or debugged so easily.
1905
:param process_args: a list of arguments to pass to the bzr executable,
1906
for example ``['--version']``.
1907
:param env_changes: A dictionary which lists changes to environment
1908
variables. A value of None will unset the env variable.
1909
The values must be strings. The change will only occur in the
1910
child, so you don't need to fix the environment after running.
1911
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1913
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1915
:returns: Popen object for the started process.
1917
if skip_if_plan_to_signal:
1918
if not getattr(os, 'kill', None):
1919
raise TestSkipped("os.kill not available.")
1921
if env_changes is None:
1925
def cleanup_environment():
1926
for env_var, value in env_changes.iteritems():
1927
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1929
def restore_environment():
1930
for env_var, value in old_env.iteritems():
1931
osutils.set_or_unset_env(env_var, value)
1933
bzr_path = self.get_bzr_path()
1936
if working_dir is not None:
1937
cwd = osutils.getcwd()
1938
os.chdir(working_dir)
1941
# win32 subprocess doesn't support preexec_fn
1942
# so we will avoid using it on all platforms, just to
1943
# make sure the code path is used, and we don't break on win32
1944
cleanup_environment()
1945
command = [sys.executable]
1946
# frozen executables don't need the path to bzr
1947
if getattr(sys, "frozen", None) is None:
1948
command.append(bzr_path)
1949
if not allow_plugins:
1950
command.append('--no-plugins')
1951
command.extend(process_args)
1952
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1954
restore_environment()
1960
def _popen(self, *args, **kwargs):
1961
"""Place a call to Popen.
1963
Allows tests to override this method to intercept the calls made to
1964
Popen for introspection.
1966
return Popen(*args, **kwargs)
1968
def get_source_path(self):
1969
"""Return the path of the directory containing bzrlib."""
1970
return os.path.dirname(os.path.dirname(bzrlib.__file__))
1972
def get_bzr_path(self):
1973
"""Return the path of the 'bzr' executable for this test suite."""
1974
bzr_path = self.get_source_path()+'/bzr'
1975
if not os.path.isfile(bzr_path):
1976
# We are probably installed. Assume sys.argv is the right file
1977
bzr_path = sys.argv[0]
1980
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1981
universal_newlines=False, process_args=None):
1982
"""Finish the execution of process.
1984
:param process: the Popen object returned from start_bzr_subprocess.
1985
:param retcode: The status code that is expected. Defaults to 0. If
1986
None is supplied, the status code is not checked.
1987
:param send_signal: an optional signal to send to the process.
1988
:param universal_newlines: Convert CRLF => LF
1989
:returns: (stdout, stderr)
1991
if send_signal is not None:
1992
os.kill(process.pid, send_signal)
1993
out, err = process.communicate()
1995
if universal_newlines:
1996
out = out.replace('\r\n', '\n')
1997
err = err.replace('\r\n', '\n')
1999
if retcode is not None and retcode != process.returncode:
2000
if process_args is None:
2001
process_args = "(unknown args)"
2002
mutter('Output of bzr %s:\n%s', process_args, out)
2003
mutter('Error for bzr %s:\n%s', process_args, err)
2004
self.fail('Command bzr %s failed with retcode %s != %s'
2005
% (process_args, retcode, process.returncode))
33
class TestBase(TestCase):
34
"""Base class for bzr test cases.
36
Just defines some useful helper functions; doesn't actually test
40
# TODO: Special methods to invoke bzr, so that we can run it
41
# through a specified Python intepreter
43
OVERRIDE_PYTHON = None # to run with alternative python 'python'
49
def formcmd(self, cmd):
50
if isinstance(cmd, basestring):
55
if self.OVERRIDE_PYTHON:
56
cmd.insert(0, self.OVERRIDE_PYTHON)
58
self.log('$ %r' % cmd)
63
def runcmd(self, cmd, retcode=0):
64
"""Run one command and check the return code.
66
Returns a tuple of (stdout,stderr) strings.
68
If a single string is based, it is split into words.
69
For commands that are not simple space-separated words, please
70
pass a list instead."""
71
cmd = self.formcmd(cmd)
73
self.log('$ ' + ' '.join(cmd))
74
actual_retcode = call(cmd, stdout=self.TEST_LOG, stderr=self.TEST_LOG)
76
if retcode != actual_retcode:
77
raise CommandFailed("test failed: %r returned %d, expected %d"
78
% (cmd, actual_retcode, retcode))
81
def backtick(self, cmd, retcode=0):
82
"""Run a command and return its output"""
83
cmd = self.formcmd(cmd)
84
child = Popen(cmd, stdout=PIPE, stderr=self.TEST_LOG)
85
outd, errd = child.communicate()
87
actual_retcode = child.wait()
89
outd = outd.replace('\r', '')
91
if retcode != actual_retcode:
92
raise CommandFailed("test failed: %r returned %d, expected %d"
93
% (cmd, actual_retcode, retcode))
99
def build_tree(self, shape):
100
"""Build a test tree according to a pattern.
102
shape is a sequence of file specifications. If the final
103
character is '/', a directory is created.
105
This doesn't add anything to a branch.
107
# XXX: It's OK to just create them using forward slashes on windows?
110
assert isinstance(name, basestring)
115
print >>f, "contents of", name
120
"""Log a message to a progress file"""
121
self._log_buf = self._log_buf + str(msg) + '\n'
122
print >>self.TEST_LOG, msg
2008
125
def check_inventory_shape(self, inv, shape):
2009
"""Compare an inventory to a list of expected names.
127
Compare an inventory to a list of expected names.
2011
129
Fail if they are not precisely equal.
2014
132
shape = list(shape) # copy
2015
133
for path, ie in inv.entries():
2016
134
name = path.replace('\\', '/')
2017
if ie.kind == 'directory':
2018
136
name = name + '/'
2019
137
if name in shape:
2020
138
shape.remove(name)
2022
140
extras.append(name)
2024
self.fail("expected paths not found in inventory: %r" % shape)
142
self.fail("expcted paths not found in inventory: %r" % shape)
2026
144
self.fail("unexpected paths found in inventory: %r" % extras)
2028
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2029
a_callable=None, *args, **kwargs):
2030
"""Call callable with redirected std io pipes.
2032
Returns the return code."""
2033
if not callable(a_callable):
2034
raise ValueError("a_callable must be callable.")
2036
stdin = StringIO("")
2038
if getattr(self, "_log_file", None) is not None:
2039
stdout = self._log_file
2043
if getattr(self, "_log_file", None is not None):
2044
stderr = self._log_file
2047
real_stdin = sys.stdin
2048
real_stdout = sys.stdout
2049
real_stderr = sys.stderr
2054
return a_callable(*args, **kwargs)
2056
sys.stdout = real_stdout
2057
sys.stderr = real_stderr
2058
sys.stdin = real_stdin
2060
def reduceLockdirTimeout(self):
2061
"""Reduce the default lock timeout for the duration of the test, so that
2062
if LockContention occurs during a test, it does so quickly.
2064
Tests that expect to provoke LockContention errors should call this.
2066
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2068
def make_utf8_encoded_stringio(self, encoding_type=None):
2069
"""Return a StringIOWrapper instance, that will encode Unicode
2072
if encoding_type is None:
2073
encoding_type = 'strict'
2075
output_encoding = 'utf-8'
2076
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2077
sio.encoding = output_encoding
2080
def disable_verb(self, verb):
2081
"""Disable a smart server verb for one test."""
2082
from bzrlib.smart import request
2083
request_handlers = request.request_handlers
2084
orig_method = request_handlers.get(verb)
2085
request_handlers.remove(verb)
2086
self.addCleanup(request_handlers.register, verb, orig_method)
2089
class CapturedCall(object):
2090
"""A helper for capturing smart server calls for easy debug analysis."""
2092
def __init__(self, params, prefix_length):
2093
"""Capture the call with params and skip prefix_length stack frames."""
2096
# The last 5 frames are the __init__, the hook frame, and 3 smart
2097
# client frames. Beyond this we could get more clever, but this is good
2099
stack = traceback.extract_stack()[prefix_length:-5]
2100
self.stack = ''.join(traceback.format_list(stack))
2103
return self.call.method
2106
return self.call.method
2112
class TestCaseWithMemoryTransport(TestCase):
2113
"""Common test class for tests that do not need disk resources.
2115
Tests that need disk resources should derive from TestCaseWithTransport.
2117
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2119
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2120
a directory which does not exist. This serves to help ensure test isolation
2121
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2122
must exist. However, TestCaseWithMemoryTransport does not offer local
2123
file defaults for the transport in tests, nor does it obey the command line
2124
override, so tests that accidentally write to the common directory should
2127
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2128
a .bzr directory that stops us ascending higher into the filesystem.
2134
def __init__(self, methodName='runTest'):
2135
# allow test parameterization after test construction and before test
2136
# execution. Variables that the parameterizer sets need to be
2137
# ones that are not set by setUp, or setUp will trash them.
2138
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2139
self.vfs_transport_factory = default_transport
2140
self.transport_server = None
2141
self.transport_readonly_server = None
2142
self.__vfs_server = None
2144
def get_transport(self, relpath=None):
2145
"""Return a writeable transport.
2147
This transport is for the test scratch space relative to
2150
:param relpath: a path relative to the base url.
2152
t = get_transport(self.get_url(relpath))
2153
self.assertFalse(t.is_readonly())
2156
def get_readonly_transport(self, relpath=None):
2157
"""Return a readonly transport for the test scratch space
2159
This can be used to test that operations which should only need
2160
readonly access in fact do not try to write.
2162
:param relpath: a path relative to the base url.
2164
t = get_transport(self.get_readonly_url(relpath))
2165
self.assertTrue(t.is_readonly())
2168
def create_transport_readonly_server(self):
2169
"""Create a transport server from class defined at init.
2171
This is mostly a hook for daughter classes.
2173
return self.transport_readonly_server()
2175
def get_readonly_server(self):
2176
"""Get the server instance for the readonly transport
2178
This is useful for some tests with specific servers to do diagnostics.
2180
if self.__readonly_server is None:
2181
if self.transport_readonly_server is None:
2182
# readonly decorator requested
2183
self.__readonly_server = test_server.ReadonlyServer()
2185
# explicit readonly transport.
2186
self.__readonly_server = self.create_transport_readonly_server()
2187
self.start_server(self.__readonly_server,
2188
self.get_vfs_only_server())
2189
return self.__readonly_server
2191
def get_readonly_url(self, relpath=None):
2192
"""Get a URL for the readonly transport.
2194
This will either be backed by '.' or a decorator to the transport
2195
used by self.get_url()
2196
relpath provides for clients to get a path relative to the base url.
2197
These should only be downwards relative, not upwards.
2199
base = self.get_readonly_server().get_url()
2200
return self._adjust_url(base, relpath)
2202
def get_vfs_only_server(self):
2203
"""Get the vfs only read/write server instance.
2205
This is useful for some tests with specific servers that need
2208
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2209
is no means to override it.
2211
if self.__vfs_server is None:
2212
self.__vfs_server = memory.MemoryServer()
2213
self.start_server(self.__vfs_server)
2214
return self.__vfs_server
2216
def get_server(self):
2217
"""Get the read/write server instance.
2219
This is useful for some tests with specific servers that need
2222
This is built from the self.transport_server factory. If that is None,
2223
then the self.get_vfs_server is returned.
2225
if self.__server is None:
2226
if (self.transport_server is None or self.transport_server is
2227
self.vfs_transport_factory):
2228
self.__server = self.get_vfs_only_server()
2230
# bring up a decorated means of access to the vfs only server.
2231
self.__server = self.transport_server()
2232
self.start_server(self.__server, self.get_vfs_only_server())
2233
return self.__server
2235
def _adjust_url(self, base, relpath):
2236
"""Get a URL (or maybe a path) for the readwrite transport.
2238
This will either be backed by '.' or to an equivalent non-file based
2240
relpath provides for clients to get a path relative to the base url.
2241
These should only be downwards relative, not upwards.
2243
if relpath is not None and relpath != '.':
2244
if not base.endswith('/'):
2246
# XXX: Really base should be a url; we did after all call
2247
# get_url()! But sometimes it's just a path (from
2248
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2249
# to a non-escaped local path.
2250
if base.startswith('./') or base.startswith('/'):
2253
base += urlutils.escape(relpath)
2256
def get_url(self, relpath=None):
2257
"""Get a URL (or maybe a path) for the readwrite transport.
2259
This will either be backed by '.' or to an equivalent non-file based
2261
relpath provides for clients to get a path relative to the base url.
2262
These should only be downwards relative, not upwards.
2264
base = self.get_server().get_url()
2265
return self._adjust_url(base, relpath)
2267
def get_vfs_only_url(self, relpath=None):
2268
"""Get a URL (or maybe a path for the plain old vfs transport.
2270
This will never be a smart protocol. It always has all the
2271
capabilities of the local filesystem, but it might actually be a
2272
MemoryTransport or some other similar virtual filesystem.
2274
This is the backing transport (if any) of the server returned by
2275
get_url and get_readonly_url.
2277
:param relpath: provides for clients to get a path relative to the base
2278
url. These should only be downwards relative, not upwards.
2281
base = self.get_vfs_only_server().get_url()
2282
return self._adjust_url(base, relpath)
2284
def _create_safety_net(self):
2285
"""Make a fake bzr directory.
2287
This prevents any tests propagating up onto the TEST_ROOT directory's
2290
root = TestCaseWithMemoryTransport.TEST_ROOT
2291
bzrdir.BzrDir.create_standalone_workingtree(root)
2293
def _check_safety_net(self):
2294
"""Check that the safety .bzr directory have not been touched.
2296
_make_test_root have created a .bzr directory to prevent tests from
2297
propagating. This method ensures than a test did not leaked.
2299
root = TestCaseWithMemoryTransport.TEST_ROOT
2300
self.permit_url(get_transport(root).base)
2301
wt = workingtree.WorkingTree.open(root)
2302
last_rev = wt.last_revision()
2303
if last_rev != 'null:':
2304
# The current test have modified the /bzr directory, we need to
2305
# recreate a new one or all the followng tests will fail.
2306
# If you need to inspect its content uncomment the following line
2307
# import pdb; pdb.set_trace()
2308
_rmtree_temp_dir(root + '/.bzr', test_id=self.id())
2309
self._create_safety_net()
2310
raise AssertionError('%s/.bzr should not be modified' % root)
2312
def _make_test_root(self):
2313
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2314
# Watch out for tricky test dir (on OSX /tmp -> /private/tmp)
2315
root = osutils.realpath(osutils.mkdtemp(prefix='testbzr-',
2317
TestCaseWithMemoryTransport.TEST_ROOT = root
2319
self._create_safety_net()
2321
# The same directory is used by all tests, and we're not
2322
# specifically told when all tests are finished. This will do.
2323
atexit.register(_rmtree_temp_dir, root)
2325
self.permit_dir(TestCaseWithMemoryTransport.TEST_ROOT)
2326
self.addCleanup(self._check_safety_net)
2328
def makeAndChdirToTestDir(self):
2329
"""Create a temporary directories for this one test.
2331
This must set self.test_home_dir and self.test_dir and chdir to
2334
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2336
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2337
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2338
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2339
self.permit_dir(self.test_dir)
2341
def make_branch(self, relpath, format=None):
2342
"""Create a branch on the transport at relpath."""
2343
repo = self.make_repository(relpath, format=format)
2344
return repo.bzrdir.create_branch()
2346
def make_bzrdir(self, relpath, format=None):
2348
# might be a relative or absolute path
2349
maybe_a_url = self.get_url(relpath)
2350
segments = maybe_a_url.rsplit('/', 1)
2351
t = get_transport(maybe_a_url)
2352
if len(segments) > 1 and segments[-1] not in ('', '.'):
2356
if isinstance(format, basestring):
2357
format = bzrdir.format_registry.make_bzrdir(format)
2358
return format.initialize_on_transport(t)
2359
except errors.UninitializableFormat:
2360
raise TestSkipped("Format %s is not initializable." % format)
2362
def make_repository(self, relpath, shared=False, format=None):
2363
"""Create a repository on our default transport at relpath.
2365
Note that relpath must be a relative path, not a full url.
2367
# FIXME: If you create a remoterepository this returns the underlying
2368
# real format, which is incorrect. Actually we should make sure that
2369
# RemoteBzrDir returns a RemoteRepository.
2370
# maybe mbp 20070410
2371
made_control = self.make_bzrdir(relpath, format=format)
2372
return made_control.create_repository(shared=shared)
2374
def make_smart_server(self, path):
2375
smart_server = test_server.SmartTCPServer_for_testing()
2376
self.start_server(smart_server, self.get_server())
2377
remote_transport = get_transport(smart_server.get_url()).clone(path)
2378
return remote_transport
2380
def make_branch_and_memory_tree(self, relpath, format=None):
2381
"""Create a branch on the default transport and a MemoryTree for it."""
2382
b = self.make_branch(relpath, format=format)
2383
return memorytree.MemoryTree.create_on_branch(b)
2385
def make_branch_builder(self, relpath, format=None):
2386
branch = self.make_branch(relpath, format=format)
2387
return branchbuilder.BranchBuilder(branch=branch)
2389
def overrideEnvironmentForTesting(self):
2390
test_home_dir = self.test_home_dir
2391
if isinstance(test_home_dir, unicode):
2392
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2393
os.environ['HOME'] = test_home_dir
2394
os.environ['BZR_HOME'] = test_home_dir
147
class InTempDir(TestBase):
148
"""Base class for tests run in a temporary branch."""
2396
149
def setUp(self):
2397
super(TestCaseWithMemoryTransport, self).setUp()
2398
self._make_test_root()
2399
self.addCleanup(os.chdir, os.getcwdu())
2400
self.makeAndChdirToTestDir()
2401
self.overrideEnvironmentForTesting()
2402
self.__readonly_server = None
2403
self.__server = None
2404
self.reduceLockdirTimeout()
2406
def setup_smart_server_with_call_log(self):
2407
"""Sets up a smart server as the transport server with a call log."""
2408
self.transport_server = test_server.SmartTCPServer_for_testing
2409
self.hpss_calls = []
2411
# Skip the current stack down to the caller of
2412
# setup_smart_server_with_call_log
2413
prefix_length = len(traceback.extract_stack()) - 2
2414
def capture_hpss_call(params):
2415
self.hpss_calls.append(
2416
CapturedCall(params, prefix_length))
2417
client._SmartClient.hooks.install_named_hook(
2418
'call', capture_hpss_call, None)
2420
def reset_smart_call_log(self):
2421
self.hpss_calls = []
2424
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2425
"""Derived class that runs a test within a temporary directory.
2427
This is useful for tests that need to create a branch, etc.
2429
The directory is created in a slightly complex way: for each
2430
Python invocation, a new temporary top-level directory is created.
2431
All test cases create their own directory within that. If the
2432
tests complete successfully, the directory is removed.
2434
:ivar test_base_dir: The path of the top-level directory for this
2435
test, which contains a home directory and a work directory.
2437
:ivar test_home_dir: An initially empty directory under test_base_dir
2438
which is used as $HOME for this test.
2440
:ivar test_dir: A directory under test_base_dir used as the current
2441
directory when the test proper is run.
2444
OVERRIDE_PYTHON = 'python'
2446
def check_file_contents(self, filename, expect):
2447
self.log("check contents of file %s" % filename)
2448
contents = file(filename, 'r').read()
2449
if contents != expect:
2450
self.log("expected: %r" % expect)
2451
self.log("actually: %r" % contents)
2452
self.fail("contents of %s not as expected" % filename)
2454
def _getTestDirPrefix(self):
2455
# create a directory within the top level test directory
2456
if sys.platform in ('win32', 'cygwin'):
2457
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2458
# windows is likely to have path-length limits so use a short name
2459
name_prefix = name_prefix[-30:]
2461
name_prefix = re.sub('[/]', '_', self.id())
2464
def makeAndChdirToTestDir(self):
2465
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2467
For TestCaseInTempDir we create a temporary directory based on the test
2468
name and then create two subdirs - test and home under it.
2470
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2471
self._getTestDirPrefix())
2473
for i in range(100):
2474
if os.path.exists(name):
2475
name = name_prefix + '_' + str(i)
2477
# now create test and home directories within this dir
2478
self.test_base_dir = name
2479
self.addCleanup(self.deleteTestDir)
2480
os.mkdir(self.test_base_dir)
2482
self.permit_dir(self.test_base_dir)
2483
# 'sprouting' and 'init' of a branch both walk up the tree to find
2484
# stacking policy to honour; create a bzr dir with an unshared
2485
# repository (but not a branch - our code would be trying to escape
2486
# then!) to stop them, and permit it to be read.
2487
# control = bzrdir.BzrDir.create(self.test_base_dir)
2488
# control.create_repository()
2489
self.test_home_dir = self.test_base_dir + '/home'
2490
os.mkdir(self.test_home_dir)
2491
self.test_dir = self.test_base_dir + '/work'
151
self.test_dir = os.path.join(self.TEST_ROOT, self.__class__.__name__)
2492
152
os.mkdir(self.test_dir)
2493
153
os.chdir(self.test_dir)
2494
# put name of test inside
2495
f = file(self.test_base_dir + '/name', 'w')
2501
def deleteTestDir(self):
2502
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2503
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2505
def build_tree(self, shape, line_endings='binary', transport=None):
2506
"""Build a test tree according to a pattern.
2508
shape is a sequence of file specifications. If the final
2509
character is '/', a directory is created.
2511
This assumes that all the elements in the tree being built are new.
2513
This doesn't add anything to a branch.
2515
:type shape: list or tuple.
2516
:param line_endings: Either 'binary' or 'native'
2517
in binary mode, exact contents are written in native mode, the
2518
line endings match the default platform endings.
2519
:param transport: A transport to write to, for building trees on VFS's.
2520
If the transport is readonly or None, "." is opened automatically.
2523
if type(shape) not in (list, tuple):
2524
raise AssertionError("Parameter 'shape' should be "
2525
"a list or a tuple. Got %r instead" % (shape,))
2526
# It's OK to just create them using forward slashes on windows.
2527
if transport is None or transport.is_readonly():
2528
transport = get_transport(".")
2530
self.assertIsInstance(name, basestring)
2532
transport.mkdir(urlutils.escape(name[:-1]))
2534
if line_endings == 'binary':
2536
elif line_endings == 'native':
2539
raise errors.BzrError(
2540
'Invalid line ending request %r' % line_endings)
2541
content = "contents of %s%s" % (name.encode('utf-8'), end)
2542
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2544
def build_tree_contents(self, shape):
2545
build_tree_contents(shape)
2547
def assertInWorkingTree(self, path, root_path='.', tree=None):
2548
"""Assert whether path or paths are in the WorkingTree"""
2550
tree = workingtree.WorkingTree.open(root_path)
2551
if not isinstance(path, basestring):
2553
self.assertInWorkingTree(p, tree=tree)
2555
self.assertIsNot(tree.path2id(path), None,
2556
path+' not in working tree.')
2558
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2559
"""Assert whether path or paths are not in the WorkingTree"""
2561
tree = workingtree.WorkingTree.open(root_path)
2562
if not isinstance(path, basestring):
2564
self.assertNotInWorkingTree(p,tree=tree)
2566
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2569
class TestCaseWithTransport(TestCaseInTempDir):
2570
"""A test case that provides get_url and get_readonly_url facilities.
2572
These back onto two transport servers, one for readonly access and one for
2575
If no explicit class is provided for readonly access, a
2576
ReadonlyTransportDecorator is used instead which allows the use of non disk
2577
based read write transports.
2579
If an explicit class is provided for readonly access, that server and the
2580
readwrite one must both define get_url() as resolving to os.getcwd().
2583
def get_vfs_only_server(self):
2584
"""See TestCaseWithMemoryTransport.
2586
This is useful for some tests with specific servers that need
2589
if self.__vfs_server is None:
2590
self.__vfs_server = self.vfs_transport_factory()
2591
self.start_server(self.__vfs_server)
2592
return self.__vfs_server
2594
def make_branch_and_tree(self, relpath, format=None):
2595
"""Create a branch on the transport and a tree locally.
2597
If the transport is not a LocalTransport, the Tree can't be created on
2598
the transport. In that case if the vfs_transport_factory is
2599
LocalURLServer the working tree is created in the local
2600
directory backing the transport, and the returned tree's branch and
2601
repository will also be accessed locally. Otherwise a lightweight
2602
checkout is created and returned.
2604
We do this because we can't physically create a tree in the local
2605
path, with a branch reference to the transport_factory url, and
2606
a branch + repository in the vfs_transport, unless the vfs_transport
2607
namespace is distinct from the local disk - the two branch objects
2608
would collide. While we could construct a tree with its branch object
2609
pointing at the transport_factory transport in memory, reopening it
2610
would behaving unexpectedly, and has in the past caused testing bugs
2611
when we tried to do it that way.
2613
:param format: The BzrDirFormat.
2614
:returns: the WorkingTree.
2616
# TODO: always use the local disk path for the working tree,
2617
# this obviously requires a format that supports branch references
2618
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2620
b = self.make_branch(relpath, format=format)
2622
return b.bzrdir.create_workingtree()
2623
except errors.NotLocalUrl:
2624
# We can only make working trees locally at the moment. If the
2625
# transport can't support them, then we keep the non-disk-backed
2626
# branch and create a local checkout.
2627
if self.vfs_transport_factory is test_server.LocalURLServer:
2628
# the branch is colocated on disk, we cannot create a checkout.
2629
# hopefully callers will expect this.
2630
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2631
wt = local_controldir.create_workingtree()
2632
if wt.branch._format != b._format:
2634
# Make sure that assigning to wt._branch fixes wt.branch,
2635
# in case the implementation details of workingtree objects
2637
self.assertIs(b, wt.branch)
2640
return b.create_checkout(relpath, lightweight=True)
2642
def assertIsDirectory(self, relpath, transport):
2643
"""Assert that relpath within transport is a directory.
2645
This may not be possible on all transports; in that case it propagates
2646
a TransportNotPossible.
2649
mode = transport.stat(relpath).st_mode
2650
except errors.NoSuchFile:
2651
self.fail("path %s is not a directory; no such file"
2653
if not stat.S_ISDIR(mode):
2654
self.fail("path %s is not a directory; has mode %#o"
2657
def assertTreesEqual(self, left, right):
2658
"""Check that left and right have the same content and properties."""
2659
# we use a tree delta to check for equality of the content, and we
2660
# manually check for equality of other things such as the parents list.
2661
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2662
differences = left.changes_from(right)
2663
self.assertFalse(differences.has_changed(),
2664
"Trees %r and %r are different: %r" % (left, right, differences))
2667
super(TestCaseWithTransport, self).setUp()
2668
self.__vfs_server = None
2670
def disable_missing_extensions_warning(self):
2671
"""Some tests expect a precise stderr content.
2673
There is no point in forcing them to duplicate the extension related
2676
config.GlobalConfig().set_user_option('ignore_missing_extensions', True)
2679
class ChrootedTestCase(TestCaseWithTransport):
2680
"""A support class that provides readonly urls outside the local namespace.
2682
This is done by checking if self.transport_server is a MemoryServer. if it
2683
is then we are chrooted already, if it is not then an HttpServer is used
2686
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2687
be used without needed to redo it when a different
2688
subclass is in use ?
2692
super(ChrootedTestCase, self).setUp()
2693
if not self.vfs_transport_factory == memory.MemoryServer:
2694
self.transport_readonly_server = HttpServer
2697
def condition_id_re(pattern):
2698
"""Create a condition filter which performs a re check on a test's id.
2700
:param pattern: A regular expression string.
2701
:return: A callable that returns True if the re matches.
2703
filter_re = osutils.re_compile_checked(pattern, 0,
2705
def condition(test):
2707
return filter_re.search(test_id)
2711
def condition_isinstance(klass_or_klass_list):
2712
"""Create a condition filter which returns isinstance(param, klass).
2714
:return: A callable which when called with one parameter obj return the
2715
result of isinstance(obj, klass_or_klass_list).
2718
return isinstance(obj, klass_or_klass_list)
2722
def condition_id_in_list(id_list):
2723
"""Create a condition filter which verify that test's id in a list.
2725
:param id_list: A TestIdList object.
2726
:return: A callable that returns True if the test's id appears in the list.
2728
def condition(test):
2729
return id_list.includes(test.id())
2733
def condition_id_startswith(starts):
2734
"""Create a condition filter verifying that test's id starts with a string.
2736
:param starts: A list of string.
2737
:return: A callable that returns True if the test's id starts with one of
2740
def condition(test):
2741
for start in starts:
2742
if test.id().startswith(start):
2748
def exclude_tests_by_condition(suite, condition):
2749
"""Create a test suite which excludes some tests from suite.
2751
:param suite: The suite to get tests from.
2752
:param condition: A callable whose result evaluates True when called with a
2753
test case which should be excluded from the result.
2754
:return: A suite which contains the tests found in suite that fail
2758
for test in iter_suite_tests(suite):
2759
if not condition(test):
2761
return TestUtil.TestSuite(result)
2764
def filter_suite_by_condition(suite, condition):
2765
"""Create a test suite by filtering another one.
2767
:param suite: The source suite.
2768
:param condition: A callable whose result evaluates True when called with a
2769
test case which should be included in the result.
2770
:return: A suite which contains the tests found in suite that pass
2774
for test in iter_suite_tests(suite):
2777
return TestUtil.TestSuite(result)
2780
def filter_suite_by_re(suite, pattern):
2781
"""Create a test suite by filtering another one.
2783
:param suite: the source suite
2784
:param pattern: pattern that names must match
2785
:returns: the newly created suite
2787
condition = condition_id_re(pattern)
2788
result_suite = filter_suite_by_condition(suite, condition)
2792
def filter_suite_by_id_list(suite, test_id_list):
2793
"""Create a test suite by filtering another one.
2795
:param suite: The source suite.
2796
:param test_id_list: A list of the test ids to keep as strings.
2797
:returns: the newly created suite
2799
condition = condition_id_in_list(test_id_list)
2800
result_suite = filter_suite_by_condition(suite, condition)
2804
def filter_suite_by_id_startswith(suite, start):
2805
"""Create a test suite by filtering another one.
2807
:param suite: The source suite.
2808
:param start: A list of string the test id must start with one of.
2809
:returns: the newly created suite
2811
condition = condition_id_startswith(start)
2812
result_suite = filter_suite_by_condition(suite, condition)
2816
def exclude_tests_by_re(suite, pattern):
2817
"""Create a test suite which excludes some tests from suite.
2819
:param suite: The suite to get tests from.
2820
:param pattern: A regular expression string. Test ids that match this
2821
pattern will be excluded from the result.
2822
:return: A TestSuite that contains all the tests from suite without the
2823
tests that matched pattern. The order of tests is the same as it was in
2826
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2829
def preserve_input(something):
2830
"""A helper for performing test suite transformation chains.
2832
:param something: Anything you want to preserve.
2838
def randomize_suite(suite):
2839
"""Return a new TestSuite with suite's tests in random order.
2841
The tests in the input suite are flattened into a single suite in order to
2842
accomplish this. Any nested TestSuites are removed to provide global
2845
tests = list(iter_suite_tests(suite))
2846
random.shuffle(tests)
2847
return TestUtil.TestSuite(tests)
2850
def split_suite_by_condition(suite, condition):
2851
"""Split a test suite into two by a condition.
2853
:param suite: The suite to split.
2854
:param condition: The condition to match on. Tests that match this
2855
condition are returned in the first test suite, ones that do not match
2856
are in the second suite.
2857
:return: A tuple of two test suites, where the first contains tests from
2858
suite matching the condition, and the second contains the remainder
2859
from suite. The order within each output suite is the same as it was in
2864
for test in iter_suite_tests(suite):
2866
matched.append(test)
2868
did_not_match.append(test)
2869
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2872
def split_suite_by_re(suite, pattern):
2873
"""Split a test suite into two by a regular expression.
2875
:param suite: The suite to split.
2876
:param pattern: A regular expression string. Test ids that match this
2877
pattern will be in the first test suite returned, and the others in the
2878
second test suite returned.
2879
:return: A tuple of two test suites, where the first contains tests from
2880
suite matching pattern, and the second contains the remainder from
2881
suite. The order within each output suite is the same as it was in
2884
return split_suite_by_condition(suite, condition_id_re(pattern))
2887
def run_suite(suite, name='test', verbose=False, pattern=".*",
2888
stop_on_failure=False,
2889
transport=None, lsprof_timed=None, bench_history=None,
2890
matching_tests_first=None,
2893
exclude_pattern=None,
2896
suite_decorators=None,
2898
result_decorators=None,
2900
"""Run a test suite for bzr selftest.
2902
:param runner_class: The class of runner to use. Must support the
2903
constructor arguments passed by run_suite which are more than standard
2905
:return: A boolean indicating success.
2907
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2912
if runner_class is None:
2913
runner_class = TextTestRunner
2916
runner = runner_class(stream=stream,
2918
verbosity=verbosity,
2919
bench_history=bench_history,
2921
result_decorators=result_decorators,
2923
runner.stop_on_failure=stop_on_failure
2924
# built in decorator factories:
2926
random_order(random_seed, runner),
2927
exclude_tests(exclude_pattern),
2929
if matching_tests_first:
2930
decorators.append(tests_first(pattern))
2932
decorators.append(filter_tests(pattern))
2933
if suite_decorators:
2934
decorators.extend(suite_decorators)
2935
# tell the result object how many tests will be running: (except if
2936
# --parallel=fork is being used. Robert said he will provide a better
2937
# progress design later -- vila 20090817)
2938
if fork_decorator not in decorators:
2939
decorators.append(CountingDecorator)
2940
for decorator in decorators:
2941
suite = decorator(suite)
2943
# Done after test suite decoration to allow randomisation etc
2944
# to take effect, though that is of marginal benefit.
2946
stream.write("Listing tests only ...\n")
2947
for t in iter_suite_tests(suite):
2948
stream.write("%s\n" % (t.id()))
2950
result = runner.run(suite)
2952
return result.wasStrictlySuccessful()
2954
return result.wasSuccessful()
2957
# A registry where get() returns a suite decorator.
2958
parallel_registry = registry.Registry()
2961
def fork_decorator(suite):
2962
concurrency = osutils.local_concurrency()
2963
if concurrency == 1:
2965
from testtools import ConcurrentTestSuite
2966
return ConcurrentTestSuite(suite, fork_for_tests)
2967
parallel_registry.register('fork', fork_decorator)
2970
def subprocess_decorator(suite):
2971
concurrency = osutils.local_concurrency()
2972
if concurrency == 1:
2974
from testtools import ConcurrentTestSuite
2975
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2976
parallel_registry.register('subprocess', subprocess_decorator)
2979
def exclude_tests(exclude_pattern):
2980
"""Return a test suite decorator that excludes tests."""
2981
if exclude_pattern is None:
2982
return identity_decorator
2983
def decorator(suite):
2984
return ExcludeDecorator(suite, exclude_pattern)
2988
def filter_tests(pattern):
2990
return identity_decorator
2991
def decorator(suite):
2992
return FilterTestsDecorator(suite, pattern)
2996
def random_order(random_seed, runner):
2997
"""Return a test suite decorator factory for randomising tests order.
2999
:param random_seed: now, a string which casts to a long, or a long.
3000
:param runner: A test runner with a stream attribute to report on.
3002
if random_seed is None:
3003
return identity_decorator
3004
def decorator(suite):
3005
return RandomDecorator(suite, random_seed, runner.stream)
3009
def tests_first(pattern):
3011
return identity_decorator
3012
def decorator(suite):
3013
return TestFirstDecorator(suite, pattern)
3017
def identity_decorator(suite):
3022
class TestDecorator(TestSuite):
3023
"""A decorator for TestCase/TestSuite objects.
3025
Usually, subclasses should override __iter__(used when flattening test
3026
suites), which we do to filter, reorder, parallelise and so on, run() and
3030
def __init__(self, suite):
3031
TestSuite.__init__(self)
3034
def countTestCases(self):
3037
cases += test.countTestCases()
3044
def run(self, result):
3045
# Use iteration on self, not self._tests, to allow subclasses to hook
3048
if result.shouldStop:
3054
class CountingDecorator(TestDecorator):
3055
"""A decorator which calls result.progress(self.countTestCases)."""
3057
def run(self, result):
3058
progress_method = getattr(result, 'progress', None)
3059
if callable(progress_method):
3060
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3061
return super(CountingDecorator, self).run(result)
3064
class ExcludeDecorator(TestDecorator):
3065
"""A decorator which excludes test matching an exclude pattern."""
3067
def __init__(self, suite, exclude_pattern):
3068
TestDecorator.__init__(self, suite)
3069
self.exclude_pattern = exclude_pattern
3070
self.excluded = False
3074
return iter(self._tests)
3075
self.excluded = True
3076
suite = exclude_tests_by_re(self, self.exclude_pattern)
3078
self.addTests(suite)
3079
return iter(self._tests)
3082
class FilterTestsDecorator(TestDecorator):
3083
"""A decorator which filters tests to those matching a pattern."""
3085
def __init__(self, suite, pattern):
3086
TestDecorator.__init__(self, suite)
3087
self.pattern = pattern
3088
self.filtered = False
3092
return iter(self._tests)
3093
self.filtered = True
3094
suite = filter_suite_by_re(self, self.pattern)
3096
self.addTests(suite)
3097
return iter(self._tests)
3100
class RandomDecorator(TestDecorator):
3101
"""A decorator which randomises the order of its tests."""
3103
def __init__(self, suite, random_seed, stream):
3104
TestDecorator.__init__(self, suite)
3105
self.random_seed = random_seed
3106
self.randomised = False
3107
self.stream = stream
3111
return iter(self._tests)
3112
self.randomised = True
3113
self.stream.write("Randomizing test order using seed %s\n\n" %
3114
(self.actual_seed()))
3115
# Initialise the random number generator.
3116
random.seed(self.actual_seed())
3117
suite = randomize_suite(self)
3119
self.addTests(suite)
3120
return iter(self._tests)
3122
def actual_seed(self):
3123
if self.random_seed == "now":
3124
# We convert the seed to a long to make it reuseable across
3125
# invocations (because the user can reenter it).
3126
self.random_seed = long(time.time())
3128
# Convert the seed to a long if we can
3130
self.random_seed = long(self.random_seed)
3133
return self.random_seed
3136
class TestFirstDecorator(TestDecorator):
3137
"""A decorator which moves named tests to the front."""
3139
def __init__(self, suite, pattern):
3140
TestDecorator.__init__(self, suite)
3141
self.pattern = pattern
3142
self.filtered = False
3146
return iter(self._tests)
3147
self.filtered = True
3148
suites = split_suite_by_re(self, self.pattern)
3150
self.addTests(suites)
3151
return iter(self._tests)
3154
def partition_tests(suite, count):
3155
"""Partition suite into count lists of tests."""
3157
tests = list(iter_suite_tests(suite))
3158
tests_per_process = int(math.ceil(float(len(tests)) / count))
3159
for block in range(count):
3160
low_test = block * tests_per_process
3161
high_test = low_test + tests_per_process
3162
process_tests = tests[low_test:high_test]
3163
result.append(process_tests)
3167
def fork_for_tests(suite):
3168
"""Take suite and start up one runner per CPU by forking()
3170
:return: An iterable of TestCase-like objects which can each have
3171
run(result) called on them to feed tests to result.
3173
concurrency = osutils.local_concurrency()
3175
from subunit import TestProtocolClient, ProtocolTestCase
3176
from subunit.test_results import AutoTimingTestResultDecorator
3177
class TestInOtherProcess(ProtocolTestCase):
3178
# Should be in subunit, I think. RBC.
3179
def __init__(self, stream, pid):
3180
ProtocolTestCase.__init__(self, stream)
3183
def run(self, result):
3185
ProtocolTestCase.run(self, result)
3187
os.waitpid(self.pid, os.WNOHANG)
3189
test_blocks = partition_tests(suite, concurrency)
3190
for process_tests in test_blocks:
3191
process_suite = TestSuite()
3192
process_suite.addTests(process_tests)
3193
c2pread, c2pwrite = os.pipe()
3198
# Leave stderr and stdout open so we can see test noise
3199
# Close stdin so that the child goes away if it decides to
3200
# read from stdin (otherwise its a roulette to see what
3201
# child actually gets keystrokes for pdb etc).
3204
stream = os.fdopen(c2pwrite, 'wb', 1)
3205
subunit_result = AutoTimingTestResultDecorator(
3206
TestProtocolClient(stream))
3207
process_suite.run(subunit_result)
3212
stream = os.fdopen(c2pread, 'rb', 1)
3213
test = TestInOtherProcess(stream, pid)
3218
def reinvoke_for_tests(suite):
3219
"""Take suite and start up one runner per CPU using subprocess().
3221
:return: An iterable of TestCase-like objects which can each have
3222
run(result) called on them to feed tests to result.
3224
concurrency = osutils.local_concurrency()
3226
from subunit import ProtocolTestCase
3227
class TestInSubprocess(ProtocolTestCase):
3228
def __init__(self, process, name):
3229
ProtocolTestCase.__init__(self, process.stdout)
3230
self.process = process
3231
self.process.stdin.close()
3234
def run(self, result):
3236
ProtocolTestCase.run(self, result)
3239
os.unlink(self.name)
3240
# print "pid %d finished" % finished_process
3241
test_blocks = partition_tests(suite, concurrency)
3242
for process_tests in test_blocks:
3243
# ugly; currently reimplement rather than reuses TestCase methods.
3244
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3245
if not os.path.isfile(bzr_path):
3246
# We are probably installed. Assume sys.argv is the right file
3247
bzr_path = sys.argv[0]
3248
bzr_path = [bzr_path]
3249
if sys.platform == "win32":
3250
# if we're on windows, we can't execute the bzr script directly
3251
bzr_path = [sys.executable] + bzr_path
3252
fd, test_list_file_name = tempfile.mkstemp()
3253
test_list_file = os.fdopen(fd, 'wb', 1)
3254
for test in process_tests:
3255
test_list_file.write(test.id() + '\n')
3256
test_list_file.close()
3258
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3260
if '--no-plugins' in sys.argv:
3261
argv.append('--no-plugins')
3262
# stderr=STDOUT would be ideal, but until we prevent noise on
3263
# stderr it can interrupt the subunit protocol.
3264
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3266
test = TestInSubprocess(process, test_list_file_name)
3269
os.unlink(test_list_file_name)
3274
class ForwardingResult(unittest.TestResult):
3276
def __init__(self, target):
3277
unittest.TestResult.__init__(self)
3278
self.result = target
157
os.chdir(self.TEST_ROOT)
163
class _MyResult(TestResult):
167
No special behaviour for now.
169
def __init__(self, out):
171
TestResult.__init__(self)
3280
173
def startTest(self, test):
3281
self.result.startTest(test)
174
# TODO: Maybe show test.shortDescription somewhere?
175
print >>self.out, '%-60.60s' % test.id(),
176
TestResult.startTest(self, test)
3283
178
def stopTest(self, test):
3284
self.result.stopTest(test)
3286
def startTestRun(self):
3287
self.result.startTestRun()
3289
def stopTestRun(self):
3290
self.result.stopTestRun()
3292
def addSkip(self, test, reason):
3293
self.result.addSkip(test, reason)
3295
def addSuccess(self, test):
3296
self.result.addSuccess(test)
180
TestResult.stopTest(self, test)
3298
183
def addError(self, test, err):
3299
self.result.addError(test, err)
184
print >>self.out, 'ERROR'
185
TestResult.addError(self, test, err)
3301
187
def addFailure(self, test, err):
3302
self.result.addFailure(test, err)
3303
ForwardingResult = testtools.ExtendedToOriginalDecorator
3306
class ProfileResult(ForwardingResult):
3307
"""Generate profiling data for all activity between start and success.
3309
The profile data is appended to the test's _benchcalls attribute and can
3310
be accessed by the forwarded-to TestResult.
3312
While it might be cleaner do accumulate this in stopTest, addSuccess is
3313
where our existing output support for lsprof is, and this class aims to
3314
fit in with that: while it could be moved it's not necessary to accomplish
3315
test profiling, nor would it be dramatically cleaner.
3318
def startTest(self, test):
3319
self.profiler = bzrlib.lsprof.BzrProfiler()
3320
self.profiler.start()
3321
ForwardingResult.startTest(self, test)
188
print >>self.out, 'FAILURE'
189
TestResult.addFailure(self, test, err)
3323
191
def addSuccess(self, test):
3324
stats = self.profiler.stop()
3326
calls = test._benchcalls
3327
except AttributeError:
3328
test._benchcalls = []
3329
calls = test._benchcalls
3330
calls.append(((test.id(), "", ""), stats))
3331
ForwardingResult.addSuccess(self, test)
3333
def stopTest(self, test):
3334
ForwardingResult.stopTest(self, test)
3335
self.profiler = None
3338
# Controlled by "bzr selftest -E=..." option
3339
# Currently supported:
3340
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3341
# preserves any flags supplied at the command line.
3342
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3343
# rather than failing tests. And no longer raise
3344
# LockContention when fctnl locks are not being used
3345
# with proper exclusion rules.
3346
selftest_debug_flags = set()
3349
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3351
test_suite_factory=None,
3354
matching_tests_first=None,
3357
exclude_pattern=None,
3363
suite_decorators=None,
3367
"""Run the whole test suite under the enhanced runner"""
3368
# XXX: Very ugly way to do this...
3369
# Disable warning about old formats because we don't want it to disturb
3370
# any blackbox tests.
3371
from bzrlib import repository
3372
repository._deprecation_warning_done = True
3374
global default_transport
3375
if transport is None:
3376
transport = default_transport
3377
old_transport = default_transport
3378
default_transport = transport
3379
global selftest_debug_flags
3380
old_debug_flags = selftest_debug_flags
3381
if debug_flags is not None:
3382
selftest_debug_flags = set(debug_flags)
192
print >>self.out, 'OK'
193
TestResult.addSuccess(self, test)
198
from unittest import TestLoader, TestSuite
200
import bzrlib.selftest.whitebox
201
import bzrlib.selftest.blackbox
202
import bzrlib.selftest.versioning
203
from doctest import DocTestSuite
216
for m in bzrlib.selftest.whitebox, \
217
bzrlib.selftest.versioning:
218
suite.addTest(tl.loadTestsFromModule(m))
220
suite.addTest(bzrlib.selftest.blackbox.suite())
222
for m in bzrlib.store, bzrlib.inventory, bzrlib.branch, bzrlib.osutils, \
224
suite.addTest(DocTestSuite(m))
226
# save stdout & stderr so there's no leakage from code-under-test
227
real_stdout = sys.stdout
228
real_stderr = sys.stderr
229
sys.stdout = sys.stderr = TestBase.TEST_LOG
3384
if load_list is None:
3387
keep_only = load_test_id_list(load_list)
3389
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3390
for start in starting_with]
3391
if test_suite_factory is None:
3392
# Reduce loading time by loading modules based on the starting_with
3394
suite = test_suite(keep_only, starting_with)
3396
suite = test_suite_factory()
3398
# But always filter as requested.
3399
suite = filter_suite_by_id_startswith(suite, starting_with)
3400
result_decorators = []
3402
result_decorators.append(ProfileResult)
3403
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3404
stop_on_failure=stop_on_failure,
3405
transport=transport,
3406
lsprof_timed=lsprof_timed,
3407
bench_history=bench_history,
3408
matching_tests_first=matching_tests_first,
3409
list_only=list_only,
3410
random_seed=random_seed,
3411
exclude_pattern=exclude_pattern,
3413
runner_class=runner_class,
3414
suite_decorators=suite_decorators,
3416
result_decorators=result_decorators,
231
result = _MyResult(real_stdout)
3419
default_transport = old_transport
3420
selftest_debug_flags = old_debug_flags
3423
def load_test_id_list(file_name):
3424
"""Load a test id list from a text file.
3426
The format is one test id by line. No special care is taken to impose
3427
strict rules, these test ids are used to filter the test suite so a test id
3428
that do not match an existing test will do no harm. This allows user to add
3429
comments, leave blank lines, etc.
3433
ftest = open(file_name, 'rt')
3435
if e.errno != errno.ENOENT:
3438
raise errors.NoSuchFile(file_name)
3440
for test_name in ftest.readlines():
3441
test_list.append(test_name.strip())
3446
def suite_matches_id_list(test_suite, id_list):
3447
"""Warns about tests not appearing or appearing more than once.
3449
:param test_suite: A TestSuite object.
3450
:param test_id_list: The list of test ids that should be found in
3453
:return: (absents, duplicates) absents is a list containing the test found
3454
in id_list but not in test_suite, duplicates is a list containing the
3455
test found multiple times in test_suite.
3457
When using a prefined test id list, it may occurs that some tests do not
3458
exist anymore or that some tests use the same id. This function warns the
3459
tester about potential problems in his workflow (test lists are volatile)
3460
or in the test suite itself (using the same id for several tests does not
3461
help to localize defects).
3463
# Build a dict counting id occurrences
3465
for test in iter_suite_tests(test_suite):
3467
tests[id] = tests.get(id, 0) + 1
3472
occurs = tests.get(id, 0)
3474
not_found.append(id)
3476
duplicates.append(id)
3478
return not_found, duplicates
3481
class TestIdList(object):
3482
"""Test id list to filter a test suite.
3484
Relying on the assumption that test ids are built as:
3485
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3486
notation, this class offers methods to :
3487
- avoid building a test suite for modules not refered to in the test list,
3488
- keep only the tests listed from the module test suite.
3491
def __init__(self, test_id_list):
3492
# When a test suite needs to be filtered against us we compare test ids
3493
# for equality, so a simple dict offers a quick and simple solution.
3494
self.tests = dict().fromkeys(test_id_list, True)
3496
# While unittest.TestCase have ids like:
3497
# <module>.<class>.<method>[(<param+)],
3498
# doctest.DocTestCase can have ids like:
3501
# <module>.<function>
3502
# <module>.<class>.<method>
3504
# Since we can't predict a test class from its name only, we settle on
3505
# a simple constraint: a test id always begins with its module name.
3508
for test_id in test_id_list:
3509
parts = test_id.split('.')
3510
mod_name = parts.pop(0)
3511
modules[mod_name] = True
3513
mod_name += '.' + part
3514
modules[mod_name] = True
3515
self.modules = modules
3517
def refers_to(self, module_name):
3518
"""Is there tests for the module or one of its sub modules."""
3519
return self.modules.has_key(module_name)
3521
def includes(self, test_id):
3522
return self.tests.has_key(test_id)
3525
class TestPrefixAliasRegistry(registry.Registry):
3526
"""A registry for test prefix aliases.
3528
This helps implement shorcuts for the --starting-with selftest
3529
option. Overriding existing prefixes is not allowed but not fatal (a
3530
warning will be emitted).
3533
def register(self, key, obj, help=None, info=None,
3534
override_existing=False):
3535
"""See Registry.register.
3537
Trying to override an existing alias causes a warning to be emitted,
3538
not a fatal execption.
3541
super(TestPrefixAliasRegistry, self).register(
3542
key, obj, help=help, info=info, override_existing=False)
3544
actual = self.get(key)
3545
note('Test prefix alias %s is already used for %s, ignoring %s'
3546
% (key, actual, obj))
3548
def resolve_alias(self, id_start):
3549
"""Replace the alias by the prefix in the given string.
3551
Using an unknown prefix is an error to help catching typos.
3553
parts = id_start.split('.')
3555
parts[0] = self.get(parts[0])
3557
raise errors.BzrCommandError(
3558
'%s is not a known test prefix alias' % parts[0])
3559
return '.'.join(parts)
3562
test_prefix_alias_registry = TestPrefixAliasRegistry()
3563
"""Registry of test prefix aliases."""
3566
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3567
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3568
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3570
# Obvious highest levels prefixes, feel free to add your own via a plugin
3571
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3572
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3573
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3574
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3575
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3578
def _test_suite_testmod_names():
3579
"""Return the standard list of test module names to test."""
3582
'bzrlib.tests.blackbox',
3583
'bzrlib.tests.commands',
3584
'bzrlib.tests.per_branch',
3585
'bzrlib.tests.per_bzrdir',
3586
'bzrlib.tests.per_foreign_vcs',
3587
'bzrlib.tests.per_interrepository',
3588
'bzrlib.tests.per_intertree',
3589
'bzrlib.tests.per_inventory',
3590
'bzrlib.tests.per_interbranch',
3591
'bzrlib.tests.per_lock',
3592
'bzrlib.tests.per_merger',
3593
'bzrlib.tests.per_transport',
3594
'bzrlib.tests.per_tree',
3595
'bzrlib.tests.per_pack_repository',
3596
'bzrlib.tests.per_repository',
3597
'bzrlib.tests.per_repository_chk',
3598
'bzrlib.tests.per_repository_reference',
3599
'bzrlib.tests.per_uifactory',
3600
'bzrlib.tests.per_versionedfile',
3601
'bzrlib.tests.per_workingtree',
3602
'bzrlib.tests.test__annotator',
3603
'bzrlib.tests.test__bencode',
3604
'bzrlib.tests.test__chk_map',
3605
'bzrlib.tests.test__dirstate_helpers',
3606
'bzrlib.tests.test__groupcompress',
3607
'bzrlib.tests.test__known_graph',
3608
'bzrlib.tests.test__rio',
3609
'bzrlib.tests.test__simple_set',
3610
'bzrlib.tests.test__static_tuple',
3611
'bzrlib.tests.test__walkdirs_win32',
3612
'bzrlib.tests.test_ancestry',
3613
'bzrlib.tests.test_annotate',
3614
'bzrlib.tests.test_api',
3615
'bzrlib.tests.test_atomicfile',
3616
'bzrlib.tests.test_bad_files',
3617
'bzrlib.tests.test_bisect_multi',
3618
'bzrlib.tests.test_branch',
3619
'bzrlib.tests.test_branchbuilder',
3620
'bzrlib.tests.test_btree_index',
3621
'bzrlib.tests.test_bugtracker',
3622
'bzrlib.tests.test_bundle',
3623
'bzrlib.tests.test_bzrdir',
3624
'bzrlib.tests.test__chunks_to_lines',
3625
'bzrlib.tests.test_cache_utf8',
3626
'bzrlib.tests.test_chk_map',
3627
'bzrlib.tests.test_chk_serializer',
3628
'bzrlib.tests.test_chunk_writer',
3629
'bzrlib.tests.test_clean_tree',
3630
'bzrlib.tests.test_cleanup',
3631
'bzrlib.tests.test_cmdline',
3632
'bzrlib.tests.test_commands',
3633
'bzrlib.tests.test_commit',
3634
'bzrlib.tests.test_commit_merge',
3635
'bzrlib.tests.test_config',
3636
'bzrlib.tests.test_conflicts',
3637
'bzrlib.tests.test_counted_lock',
3638
'bzrlib.tests.test_crash',
3639
'bzrlib.tests.test_decorators',
3640
'bzrlib.tests.test_delta',
3641
'bzrlib.tests.test_debug',
3642
'bzrlib.tests.test_deprecated_graph',
3643
'bzrlib.tests.test_diff',
3644
'bzrlib.tests.test_directory_service',
3645
'bzrlib.tests.test_dirstate',
3646
'bzrlib.tests.test_email_message',
3647
'bzrlib.tests.test_eol_filters',
3648
'bzrlib.tests.test_errors',
3649
'bzrlib.tests.test_export',
3650
'bzrlib.tests.test_extract',
3651
'bzrlib.tests.test_fetch',
3652
'bzrlib.tests.test_fifo_cache',
3653
'bzrlib.tests.test_filters',
3654
'bzrlib.tests.test_ftp_transport',
3655
'bzrlib.tests.test_foreign',
3656
'bzrlib.tests.test_generate_docs',
3657
'bzrlib.tests.test_generate_ids',
3658
'bzrlib.tests.test_globbing',
3659
'bzrlib.tests.test_gpg',
3660
'bzrlib.tests.test_graph',
3661
'bzrlib.tests.test_groupcompress',
3662
'bzrlib.tests.test_hashcache',
3663
'bzrlib.tests.test_help',
3664
'bzrlib.tests.test_hooks',
3665
'bzrlib.tests.test_http',
3666
'bzrlib.tests.test_http_response',
3667
'bzrlib.tests.test_https_ca_bundle',
3668
'bzrlib.tests.test_identitymap',
3669
'bzrlib.tests.test_ignores',
3670
'bzrlib.tests.test_index',
3671
'bzrlib.tests.test_import_tariff',
3672
'bzrlib.tests.test_info',
3673
'bzrlib.tests.test_inv',
3674
'bzrlib.tests.test_inventory_delta',
3675
'bzrlib.tests.test_knit',
3676
'bzrlib.tests.test_lazy_import',
3677
'bzrlib.tests.test_lazy_regex',
3678
'bzrlib.tests.test_lock',
3679
'bzrlib.tests.test_lockable_files',
3680
'bzrlib.tests.test_lockdir',
3681
'bzrlib.tests.test_log',
3682
'bzrlib.tests.test_lru_cache',
3683
'bzrlib.tests.test_lsprof',
3684
'bzrlib.tests.test_mail_client',
3685
'bzrlib.tests.test_memorytree',
3686
'bzrlib.tests.test_merge',
3687
'bzrlib.tests.test_merge3',
3688
'bzrlib.tests.test_merge_core',
3689
'bzrlib.tests.test_merge_directive',
3690
'bzrlib.tests.test_missing',
3691
'bzrlib.tests.test_msgeditor',
3692
'bzrlib.tests.test_multiparent',
3693
'bzrlib.tests.test_mutabletree',
3694
'bzrlib.tests.test_nonascii',
3695
'bzrlib.tests.test_options',
3696
'bzrlib.tests.test_osutils',
3697
'bzrlib.tests.test_osutils_encodings',
3698
'bzrlib.tests.test_pack',
3699
'bzrlib.tests.test_patch',
3700
'bzrlib.tests.test_patches',
3701
'bzrlib.tests.test_permissions',
3702
'bzrlib.tests.test_plugins',
3703
'bzrlib.tests.test_progress',
3704
'bzrlib.tests.test_read_bundle',
3705
'bzrlib.tests.test_reconcile',
3706
'bzrlib.tests.test_reconfigure',
3707
'bzrlib.tests.test_registry',
3708
'bzrlib.tests.test_remote',
3709
'bzrlib.tests.test_rename_map',
3710
'bzrlib.tests.test_repository',
3711
'bzrlib.tests.test_revert',
3712
'bzrlib.tests.test_revision',
3713
'bzrlib.tests.test_revisionspec',
3714
'bzrlib.tests.test_revisiontree',
3715
'bzrlib.tests.test_rio',
3716
'bzrlib.tests.test_rules',
3717
'bzrlib.tests.test_sampler',
3718
'bzrlib.tests.test_script',
3719
'bzrlib.tests.test_selftest',
3720
'bzrlib.tests.test_serializer',
3721
'bzrlib.tests.test_setup',
3722
'bzrlib.tests.test_sftp_transport',
3723
'bzrlib.tests.test_shelf',
3724
'bzrlib.tests.test_shelf_ui',
3725
'bzrlib.tests.test_smart',
3726
'bzrlib.tests.test_smart_add',
3727
'bzrlib.tests.test_smart_request',
3728
'bzrlib.tests.test_smart_transport',
3729
'bzrlib.tests.test_smtp_connection',
3730
'bzrlib.tests.test_source',
3731
'bzrlib.tests.test_ssh_transport',
3732
'bzrlib.tests.test_status',
3733
'bzrlib.tests.test_store',
3734
'bzrlib.tests.test_strace',
3735
'bzrlib.tests.test_subsume',
3736
'bzrlib.tests.test_switch',
3737
'bzrlib.tests.test_symbol_versioning',
3738
'bzrlib.tests.test_tag',
3739
'bzrlib.tests.test_testament',
3740
'bzrlib.tests.test_textfile',
3741
'bzrlib.tests.test_textmerge',
3742
'bzrlib.tests.test_timestamp',
3743
'bzrlib.tests.test_trace',
3744
'bzrlib.tests.test_transactions',
3745
'bzrlib.tests.test_transform',
3746
'bzrlib.tests.test_transport',
3747
'bzrlib.tests.test_transport_log',
3748
'bzrlib.tests.test_tree',
3749
'bzrlib.tests.test_treebuilder',
3750
'bzrlib.tests.test_tsort',
3751
'bzrlib.tests.test_tuned_gzip',
3752
'bzrlib.tests.test_ui',
3753
'bzrlib.tests.test_uncommit',
3754
'bzrlib.tests.test_upgrade',
3755
'bzrlib.tests.test_upgrade_stacked',
3756
'bzrlib.tests.test_urlutils',
3757
'bzrlib.tests.test_version',
3758
'bzrlib.tests.test_version_info',
3759
'bzrlib.tests.test_weave',
3760
'bzrlib.tests.test_whitebox',
3761
'bzrlib.tests.test_win32utils',
3762
'bzrlib.tests.test_workingtree',
3763
'bzrlib.tests.test_workingtree_4',
3764
'bzrlib.tests.test_wsgi',
3765
'bzrlib.tests.test_xml',
3769
def _test_suite_modules_to_doctest():
3770
"""Return the list of modules to doctest."""
3773
'bzrlib.branchbuilder',
3774
'bzrlib.decorators',
3777
'bzrlib.iterablefile',
3781
'bzrlib.symbol_versioning',
3784
'bzrlib.version_info_formats.format_custom',
3788
def test_suite(keep_only=None, starting_with=None):
3789
"""Build and return TestSuite for the whole of bzrlib.
3791
:param keep_only: A list of test ids limiting the suite returned.
3793
:param starting_with: An id limiting the suite returned to the tests
3796
This function can be replaced if you need to change the default test
3797
suite on a global basis, but it is not encouraged.
3800
loader = TestUtil.TestLoader()
3802
if keep_only is not None:
3803
id_filter = TestIdList(keep_only)
3805
# We take precedence over keep_only because *at loading time* using
3806
# both options means we will load less tests for the same final result.
3807
def interesting_module(name):
3808
for start in starting_with:
3810
# Either the module name starts with the specified string
3811
name.startswith(start)
3812
# or it may contain tests starting with the specified string
3813
or start.startswith(name)
3817
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3819
elif keep_only is not None:
3820
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3821
def interesting_module(name):
3822
return id_filter.refers_to(name)
3825
loader = TestUtil.TestLoader()
3826
def interesting_module(name):
3827
# No filtering, all modules are interesting
3830
suite = loader.suiteClass()
3832
# modules building their suite with loadTestsFromModuleNames
3833
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3835
for mod in _test_suite_modules_to_doctest():
3836
if not interesting_module(mod):
3837
# No tests to keep here, move along
3840
# note that this really does mean "report only" -- doctest
3841
# still runs the rest of the examples
3842
doc_suite = doctest.DocTestSuite(mod,
3843
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3844
except ValueError, e:
3845
print '**failed to get doctest for: %s\n%s' % (mod, e)
3847
if len(doc_suite._tests) == 0:
3848
raise errors.BzrError("no doctests found in %s" % (mod,))
3849
suite.addTest(doc_suite)
3851
default_encoding = sys.getdefaultencoding()
3852
for name, plugin in bzrlib.plugin.plugins().items():
3853
if not interesting_module(plugin.module.__name__):
3855
plugin_suite = plugin.test_suite()
3856
# We used to catch ImportError here and turn it into just a warning,
3857
# but really if you don't have --no-plugins this should be a failure.
3858
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3859
if plugin_suite is None:
3860
plugin_suite = plugin.load_plugin_tests(loader)
3861
if plugin_suite is not None:
3862
suite.addTest(plugin_suite)
3863
if default_encoding != sys.getdefaultencoding():
3864
bzrlib.trace.warning(
3865
'Plugin "%s" tried to reset default encoding to: %s', name,
3866
sys.getdefaultencoding())
3868
sys.setdefaultencoding(default_encoding)
3870
if keep_only is not None:
3871
# Now that the referred modules have loaded their tests, keep only the
3873
suite = filter_suite_by_id_list(suite, id_filter)
3874
# Do some sanity checks on the id_list filtering
3875
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3877
# The tester has used both keep_only and starting_with, so he is
3878
# already aware that some tests are excluded from the list, there
3879
# is no need to tell him which.
3882
# Some tests mentioned in the list are not in the test suite. The
3883
# list may be out of date, report to the tester.
3884
for id in not_found:
3885
bzrlib.trace.warning('"%s" not found in the test suite', id)
3886
for id in duplicates:
3887
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3892
def multiply_scenarios(scenarios_left, scenarios_right):
3893
"""Multiply two sets of scenarios.
3895
:returns: the cartesian product of the two sets of scenarios, that is
3896
a scenario for every possible combination of a left scenario and a
3900
('%s,%s' % (left_name, right_name),
3901
dict(left_dict.items() + right_dict.items()))
3902
for left_name, left_dict in scenarios_left
3903
for right_name, right_dict in scenarios_right]
3906
def multiply_tests(tests, scenarios, result):
3907
"""Multiply tests_list by scenarios into result.
3909
This is the core workhorse for test parameterisation.
3911
Typically the load_tests() method for a per-implementation test suite will
3912
call multiply_tests and return the result.
3914
:param tests: The tests to parameterise.
3915
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3916
scenario_param_dict).
3917
:param result: A TestSuite to add created tests to.
3919
This returns the passed in result TestSuite with the cross product of all
3920
the tests repeated once for each scenario. Each test is adapted by adding
3921
the scenario name at the end of its id(), and updating the test object's
3922
__dict__ with the scenario_param_dict.
3924
>>> import bzrlib.tests.test_sampler
3925
>>> r = multiply_tests(
3926
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3927
... [('one', dict(param=1)),
3928
... ('two', dict(param=2))],
3930
>>> tests = list(iter_suite_tests(r))
3934
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3940
for test in iter_suite_tests(tests):
3941
apply_scenarios(test, scenarios, result)
3945
def apply_scenarios(test, scenarios, result):
3946
"""Apply the scenarios in scenarios to test and add to result.
3948
:param test: The test to apply scenarios to.
3949
:param scenarios: An iterable of scenarios to apply to test.
3951
:seealso: apply_scenario
3953
for scenario in scenarios:
3954
result.addTest(apply_scenario(test, scenario))
3958
def apply_scenario(test, scenario):
3959
"""Copy test and apply scenario to it.
3961
:param test: A test to adapt.
3962
:param scenario: A tuple describing the scenarion.
3963
The first element of the tuple is the new test id.
3964
The second element is a dict containing attributes to set on the
3966
:return: The adapted test.
3968
new_id = "%s(%s)" % (test.id(), scenario[0])
3969
new_test = clone_test(test, new_id)
3970
for name, value in scenario[1].items():
3971
setattr(new_test, name, value)
3975
def clone_test(test, new_id):
3976
"""Clone a test giving it a new id.
3978
:param test: The test to clone.
3979
:param new_id: The id to assign to it.
3980
:return: The new test.
3982
new_test = copy(test)
3983
new_test.id = lambda: new_id
3987
def permute_tests_for_extension(standard_tests, loader, py_module_name,
3989
"""Helper for permutating tests against an extension module.
3991
This is meant to be used inside a modules 'load_tests()' function. It will
3992
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
3993
against both implementations. Setting 'test.module' to the appropriate
3994
module. See bzrlib.tests.test__chk_map.load_tests as an example.
3996
:param standard_tests: A test suite to permute
3997
:param loader: A TestLoader
3998
:param py_module_name: The python path to a python module that can always
3999
be loaded, and will be considered the 'python' implementation. (eg
4000
'bzrlib._chk_map_py')
4001
:param ext_module_name: The python path to an extension module. If the
4002
module cannot be loaded, a single test will be added, which notes that
4003
the module is not available. If it can be loaded, all standard_tests
4004
will be run against that module.
4005
:return: (suite, feature) suite is a test-suite that has all the permuted
4006
tests. feature is the Feature object that can be used to determine if
4007
the module is available.
4010
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4012
('python', {'module': py_module}),
4014
suite = loader.suiteClass()
4015
feature = ModuleAvailableFeature(ext_module_name)
4016
if feature.available():
4017
scenarios.append(('C', {'module': feature.module}))
4019
# the compiled module isn't available, so we add a failing test
4020
class FailWithoutFeature(TestCase):
4021
def test_fail(self):
4022
self.requireFeature(feature)
4023
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4024
result = multiply_tests(standard_tests, scenarios, suite)
4025
return result, feature
4028
def _rmtree_temp_dir(dirname, test_id=None):
4029
# If LANG=C we probably have created some bogus paths
4030
# which rmtree(unicode) will fail to delete
4031
# so make sure we are using rmtree(str) to delete everything
4032
# except on win32, where rmtree(str) will fail
4033
# since it doesn't have the property of byte-stream paths
4034
# (they are either ascii or mbcs)
4035
if sys.platform == 'win32':
4036
# make sure we are using the unicode win32 api
4037
dirname = unicode(dirname)
4039
dirname = dirname.encode(sys.getfilesystemencoding())
4041
osutils.rmtree(dirname)
4043
# We don't want to fail here because some useful display will be lost
4044
# otherwise. Polluting the tmp dir is bad, but not giving all the
4045
# possible info to the test runner is even worse.
4047
ui.ui_factory.clear_term()
4048
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4049
sys.stderr.write('Unable to remove testing dir %s\n%s'
4050
% (os.path.basename(dirname), e))
4053
class Feature(object):
4054
"""An operating system Feature."""
4057
self._available = None
4059
def available(self):
4060
"""Is the feature available?
4062
:return: True if the feature is available.
4064
if self._available is None:
4065
self._available = self._probe()
4066
return self._available
4069
"""Implement this method in concrete features.
4071
:return: True if the feature is available.
4073
raise NotImplementedError
4076
if getattr(self, 'feature_name', None):
4077
return self.feature_name()
4078
return self.__class__.__name__
4081
class _SymlinkFeature(Feature):
4084
return osutils.has_symlinks()
4086
def feature_name(self):
4089
SymlinkFeature = _SymlinkFeature()
4092
class _HardlinkFeature(Feature):
4095
return osutils.has_hardlinks()
4097
def feature_name(self):
4100
HardlinkFeature = _HardlinkFeature()
4103
class _OsFifoFeature(Feature):
4106
return getattr(os, 'mkfifo', None)
4108
def feature_name(self):
4109
return 'filesystem fifos'
4111
OsFifoFeature = _OsFifoFeature()
4114
class _UnicodeFilenameFeature(Feature):
4115
"""Does the filesystem support Unicode filenames?"""
4119
# Check for character combinations unlikely to be covered by any
4120
# single non-unicode encoding. We use the characters
4121
# - greek small letter alpha (U+03B1) and
4122
# - braille pattern dots-123456 (U+283F).
4123
os.stat(u'\u03b1\u283f')
4124
except UnicodeEncodeError:
4126
except (IOError, OSError):
4127
# The filesystem allows the Unicode filename but the file doesn't
4131
# The filesystem allows the Unicode filename and the file exists,
4135
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4138
class _CompatabilityThunkFeature(Feature):
4139
"""This feature is just a thunk to another feature.
4141
It issues a deprecation warning if it is accessed, to let you know that you
4142
should really use a different feature.
4145
def __init__(self, dep_version, module, name,
4146
replacement_name, replacement_module=None):
4147
super(_CompatabilityThunkFeature, self).__init__()
4148
self._module = module
4149
if replacement_module is None:
4150
replacement_module = module
4151
self._replacement_module = replacement_module
4153
self._replacement_name = replacement_name
4154
self._dep_version = dep_version
4155
self._feature = None
4158
if self._feature is None:
4159
depr_msg = self._dep_version % ('%s.%s'
4160
% (self._module, self._name))
4161
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4162
self._replacement_name)
4163
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4164
# Import the new feature and use it as a replacement for the
4166
mod = __import__(self._replacement_module, {}, {},
4167
[self._replacement_name])
4168
self._feature = getattr(mod, self._replacement_name)
4172
return self._feature._probe()
4175
class ModuleAvailableFeature(Feature):
4176
"""This is a feature than describes a module we want to be available.
4178
Declare the name of the module in __init__(), and then after probing, the
4179
module will be available as 'self.module'.
4181
:ivar module: The module if it is available, else None.
4184
def __init__(self, module_name):
4185
super(ModuleAvailableFeature, self).__init__()
4186
self.module_name = module_name
4190
self._module = __import__(self.module_name, {}, {}, [''])
4197
if self.available(): # Make sure the probe has been done
4201
def feature_name(self):
4202
return self.module_name
4205
# This is kept here for compatibility, it is recommended to use
4206
# 'bzrlib.tests.feature.paramiko' instead
4207
ParamikoFeature = _CompatabilityThunkFeature(
4208
deprecated_in((2,1,0)),
4209
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4212
def probe_unicode_in_user_encoding():
4213
"""Try to encode several unicode strings to use in unicode-aware tests.
4214
Return first successfull match.
4216
:return: (unicode value, encoded plain string value) or (None, None)
4218
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4219
for uni_val in possible_vals:
4221
str_val = uni_val.encode(osutils.get_user_encoding())
4222
except UnicodeEncodeError:
4223
# Try a different character
4226
return uni_val, str_val
4230
def probe_bad_non_ascii(encoding):
4231
"""Try to find [bad] character with code [128..255]
4232
that cannot be decoded to unicode in some encoding.
4233
Return None if all non-ascii characters is valid
4236
for i in xrange(128, 256):
4239
char.decode(encoding)
4240
except UnicodeDecodeError:
4245
class _HTTPSServerFeature(Feature):
4246
"""Some tests want an https Server, check if one is available.
4248
Right now, the only way this is available is under python2.6 which provides
4259
def feature_name(self):
4260
return 'HTTPSServer'
4263
HTTPSServerFeature = _HTTPSServerFeature()
4266
class _UnicodeFilename(Feature):
4267
"""Does the filesystem support Unicode filenames?"""
4272
except UnicodeEncodeError:
4274
except (IOError, OSError):
4275
# The filesystem allows the Unicode filename but the file doesn't
4279
# The filesystem allows the Unicode filename and the file exists,
4283
UnicodeFilename = _UnicodeFilename()
4286
class _UTF8Filesystem(Feature):
4287
"""Is the filesystem UTF-8?"""
4290
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4294
UTF8Filesystem = _UTF8Filesystem()
4297
class _BreakinFeature(Feature):
4298
"""Does this platform support the breakin feature?"""
4301
from bzrlib import breakin
4302
if breakin.determine_signal() is None:
4304
if sys.platform == 'win32':
4305
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4306
# We trigger SIGBREAK via a Console api so we need ctypes to
4307
# access the function
4314
def feature_name(self):
4315
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4318
BreakinFeature = _BreakinFeature()
4321
class _CaseInsCasePresFilenameFeature(Feature):
4322
"""Is the file-system case insensitive, but case-preserving?"""
4325
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4327
# first check truly case-preserving for created files, then check
4328
# case insensitive when opening existing files.
4329
name = osutils.normpath(name)
4330
base, rel = osutils.split(name)
4331
found_rel = osutils.canonical_relpath(base, name)
4332
return (found_rel == rel
4333
and os.path.isfile(name.upper())
4334
and os.path.isfile(name.lower()))
4339
def feature_name(self):
4340
return "case-insensitive case-preserving filesystem"
4342
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4345
class _CaseInsensitiveFilesystemFeature(Feature):
4346
"""Check if underlying filesystem is case-insensitive but *not* case
4349
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4350
# more likely to be case preserving, so this case is rare.
4353
if CaseInsCasePresFilenameFeature.available():
4356
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4357
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4358
TestCaseWithMemoryTransport.TEST_ROOT = root
4360
root = TestCaseWithMemoryTransport.TEST_ROOT
4361
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4363
name_a = osutils.pathjoin(tdir, 'a')
4364
name_A = osutils.pathjoin(tdir, 'A')
4366
result = osutils.isdir(name_A)
4367
_rmtree_temp_dir(tdir)
4370
def feature_name(self):
4371
return 'case-insensitive filesystem'
4373
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4376
class _CaseSensitiveFilesystemFeature(Feature):
4379
if CaseInsCasePresFilenameFeature.available():
4381
elif CaseInsensitiveFilesystemFeature.available():
4386
def feature_name(self):
4387
return 'case-sensitive filesystem'
4389
# new coding style is for feature instances to be lowercase
4390
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4393
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4394
SubUnitFeature = _CompatabilityThunkFeature(
4395
deprecated_in((2,1,0)),
4396
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4397
# Only define SubUnitBzrRunner if subunit is available.
4399
from subunit import TestProtocolClient
4400
from subunit.test_results import AutoTimingTestResultDecorator
4401
class SubUnitBzrRunner(TextTestRunner):
4402
def run(self, test):
4403
result = AutoTimingTestResultDecorator(
4404
TestProtocolClient(self.stream))
234
sys.stdout = real_stdout
235
sys.stderr = real_stderr
237
_show_results(result)
239
return result.wasSuccessful()
244
def _setup_test_log():
248
log_filename = os.path.abspath('testbzr.log')
249
TestBase.TEST_LOG = open(log_filename, 'wt', buffering=1) # line buffered
251
print >>TestBase.TEST_LOG, "bzr tests run at " + time.ctime()
252
print '%-30s %s' % ('test log', log_filename)
255
def _setup_test_dir():
259
TestBase.ORIG_DIR = os.getcwdu()
260
TestBase.TEST_ROOT = os.path.abspath("testbzr.tmp")
262
print '%-30s %s' % ('running tests in', TestBase.TEST_ROOT)
264
if os.path.exists(TestBase.TEST_ROOT):
265
shutil.rmtree(TestBase.TEST_ROOT)
266
os.mkdir(TestBase.TEST_ROOT)
267
os.chdir(TestBase.TEST_ROOT)
269
# make a fake bzr directory there to prevent any tests propagating
270
# up onto the source directory's real branch
271
os.mkdir(os.path.join(TestBase.TEST_ROOT, '.bzr'))
275
def _show_results(result):
276
for case, tb in result.errors:
277
_show_test_failure('ERROR', case, tb)
279
for case, tb in result.failures:
280
_show_test_failure('FAILURE', case, tb)
283
print '%4d tests run' % result.testsRun
284
print '%4d errors' % len(result.errors)
285
print '%4d failures' % len(result.failures)
289
def _show_test_failure(kind, case, tb):
290
print (kind + '! ').ljust(60, '-')
292
desc = case.shortDescription()
297
if isinstance(case, TestBase):
299
print 'log from this test:'
302
print ''.ljust(60, '-')
added
removed
bzrlib/selftest/__init__.py
