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 get_non_echoed_password(self):
757
"""Get password from stdin without trying to handle the echo mode"""
758
password = self.stdin.readline()
761
if password[-1] == '\n':
762
password = password[:-1]
765
def make_progress_view(self):
766
return NullProgressView()
769
class TestCase(unittest.TestCase):
770
"""Base class for bzr unit tests.
772
Tests that need access to disk resources should subclass
773
TestCaseInTempDir not TestCase.
775
Error and debug log messages are redirected from their usual
776
location into a temporary file, the contents of which can be
777
retrieved by _get_log(). We use a real OS file, not an in-memory object,
778
so that it can also capture file IO. When the test completes this file
779
is read into memory and removed from disk.
781
There are also convenience functions to invoke bzr's command-line
782
routine, and to build and check bzr trees.
784
In addition to the usual method of overriding tearDown(), this class also
785
allows subclasses to register functions into the _cleanups list, which is
786
run in order as the object is torn down. It's less likely this will be
787
accidentally overlooked.
790
_active_threads = None
791
_leaking_threads_tests = 0
792
_first_thread_leaker_id = None
793
_log_file_name = None
795
_keep_log_file = False
796
# record lsprof data when performing benchmark calls.
797
_gather_lsprof_in_benchmarks = False
798
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
799
'_log_contents', '_log_file_name', '_benchtime',
800
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
802
def __init__(self, methodName='testMethod'):
803
super(TestCase, self).__init__(methodName)
805
self._bzr_test_setUp_run = False
806
self._bzr_test_tearDown_run = False
809
unittest.TestCase.setUp(self)
810
self._bzr_test_setUp_run = True
811
self._cleanEnvironment()
814
self._benchcalls = []
815
self._benchtime = None
817
# Track locks - needs to be called before _clear_debug_flags.
819
self._clear_debug_flags()
820
TestCase._active_threads = threading.activeCount()
821
self.addCleanup(self._check_leaked_threads)
826
pdb.Pdb().set_trace(sys._getframe().f_back)
828
def _check_leaked_threads(self):
829
active = threading.activeCount()
830
leaked_threads = active - TestCase._active_threads
831
TestCase._active_threads = active
833
TestCase._leaking_threads_tests += 1
834
if TestCase._first_thread_leaker_id is None:
835
TestCase._first_thread_leaker_id = self.id()
837
def _clear_debug_flags(self):
838
"""Prevent externally set debug flags affecting tests.
840
Tests that want to use debug flags can just set them in the
841
debug_flags set during setup/teardown.
843
self._preserved_debug_flags = set(debug.debug_flags)
844
if 'allow_debug' not in selftest_debug_flags:
845
debug.debug_flags.clear()
846
self.addCleanup(self._restore_debug_flags)
848
def _clear_hooks(self):
849
# prevent hooks affecting tests
850
self._preserved_hooks = {}
851
for key, factory in hooks.known_hooks.items():
852
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
853
current_hooks = hooks.known_hooks_key_to_object(key)
854
self._preserved_hooks[parent] = (name, current_hooks)
855
self.addCleanup(self._restoreHooks)
856
for key, factory in hooks.known_hooks.items():
857
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
858
setattr(parent, name, factory())
859
# this hook should always be installed
860
request._install_hook()
862
def _silenceUI(self):
863
"""Turn off UI for duration of test"""
864
# by default the UI is off; tests can turn it on if they want it.
865
saved = ui.ui_factory
867
ui.ui_factory = saved
868
ui.ui_factory = ui.SilentUIFactory()
869
self.addCleanup(_restore)
871
def _check_locks(self):
872
"""Check that all lock take/release actions have been paired."""
873
# once we have fixed all the current lock problems, we can change the
874
# following code to always check for mismatched locks, but only do
875
# traceback showing with -Dlock (self._lock_check_thorough is True).
876
# For now, because the test suite will fail, we only assert that lock
877
# matching has occured with -Dlock.
879
acquired_locks = [lock for action, lock in self._lock_actions
880
if action == 'acquired']
881
released_locks = [lock for action, lock in self._lock_actions
882
if action == 'released']
883
broken_locks = [lock for action, lock in self._lock_actions
884
if action == 'broken']
885
# trivially, given the tests for lock acquistion and release, if we
886
# have as many in each list, it should be ok. Some lock tests also
887
# break some locks on purpose and should be taken into account by
888
# considering that breaking a lock is just a dirty way of releasing it.
889
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
890
message = ('Different number of acquired and '
891
'released or broken locks. (%s, %s + %s)' %
892
(acquired_locks, released_locks, broken_locks))
893
if not self._lock_check_thorough:
894
# Rather than fail, just warn
895
print "Broken test %s: %s" % (self, message)
899
def _track_locks(self):
900
"""Track lock activity during tests."""
901
self._lock_actions = []
902
self._lock_check_thorough = 'lock' not in debug.debug_flags
903
self.addCleanup(self._check_locks)
904
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
905
self._lock_acquired, None)
906
_mod_lock.Lock.hooks.install_named_hook('lock_released',
907
self._lock_released, None)
908
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
909
self._lock_broken, None)
911
def _lock_acquired(self, result):
912
self._lock_actions.append(('acquired', result))
914
def _lock_released(self, result):
915
self._lock_actions.append(('released', result))
917
def _lock_broken(self, result):
918
self._lock_actions.append(('broken', result))
920
def _ndiff_strings(self, a, b):
921
"""Return ndiff between two strings containing lines.
923
A trailing newline is added if missing to make the strings
925
if b and b[-1] != '\n':
927
if a and a[-1] != '\n':
929
difflines = difflib.ndiff(a.splitlines(True),
931
linejunk=lambda x: False,
932
charjunk=lambda x: False)
933
return ''.join(difflines)
935
def assertEqual(self, a, b, message=''):
939
except UnicodeError, e:
940
# If we can't compare without getting a UnicodeError, then
941
# obviously they are different
942
mutter('UnicodeError: %s', e)
945
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
947
pformat(a), pformat(b)))
949
assertEquals = assertEqual
951
def assertEqualDiff(self, a, b, message=None):
952
"""Assert two texts are equal, if not raise an exception.
954
This is intended for use with multi-line strings where it can
955
be hard to find the differences by eye.
957
# TODO: perhaps override assertEquals to call this for strings?
961
message = "texts not equal:\n"
963
message = 'first string is missing a final newline.\n'
965
message = 'second string is missing a final newline.\n'
966
raise AssertionError(message +
967
self._ndiff_strings(a, b))
969
def assertEqualMode(self, mode, mode_test):
970
self.assertEqual(mode, mode_test,
971
'mode mismatch %o != %o' % (mode, mode_test))
973
def assertEqualStat(self, expected, actual):
974
"""assert that expected and actual are the same stat result.
976
:param expected: A stat result.
977
:param actual: A stat result.
978
:raises AssertionError: If the expected and actual stat values differ
981
self.assertEqual(expected.st_size, actual.st_size)
982
self.assertEqual(expected.st_mtime, actual.st_mtime)
983
self.assertEqual(expected.st_ctime, actual.st_ctime)
984
self.assertEqual(expected.st_dev, actual.st_dev)
985
self.assertEqual(expected.st_ino, actual.st_ino)
986
self.assertEqual(expected.st_mode, actual.st_mode)
988
def assertLength(self, length, obj_with_len):
989
"""Assert that obj_with_len is of length length."""
990
if len(obj_with_len) != length:
991
self.fail("Incorrect length: wanted %d, got %d for %r" % (
992
length, len(obj_with_len), obj_with_len))
994
def assertPositive(self, val):
995
"""Assert that val is greater than 0."""
996
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
998
def assertNegative(self, val):
999
"""Assert that val is less than 0."""
1000
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
1002
def assertStartsWith(self, s, prefix):
1003
if not s.startswith(prefix):
1004
raise AssertionError('string %r does not start with %r' % (s, prefix))
1006
def assertEndsWith(self, s, suffix):
1007
"""Asserts that s ends with suffix."""
1008
if not s.endswith(suffix):
1009
raise AssertionError('string %r does not end with %r' % (s, suffix))
1011
def assertContainsRe(self, haystack, needle_re, flags=0):
1012
"""Assert that a contains something matching a regular expression."""
1013
if not re.search(needle_re, haystack, flags):
1014
if '\n' in haystack or len(haystack) > 60:
1015
# a long string, format it in a more readable way
1016
raise AssertionError(
1017
'pattern "%s" not found in\n"""\\\n%s"""\n'
1018
% (needle_re, haystack))
1020
raise AssertionError('pattern "%s" not found in "%s"'
1021
% (needle_re, haystack))
1023
def assertNotContainsRe(self, haystack, needle_re, flags=0):
1024
"""Assert that a does not match a regular expression"""
1025
if re.search(needle_re, haystack, flags):
1026
raise AssertionError('pattern "%s" found in "%s"'
1027
% (needle_re, haystack))
1029
def assertSubset(self, sublist, superlist):
1030
"""Assert that every entry in sublist is present in superlist."""
1031
missing = set(sublist) - set(superlist)
1032
if len(missing) > 0:
1033
raise AssertionError("value(s) %r not present in container %r" %
1034
(missing, superlist))
1036
def assertListRaises(self, excClass, func, *args, **kwargs):
1037
"""Fail unless excClass is raised when the iterator from func is used.
1039
Many functions can return generators this makes sure
1040
to wrap them in a list() call to make sure the whole generator
1041
is run, and that the proper exception is raised.
1044
list(func(*args, **kwargs))
1048
if getattr(excClass,'__name__', None) is not None:
1049
excName = excClass.__name__
1051
excName = str(excClass)
1052
raise self.failureException, "%s not raised" % excName
1054
def assertRaises(self, excClass, callableObj, *args, **kwargs):
1055
"""Assert that a callable raises a particular exception.
1057
:param excClass: As for the except statement, this may be either an
1058
exception class, or a tuple of classes.
1059
:param callableObj: A callable, will be passed ``*args`` and
1062
Returns the exception so that you can examine it.
1065
callableObj(*args, **kwargs)
1069
if getattr(excClass,'__name__', None) is not None:
1070
excName = excClass.__name__
1073
excName = str(excClass)
1074
raise self.failureException, "%s not raised" % excName
1076
def assertIs(self, left, right, message=None):
1077
if not (left is right):
1078
if message is not None:
1079
raise AssertionError(message)
1081
raise AssertionError("%r is not %r." % (left, right))
1083
def assertIsNot(self, left, right, message=None):
1085
if message is not None:
1086
raise AssertionError(message)
1088
raise AssertionError("%r is %r." % (left, right))
1090
def assertTransportMode(self, transport, path, mode):
1091
"""Fail if a path does not have mode "mode".
1093
If modes are not supported on this transport, the assertion is ignored.
1095
if not transport._can_roundtrip_unix_modebits():
1097
path_stat = transport.stat(path)
1098
actual_mode = stat.S_IMODE(path_stat.st_mode)
1099
self.assertEqual(mode, actual_mode,
1100
'mode of %r incorrect (%s != %s)'
1101
% (path, oct(mode), oct(actual_mode)))
1103
def assertIsSameRealPath(self, path1, path2):
1104
"""Fail if path1 and path2 points to different files"""
1105
self.assertEqual(osutils.realpath(path1),
1106
osutils.realpath(path2),
1107
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1109
def assertIsInstance(self, obj, kls, msg=None):
1110
"""Fail if obj is not an instance of kls
1112
:param msg: Supplementary message to show if the assertion fails.
1114
if not isinstance(obj, kls):
1115
m = "%r is an instance of %s rather than %s" % (
1116
obj, obj.__class__, kls)
1121
def expectFailure(self, reason, assertion, *args, **kwargs):
1122
"""Invoke a test, expecting it to fail for the given reason.
1124
This is for assertions that ought to succeed, but currently fail.
1125
(The failure is *expected* but not *wanted*.) Please be very precise
1126
about the failure you're expecting. If a new bug is introduced,
1127
AssertionError should be raised, not KnownFailure.
1129
Frequently, expectFailure should be followed by an opposite assertion.
1132
Intended to be used with a callable that raises AssertionError as the
1133
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1135
Raises KnownFailure if the test fails. Raises AssertionError if the
1140
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1142
self.assertEqual(42, dynamic_val)
1144
This means that a dynamic_val of 54 will cause the test to raise
1145
a KnownFailure. Once math is fixed and the expectFailure is removed,
1146
only a dynamic_val of 42 will allow the test to pass. Anything other
1147
than 54 or 42 will cause an AssertionError.
1150
assertion(*args, **kwargs)
1151
except AssertionError:
1152
raise KnownFailure(reason)
1154
self.fail('Unexpected success. Should have failed: %s' % reason)
1156
def assertFileEqual(self, content, path):
1157
"""Fail if path does not contain 'content'."""
1158
self.failUnlessExists(path)
1159
f = file(path, 'rb')
1164
self.assertEqualDiff(content, s)
1166
def failUnlessExists(self, path):
1167
"""Fail unless path or paths, which may be abs or relative, exist."""
1168
if not isinstance(path, basestring):
1170
self.failUnlessExists(p)
1172
self.failUnless(osutils.lexists(path),path+" does not exist")
1174
def failIfExists(self, path):
1175
"""Fail if path or paths, which may be abs or relative, exist."""
1176
if not isinstance(path, basestring):
1178
self.failIfExists(p)
1180
self.failIf(osutils.lexists(path),path+" exists")
1182
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1183
"""A helper for callDeprecated and applyDeprecated.
1185
:param a_callable: A callable to call.
1186
:param args: The positional arguments for the callable
1187
:param kwargs: The keyword arguments for the callable
1188
:return: A tuple (warnings, result). result is the result of calling
1189
a_callable(``*args``, ``**kwargs``).
1192
def capture_warnings(msg, cls=None, stacklevel=None):
1193
# we've hooked into a deprecation specific callpath,
1194
# only deprecations should getting sent via it.
1195
self.assertEqual(cls, DeprecationWarning)
1196
local_warnings.append(msg)
1197
original_warning_method = symbol_versioning.warn
1198
symbol_versioning.set_warning_method(capture_warnings)
1200
result = a_callable(*args, **kwargs)
1202
symbol_versioning.set_warning_method(original_warning_method)
1203
return (local_warnings, result)
1205
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1206
"""Call a deprecated callable without warning the user.
1208
Note that this only captures warnings raised by symbol_versioning.warn,
1209
not other callers that go direct to the warning module.
1211
To test that a deprecated method raises an error, do something like
1214
self.assertRaises(errors.ReservedId,
1215
self.applyDeprecated,
1216
deprecated_in((1, 5, 0)),
1220
:param deprecation_format: The deprecation format that the callable
1221
should have been deprecated with. This is the same type as the
1222
parameter to deprecated_method/deprecated_function. If the
1223
callable is not deprecated with this format, an assertion error
1225
:param a_callable: A callable to call. This may be a bound method or
1226
a regular function. It will be called with ``*args`` and
1228
:param args: The positional arguments for the callable
1229
:param kwargs: The keyword arguments for the callable
1230
:return: The result of a_callable(``*args``, ``**kwargs``)
1232
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1234
expected_first_warning = symbol_versioning.deprecation_string(
1235
a_callable, deprecation_format)
1236
if len(call_warnings) == 0:
1237
self.fail("No deprecation warning generated by call to %s" %
1239
self.assertEqual(expected_first_warning, call_warnings[0])
1242
def callCatchWarnings(self, fn, *args, **kw):
1243
"""Call a callable that raises python warnings.
1245
The caller's responsible for examining the returned warnings.
1247
If the callable raises an exception, the exception is not
1248
caught and propagates up to the caller. In that case, the list
1249
of warnings is not available.
1251
:returns: ([warning_object, ...], fn_result)
1253
# XXX: This is not perfect, because it completely overrides the
1254
# warnings filters, and some code may depend on suppressing particular
1255
# warnings. It's the easiest way to insulate ourselves from -Werror,
1256
# though. -- Andrew, 20071062
1258
def _catcher(message, category, filename, lineno, file=None, line=None):
1259
# despite the name, 'message' is normally(?) a Warning subclass
1261
wlist.append(message)
1262
saved_showwarning = warnings.showwarning
1263
saved_filters = warnings.filters
1265
warnings.showwarning = _catcher
1266
warnings.filters = []
1267
result = fn(*args, **kw)
1269
warnings.showwarning = saved_showwarning
1270
warnings.filters = saved_filters
1271
return wlist, result
1273
def callDeprecated(self, expected, callable, *args, **kwargs):
1274
"""Assert that a callable is deprecated in a particular way.
1276
This is a very precise test for unusual requirements. The
1277
applyDeprecated helper function is probably more suited for most tests
1278
as it allows you to simply specify the deprecation format being used
1279
and will ensure that that is issued for the function being called.
1281
Note that this only captures warnings raised by symbol_versioning.warn,
1282
not other callers that go direct to the warning module. To catch
1283
general warnings, use callCatchWarnings.
1285
:param expected: a list of the deprecation warnings expected, in order
1286
:param callable: The callable to call
1287
:param args: The positional arguments for the callable
1288
:param kwargs: The keyword arguments for the callable
1290
call_warnings, result = self._capture_deprecation_warnings(callable,
1292
self.assertEqual(expected, call_warnings)
1295
def _startLogFile(self):
1296
"""Send bzr and test log messages to a temporary file.
1298
The file is removed as the test is torn down.
1300
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1301
self._log_file = os.fdopen(fileno, 'w+')
1302
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1303
self._log_file_name = name
1304
self.addCleanup(self._finishLogFile)
1306
def _finishLogFile(self):
1307
"""Finished with the log file.
1309
Close the file and delete it, unless setKeepLogfile was called.
1311
if self._log_file is None:
1313
bzrlib.trace.pop_log_file(self._log_memento)
1314
self._log_file.close()
1315
self._log_file = None
1316
if not self._keep_log_file:
1317
os.remove(self._log_file_name)
1318
self._log_file_name = None
1320
def setKeepLogfile(self):
1321
"""Make the logfile not be deleted when _finishLogFile is called."""
1322
self._keep_log_file = True
1324
def addCleanup(self, callable, *args, **kwargs):
1325
"""Arrange to run a callable when this case is torn down.
1327
Callables are run in the reverse of the order they are registered,
1328
ie last-in first-out.
1330
self._cleanups.append((callable, args, kwargs))
1332
def _cleanEnvironment(self):
1334
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1335
'HOME': os.getcwd(),
1336
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1337
# tests do check our impls match APPDATA
1338
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1342
'BZREMAIL': None, # may still be present in the environment
1344
'BZR_PROGRESS_BAR': None,
1346
'BZR_PLUGIN_PATH': None,
1347
# Make sure that any text ui tests are consistent regardless of
1348
# the environment the test case is run in; you may want tests that
1349
# test other combinations. 'dumb' is a reasonable guess for tests
1350
# going to a pipe or a StringIO.
1355
'SSH_AUTH_SOCK': None,
1359
'https_proxy': None,
1360
'HTTPS_PROXY': None,
1365
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1366
# least. If you do (care), please update this comment
1370
'BZR_REMOTE_PATH': None,
1373
self.addCleanup(self._restoreEnvironment)
1374
for name, value in new_env.iteritems():
1375
self._captureVar(name, value)
1377
def _captureVar(self, name, newvalue):
1378
"""Set an environment variable, and reset it when finished."""
1379
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1381
def _restore_debug_flags(self):
1382
debug.debug_flags.clear()
1383
debug.debug_flags.update(self._preserved_debug_flags)
1385
def _restoreEnvironment(self):
1386
for name, value in self.__old_env.iteritems():
1387
osutils.set_or_unset_env(name, value)
1389
def _restoreHooks(self):
1390
for klass, (name, hooks) in self._preserved_hooks.items():
1391
setattr(klass, name, hooks)
1393
def knownFailure(self, reason):
1394
"""This test has failed for some known reason."""
1395
raise KnownFailure(reason)
1397
def _do_skip(self, result, reason):
1398
addSkip = getattr(result, 'addSkip', None)
1399
if not callable(addSkip):
1400
result.addError(self, sys.exc_info())
1402
addSkip(self, reason)
1404
def run(self, result=None):
1405
if result is None: result = self.defaultTestResult()
1406
for feature in getattr(self, '_test_needs_features', []):
1407
if not feature.available():
1408
result.startTest(self)
1409
if getattr(result, 'addNotSupported', None):
1410
result.addNotSupported(self, feature)
1412
result.addSuccess(self)
1413
result.stopTest(self)
1417
result.startTest(self)
1418
absent_attr = object()
1420
method_name = getattr(self, '_testMethodName', absent_attr)
1421
if method_name is absent_attr:
1423
method_name = getattr(self, '_TestCase__testMethodName')
1424
testMethod = getattr(self, method_name)
1428
if not self._bzr_test_setUp_run:
1430
"test setUp did not invoke "
1431
"bzrlib.tests.TestCase's setUp")
1432
except KeyboardInterrupt:
1435
except TestSkipped, e:
1436
self._do_skip(result, e.args[0])
1440
result.addError(self, sys.exc_info())
1448
except self.failureException:
1449
result.addFailure(self, sys.exc_info())
1450
except TestSkipped, e:
1452
reason = "No reason given."
1455
self._do_skip(result, reason)
1456
except KeyboardInterrupt:
1460
result.addError(self, sys.exc_info())
1464
if not self._bzr_test_tearDown_run:
1466
"test tearDown did not invoke "
1467
"bzrlib.tests.TestCase's tearDown")
1468
except KeyboardInterrupt:
1472
result.addError(self, sys.exc_info())
1475
if ok: result.addSuccess(self)
1477
result.stopTest(self)
1479
except TestNotApplicable:
1480
# Not moved from the result [yet].
1483
except KeyboardInterrupt:
1488
for attr_name in self.attrs_to_keep:
1489
if attr_name in self.__dict__:
1490
saved_attrs[attr_name] = self.__dict__[attr_name]
1491
self.__dict__ = saved_attrs
1495
self._log_contents = ''
1496
self._bzr_test_tearDown_run = True
1497
unittest.TestCase.tearDown(self)
1499
def time(self, callable, *args, **kwargs):
1500
"""Run callable and accrue the time it takes to the benchmark time.
1502
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1503
this will cause lsprofile statistics to be gathered and stored in
1506
if self._benchtime is None:
1510
if not self._gather_lsprof_in_benchmarks:
1511
return callable(*args, **kwargs)
1513
# record this benchmark
1514
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1516
self._benchcalls.append(((callable, args, kwargs), stats))
1519
self._benchtime += time.time() - start
1521
def _runCleanups(self):
1522
"""Run registered cleanup functions.
1524
This should only be called from TestCase.tearDown.
1526
# TODO: Perhaps this should keep running cleanups even if
1527
# one of them fails?
1529
# Actually pop the cleanups from the list so tearDown running
1530
# twice is safe (this happens for skipped tests).
1531
while self._cleanups:
1532
cleanup, args, kwargs = self._cleanups.pop()
1533
cleanup(*args, **kwargs)
1535
def log(self, *args):
1538
def _get_log(self, keep_log_file=False):
1539
"""Get the log from bzrlib.trace calls from this test.
1541
:param keep_log_file: When True, if the log is still a file on disk
1542
leave it as a file on disk. When False, if the log is still a file
1543
on disk, the log file is deleted and the log preserved as
1545
:return: A string containing the log.
1547
# flush the log file, to get all content
1549
if bzrlib.trace._trace_file:
1550
bzrlib.trace._trace_file.flush()
1551
if self._log_contents:
1552
# XXX: this can hardly contain the content flushed above --vila
1554
return self._log_contents
1555
if self._log_file_name is not None:
1556
logfile = open(self._log_file_name)
1558
log_contents = logfile.read()
1561
if not keep_log_file:
1562
self._log_contents = log_contents
1564
os.remove(self._log_file_name)
1566
if sys.platform == 'win32' and e.errno == errno.EACCES:
1567
sys.stderr.write(('Unable to delete log file '
1568
' %r\n' % self._log_file_name))
1573
return "DELETED log file to reduce memory footprint"
1575
def requireFeature(self, feature):
1576
"""This test requires a specific feature is available.
1578
:raises UnavailableFeature: When feature is not available.
1580
if not feature.available():
1581
raise UnavailableFeature(feature)
1583
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1585
"""Run bazaar command line, splitting up a string command line."""
1586
if isinstance(args, basestring):
1587
# shlex don't understand unicode strings,
1588
# so args should be plain string (bialix 20070906)
1589
args = list(shlex.split(str(args)))
1590
return self._run_bzr_core(args, retcode=retcode,
1591
encoding=encoding, stdin=stdin, working_dir=working_dir,
1594
def _run_bzr_core(self, args, retcode, encoding, stdin,
1596
if encoding is None:
1597
encoding = osutils.get_user_encoding()
1598
stdout = StringIOWrapper()
1599
stderr = StringIOWrapper()
1600
stdout.encoding = encoding
1601
stderr.encoding = encoding
1603
self.log('run bzr: %r', args)
1604
# FIXME: don't call into logging here
1605
handler = logging.StreamHandler(stderr)
1606
handler.setLevel(logging.INFO)
1607
logger = logging.getLogger('')
1608
logger.addHandler(handler)
1609
old_ui_factory = ui.ui_factory
1610
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1613
if working_dir is not None:
1614
cwd = osutils.getcwd()
1615
os.chdir(working_dir)
1618
result = self.apply_redirected(ui.ui_factory.stdin,
1620
bzrlib.commands.run_bzr_catch_user_errors,
1623
logger.removeHandler(handler)
1624
ui.ui_factory = old_ui_factory
1628
out = stdout.getvalue()
1629
err = stderr.getvalue()
1631
self.log('output:\n%r', out)
1633
self.log('errors:\n%r', err)
1634
if retcode is not None:
1635
self.assertEquals(retcode, result,
1636
message='Unexpected return code')
1639
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1640
working_dir=None, error_regexes=[], output_encoding=None):
1641
"""Invoke bzr, as if it were run from the command line.
1643
The argument list should not include the bzr program name - the
1644
first argument is normally the bzr command. Arguments may be
1645
passed in three ways:
1647
1- A list of strings, eg ["commit", "a"]. This is recommended
1648
when the command contains whitespace or metacharacters, or
1649
is built up at run time.
1651
2- A single string, eg "add a". This is the most convenient
1652
for hardcoded commands.
1654
This runs bzr through the interface that catches and reports
1655
errors, and with logging set to something approximating the
1656
default, so that error reporting can be checked.
1658
This should be the main method for tests that want to exercise the
1659
overall behavior of the bzr application (rather than a unit test
1660
or a functional test of the library.)
1662
This sends the stdout/stderr results into the test's log,
1663
where it may be useful for debugging. See also run_captured.
1665
:keyword stdin: A string to be used as stdin for the command.
1666
:keyword retcode: The status code the command should return;
1668
:keyword working_dir: The directory to run the command in
1669
:keyword error_regexes: A list of expected error messages. If
1670
specified they must be seen in the error output of the command.
1672
out, err = self._run_bzr_autosplit(
1677
working_dir=working_dir,
1679
self.assertIsInstance(error_regexes, (list, tuple))
1680
for regex in error_regexes:
1681
self.assertContainsRe(err, regex)
1684
def run_bzr_error(self, error_regexes, *args, **kwargs):
1685
"""Run bzr, and check that stderr contains the supplied regexes
1687
:param error_regexes: Sequence of regular expressions which
1688
must each be found in the error output. The relative ordering
1690
:param args: command-line arguments for bzr
1691
:param kwargs: Keyword arguments which are interpreted by run_bzr
1692
This function changes the default value of retcode to be 3,
1693
since in most cases this is run when you expect bzr to fail.
1695
:return: (out, err) The actual output of running the command (in case
1696
you want to do more inspection)
1700
# Make sure that commit is failing because there is nothing to do
1701
self.run_bzr_error(['no changes to commit'],
1702
['commit', '-m', 'my commit comment'])
1703
# Make sure --strict is handling an unknown file, rather than
1704
# giving us the 'nothing to do' error
1705
self.build_tree(['unknown'])
1706
self.run_bzr_error(['Commit refused because there are unknown files'],
1707
['commit', --strict', '-m', 'my commit comment'])
1709
kwargs.setdefault('retcode', 3)
1710
kwargs['error_regexes'] = error_regexes
1711
out, err = self.run_bzr(*args, **kwargs)
1714
def run_bzr_subprocess(self, *args, **kwargs):
1715
"""Run bzr in a subprocess for testing.
1717
This starts a new Python interpreter and runs bzr in there.
1718
This should only be used for tests that have a justifiable need for
1719
this isolation: e.g. they are testing startup time, or signal
1720
handling, or early startup code, etc. Subprocess code can't be
1721
profiled or debugged so easily.
1723
:keyword retcode: The status code that is expected. Defaults to 0. If
1724
None is supplied, the status code is not checked.
1725
:keyword env_changes: A dictionary which lists changes to environment
1726
variables. A value of None will unset the env variable.
1727
The values must be strings. The change will only occur in the
1728
child, so you don't need to fix the environment after running.
1729
:keyword universal_newlines: Convert CRLF => LF
1730
:keyword allow_plugins: By default the subprocess is run with
1731
--no-plugins to ensure test reproducibility. Also, it is possible
1732
for system-wide plugins to create unexpected output on stderr,
1733
which can cause unnecessary test failures.
1735
env_changes = kwargs.get('env_changes', {})
1736
working_dir = kwargs.get('working_dir', None)
1737
allow_plugins = kwargs.get('allow_plugins', False)
1739
if isinstance(args[0], list):
1741
elif isinstance(args[0], basestring):
1742
args = list(shlex.split(args[0]))
1744
raise ValueError("passing varargs to run_bzr_subprocess")
1745
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1746
working_dir=working_dir,
1747
allow_plugins=allow_plugins)
1748
# We distinguish between retcode=None and retcode not passed.
1749
supplied_retcode = kwargs.get('retcode', 0)
1750
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1751
universal_newlines=kwargs.get('universal_newlines', False),
1754
def start_bzr_subprocess(self, process_args, env_changes=None,
1755
skip_if_plan_to_signal=False,
1757
allow_plugins=False):
1758
"""Start bzr in a subprocess for testing.
1760
This starts a new Python interpreter and runs bzr in there.
1761
This should only be used for tests that have a justifiable need for
1762
this isolation: e.g. they are testing startup time, or signal
1763
handling, or early startup code, etc. Subprocess code can't be
1764
profiled or debugged so easily.
1766
:param process_args: a list of arguments to pass to the bzr executable,
1767
for example ``['--version']``.
1768
:param env_changes: A dictionary which lists changes to environment
1769
variables. A value of None will unset the env variable.
1770
The values must be strings. The change will only occur in the
1771
child, so you don't need to fix the environment after running.
1772
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1774
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1776
:returns: Popen object for the started process.
1778
if skip_if_plan_to_signal:
1779
if not getattr(os, 'kill', None):
1780
raise TestSkipped("os.kill not available.")
1782
if env_changes is None:
1786
def cleanup_environment():
1787
for env_var, value in env_changes.iteritems():
1788
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1790
def restore_environment():
1791
for env_var, value in old_env.iteritems():
1792
osutils.set_or_unset_env(env_var, value)
1794
bzr_path = self.get_bzr_path()
1797
if working_dir is not None:
1798
cwd = osutils.getcwd()
1799
os.chdir(working_dir)
1802
# win32 subprocess doesn't support preexec_fn
1803
# so we will avoid using it on all platforms, just to
1804
# make sure the code path is used, and we don't break on win32
1805
cleanup_environment()
1806
command = [sys.executable]
1807
# frozen executables don't need the path to bzr
1808
if getattr(sys, "frozen", None) is None:
1809
command.append(bzr_path)
1810
if not allow_plugins:
1811
command.append('--no-plugins')
1812
command.extend(process_args)
1813
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1815
restore_environment()
1821
def _popen(self, *args, **kwargs):
1822
"""Place a call to Popen.
1824
Allows tests to override this method to intercept the calls made to
1825
Popen for introspection.
1827
return Popen(*args, **kwargs)
1829
def get_bzr_path(self):
1830
"""Return the path of the 'bzr' executable for this test suite."""
1831
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1832
if not os.path.isfile(bzr_path):
1833
# We are probably installed. Assume sys.argv is the right file
1834
bzr_path = sys.argv[0]
1837
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1838
universal_newlines=False, process_args=None):
1839
"""Finish the execution of process.
1841
:param process: the Popen object returned from start_bzr_subprocess.
1842
:param retcode: The status code that is expected. Defaults to 0. If
1843
None is supplied, the status code is not checked.
1844
:param send_signal: an optional signal to send to the process.
1845
:param universal_newlines: Convert CRLF => LF
1846
:returns: (stdout, stderr)
1848
if send_signal is not None:
1849
os.kill(process.pid, send_signal)
1850
out, err = process.communicate()
1852
if universal_newlines:
1853
out = out.replace('\r\n', '\n')
1854
err = err.replace('\r\n', '\n')
1856
if retcode is not None and retcode != process.returncode:
1857
if process_args is None:
1858
process_args = "(unknown args)"
1859
mutter('Output of bzr %s:\n%s', process_args, out)
1860
mutter('Error for bzr %s:\n%s', process_args, err)
1861
self.fail('Command bzr %s failed with retcode %s != %s'
1862
% (process_args, retcode, process.returncode))
1865
def check_inventory_shape(self, inv, shape):
1866
"""Compare an inventory to a list of expected names.
1868
Fail if they are not precisely equal.
1871
shape = list(shape) # copy
1872
for path, ie in inv.entries():
1873
name = path.replace('\\', '/')
1874
if ie.kind == 'directory':
1881
self.fail("expected paths not found in inventory: %r" % shape)
1883
self.fail("unexpected paths found in inventory: %r" % extras)
1885
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1886
a_callable=None, *args, **kwargs):
1887
"""Call callable with redirected std io pipes.
1889
Returns the return code."""
1890
if not callable(a_callable):
1891
raise ValueError("a_callable must be callable.")
1893
stdin = StringIO("")
1895
if getattr(self, "_log_file", None) is not None:
1896
stdout = self._log_file
1900
if getattr(self, "_log_file", None is not None):
1901
stderr = self._log_file
1904
real_stdin = sys.stdin
1905
real_stdout = sys.stdout
1906
real_stderr = sys.stderr
1911
return a_callable(*args, **kwargs)
1913
sys.stdout = real_stdout
1914
sys.stderr = real_stderr
1915
sys.stdin = real_stdin
1917
def reduceLockdirTimeout(self):
1918
"""Reduce the default lock timeout for the duration of the test, so that
1919
if LockContention occurs during a test, it does so quickly.
1921
Tests that expect to provoke LockContention errors should call this.
1923
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1925
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1926
self.addCleanup(resetTimeout)
1927
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1929
def make_utf8_encoded_stringio(self, encoding_type=None):
1930
"""Return a StringIOWrapper instance, that will encode Unicode
1933
if encoding_type is None:
1934
encoding_type = 'strict'
1936
output_encoding = 'utf-8'
1937
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1938
sio.encoding = output_encoding
1942
class CapturedCall(object):
1943
"""A helper for capturing smart server calls for easy debug analysis."""
1945
def __init__(self, params, prefix_length):
1946
"""Capture the call with params and skip prefix_length stack frames."""
1949
# The last 5 frames are the __init__, the hook frame, and 3 smart
1950
# client frames. Beyond this we could get more clever, but this is good
1952
stack = traceback.extract_stack()[prefix_length:-5]
1953
self.stack = ''.join(traceback.format_list(stack))
1956
return self.call.method
1959
return self.call.method
1965
class TestCaseWithMemoryTransport(TestCase):
1966
"""Common test class for tests that do not need disk resources.
1968
Tests that need disk resources should derive from TestCaseWithTransport.
1970
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1972
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1973
a directory which does not exist. This serves to help ensure test isolation
1974
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1975
must exist. However, TestCaseWithMemoryTransport does not offer local
1976
file defaults for the transport in tests, nor does it obey the command line
1977
override, so tests that accidentally write to the common directory should
1980
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1981
a .bzr directory that stops us ascending higher into the filesystem.
1987
def __init__(self, methodName='runTest'):
1988
# allow test parameterization after test construction and before test
1989
# execution. Variables that the parameterizer sets need to be
1990
# ones that are not set by setUp, or setUp will trash them.
1991
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1992
self.vfs_transport_factory = default_transport
1993
self.transport_server = None
1994
self.transport_readonly_server = None
1995
self.__vfs_server = None
1997
def get_transport(self, relpath=None):
1998
"""Return a writeable transport.
2000
This transport is for the test scratch space relative to
2003
:param relpath: a path relative to the base url.
2005
t = get_transport(self.get_url(relpath))
2006
self.assertFalse(t.is_readonly())
2009
def get_readonly_transport(self, relpath=None):
2010
"""Return a readonly transport for the test scratch space
2012
This can be used to test that operations which should only need
2013
readonly access in fact do not try to write.
2015
:param relpath: a path relative to the base url.
2017
t = get_transport(self.get_readonly_url(relpath))
2018
self.assertTrue(t.is_readonly())
2021
def create_transport_readonly_server(self):
2022
"""Create a transport server from class defined at init.
2024
This is mostly a hook for daughter classes.
2026
return self.transport_readonly_server()
2028
def get_readonly_server(self):
2029
"""Get the server instance for the readonly transport
2031
This is useful for some tests with specific servers to do diagnostics.
2033
if self.__readonly_server is None:
2034
if self.transport_readonly_server is None:
2035
# readonly decorator requested
2036
# bring up the server
2037
self.__readonly_server = ReadonlyServer()
2038
self.__readonly_server.setUp(self.get_vfs_only_server())
2040
self.__readonly_server = self.create_transport_readonly_server()
2041
self.__readonly_server.setUp(self.get_vfs_only_server())
2042
self.addCleanup(self.__readonly_server.tearDown)
2043
return self.__readonly_server
2045
def get_readonly_url(self, relpath=None):
2046
"""Get a URL for the readonly transport.
2048
This will either be backed by '.' or a decorator to the transport
2049
used by self.get_url()
2050
relpath provides for clients to get a path relative to the base url.
2051
These should only be downwards relative, not upwards.
2053
base = self.get_readonly_server().get_url()
2054
return self._adjust_url(base, relpath)
2056
def get_vfs_only_server(self):
2057
"""Get the vfs only read/write server instance.
2059
This is useful for some tests with specific servers that need
2062
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
2063
is no means to override it.
2065
if self.__vfs_server is None:
2066
self.__vfs_server = MemoryServer()
2067
self.__vfs_server.setUp()
2068
self.addCleanup(self.__vfs_server.tearDown)
2069
return self.__vfs_server
2071
def get_server(self):
2072
"""Get the read/write server instance.
2074
This is useful for some tests with specific servers that need
2077
This is built from the self.transport_server factory. If that is None,
2078
then the self.get_vfs_server is returned.
2080
if self.__server is None:
2081
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
2082
return self.get_vfs_only_server()
2084
# bring up a decorated means of access to the vfs only server.
2085
self.__server = self.transport_server()
2087
self.__server.setUp(self.get_vfs_only_server())
2088
except TypeError, e:
2089
# This should never happen; the try:Except here is to assist
2090
# developers having to update code rather than seeing an
2091
# uninformative TypeError.
2092
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
2093
self.addCleanup(self.__server.tearDown)
2094
return self.__server
2096
def _adjust_url(self, base, relpath):
2097
"""Get a URL (or maybe a path) for the readwrite transport.
2099
This will either be backed by '.' or to an equivalent non-file based
2101
relpath provides for clients to get a path relative to the base url.
2102
These should only be downwards relative, not upwards.
2104
if relpath is not None and relpath != '.':
2105
if not base.endswith('/'):
2107
# XXX: Really base should be a url; we did after all call
2108
# get_url()! But sometimes it's just a path (from
2109
# LocalAbspathServer), and it'd be wrong to append urlescaped data
2110
# to a non-escaped local path.
2111
if base.startswith('./') or base.startswith('/'):
2114
base += urlutils.escape(relpath)
2117
def get_url(self, relpath=None):
2118
"""Get a URL (or maybe a path) for the readwrite transport.
2120
This will either be backed by '.' or to an equivalent non-file based
2122
relpath provides for clients to get a path relative to the base url.
2123
These should only be downwards relative, not upwards.
2125
base = self.get_server().get_url()
2126
return self._adjust_url(base, relpath)
2128
def get_vfs_only_url(self, relpath=None):
2129
"""Get a URL (or maybe a path for the plain old vfs transport.
2131
This will never be a smart protocol. It always has all the
2132
capabilities of the local filesystem, but it might actually be a
2133
MemoryTransport or some other similar virtual filesystem.
2135
This is the backing transport (if any) of the server returned by
2136
get_url and get_readonly_url.
2138
:param relpath: provides for clients to get a path relative to the base
2139
url. These should only be downwards relative, not upwards.
2142
base = self.get_vfs_only_server().get_url()
2143
return self._adjust_url(base, relpath)
2145
def _create_safety_net(self):
2146
"""Make a fake bzr directory.
2148
This prevents any tests propagating up onto the TEST_ROOT directory's
2151
root = TestCaseWithMemoryTransport.TEST_ROOT
2152
bzrdir.BzrDir.create_standalone_workingtree(root)
2154
def _check_safety_net(self):
2155
"""Check that the safety .bzr directory have not been touched.
2157
_make_test_root have created a .bzr directory to prevent tests from
2158
propagating. This method ensures than a test did not leaked.
2160
root = TestCaseWithMemoryTransport.TEST_ROOT
2161
wt = workingtree.WorkingTree.open(root)
2162
last_rev = wt.last_revision()
2163
if last_rev != 'null:':
2164
# The current test have modified the /bzr directory, we need to
2165
# recreate a new one or all the followng tests will fail.
2166
# If you need to inspect its content uncomment the following line
2167
# import pdb; pdb.set_trace()
2168
_rmtree_temp_dir(root + '/.bzr')
2169
self._create_safety_net()
2170
raise AssertionError('%s/.bzr should not be modified' % root)
2172
def _make_test_root(self):
2173
if TestCaseWithMemoryTransport.TEST_ROOT is None:
2174
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
2175
TestCaseWithMemoryTransport.TEST_ROOT = root
2177
self._create_safety_net()
2179
# The same directory is used by all tests, and we're not
2180
# specifically told when all tests are finished. This will do.
2181
atexit.register(_rmtree_temp_dir, root)
2183
self.addCleanup(self._check_safety_net)
2185
def makeAndChdirToTestDir(self):
2186
"""Create a temporary directories for this one test.
2188
This must set self.test_home_dir and self.test_dir and chdir to
2191
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
2193
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2194
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
2195
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
2197
def make_branch(self, relpath, format=None):
2198
"""Create a branch on the transport at relpath."""
2199
repo = self.make_repository(relpath, format=format)
2200
return repo.bzrdir.create_branch()
2202
def make_bzrdir(self, relpath, format=None):
2204
# might be a relative or absolute path
2205
maybe_a_url = self.get_url(relpath)
2206
segments = maybe_a_url.rsplit('/', 1)
2207
t = get_transport(maybe_a_url)
2208
if len(segments) > 1 and segments[-1] not in ('', '.'):
2212
if isinstance(format, basestring):
2213
format = bzrdir.format_registry.make_bzrdir(format)
2214
return format.initialize_on_transport(t)
2215
except errors.UninitializableFormat:
2216
raise TestSkipped("Format %s is not initializable." % format)
2218
def make_repository(self, relpath, shared=False, format=None):
2219
"""Create a repository on our default transport at relpath.
2221
Note that relpath must be a relative path, not a full url.
2223
# FIXME: If you create a remoterepository this returns the underlying
2224
# real format, which is incorrect. Actually we should make sure that
2225
# RemoteBzrDir returns a RemoteRepository.
2226
# maybe mbp 20070410
2227
made_control = self.make_bzrdir(relpath, format=format)
2228
return made_control.create_repository(shared=shared)
2230
def make_smart_server(self, path):
2231
smart_server = server.SmartTCPServer_for_testing()
2232
smart_server.setUp(self.get_server())
2233
remote_transport = get_transport(smart_server.get_url()).clone(path)
2234
self.addCleanup(smart_server.tearDown)
2235
return remote_transport
2237
def make_branch_and_memory_tree(self, relpath, format=None):
2238
"""Create a branch on the default transport and a MemoryTree for it."""
2239
b = self.make_branch(relpath, format=format)
2240
return memorytree.MemoryTree.create_on_branch(b)
2242
def make_branch_builder(self, relpath, format=None):
2243
branch = self.make_branch(relpath, format=format)
2244
return branchbuilder.BranchBuilder(branch=branch)
2246
def overrideEnvironmentForTesting(self):
2247
os.environ['HOME'] = self.test_home_dir
2248
os.environ['BZR_HOME'] = self.test_home_dir
2251
super(TestCaseWithMemoryTransport, self).setUp()
2252
self._make_test_root()
2253
_currentdir = os.getcwdu()
2254
def _leaveDirectory():
2255
os.chdir(_currentdir)
2256
self.addCleanup(_leaveDirectory)
2257
self.makeAndChdirToTestDir()
2258
self.overrideEnvironmentForTesting()
2259
self.__readonly_server = None
2260
self.__server = None
2261
self.reduceLockdirTimeout()
2263
def setup_smart_server_with_call_log(self):
2264
"""Sets up a smart server as the transport server with a call log."""
2265
self.transport_server = server.SmartTCPServer_for_testing
2266
self.hpss_calls = []
2268
# Skip the current stack down to the caller of
2269
# setup_smart_server_with_call_log
2270
prefix_length = len(traceback.extract_stack()) - 2
2271
def capture_hpss_call(params):
2272
self.hpss_calls.append(
2273
CapturedCall(params, prefix_length))
2274
client._SmartClient.hooks.install_named_hook(
2275
'call', capture_hpss_call, None)
2277
def reset_smart_call_log(self):
2278
self.hpss_calls = []
2281
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2282
"""Derived class that runs a test within a temporary directory.
2284
This is useful for tests that need to create a branch, etc.
2286
The directory is created in a slightly complex way: for each
2287
Python invocation, a new temporary top-level directory is created.
2288
All test cases create their own directory within that. If the
2289
tests complete successfully, the directory is removed.
2291
:ivar test_base_dir: The path of the top-level directory for this
2292
test, which contains a home directory and a work directory.
2294
:ivar test_home_dir: An initially empty directory under test_base_dir
2295
which is used as $HOME for this test.
2297
:ivar test_dir: A directory under test_base_dir used as the current
2298
directory when the test proper is run.
2301
OVERRIDE_PYTHON = 'python'
2303
def check_file_contents(self, filename, expect):
2304
self.log("check contents of file %s" % filename)
2305
contents = file(filename, 'r').read()
2306
if contents != expect:
2307
self.log("expected: %r" % expect)
2308
self.log("actually: %r" % contents)
2309
self.fail("contents of %s not as expected" % filename)
2311
def _getTestDirPrefix(self):
2312
# create a directory within the top level test directory
2313
if sys.platform == 'win32':
2314
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2315
# windows is likely to have path-length limits so use a short name
2316
name_prefix = name_prefix[-30:]
2318
name_prefix = re.sub('[/]', '_', self.id())
2321
def makeAndChdirToTestDir(self):
2322
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2324
For TestCaseInTempDir we create a temporary directory based on the test
2325
name and then create two subdirs - test and home under it.
2327
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2328
self._getTestDirPrefix())
2330
for i in range(100):
2331
if os.path.exists(name):
2332
name = name_prefix + '_' + str(i)
2336
# now create test and home directories within this dir
2337
self.test_base_dir = name
2338
self.test_home_dir = self.test_base_dir + '/home'
2339
os.mkdir(self.test_home_dir)
2340
self.test_dir = self.test_base_dir + '/work'
2341
os.mkdir(self.test_dir)
2342
os.chdir(self.test_dir)
2343
# put name of test inside
2344
f = file(self.test_base_dir + '/name', 'w')
2349
self.addCleanup(self.deleteTestDir)
2351
def deleteTestDir(self):
2352
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2353
_rmtree_temp_dir(self.test_base_dir)
2355
def build_tree(self, shape, line_endings='binary', transport=None):
2356
"""Build a test tree according to a pattern.
2358
shape is a sequence of file specifications. If the final
2359
character is '/', a directory is created.
2361
This assumes that all the elements in the tree being built are new.
2363
This doesn't add anything to a branch.
2365
:type shape: list or tuple.
2366
:param line_endings: Either 'binary' or 'native'
2367
in binary mode, exact contents are written in native mode, the
2368
line endings match the default platform endings.
2369
:param transport: A transport to write to, for building trees on VFS's.
2370
If the transport is readonly or None, "." is opened automatically.
2373
if type(shape) not in (list, tuple):
2374
raise AssertionError("Parameter 'shape' should be "
2375
"a list or a tuple. Got %r instead" % (shape,))
2376
# It's OK to just create them using forward slashes on windows.
2377
if transport is None or transport.is_readonly():
2378
transport = get_transport(".")
2380
self.assertIsInstance(name, basestring)
2382
transport.mkdir(urlutils.escape(name[:-1]))
2384
if line_endings == 'binary':
2386
elif line_endings == 'native':
2389
raise errors.BzrError(
2390
'Invalid line ending request %r' % line_endings)
2391
content = "contents of %s%s" % (name.encode('utf-8'), end)
2392
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2394
def build_tree_contents(self, shape):
2395
build_tree_contents(shape)
2397
def assertInWorkingTree(self, path, root_path='.', tree=None):
2398
"""Assert whether path or paths are in the WorkingTree"""
2400
tree = workingtree.WorkingTree.open(root_path)
2401
if not isinstance(path, basestring):
2403
self.assertInWorkingTree(p, tree=tree)
2405
self.assertIsNot(tree.path2id(path), None,
2406
path+' not in working tree.')
2408
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2409
"""Assert whether path or paths are not in the WorkingTree"""
2411
tree = workingtree.WorkingTree.open(root_path)
2412
if not isinstance(path, basestring):
2414
self.assertNotInWorkingTree(p,tree=tree)
2416
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2419
class TestCaseWithTransport(TestCaseInTempDir):
2420
"""A test case that provides get_url and get_readonly_url facilities.
2422
These back onto two transport servers, one for readonly access and one for
2425
If no explicit class is provided for readonly access, a
2426
ReadonlyTransportDecorator is used instead which allows the use of non disk
2427
based read write transports.
2429
If an explicit class is provided for readonly access, that server and the
2430
readwrite one must both define get_url() as resolving to os.getcwd().
2433
def get_vfs_only_server(self):
2434
"""See TestCaseWithMemoryTransport.
2436
This is useful for some tests with specific servers that need
2439
if self.__vfs_server is None:
2440
self.__vfs_server = self.vfs_transport_factory()
2441
self.__vfs_server.setUp()
2442
self.addCleanup(self.__vfs_server.tearDown)
2443
return self.__vfs_server
2445
def make_branch_and_tree(self, relpath, format=None):
2446
"""Create a branch on the transport and a tree locally.
2448
If the transport is not a LocalTransport, the Tree can't be created on
2449
the transport. In that case if the vfs_transport_factory is
2450
LocalURLServer the working tree is created in the local
2451
directory backing the transport, and the returned tree's branch and
2452
repository will also be accessed locally. Otherwise a lightweight
2453
checkout is created and returned.
2455
:param format: The BzrDirFormat.
2456
:returns: the WorkingTree.
2458
# TODO: always use the local disk path for the working tree,
2459
# this obviously requires a format that supports branch references
2460
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2462
b = self.make_branch(relpath, format=format)
2464
return b.bzrdir.create_workingtree()
2465
except errors.NotLocalUrl:
2466
# We can only make working trees locally at the moment. If the
2467
# transport can't support them, then we keep the non-disk-backed
2468
# branch and create a local checkout.
2469
if self.vfs_transport_factory is LocalURLServer:
2470
# the branch is colocated on disk, we cannot create a checkout.
2471
# hopefully callers will expect this.
2472
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2473
wt = local_controldir.create_workingtree()
2474
if wt.branch._format != b._format:
2476
# Make sure that assigning to wt._branch fixes wt.branch,
2477
# in case the implementation details of workingtree objects
2479
self.assertIs(b, wt.branch)
2482
return b.create_checkout(relpath, lightweight=True)
2484
def assertIsDirectory(self, relpath, transport):
2485
"""Assert that relpath within transport is a directory.
2487
This may not be possible on all transports; in that case it propagates
2488
a TransportNotPossible.
2491
mode = transport.stat(relpath).st_mode
2492
except errors.NoSuchFile:
2493
self.fail("path %s is not a directory; no such file"
2495
if not stat.S_ISDIR(mode):
2496
self.fail("path %s is not a directory; has mode %#o"
2499
def assertTreesEqual(self, left, right):
2500
"""Check that left and right have the same content and properties."""
2501
# we use a tree delta to check for equality of the content, and we
2502
# manually check for equality of other things such as the parents list.
2503
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2504
differences = left.changes_from(right)
2505
self.assertFalse(differences.has_changed(),
2506
"Trees %r and %r are different: %r" % (left, right, differences))
2509
super(TestCaseWithTransport, self).setUp()
2510
self.__vfs_server = None
2513
class ChrootedTestCase(TestCaseWithTransport):
2514
"""A support class that provides readonly urls outside the local namespace.
2516
This is done by checking if self.transport_server is a MemoryServer. if it
2517
is then we are chrooted already, if it is not then an HttpServer is used
2520
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2521
be used without needed to redo it when a different
2522
subclass is in use ?
2526
super(ChrootedTestCase, self).setUp()
2527
if not self.vfs_transport_factory == MemoryServer:
2528
self.transport_readonly_server = HttpServer
2531
def condition_id_re(pattern):
2532
"""Create a condition filter which performs a re check on a test's id.
2534
:param pattern: A regular expression string.
2535
:return: A callable that returns True if the re matches.
2537
filter_re = osutils.re_compile_checked(pattern, 0,
2539
def condition(test):
2541
return filter_re.search(test_id)
2545
def condition_isinstance(klass_or_klass_list):
2546
"""Create a condition filter which returns isinstance(param, klass).
2548
:return: A callable which when called with one parameter obj return the
2549
result of isinstance(obj, klass_or_klass_list).
2552
return isinstance(obj, klass_or_klass_list)
2556
def condition_id_in_list(id_list):
2557
"""Create a condition filter which verify that test's id in a list.
2559
:param id_list: A TestIdList object.
2560
:return: A callable that returns True if the test's id appears in the list.
2562
def condition(test):
2563
return id_list.includes(test.id())
2567
def condition_id_startswith(starts):
2568
"""Create a condition filter verifying that test's id starts with a string.
2570
:param starts: A list of string.
2571
:return: A callable that returns True if the test's id starts with one of
2574
def condition(test):
2575
for start in starts:
2576
if test.id().startswith(start):
2582
def exclude_tests_by_condition(suite, condition):
2583
"""Create a test suite which excludes some tests from suite.
2585
:param suite: The suite to get tests from.
2586
:param condition: A callable whose result evaluates True when called with a
2587
test case which should be excluded from the result.
2588
:return: A suite which contains the tests found in suite that fail
2592
for test in iter_suite_tests(suite):
2593
if not condition(test):
2595
return TestUtil.TestSuite(result)
2598
def filter_suite_by_condition(suite, condition):
2599
"""Create a test suite by filtering another one.
2601
:param suite: The source suite.
2602
:param condition: A callable whose result evaluates True when called with a
2603
test case which should be included in the result.
2604
:return: A suite which contains the tests found in suite that pass
2608
for test in iter_suite_tests(suite):
2611
return TestUtil.TestSuite(result)
2614
def filter_suite_by_re(suite, pattern):
2615
"""Create a test suite by filtering another one.
2617
:param suite: the source suite
2618
:param pattern: pattern that names must match
2619
:returns: the newly created suite
2621
condition = condition_id_re(pattern)
2622
result_suite = filter_suite_by_condition(suite, condition)
2626
def filter_suite_by_id_list(suite, test_id_list):
2627
"""Create a test suite by filtering another one.
2629
:param suite: The source suite.
2630
:param test_id_list: A list of the test ids to keep as strings.
2631
:returns: the newly created suite
2633
condition = condition_id_in_list(test_id_list)
2634
result_suite = filter_suite_by_condition(suite, condition)
2638
def filter_suite_by_id_startswith(suite, start):
2639
"""Create a test suite by filtering another one.
2641
:param suite: The source suite.
2642
:param start: A list of string the test id must start with one of.
2643
:returns: the newly created suite
2645
condition = condition_id_startswith(start)
2646
result_suite = filter_suite_by_condition(suite, condition)
2650
def exclude_tests_by_re(suite, pattern):
2651
"""Create a test suite which excludes some tests from suite.
2653
:param suite: The suite to get tests from.
2654
:param pattern: A regular expression string. Test ids that match this
2655
pattern will be excluded from the result.
2656
:return: A TestSuite that contains all the tests from suite without the
2657
tests that matched pattern. The order of tests is the same as it was in
2660
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2663
def preserve_input(something):
2664
"""A helper for performing test suite transformation chains.
2666
:param something: Anything you want to preserve.
2672
def randomize_suite(suite):
2673
"""Return a new TestSuite with suite's tests in random order.
2675
The tests in the input suite are flattened into a single suite in order to
2676
accomplish this. Any nested TestSuites are removed to provide global
2679
tests = list(iter_suite_tests(suite))
2680
random.shuffle(tests)
2681
return TestUtil.TestSuite(tests)
2684
def split_suite_by_condition(suite, condition):
2685
"""Split a test suite into two by a condition.
2687
:param suite: The suite to split.
2688
:param condition: The condition to match on. Tests that match this
2689
condition are returned in the first test suite, ones that do not match
2690
are in the second suite.
2691
:return: A tuple of two test suites, where the first contains tests from
2692
suite matching the condition, and the second contains the remainder
2693
from suite. The order within each output suite is the same as it was in
2698
for test in iter_suite_tests(suite):
2700
matched.append(test)
2702
did_not_match.append(test)
2703
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2706
def split_suite_by_re(suite, pattern):
2707
"""Split a test suite into two by a regular expression.
2709
:param suite: The suite to split.
2710
:param pattern: A regular expression string. Test ids that match this
2711
pattern will be in the first test suite returned, and the others in the
2712
second test suite returned.
2713
:return: A tuple of two test suites, where the first contains tests from
2714
suite matching pattern, and the second contains the remainder from
2715
suite. The order within each output suite is the same as it was in
2718
return split_suite_by_condition(suite, condition_id_re(pattern))
2721
def run_suite(suite, name='test', verbose=False, pattern=".*",
2722
stop_on_failure=False,
2723
transport=None, lsprof_timed=None, bench_history=None,
2724
matching_tests_first=None,
2727
exclude_pattern=None,
2730
suite_decorators=None,
2732
"""Run a test suite for bzr selftest.
2734
:param runner_class: The class of runner to use. Must support the
2735
constructor arguments passed by run_suite which are more than standard
2737
:return: A boolean indicating success.
2739
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2744
if runner_class is None:
2745
runner_class = TextTestRunner
2748
runner = runner_class(stream=stream,
2750
verbosity=verbosity,
2751
bench_history=bench_history,
2752
list_only=list_only,
2755
runner.stop_on_failure=stop_on_failure
2756
# built in decorator factories:
2758
random_order(random_seed, runner),
2759
exclude_tests(exclude_pattern),
2761
if matching_tests_first:
2762
decorators.append(tests_first(pattern))
2764
decorators.append(filter_tests(pattern))
2765
if suite_decorators:
2766
decorators.extend(suite_decorators)
2767
# tell the result object how many tests will be running:
2768
decorators.append(CountingDecorator)
2769
for decorator in decorators:
2770
suite = decorator(suite)
2771
result = runner.run(suite)
2776
return result.wasStrictlySuccessful()
2778
return result.wasSuccessful()
2781
# A registry where get() returns a suite decorator.
2782
parallel_registry = registry.Registry()
2785
def fork_decorator(suite):
2786
concurrency = osutils.local_concurrency()
2787
if concurrency == 1:
2789
from testtools import ConcurrentTestSuite
2790
return ConcurrentTestSuite(suite, fork_for_tests)
2791
parallel_registry.register('fork', fork_decorator)
2794
def subprocess_decorator(suite):
2795
concurrency = osutils.local_concurrency()
2796
if concurrency == 1:
2798
from testtools import ConcurrentTestSuite
2799
return ConcurrentTestSuite(suite, reinvoke_for_tests)
2800
parallel_registry.register('subprocess', subprocess_decorator)
2803
def exclude_tests(exclude_pattern):
2804
"""Return a test suite decorator that excludes tests."""
2805
if exclude_pattern is None:
2806
return identity_decorator
2807
def decorator(suite):
2808
return ExcludeDecorator(suite, exclude_pattern)
2812
def filter_tests(pattern):
2814
return identity_decorator
2815
def decorator(suite):
2816
return FilterTestsDecorator(suite, pattern)
2820
def random_order(random_seed, runner):
2821
"""Return a test suite decorator factory for randomising tests order.
2823
:param random_seed: now, a string which casts to a long, or a long.
2824
:param runner: A test runner with a stream attribute to report on.
2826
if random_seed is None:
2827
return identity_decorator
2828
def decorator(suite):
2829
return RandomDecorator(suite, random_seed, runner.stream)
2833
def tests_first(pattern):
2835
return identity_decorator
2836
def decorator(suite):
2837
return TestFirstDecorator(suite, pattern)
2841
def identity_decorator(suite):
2846
class TestDecorator(TestSuite):
2847
"""A decorator for TestCase/TestSuite objects.
2849
Usually, subclasses should override __iter__(used when flattening test
2850
suites), which we do to filter, reorder, parallelise and so on, run() and
2854
def __init__(self, suite):
2855
TestSuite.__init__(self)
2858
def countTestCases(self):
2861
cases += test.countTestCases()
2868
def run(self, result):
2869
# Use iteration on self, not self._tests, to allow subclasses to hook
2872
if result.shouldStop:
2878
class CountingDecorator(TestDecorator):
2879
"""A decorator which calls result.progress(self.countTestCases)."""
2881
def run(self, result):
2882
progress_method = getattr(result, 'progress', None)
2883
if callable(progress_method):
2884
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
2885
return super(CountingDecorator, self).run(result)
2888
class ExcludeDecorator(TestDecorator):
2889
"""A decorator which excludes test matching an exclude pattern."""
2891
def __init__(self, suite, exclude_pattern):
2892
TestDecorator.__init__(self, suite)
2893
self.exclude_pattern = exclude_pattern
2894
self.excluded = False
2898
return iter(self._tests)
2899
self.excluded = True
2900
suite = exclude_tests_by_re(self, self.exclude_pattern)
2902
self.addTests(suite)
2903
return iter(self._tests)
2906
class FilterTestsDecorator(TestDecorator):
2907
"""A decorator which filters tests to those matching a pattern."""
2909
def __init__(self, suite, pattern):
2910
TestDecorator.__init__(self, suite)
2911
self.pattern = pattern
2912
self.filtered = False
2916
return iter(self._tests)
2917
self.filtered = True
2918
suite = filter_suite_by_re(self, self.pattern)
2920
self.addTests(suite)
2921
return iter(self._tests)
2924
class RandomDecorator(TestDecorator):
2925
"""A decorator which randomises the order of its tests."""
2927
def __init__(self, suite, random_seed, stream):
2928
TestDecorator.__init__(self, suite)
2929
self.random_seed = random_seed
2930
self.randomised = False
2931
self.stream = stream
2935
return iter(self._tests)
2936
self.randomised = True
2937
self.stream.writeln("Randomizing test order using seed %s\n" %
2938
(self.actual_seed()))
2939
# Initialise the random number generator.
2940
random.seed(self.actual_seed())
2941
suite = randomize_suite(self)
2943
self.addTests(suite)
2944
return iter(self._tests)
2946
def actual_seed(self):
2947
if self.random_seed == "now":
2948
# We convert the seed to a long to make it reuseable across
2949
# invocations (because the user can reenter it).
2950
self.random_seed = long(time.time())
2952
# Convert the seed to a long if we can
2954
self.random_seed = long(self.random_seed)
2957
return self.random_seed
2960
class TestFirstDecorator(TestDecorator):
2961
"""A decorator which moves named tests to the front."""
2963
def __init__(self, suite, pattern):
2964
TestDecorator.__init__(self, suite)
2965
self.pattern = pattern
2966
self.filtered = False
2970
return iter(self._tests)
2971
self.filtered = True
2972
suites = split_suite_by_re(self, self.pattern)
2974
self.addTests(suites)
2975
return iter(self._tests)
2978
def partition_tests(suite, count):
2979
"""Partition suite into count lists of tests."""
2981
tests = list(iter_suite_tests(suite))
2982
tests_per_process = int(math.ceil(float(len(tests)) / count))
2983
for block in range(count):
2984
low_test = block * tests_per_process
2985
high_test = low_test + tests_per_process
2986
process_tests = tests[low_test:high_test]
2987
result.append(process_tests)
2991
def fork_for_tests(suite):
2992
"""Take suite and start up one runner per CPU by forking()
2994
:return: An iterable of TestCase-like objects which can each have
2995
run(result) called on them to feed tests to result.
2997
concurrency = osutils.local_concurrency()
2999
from subunit import TestProtocolClient, ProtocolTestCase
3001
from subunit.test_results import AutoTimingTestResultDecorator
3003
AutoTimingTestResultDecorator = lambda x:x
3004
class TestInOtherProcess(ProtocolTestCase):
3005
# Should be in subunit, I think. RBC.
3006
def __init__(self, stream, pid):
3007
ProtocolTestCase.__init__(self, stream)
3010
def run(self, result):
3012
ProtocolTestCase.run(self, result)
3014
os.waitpid(self.pid, os.WNOHANG)
3016
test_blocks = partition_tests(suite, concurrency)
3017
for process_tests in test_blocks:
3018
process_suite = TestSuite()
3019
process_suite.addTests(process_tests)
3020
c2pread, c2pwrite = os.pipe()
3025
# Leave stderr and stdout open so we can see test noise
3026
# Close stdin so that the child goes away if it decides to
3027
# read from stdin (otherwise its a roulette to see what
3028
# child actually gets keystrokes for pdb etc).
3031
stream = os.fdopen(c2pwrite, 'wb', 1)
3032
subunit_result = AutoTimingTestResultDecorator(
3033
TestProtocolClient(stream))
3034
process_suite.run(subunit_result)
3039
stream = os.fdopen(c2pread, 'rb', 1)
3040
test = TestInOtherProcess(stream, pid)
3045
def reinvoke_for_tests(suite):
3046
"""Take suite and start up one runner per CPU using subprocess().
3048
:return: An iterable of TestCase-like objects which can each have
3049
run(result) called on them to feed tests to result.
3051
concurrency = osutils.local_concurrency()
3053
from subunit import ProtocolTestCase
3054
class TestInSubprocess(ProtocolTestCase):
3055
def __init__(self, process, name):
3056
ProtocolTestCase.__init__(self, process.stdout)
3057
self.process = process
3058
self.process.stdin.close()
3061
def run(self, result):
3063
ProtocolTestCase.run(self, result)
3066
os.unlink(self.name)
3067
# print "pid %d finished" % finished_process
3068
test_blocks = partition_tests(suite, concurrency)
3069
for process_tests in test_blocks:
3070
# ugly; currently reimplement rather than reuses TestCase methods.
3071
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3072
if not os.path.isfile(bzr_path):
3073
# We are probably installed. Assume sys.argv is the right file
3074
bzr_path = sys.argv[0]
3075
fd, test_list_file_name = tempfile.mkstemp()
3076
test_list_file = os.fdopen(fd, 'wb', 1)
3077
for test in process_tests:
3078
test_list_file.write(test.id() + '\n')
3079
test_list_file.close()
3081
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3083
if '--no-plugins' in sys.argv:
3084
argv.append('--no-plugins')
3085
# stderr=STDOUT would be ideal, but until we prevent noise on
3086
# stderr it can interrupt the subunit protocol.
3087
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3089
test = TestInSubprocess(process, test_list_file_name)
3092
os.unlink(test_list_file_name)
3097
class BZRTransformingResult(unittest.TestResult):
3099
def __init__(self, target):
3100
unittest.TestResult.__init__(self)
3101
self.result = target
3103
def startTest(self, test):
3104
self.result.startTest(test)
3106
def stopTest(self, test):
3107
self.result.stopTest(test)
3109
def addError(self, test, err):
3110
feature = self._error_looks_like('UnavailableFeature: ', err)
3111
if feature is not None:
3112
self.result.addNotSupported(test, feature)
3114
self.result.addError(test, err)
3116
def addFailure(self, test, err):
3117
known = self._error_looks_like('KnownFailure: ', err)
3118
if known is not None:
3119
self.result._addKnownFailure(test, [KnownFailure,
3120
KnownFailure(known), None])
3122
self.result.addFailure(test, err)
3124
def addSkip(self, test, reason):
3125
self.result.addSkip(test, reason)
3127
def addSuccess(self, test):
3128
self.result.addSuccess(test)
3130
def _error_looks_like(self, prefix, err):
3131
"""Deserialize exception and returns the stringify value."""
3135
if isinstance(exc, subunit.RemoteException):
3136
# stringify the exception gives access to the remote traceback
3137
# We search the last line for 'prefix'
3138
lines = str(exc).split('\n')
3139
while lines and not lines[-1]:
3142
if lines[-1].startswith(prefix):
3143
value = lines[-1][len(prefix):]
3147
# Controlled by "bzr selftest -E=..." option
3148
selftest_debug_flags = set()
3151
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3153
test_suite_factory=None,
3156
matching_tests_first=None,
3159
exclude_pattern=None,
3165
suite_decorators=None,
3167
"""Run the whole test suite under the enhanced runner"""
3168
# XXX: Very ugly way to do this...
3169
# Disable warning about old formats because we don't want it to disturb
3170
# any blackbox tests.
3171
from bzrlib import repository
3172
repository._deprecation_warning_done = True
3174
global default_transport
3175
if transport is None:
3176
transport = default_transport
3177
old_transport = default_transport
3178
default_transport = transport
3179
global selftest_debug_flags
3180
old_debug_flags = selftest_debug_flags
3181
if debug_flags is not None:
3182
selftest_debug_flags = set(debug_flags)
3184
if load_list is None:
3187
keep_only = load_test_id_list(load_list)
3188
if test_suite_factory is None:
3189
suite = test_suite(keep_only, starting_with)
3191
suite = test_suite_factory()
3192
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3193
stop_on_failure=stop_on_failure,
3194
transport=transport,
3195
lsprof_timed=lsprof_timed,
3196
bench_history=bench_history,
3197
matching_tests_first=matching_tests_first,
3198
list_only=list_only,
3199
random_seed=random_seed,
3200
exclude_pattern=exclude_pattern,
3202
runner_class=runner_class,
3203
suite_decorators=suite_decorators,
3206
default_transport = old_transport
3207
selftest_debug_flags = old_debug_flags
3210
def load_test_id_list(file_name):
3211
"""Load a test id list from a text file.
3213
The format is one test id by line. No special care is taken to impose
3214
strict rules, these test ids are used to filter the test suite so a test id
3215
that do not match an existing test will do no harm. This allows user to add
3216
comments, leave blank lines, etc.
3220
ftest = open(file_name, 'rt')
3222
if e.errno != errno.ENOENT:
3225
raise errors.NoSuchFile(file_name)
3227
for test_name in ftest.readlines():
3228
test_list.append(test_name.strip())
3233
def suite_matches_id_list(test_suite, id_list):
3234
"""Warns about tests not appearing or appearing more than once.
3236
:param test_suite: A TestSuite object.
3237
:param test_id_list: The list of test ids that should be found in
3240
:return: (absents, duplicates) absents is a list containing the test found
3241
in id_list but not in test_suite, duplicates is a list containing the
3242
test found multiple times in test_suite.
3244
When using a prefined test id list, it may occurs that some tests do not
3245
exist anymore or that some tests use the same id. This function warns the
3246
tester about potential problems in his workflow (test lists are volatile)
3247
or in the test suite itself (using the same id for several tests does not
3248
help to localize defects).
3250
# Build a dict counting id occurrences
3252
for test in iter_suite_tests(test_suite):
3254
tests[id] = tests.get(id, 0) + 1
3259
occurs = tests.get(id, 0)
3261
not_found.append(id)
3263
duplicates.append(id)
3265
return not_found, duplicates
3268
class TestIdList(object):
3269
"""Test id list to filter a test suite.
3271
Relying on the assumption that test ids are built as:
3272
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3273
notation, this class offers methods to :
3274
- avoid building a test suite for modules not refered to in the test list,
3275
- keep only the tests listed from the module test suite.
3278
def __init__(self, test_id_list):
3279
# When a test suite needs to be filtered against us we compare test ids
3280
# for equality, so a simple dict offers a quick and simple solution.
3281
self.tests = dict().fromkeys(test_id_list, True)
3283
# While unittest.TestCase have ids like:
3284
# <module>.<class>.<method>[(<param+)],
3285
# doctest.DocTestCase can have ids like:
3288
# <module>.<function>
3289
# <module>.<class>.<method>
3291
# Since we can't predict a test class from its name only, we settle on
3292
# a simple constraint: a test id always begins with its module name.
3295
for test_id in test_id_list:
3296
parts = test_id.split('.')
3297
mod_name = parts.pop(0)
3298
modules[mod_name] = True
3300
mod_name += '.' + part
3301
modules[mod_name] = True
3302
self.modules = modules
3304
def refers_to(self, module_name):
3305
"""Is there tests for the module or one of its sub modules."""
3306
return self.modules.has_key(module_name)
3308
def includes(self, test_id):
3309
return self.tests.has_key(test_id)
3312
class TestPrefixAliasRegistry(registry.Registry):
3313
"""A registry for test prefix aliases.
3315
This helps implement shorcuts for the --starting-with selftest
3316
option. Overriding existing prefixes is not allowed but not fatal (a
3317
warning will be emitted).
3320
def register(self, key, obj, help=None, info=None,
3321
override_existing=False):
3322
"""See Registry.register.
3324
Trying to override an existing alias causes a warning to be emitted,
3325
not a fatal execption.
3328
super(TestPrefixAliasRegistry, self).register(
3329
key, obj, help=help, info=info, override_existing=False)
3331
actual = self.get(key)
3332
note('Test prefix alias %s is already used for %s, ignoring %s'
3333
% (key, actual, obj))
3335
def resolve_alias(self, id_start):
3336
"""Replace the alias by the prefix in the given string.
3338
Using an unknown prefix is an error to help catching typos.
3340
parts = id_start.split('.')
3342
parts[0] = self.get(parts[0])
3344
raise errors.BzrCommandError(
3345
'%s is not a known test prefix alias' % parts[0])
3346
return '.'.join(parts)
3349
test_prefix_alias_registry = TestPrefixAliasRegistry()
3350
"""Registry of test prefix aliases."""
3353
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3354
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3355
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3357
# Obvious higest levels prefixes, feel free to add your own via a plugin
3358
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3359
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3360
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3361
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3362
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3365
def test_suite(keep_only=None, starting_with=None):
3366
"""Build and return TestSuite for the whole of bzrlib.
3368
:param keep_only: A list of test ids limiting the suite returned.
3370
:param starting_with: An id limiting the suite returned to the tests
3373
This function can be replaced if you need to change the default test
3374
suite on a global basis, but it is not encouraged.
3378
'bzrlib.tests.blackbox',
3379
'bzrlib.tests.commands',
3380
'bzrlib.tests.per_branch',
3381
'bzrlib.tests.per_bzrdir',
3382
'bzrlib.tests.per_interrepository',
3383
'bzrlib.tests.per_intertree',
3384
'bzrlib.tests.per_inventory',
3385
'bzrlib.tests.per_interbranch',
3386
'bzrlib.tests.per_lock',
3387
'bzrlib.tests.per_transport',
3388
'bzrlib.tests.per_tree',
3389
'bzrlib.tests.per_pack_repository',
3390
'bzrlib.tests.per_repository',
3391
'bzrlib.tests.per_repository_chk',
3392
'bzrlib.tests.per_repository_reference',
3393
'bzrlib.tests.per_workingtree',
3394
'bzrlib.tests.test__annotator',
3395
'bzrlib.tests.test__chk_map',
3396
'bzrlib.tests.test__dirstate_helpers',
3397
'bzrlib.tests.test__groupcompress',
3398
'bzrlib.tests.test__known_graph',
3399
'bzrlib.tests.test__rio',
3400
'bzrlib.tests.test__walkdirs_win32',
3401
'bzrlib.tests.test_ancestry',
3402
'bzrlib.tests.test_annotate',
3403
'bzrlib.tests.test_api',
3404
'bzrlib.tests.test_atomicfile',
3405
'bzrlib.tests.test_bad_files',
3406
'bzrlib.tests.test_bencode',
3407
'bzrlib.tests.test_bisect_multi',
3408
'bzrlib.tests.test_branch',
3409
'bzrlib.tests.test_branchbuilder',
3410
'bzrlib.tests.test_btree_index',
3411
'bzrlib.tests.test_bugtracker',
3412
'bzrlib.tests.test_bundle',
3413
'bzrlib.tests.test_bzrdir',
3414
'bzrlib.tests.test__chunks_to_lines',
3415
'bzrlib.tests.test_cache_utf8',
3416
'bzrlib.tests.test_chk_map',
3417
'bzrlib.tests.test_chk_serializer',
3418
'bzrlib.tests.test_chunk_writer',
3419
'bzrlib.tests.test_clean_tree',
3420
'bzrlib.tests.test_commands',
3421
'bzrlib.tests.test_commit',
3422
'bzrlib.tests.test_commit_merge',
3423
'bzrlib.tests.test_config',
3424
'bzrlib.tests.test_conflicts',
3425
'bzrlib.tests.test_counted_lock',
3426
'bzrlib.tests.test_decorators',
3427
'bzrlib.tests.test_delta',
3428
'bzrlib.tests.test_debug',
3429
'bzrlib.tests.test_deprecated_graph',
3430
'bzrlib.tests.test_diff',
3431
'bzrlib.tests.test_directory_service',
3432
'bzrlib.tests.test_dirstate',
3433
'bzrlib.tests.test_email_message',
3434
'bzrlib.tests.test_eol_filters',
3435
'bzrlib.tests.test_errors',
3436
'bzrlib.tests.test_export',
3437
'bzrlib.tests.test_extract',
3438
'bzrlib.tests.test_fetch',
3439
'bzrlib.tests.test_fifo_cache',
3440
'bzrlib.tests.test_filters',
3441
'bzrlib.tests.test_ftp_transport',
3442
'bzrlib.tests.test_foreign',
3443
'bzrlib.tests.test_generate_docs',
3444
'bzrlib.tests.test_generate_ids',
3445
'bzrlib.tests.test_globbing',
3446
'bzrlib.tests.test_gpg',
3447
'bzrlib.tests.test_graph',
3448
'bzrlib.tests.test_groupcompress',
3449
'bzrlib.tests.test_hashcache',
3450
'bzrlib.tests.test_help',
3451
'bzrlib.tests.test_hooks',
3452
'bzrlib.tests.test_http',
3453
'bzrlib.tests.test_http_response',
3454
'bzrlib.tests.test_https_ca_bundle',
3455
'bzrlib.tests.test_identitymap',
3456
'bzrlib.tests.test_ignores',
3457
'bzrlib.tests.test_index',
3458
'bzrlib.tests.test_info',
3459
'bzrlib.tests.test_inv',
3460
'bzrlib.tests.test_inventory_delta',
3461
'bzrlib.tests.test_knit',
3462
'bzrlib.tests.test_lazy_import',
3463
'bzrlib.tests.test_lazy_regex',
3464
'bzrlib.tests.test_lockable_files',
3465
'bzrlib.tests.test_lockdir',
3466
'bzrlib.tests.test_log',
3467
'bzrlib.tests.test_lru_cache',
3468
'bzrlib.tests.test_lsprof',
3469
'bzrlib.tests.test_mail_client',
3470
'bzrlib.tests.test_memorytree',
3471
'bzrlib.tests.test_merge',
3472
'bzrlib.tests.test_merge3',
3473
'bzrlib.tests.test_merge_core',
3474
'bzrlib.tests.test_merge_directive',
3475
'bzrlib.tests.test_missing',
3476
'bzrlib.tests.test_msgeditor',
3477
'bzrlib.tests.test_multiparent',
3478
'bzrlib.tests.test_mutabletree',
3479
'bzrlib.tests.test_nonascii',
3480
'bzrlib.tests.test_options',
3481
'bzrlib.tests.test_osutils',
3482
'bzrlib.tests.test_osutils_encodings',
3483
'bzrlib.tests.test_pack',
3484
'bzrlib.tests.test_patch',
3485
'bzrlib.tests.test_patches',
3486
'bzrlib.tests.test_permissions',
3487
'bzrlib.tests.test_plugins',
3488
'bzrlib.tests.test_progress',
3489
'bzrlib.tests.test_read_bundle',
3490
'bzrlib.tests.test_reconcile',
3491
'bzrlib.tests.test_reconfigure',
3492
'bzrlib.tests.test_registry',
3493
'bzrlib.tests.test_remote',
3494
'bzrlib.tests.test_rename_map',
3495
'bzrlib.tests.test_repository',
3496
'bzrlib.tests.test_revert',
3497
'bzrlib.tests.test_revision',
3498
'bzrlib.tests.test_revisionspec',
3499
'bzrlib.tests.test_revisiontree',
3500
'bzrlib.tests.test_rio',
3501
'bzrlib.tests.test_rules',
3502
'bzrlib.tests.test_sampler',
3503
'bzrlib.tests.test_selftest',
3504
'bzrlib.tests.test_serializer',
3505
'bzrlib.tests.test_setup',
3506
'bzrlib.tests.test_sftp_transport',
3507
'bzrlib.tests.test_shelf',
3508
'bzrlib.tests.test_shelf_ui',
3509
'bzrlib.tests.test_smart',
3510
'bzrlib.tests.test_smart_add',
3511
'bzrlib.tests.test_smart_request',
3512
'bzrlib.tests.test_smart_transport',
3513
'bzrlib.tests.test_smtp_connection',
3514
'bzrlib.tests.test_source',
3515
'bzrlib.tests.test_ssh_transport',
3516
'bzrlib.tests.test_status',
3517
'bzrlib.tests.test_store',
3518
'bzrlib.tests.test_strace',
3519
'bzrlib.tests.test_subsume',
3520
'bzrlib.tests.test_switch',
3521
'bzrlib.tests.test_symbol_versioning',
3522
'bzrlib.tests.test_tag',
3523
'bzrlib.tests.test_testament',
3524
'bzrlib.tests.test_textfile',
3525
'bzrlib.tests.test_textmerge',
3526
'bzrlib.tests.test_timestamp',
3527
'bzrlib.tests.test_trace',
3528
'bzrlib.tests.test_transactions',
3529
'bzrlib.tests.test_transform',
3530
'bzrlib.tests.test_transport',
3531
'bzrlib.tests.test_transport_log',
3532
'bzrlib.tests.test_tree',
3533
'bzrlib.tests.test_treebuilder',
3534
'bzrlib.tests.test_tsort',
3535
'bzrlib.tests.test_tuned_gzip',
3536
'bzrlib.tests.test_ui',
3537
'bzrlib.tests.test_uncommit',
3538
'bzrlib.tests.test_upgrade',
3539
'bzrlib.tests.test_upgrade_stacked',
3540
'bzrlib.tests.test_urlutils',
3541
'bzrlib.tests.test_version',
3542
'bzrlib.tests.test_version_info',
3543
'bzrlib.tests.test_versionedfile',
3544
'bzrlib.tests.test_weave',
3545
'bzrlib.tests.test_whitebox',
3546
'bzrlib.tests.test_win32utils',
3547
'bzrlib.tests.test_workingtree',
3548
'bzrlib.tests.test_workingtree_4',
3549
'bzrlib.tests.test_wsgi',
3550
'bzrlib.tests.test_xml',
3553
loader = TestUtil.TestLoader()
3555
if keep_only is not None:
3556
id_filter = TestIdList(keep_only)
3558
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3559
for start in starting_with]
3560
# We take precedence over keep_only because *at loading time* using
3561
# both options means we will load less tests for the same final result.
3562
def interesting_module(name):
3563
for start in starting_with:
3565
# Either the module name starts with the specified string
3566
name.startswith(start)
3567
# or it may contain tests starting with the specified string
3568
or start.startswith(name)
3572
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3574
elif keep_only is not None:
3575
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3576
def interesting_module(name):
3577
return id_filter.refers_to(name)
3580
loader = TestUtil.TestLoader()
3581
def interesting_module(name):
3582
# No filtering, all modules are interesting
3585
suite = loader.suiteClass()
3587
# modules building their suite with loadTestsFromModuleNames
3588
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
3590
modules_to_doctest = [
3592
'bzrlib.branchbuilder',
3595
'bzrlib.iterablefile',
3599
'bzrlib.symbol_versioning',
3602
'bzrlib.version_info_formats.format_custom',
3605
for mod in modules_to_doctest:
3606
if not interesting_module(mod):
3607
# No tests to keep here, move along
3610
# note that this really does mean "report only" -- doctest
3611
# still runs the rest of the examples
3612
doc_suite = doctest.DocTestSuite(mod,
3613
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3614
except ValueError, e:
3615
print '**failed to get doctest for: %s\n%s' % (mod, e)
3617
if len(doc_suite._tests) == 0:
3618
raise errors.BzrError("no doctests found in %s" % (mod,))
3619
suite.addTest(doc_suite)
3621
default_encoding = sys.getdefaultencoding()
3622
for name, plugin in bzrlib.plugin.plugins().items():
3623
if not interesting_module(plugin.module.__name__):
3625
plugin_suite = plugin.test_suite()
3626
# We used to catch ImportError here and turn it into just a warning,
3627
# but really if you don't have --no-plugins this should be a failure.
3628
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3629
if plugin_suite is None:
3630
plugin_suite = plugin.load_plugin_tests(loader)
3631
if plugin_suite is not None:
3632
suite.addTest(plugin_suite)
3633
if default_encoding != sys.getdefaultencoding():
3634
bzrlib.trace.warning(
3635
'Plugin "%s" tried to reset default encoding to: %s', name,
3636
sys.getdefaultencoding())
3638
sys.setdefaultencoding(default_encoding)
3641
suite = filter_suite_by_id_startswith(suite, starting_with)
3643
if keep_only is not None:
3644
# Now that the referred modules have loaded their tests, keep only the
3646
suite = filter_suite_by_id_list(suite, id_filter)
3647
# Do some sanity checks on the id_list filtering
3648
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3650
# The tester has used both keep_only and starting_with, so he is
3651
# already aware that some tests are excluded from the list, there
3652
# is no need to tell him which.
3655
# Some tests mentioned in the list are not in the test suite. The
3656
# list may be out of date, report to the tester.
3657
for id in not_found:
3658
bzrlib.trace.warning('"%s" not found in the test suite', id)
3659
for id in duplicates:
3660
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
3665
def multiply_scenarios(scenarios_left, scenarios_right):
3666
"""Multiply two sets of scenarios.
3668
:returns: the cartesian product of the two sets of scenarios, that is
3669
a scenario for every possible combination of a left scenario and a
3673
('%s,%s' % (left_name, right_name),
3674
dict(left_dict.items() + right_dict.items()))
3675
for left_name, left_dict in scenarios_left
3676
for right_name, right_dict in scenarios_right]
3679
def multiply_tests(tests, scenarios, result):
3680
"""Multiply tests_list by scenarios into result.
3682
This is the core workhorse for test parameterisation.
3684
Typically the load_tests() method for a per-implementation test suite will
3685
call multiply_tests and return the result.
3687
:param tests: The tests to parameterise.
3688
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3689
scenario_param_dict).
3690
:param result: A TestSuite to add created tests to.
3692
This returns the passed in result TestSuite with the cross product of all
3693
the tests repeated once for each scenario. Each test is adapted by adding
3694
the scenario name at the end of its id(), and updating the test object's
3695
__dict__ with the scenario_param_dict.
3697
>>> import bzrlib.tests.test_sampler
3698
>>> r = multiply_tests(
3699
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3700
... [('one', dict(param=1)),
3701
... ('two', dict(param=2))],
3703
>>> tests = list(iter_suite_tests(r))
3707
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3713
for test in iter_suite_tests(tests):
3714
apply_scenarios(test, scenarios, result)
3718
def apply_scenarios(test, scenarios, result):
3719
"""Apply the scenarios in scenarios to test and add to result.
3721
:param test: The test to apply scenarios to.
3722
:param scenarios: An iterable of scenarios to apply to test.
3724
:seealso: apply_scenario
3726
for scenario in scenarios:
3727
result.addTest(apply_scenario(test, scenario))
3731
def apply_scenario(test, scenario):
3732
"""Copy test and apply scenario to it.
3734
:param test: A test to adapt.
3735
:param scenario: A tuple describing the scenarion.
3736
The first element of the tuple is the new test id.
3737
The second element is a dict containing attributes to set on the
3739
:return: The adapted test.
3741
new_id = "%s(%s)" % (test.id(), scenario[0])
3742
new_test = clone_test(test, new_id)
3743
for name, value in scenario[1].items():
3744
setattr(new_test, name, value)
3748
def clone_test(test, new_id):
3749
"""Clone a test giving it a new id.
3751
:param test: The test to clone.
3752
:param new_id: The id to assign to it.
3753
:return: The new test.
3755
from copy import deepcopy
3756
new_test = deepcopy(test)
3757
new_test.id = lambda: new_id
3761
def _rmtree_temp_dir(dirname):
3762
# If LANG=C we probably have created some bogus paths
3763
# which rmtree(unicode) will fail to delete
3764
# so make sure we are using rmtree(str) to delete everything
3765
# except on win32, where rmtree(str) will fail
3766
# since it doesn't have the property of byte-stream paths
3767
# (they are either ascii or mbcs)
3768
if sys.platform == 'win32':
3769
# make sure we are using the unicode win32 api
3770
dirname = unicode(dirname)
3772
dirname = dirname.encode(sys.getfilesystemencoding())
3774
osutils.rmtree(dirname)
3776
if sys.platform == 'win32' and e.errno == errno.EACCES:
3777
sys.stderr.write('Permission denied: '
3778
'unable to remove testing dir '
3780
% (os.path.basename(dirname), e))
3785
class Feature(object):
3786
"""An operating system Feature."""
3789
self._available = None
3791
def available(self):
3792
"""Is the feature available?
3794
:return: True if the feature is available.
3796
if self._available is None:
3797
self._available = self._probe()
3798
return self._available
3801
"""Implement this method in concrete features.
3803
:return: True if the feature is available.
3805
raise NotImplementedError
3808
if getattr(self, 'feature_name', None):
3809
return self.feature_name()
3810
return self.__class__.__name__
3813
class _SymlinkFeature(Feature):
3816
return osutils.has_symlinks()
3818
def feature_name(self):
3821
SymlinkFeature = _SymlinkFeature()
3824
class _HardlinkFeature(Feature):
3827
return osutils.has_hardlinks()
3829
def feature_name(self):
3832
HardlinkFeature = _HardlinkFeature()
3835
class _OsFifoFeature(Feature):
3838
return getattr(os, 'mkfifo', None)
3840
def feature_name(self):
3841
return 'filesystem fifos'
3843
OsFifoFeature = _OsFifoFeature()
3846
class _UnicodeFilenameFeature(Feature):
3847
"""Does the filesystem support Unicode filenames?"""
3851
# Check for character combinations unlikely to be covered by any
3852
# single non-unicode encoding. We use the characters
3853
# - greek small letter alpha (U+03B1) and
3854
# - braille pattern dots-123456 (U+283F).
3855
os.stat(u'\u03b1\u283f')
3856
except UnicodeEncodeError:
3858
except (IOError, OSError):
3859
# The filesystem allows the Unicode filename but the file doesn't
3863
# The filesystem allows the Unicode filename and the file exists,
3867
UnicodeFilenameFeature = _UnicodeFilenameFeature()
3870
def probe_unicode_in_user_encoding():
3871
"""Try to encode several unicode strings to use in unicode-aware tests.
3872
Return first successfull match.
3874
:return: (unicode value, encoded plain string value) or (None, None)
3876
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3877
for uni_val in possible_vals:
3879
str_val = uni_val.encode(osutils.get_user_encoding())
3880
except UnicodeEncodeError:
3881
# Try a different character
3884
return uni_val, str_val
3888
def probe_bad_non_ascii(encoding):
3889
"""Try to find [bad] character with code [128..255]
3890
that cannot be decoded to unicode in some encoding.
3891
Return None if all non-ascii characters is valid
3894
for i in xrange(128, 256):
3897
char.decode(encoding)
3898
except UnicodeDecodeError:
3903
class _HTTPSServerFeature(Feature):
3904
"""Some tests want an https Server, check if one is available.
3906
Right now, the only way this is available is under python2.6 which provides
3917
def feature_name(self):
3918
return 'HTTPSServer'
3921
HTTPSServerFeature = _HTTPSServerFeature()
3924
class _UnicodeFilename(Feature):
3925
"""Does the filesystem support Unicode filenames?"""
3930
except UnicodeEncodeError:
3932
except (IOError, OSError):
3933
# The filesystem allows the Unicode filename but the file doesn't
3937
# The filesystem allows the Unicode filename and the file exists,
3941
UnicodeFilename = _UnicodeFilename()
3944
class _UTF8Filesystem(Feature):
3945
"""Is the filesystem UTF-8?"""
3948
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
3952
UTF8Filesystem = _UTF8Filesystem()
3955
class _CaseInsCasePresFilenameFeature(Feature):
3956
"""Is the file-system case insensitive, but case-preserving?"""
3959
fileno, name = tempfile.mkstemp(prefix='MixedCase')
3961
# first check truly case-preserving for created files, then check
3962
# case insensitive when opening existing files.
3963
name = osutils.normpath(name)
3964
base, rel = osutils.split(name)
3965
found_rel = osutils.canonical_relpath(base, name)
3966
return (found_rel == rel
3967
and os.path.isfile(name.upper())
3968
and os.path.isfile(name.lower()))
3973
def feature_name(self):
3974
return "case-insensitive case-preserving filesystem"
3976
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
3979
class _CaseInsensitiveFilesystemFeature(Feature):
3980
"""Check if underlying filesystem is case-insensitive but *not* case
3983
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
3984
# more likely to be case preserving, so this case is rare.
3987
if CaseInsCasePresFilenameFeature.available():
3990
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3991
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3992
TestCaseWithMemoryTransport.TEST_ROOT = root
3994
root = TestCaseWithMemoryTransport.TEST_ROOT
3995
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3997
name_a = osutils.pathjoin(tdir, 'a')
3998
name_A = osutils.pathjoin(tdir, 'A')
4000
result = osutils.isdir(name_A)
4001
_rmtree_temp_dir(tdir)
4004
def feature_name(self):
4005
return 'case-insensitive filesystem'
4007
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4010
class _SubUnitFeature(Feature):
4011
"""Check if subunit is available."""
4020
def feature_name(self):
4023
SubUnitFeature = _SubUnitFeature()
4024
# Only define SubUnitBzrRunner if subunit is available.
4026
from subunit import TestProtocolClient
4028
from subunit.test_results import AutoTimingTestResultDecorator
4030
AutoTimingTestResultDecorator = lambda x:x
4031
class SubUnitBzrRunner(TextTestRunner):
4032
def run(self, test):
4033
result = AutoTimingTestResultDecorator(
4034
TestProtocolClient(self.stream))
added
removed
bzrlib/tests/__init__.py
