1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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.
31
from cStringIO import StringIO
38
from pprint import pformat
43
from subprocess import Popen, PIPE, STDOUT
68
import bzrlib.commands
69
import bzrlib.timestamp
71
import bzrlib.inventory
72
import bzrlib.iterablefile
77
# lsprof not available
79
from bzrlib.merge import merge_inner
82
from bzrlib.smart import client, request, server
84
from bzrlib import symbol_versioning
85
from bzrlib.symbol_versioning import (
92
from bzrlib.transport import get_transport
93
import bzrlib.transport
94
from bzrlib.transport.local import LocalURLServer
95
from bzrlib.transport.memory import MemoryServer
96
from bzrlib.transport.readonly import ReadonlyServer
97
from bzrlib.trace import mutter, note
98
from bzrlib.tests import TestUtil
99
from bzrlib.tests.http_server import HttpServer
100
from bzrlib.tests.TestUtil import (
104
from bzrlib.tests.treeshape import build_tree_contents
105
from bzrlib.ui import NullProgressView
106
from bzrlib.ui.text import TextUIFactory
107
import bzrlib.version_info_formats.format_custom
108
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
110
# Mark this python module as being part of the implementation
111
# of unittest: this gives us better tracebacks where the last
112
# shown frame is the test code, not our assertXYZ.
115
default_transport = LocalURLServer
117
# Subunit result codes, defined here to prevent a hard dependency on subunit.
122
class ExtendedTestResult(unittest._TextTestResult):
123
"""Accepts, reports and accumulates the results of running tests.
125
Compared to the unittest version this class adds support for
126
profiling, benchmarking, stopping as soon as a test fails, and
127
skipping tests. There are further-specialized subclasses for
128
different types of display.
130
When a test finishes, in whatever way, it calls one of the addSuccess,
131
addFailure or addError classes. These in turn may redirect to a more
132
specific case for the special test results supported by our extended
135
Note that just one of these objects is fed the results from many tests.
140
def __init__(self, stream, descriptions, verbosity,
144
"""Construct new TestResult.
146
:param bench_history: Optionally, a writable file object to accumulate
149
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
150
if bench_history is not None:
151
from bzrlib.version import _get_bzr_source_tree
152
src_tree = _get_bzr_source_tree()
155
revision_id = src_tree.get_parent_ids()[0]
157
# XXX: if this is a brand new tree, do the same as if there
161
# XXX: If there's no branch, what should we do?
163
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
164
self._bench_history = bench_history
165
self.ui = ui.ui_factory
168
self.failure_count = 0
169
self.known_failure_count = 0
171
self.not_applicable_count = 0
172
self.unsupported = {}
174
self._overall_start_time = time.time()
175
self._strict = strict
178
# nb: called stopTestRun in the version of this that Python merged
179
# upstream, according to lifeless 20090803
181
ok = self.wasStrictlySuccessful()
183
ok = self.wasSuccessful()
185
self.stream.write('tests passed\n')
187
self.stream.write('tests failed\n')
188
if TestCase._first_thread_leaker_id:
190
'%s is leaking threads among %d leaking tests.\n' % (
191
TestCase._first_thread_leaker_id,
192
TestCase._leaking_threads_tests))
194
def _extractBenchmarkTime(self, testCase):
195
"""Add a benchmark time for the current test case."""
196
return getattr(testCase, "_benchtime", None)
198
def _elapsedTestTimeString(self):
199
"""Return a time string for the overall time the current test has taken."""
200
return self._formatTime(time.time() - self._start_time)
202
def _testTimeString(self, testCase):
203
benchmark_time = self._extractBenchmarkTime(testCase)
204
if benchmark_time is not None:
205
return self._formatTime(benchmark_time) + "*"
207
return self._elapsedTestTimeString()
209
def _formatTime(self, seconds):
210
"""Format seconds as milliseconds with leading spaces."""
211
# some benchmarks can take thousands of seconds to run, so we need 8
213
return "%8dms" % (1000 * seconds)
215
def _shortened_test_description(self, test):
217
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
220
def startTest(self, test):
221
unittest.TestResult.startTest(self, test)
224
self.report_test_start(test)
225
test.number = self.count
226
self._recordTestStartTime()
228
def startTests(self):
230
'testing: %s\n' % (osutils.realpath(sys.argv[0]),))
232
' %s (%s python%s)\n' % (
234
bzrlib.version_string,
235
bzrlib._format_version_tuple(sys.version_info),
237
self.stream.write('\n')
239
def _recordTestStartTime(self):
240
"""Record that a test has started."""
241
self._start_time = time.time()
243
def _cleanupLogFile(self, test):
244
# We can only do this if we have one of our TestCases, not if
246
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
247
if setKeepLogfile is not None:
250
def addError(self, test, err):
251
"""Tell result that test finished with an error.
253
Called from the TestCase run() method when the test
254
fails with an unexpected error.
256
self._testConcluded(test)
257
if isinstance(err[1], TestNotApplicable):
258
return self._addNotApplicable(test, err)
259
elif isinstance(err[1], UnavailableFeature):
260
return self.addNotSupported(test, err[1].args[0])
262
unittest.TestResult.addError(self, test, err)
263
self.error_count += 1
264
self.report_error(test, err)
267
self._cleanupLogFile(test)
269
def addFailure(self, test, err):
270
"""Tell result that test failed.
272
Called from the TestCase run() method when the test
273
fails because e.g. an assert() method failed.
275
self._testConcluded(test)
276
if isinstance(err[1], KnownFailure):
277
return self._addKnownFailure(test, err)
279
unittest.TestResult.addFailure(self, test, err)
280
self.failure_count += 1
281
self.report_failure(test, err)
284
self._cleanupLogFile(test)
286
def addSuccess(self, test):
287
"""Tell result that test completed successfully.
289
Called from the TestCase run()
291
self._testConcluded(test)
292
if self._bench_history is not None:
293
benchmark_time = self._extractBenchmarkTime(test)
294
if benchmark_time is not None:
295
self._bench_history.write("%s %s\n" % (
296
self._formatTime(benchmark_time),
298
self.report_success(test)
299
self._cleanupLogFile(test)
300
unittest.TestResult.addSuccess(self, test)
301
test._log_contents = ''
303
def _testConcluded(self, test):
304
"""Common code when a test has finished.
306
Called regardless of whether it succeded, failed, etc.
310
def _addKnownFailure(self, test, err):
311
self.known_failure_count += 1
312
self.report_known_failure(test, err)
314
def addNotSupported(self, test, feature):
315
"""The test will not be run because of a missing feature.
317
# this can be called in two different ways: it may be that the
318
# test started running, and then raised (through addError)
319
# UnavailableFeature. Alternatively this method can be called
320
# while probing for features before running the tests; in that
321
# case we will see startTest and stopTest, but the test will never
323
self.unsupported.setdefault(str(feature), 0)
324
self.unsupported[str(feature)] += 1
325
self.report_unsupported(test, feature)
327
def addSkip(self, test, reason):
328
"""A test has not run for 'reason'."""
330
self.report_skip(test, reason)
332
def _addNotApplicable(self, test, skip_excinfo):
333
if isinstance(skip_excinfo[1], TestNotApplicable):
334
self.not_applicable_count += 1
335
self.report_not_applicable(test, skip_excinfo)
338
except KeyboardInterrupt:
341
self.addError(test, test.exc_info())
343
# seems best to treat this as success from point-of-view of unittest
344
# -- it actually does nothing so it barely matters :)
345
unittest.TestResult.addSuccess(self, test)
346
test._log_contents = ''
348
def printErrorList(self, flavour, errors):
349
for test, err in errors:
350
self.stream.writeln(self.separator1)
351
self.stream.write("%s: " % flavour)
352
self.stream.writeln(self.getDescription(test))
353
if getattr(test, '_get_log', None) is not None:
354
log_contents = test._get_log()
356
self.stream.write('\n')
358
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
359
self.stream.write('\n')
360
self.stream.write(log_contents)
361
self.stream.write('\n')
363
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
364
self.stream.write('\n')
365
self.stream.writeln(self.separator2)
366
self.stream.writeln("%s" % err)
368
def progress(self, offset, whence):
369
"""The test is adjusting the count of tests to run."""
370
if whence == SUBUNIT_SEEK_SET:
371
self.num_tests = offset
372
elif whence == SUBUNIT_SEEK_CUR:
373
self.num_tests += offset
375
raise errors.BzrError("Unknown whence %r" % whence)
380
def report_cleaning_up(self):
383
def report_success(self, test):
386
def wasStrictlySuccessful(self):
387
if self.unsupported or self.known_failure_count:
389
return self.wasSuccessful()
392
class TextTestResult(ExtendedTestResult):
393
"""Displays progress and results of tests in text form"""
395
def __init__(self, stream, descriptions, verbosity,
400
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
401
bench_history, strict)
402
# We no longer pass them around, but just rely on the UIFactory stack
405
warnings.warn("Passing pb to TextTestResult is deprecated")
406
self.pb = self.ui.nested_progress_bar()
407
self.pb.show_pct = False
408
self.pb.show_spinner = False
409
self.pb.show_eta = False,
410
self.pb.show_count = False
411
self.pb.show_bar = False
412
self.pb.update_latency = 0
413
self.pb.show_transport_activity = False
416
# called when the tests that are going to run have run
418
super(TextTestResult, self).done()
423
def report_starting(self):
424
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
426
def printErrors(self):
427
# clear the pb to make room for the error listing
429
super(TextTestResult, self).printErrors()
431
def _progress_prefix_text(self):
432
# the longer this text, the less space we have to show the test
434
a = '[%d' % self.count # total that have been run
435
# tests skipped as known not to be relevant are not important enough
437
## if self.skip_count:
438
## a += ', %d skip' % self.skip_count
439
## if self.known_failure_count:
440
## a += '+%dX' % self.known_failure_count
442
a +='/%d' % self.num_tests
444
runtime = time.time() - self._overall_start_time
446
a += '%dm%ds' % (runtime / 60, runtime % 60)
450
a += ', %d err' % self.error_count
451
if self.failure_count:
452
a += ', %d fail' % self.failure_count
454
a += ', %d missing' % len(self.unsupported)
458
def report_test_start(self, test):
461
self._progress_prefix_text()
463
+ self._shortened_test_description(test))
465
def _test_description(self, test):
466
return self._shortened_test_description(test)
468
def report_error(self, test, err):
469
self.pb.note('ERROR: %s\n %s\n',
470
self._test_description(test),
474
def report_failure(self, test, err):
475
self.pb.note('FAIL: %s\n %s\n',
476
self._test_description(test),
480
def report_known_failure(self, test, err):
481
self.pb.note('XFAIL: %s\n%s\n',
482
self._test_description(test), err[1])
484
def report_skip(self, test, reason):
487
def report_not_applicable(self, test, skip_excinfo):
490
def report_unsupported(self, test, feature):
491
"""test cannot be run because feature is missing."""
493
def report_cleaning_up(self):
494
self.pb.update('Cleaning up')
497
class VerboseTestResult(ExtendedTestResult):
498
"""Produce long output, with one line per test run plus times"""
500
def _ellipsize_to_right(self, a_string, final_width):
501
"""Truncate and pad a string, keeping the right hand side"""
502
if len(a_string) > final_width:
503
result = '...' + a_string[3-final_width:]
506
return result.ljust(final_width)
508
def report_starting(self):
509
self.stream.write('running %d tests...\n' % self.num_tests)
511
def report_test_start(self, test):
513
name = self._shortened_test_description(test)
514
# width needs space for 6 char status, plus 1 for slash, plus an
515
# 11-char time string, plus a trailing blank
516
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
517
self.stream.write(self._ellipsize_to_right(name,
518
osutils.terminal_width()-18))
521
def _error_summary(self, err):
523
return '%s%s' % (indent, err[1])
525
def report_error(self, test, err):
526
self.stream.writeln('ERROR %s\n%s'
527
% (self._testTimeString(test),
528
self._error_summary(err)))
530
def report_failure(self, test, err):
531
self.stream.writeln(' FAIL %s\n%s'
532
% (self._testTimeString(test),
533
self._error_summary(err)))
535
def report_known_failure(self, test, err):
536
self.stream.writeln('XFAIL %s\n%s'
537
% (self._testTimeString(test),
538
self._error_summary(err)))
540
def report_success(self, test):
541
self.stream.writeln(' OK %s' % self._testTimeString(test))
542
for bench_called, stats in getattr(test, '_benchcalls', []):
543
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
544
stats.pprint(file=self.stream)
545
# flush the stream so that we get smooth output. This verbose mode is
546
# used to show the output in PQM.
549
def report_skip(self, test, reason):
550
self.stream.writeln(' SKIP %s\n%s'
551
% (self._testTimeString(test), reason))
553
def report_not_applicable(self, test, skip_excinfo):
554
self.stream.writeln(' N/A %s\n%s'
555
% (self._testTimeString(test),
556
self._error_summary(skip_excinfo)))
558
def report_unsupported(self, test, feature):
559
"""test cannot be run because feature is missing."""
560
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
561
%(self._testTimeString(test), feature))
564
class TextTestRunner(object):
565
stop_on_failure = False
575
self.stream = unittest._WritelnDecorator(stream)
576
self.descriptions = descriptions
577
self.verbosity = verbosity
578
self._bench_history = bench_history
579
self.list_only = list_only
580
self._strict = strict
583
"Run the given test case or test suite."
584
startTime = time.time()
585
if self.verbosity == 1:
586
result_class = TextTestResult
587
elif self.verbosity >= 2:
588
result_class = VerboseTestResult
589
result = result_class(self.stream,
592
bench_history=self._bench_history,
595
result.stop_early = self.stop_on_failure
596
result.report_starting()
598
if self.verbosity >= 2:
599
self.stream.writeln("Listing tests only ...\n")
601
for t in iter_suite_tests(test):
602
self.stream.writeln("%s" % (t.id()))
611
if isinstance(test, testtools.ConcurrentTestSuite):
612
# We need to catch bzr specific behaviors
613
test.run(BZRTransformingResult(result))
616
run = result.testsRun
618
stopTime = time.time()
619
timeTaken = stopTime - startTime
621
self.stream.writeln(result.separator2)
622
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
623
run, run != 1 and "s" or "", timeTaken))
624
self.stream.writeln()
625
if not result.wasSuccessful():
626
self.stream.write("FAILED (")
627
failed, errored = map(len, (result.failures, result.errors))
629
self.stream.write("failures=%d" % failed)
631
if failed: self.stream.write(", ")
632
self.stream.write("errors=%d" % errored)
633
if result.known_failure_count:
634
if failed or errored: self.stream.write(", ")
635
self.stream.write("known_failure_count=%d" %
636
result.known_failure_count)
637
self.stream.writeln(")")
639
if result.known_failure_count:
640
self.stream.writeln("OK (known_failures=%d)" %
641
result.known_failure_count)
643
self.stream.writeln("OK")
644
if result.skip_count > 0:
645
skipped = result.skip_count
646
self.stream.writeln('%d test%s skipped' %
647
(skipped, skipped != 1 and "s" or ""))
648
if result.unsupported:
649
for feature, count in sorted(result.unsupported.items()):
650
self.stream.writeln("Missing feature '%s' skipped %d tests." %
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
class TestSkipped(Exception):
670
"""Indicates that a test was intentionally skipped, rather than failing."""
673
class TestNotApplicable(TestSkipped):
674
"""A test is not applicable to the situation where it was run.
676
This is only normally raised by parameterized tests, if they find that
677
the instance they're constructed upon does not support one aspect
682
class KnownFailure(AssertionError):
683
"""Indicates that a test failed in a precisely expected manner.
685
Such failures dont block the whole test suite from passing because they are
686
indicators of partially completed code or of future work. We have an
687
explicit error for them so that we can ensure that they are always visible:
688
KnownFailures are always shown in the output of bzr selftest.
692
class UnavailableFeature(Exception):
693
"""A feature required for this test was not available.
695
The feature should be used to construct the exception.
699
class CommandFailed(Exception):
703
class StringIOWrapper(object):
704
"""A wrapper around cStringIO which just adds an encoding attribute.
706
Internally we can check sys.stdout to see what the output encoding
707
should be. However, cStringIO has no encoding attribute that we can
708
set. So we wrap it instead.
713
def __init__(self, s=None):
715
self.__dict__['_cstring'] = StringIO(s)
717
self.__dict__['_cstring'] = StringIO()
719
def __getattr__(self, name, getattr=getattr):
720
return getattr(self.__dict__['_cstring'], name)
722
def __setattr__(self, name, val):
723
if name == 'encoding':
724
self.__dict__['encoding'] = val
726
return setattr(self._cstring, name, val)
729
class TestUIFactory(TextUIFactory):
730
"""A UI Factory for testing.
732
Hide the progress bar but emit note()s.
734
Allows get_password to be tested without real tty attached.
736
See also CannedInputUIFactory which lets you provide programmatic input in
739
# TODO: Capture progress events at the model level and allow them to be
740
# observed by tests that care.
742
# XXX: Should probably unify more with CannedInputUIFactory or a
743
# particular configuration of TextUIFactory, or otherwise have a clearer
744
# idea of how they're supposed to be different.
745
# See https://bugs.edge.launchpad.net/bzr/+bug/408213
747
def __init__(self, stdout=None, stderr=None, stdin=None):
748
if stdin is not None:
749
# We use a StringIOWrapper to be able to test various
750
# encodings, but the user is still responsible to
751
# encode the string and to set the encoding attribute
752
# of StringIOWrapper.
753
stdin = StringIOWrapper(stdin)
754
super(TestUIFactory, self).__init__(stdin, stdout, stderr)
756
def make_progress_view(self):
757
return NullProgressView()
759
def update(self, message, count=None, total=None):
760
"""See progress.ProgressBar.update()."""
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]
772
class TestCase(unittest.TestCase):
773
"""Base class for bzr unit tests.
775
Tests that need access to disk resources should subclass
776
TestCaseInTempDir not TestCase.
778
Error and debug log messages are redirected from their usual
779
location into a temporary file, the contents of which can be
780
retrieved by _get_log(). We use a real OS file, not an in-memory object,
781
so that it can also capture file IO. When the test completes this file
782
is read into memory and removed from disk.
784
There are also convenience functions to invoke bzr's command-line
785
routine, and to build and check bzr trees.
787
In addition to the usual method of overriding tearDown(), this class also
788
allows subclasses to register functions into the _cleanups list, which is
789
run in order as the object is torn down. It's less likely this will be
790
accidentally overlooked.
793
_active_threads = None
794
_leaking_threads_tests = 0
795
_first_thread_leaker_id = None
796
_log_file_name = None
798
_keep_log_file = False
799
# record lsprof data when performing benchmark calls.
800
_gather_lsprof_in_benchmarks = False
801
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
802
'_log_contents', '_log_file_name', '_benchtime',
803
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
805
def __init__(self, methodName='testMethod'):
806
super(TestCase, self).__init__(methodName)
808
self._bzr_test_setUp_run = False
809
self._bzr_test_tearDown_run = False
812
unittest.TestCase.setUp(self)
813
self._bzr_test_setUp_run = True
814
self._cleanEnvironment()
817
self._benchcalls = []
818
self._benchtime = None
820
# Track locks - needs to be called before _clear_debug_flags.
822
self._clear_debug_flags()
823
TestCase._active_threads = threading.activeCount()
824
self.addCleanup(self._check_leaked_threads)
829
pdb.Pdb().set_trace(sys._getframe().f_back)
831
def _check_leaked_threads(self):
832
active = threading.activeCount()
833
leaked_threads = active - TestCase._active_threads
834
TestCase._active_threads = active
836
TestCase._leaking_threads_tests += 1
837
if TestCase._first_thread_leaker_id is None:
838
TestCase._first_thread_leaker_id = self.id()
840
def _clear_debug_flags(self):
841
"""Prevent externally set debug flags affecting tests.
843
Tests that want to use debug flags can just set them in the
844
debug_flags set during setup/teardown.
846
self._preserved_debug_flags = set(debug.debug_flags)
847
if 'allow_debug' not in selftest_debug_flags:
848
debug.debug_flags.clear()
849
self.addCleanup(self._restore_debug_flags)
851
def _clear_hooks(self):
852
# prevent hooks affecting tests
853
self._preserved_hooks = {}
854
for key, factory in hooks.known_hooks.items():
855
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
856
current_hooks = hooks.known_hooks_key_to_object(key)
857
self._preserved_hooks[parent] = (name, current_hooks)
858
self.addCleanup(self._restoreHooks)
859
for key, factory in hooks.known_hooks.items():
860
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
861
setattr(parent, name, factory())
862
# this hook should always be installed
863
request._install_hook()
865
def _silenceUI(self):
866
"""Turn off UI for duration of test"""
867
# by default the UI is off; tests can turn it on if they want it.
868
saved = ui.ui_factory
870
ui.ui_factory = saved
871
ui.ui_factory = ui.SilentUIFactory()
872
self.addCleanup(_restore)
874
def _check_locks(self):
875
"""Check that all lock take/release actions have been paired."""
876
# once we have fixed all the current lock problems, we can change the
877
# following code to always check for mismatched locks, but only do
878
# traceback showing with -Dlock (self._lock_check_thorough is True).
879
# For now, because the test suite will fail, we only assert that lock
880
# matching has occured with -Dlock.
882
acquired_locks = [lock for action, lock in self._lock_actions
883
if action == 'acquired']
884
released_locks = [lock for action, lock in self._lock_actions
885
if action == 'released']
886
broken_locks = [lock for action, lock in self._lock_actions
887
if action == 'broken']
888
# trivially, given the tests for lock acquistion and release, if we
889
# have as many in each list, it should be ok. Some lock tests also
890
# break some locks on purpose and should be taken into account by
891
# considering that breaking a lock is just a dirty way of releasing it.
892
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
893
message = ('Different number of acquired and '
894
'released or broken locks. (%s, %s + %s)' %
895
(acquired_locks, released_locks, broken_locks))
896
if not self._lock_check_thorough:
897
# Rather than fail, just warn
898
print "Broken test %s: %s" % (self, message)
902
def _track_locks(self):
903
"""Track lock activity during tests."""
904
self._lock_actions = []
905
self._lock_check_thorough = 'lock' not in debug.debug_flags
906
self.addCleanup(self._check_locks)
907
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
908
self._lock_acquired, None)
909
_mod_lock.Lock.hooks.install_named_hook('lock_released',
910
self._lock_released, None)
911
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
912
self._lock_broken, None)
914
def _lock_acquired(self, result):
915
self._lock_actions.append(('acquired', result))
917
def _lock_released(self, result):
918
self._lock_actions.append(('released', result))
920
def _lock_broken(self, result):
921
self._lock_actions.append(('broken', result))
923
def _ndiff_strings(self, a, b):
924
"""Return ndiff between two strings containing lines.
926
A trailing newline is added if missing to make the strings
928
if b and b[-1] != '\n':
930
if a and a[-1] != '\n':
932
difflines = difflib.ndiff(a.splitlines(True),
934
linejunk=lambda x: False,
935
charjunk=lambda x: False)
936
return ''.join(difflines)
938
def assertEqual(self, a, b, message=''):
942
except UnicodeError, e:
943
# If we can't compare without getting a UnicodeError, then
944
# obviously they are different
945
mutter('UnicodeError: %s', e)
948
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
950
pformat(a), pformat(b)))
952
assertEquals = assertEqual
954
def assertEqualDiff(self, a, b, message=None):
955
"""Assert two texts are equal, if not raise an exception.
957
This is intended for use with multi-line strings where it can
958
be hard to find the differences by eye.
960
# TODO: perhaps override assertEquals to call this for strings?
964
message = "texts not equal:\n"
966
message = 'first string is missing a final newline.\n'
968
message = 'second string is missing a final newline.\n'
969
raise AssertionError(message +
970
self._ndiff_strings(a, b))
972
def assertEqualMode(self, mode, mode_test):
973
self.assertEqual(mode, mode_test,
974
'mode mismatch %o != %o' % (mode, mode_test))
976
def assertEqualStat(self, expected, actual):
977
"""assert that expected and actual are the same stat result.
979
:param expected: A stat result.
980
:param actual: A stat result.
981
:raises AssertionError: If the expected and actual stat values differ
984
self.assertEqual(expected.st_size, actual.st_size)
985
self.assertEqual(expected.st_mtime, actual.st_mtime)
986
self.assertEqual(expected.st_ctime, actual.st_ctime)
987
self.assertEqual(expected.st_dev, actual.st_dev)
988
self.assertEqual(expected.st_ino, actual.st_ino)
989
self.assertEqual(expected.st_mode, actual.st_mode)
991
def assertLength(self, length, obj_with_len):
992
"""Assert that obj_with_len is of length length."""
993
if len(obj_with_len) != length:
994
self.fail("Incorrect length: wanted %d, got %d for %r" % (
995
length, len(obj_with_len), obj_with_len))
997
def assertPositive(self, val):
998
"""Assert that val is greater than 0."""
999
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1001
def assertNegative(self, val):
1002
"""Assert that val is less than 0."""
1003
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1005
def assertStartsWith(self, s, prefix):
1006
if not s.startswith(prefix):
1007
raise AssertionError('string %r does not start with %r' % (s, prefix))
1009
def assertEndsWith(self, s, suffix):
1010
"""Asserts that s ends with suffix."""
1011
if not s.endswith(suffix):
1012
raise AssertionError('string %r does not end with %r' % (s, suffix))
1014
def assertContainsRe(self, haystack, needle_re, flags=0):
1015
"""Assert that a contains something matching a regular expression."""
1016
if not re.search(needle_re, haystack, flags):
1017
if '\n' in haystack or len(haystack) > 60:
1018
# a long string, format it in a more readable way
1019
raise AssertionError(
1020
'pattern "%s" not found in\n"""\\\n%s"""\n'
1021
% (needle_re, haystack))
1023
raise AssertionError('pattern "%s" not found in "%s"'
1024
% (needle_re, haystack))
1026
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1027
"""Assert that a does not match a regular expression"""
1028
if re.search(needle_re, haystack, flags):
1029
raise AssertionError('pattern "%s" found in "%s"'
1030
% (needle_re, haystack))
1032
def assertSubset(self, sublist, superlist):
1033
"""Assert that every entry in sublist is present in superlist."""
1034
missing = set(sublist) - set(superlist)
1035
if len(missing) > 0:
1036
raise AssertionError("value(s) %r not present in container %r" %
1037
(missing, superlist))
1039
def assertListRaises(self, excClass, func, *args, **kwargs):
1040
"""Fail unless excClass is raised when the iterator from func is used.
1042
Many functions can return generators this makes sure
1043
to wrap them in a list() call to make sure the whole generator
1044
is run, and that the proper exception is raised.
1047
list(func(*args, **kwargs))
1051
if getattr(excClass,'__name__', None) is not None:
1052
excName = excClass.__name__
1054
excName = str(excClass)
1055
raise self.failureException, "%s not raised" % excName
1057
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1058
"""Assert that a callable raises a particular exception.
1060
:param excClass: As for the except statement, this may be either an
1061
exception class, or a tuple of classes.
1062
:param callableObj: A callable, will be passed ``*args`` and
1065
Returns the exception so that you can examine it.
1068
callableObj(*args, **kwargs)
1072
if getattr(excClass,'__name__', None) is not None:
1073
excName = excClass.__name__
1076
excName = str(excClass)
1077
raise self.failureException, "%s not raised" % excName
1079
def assertIs(self, left, right, message=None):
1080
if not (left is right):
1081
if message is not None:
1082
raise AssertionError(message)
1084
raise AssertionError("%r is not %r." % (left, right))
1086
def assertIsNot(self, left, right, message=None):
1088
if message is not None:
1089
raise AssertionError(message)
1091
raise AssertionError("%r is %r." % (left, right))
1093
def assertTransportMode(self, transport, path, mode):
1094
"""Fail if a path does not have mode "mode".
1096
If modes are not supported on this transport, the assertion is ignored.
1098
if not transport._can_roundtrip_unix_modebits():
1100
path_stat = transport.stat(path)
1101
actual_mode = stat.S_IMODE(path_stat.st_mode)
1102
self.assertEqual(mode, actual_mode,
1103
'mode of %r incorrect (%s != %s)'
1104
% (path, oct(mode), oct(actual_mode)))
1106
def assertIsSameRealPath(self, path1, path2):
1107
"""Fail if path1 and path2 points to different files"""
1108
self.assertEqual(osutils.realpath(path1),
1109
osutils.realpath(path2),
1110
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1112
def assertIsInstance(self, obj, kls, msg=None):
1113
"""Fail if obj is not an instance of kls
1115
:param msg: Supplementary message to show if the assertion fails.
1117
if not isinstance(obj, kls):
1118
m = "%r is an instance of %s rather than %s" % (
1119
obj, obj.__class__, kls)
1124
def expectFailure(self, reason, assertion, *args, **kwargs):
1125
"""Invoke a test, expecting it to fail for the given reason.
1127
This is for assertions that ought to succeed, but currently fail.
1128
(The failure is *expected* but not *wanted*.) Please be very precise
1129
about the failure you're expecting. If a new bug is introduced,
1130
AssertionError should be raised, not KnownFailure.
1132
Frequently, expectFailure should be followed by an opposite assertion.
1135
Intended to be used with a callable that raises AssertionError as the
1136
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1138
Raises KnownFailure if the test fails. Raises AssertionError if the
1143
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1145
self.assertEqual(42, dynamic_val)
1147
This means that a dynamic_val of 54 will cause the test to raise
1148
a KnownFailure. Once math is fixed and the expectFailure is removed,
1149
only a dynamic_val of 42 will allow the test to pass. Anything other
1150
than 54 or 42 will cause an AssertionError.
1153
assertion(*args, **kwargs)
1154
except AssertionError:
1155
raise KnownFailure(reason)
1157
self.fail('Unexpected success. Should have failed: %s' % reason)
1159
def assertFileEqual(self, content, path):
1160
"""Fail if path does not contain 'content'."""
1161
self.failUnlessExists(path)
1162
f = file(path, 'rb')
1167
self.assertEqualDiff(content, s)
1169
def failUnlessExists(self, path):
1170
"""Fail unless path or paths, which may be abs or relative, exist."""
1171
if not isinstance(path, basestring):
1173
self.failUnlessExists(p)
1175
self.failUnless(osutils.lexists(path),path+" does not exist")
1177
def failIfExists(self, path):
1178
"""Fail if path or paths, which may be abs or relative, exist."""
1179
if not isinstance(path, basestring):
1181
self.failIfExists(p)
1183
self.failIf(osutils.lexists(path),path+" exists")
1185
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1186
"""A helper for callDeprecated and applyDeprecated.
1188
:param a_callable: A callable to call.
1189
:param args: The positional arguments for the callable
1190
:param kwargs: The keyword arguments for the callable
1191
:return: A tuple (warnings, result). result is the result of calling
1192
a_callable(``*args``, ``**kwargs``).
1195
def capture_warnings(msg, cls=None, stacklevel=None):
1196
# we've hooked into a deprecation specific callpath,
1197
# only deprecations should getting sent via it.
1198
self.assertEqual(cls, DeprecationWarning)
1199
local_warnings.append(msg)
1200
original_warning_method = symbol_versioning.warn
1201
symbol_versioning.set_warning_method(capture_warnings)
1203
result = a_callable(*args, **kwargs)
1205
symbol_versioning.set_warning_method(original_warning_method)
1206
return (local_warnings, result)
1208
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1209
"""Call a deprecated callable without warning the user.
1211
Note that this only captures warnings raised by symbol_versioning.warn,
1212
not other callers that go direct to the warning module.
1214
To test that a deprecated method raises an error, do something like
1217
self.assertRaises(errors.ReservedId,
1218
self.applyDeprecated,
1219
deprecated_in((1, 5, 0)),
1223
:param deprecation_format: The deprecation format that the callable
1224
should have been deprecated with. This is the same type as the
1225
parameter to deprecated_method/deprecated_function. If the
1226
callable is not deprecated with this format, an assertion error
1228
:param a_callable: A callable to call. This may be a bound method or
1229
a regular function. It will be called with ``*args`` and
1231
:param args: The positional arguments for the callable
1232
:param kwargs: The keyword arguments for the callable
1233
:return: The result of a_callable(``*args``, ``**kwargs``)
1235
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1237
expected_first_warning = symbol_versioning.deprecation_string(
1238
a_callable, deprecation_format)
1239
if len(call_warnings) == 0:
1240
self.fail("No deprecation warning generated by call to %s" %
1242
self.assertEqual(expected_first_warning, call_warnings[0])
1245
def callCatchWarnings(self, fn, *args, **kw):
1246
"""Call a callable that raises python warnings.
1248
The caller's responsible for examining the returned warnings.
1250
If the callable raises an exception, the exception is not
1251
caught and propagates up to the caller. In that case, the list
1252
of warnings is not available.
1254
:returns: ([warning_object, ...], fn_result)
1256
# XXX: This is not perfect, because it completely overrides the
1257
# warnings filters, and some code may depend on suppressing particular
1258
# warnings. It's the easiest way to insulate ourselves from -Werror,
1259
# though. -- Andrew, 20071062
1261
def _catcher(message, category, filename, lineno, file=None, line=None):
1262
# despite the name, 'message' is normally(?) a Warning subclass
1264
wlist.append(message)
1265
saved_showwarning = warnings.showwarning
1266
saved_filters = warnings.filters
1268
warnings.showwarning = _catcher
1269
warnings.filters = []
1270
result = fn(*args, **kw)
1272
warnings.showwarning = saved_showwarning
1273
warnings.filters = saved_filters
1274
return wlist, result
1276
def callDeprecated(self, expected, callable, *args, **kwargs):
1277
"""Assert that a callable is deprecated in a particular way.
1279
This is a very precise test for unusual requirements. The
1280
applyDeprecated helper function is probably more suited for most tests
1281
as it allows you to simply specify the deprecation format being used
1282
and will ensure that that is issued for the function being called.
1284
Note that this only captures warnings raised by symbol_versioning.warn,
1285
not other callers that go direct to the warning module. To catch
1286
general warnings, use callCatchWarnings.
1288
:param expected: a list of the deprecation warnings expected, in order
1289
:param callable: The callable to call
1290
:param args: The positional arguments for the callable
1291
:param kwargs: The keyword arguments for the callable
1293
call_warnings, result = self._capture_deprecation_warnings(callable,
1295
self.assertEqual(expected, call_warnings)
1298
def _startLogFile(self):
1299
"""Send bzr and test log messages to a temporary file.
1301
The file is removed as the test is torn down.
1303
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1304
self._log_file = os.fdopen(fileno, 'w+')
1305
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1306
self._log_file_name = name
1307
self.addCleanup(self._finishLogFile)
1309
def _finishLogFile(self):
1310
"""Finished with the log file.
1312
Close the file and delete it, unless setKeepLogfile was called.
1314
if self._log_file is None:
1316
bzrlib.trace.pop_log_file(self._log_memento)
1317
self._log_file.close()
1318
self._log_file = None
1319
if not self._keep_log_file:
1320
os.remove(self._log_file_name)
1321
self._log_file_name = None
1323
def setKeepLogfile(self):
1324
"""Make the logfile not be deleted when _finishLogFile is called."""
1325
self._keep_log_file = True
1327
def addCleanup(self, callable, *args, **kwargs):
1328
"""Arrange to run a callable when this case is torn down.
1330
Callables are run in the reverse of the order they are registered,
1331
ie last-in first-out.
1333
self._cleanups.append((callable, args, kwargs))
1335
def _cleanEnvironment(self):
1337
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1338
'HOME': os.getcwd(),
1339
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1340
# tests do check our impls match APPDATA
1341
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1345
'BZREMAIL': None, # may still be present in the environment
1347
'BZR_PROGRESS_BAR': None,
1349
'BZR_PLUGIN_PATH': None,
1350
# Make sure that any text ui tests are consistent regardless of
1351
# the environment the test case is run in; you may want tests that
1352
# test other combinations. 'dumb' is a reasonable guess for tests
1353
# going to a pipe or a StringIO.
1358
'SSH_AUTH_SOCK': None,
1362
'https_proxy': None,
1363
'HTTPS_PROXY': None,
1368
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1369
# least. If you do (care), please update this comment
1373
'BZR_REMOTE_PATH': None,
1376
self.addCleanup(self._restoreEnvironment)
1377
for name, value in new_env.iteritems():
1378
self._captureVar(name, value)
1380
def _captureVar(self, name, newvalue):
1381
"""Set an environment variable, and reset it when finished."""
1382
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1384
def _restore_debug_flags(self):
1385
debug.debug_flags.clear()
1386
debug.debug_flags.update(self._preserved_debug_flags)
1388
def _restoreEnvironment(self):
1389
for name, value in self.__old_env.iteritems():
1390
osutils.set_or_unset_env(name, value)
1392
def _restoreHooks(self):
1393
for klass, (name, hooks) in self._preserved_hooks.items():
1394
setattr(klass, name, hooks)
1396
def knownFailure(self, reason):
1397
"""This test has failed for some known reason."""
1398
raise KnownFailure(reason)
1400
def _do_skip(self, result, reason):
1401
addSkip = getattr(result, 'addSkip', None)
1402
if not callable(addSkip):
1403
result.addError(self, sys.exc_info())
1405
addSkip(self, reason)
1407
def run(self, result=None):
1408
if result is None: result = self.defaultTestResult()
1409
for feature in getattr(self, '_test_needs_features', []):
1410
if not feature.available():
1411
result.startTest(self)
1412
if getattr(result, 'addNotSupported', None):
1413
result.addNotSupported(self, feature)
1415
result.addSuccess(self)
1416
result.stopTest(self)
1420
result.startTest(self)
1421
absent_attr = object()
1423
method_name = getattr(self, '_testMethodName', absent_attr)
1424
if method_name is absent_attr:
1426
method_name = getattr(self, '_TestCase__testMethodName')
1427
testMethod = getattr(self, method_name)
1431
if not self._bzr_test_setUp_run:
1433
"test setUp did not invoke "
1434
"bzrlib.tests.TestCase's setUp")
1435
except KeyboardInterrupt:
1438
except TestSkipped, e:
1439
self._do_skip(result, e.args[0])
1443
result.addError(self, sys.exc_info())
1451
except self.failureException:
1452
result.addFailure(self, sys.exc_info())
1453
except TestSkipped, e:
1455
reason = "No reason given."
1458
self._do_skip(result, reason)
1459
except KeyboardInterrupt:
1463
result.addError(self, sys.exc_info())
1467
if not self._bzr_test_tearDown_run:
1469
"test tearDown did not invoke "
1470
"bzrlib.tests.TestCase's tearDown")
1471
except KeyboardInterrupt:
1475
result.addError(self, sys.exc_info())
1478
if ok: result.addSuccess(self)
1480
result.stopTest(self)
1482
except TestNotApplicable:
1483
# Not moved from the result [yet].
1486
except KeyboardInterrupt:
1491
for attr_name in self.attrs_to_keep:
1492
if attr_name in self.__dict__:
1493
saved_attrs[attr_name] = self.__dict__[attr_name]
1494
self.__dict__ = saved_attrs
1498
self._log_contents = ''
1499
self._bzr_test_tearDown_run = True
1500
unittest.TestCase.tearDown(self)
1502
def time(self, callable, *args, **kwargs):
1503
"""Run callable and accrue the time it takes to the benchmark time.
1505
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1506
this will cause lsprofile statistics to be gathered and stored in
1509
if self._benchtime is None:
1513
if not self._gather_lsprof_in_benchmarks:
1514
return callable(*args, **kwargs)
1516
# record this benchmark
1517
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1519
self._benchcalls.append(((callable, args, kwargs), stats))
1522
self._benchtime += time.time() - start
1524
def _runCleanups(self):
1525
"""Run registered cleanup functions.
1527
This should only be called from TestCase.tearDown.
1529
# TODO: Perhaps this should keep running cleanups even if
1530
# one of them fails?
1532
# Actually pop the cleanups from the list so tearDown running
1533
# twice is safe (this happens for skipped tests).
1534
while self._cleanups:
1535
cleanup, args, kwargs = self._cleanups.pop()
1536
cleanup(*args, **kwargs)
1538
def log(self, *args):
1541
def _get_log(self, keep_log_file=False):
1542
"""Get the log from bzrlib.trace calls from this test.
1544
:param keep_log_file: When True, if the log is still a file on disk
1545
leave it as a file on disk. When False, if the log is still a file
1546
on disk, the log file is deleted and the log preserved as
1548
:return: A string containing the log.
1550
# flush the log file, to get all content
1552
if bzrlib.trace._trace_file:
1553
bzrlib.trace._trace_file.flush()
1554
if self._log_contents:
1555
# XXX: this can hardly contain the content flushed above --vila
1557
return self._log_contents
1558
if self._log_file_name is not None:
1559
logfile = open(self._log_file_name)
1561
log_contents = logfile.read()
1564
if not keep_log_file:
1565
self._log_contents = log_contents
1567
os.remove(self._log_file_name)
1569
if sys.platform == 'win32' and e.errno == errno.EACCES:
1570
sys.stderr.write(('Unable to delete log file '
1571
' %r\n' % self._log_file_name))
1576
return "DELETED log file to reduce memory footprint"
1578
def requireFeature(self, feature):
1579
"""This test requires a specific feature is available.
1581
:raises UnavailableFeature: When feature is not available.
1583
if not feature.available():
1584
raise UnavailableFeature(feature)
1586
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1588
"""Run bazaar command line, splitting up a string command line."""
1589
if isinstance(args, basestring):
1590
# shlex don't understand unicode strings,
1591
# so args should be plain string (bialix 20070906)
1592
args = list(shlex.split(str(args)))
1593
return self._run_bzr_core(args, retcode=retcode,
1594
encoding=encoding, stdin=stdin, working_dir=working_dir,
1597
def _run_bzr_core(self, args, retcode, encoding, stdin,
1599
if encoding is None:
1600
encoding = osutils.get_user_encoding()
1601
stdout = StringIOWrapper()
1602
stderr = StringIOWrapper()
1603
stdout.encoding = encoding
1604
stderr.encoding = encoding
1606
self.log('run bzr: %r', args)
1607
# FIXME: don't call into logging here
1608
handler = logging.StreamHandler(stderr)
1609
handler.setLevel(logging.INFO)
1610
logger = logging.getLogger('')
1611
logger.addHandler(handler)
1612
old_ui_factory = ui.ui_factory
1613
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1616
if working_dir is not None:
1617
cwd = osutils.getcwd()
1618
os.chdir(working_dir)
1621
result = self.apply_redirected(ui.ui_factory.stdin,
1623
bzrlib.commands.run_bzr_catch_user_errors,
1626
logger.removeHandler(handler)
1627
ui.ui_factory = old_ui_factory
1631
out = stdout.getvalue()
1632
err = stderr.getvalue()
1634
self.log('output:\n%r', out)
1636
self.log('errors:\n%r', err)
1637
if retcode is not None:
1638
self.assertEquals(retcode, result,
1639
message='Unexpected return code')
1642
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1643
working_dir=None, error_regexes=[], output_encoding=None):
1644
"""Invoke bzr, as if it were run from the command line.
1646
The argument list should not include the bzr program name - the
1647
first argument is normally the bzr command. Arguments may be
1648
passed in three ways:
1650
1- A list of strings, eg ["commit", "a"]. This is recommended
1651
when the command contains whitespace or metacharacters, or
1652
is built up at run time.
1654
2- A single string, eg "add a". This is the most convenient
1655
for hardcoded commands.
1657
This runs bzr through the interface that catches and reports
1658
errors, and with logging set to something approximating the
1659
default, so that error reporting can be checked.
1661
This should be the main method for tests that want to exercise the
1662
overall behavior of the bzr application (rather than a unit test
1663
or a functional test of the library.)
1665
This sends the stdout/stderr results into the test's log,
1666
where it may be useful for debugging. See also run_captured.
1668
:keyword stdin: A string to be used as stdin for the command.
1669
:keyword retcode: The status code the command should return;
1671
:keyword working_dir: The directory to run the command in
1672
:keyword error_regexes: A list of expected error messages. If
1673
specified they must be seen in the error output of the command.
1675
out, err = self._run_bzr_autosplit(
1680
working_dir=working_dir,
1682
self.assertIsInstance(error_regexes, (list, tuple))
1683
for regex in error_regexes:
1684
self.assertContainsRe(err, regex)
1687
def run_bzr_error(self, error_regexes, *args, **kwargs):
1688
"""Run bzr, and check that stderr contains the supplied regexes
1690
:param error_regexes: Sequence of regular expressions which
1691
must each be found in the error output. The relative ordering
1693
:param args: command-line arguments for bzr
1694
:param kwargs: Keyword arguments which are interpreted by run_bzr
1695
This function changes the default value of retcode to be 3,
1696
since in most cases this is run when you expect bzr to fail.
1698
:return: (out, err) The actual output of running the command (in case
1699
you want to do more inspection)
1703
# Make sure that commit is failing because there is nothing to do
1704
self.run_bzr_error(['no changes to commit'],
1705
['commit', '-m', 'my commit comment'])
1706
# Make sure --strict is handling an unknown file, rather than
1707
# giving us the 'nothing to do' error
1708
self.build_tree(['unknown'])
1709
self.run_bzr_error(['Commit refused because there are unknown files'],
1710
['commit', --strict', '-m', 'my commit comment'])
1712
kwargs.setdefault('retcode', 3)
1713
kwargs['error_regexes'] = error_regexes
1714
out, err = self.run_bzr(*args, **kwargs)
1717
def run_bzr_subprocess(self, *args, **kwargs):
1718
"""Run bzr in a subprocess for testing.
1720
This starts a new Python interpreter and runs bzr in there.
1721
This should only be used for tests that have a justifiable need for
1722
this isolation: e.g. they are testing startup time, or signal
1723
handling, or early startup code, etc. Subprocess code can't be
1724
profiled or debugged so easily.
1726
:keyword retcode: The status code that is expected. Defaults to 0. If
1727
None is supplied, the status code is not checked.
1728
:keyword env_changes: A dictionary which lists changes to environment
1729
variables. A value of None will unset the env variable.
1730
The values must be strings. The change will only occur in the
1731
child, so you don't need to fix the environment after running.
1732
:keyword universal_newlines: Convert CRLF => LF
1733
:keyword allow_plugins: By default the subprocess is run with
1734
--no-plugins to ensure test reproducibility. Also, it is possible
1735
for system-wide plugins to create unexpected output on stderr,
1736
which can cause unnecessary test failures.
1738
env_changes = kwargs.get('env_changes', {})
1739
working_dir = kwargs.get('working_dir', None)
1740
allow_plugins = kwargs.get('allow_plugins', False)
1742
if isinstance(args[0], list):
1744
elif isinstance(args[0], basestring):
1745
args = list(shlex.split(args[0]))
1747
raise ValueError("passing varargs to run_bzr_subprocess")
1748
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1749
working_dir=working_dir,
1750
allow_plugins=allow_plugins)
1751
# We distinguish between retcode=None and retcode not passed.
1752
supplied_retcode = kwargs.get('retcode', 0)
1753
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1754
universal_newlines=kwargs.get('universal_newlines', False),
1757
def start_bzr_subprocess(self, process_args, env_changes=None,
1758
skip_if_plan_to_signal=False,
1760
allow_plugins=False):
1761
"""Start bzr in a subprocess for testing.
1763
This starts a new Python interpreter and runs bzr in there.
1764
This should only be used for tests that have a justifiable need for
1765
this isolation: e.g. they are testing startup time, or signal
1766
handling, or early startup code, etc. Subprocess code can't be
1767
profiled or debugged so easily.
1769
:param process_args: a list of arguments to pass to the bzr executable,
1770
for example ``['--version']``.
1771
:param env_changes: A dictionary which lists changes to environment
1772
variables. A value of None will unset the env variable.
1773
The values must be strings. The change will only occur in the
1774
child, so you don't need to fix the environment after running.
1775
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1777
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1779
:returns: Popen object for the started process.
1781
if skip_if_plan_to_signal:
1782
if not getattr(os, 'kill', None):
1783
raise TestSkipped("os.kill not available.")
1785
if env_changes is None:
1789
def cleanup_environment():
1790
for env_var, value in env_changes.iteritems():
1791
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1793
def restore_environment():
1794
for env_var, value in old_env.iteritems():
1795
osutils.set_or_unset_env(env_var, value)
1797
bzr_path = self.get_bzr_path()
1800
if working_dir is not None:
1801
cwd = osutils.getcwd()
1802
os.chdir(working_dir)
1805
# win32 subprocess doesn't support preexec_fn
1806
# so we will avoid using it on all platforms, just to
1807
# make sure the code path is used, and we don't break on win32
1808
cleanup_environment()
1809
command = [sys.executable]
1810
# frozen executables don't need the path to bzr
1811
if getattr(sys, "frozen", None) is None:
1812
command.append(bzr_path)
1813
if not allow_plugins:
1814
command.append('--no-plugins')
1815
command.extend(process_args)
1816
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1818
restore_environment()
1824
def _popen(self, *args, **kwargs):
1825
"""Place a call to Popen.
1827
Allows tests to override this method to intercept the calls made to
1828
Popen for introspection.
1830
return Popen(*args, **kwargs)
1832
def get_bzr_path(self):
1833
"""Return the path of the 'bzr' executable for this test suite."""
1834
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1835
if not os.path.isfile(bzr_path):
1836
# We are probably installed. Assume sys.argv is the right file
1837
bzr_path = sys.argv[0]
1840
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1841
universal_newlines=False, process_args=None):
1842
"""Finish the execution of process.
1844
:param process: the Popen object returned from start_bzr_subprocess.
1845
:param retcode: The status code that is expected. Defaults to 0. If
1846
None is supplied, the status code is not checked.
1847
:param send_signal: an optional signal to send to the process.
1848
:param universal_newlines: Convert CRLF => LF
1849
:returns: (stdout, stderr)
1851
if send_signal is not None:
1852
os.kill(process.pid, send_signal)
1853
out, err = process.communicate()
1855
if universal_newlines:
1856
out = out.replace('\r\n', '\n')
1857
err = err.replace('\r\n', '\n')
1859
if retcode is not None and retcode != process.returncode:
1860
if process_args is None:
1861
process_args = "(unknown args)"
1862
mutter('Output of bzr %s:\n%s', process_args, out)
1863
mutter('Error for bzr %s:\n%s', process_args, err)
1864
self.fail('Command bzr %s failed with retcode %s != %s'
1865
% (process_args, retcode, process.returncode))
1868
def check_inventory_shape(self, inv, shape):
1869
"""Compare an inventory to a list of expected names.
1871
Fail if they are not precisely equal.
1874
shape = list(shape) # copy
1875
for path, ie in inv.entries():
1876
name = path.replace('\\', '/')
1877
if ie.kind == 'directory':
1884
self.fail("expected paths not found in inventory: %r" % shape)
1886
self.fail("unexpected paths found in inventory: %r" % extras)
1888
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1889
a_callable=None, *args, **kwargs):
1890
"""Call callable with redirected std io pipes.
1892
Returns the return code."""
1893
if not callable(a_callable):
1894
raise ValueError("a_callable must be callable.")
1896
stdin = StringIO("")
1898
if getattr(self, "_log_file", None) is not None:
1899
stdout = self._log_file
1903
if getattr(self, "_log_file", None is not None):
1904
stderr = self._log_file
1907
real_stdin = sys.stdin
1908
real_stdout = sys.stdout
1909
real_stderr = sys.stderr
1914
return a_callable(*args, **kwargs)
1916
sys.stdout = real_stdout
1917
sys.stderr = real_stderr
1918
sys.stdin = real_stdin
1920
def reduceLockdirTimeout(self):
1921
"""Reduce the default lock timeout for the duration of the test, so that
1922
if LockContention occurs during a test, it does so quickly.
1924
Tests that expect to provoke LockContention errors should call this.
1926
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1928
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1929
self.addCleanup(resetTimeout)
1930
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1932
def make_utf8_encoded_stringio(self, encoding_type=None):
1933
"""Return a StringIOWrapper instance, that will encode Unicode
1936
if encoding_type is None:
1937
encoding_type = 'strict'
1939
output_encoding = 'utf-8'
1940
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1941
sio.encoding = output_encoding
1945
class CapturedCall(object):
1946
"""A helper for capturing smart server calls for easy debug analysis."""
1948
def __init__(self, params, prefix_length):
1949
"""Capture the call with params and skip prefix_length stack frames."""
1952
# The last 5 frames are the __init__, the hook frame, and 3 smart
1953
# client frames. Beyond this we could get more clever, but this is good
1955
stack = traceback.extract_stack()[prefix_length:-5]
1956
self.stack = ''.join(traceback.format_list(stack))
1959
return self.call.method
1962
return self.call.method
1968
class TestCaseWithMemoryTransport(TestCase):
1969
"""Common test class for tests that do not need disk resources.
1971
Tests that need disk resources should derive from TestCaseWithTransport.
1973
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1975
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1976
a directory which does not exist. This serves to help ensure test isolation
1977
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1978
must exist. However, TestCaseWithMemoryTransport does not offer local
1979
file defaults for the transport in tests, nor does it obey the command line
1980
override, so tests that accidentally write to the common directory should
1983
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1984
a .bzr directory that stops us ascending higher into the filesystem.
1990
def __init__(self, methodName='runTest'):
1991
# allow test parameterization after test construction and before test
1992
# execution. Variables that the parameterizer sets need to be
1993
# ones that are not set by setUp, or setUp will trash them.
1994
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1995
self.vfs_transport_factory = default_transport
1996
self.transport_server = None
1997
self.transport_readonly_server = None
1998
self.__vfs_server = None
2000
def get_transport(self, relpath=None):
2001
"""Return a writeable transport.
2003
This transport is for the test scratch space relative to
2006
:param relpath: a path relative to the base url.
2008
t = get_transport(self.get_url(relpath))
2009
self.assertFalse(t.is_readonly())
2012
def get_readonly_transport(self, relpath=None):
2013
"""Return a readonly transport for the test scratch space
2015
This can be used to test that operations which should only need
2016
readonly access in fact do not try to write.
2018
:param relpath: a path relative to the base url.
2020
t = get_transport(self.get_readonly_url(relpath))
2021
self.assertTrue(t.is_readonly())
2024
def create_transport_readonly_server(self):
2025
"""Create a transport server from class defined at init.
2027
This is mostly a hook for daughter classes.
2029
return self.transport_readonly_server()
2031
def get_readonly_server(self):
2032
"""Get the server instance for the readonly transport
2034
This is useful for some tests with specific servers to do diagnostics.
2036
if self.__readonly_server is None:
2037
if self.transport_readonly_server is None:
2038
# readonly decorator requested
2039
# bring up the server
2040
self.__readonly_server = ReadonlyServer()
2041
self.__readonly_server.setUp(self.get_vfs_only_server())
2043
self.__readonly_server = self.create_transport_readonly_server()
2044
self.__readonly_server.setUp(self.get_vfs_only_server())
2045
self.addCleanup(self.__readonly_server.tearDown)
2046
return self.__readonly_server
2048
def get_readonly_url(self, relpath=None):
2049
"""Get a URL for the readonly transport.
2051
This will either be backed by '.' or a decorator to the transport
2052
used by self.get_url()
2053
relpath provides for clients to get a path relative to the base url.
2054
These should only be downwards relative, not upwards.
2056
base = self.get_readonly_server().get_url()
2057
return self._adjust_url(base, relpath)
2059
def get_vfs_only_server(self):
2060
"""Get the vfs only read/write server instance.
2062
This is useful for some tests with specific servers that need
2065
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2066
is no means to override it.
2068
if self.__vfs_server is None:
2069
self.__vfs_server = MemoryServer()
2070
self.__vfs_server.setUp()
2071
self.addCleanup(self.__vfs_server.tearDown)
2072
return self.__vfs_server
2074
def get_server(self):
2075
"""Get the read/write server instance.
2077
This is useful for some tests with specific servers that need
2080
This is built from the self.transport_server factory. If that is None,
2081
then the self.get_vfs_server is returned.
2083
if self.__server is None:
2084
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
2085
return self.get_vfs_only_server()
2087
# bring up a decorated means of access to the vfs only server.
2088
self.__server = self.transport_server()
2090
self.__server.setUp(self.get_vfs_only_server())
2091
except TypeError, e:
2092
# This should never happen; the try:Except here is to assist
2093
# developers having to update code rather than seeing an
2094
# uninformative TypeError.
2095
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2096
self.addCleanup(self.__server.tearDown)
2097
return self.__server
2099
def _adjust_url(self, base, relpath):
2100
"""Get a URL (or maybe a path) for the readwrite transport.
2102
This will either be backed by '.' or to an equivalent non-file based
2104
relpath provides for clients to get a path relative to the base url.
2105
These should only be downwards relative, not upwards.
2107
if relpath is not None and relpath != '.':
2108
if not base.endswith('/'):
2110
# XXX: Really base should be a url; we did after all call
2111
# get_url()! But sometimes it's just a path (from
2112
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2113
# to a non-escaped local path.
2114
if base.startswith('./') or base.startswith('/'):
2117
base += urlutils.escape(relpath)
2120
def get_url(self, relpath=None):
2121
"""Get a URL (or maybe a path) for the readwrite transport.
2123
This will either be backed by '.' or to an equivalent non-file based
2125
relpath provides for clients to get a path relative to the base url.
2126
These should only be downwards relative, not upwards.
2128
base = self.get_server().get_url()
2129
return self._adjust_url(base, relpath)
2131
def get_vfs_only_url(self, relpath=None):
2132
"""Get a URL (or maybe a path for the plain old vfs transport.
2134
This will never be a smart protocol. It always has all the
2135
capabilities of the local filesystem, but it might actually be a
2136
MemoryTransport or some other similar virtual filesystem.
2138
This is the backing transport (if any) of the server returned by
2139
get_url and get_readonly_url.
2141
:param relpath: provides for clients to get a path relative to the base
2142
url. These should only be downwards relative, not upwards.
2145
base = self.get_vfs_only_server().get_url()
2146
return self._adjust_url(base, relpath)
2148
def _create_safety_net(self):
2149
"""Make a fake bzr directory.
2151
This prevents any tests propagating up onto the TEST_ROOT directory's
2154
root = TestCaseWithMemoryTransport.TEST_ROOT
2155
bzrdir.BzrDir.create_standalone_workingtree(root)
2157
def _check_safety_net(self):
2158
"""Check that the safety .bzr directory have not been touched.
2160
_make_test_root have created a .bzr directory to prevent tests from
2161
propagating. This method ensures than a test did not leaked.
2163
root = TestCaseWithMemoryTransport.TEST_ROOT
2164
wt = workingtree.WorkingTree.open(root)
2165
last_rev = wt.last_revision()
2166
if last_rev != 'null:':
2167
# The current test have modified the /bzr directory, we need to
2168
# recreate a new one or all the followng tests will fail.
2169
# If you need to inspect its content uncomment the following line
2170
# import pdb; pdb.set_trace()
2171
_rmtree_temp_dir(root + '/.bzr')
2172
self._create_safety_net()
2173
raise AssertionError('%s/.bzr should not be modified' % root)
2175
def _make_test_root(self):
2176
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2177
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2178
TestCaseWithMemoryTransport.TEST_ROOT = root
2180
self._create_safety_net()
2182
# The same directory is used by all tests, and we're not
2183
# specifically told when all tests are finished. This will do.
2184
atexit.register(_rmtree_temp_dir, root)
2186
self.addCleanup(self._check_safety_net)
2188
def makeAndChdirToTestDir(self):
2189
"""Create a temporary directories for this one test.
2191
This must set self.test_home_dir and self.test_dir and chdir to
2194
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2196
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2197
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2198
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2200
def make_branch(self, relpath, format=None):
2201
"""Create a branch on the transport at relpath."""
2202
repo = self.make_repository(relpath, format=format)
2203
return repo.bzrdir.create_branch()
2205
def make_bzrdir(self, relpath, format=None):
2207
# might be a relative or absolute path
2208
maybe_a_url = self.get_url(relpath)
2209
segments = maybe_a_url.rsplit('/', 1)
2210
t = get_transport(maybe_a_url)
2211
if len(segments) > 1 and segments[-1] not in ('', '.'):
2215
if isinstance(format, basestring):
2216
format = bzrdir.format_registry.make_bzrdir(format)
2217
return format.initialize_on_transport(t)
2218
except errors.UninitializableFormat:
2219
raise TestSkipped("Format %s is not initializable." % format)
2221
def make_repository(self, relpath, shared=False, format=None):
2222
"""Create a repository on our default transport at relpath.
2224
Note that relpath must be a relative path, not a full url.
2226
# FIXME: If you create a remoterepository this returns the underlying
2227
# real format, which is incorrect. Actually we should make sure that
2228
# RemoteBzrDir returns a RemoteRepository.
2229
# maybe mbp 20070410
2230
made_control = self.make_bzrdir(relpath, format=format)
2231
return made_control.create_repository(shared=shared)
2233
def make_smart_server(self, path):
2234
smart_server = server.SmartTCPServer_for_testing()
2235
smart_server.setUp(self.get_server())
2236
remote_transport = get_transport(smart_server.get_url()).clone(path)
2237
self.addCleanup(smart_server.tearDown)
2238
return remote_transport
2240
def make_branch_and_memory_tree(self, relpath, format=None):
2241
"""Create a branch on the default transport and a MemoryTree for it."""
2242
b = self.make_branch(relpath, format=format)
2243
return memorytree.MemoryTree.create_on_branch(b)
2245
def make_branch_builder(self, relpath, format=None):
2246
branch = self.make_branch(relpath, format=format)
2247
return branchbuilder.BranchBuilder(branch=branch)
2249
def overrideEnvironmentForTesting(self):
2250
os.environ['HOME'] = self.test_home_dir
2251
os.environ['BZR_HOME'] = self.test_home_dir
2254
super(TestCaseWithMemoryTransport, self).setUp()
2255
self._make_test_root()
2256
_currentdir = os.getcwdu()
2257
def _leaveDirectory():
2258
os.chdir(_currentdir)
2259
self.addCleanup(_leaveDirectory)
2260
self.makeAndChdirToTestDir()
2261
self.overrideEnvironmentForTesting()
2262
self.__readonly_server = None
2263
self.__server = None
2264
self.reduceLockdirTimeout()
2266
def setup_smart_server_with_call_log(self):
2267
"""Sets up a smart server as the transport server with a call log."""
2268
self.transport_server = server.SmartTCPServer_for_testing
2269
self.hpss_calls = []
2271
# Skip the current stack down to the caller of
2272
# setup_smart_server_with_call_log
2273
prefix_length = len(traceback.extract_stack()) - 2
2274
def capture_hpss_call(params):
2275
self.hpss_calls.append(
2276
CapturedCall(params, prefix_length))
2277
client._SmartClient.hooks.install_named_hook(
2278
'call', capture_hpss_call, None)
2280
def reset_smart_call_log(self):
2281
self.hpss_calls = []
2284
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2285
"""Derived class that runs a test within a temporary directory.
2287
This is useful for tests that need to create a branch, etc.
2289
The directory is created in a slightly complex way: for each
2290
Python invocation, a new temporary top-level directory is created.
2291
All test cases create their own directory within that. If the
2292
tests complete successfully, the directory is removed.
2294
:ivar test_base_dir: The path of the top-level directory for this
2295
test, which contains a home directory and a work directory.
2297
:ivar test_home_dir: An initially empty directory under test_base_dir
2298
which is used as $HOME for this test.
2300
:ivar test_dir: A directory under test_base_dir used as the current
2301
directory when the test proper is run.
2304
OVERRIDE_PYTHON = 'python'
2306
def check_file_contents(self, filename, expect):
2307
self.log("check contents of file %s" % filename)
2308
contents = file(filename, 'r').read()
2309
if contents != expect:
2310
self.log("expected: %r" % expect)
2311
self.log("actually: %r" % contents)
2312
self.fail("contents of %s not as expected" % filename)
2314
def _getTestDirPrefix(self):
2315
# create a directory within the top level test directory
2316
if sys.platform == 'win32':
2317
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2318
# windows is likely to have path-length limits so use a short name
2319
name_prefix = name_prefix[-30:]
2321
name_prefix = re.sub('[/]', '_', self.id())
2324
def makeAndChdirToTestDir(self):
2325
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2327
For TestCaseInTempDir we create a temporary directory based on the test
2328
name and then create two subdirs - test and home under it.
2330
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2331
self._getTestDirPrefix())
2333
for i in range(100):
2334
if os.path.exists(name):
2335
name = name_prefix + '_' + str(i)
2339
# now create test and home directories within this dir
2340
self.test_base_dir = name
2341
self.test_home_dir = self.test_base_dir + '/home'
2342
os.mkdir(self.test_home_dir)
2343
self.test_dir = self.test_base_dir + '/work'
2344
os.mkdir(self.test_dir)
2345
os.chdir(self.test_dir)
2346
# put name of test inside
2347
f = file(self.test_base_dir + '/name', 'w')
2352
self.addCleanup(self.deleteTestDir)
2354
def deleteTestDir(self):
2355
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2356
_rmtree_temp_dir(self.test_base_dir)
2358
def build_tree(self, shape, line_endings='binary', transport=None):
2359
"""Build a test tree according to a pattern.
2361
shape is a sequence of file specifications. If the final
2362
character is '/', a directory is created.
2364
This assumes that all the elements in the tree being built are new.
2366
This doesn't add anything to a branch.
2368
:type shape: list or tuple.
2369
:param line_endings: Either 'binary' or 'native'
2370
in binary mode, exact contents are written in native mode, the
2371
line endings match the default platform endings.
2372
:param transport: A transport to write to, for building trees on VFS's.
2373
If the transport is readonly or None, "." is opened automatically.
2376
if type(shape) not in (list, tuple):
2377
raise AssertionError("Parameter 'shape' should be "
2378
"a list or a tuple. Got %r instead" % (shape,))
2379
# It's OK to just create them using forward slashes on windows.
2380
if transport is None or transport.is_readonly():
2381
transport = get_transport(".")
2383
self.assertIsInstance(name, basestring)
2385
transport.mkdir(urlutils.escape(name[:-1]))
2387
if line_endings == 'binary':
2389
elif line_endings == 'native':
2392
raise errors.BzrError(
2393
'Invalid line ending request %r' % line_endings)
2394
content = "contents of %s%s" % (name.encode('utf-8'), end)
2395
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2397
def build_tree_contents(self, shape):
2398
build_tree_contents(shape)
2400
def assertInWorkingTree(self, path, root_path='.', tree=None):
2401
"""Assert whether path or paths are in the WorkingTree"""
2403
tree = workingtree.WorkingTree.open(root_path)
2404
if not isinstance(path, basestring):
2406
self.assertInWorkingTree(p, tree=tree)
2408
self.assertIsNot(tree.path2id(path), None,
2409
path+' not in working tree.')
2411
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2412
"""Assert whether path or paths are not in the WorkingTree"""
2414
tree = workingtree.WorkingTree.open(root_path)
2415
if not isinstance(path, basestring):
2417
self.assertNotInWorkingTree(p,tree=tree)
2419
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2422
class TestCaseWithTransport(TestCaseInTempDir):
2423
"""A test case that provides get_url and get_readonly_url facilities.
2425
These back onto two transport servers, one for readonly access and one for
2428
If no explicit class is provided for readonly access, a
2429
ReadonlyTransportDecorator is used instead which allows the use of non disk
2430
based read write transports.
2432
If an explicit class is provided for readonly access, that server and the
2433
readwrite one must both define get_url() as resolving to os.getcwd().
2436
def get_vfs_only_server(self):
2437
"""See TestCaseWithMemoryTransport.
2439
This is useful for some tests with specific servers that need
2442
if self.__vfs_server is None:
2443
self.__vfs_server = self.vfs_transport_factory()
2444
self.__vfs_server.setUp()
2445
self.addCleanup(self.__vfs_server.tearDown)
2446
return self.__vfs_server
2448
def make_branch_and_tree(self, relpath, format=None):
2449
"""Create a branch on the transport and a tree locally.
2451
If the transport is not a LocalTransport, the Tree can't be created on
2452
the transport. In that case if the vfs_transport_factory is
2453
LocalURLServer the working tree is created in the local
2454
directory backing the transport, and the returned tree's branch and
2455
repository will also be accessed locally. Otherwise a lightweight
2456
checkout is created and returned.
2458
:param format: The BzrDirFormat.
2459
:returns: the WorkingTree.
2461
# TODO: always use the local disk path for the working tree,
2462
# this obviously requires a format that supports branch references
2463
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2465
b = self.make_branch(relpath, format=format)
2467
return b.bzrdir.create_workingtree()
2468
except errors.NotLocalUrl:
2469
# We can only make working trees locally at the moment. If the
2470
# transport can't support them, then we keep the non-disk-backed
2471
# branch and create a local checkout.
2472
if self.vfs_transport_factory is LocalURLServer:
2473
# the branch is colocated on disk, we cannot create a checkout.
2474
# hopefully callers will expect this.
2475
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2476
wt = local_controldir.create_workingtree()
2477
if wt.branch._format != b._format:
2479
# Make sure that assigning to wt._branch fixes wt.branch,
2480
# in case the implementation details of workingtree objects
2482
self.assertIs(b, wt.branch)
2485
return b.create_checkout(relpath, lightweight=True)
2487
def assertIsDirectory(self, relpath, transport):
2488
"""Assert that relpath within transport is a directory.
2490
This may not be possible on all transports; in that case it propagates
2491
a TransportNotPossible.
2494
mode = transport.stat(relpath).st_mode
2495
except errors.NoSuchFile:
2496
self.fail("path %s is not a directory; no such file"
2498
if not stat.S_ISDIR(mode):
2499
self.fail("path %s is not a directory; has mode %#o"
2502
def assertTreesEqual(self, left, right):
2503
"""Check that left and right have the same content and properties."""
2504
# we use a tree delta to check for equality of the content, and we
2505
# manually check for equality of other things such as the parents list.
2506
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2507
differences = left.changes_from(right)
2508
self.assertFalse(differences.has_changed(),
2509
"Trees %r and %r are different: %r" % (left, right, differences))
2512
super(TestCaseWithTransport, self).setUp()
2513
self.__vfs_server = None
2516
class ChrootedTestCase(TestCaseWithTransport):
2517
"""A support class that provides readonly urls outside the local namespace.
2519
This is done by checking if self.transport_server is a MemoryServer. if it
2520
is then we are chrooted already, if it is not then an HttpServer is used
2523
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2524
be used without needed to redo it when a different
2525
subclass is in use ?
2529
super(ChrootedTestCase, self).setUp()
2530
if not self.vfs_transport_factory == MemoryServer:
2531
self.transport_readonly_server = HttpServer
2534
def condition_id_re(pattern):
2535
"""Create a condition filter which performs a re check on a test's id.
2537
:param pattern: A regular expression string.
2538
:return: A callable that returns True if the re matches.
2540
filter_re = osutils.re_compile_checked(pattern, 0,
2542
def condition(test):
2544
return filter_re.search(test_id)
2548
def condition_isinstance(klass_or_klass_list):
2549
"""Create a condition filter which returns isinstance(param, klass).
2551
:return: A callable which when called with one parameter obj return the
2552
result of isinstance(obj, klass_or_klass_list).
2555
return isinstance(obj, klass_or_klass_list)
2559
def condition_id_in_list(id_list):
2560
"""Create a condition filter which verify that test's id in a list.
2562
:param id_list: A TestIdList object.
2563
:return: A callable that returns True if the test's id appears in the list.
2565
def condition(test):
2566
return id_list.includes(test.id())
2570
def condition_id_startswith(starts):
2571
"""Create a condition filter verifying that test's id starts with a string.
2573
:param starts: A list of string.
2574
:return: A callable that returns True if the test's id starts with one of
2577
def condition(test):
2578
for start in starts:
2579
if test.id().startswith(start):
2585
def exclude_tests_by_condition(suite, condition):
2586
"""Create a test suite which excludes some tests from suite.
2588
:param suite: The suite to get tests from.
2589
:param condition: A callable whose result evaluates True when called with a
2590
test case which should be excluded from the result.
2591
:return: A suite which contains the tests found in suite that fail
2595
for test in iter_suite_tests(suite):
2596
if not condition(test):
2598
return TestUtil.TestSuite(result)
2601
def filter_suite_by_condition(suite, condition):
2602
"""Create a test suite by filtering another one.
2604
:param suite: The source suite.
2605
:param condition: A callable whose result evaluates True when called with a
2606
test case which should be included in the result.
2607
:return: A suite which contains the tests found in suite that pass
2611
for test in iter_suite_tests(suite):
2614
return TestUtil.TestSuite(result)
2617
def filter_suite_by_re(suite, pattern):
2618
"""Create a test suite by filtering another one.
2620
:param suite: the source suite
2621
:param pattern: pattern that names must match
2622
:returns: the newly created suite
2624
condition = condition_id_re(pattern)
2625
result_suite = filter_suite_by_condition(suite, condition)
2629
def filter_suite_by_id_list(suite, test_id_list):
2630
"""Create a test suite by filtering another one.
2632
:param suite: The source suite.
2633
:param test_id_list: A list of the test ids to keep as strings.
2634
:returns: the newly created suite
2636
condition = condition_id_in_list(test_id_list)
2637
result_suite = filter_suite_by_condition(suite, condition)
2641
def filter_suite_by_id_startswith(suite, start):
2642
"""Create a test suite by filtering another one.
2644
:param suite: The source suite.
2645
:param start: A list of string the test id must start with one of.
2646
:returns: the newly created suite
2648
condition = condition_id_startswith(start)
2649
result_suite = filter_suite_by_condition(suite, condition)
2653
def exclude_tests_by_re(suite, pattern):
2654
"""Create a test suite which excludes some tests from suite.
2656
:param suite: The suite to get tests from.
2657
:param pattern: A regular expression string. Test ids that match this
2658
pattern will be excluded from the result.
2659
:return: A TestSuite that contains all the tests from suite without the
2660
tests that matched pattern. The order of tests is the same as it was in
2663
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2666
def preserve_input(something):
2667
"""A helper for performing test suite transformation chains.
2669
:param something: Anything you want to preserve.
2675
def randomize_suite(suite):
2676
"""Return a new TestSuite with suite's tests in random order.
2678
The tests in the input suite are flattened into a single suite in order to
2679
accomplish this. Any nested TestSuites are removed to provide global
2682
tests = list(iter_suite_tests(suite))
2683
random.shuffle(tests)
2684
return TestUtil.TestSuite(tests)
2687
def split_suite_by_condition(suite, condition):
2688
"""Split a test suite into two by a condition.
2690
:param suite: The suite to split.
2691
:param condition: The condition to match on. Tests that match this
2692
condition are returned in the first test suite, ones that do not match
2693
are in the second suite.
2694
:return: A tuple of two test suites, where the first contains tests from
2695
suite matching the condition, and the second contains the remainder
2696
from suite. The order within each output suite is the same as it was in
2701
for test in iter_suite_tests(suite):
2703
matched.append(test)
2705
did_not_match.append(test)
2706
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2709
def split_suite_by_re(suite, pattern):
2710
"""Split a test suite into two by a regular expression.
2712
:param suite: The suite to split.
2713
:param pattern: A regular expression string. Test ids that match this
2714
pattern will be in the first test suite returned, and the others in the
2715
second test suite returned.
2716
:return: A tuple of two test suites, where the first contains tests from
2717
suite matching pattern, and the second contains the remainder from
2718
suite. The order within each output suite is the same as it was in
2721
return split_suite_by_condition(suite, condition_id_re(pattern))
2724
def run_suite(suite, name='test', verbose=False, pattern=".*",
2725
stop_on_failure=False,
2726
transport=None, lsprof_timed=None, bench_history=None,
2727
matching_tests_first=None,
2730
exclude_pattern=None,
2733
suite_decorators=None,
2735
"""Run a test suite for bzr selftest.
2737
:param runner_class: The class of runner to use. Must support the
2738
constructor arguments passed by run_suite which are more than standard
2740
:return: A boolean indicating success.
2742
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2747
if runner_class is None:
2748
runner_class = TextTestRunner
2751
runner = runner_class(stream=stream,
2753
verbosity=verbosity,
2754
bench_history=bench_history,
2755
list_only=list_only,
2758
runner.stop_on_failure=stop_on_failure
2759
# built in decorator factories:
2761
random_order(random_seed, runner),
2762
exclude_tests(exclude_pattern),
2764
if matching_tests_first:
2765
decorators.append(tests_first(pattern))
2767
decorators.append(filter_tests(pattern))
2768
if suite_decorators:
2769
decorators.extend(suite_decorators)
2770
# tell the result object how many tests will be running:
2771
decorators.append(CountingDecorator)
2772
for decorator in decorators:
2773
suite = decorator(suite)
2774
result = runner.run(suite)
2779
return result.wasStrictlySuccessful()
2781
return result.wasSuccessful()
2784
# A registry where get() returns a suite decorator.
2785
parallel_registry = registry.Registry()
2788
def fork_decorator(suite):
2789
concurrency = osutils.local_concurrency()
2790
if concurrency == 1:
2792
from testtools import ConcurrentTestSuite
2793
return ConcurrentTestSuite(suite, fork_for_tests)
2794
parallel_registry.register('fork', fork_decorator)
2797
def subprocess_decorator(suite):
2798
concurrency = osutils.local_concurrency()
2799
if concurrency == 1:
2801
from testtools import ConcurrentTestSuite
2802
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2803
parallel_registry.register('subprocess', subprocess_decorator)
2806
def exclude_tests(exclude_pattern):
2807
"""Return a test suite decorator that excludes tests."""
2808
if exclude_pattern is None:
2809
return identity_decorator
2810
def decorator(suite):
2811
return ExcludeDecorator(suite, exclude_pattern)
2815
def filter_tests(pattern):
2817
return identity_decorator
2818
def decorator(suite):
2819
return FilterTestsDecorator(suite, pattern)
2823
def random_order(random_seed, runner):
2824
"""Return a test suite decorator factory for randomising tests order.
2826
:param random_seed: now, a string which casts to a long, or a long.
2827
:param runner: A test runner with a stream attribute to report on.
2829
if random_seed is None:
2830
return identity_decorator
2831
def decorator(suite):
2832
return RandomDecorator(suite, random_seed, runner.stream)
2836
def tests_first(pattern):
2838
return identity_decorator
2839
def decorator(suite):
2840
return TestFirstDecorator(suite, pattern)
2844
def identity_decorator(suite):
2849
class TestDecorator(TestSuite):
2850
"""A decorator for TestCase/TestSuite objects.
2852
Usually, subclasses should override __iter__(used when flattening test
2853
suites), which we do to filter, reorder, parallelise and so on, run() and
2857
def __init__(self, suite):
2858
TestSuite.__init__(self)
2861
def countTestCases(self):
2864
cases += test.countTestCases()
2871
def run(self, result):
2872
# Use iteration on self, not self._tests, to allow subclasses to hook
2875
if result.shouldStop:
2881
class CountingDecorator(TestDecorator):
2882
"""A decorator which calls result.progress(self.countTestCases)."""
2884
def run(self, result):
2885
progress_method = getattr(result, 'progress', None)
2886
if callable(progress_method):
2887
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
2888
return super(CountingDecorator, self).run(result)
2891
class ExcludeDecorator(TestDecorator):
2892
"""A decorator which excludes test matching an exclude pattern."""
2894
def __init__(self, suite, exclude_pattern):
2895
TestDecorator.__init__(self, suite)
2896
self.exclude_pattern = exclude_pattern
2897
self.excluded = False
2901
return iter(self._tests)
2902
self.excluded = True
2903
suite = exclude_tests_by_re(self, self.exclude_pattern)
2905
self.addTests(suite)
2906
return iter(self._tests)
2909
class FilterTestsDecorator(TestDecorator):
2910
"""A decorator which filters tests to those matching a pattern."""
2912
def __init__(self, suite, pattern):
2913
TestDecorator.__init__(self, suite)
2914
self.pattern = pattern
2915
self.filtered = False
2919
return iter(self._tests)
2920
self.filtered = True
2921
suite = filter_suite_by_re(self, self.pattern)
2923
self.addTests(suite)
2924
return iter(self._tests)
2927
class RandomDecorator(TestDecorator):
2928
"""A decorator which randomises the order of its tests."""
2930
def __init__(self, suite, random_seed, stream):
2931
TestDecorator.__init__(self, suite)
2932
self.random_seed = random_seed
2933
self.randomised = False
2934
self.stream = stream
2938
return iter(self._tests)
2939
self.randomised = True
2940
self.stream.writeln("Randomizing test order using seed %s\n" %
2941
(self.actual_seed()))
2942
# Initialise the random number generator.
2943
random.seed(self.actual_seed())
2944
suite = randomize_suite(self)
2946
self.addTests(suite)
2947
return iter(self._tests)
2949
def actual_seed(self):
2950
if self.random_seed == "now":
2951
# We convert the seed to a long to make it reuseable across
2952
# invocations (because the user can reenter it).
2953
self.random_seed = long(time.time())
2955
# Convert the seed to a long if we can
2957
self.random_seed = long(self.random_seed)
2960
return self.random_seed
2963
class TestFirstDecorator(TestDecorator):
2964
"""A decorator which moves named tests to the front."""
2966
def __init__(self, suite, pattern):
2967
TestDecorator.__init__(self, suite)
2968
self.pattern = pattern
2969
self.filtered = False
2973
return iter(self._tests)
2974
self.filtered = True
2975
suites = split_suite_by_re(self, self.pattern)
2977
self.addTests(suites)
2978
return iter(self._tests)
2981
def partition_tests(suite, count):
2982
"""Partition suite into count lists of tests."""
2984
tests = list(iter_suite_tests(suite))
2985
tests_per_process = int(math.ceil(float(len(tests)) / count))
2986
for block in range(count):
2987
low_test = block * tests_per_process
2988
high_test = low_test + tests_per_process
2989
process_tests = tests[low_test:high_test]
2990
result.append(process_tests)
2994
def fork_for_tests(suite):
2995
"""Take suite and start up one runner per CPU by forking()
2997
:return: An iterable of TestCase-like objects which can each have
2998
run(result) called on them to feed tests to result.
3000
concurrency = osutils.local_concurrency()
3002
from subunit import TestProtocolClient, ProtocolTestCase
3004
from subunit.test_results import AutoTimingTestResultDecorator
3006
AutoTimingTestResultDecorator = lambda x:x
3007
class TestInOtherProcess(ProtocolTestCase):
3008
# Should be in subunit, I think. RBC.
3009
def __init__(self, stream, pid):
3010
ProtocolTestCase.__init__(self, stream)
3013
def run(self, result):
3015
ProtocolTestCase.run(self, result)
3017
os.waitpid(self.pid, os.WNOHANG)
3019
test_blocks = partition_tests(suite, concurrency)
3020
for process_tests in test_blocks:
3021
process_suite = TestSuite()
3022
process_suite.addTests(process_tests)
3023
c2pread, c2pwrite = os.pipe()
3028
# Leave stderr and stdout open so we can see test noise
3029
# Close stdin so that the child goes away if it decides to
3030
# read from stdin (otherwise its a roulette to see what
3031
# child actually gets keystrokes for pdb etc).
3034
stream = os.fdopen(c2pwrite, 'wb', 1)
3035
subunit_result = AutoTimingTestResultDecorator(
3036
TestProtocolClient(stream))
3037
process_suite.run(subunit_result)
3042
stream = os.fdopen(c2pread, 'rb', 1)
3043
test = TestInOtherProcess(stream, pid)
3048
def reinvoke_for_tests(suite):
3049
"""Take suite and start up one runner per CPU using subprocess().
3051
:return: An iterable of TestCase-like objects which can each have
3052
run(result) called on them to feed tests to result.
3054
concurrency = osutils.local_concurrency()
3056
from subunit import ProtocolTestCase
3057
class TestInSubprocess(ProtocolTestCase):
3058
def __init__(self, process, name):
3059
ProtocolTestCase.__init__(self, process.stdout)
3060
self.process = process
3061
self.process.stdin.close()
3064
def run(self, result):
3066
ProtocolTestCase.run(self, result)
3069
os.unlink(self.name)
3070
# print "pid %d finished" % finished_process
3071
test_blocks = partition_tests(suite, concurrency)
3072
for process_tests in test_blocks:
3073
# ugly; currently reimplement rather than reuses TestCase methods.
3074
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3075
if not os.path.isfile(bzr_path):
3076
# We are probably installed. Assume sys.argv is the right file
3077
bzr_path = sys.argv[0]
3078
fd, test_list_file_name = tempfile.mkstemp()
3079
test_list_file = os.fdopen(fd, 'wb', 1)
3080
for test in process_tests:
3081
test_list_file.write(test.id() + '\n')
3082
test_list_file.close()
3084
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3086
if '--no-plugins' in sys.argv:
3087
argv.append('--no-plugins')
3088
# stderr=STDOUT would be ideal, but until we prevent noise on
3089
# stderr it can interrupt the subunit protocol.
3090
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3092
test = TestInSubprocess(process, test_list_file_name)
3095
os.unlink(test_list_file_name)
3100
class BZRTransformingResult(unittest.TestResult):
3102
def __init__(self, target):
3103
unittest.TestResult.__init__(self)
3104
self.result = target
3106
def startTest(self, test):
3107
self.result.startTest(test)
3109
def stopTest(self, test):
3110
self.result.stopTest(test)
3112
def addError(self, test, err):
3113
feature = self._error_looks_like('UnavailableFeature: ', err)
3114
if feature is not None:
3115
self.result.addNotSupported(test, feature)
3117
self.result.addError(test, err)
3119
def addFailure(self, test, err):
3120
known = self._error_looks_like('KnownFailure: ', err)
3121
if known is not None:
3122
self.result._addKnownFailure(test, [KnownFailure,
3123
KnownFailure(known), None])
3125
self.result.addFailure(test, err)
3127
def addSkip(self, test, reason):
3128
self.result.addSkip(test, reason)
3130
def addSuccess(self, test):
3131
self.result.addSuccess(test)
3133
def _error_looks_like(self, prefix, err):
3134
"""Deserialize exception and returns the stringify value."""
3138
if isinstance(exc, subunit.RemoteException):
3139
# stringify the exception gives access to the remote traceback
3140
# We search the last line for 'prefix'
3141
lines = str(exc).split('\n')
3142
while lines and not lines[-1]:
3145
if lines[-1].startswith(prefix):
3146
value = lines[-1][len(prefix):]
3150
# Controlled by "bzr selftest -E=..." option
3151
selftest_debug_flags = set()
3154
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3156
test_suite_factory=None,
3159
matching_tests_first=None,
3162
exclude_pattern=None,
3168
suite_decorators=None,
3170
"""Run the whole test suite under the enhanced runner"""
3171
# XXX: Very ugly way to do this...
3172
# Disable warning about old formats because we don't want it to disturb
3173
# any blackbox tests.
3174
from bzrlib import repository
3175
repository._deprecation_warning_done = True
3177
global default_transport
3178
if transport is None:
3179
transport = default_transport
3180
old_transport = default_transport
3181
default_transport = transport
3182
global selftest_debug_flags
3183
old_debug_flags = selftest_debug_flags
3184
if debug_flags is not None:
3185
selftest_debug_flags = set(debug_flags)
3187
if load_list is None:
3190
keep_only = load_test_id_list(load_list)
3191
if test_suite_factory is None:
3192
suite = test_suite(keep_only, starting_with)
3194
suite = test_suite_factory()
3195
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3196
stop_on_failure=stop_on_failure,
3197
transport=transport,
3198
lsprof_timed=lsprof_timed,
3199
bench_history=bench_history,
3200
matching_tests_first=matching_tests_first,
3201
list_only=list_only,
3202
random_seed=random_seed,
3203
exclude_pattern=exclude_pattern,
3205
runner_class=runner_class,
3206
suite_decorators=suite_decorators,
3209
default_transport = old_transport
3210
selftest_debug_flags = old_debug_flags
3213
def load_test_id_list(file_name):
3214
"""Load a test id list from a text file.
3216
The format is one test id by line. No special care is taken to impose
3217
strict rules, these test ids are used to filter the test suite so a test id
3218
that do not match an existing test will do no harm. This allows user to add
3219
comments, leave blank lines, etc.
3223
ftest = open(file_name, 'rt')
3225
if e.errno != errno.ENOENT:
3228
raise errors.NoSuchFile(file_name)
3230
for test_name in ftest.readlines():
3231
test_list.append(test_name.strip())
3236
def suite_matches_id_list(test_suite, id_list):
3237
"""Warns about tests not appearing or appearing more than once.
3239
:param test_suite: A TestSuite object.
3240
:param test_id_list: The list of test ids that should be found in
3243
:return: (absents, duplicates) absents is a list containing the test found
3244
in id_list but not in test_suite, duplicates is a list containing the
3245
test found multiple times in test_suite.
3247
When using a prefined test id list, it may occurs that some tests do not
3248
exist anymore or that some tests use the same id. This function warns the
3249
tester about potential problems in his workflow (test lists are volatile)
3250
or in the test suite itself (using the same id for several tests does not
3251
help to localize defects).
3253
# Build a dict counting id occurrences
3255
for test in iter_suite_tests(test_suite):
3257
tests[id] = tests.get(id, 0) + 1
3262
occurs = tests.get(id, 0)
3264
not_found.append(id)
3266
duplicates.append(id)
3268
return not_found, duplicates
3271
class TestIdList(object):
3272
"""Test id list to filter a test suite.
3274
Relying on the assumption that test ids are built as:
3275
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3276
notation, this class offers methods to :
3277
- avoid building a test suite for modules not refered to in the test list,
3278
- keep only the tests listed from the module test suite.
3281
def __init__(self, test_id_list):
3282
# When a test suite needs to be filtered against us we compare test ids
3283
# for equality, so a simple dict offers a quick and simple solution.
3284
self.tests = dict().fromkeys(test_id_list, True)
3286
# While unittest.TestCase have ids like:
3287
# <module>.<class>.<method>[(<param+)],
3288
# doctest.DocTestCase can have ids like:
3291
# <module>.<function>
3292
# <module>.<class>.<method>
3294
# Since we can't predict a test class from its name only, we settle on
3295
# a simple constraint: a test id always begins with its module name.
3298
for test_id in test_id_list:
3299
parts = test_id.split('.')
3300
mod_name = parts.pop(0)
3301
modules[mod_name] = True
3303
mod_name += '.' + part
3304
modules[mod_name] = True
3305
self.modules = modules
3307
def refers_to(self, module_name):
3308
"""Is there tests for the module or one of its sub modules."""
3309
return self.modules.has_key(module_name)
3311
def includes(self, test_id):
3312
return self.tests.has_key(test_id)
3315
class TestPrefixAliasRegistry(registry.Registry):
3316
"""A registry for test prefix aliases.
3318
This helps implement shorcuts for the --starting-with selftest
3319
option. Overriding existing prefixes is not allowed but not fatal (a
3320
warning will be emitted).
3323
def register(self, key, obj, help=None, info=None,
3324
override_existing=False):
3325
"""See Registry.register.
3327
Trying to override an existing alias causes a warning to be emitted,
3328
not a fatal execption.
3331
super(TestPrefixAliasRegistry, self).register(
3332
key, obj, help=help, info=info, override_existing=False)
3334
actual = self.get(key)
3335
note('Test prefix alias %s is already used for %s, ignoring %s'
3336
% (key, actual, obj))
3338
def resolve_alias(self, id_start):
3339
"""Replace the alias by the prefix in the given string.
3341
Using an unknown prefix is an error to help catching typos.
3343
parts = id_start.split('.')
3345
parts[0] = self.get(parts[0])
3347
raise errors.BzrCommandError(
3348
'%s is not a known test prefix alias' % parts[0])
3349
return '.'.join(parts)
3352
test_prefix_alias_registry = TestPrefixAliasRegistry()
3353
"""Registry of test prefix aliases."""
3356
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3357
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3358
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3360
# Obvious higest levels prefixes, feel free to add your own via a plugin
3361
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3362
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3363
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3364
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3365
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3368
def test_suite(keep_only=None, starting_with=None):
3369
"""Build and return TestSuite for the whole of bzrlib.
3371
:param keep_only: A list of test ids limiting the suite returned.
3373
:param starting_with: An id limiting the suite returned to the tests
3376
This function can be replaced if you need to change the default test
3377
suite on a global basis, but it is not encouraged.
3381
'bzrlib.tests.blackbox',
3382
'bzrlib.tests.commands',
3383
'bzrlib.tests.per_branch',
3384
'bzrlib.tests.per_bzrdir',
3385
'bzrlib.tests.per_interrepository',
3386
'bzrlib.tests.per_intertree',
3387
'bzrlib.tests.per_inventory',
3388
'bzrlib.tests.per_interbranch',
3389
'bzrlib.tests.per_lock',
3390
'bzrlib.tests.per_transport',
3391
'bzrlib.tests.per_tree',
3392
'bzrlib.tests.per_repository',
3393
'bzrlib.tests.per_repository_chk',
3394
'bzrlib.tests.per_repository_reference',
3395
'bzrlib.tests.per_workingtree',
3396
'bzrlib.tests.test__annotator',
3397
'bzrlib.tests.test__chk_map',
3398
'bzrlib.tests.test__dirstate_helpers',
3399
'bzrlib.tests.test__groupcompress',
3400
'bzrlib.tests.test__known_graph',
3401
'bzrlib.tests.test__rio',
3402
'bzrlib.tests.test__walkdirs_win32',
3403
'bzrlib.tests.test_ancestry',
3404
'bzrlib.tests.test_annotate',
3405
'bzrlib.tests.test_api',
3406
'bzrlib.tests.test_atomicfile',
3407
'bzrlib.tests.test_bad_files',
3408
'bzrlib.tests.test_bencode',
3409
'bzrlib.tests.test_bisect_multi',
3410
'bzrlib.tests.test_branch',
3411
'bzrlib.tests.test_branchbuilder',
3412
'bzrlib.tests.test_btree_index',
3413
'bzrlib.tests.test_bugtracker',
3414
'bzrlib.tests.test_bundle',
3415
'bzrlib.tests.test_bzrdir',
3416
'bzrlib.tests.test__chunks_to_lines',
3417
'bzrlib.tests.test_cache_utf8',
3418
'bzrlib.tests.test_chk_map',
3419
'bzrlib.tests.test_chk_serializer',
3420
'bzrlib.tests.test_chunk_writer',
3421
'bzrlib.tests.test_clean_tree',
3422
'bzrlib.tests.test_commands',
3423
'bzrlib.tests.test_commit',
3424
'bzrlib.tests.test_commit_merge',
3425
'bzrlib.tests.test_config',
3426
'bzrlib.tests.test_conflicts',
3427
'bzrlib.tests.test_counted_lock',
3428
'bzrlib.tests.test_decorators',
3429
'bzrlib.tests.test_delta',
3430
'bzrlib.tests.test_debug',
3431
'bzrlib.tests.test_deprecated_graph',
3432
'bzrlib.tests.test_diff',
3433
'bzrlib.tests.test_directory_service',
3434
'bzrlib.tests.test_dirstate',
3435
'bzrlib.tests.test_email_message',
3436
'bzrlib.tests.test_eol_filters',
3437
'bzrlib.tests.test_errors',
3438
'bzrlib.tests.test_export',
3439
'bzrlib.tests.test_extract',
3440
'bzrlib.tests.test_fetch',
3441
'bzrlib.tests.test_fifo_cache',
3442
'bzrlib.tests.test_filters',
3443
'bzrlib.tests.test_ftp_transport',
3444
'bzrlib.tests.test_foreign',
3445
'bzrlib.tests.test_generate_docs',
3446
'bzrlib.tests.test_generate_ids',
3447
'bzrlib.tests.test_globbing',
3448
'bzrlib.tests.test_gpg',
3449
'bzrlib.tests.test_graph',
3450
'bzrlib.tests.test_groupcompress',
3451
'bzrlib.tests.test_hashcache',
3452
'bzrlib.tests.test_help',
3453
'bzrlib.tests.test_hooks',
3454
'bzrlib.tests.test_http',
3455
'bzrlib.tests.test_http_response',
3456
'bzrlib.tests.test_https_ca_bundle',
3457
'bzrlib.tests.test_identitymap',
3458
'bzrlib.tests.test_ignores',
3459
'bzrlib.tests.test_index',
3460
'bzrlib.tests.test_info',
3461
'bzrlib.tests.test_inv',
3462
'bzrlib.tests.test_inventory_delta',
3463
'bzrlib.tests.test_knit',
3464
'bzrlib.tests.test_lazy_import',
3465
'bzrlib.tests.test_lazy_regex',
3466
'bzrlib.tests.test_lockable_files',
3467
'bzrlib.tests.test_lockdir',
3468
'bzrlib.tests.test_log',
3469
'bzrlib.tests.test_lru_cache',
3470
'bzrlib.tests.test_lsprof',
3471
'bzrlib.tests.test_mail_client',
3472
'bzrlib.tests.test_memorytree',
3473
'bzrlib.tests.test_merge',
3474
'bzrlib.tests.test_merge3',
3475
'bzrlib.tests.test_merge_core',
3476
'bzrlib.tests.test_merge_directive',
3477
'bzrlib.tests.test_missing',
3478
'bzrlib.tests.test_msgeditor',
3479
'bzrlib.tests.test_multiparent',
3480
'bzrlib.tests.test_mutabletree',
3481
'bzrlib.tests.test_nonascii',
3482
'bzrlib.tests.test_options',
3483
'bzrlib.tests.test_osutils',
3484
'bzrlib.tests.test_osutils_encodings',
3485
'bzrlib.tests.test_pack',
3486
'bzrlib.tests.test_pack_repository',
3487
'bzrlib.tests.test_patch',
3488
'bzrlib.tests.test_patches',
3489
'bzrlib.tests.test_permissions',
3490
'bzrlib.tests.test_plugins',
3491
'bzrlib.tests.test_progress',
3492
'bzrlib.tests.test_read_bundle',
3493
'bzrlib.tests.test_reconcile',
3494
'bzrlib.tests.test_reconfigure',
3495
'bzrlib.tests.test_registry',
3496
'bzrlib.tests.test_remote',
3497
'bzrlib.tests.test_rename_map',
3498
'bzrlib.tests.test_repository',
3499
'bzrlib.tests.test_revert',
3500
'bzrlib.tests.test_revision',
3501
'bzrlib.tests.test_revisionspec',
3502
'bzrlib.tests.test_revisiontree',
3503
'bzrlib.tests.test_rio',
3504
'bzrlib.tests.test_rules',
3505
'bzrlib.tests.test_sampler',
3506
'bzrlib.tests.test_selftest',
3507
'bzrlib.tests.test_serializer',
3508
'bzrlib.tests.test_setup',
3509
'bzrlib.tests.test_sftp_transport',
3510
'bzrlib.tests.test_shelf',
3511
'bzrlib.tests.test_shelf_ui',
3512
'bzrlib.tests.test_smart',
3513
'bzrlib.tests.test_smart_add',
3514
'bzrlib.tests.test_smart_request',
3515
'bzrlib.tests.test_smart_transport',
3516
'bzrlib.tests.test_smtp_connection',
3517
'bzrlib.tests.test_source',
3518
'bzrlib.tests.test_ssh_transport',
3519
'bzrlib.tests.test_status',
3520
'bzrlib.tests.test_store',
3521
'bzrlib.tests.test_strace',
3522
'bzrlib.tests.test_subsume',
3523
'bzrlib.tests.test_switch',
3524
'bzrlib.tests.test_symbol_versioning',
3525
'bzrlib.tests.test_tag',
3526
'bzrlib.tests.test_testament',
3527
'bzrlib.tests.test_textfile',
3528
'bzrlib.tests.test_textmerge',
3529
'bzrlib.tests.test_timestamp',
3530
'bzrlib.tests.test_trace',
3531
'bzrlib.tests.test_transactions',
3532
'bzrlib.tests.test_transform',
3533
'bzrlib.tests.test_transport',
3534
'bzrlib.tests.test_transport_log',
3535
'bzrlib.tests.test_tree',
3536
'bzrlib.tests.test_treebuilder',
3537
'bzrlib.tests.test_tsort',
3538
'bzrlib.tests.test_tuned_gzip',
3539
'bzrlib.tests.test_ui',
3540
'bzrlib.tests.test_uncommit',
3541
'bzrlib.tests.test_upgrade',
3542
'bzrlib.tests.test_upgrade_stacked',
3543
'bzrlib.tests.test_urlutils',
3544
'bzrlib.tests.test_version',
3545
'bzrlib.tests.test_version_info',
3546
'bzrlib.tests.test_versionedfile',
3547
'bzrlib.tests.test_weave',
3548
'bzrlib.tests.test_whitebox',
3549
'bzrlib.tests.test_win32utils',
3550
'bzrlib.tests.test_workingtree',
3551
'bzrlib.tests.test_workingtree_4',
3552
'bzrlib.tests.test_wsgi',
3553
'bzrlib.tests.test_xml',
3556
loader = TestUtil.TestLoader()
3558
if keep_only is not None:
3559
id_filter = TestIdList(keep_only)
3561
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3562
for start in starting_with]
3563
# We take precedence over keep_only because *at loading time* using
3564
# both options means we will load less tests for the same final result.
3565
def interesting_module(name):
3566
for start in starting_with:
3568
# Either the module name starts with the specified string
3569
name.startswith(start)
3570
# or it may contain tests starting with the specified string
3571
or start.startswith(name)
3575
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3577
elif keep_only is not None:
3578
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3579
def interesting_module(name):
3580
return id_filter.refers_to(name)
3583
loader = TestUtil.TestLoader()
3584
def interesting_module(name):
3585
# No filtering, all modules are interesting
3588
suite = loader.suiteClass()
3590
# modules building their suite with loadTestsFromModuleNames
3591
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3593
modules_to_doctest = [
3595
'bzrlib.branchbuilder',
3598
'bzrlib.iterablefile',
3602
'bzrlib.symbol_versioning',
3605
'bzrlib.version_info_formats.format_custom',
3608
for mod in modules_to_doctest:
3609
if not interesting_module(mod):
3610
# No tests to keep here, move along
3613
# note that this really does mean "report only" -- doctest
3614
# still runs the rest of the examples
3615
doc_suite = doctest.DocTestSuite(mod,
3616
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3617
except ValueError, e:
3618
print '**failed to get doctest for: %s\n%s' % (mod, e)
3620
if len(doc_suite._tests) == 0:
3621
raise errors.BzrError("no doctests found in %s" % (mod,))
3622
suite.addTest(doc_suite)
3624
default_encoding = sys.getdefaultencoding()
3625
for name, plugin in bzrlib.plugin.plugins().items():
3626
if not interesting_module(plugin.module.__name__):
3628
plugin_suite = plugin.test_suite()
3629
# We used to catch ImportError here and turn it into just a warning,
3630
# but really if you don't have --no-plugins this should be a failure.
3631
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3632
if plugin_suite is None:
3633
plugin_suite = plugin.load_plugin_tests(loader)
3634
if plugin_suite is not None:
3635
suite.addTest(plugin_suite)
3636
if default_encoding != sys.getdefaultencoding():
3637
bzrlib.trace.warning(
3638
'Plugin "%s" tried to reset default encoding to: %s', name,
3639
sys.getdefaultencoding())
3641
sys.setdefaultencoding(default_encoding)
3644
suite = filter_suite_by_id_startswith(suite, starting_with)
3646
if keep_only is not None:
3647
# Now that the referred modules have loaded their tests, keep only the
3649
suite = filter_suite_by_id_list(suite, id_filter)
3650
# Do some sanity checks on the id_list filtering
3651
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3653
# The tester has used both keep_only and starting_with, so he is
3654
# already aware that some tests are excluded from the list, there
3655
# is no need to tell him which.
3658
# Some tests mentioned in the list are not in the test suite. The
3659
# list may be out of date, report to the tester.
3660
for id in not_found:
3661
bzrlib.trace.warning('"%s" not found in the test suite', id)
3662
for id in duplicates:
3663
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3668
def multiply_scenarios(scenarios_left, scenarios_right):
3669
"""Multiply two sets of scenarios.
3671
:returns: the cartesian product of the two sets of scenarios, that is
3672
a scenario for every possible combination of a left scenario and a
3676
('%s,%s' % (left_name, right_name),
3677
dict(left_dict.items() + right_dict.items()))
3678
for left_name, left_dict in scenarios_left
3679
for right_name, right_dict in scenarios_right]
3682
def multiply_tests(tests, scenarios, result):
3683
"""Multiply tests_list by scenarios into result.
3685
This is the core workhorse for test parameterisation.
3687
Typically the load_tests() method for a per-implementation test suite will
3688
call multiply_tests and return the result.
3690
:param tests: The tests to parameterise.
3691
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3692
scenario_param_dict).
3693
:param result: A TestSuite to add created tests to.
3695
This returns the passed in result TestSuite with the cross product of all
3696
the tests repeated once for each scenario. Each test is adapted by adding
3697
the scenario name at the end of its id(), and updating the test object's
3698
__dict__ with the scenario_param_dict.
3700
>>> import bzrlib.tests.test_sampler
3701
>>> r = multiply_tests(
3702
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3703
... [('one', dict(param=1)),
3704
... ('two', dict(param=2))],
3706
>>> tests = list(iter_suite_tests(r))
3710
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3716
for test in iter_suite_tests(tests):
3717
apply_scenarios(test, scenarios, result)
3721
def apply_scenarios(test, scenarios, result):
3722
"""Apply the scenarios in scenarios to test and add to result.
3724
:param test: The test to apply scenarios to.
3725
:param scenarios: An iterable of scenarios to apply to test.
3727
:seealso: apply_scenario
3729
for scenario in scenarios:
3730
result.addTest(apply_scenario(test, scenario))
3734
def apply_scenario(test, scenario):
3735
"""Copy test and apply scenario to it.
3737
:param test: A test to adapt.
3738
:param scenario: A tuple describing the scenarion.
3739
The first element of the tuple is the new test id.
3740
The second element is a dict containing attributes to set on the
3742
:return: The adapted test.
3744
new_id = "%s(%s)" % (test.id(), scenario[0])
3745
new_test = clone_test(test, new_id)
3746
for name, value in scenario[1].items():
3747
setattr(new_test, name, value)
3751
def clone_test(test, new_id):
3752
"""Clone a test giving it a new id.
3754
:param test: The test to clone.
3755
:param new_id: The id to assign to it.
3756
:return: The new test.
3758
from copy import deepcopy
3759
new_test = deepcopy(test)
3760
new_test.id = lambda: new_id
3764
def _rmtree_temp_dir(dirname):
3765
# If LANG=C we probably have created some bogus paths
3766
# which rmtree(unicode) will fail to delete
3767
# so make sure we are using rmtree(str) to delete everything
3768
# except on win32, where rmtree(str) will fail
3769
# since it doesn't have the property of byte-stream paths
3770
# (they are either ascii or mbcs)
3771
if sys.platform == 'win32':
3772
# make sure we are using the unicode win32 api
3773
dirname = unicode(dirname)
3775
dirname = dirname.encode(sys.getfilesystemencoding())
3777
osutils.rmtree(dirname)
3779
if sys.platform == 'win32' and e.errno == errno.EACCES:
3780
sys.stderr.write('Permission denied: '
3781
'unable to remove testing dir '
3783
% (os.path.basename(dirname), e))
3788
class Feature(object):
3789
"""An operating system Feature."""
3792
self._available = None
3794
def available(self):
3795
"""Is the feature available?
3797
:return: True if the feature is available.
3799
if self._available is None:
3800
self._available = self._probe()
3801
return self._available
3804
"""Implement this method in concrete features.
3806
:return: True if the feature is available.
3808
raise NotImplementedError
3811
if getattr(self, 'feature_name', None):
3812
return self.feature_name()
3813
return self.__class__.__name__
3816
class _SymlinkFeature(Feature):
3819
return osutils.has_symlinks()
3821
def feature_name(self):
3824
SymlinkFeature = _SymlinkFeature()
3827
class _HardlinkFeature(Feature):
3830
return osutils.has_hardlinks()
3832
def feature_name(self):
3835
HardlinkFeature = _HardlinkFeature()
3838
class _OsFifoFeature(Feature):
3841
return getattr(os, 'mkfifo', None)
3843
def feature_name(self):
3844
return 'filesystem fifos'
3846
OsFifoFeature = _OsFifoFeature()
3849
class _UnicodeFilenameFeature(Feature):
3850
"""Does the filesystem support Unicode filenames?"""
3854
# Check for character combinations unlikely to be covered by any
3855
# single non-unicode encoding. We use the characters
3856
# - greek small letter alpha (U+03B1) and
3857
# - braille pattern dots-123456 (U+283F).
3858
os.stat(u'\u03b1\u283f')
3859
except UnicodeEncodeError:
3861
except (IOError, OSError):
3862
# The filesystem allows the Unicode filename but the file doesn't
3866
# The filesystem allows the Unicode filename and the file exists,
3870
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3873
def probe_unicode_in_user_encoding():
3874
"""Try to encode several unicode strings to use in unicode-aware tests.
3875
Return first successfull match.
3877
:return: (unicode value, encoded plain string value) or (None, None)
3879
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3880
for uni_val in possible_vals:
3882
str_val = uni_val.encode(osutils.get_user_encoding())
3883
except UnicodeEncodeError:
3884
# Try a different character
3887
return uni_val, str_val
3891
def probe_bad_non_ascii(encoding):
3892
"""Try to find [bad] character with code [128..255]
3893
that cannot be decoded to unicode in some encoding.
3894
Return None if all non-ascii characters is valid
3897
for i in xrange(128, 256):
3900
char.decode(encoding)
3901
except UnicodeDecodeError:
3906
class _HTTPSServerFeature(Feature):
3907
"""Some tests want an https Server, check if one is available.
3909
Right now, the only way this is available is under python2.6 which provides
3920
def feature_name(self):
3921
return 'HTTPSServer'
3924
HTTPSServerFeature = _HTTPSServerFeature()
3927
class _UnicodeFilename(Feature):
3928
"""Does the filesystem support Unicode filenames?"""
3933
except UnicodeEncodeError:
3935
except (IOError, OSError):
3936
# The filesystem allows the Unicode filename but the file doesn't
3940
# The filesystem allows the Unicode filename and the file exists,
3944
UnicodeFilename = _UnicodeFilename()
3947
class _UTF8Filesystem(Feature):
3948
"""Is the filesystem UTF-8?"""
3951
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3955
UTF8Filesystem = _UTF8Filesystem()
3958
class _CaseInsCasePresFilenameFeature(Feature):
3959
"""Is the file-system case insensitive, but case-preserving?"""
3962
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3964
# first check truly case-preserving for created files, then check
3965
# case insensitive when opening existing files.
3966
name = osutils.normpath(name)
3967
base, rel = osutils.split(name)
3968
found_rel = osutils.canonical_relpath(base, name)
3969
return (found_rel == rel
3970
and os.path.isfile(name.upper())
3971
and os.path.isfile(name.lower()))
3976
def feature_name(self):
3977
return "case-insensitive case-preserving filesystem"
3979
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3982
class _CaseInsensitiveFilesystemFeature(Feature):
3983
"""Check if underlying filesystem is case-insensitive but *not* case
3986
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3987
# more likely to be case preserving, so this case is rare.
3990
if CaseInsCasePresFilenameFeature.available():
3993
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3994
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3995
TestCaseWithMemoryTransport.TEST_ROOT = root
3997
root = TestCaseWithMemoryTransport.TEST_ROOT
3998
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4000
name_a = osutils.pathjoin(tdir, 'a')
4001
name_A = osutils.pathjoin(tdir, 'A')
4003
result = osutils.isdir(name_A)
4004
_rmtree_temp_dir(tdir)
4007
def feature_name(self):
4008
return 'case-insensitive filesystem'
4010
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4013
class _SubUnitFeature(Feature):
4014
"""Check if subunit is available."""
4023
def feature_name(self):
4026
SubUnitFeature = _SubUnitFeature()
4027
# Only define SubUnitBzrRunner if subunit is available.
4029
from subunit import TestProtocolClient
4031
from subunit.test_results import AutoTimingTestResultDecorator
4033
AutoTimingTestResultDecorator = lambda x:x
4034
class SubUnitBzrRunner(TextTestRunner):
4035
def run(self, test):
4036
result = AutoTimingTestResultDecorator(
4037
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
