1
# Copyright (C) 2005, 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 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
37
from pprint import pformat
42
from subprocess import Popen, PIPE
63
import bzrlib.commands
64
import bzrlib.timestamp
66
import bzrlib.inventory
67
import bzrlib.iterablefile
72
# lsprof not available
74
from bzrlib.merge import merge_inner
77
from bzrlib.revision import common_ancestor
79
from bzrlib import symbol_versioning
80
from bzrlib.symbol_versioning import (
87
from bzrlib.transport import get_transport
88
import bzrlib.transport
89
from bzrlib.transport.local import LocalURLServer
90
from bzrlib.transport.memory import MemoryServer
91
from bzrlib.transport.readonly import ReadonlyServer
92
from bzrlib.trace import mutter, note
93
from bzrlib.tests import TestUtil
94
from bzrlib.tests.http_server import HttpServer
95
from bzrlib.tests.TestUtil import (
99
from bzrlib.tests.treeshape import build_tree_contents
100
import bzrlib.version_info_formats.format_custom
101
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
103
# Mark this python module as being part of the implementation
104
# of unittest: this gives us better tracebacks where the last
105
# shown frame is the test code, not our assertXYZ.
108
default_transport = LocalURLServer
111
class ExtendedTestResult(unittest._TextTestResult):
112
"""Accepts, reports and accumulates the results of running tests.
114
Compared to the unittest version this class adds support for
115
profiling, benchmarking, stopping as soon as a test fails, and
116
skipping tests. There are further-specialized subclasses for
117
different types of display.
119
When a test finishes, in whatever way, it calls one of the addSuccess,
120
addFailure or addError classes. These in turn may redirect to a more
121
specific case for the special test results supported by our extended
124
Note that just one of these objects is fed the results from many tests.
129
def __init__(self, stream, descriptions, verbosity,
133
"""Construct new TestResult.
135
:param bench_history: Optionally, a writable file object to accumulate
138
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
139
if bench_history is not None:
140
from bzrlib.version import _get_bzr_source_tree
141
src_tree = _get_bzr_source_tree()
144
revision_id = src_tree.get_parent_ids()[0]
146
# XXX: if this is a brand new tree, do the same as if there
150
# XXX: If there's no branch, what should we do?
152
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
153
self._bench_history = bench_history
154
self.ui = ui.ui_factory
155
self.num_tests = num_tests
157
self.failure_count = 0
158
self.known_failure_count = 0
160
self.not_applicable_count = 0
161
self.unsupported = {}
163
self._overall_start_time = time.time()
165
def _extractBenchmarkTime(self, testCase):
166
"""Add a benchmark time for the current test case."""
167
return getattr(testCase, "_benchtime", None)
169
def _elapsedTestTimeString(self):
170
"""Return a time string for the overall time the current test has taken."""
171
return self._formatTime(time.time() - self._start_time)
173
def _testTimeString(self, testCase):
174
benchmark_time = self._extractBenchmarkTime(testCase)
175
if benchmark_time is not None:
177
self._formatTime(benchmark_time),
178
self._elapsedTestTimeString())
180
return " %s" % self._elapsedTestTimeString()
182
def _formatTime(self, seconds):
183
"""Format seconds as milliseconds with leading spaces."""
184
# some benchmarks can take thousands of seconds to run, so we need 8
186
return "%8dms" % (1000 * seconds)
188
def _shortened_test_description(self, test):
190
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
193
def startTest(self, test):
194
unittest.TestResult.startTest(self, test)
195
self.report_test_start(test)
196
test.number = self.count
197
self._recordTestStartTime()
199
def _recordTestStartTime(self):
200
"""Record that a test has started."""
201
self._start_time = time.time()
203
def _cleanupLogFile(self, test):
204
# We can only do this if we have one of our TestCases, not if
206
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
207
if setKeepLogfile is not None:
210
def addError(self, test, err):
211
"""Tell result that test finished with an error.
213
Called from the TestCase run() method when the test
214
fails with an unexpected error.
216
self._testConcluded(test)
217
if isinstance(err[1], TestSkipped):
218
return self._addSkipped(test, err)
219
elif isinstance(err[1], UnavailableFeature):
220
return self.addNotSupported(test, err[1].args[0])
222
self._cleanupLogFile(test)
223
unittest.TestResult.addError(self, test, err)
224
self.error_count += 1
225
self.report_error(test, err)
229
def addFailure(self, test, err):
230
"""Tell result that test failed.
232
Called from the TestCase run() method when the test
233
fails because e.g. an assert() method failed.
235
self._testConcluded(test)
236
if isinstance(err[1], KnownFailure):
237
return self._addKnownFailure(test, err)
239
self._cleanupLogFile(test)
240
unittest.TestResult.addFailure(self, test, err)
241
self.failure_count += 1
242
self.report_failure(test, err)
246
def addSuccess(self, test):
247
"""Tell result that test completed successfully.
249
Called from the TestCase run()
251
self._testConcluded(test)
252
if self._bench_history is not None:
253
benchmark_time = self._extractBenchmarkTime(test)
254
if benchmark_time is not None:
255
self._bench_history.write("%s %s\n" % (
256
self._formatTime(benchmark_time),
258
self.report_success(test)
259
self._cleanupLogFile(test)
260
unittest.TestResult.addSuccess(self, test)
261
test._log_contents = ''
263
def _testConcluded(self, test):
264
"""Common code when a test has finished.
266
Called regardless of whether it succeded, failed, etc.
270
def _addKnownFailure(self, test, err):
271
self.known_failure_count += 1
272
self.report_known_failure(test, err)
274
def addNotSupported(self, test, feature):
275
"""The test will not be run because of a missing feature.
277
# this can be called in two different ways: it may be that the
278
# test started running, and then raised (through addError)
279
# UnavailableFeature. Alternatively this method can be called
280
# while probing for features before running the tests; in that
281
# case we will see startTest and stopTest, but the test will never
283
self.unsupported.setdefault(str(feature), 0)
284
self.unsupported[str(feature)] += 1
285
self.report_unsupported(test, feature)
287
def _addSkipped(self, test, skip_excinfo):
288
if isinstance(skip_excinfo[1], TestNotApplicable):
289
self.not_applicable_count += 1
290
self.report_not_applicable(test, skip_excinfo)
293
self.report_skip(test, skip_excinfo)
296
except KeyboardInterrupt:
299
self.addError(test, test._exc_info())
301
# seems best to treat this as success from point-of-view of unittest
302
# -- it actually does nothing so it barely matters :)
303
unittest.TestResult.addSuccess(self, test)
304
test._log_contents = ''
306
def printErrorList(self, flavour, errors):
307
for test, err in errors:
308
self.stream.writeln(self.separator1)
309
self.stream.write("%s: " % flavour)
310
self.stream.writeln(self.getDescription(test))
311
if getattr(test, '_get_log', None) is not None:
312
self.stream.write('\n')
314
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
315
self.stream.write('\n')
316
self.stream.write(test._get_log())
317
self.stream.write('\n')
319
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
320
self.stream.write('\n')
321
self.stream.writeln(self.separator2)
322
self.stream.writeln("%s" % err)
327
def report_cleaning_up(self):
330
def report_success(self, test):
333
def wasStrictlySuccessful(self):
334
if self.unsupported or self.known_failure_count:
336
return self.wasSuccessful()
339
class TextTestResult(ExtendedTestResult):
340
"""Displays progress and results of tests in text form"""
342
def __init__(self, stream, descriptions, verbosity,
347
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
348
bench_history, num_tests)
350
self.pb = self.ui.nested_progress_bar()
351
self._supplied_pb = False
354
self._supplied_pb = True
355
self.pb.show_pct = False
356
self.pb.show_spinner = False
357
self.pb.show_eta = False,
358
self.pb.show_count = False
359
self.pb.show_bar = False
361
def report_starting(self):
362
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
364
def _progress_prefix_text(self):
365
# the longer this text, the less space we have to show the test
367
a = '[%d' % self.count # total that have been run
368
# tests skipped as known not to be relevant are not important enough
370
## if self.skip_count:
371
## a += ', %d skip' % self.skip_count
372
## if self.known_failure_count:
373
## a += '+%dX' % self.known_failure_count
374
if self.num_tests is not None:
375
a +='/%d' % self.num_tests
377
runtime = time.time() - self._overall_start_time
379
a += '%dm%ds' % (runtime / 60, runtime % 60)
383
a += ', %d err' % self.error_count
384
if self.failure_count:
385
a += ', %d fail' % self.failure_count
387
a += ', %d missing' % len(self.unsupported)
391
def report_test_start(self, test):
394
self._progress_prefix_text()
396
+ self._shortened_test_description(test))
398
def _test_description(self, test):
399
return self._shortened_test_description(test)
401
def report_error(self, test, err):
402
self.pb.note('ERROR: %s\n %s\n',
403
self._test_description(test),
407
def report_failure(self, test, err):
408
self.pb.note('FAIL: %s\n %s\n',
409
self._test_description(test),
413
def report_known_failure(self, test, err):
414
self.pb.note('XFAIL: %s\n%s\n',
415
self._test_description(test), err[1])
417
def report_skip(self, test, skip_excinfo):
420
def report_not_applicable(self, test, skip_excinfo):
423
def report_unsupported(self, test, feature):
424
"""test cannot be run because feature is missing."""
426
def report_cleaning_up(self):
427
self.pb.update('cleaning up...')
430
if not self._supplied_pb:
434
class VerboseTestResult(ExtendedTestResult):
435
"""Produce long output, with one line per test run plus times"""
437
def _ellipsize_to_right(self, a_string, final_width):
438
"""Truncate and pad a string, keeping the right hand side"""
439
if len(a_string) > final_width:
440
result = '...' + a_string[3-final_width:]
443
return result.ljust(final_width)
445
def report_starting(self):
446
self.stream.write('running %d tests...\n' % self.num_tests)
448
def report_test_start(self, test):
450
name = self._shortened_test_description(test)
451
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
452
# numbers, plus a trailing blank
453
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
454
self.stream.write(self._ellipsize_to_right(name,
455
osutils.terminal_width()-30))
458
def _error_summary(self, err):
460
return '%s%s' % (indent, err[1])
462
def report_error(self, test, err):
463
self.stream.writeln('ERROR %s\n%s'
464
% (self._testTimeString(test),
465
self._error_summary(err)))
467
def report_failure(self, test, err):
468
self.stream.writeln(' FAIL %s\n%s'
469
% (self._testTimeString(test),
470
self._error_summary(err)))
472
def report_known_failure(self, test, err):
473
self.stream.writeln('XFAIL %s\n%s'
474
% (self._testTimeString(test),
475
self._error_summary(err)))
477
def report_success(self, test):
478
self.stream.writeln(' OK %s' % self._testTimeString(test))
479
for bench_called, stats in getattr(test, '_benchcalls', []):
480
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
481
stats.pprint(file=self.stream)
482
# flush the stream so that we get smooth output. This verbose mode is
483
# used to show the output in PQM.
486
def report_skip(self, test, skip_excinfo):
487
self.stream.writeln(' SKIP %s\n%s'
488
% (self._testTimeString(test),
489
self._error_summary(skip_excinfo)))
491
def report_not_applicable(self, test, skip_excinfo):
492
self.stream.writeln(' N/A %s\n%s'
493
% (self._testTimeString(test),
494
self._error_summary(skip_excinfo)))
496
def report_unsupported(self, test, feature):
497
"""test cannot be run because feature is missing."""
498
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
499
%(self._testTimeString(test), feature))
502
class TextTestRunner(object):
503
stop_on_failure = False
512
self.stream = unittest._WritelnDecorator(stream)
513
self.descriptions = descriptions
514
self.verbosity = verbosity
515
self._bench_history = bench_history
516
self.list_only = list_only
519
"Run the given test case or test suite."
520
startTime = time.time()
521
if self.verbosity == 1:
522
result_class = TextTestResult
523
elif self.verbosity >= 2:
524
result_class = VerboseTestResult
525
result = result_class(self.stream,
528
bench_history=self._bench_history,
529
num_tests=test.countTestCases(),
531
result.stop_early = self.stop_on_failure
532
result.report_starting()
534
if self.verbosity >= 2:
535
self.stream.writeln("Listing tests only ...\n")
537
for t in iter_suite_tests(test):
538
self.stream.writeln("%s" % (t.id()))
540
actionTaken = "Listed"
543
run = result.testsRun
545
stopTime = time.time()
546
timeTaken = stopTime - startTime
548
self.stream.writeln(result.separator2)
549
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
550
run, run != 1 and "s" or "", timeTaken))
551
self.stream.writeln()
552
if not result.wasSuccessful():
553
self.stream.write("FAILED (")
554
failed, errored = map(len, (result.failures, result.errors))
556
self.stream.write("failures=%d" % failed)
558
if failed: self.stream.write(", ")
559
self.stream.write("errors=%d" % errored)
560
if result.known_failure_count:
561
if failed or errored: self.stream.write(", ")
562
self.stream.write("known_failure_count=%d" %
563
result.known_failure_count)
564
self.stream.writeln(")")
566
if result.known_failure_count:
567
self.stream.writeln("OK (known_failures=%d)" %
568
result.known_failure_count)
570
self.stream.writeln("OK")
571
if result.skip_count > 0:
572
skipped = result.skip_count
573
self.stream.writeln('%d test%s skipped' %
574
(skipped, skipped != 1 and "s" or ""))
575
if result.unsupported:
576
for feature, count in sorted(result.unsupported.items()):
577
self.stream.writeln("Missing feature '%s' skipped %d tests." %
583
def iter_suite_tests(suite):
584
"""Return all tests in a suite, recursing through nested suites"""
585
for item in suite._tests:
586
if isinstance(item, unittest.TestCase):
588
elif isinstance(item, unittest.TestSuite):
589
for r in iter_suite_tests(item):
592
raise Exception('unknown object %r inside test suite %r'
596
class TestSkipped(Exception):
597
"""Indicates that a test was intentionally skipped, rather than failing."""
600
class TestNotApplicable(TestSkipped):
601
"""A test is not applicable to the situation where it was run.
603
This is only normally raised by parameterized tests, if they find that
604
the instance they're constructed upon does not support one aspect
609
class KnownFailure(AssertionError):
610
"""Indicates that a test failed in a precisely expected manner.
612
Such failures dont block the whole test suite from passing because they are
613
indicators of partially completed code or of future work. We have an
614
explicit error for them so that we can ensure that they are always visible:
615
KnownFailures are always shown in the output of bzr selftest.
619
class UnavailableFeature(Exception):
620
"""A feature required for this test was not available.
622
The feature should be used to construct the exception.
626
class CommandFailed(Exception):
630
class StringIOWrapper(object):
631
"""A wrapper around cStringIO which just adds an encoding attribute.
633
Internally we can check sys.stdout to see what the output encoding
634
should be. However, cStringIO has no encoding attribute that we can
635
set. So we wrap it instead.
640
def __init__(self, s=None):
642
self.__dict__['_cstring'] = StringIO(s)
644
self.__dict__['_cstring'] = StringIO()
646
def __getattr__(self, name, getattr=getattr):
647
return getattr(self.__dict__['_cstring'], name)
649
def __setattr__(self, name, val):
650
if name == 'encoding':
651
self.__dict__['encoding'] = val
653
return setattr(self._cstring, name, val)
656
class TestUIFactory(ui.CLIUIFactory):
657
"""A UI Factory for testing.
659
Hide the progress bar but emit note()s.
661
Allows get_password to be tested without real tty attached.
668
super(TestUIFactory, self).__init__()
669
if stdin is not None:
670
# We use a StringIOWrapper to be able to test various
671
# encodings, but the user is still responsible to
672
# encode the string and to set the encoding attribute
673
# of StringIOWrapper.
674
self.stdin = StringIOWrapper(stdin)
676
self.stdout = sys.stdout
680
self.stderr = sys.stderr
685
"""See progress.ProgressBar.clear()."""
687
def clear_term(self):
688
"""See progress.ProgressBar.clear_term()."""
690
def clear_term(self):
691
"""See progress.ProgressBar.clear_term()."""
694
"""See progress.ProgressBar.finished()."""
696
def note(self, fmt_string, *args, **kwargs):
697
"""See progress.ProgressBar.note()."""
698
self.stdout.write((fmt_string + "\n") % args)
700
def progress_bar(self):
703
def nested_progress_bar(self):
706
def update(self, message, count=None, total=None):
707
"""See progress.ProgressBar.update()."""
709
def get_non_echoed_password(self, prompt):
710
"""Get password from stdin without trying to handle the echo mode"""
712
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
713
password = self.stdin.readline()
716
if password[-1] == '\n':
717
password = password[:-1]
721
def _report_leaked_threads():
722
bzrlib.trace.warning('%s is leaking threads among %d leaking tests',
723
TestCase._first_thread_leaker_id,
724
TestCase._leaking_threads_tests)
727
class TestCase(unittest.TestCase):
728
"""Base class for bzr unit tests.
730
Tests that need access to disk resources should subclass
731
TestCaseInTempDir not TestCase.
733
Error and debug log messages are redirected from their usual
734
location into a temporary file, the contents of which can be
735
retrieved by _get_log(). We use a real OS file, not an in-memory object,
736
so that it can also capture file IO. When the test completes this file
737
is read into memory and removed from disk.
739
There are also convenience functions to invoke bzr's command-line
740
routine, and to build and check bzr trees.
742
In addition to the usual method of overriding tearDown(), this class also
743
allows subclasses to register functions into the _cleanups list, which is
744
run in order as the object is torn down. It's less likely this will be
745
accidentally overlooked.
748
_active_threads = None
749
_leaking_threads_tests = 0
750
_first_thread_leaker_id = None
751
_log_file_name = None
753
_keep_log_file = False
754
# record lsprof data when performing benchmark calls.
755
_gather_lsprof_in_benchmarks = False
756
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
757
'_log_contents', '_log_file_name', '_benchtime',
758
'_TestCase__testMethodName')
760
def __init__(self, methodName='testMethod'):
761
super(TestCase, self).__init__(methodName)
765
unittest.TestCase.setUp(self)
766
self._cleanEnvironment()
769
self._benchcalls = []
770
self._benchtime = None
772
self._clear_debug_flags()
773
TestCase._active_threads = threading.activeCount()
774
self.addCleanup(self._check_leaked_threads)
776
def _check_leaked_threads(self):
777
active = threading.activeCount()
778
leaked_threads = active - TestCase._active_threads
779
TestCase._active_threads = active
781
TestCase._leaking_threads_tests += 1
782
if TestCase._first_thread_leaker_id is None:
783
TestCase._first_thread_leaker_id = self.id()
784
# we're not specifically told when all tests are finished.
785
# This will do. We use a function to avoid keeping a reference
786
# to a TestCase object.
787
atexit.register(_report_leaked_threads)
789
def _clear_debug_flags(self):
790
"""Prevent externally set debug flags affecting tests.
792
Tests that want to use debug flags can just set them in the
793
debug_flags set during setup/teardown.
795
if 'allow_debug' not in selftest_debug_flags:
796
self._preserved_debug_flags = set(debug.debug_flags)
797
debug.debug_flags.clear()
798
self.addCleanup(self._restore_debug_flags)
800
def _clear_hooks(self):
801
# prevent hooks affecting tests
803
import bzrlib.smart.server
804
self._preserved_hooks = {
805
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
806
bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
807
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
809
self.addCleanup(self._restoreHooks)
810
# reset all hooks to an empty instance of the appropriate type
811
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
812
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
814
def _silenceUI(self):
815
"""Turn off UI for duration of test"""
816
# by default the UI is off; tests can turn it on if they want it.
817
saved = ui.ui_factory
819
ui.ui_factory = saved
820
ui.ui_factory = ui.SilentUIFactory()
821
self.addCleanup(_restore)
823
def _ndiff_strings(self, a, b):
824
"""Return ndiff between two strings containing lines.
826
A trailing newline is added if missing to make the strings
828
if b and b[-1] != '\n':
830
if a and a[-1] != '\n':
832
difflines = difflib.ndiff(a.splitlines(True),
834
linejunk=lambda x: False,
835
charjunk=lambda x: False)
836
return ''.join(difflines)
838
def assertEqual(self, a, b, message=''):
842
except UnicodeError, e:
843
# If we can't compare without getting a UnicodeError, then
844
# obviously they are different
845
mutter('UnicodeError: %s', e)
848
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
850
pformat(a), pformat(b)))
852
assertEquals = assertEqual
854
def assertEqualDiff(self, a, b, message=None):
855
"""Assert two texts are equal, if not raise an exception.
857
This is intended for use with multi-line strings where it can
858
be hard to find the differences by eye.
860
# TODO: perhaps override assertEquals to call this for strings?
864
message = "texts not equal:\n"
865
raise AssertionError(message +
866
self._ndiff_strings(a, b))
868
def assertEqualMode(self, mode, mode_test):
869
self.assertEqual(mode, mode_test,
870
'mode mismatch %o != %o' % (mode, mode_test))
872
def assertPositive(self, val):
873
"""Assert that val is greater than 0."""
874
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
876
def assertNegative(self, val):
877
"""Assert that val is less than 0."""
878
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
880
def assertStartsWith(self, s, prefix):
881
if not s.startswith(prefix):
882
raise AssertionError('string %r does not start with %r' % (s, prefix))
884
def assertEndsWith(self, s, suffix):
885
"""Asserts that s ends with suffix."""
886
if not s.endswith(suffix):
887
raise AssertionError('string %r does not end with %r' % (s, suffix))
889
def assertContainsRe(self, haystack, needle_re):
890
"""Assert that a contains something matching a regular expression."""
891
if not re.search(needle_re, haystack):
892
if '\n' in haystack or len(haystack) > 60:
893
# a long string, format it in a more readable way
894
raise AssertionError(
895
'pattern "%s" not found in\n"""\\\n%s"""\n'
896
% (needle_re, haystack))
898
raise AssertionError('pattern "%s" not found in "%s"'
899
% (needle_re, haystack))
901
def assertNotContainsRe(self, haystack, needle_re):
902
"""Assert that a does not match a regular expression"""
903
if re.search(needle_re, haystack):
904
raise AssertionError('pattern "%s" found in "%s"'
905
% (needle_re, haystack))
907
def assertSubset(self, sublist, superlist):
908
"""Assert that every entry in sublist is present in superlist."""
909
missing = set(sublist) - set(superlist)
911
raise AssertionError("value(s) %r not present in container %r" %
912
(missing, superlist))
914
def assertListRaises(self, excClass, func, *args, **kwargs):
915
"""Fail unless excClass is raised when the iterator from func is used.
917
Many functions can return generators this makes sure
918
to wrap them in a list() call to make sure the whole generator
919
is run, and that the proper exception is raised.
922
list(func(*args, **kwargs))
926
if getattr(excClass,'__name__', None) is not None:
927
excName = excClass.__name__
929
excName = str(excClass)
930
raise self.failureException, "%s not raised" % excName
932
def assertRaises(self, excClass, callableObj, *args, **kwargs):
933
"""Assert that a callable raises a particular exception.
935
:param excClass: As for the except statement, this may be either an
936
exception class, or a tuple of classes.
937
:param callableObj: A callable, will be passed ``*args`` and
940
Returns the exception so that you can examine it.
943
callableObj(*args, **kwargs)
947
if getattr(excClass,'__name__', None) is not None:
948
excName = excClass.__name__
951
excName = str(excClass)
952
raise self.failureException, "%s not raised" % excName
954
def assertIs(self, left, right, message=None):
955
if not (left is right):
956
if message is not None:
957
raise AssertionError(message)
959
raise AssertionError("%r is not %r." % (left, right))
961
def assertIsNot(self, left, right, message=None):
963
if message is not None:
964
raise AssertionError(message)
966
raise AssertionError("%r is %r." % (left, right))
968
def assertTransportMode(self, transport, path, mode):
969
"""Fail if a path does not have mode mode.
971
If modes are not supported on this transport, the assertion is ignored.
973
if not transport._can_roundtrip_unix_modebits():
975
path_stat = transport.stat(path)
976
actual_mode = stat.S_IMODE(path_stat.st_mode)
977
self.assertEqual(mode, actual_mode,
978
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
980
def assertIsSameRealPath(self, path1, path2):
981
"""Fail if path1 and path2 points to different files"""
982
self.assertEqual(osutils.realpath(path1),
983
osutils.realpath(path2),
984
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
986
def assertIsInstance(self, obj, kls):
987
"""Fail if obj is not an instance of kls"""
988
if not isinstance(obj, kls):
989
self.fail("%r is an instance of %s rather than %s" % (
990
obj, obj.__class__, kls))
992
def expectFailure(self, reason, assertion, *args, **kwargs):
993
"""Invoke a test, expecting it to fail for the given reason.
995
This is for assertions that ought to succeed, but currently fail.
996
(The failure is *expected* but not *wanted*.) Please be very precise
997
about the failure you're expecting. If a new bug is introduced,
998
AssertionError should be raised, not KnownFailure.
1000
Frequently, expectFailure should be followed by an opposite assertion.
1003
Intended to be used with a callable that raises AssertionError as the
1004
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1006
Raises KnownFailure if the test fails. Raises AssertionError if the
1011
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1013
self.assertEqual(42, dynamic_val)
1015
This means that a dynamic_val of 54 will cause the test to raise
1016
a KnownFailure. Once math is fixed and the expectFailure is removed,
1017
only a dynamic_val of 42 will allow the test to pass. Anything other
1018
than 54 or 42 will cause an AssertionError.
1021
assertion(*args, **kwargs)
1022
except AssertionError:
1023
raise KnownFailure(reason)
1025
self.fail('Unexpected success. Should have failed: %s' % reason)
1027
def assertFileEqual(self, content, path):
1028
"""Fail if path does not contain 'content'."""
1029
self.failUnlessExists(path)
1030
f = file(path, 'rb')
1035
self.assertEqualDiff(content, s)
1037
def failUnlessExists(self, path):
1038
"""Fail unless path or paths, which may be abs or relative, exist."""
1039
if not isinstance(path, basestring):
1041
self.failUnlessExists(p)
1043
self.failUnless(osutils.lexists(path),path+" does not exist")
1045
def failIfExists(self, path):
1046
"""Fail if path or paths, which may be abs or relative, exist."""
1047
if not isinstance(path, basestring):
1049
self.failIfExists(p)
1051
self.failIf(osutils.lexists(path),path+" exists")
1053
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1054
"""A helper for callDeprecated and applyDeprecated.
1056
:param a_callable: A callable to call.
1057
:param args: The positional arguments for the callable
1058
:param kwargs: The keyword arguments for the callable
1059
:return: A tuple (warnings, result). result is the result of calling
1060
a_callable(``*args``, ``**kwargs``).
1063
def capture_warnings(msg, cls=None, stacklevel=None):
1064
# we've hooked into a deprecation specific callpath,
1065
# only deprecations should getting sent via it.
1066
self.assertEqual(cls, DeprecationWarning)
1067
local_warnings.append(msg)
1068
original_warning_method = symbol_versioning.warn
1069
symbol_versioning.set_warning_method(capture_warnings)
1071
result = a_callable(*args, **kwargs)
1073
symbol_versioning.set_warning_method(original_warning_method)
1074
return (local_warnings, result)
1076
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1077
"""Call a deprecated callable without warning the user.
1079
Note that this only captures warnings raised by symbol_versioning.warn,
1080
not other callers that go direct to the warning module.
1082
To test that a deprecated method raises an error, do something like
1085
self.assertRaises(errors.ReservedId,
1086
self.applyDeprecated,
1087
deprecated_in((1, 5, 0)),
1091
:param deprecation_format: The deprecation format that the callable
1092
should have been deprecated with. This is the same type as the
1093
parameter to deprecated_method/deprecated_function. If the
1094
callable is not deprecated with this format, an assertion error
1096
:param a_callable: A callable to call. This may be a bound method or
1097
a regular function. It will be called with ``*args`` and
1099
:param args: The positional arguments for the callable
1100
:param kwargs: The keyword arguments for the callable
1101
:return: The result of a_callable(``*args``, ``**kwargs``)
1103
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1105
expected_first_warning = symbol_versioning.deprecation_string(
1106
a_callable, deprecation_format)
1107
if len(call_warnings) == 0:
1108
self.fail("No deprecation warning generated by call to %s" %
1110
self.assertEqual(expected_first_warning, call_warnings[0])
1113
def callCatchWarnings(self, fn, *args, **kw):
1114
"""Call a callable that raises python warnings.
1116
The caller's responsible for examining the returned warnings.
1118
If the callable raises an exception, the exception is not
1119
caught and propagates up to the caller. In that case, the list
1120
of warnings is not available.
1122
:returns: ([warning_object, ...], fn_result)
1124
# XXX: This is not perfect, because it completely overrides the
1125
# warnings filters, and some code may depend on suppressing particular
1126
# warnings. It's the easiest way to insulate ourselves from -Werror,
1127
# though. -- Andrew, 20071062
1129
def _catcher(message, category, filename, lineno, file=None):
1130
# despite the name, 'message' is normally(?) a Warning subclass
1132
wlist.append(message)
1133
saved_showwarning = warnings.showwarning
1134
saved_filters = warnings.filters
1136
warnings.showwarning = _catcher
1137
warnings.filters = []
1138
result = fn(*args, **kw)
1140
warnings.showwarning = saved_showwarning
1141
warnings.filters = saved_filters
1142
return wlist, result
1144
def callDeprecated(self, expected, callable, *args, **kwargs):
1145
"""Assert that a callable is deprecated in a particular way.
1147
This is a very precise test for unusual requirements. The
1148
applyDeprecated helper function is probably more suited for most tests
1149
as it allows you to simply specify the deprecation format being used
1150
and will ensure that that is issued for the function being called.
1152
Note that this only captures warnings raised by symbol_versioning.warn,
1153
not other callers that go direct to the warning module. To catch
1154
general warnings, use callCatchWarnings.
1156
:param expected: a list of the deprecation warnings expected, in order
1157
:param callable: The callable to call
1158
:param args: The positional arguments for the callable
1159
:param kwargs: The keyword arguments for the callable
1161
call_warnings, result = self._capture_deprecation_warnings(callable,
1163
self.assertEqual(expected, call_warnings)
1166
def _startLogFile(self):
1167
"""Send bzr and test log messages to a temporary file.
1169
The file is removed as the test is torn down.
1171
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1172
self._log_file = os.fdopen(fileno, 'w+')
1173
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1174
self._log_file_name = name
1175
self.addCleanup(self._finishLogFile)
1177
def _finishLogFile(self):
1178
"""Finished with the log file.
1180
Close the file and delete it, unless setKeepLogfile was called.
1182
if self._log_file is None:
1184
bzrlib.trace.pop_log_file(self._log_memento)
1185
self._log_file.close()
1186
self._log_file = None
1187
if not self._keep_log_file:
1188
os.remove(self._log_file_name)
1189
self._log_file_name = None
1191
def setKeepLogfile(self):
1192
"""Make the logfile not be deleted when _finishLogFile is called."""
1193
self._keep_log_file = True
1195
def addCleanup(self, callable):
1196
"""Arrange to run a callable when this case is torn down.
1198
Callables are run in the reverse of the order they are registered,
1199
ie last-in first-out.
1201
if callable in self._cleanups:
1202
raise ValueError("cleanup function %r already registered on %s"
1204
self._cleanups.append(callable)
1206
def _cleanEnvironment(self):
1208
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1209
'HOME': os.getcwd(),
1210
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1211
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1213
'BZREMAIL': None, # may still be present in the environment
1215
'BZR_PROGRESS_BAR': None,
1218
'SSH_AUTH_SOCK': None,
1222
'https_proxy': None,
1223
'HTTPS_PROXY': None,
1228
# Nobody cares about these ones AFAIK. So far at
1229
# least. If you do (care), please update this comment
1233
'BZR_REMOTE_PATH': None,
1236
self.addCleanup(self._restoreEnvironment)
1237
for name, value in new_env.iteritems():
1238
self._captureVar(name, value)
1240
def _captureVar(self, name, newvalue):
1241
"""Set an environment variable, and reset it when finished."""
1242
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1244
def _restore_debug_flags(self):
1245
debug.debug_flags.clear()
1246
debug.debug_flags.update(self._preserved_debug_flags)
1248
def _restoreEnvironment(self):
1249
for name, value in self.__old_env.iteritems():
1250
osutils.set_or_unset_env(name, value)
1252
def _restoreHooks(self):
1253
for klass, hooks in self._preserved_hooks.items():
1254
setattr(klass, 'hooks', hooks)
1256
def knownFailure(self, reason):
1257
"""This test has failed for some known reason."""
1258
raise KnownFailure(reason)
1260
def run(self, result=None):
1261
if result is None: result = self.defaultTestResult()
1262
for feature in getattr(self, '_test_needs_features', []):
1263
if not feature.available():
1264
result.startTest(self)
1265
if getattr(result, 'addNotSupported', None):
1266
result.addNotSupported(self, feature)
1268
result.addSuccess(self)
1269
result.stopTest(self)
1272
return unittest.TestCase.run(self, result)
1275
absent_attr = object()
1276
for attr_name in self.attrs_to_keep:
1277
attr = getattr(self, attr_name, absent_attr)
1278
if attr is not absent_attr:
1279
saved_attrs[attr_name] = attr
1280
self.__dict__ = saved_attrs
1284
unittest.TestCase.tearDown(self)
1286
def time(self, callable, *args, **kwargs):
1287
"""Run callable and accrue the time it takes to the benchmark time.
1289
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1290
this will cause lsprofile statistics to be gathered and stored in
1293
if self._benchtime is None:
1297
if not self._gather_lsprof_in_benchmarks:
1298
return callable(*args, **kwargs)
1300
# record this benchmark
1301
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1303
self._benchcalls.append(((callable, args, kwargs), stats))
1306
self._benchtime += time.time() - start
1308
def _runCleanups(self):
1309
"""Run registered cleanup functions.
1311
This should only be called from TestCase.tearDown.
1313
# TODO: Perhaps this should keep running cleanups even if
1314
# one of them fails?
1316
# Actually pop the cleanups from the list so tearDown running
1317
# twice is safe (this happens for skipped tests).
1318
while self._cleanups:
1319
self._cleanups.pop()()
1321
def log(self, *args):
1324
def _get_log(self, keep_log_file=False):
1325
"""Get the log from bzrlib.trace calls from this test.
1327
:param keep_log_file: When True, if the log is still a file on disk
1328
leave it as a file on disk. When False, if the log is still a file
1329
on disk, the log file is deleted and the log preserved as
1331
:return: A string containing the log.
1333
# flush the log file, to get all content
1335
bzrlib.trace._trace_file.flush()
1336
if self._log_contents:
1337
# XXX: this can hardly contain the content flushed above --vila
1339
return self._log_contents
1340
if self._log_file_name is not None:
1341
logfile = open(self._log_file_name)
1343
log_contents = logfile.read()
1346
if not keep_log_file:
1347
self._log_contents = log_contents
1349
os.remove(self._log_file_name)
1351
if sys.platform == 'win32' and e.errno == errno.EACCES:
1352
sys.stderr.write(('Unable to delete log file '
1353
' %r\n' % self._log_file_name))
1358
return "DELETED log file to reduce memory footprint"
1360
def requireFeature(self, feature):
1361
"""This test requires a specific feature is available.
1363
:raises UnavailableFeature: When feature is not available.
1365
if not feature.available():
1366
raise UnavailableFeature(feature)
1368
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1370
"""Run bazaar command line, splitting up a string command line."""
1371
if isinstance(args, basestring):
1372
# shlex don't understand unicode strings,
1373
# so args should be plain string (bialix 20070906)
1374
args = list(shlex.split(str(args)))
1375
return self._run_bzr_core(args, retcode=retcode,
1376
encoding=encoding, stdin=stdin, working_dir=working_dir,
1379
def _run_bzr_core(self, args, retcode, encoding, stdin,
1381
if encoding is None:
1382
encoding = bzrlib.user_encoding
1383
stdout = StringIOWrapper()
1384
stderr = StringIOWrapper()
1385
stdout.encoding = encoding
1386
stderr.encoding = encoding
1388
self.log('run bzr: %r', args)
1389
# FIXME: don't call into logging here
1390
handler = logging.StreamHandler(stderr)
1391
handler.setLevel(logging.INFO)
1392
logger = logging.getLogger('')
1393
logger.addHandler(handler)
1394
old_ui_factory = ui.ui_factory
1395
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1398
if working_dir is not None:
1399
cwd = osutils.getcwd()
1400
os.chdir(working_dir)
1403
result = self.apply_redirected(ui.ui_factory.stdin,
1405
bzrlib.commands.run_bzr_catch_user_errors,
1408
logger.removeHandler(handler)
1409
ui.ui_factory = old_ui_factory
1413
out = stdout.getvalue()
1414
err = stderr.getvalue()
1416
self.log('output:\n%r', out)
1418
self.log('errors:\n%r', err)
1419
if retcode is not None:
1420
self.assertEquals(retcode, result,
1421
message='Unexpected return code')
1424
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1425
working_dir=None, error_regexes=[], output_encoding=None):
1426
"""Invoke bzr, as if it were run from the command line.
1428
The argument list should not include the bzr program name - the
1429
first argument is normally the bzr command. Arguments may be
1430
passed in three ways:
1432
1- A list of strings, eg ["commit", "a"]. This is recommended
1433
when the command contains whitespace or metacharacters, or
1434
is built up at run time.
1436
2- A single string, eg "add a". This is the most convenient
1437
for hardcoded commands.
1439
This runs bzr through the interface that catches and reports
1440
errors, and with logging set to something approximating the
1441
default, so that error reporting can be checked.
1443
This should be the main method for tests that want to exercise the
1444
overall behavior of the bzr application (rather than a unit test
1445
or a functional test of the library.)
1447
This sends the stdout/stderr results into the test's log,
1448
where it may be useful for debugging. See also run_captured.
1450
:keyword stdin: A string to be used as stdin for the command.
1451
:keyword retcode: The status code the command should return;
1453
:keyword working_dir: The directory to run the command in
1454
:keyword error_regexes: A list of expected error messages. If
1455
specified they must be seen in the error output of the command.
1457
out, err = self._run_bzr_autosplit(
1462
working_dir=working_dir,
1464
for regex in error_regexes:
1465
self.assertContainsRe(err, regex)
1468
def run_bzr_error(self, error_regexes, *args, **kwargs):
1469
"""Run bzr, and check that stderr contains the supplied regexes
1471
:param error_regexes: Sequence of regular expressions which
1472
must each be found in the error output. The relative ordering
1474
:param args: command-line arguments for bzr
1475
:param kwargs: Keyword arguments which are interpreted by run_bzr
1476
This function changes the default value of retcode to be 3,
1477
since in most cases this is run when you expect bzr to fail.
1479
:return: (out, err) The actual output of running the command (in case
1480
you want to do more inspection)
1484
# Make sure that commit is failing because there is nothing to do
1485
self.run_bzr_error(['no changes to commit'],
1486
['commit', '-m', 'my commit comment'])
1487
# Make sure --strict is handling an unknown file, rather than
1488
# giving us the 'nothing to do' error
1489
self.build_tree(['unknown'])
1490
self.run_bzr_error(['Commit refused because there are unknown files'],
1491
['commit', --strict', '-m', 'my commit comment'])
1493
kwargs.setdefault('retcode', 3)
1494
kwargs['error_regexes'] = error_regexes
1495
out, err = self.run_bzr(*args, **kwargs)
1498
def run_bzr_subprocess(self, *args, **kwargs):
1499
"""Run bzr in a subprocess for testing.
1501
This starts a new Python interpreter and runs bzr in there.
1502
This should only be used for tests that have a justifiable need for
1503
this isolation: e.g. they are testing startup time, or signal
1504
handling, or early startup code, etc. Subprocess code can't be
1505
profiled or debugged so easily.
1507
:keyword retcode: The status code that is expected. Defaults to 0. If
1508
None is supplied, the status code is not checked.
1509
:keyword env_changes: A dictionary which lists changes to environment
1510
variables. A value of None will unset the env variable.
1511
The values must be strings. The change will only occur in the
1512
child, so you don't need to fix the environment after running.
1513
:keyword universal_newlines: Convert CRLF => LF
1514
:keyword allow_plugins: By default the subprocess is run with
1515
--no-plugins to ensure test reproducibility. Also, it is possible
1516
for system-wide plugins to create unexpected output on stderr,
1517
which can cause unnecessary test failures.
1519
env_changes = kwargs.get('env_changes', {})
1520
working_dir = kwargs.get('working_dir', None)
1521
allow_plugins = kwargs.get('allow_plugins', False)
1523
if isinstance(args[0], list):
1525
elif isinstance(args[0], basestring):
1526
args = list(shlex.split(args[0]))
1528
raise ValueError("passing varargs to run_bzr_subprocess")
1529
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1530
working_dir=working_dir,
1531
allow_plugins=allow_plugins)
1532
# We distinguish between retcode=None and retcode not passed.
1533
supplied_retcode = kwargs.get('retcode', 0)
1534
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1535
universal_newlines=kwargs.get('universal_newlines', False),
1538
def start_bzr_subprocess(self, process_args, env_changes=None,
1539
skip_if_plan_to_signal=False,
1541
allow_plugins=False):
1542
"""Start bzr in a subprocess for testing.
1544
This starts a new Python interpreter and runs bzr in there.
1545
This should only be used for tests that have a justifiable need for
1546
this isolation: e.g. they are testing startup time, or signal
1547
handling, or early startup code, etc. Subprocess code can't be
1548
profiled or debugged so easily.
1550
:param process_args: a list of arguments to pass to the bzr executable,
1551
for example ``['--version']``.
1552
:param env_changes: A dictionary which lists changes to environment
1553
variables. A value of None will unset the env variable.
1554
The values must be strings. The change will only occur in the
1555
child, so you don't need to fix the environment after running.
1556
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1558
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1560
:returns: Popen object for the started process.
1562
if skip_if_plan_to_signal:
1563
if not getattr(os, 'kill', None):
1564
raise TestSkipped("os.kill not available.")
1566
if env_changes is None:
1570
def cleanup_environment():
1571
for env_var, value in env_changes.iteritems():
1572
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1574
def restore_environment():
1575
for env_var, value in old_env.iteritems():
1576
osutils.set_or_unset_env(env_var, value)
1578
bzr_path = self.get_bzr_path()
1581
if working_dir is not None:
1582
cwd = osutils.getcwd()
1583
os.chdir(working_dir)
1586
# win32 subprocess doesn't support preexec_fn
1587
# so we will avoid using it on all platforms, just to
1588
# make sure the code path is used, and we don't break on win32
1589
cleanup_environment()
1590
command = [sys.executable, bzr_path]
1591
if not allow_plugins:
1592
command.append('--no-plugins')
1593
command.extend(process_args)
1594
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1596
restore_environment()
1602
def _popen(self, *args, **kwargs):
1603
"""Place a call to Popen.
1605
Allows tests to override this method to intercept the calls made to
1606
Popen for introspection.
1608
return Popen(*args, **kwargs)
1610
def get_bzr_path(self):
1611
"""Return the path of the 'bzr' executable for this test suite."""
1612
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1613
if not os.path.isfile(bzr_path):
1614
# We are probably installed. Assume sys.argv is the right file
1615
bzr_path = sys.argv[0]
1618
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1619
universal_newlines=False, process_args=None):
1620
"""Finish the execution of process.
1622
:param process: the Popen object returned from start_bzr_subprocess.
1623
:param retcode: The status code that is expected. Defaults to 0. If
1624
None is supplied, the status code is not checked.
1625
:param send_signal: an optional signal to send to the process.
1626
:param universal_newlines: Convert CRLF => LF
1627
:returns: (stdout, stderr)
1629
if send_signal is not None:
1630
os.kill(process.pid, send_signal)
1631
out, err = process.communicate()
1633
if universal_newlines:
1634
out = out.replace('\r\n', '\n')
1635
err = err.replace('\r\n', '\n')
1637
if retcode is not None and retcode != process.returncode:
1638
if process_args is None:
1639
process_args = "(unknown args)"
1640
mutter('Output of bzr %s:\n%s', process_args, out)
1641
mutter('Error for bzr %s:\n%s', process_args, err)
1642
self.fail('Command bzr %s failed with retcode %s != %s'
1643
% (process_args, retcode, process.returncode))
1646
def check_inventory_shape(self, inv, shape):
1647
"""Compare an inventory to a list of expected names.
1649
Fail if they are not precisely equal.
1652
shape = list(shape) # copy
1653
for path, ie in inv.entries():
1654
name = path.replace('\\', '/')
1655
if ie.kind == 'directory':
1662
self.fail("expected paths not found in inventory: %r" % shape)
1664
self.fail("unexpected paths found in inventory: %r" % extras)
1666
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1667
a_callable=None, *args, **kwargs):
1668
"""Call callable with redirected std io pipes.
1670
Returns the return code."""
1671
if not callable(a_callable):
1672
raise ValueError("a_callable must be callable.")
1674
stdin = StringIO("")
1676
if getattr(self, "_log_file", None) is not None:
1677
stdout = self._log_file
1681
if getattr(self, "_log_file", None is not None):
1682
stderr = self._log_file
1685
real_stdin = sys.stdin
1686
real_stdout = sys.stdout
1687
real_stderr = sys.stderr
1692
return a_callable(*args, **kwargs)
1694
sys.stdout = real_stdout
1695
sys.stderr = real_stderr
1696
sys.stdin = real_stdin
1698
def reduceLockdirTimeout(self):
1699
"""Reduce the default lock timeout for the duration of the test, so that
1700
if LockContention occurs during a test, it does so quickly.
1702
Tests that expect to provoke LockContention errors should call this.
1704
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1706
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1707
self.addCleanup(resetTimeout)
1708
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1710
def make_utf8_encoded_stringio(self, encoding_type=None):
1711
"""Return a StringIOWrapper instance, that will encode Unicode
1714
if encoding_type is None:
1715
encoding_type = 'strict'
1717
output_encoding = 'utf-8'
1718
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1719
sio.encoding = output_encoding
1723
class TestCaseWithMemoryTransport(TestCase):
1724
"""Common test class for tests that do not need disk resources.
1726
Tests that need disk resources should derive from TestCaseWithTransport.
1728
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1730
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1731
a directory which does not exist. This serves to help ensure test isolation
1732
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1733
must exist. However, TestCaseWithMemoryTransport does not offer local
1734
file defaults for the transport in tests, nor does it obey the command line
1735
override, so tests that accidentally write to the common directory should
1738
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1739
a .bzr directory that stops us ascending higher into the filesystem.
1745
def __init__(self, methodName='runTest'):
1746
# allow test parameterization after test construction and before test
1747
# execution. Variables that the parameterizer sets need to be
1748
# ones that are not set by setUp, or setUp will trash them.
1749
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1750
self.vfs_transport_factory = default_transport
1751
self.transport_server = None
1752
self.transport_readonly_server = None
1753
self.__vfs_server = None
1755
def get_transport(self, relpath=None):
1756
"""Return a writeable transport.
1758
This transport is for the test scratch space relative to
1761
:param relpath: a path relative to the base url.
1763
t = get_transport(self.get_url(relpath))
1764
self.assertFalse(t.is_readonly())
1767
def get_readonly_transport(self, relpath=None):
1768
"""Return a readonly transport for the test scratch space
1770
This can be used to test that operations which should only need
1771
readonly access in fact do not try to write.
1773
:param relpath: a path relative to the base url.
1775
t = get_transport(self.get_readonly_url(relpath))
1776
self.assertTrue(t.is_readonly())
1779
def create_transport_readonly_server(self):
1780
"""Create a transport server from class defined at init.
1782
This is mostly a hook for daughter classes.
1784
return self.transport_readonly_server()
1786
def get_readonly_server(self):
1787
"""Get the server instance for the readonly transport
1789
This is useful for some tests with specific servers to do diagnostics.
1791
if self.__readonly_server is None:
1792
if self.transport_readonly_server is None:
1793
# readonly decorator requested
1794
# bring up the server
1795
self.__readonly_server = ReadonlyServer()
1796
self.__readonly_server.setUp(self.get_vfs_only_server())
1798
self.__readonly_server = self.create_transport_readonly_server()
1799
self.__readonly_server.setUp(self.get_vfs_only_server())
1800
self.addCleanup(self.__readonly_server.tearDown)
1801
return self.__readonly_server
1803
def get_readonly_url(self, relpath=None):
1804
"""Get a URL for the readonly transport.
1806
This will either be backed by '.' or a decorator to the transport
1807
used by self.get_url()
1808
relpath provides for clients to get a path relative to the base url.
1809
These should only be downwards relative, not upwards.
1811
base = self.get_readonly_server().get_url()
1812
return self._adjust_url(base, relpath)
1814
def get_vfs_only_server(self):
1815
"""Get the vfs only read/write server instance.
1817
This is useful for some tests with specific servers that need
1820
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1821
is no means to override it.
1823
if self.__vfs_server is None:
1824
self.__vfs_server = MemoryServer()
1825
self.__vfs_server.setUp()
1826
self.addCleanup(self.__vfs_server.tearDown)
1827
return self.__vfs_server
1829
def get_server(self):
1830
"""Get the read/write server instance.
1832
This is useful for some tests with specific servers that need
1835
This is built from the self.transport_server factory. If that is None,
1836
then the self.get_vfs_server is returned.
1838
if self.__server is None:
1839
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1840
return self.get_vfs_only_server()
1842
# bring up a decorated means of access to the vfs only server.
1843
self.__server = self.transport_server()
1845
self.__server.setUp(self.get_vfs_only_server())
1846
except TypeError, e:
1847
# This should never happen; the try:Except here is to assist
1848
# developers having to update code rather than seeing an
1849
# uninformative TypeError.
1850
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1851
self.addCleanup(self.__server.tearDown)
1852
return self.__server
1854
def _adjust_url(self, base, relpath):
1855
"""Get a URL (or maybe a path) for the readwrite transport.
1857
This will either be backed by '.' or to an equivalent non-file based
1859
relpath provides for clients to get a path relative to the base url.
1860
These should only be downwards relative, not upwards.
1862
if relpath is not None and relpath != '.':
1863
if not base.endswith('/'):
1865
# XXX: Really base should be a url; we did after all call
1866
# get_url()! But sometimes it's just a path (from
1867
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1868
# to a non-escaped local path.
1869
if base.startswith('./') or base.startswith('/'):
1872
base += urlutils.escape(relpath)
1875
def get_url(self, relpath=None):
1876
"""Get a URL (or maybe a path) for the readwrite transport.
1878
This will either be backed by '.' or to an equivalent non-file based
1880
relpath provides for clients to get a path relative to the base url.
1881
These should only be downwards relative, not upwards.
1883
base = self.get_server().get_url()
1884
return self._adjust_url(base, relpath)
1886
def get_vfs_only_url(self, relpath=None):
1887
"""Get a URL (or maybe a path for the plain old vfs transport.
1889
This will never be a smart protocol. It always has all the
1890
capabilities of the local filesystem, but it might actually be a
1891
MemoryTransport or some other similar virtual filesystem.
1893
This is the backing transport (if any) of the server returned by
1894
get_url and get_readonly_url.
1896
:param relpath: provides for clients to get a path relative to the base
1897
url. These should only be downwards relative, not upwards.
1900
base = self.get_vfs_only_server().get_url()
1901
return self._adjust_url(base, relpath)
1903
def _create_safety_net(self):
1904
"""Make a fake bzr directory.
1906
This prevents any tests propagating up onto the TEST_ROOT directory's
1909
root = TestCaseWithMemoryTransport.TEST_ROOT
1910
bzrdir.BzrDir.create_standalone_workingtree(root)
1912
def _check_safety_net(self):
1913
"""Check that the safety .bzr directory have not been touched.
1915
_make_test_root have created a .bzr directory to prevent tests from
1916
propagating. This method ensures than a test did not leaked.
1918
root = TestCaseWithMemoryTransport.TEST_ROOT
1919
wt = workingtree.WorkingTree.open(root)
1920
last_rev = wt.last_revision()
1921
if last_rev != 'null:':
1922
# The current test have modified the /bzr directory, we need to
1923
# recreate a new one or all the followng tests will fail.
1924
# If you need to inspect its content uncomment the following line
1925
# import pdb; pdb.set_trace()
1926
_rmtree_temp_dir(root + '/.bzr')
1927
self._create_safety_net()
1928
raise AssertionError('%s/.bzr should not be modified' % root)
1930
def _make_test_root(self):
1931
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1932
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1933
TestCaseWithMemoryTransport.TEST_ROOT = root
1935
self._create_safety_net()
1937
# The same directory is used by all tests, and we're not
1938
# specifically told when all tests are finished. This will do.
1939
atexit.register(_rmtree_temp_dir, root)
1941
self.addCleanup(self._check_safety_net)
1943
def makeAndChdirToTestDir(self):
1944
"""Create a temporary directories for this one test.
1946
This must set self.test_home_dir and self.test_dir and chdir to
1949
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1951
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1952
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1953
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1955
def make_branch(self, relpath, format=None):
1956
"""Create a branch on the transport at relpath."""
1957
repo = self.make_repository(relpath, format=format)
1958
return repo.bzrdir.create_branch()
1960
def make_bzrdir(self, relpath, format=None):
1962
# might be a relative or absolute path
1963
maybe_a_url = self.get_url(relpath)
1964
segments = maybe_a_url.rsplit('/', 1)
1965
t = get_transport(maybe_a_url)
1966
if len(segments) > 1 and segments[-1] not in ('', '.'):
1970
if isinstance(format, basestring):
1971
format = bzrdir.format_registry.make_bzrdir(format)
1972
return format.initialize_on_transport(t)
1973
except errors.UninitializableFormat:
1974
raise TestSkipped("Format %s is not initializable." % format)
1976
def make_repository(self, relpath, shared=False, format=None):
1977
"""Create a repository on our default transport at relpath.
1979
Note that relpath must be a relative path, not a full url.
1981
# FIXME: If you create a remoterepository this returns the underlying
1982
# real format, which is incorrect. Actually we should make sure that
1983
# RemoteBzrDir returns a RemoteRepository.
1984
# maybe mbp 20070410
1985
made_control = self.make_bzrdir(relpath, format=format)
1986
return made_control.create_repository(shared=shared)
1988
def make_branch_and_memory_tree(self, relpath, format=None):
1989
"""Create a branch on the default transport and a MemoryTree for it."""
1990
b = self.make_branch(relpath, format=format)
1991
return memorytree.MemoryTree.create_on_branch(b)
1993
def overrideEnvironmentForTesting(self):
1994
os.environ['HOME'] = self.test_home_dir
1995
os.environ['BZR_HOME'] = self.test_home_dir
1998
super(TestCaseWithMemoryTransport, self).setUp()
1999
self._make_test_root()
2000
_currentdir = os.getcwdu()
2001
def _leaveDirectory():
2002
os.chdir(_currentdir)
2003
self.addCleanup(_leaveDirectory)
2004
self.makeAndChdirToTestDir()
2005
self.overrideEnvironmentForTesting()
2006
self.__readonly_server = None
2007
self.__server = None
2008
self.reduceLockdirTimeout()
2011
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2012
"""Derived class that runs a test within a temporary directory.
2014
This is useful for tests that need to create a branch, etc.
2016
The directory is created in a slightly complex way: for each
2017
Python invocation, a new temporary top-level directory is created.
2018
All test cases create their own directory within that. If the
2019
tests complete successfully, the directory is removed.
2021
:ivar test_base_dir: The path of the top-level directory for this
2022
test, which contains a home directory and a work directory.
2024
:ivar test_home_dir: An initially empty directory under test_base_dir
2025
which is used as $HOME for this test.
2027
:ivar test_dir: A directory under test_base_dir used as the current
2028
directory when the test proper is run.
2031
OVERRIDE_PYTHON = 'python'
2033
def check_file_contents(self, filename, expect):
2034
self.log("check contents of file %s" % filename)
2035
contents = file(filename, 'r').read()
2036
if contents != expect:
2037
self.log("expected: %r" % expect)
2038
self.log("actually: %r" % contents)
2039
self.fail("contents of %s not as expected" % filename)
2041
def makeAndChdirToTestDir(self):
2042
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2044
For TestCaseInTempDir we create a temporary directory based on the test
2045
name and then create two subdirs - test and home under it.
2047
# create a directory within the top level test directory
2048
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2049
# now create test and home directories within this dir
2050
self.test_base_dir = candidate_dir
2051
self.test_home_dir = self.test_base_dir + '/home'
2052
os.mkdir(self.test_home_dir)
2053
self.test_dir = self.test_base_dir + '/work'
2054
os.mkdir(self.test_dir)
2055
os.chdir(self.test_dir)
2056
# put name of test inside
2057
f = file(self.test_base_dir + '/name', 'w')
2062
self.addCleanup(self.deleteTestDir)
2064
def deleteTestDir(self):
2065
os.chdir(self.TEST_ROOT)
2066
_rmtree_temp_dir(self.test_base_dir)
2068
def build_tree(self, shape, line_endings='binary', transport=None):
2069
"""Build a test tree according to a pattern.
2071
shape is a sequence of file specifications. If the final
2072
character is '/', a directory is created.
2074
This assumes that all the elements in the tree being built are new.
2076
This doesn't add anything to a branch.
2078
:type shape: list or tuple.
2079
:param line_endings: Either 'binary' or 'native'
2080
in binary mode, exact contents are written in native mode, the
2081
line endings match the default platform endings.
2082
:param transport: A transport to write to, for building trees on VFS's.
2083
If the transport is readonly or None, "." is opened automatically.
2086
if type(shape) not in (list, tuple):
2087
raise AssertionError("Parameter 'shape' should be "
2088
"a list or a tuple. Got %r instead" % (shape,))
2089
# It's OK to just create them using forward slashes on windows.
2090
if transport is None or transport.is_readonly():
2091
transport = get_transport(".")
2093
self.assert_(isinstance(name, basestring))
2095
transport.mkdir(urlutils.escape(name[:-1]))
2097
if line_endings == 'binary':
2099
elif line_endings == 'native':
2102
raise errors.BzrError(
2103
'Invalid line ending request %r' % line_endings)
2104
content = "contents of %s%s" % (name.encode('utf-8'), end)
2105
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2107
def build_tree_contents(self, shape):
2108
build_tree_contents(shape)
2110
def assertInWorkingTree(self, path, root_path='.', tree=None):
2111
"""Assert whether path or paths are in the WorkingTree"""
2113
tree = workingtree.WorkingTree.open(root_path)
2114
if not isinstance(path, basestring):
2116
self.assertInWorkingTree(p,tree=tree)
2118
self.assertIsNot(tree.path2id(path), None,
2119
path+' not in working tree.')
2121
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2122
"""Assert whether path or paths are not in the WorkingTree"""
2124
tree = workingtree.WorkingTree.open(root_path)
2125
if not isinstance(path, basestring):
2127
self.assertNotInWorkingTree(p,tree=tree)
2129
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2132
class TestCaseWithTransport(TestCaseInTempDir):
2133
"""A test case that provides get_url and get_readonly_url facilities.
2135
These back onto two transport servers, one for readonly access and one for
2138
If no explicit class is provided for readonly access, a
2139
ReadonlyTransportDecorator is used instead which allows the use of non disk
2140
based read write transports.
2142
If an explicit class is provided for readonly access, that server and the
2143
readwrite one must both define get_url() as resolving to os.getcwd().
2146
def get_vfs_only_server(self):
2147
"""See TestCaseWithMemoryTransport.
2149
This is useful for some tests with specific servers that need
2152
if self.__vfs_server is None:
2153
self.__vfs_server = self.vfs_transport_factory()
2154
self.__vfs_server.setUp()
2155
self.addCleanup(self.__vfs_server.tearDown)
2156
return self.__vfs_server
2158
def make_branch_and_tree(self, relpath, format=None):
2159
"""Create a branch on the transport and a tree locally.
2161
If the transport is not a LocalTransport, the Tree can't be created on
2162
the transport. In that case if the vfs_transport_factory is
2163
LocalURLServer the working tree is created in the local
2164
directory backing the transport, and the returned tree's branch and
2165
repository will also be accessed locally. Otherwise a lightweight
2166
checkout is created and returned.
2168
:param format: The BzrDirFormat.
2169
:returns: the WorkingTree.
2171
# TODO: always use the local disk path for the working tree,
2172
# this obviously requires a format that supports branch references
2173
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2175
b = self.make_branch(relpath, format=format)
2177
return b.bzrdir.create_workingtree()
2178
except errors.NotLocalUrl:
2179
# We can only make working trees locally at the moment. If the
2180
# transport can't support them, then we keep the non-disk-backed
2181
# branch and create a local checkout.
2182
if self.vfs_transport_factory is LocalURLServer:
2183
# the branch is colocated on disk, we cannot create a checkout.
2184
# hopefully callers will expect this.
2185
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2186
return local_controldir.create_workingtree()
2188
return b.create_checkout(relpath, lightweight=True)
2190
def assertIsDirectory(self, relpath, transport):
2191
"""Assert that relpath within transport is a directory.
2193
This may not be possible on all transports; in that case it propagates
2194
a TransportNotPossible.
2197
mode = transport.stat(relpath).st_mode
2198
except errors.NoSuchFile:
2199
self.fail("path %s is not a directory; no such file"
2201
if not stat.S_ISDIR(mode):
2202
self.fail("path %s is not a directory; has mode %#o"
2205
def assertTreesEqual(self, left, right):
2206
"""Check that left and right have the same content and properties."""
2207
# we use a tree delta to check for equality of the content, and we
2208
# manually check for equality of other things such as the parents list.
2209
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2210
differences = left.changes_from(right)
2211
self.assertFalse(differences.has_changed(),
2212
"Trees %r and %r are different: %r" % (left, right, differences))
2215
super(TestCaseWithTransport, self).setUp()
2216
self.__vfs_server = None
2219
class ChrootedTestCase(TestCaseWithTransport):
2220
"""A support class that provides readonly urls outside the local namespace.
2222
This is done by checking if self.transport_server is a MemoryServer. if it
2223
is then we are chrooted already, if it is not then an HttpServer is used
2226
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2227
be used without needed to redo it when a different
2228
subclass is in use ?
2232
super(ChrootedTestCase, self).setUp()
2233
if not self.vfs_transport_factory == MemoryServer:
2234
self.transport_readonly_server = HttpServer
2237
def condition_id_re(pattern):
2238
"""Create a condition filter which performs a re check on a test's id.
2240
:param pattern: A regular expression string.
2241
:return: A callable that returns True if the re matches.
2243
filter_re = re.compile(pattern)
2244
def condition(test):
2246
return filter_re.search(test_id)
2250
def condition_isinstance(klass_or_klass_list):
2251
"""Create a condition filter which returns isinstance(param, klass).
2253
:return: A callable which when called with one parameter obj return the
2254
result of isinstance(obj, klass_or_klass_list).
2257
return isinstance(obj, klass_or_klass_list)
2261
def condition_id_in_list(id_list):
2262
"""Create a condition filter which verify that test's id in a list.
2264
:param id_list: A TestIdList object.
2265
:return: A callable that returns True if the test's id appears in the list.
2267
def condition(test):
2268
return id_list.includes(test.id())
2272
def exclude_tests_by_condition(suite, condition):
2273
"""Create a test suite which excludes some tests from suite.
2275
:param suite: The suite to get tests from.
2276
:param condition: A callable whose result evaluates True when called with a
2277
test case which should be excluded from the result.
2278
:return: A suite which contains the tests found in suite that fail
2282
for test in iter_suite_tests(suite):
2283
if not condition(test):
2285
return TestUtil.TestSuite(result)
2288
def filter_suite_by_condition(suite, condition):
2289
"""Create a test suite by filtering another one.
2291
:param suite: The source suite.
2292
:param condition: A callable whose result evaluates True when called with a
2293
test case which should be included in the result.
2294
:return: A suite which contains the tests found in suite that pass
2298
for test in iter_suite_tests(suite):
2301
return TestUtil.TestSuite(result)
2304
def filter_suite_by_re(suite, pattern):
2305
"""Create a test suite by filtering another one.
2307
:param suite: the source suite
2308
:param pattern: pattern that names must match
2309
:returns: the newly created suite
2311
condition = condition_id_re(pattern)
2312
result_suite = filter_suite_by_condition(suite, condition)
2316
def filter_suite_by_id_list(suite, test_id_list):
2317
"""Create a test suite by filtering another one.
2319
:param suite: The source suite.
2320
:param test_id_list: A list of the test ids to keep as strings.
2321
:returns: the newly created suite
2323
condition = condition_id_in_list(test_id_list)
2324
result_suite = filter_suite_by_condition(suite, condition)
2328
def exclude_tests_by_re(suite, pattern):
2329
"""Create a test suite which excludes some tests from suite.
2331
:param suite: The suite to get tests from.
2332
:param pattern: A regular expression string. Test ids that match this
2333
pattern will be excluded from the result.
2334
:return: A TestSuite that contains all the tests from suite without the
2335
tests that matched pattern. The order of tests is the same as it was in
2338
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2341
def preserve_input(something):
2342
"""A helper for performing test suite transformation chains.
2344
:param something: Anything you want to preserve.
2350
def randomize_suite(suite):
2351
"""Return a new TestSuite with suite's tests in random order.
2353
The tests in the input suite are flattened into a single suite in order to
2354
accomplish this. Any nested TestSuites are removed to provide global
2357
tests = list(iter_suite_tests(suite))
2358
random.shuffle(tests)
2359
return TestUtil.TestSuite(tests)
2362
def split_suite_by_re(suite, pattern):
2363
"""Split a test suite into two by a regular expression.
2365
:param suite: The suite to split.
2366
:param pattern: A regular expression string. Test ids that match this
2367
pattern will be in the first test suite returned, and the others in the
2368
second test suite returned.
2369
:return: A tuple of two test suites, where the first contains tests from
2370
suite matching pattern, and the second contains the remainder from
2371
suite. The order within each output suite is the same as it was in
2376
filter_re = re.compile(pattern)
2377
for test in iter_suite_tests(suite):
2379
if filter_re.search(test_id):
2380
matched.append(test)
2382
did_not_match.append(test)
2383
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2386
def run_suite(suite, name='test', verbose=False, pattern=".*",
2387
stop_on_failure=False,
2388
transport=None, lsprof_timed=None, bench_history=None,
2389
matching_tests_first=None,
2392
exclude_pattern=None,
2394
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2399
runner = TextTestRunner(stream=sys.stdout,
2401
verbosity=verbosity,
2402
bench_history=bench_history,
2403
list_only=list_only,
2405
runner.stop_on_failure=stop_on_failure
2406
# Initialise the random number generator and display the seed used.
2407
# We convert the seed to a long to make it reuseable across invocations.
2408
random_order = False
2409
if random_seed is not None:
2411
if random_seed == "now":
2412
random_seed = long(time.time())
2414
# Convert the seed to a long if we can
2416
random_seed = long(random_seed)
2419
runner.stream.writeln("Randomizing test order using seed %s\n" %
2421
random.seed(random_seed)
2422
# Customise the list of tests if requested
2423
if exclude_pattern is not None:
2424
suite = exclude_tests_by_re(suite, exclude_pattern)
2426
order_changer = randomize_suite
2428
order_changer = preserve_input
2429
if pattern != '.*' or random_order:
2430
if matching_tests_first:
2431
suites = map(order_changer, split_suite_by_re(suite, pattern))
2432
suite = TestUtil.TestSuite(suites)
2434
suite = order_changer(filter_suite_by_re(suite, pattern))
2436
result = runner.run(suite)
2439
return result.wasStrictlySuccessful()
2441
return result.wasSuccessful()
2444
# Controlled by "bzr selftest -E=..." option
2445
selftest_debug_flags = set()
2448
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2450
test_suite_factory=None,
2453
matching_tests_first=None,
2456
exclude_pattern=None,
2461
"""Run the whole test suite under the enhanced runner"""
2462
# XXX: Very ugly way to do this...
2463
# Disable warning about old formats because we don't want it to disturb
2464
# any blackbox tests.
2465
from bzrlib import repository
2466
repository._deprecation_warning_done = True
2468
global default_transport
2469
if transport is None:
2470
transport = default_transport
2471
old_transport = default_transport
2472
default_transport = transport
2473
global selftest_debug_flags
2474
old_debug_flags = selftest_debug_flags
2475
if debug_flags is not None:
2476
selftest_debug_flags = set(debug_flags)
2478
if load_list is None:
2481
keep_only = load_test_id_list(load_list)
2482
if test_suite_factory is None:
2483
suite = test_suite(keep_only)
2485
suite = test_suite_factory()
2486
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2487
stop_on_failure=stop_on_failure,
2488
transport=transport,
2489
lsprof_timed=lsprof_timed,
2490
bench_history=bench_history,
2491
matching_tests_first=matching_tests_first,
2492
list_only=list_only,
2493
random_seed=random_seed,
2494
exclude_pattern=exclude_pattern,
2497
default_transport = old_transport
2498
selftest_debug_flags = old_debug_flags
2501
def load_test_id_list(file_name):
2502
"""Load a test id list from a text file.
2504
The format is one test id by line. No special care is taken to impose
2505
strict rules, these test ids are used to filter the test suite so a test id
2506
that do not match an existing test will do no harm. This allows user to add
2507
comments, leave blank lines, etc.
2511
ftest = open(file_name, 'rt')
2513
if e.errno != errno.ENOENT:
2516
raise errors.NoSuchFile(file_name)
2518
for test_name in ftest.readlines():
2519
test_list.append(test_name.strip())
2524
def suite_matches_id_list(test_suite, id_list):
2525
"""Warns about tests not appearing or appearing more than once.
2527
:param test_suite: A TestSuite object.
2528
:param test_id_list: The list of test ids that should be found in
2531
:return: (absents, duplicates) absents is a list containing the test found
2532
in id_list but not in test_suite, duplicates is a list containing the
2533
test found multiple times in test_suite.
2535
When using a prefined test id list, it may occurs that some tests do not
2536
exist anymore or that some tests use the same id. This function warns the
2537
tester about potential problems in his workflow (test lists are volatile)
2538
or in the test suite itself (using the same id for several tests does not
2539
help to localize defects).
2541
# Build a dict counting id occurrences
2543
for test in iter_suite_tests(test_suite):
2545
tests[id] = tests.get(id, 0) + 1
2550
occurs = tests.get(id, 0)
2552
not_found.append(id)
2554
duplicates.append(id)
2556
return not_found, duplicates
2559
class TestIdList(object):
2560
"""Test id list to filter a test suite.
2562
Relying on the assumption that test ids are built as:
2563
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2564
notation, this class offers methods to :
2565
- avoid building a test suite for modules not refered to in the test list,
2566
- keep only the tests listed from the module test suite.
2569
def __init__(self, test_id_list):
2570
# When a test suite needs to be filtered against us we compare test ids
2571
# for equality, so a simple dict offers a quick and simple solution.
2572
self.tests = dict().fromkeys(test_id_list, True)
2574
# While unittest.TestCase have ids like:
2575
# <module>.<class>.<method>[(<param+)],
2576
# doctest.DocTestCase can have ids like:
2579
# <module>.<function>
2580
# <module>.<class>.<method>
2582
# Since we can't predict a test class from its name only, we settle on
2583
# a simple constraint: a test id always begins with its module name.
2586
for test_id in test_id_list:
2587
parts = test_id.split('.')
2588
mod_name = parts.pop(0)
2589
modules[mod_name] = True
2591
mod_name += '.' + part
2592
modules[mod_name] = True
2593
self.modules = modules
2595
def refers_to(self, module_name):
2596
"""Is there tests for the module or one of its sub modules."""
2597
return self.modules.has_key(module_name)
2599
def includes(self, test_id):
2600
return self.tests.has_key(test_id)
2603
def test_suite(keep_only=None):
2604
"""Build and return TestSuite for the whole of bzrlib.
2606
:param keep_only: A list of test ids limiting the suite returned.
2608
This function can be replaced if you need to change the default test
2609
suite on a global basis, but it is not encouraged.
2613
'bzrlib.util.tests.test_bencode',
2614
'bzrlib.tests.blackbox',
2615
'bzrlib.tests.branch_implementations',
2616
'bzrlib.tests.bzrdir_implementations',
2617
'bzrlib.tests.commands',
2618
'bzrlib.tests.inventory_implementations',
2619
'bzrlib.tests.interrepository_implementations',
2620
'bzrlib.tests.intertree_implementations',
2621
'bzrlib.tests.interversionedfile_implementations',
2622
'bzrlib.tests.per_lock',
2623
'bzrlib.tests.repository_implementations',
2624
'bzrlib.tests.revisionstore_implementations',
2625
'bzrlib.tests.test__dirstate_helpers',
2626
'bzrlib.tests.test_ancestry',
2627
'bzrlib.tests.test_annotate',
2628
'bzrlib.tests.test_api',
2629
'bzrlib.tests.test_atomicfile',
2630
'bzrlib.tests.test_bad_files',
2631
'bzrlib.tests.test_bisect_multi',
2632
'bzrlib.tests.test_branch',
2633
'bzrlib.tests.test_branchbuilder',
2634
'bzrlib.tests.test_bugtracker',
2635
'bzrlib.tests.test_bundle',
2636
'bzrlib.tests.test_bzrdir',
2637
'bzrlib.tests.test_cache_utf8',
2638
'bzrlib.tests.test_commands',
2639
'bzrlib.tests.test_commit',
2640
'bzrlib.tests.test_commit_merge',
2641
'bzrlib.tests.test_config',
2642
'bzrlib.tests.test_conflicts',
2643
'bzrlib.tests.test_counted_lock',
2644
'bzrlib.tests.test_decorators',
2645
'bzrlib.tests.test_delta',
2646
'bzrlib.tests.test_deprecated_graph',
2647
'bzrlib.tests.test_diff',
2648
'bzrlib.tests.test_dirstate',
2649
'bzrlib.tests.test_directory_service',
2650
'bzrlib.tests.test_email_message',
2651
'bzrlib.tests.test_errors',
2652
'bzrlib.tests.test_escaped_store',
2653
'bzrlib.tests.test_extract',
2654
'bzrlib.tests.test_fetch',
2655
'bzrlib.tests.test_ftp_transport',
2656
'bzrlib.tests.test_generate_docs',
2657
'bzrlib.tests.test_generate_ids',
2658
'bzrlib.tests.test_globbing',
2659
'bzrlib.tests.test_gpg',
2660
'bzrlib.tests.test_graph',
2661
'bzrlib.tests.test_hashcache',
2662
'bzrlib.tests.test_help',
2663
'bzrlib.tests.test_hooks',
2664
'bzrlib.tests.test_http',
2665
'bzrlib.tests.test_http_implementations',
2666
'bzrlib.tests.test_http_response',
2667
'bzrlib.tests.test_https_ca_bundle',
2668
'bzrlib.tests.test_identitymap',
2669
'bzrlib.tests.test_ignores',
2670
'bzrlib.tests.test_index',
2671
'bzrlib.tests.test_info',
2672
'bzrlib.tests.test_inv',
2673
'bzrlib.tests.test_knit',
2674
'bzrlib.tests.test_lazy_import',
2675
'bzrlib.tests.test_lazy_regex',
2676
'bzrlib.tests.test_lockdir',
2677
'bzrlib.tests.test_lockable_files',
2678
'bzrlib.tests.test_log',
2679
'bzrlib.tests.test_lsprof',
2680
'bzrlib.tests.test_lru_cache',
2681
'bzrlib.tests.test_mail_client',
2682
'bzrlib.tests.test_memorytree',
2683
'bzrlib.tests.test_merge',
2684
'bzrlib.tests.test_merge3',
2685
'bzrlib.tests.test_merge_core',
2686
'bzrlib.tests.test_merge_directive',
2687
'bzrlib.tests.test_missing',
2688
'bzrlib.tests.test_msgeditor',
2689
'bzrlib.tests.test_multiparent',
2690
'bzrlib.tests.test_mutabletree',
2691
'bzrlib.tests.test_nonascii',
2692
'bzrlib.tests.test_options',
2693
'bzrlib.tests.test_osutils',
2694
'bzrlib.tests.test_osutils_encodings',
2695
'bzrlib.tests.test_pack',
2696
'bzrlib.tests.test_patch',
2697
'bzrlib.tests.test_patches',
2698
'bzrlib.tests.test_permissions',
2699
'bzrlib.tests.test_plugins',
2700
'bzrlib.tests.test_progress',
2701
'bzrlib.tests.test_read_bundle',
2702
'bzrlib.tests.test_reconfigure',
2703
'bzrlib.tests.test_reconcile',
2704
'bzrlib.tests.test_registry',
2705
'bzrlib.tests.test_remote',
2706
'bzrlib.tests.test_repository',
2707
'bzrlib.tests.test_revert',
2708
'bzrlib.tests.test_revision',
2709
'bzrlib.tests.test_revisionspec',
2710
'bzrlib.tests.test_revisiontree',
2711
'bzrlib.tests.test_rio',
2712
'bzrlib.tests.test_sampler',
2713
'bzrlib.tests.test_selftest',
2714
'bzrlib.tests.test_setup',
2715
'bzrlib.tests.test_sftp_transport',
2716
'bzrlib.tests.test_smart',
2717
'bzrlib.tests.test_smart_add',
2718
'bzrlib.tests.test_smart_transport',
2719
'bzrlib.tests.test_smtp_connection',
2720
'bzrlib.tests.test_source',
2721
'bzrlib.tests.test_ssh_transport',
2722
'bzrlib.tests.test_status',
2723
'bzrlib.tests.test_store',
2724
'bzrlib.tests.test_strace',
2725
'bzrlib.tests.test_subsume',
2726
'bzrlib.tests.test_switch',
2727
'bzrlib.tests.test_symbol_versioning',
2728
'bzrlib.tests.test_tag',
2729
'bzrlib.tests.test_testament',
2730
'bzrlib.tests.test_textfile',
2731
'bzrlib.tests.test_textmerge',
2732
'bzrlib.tests.test_timestamp',
2733
'bzrlib.tests.test_trace',
2734
'bzrlib.tests.test_transactions',
2735
'bzrlib.tests.test_transform',
2736
'bzrlib.tests.test_transport',
2737
'bzrlib.tests.test_transport_implementations',
2738
'bzrlib.tests.test_tree',
2739
'bzrlib.tests.test_treebuilder',
2740
'bzrlib.tests.test_tsort',
2741
'bzrlib.tests.test_tuned_gzip',
2742
'bzrlib.tests.test_ui',
2743
'bzrlib.tests.test_uncommit',
2744
'bzrlib.tests.test_upgrade',
2745
'bzrlib.tests.test_urlutils',
2746
'bzrlib.tests.test_versionedfile',
2747
'bzrlib.tests.test_version',
2748
'bzrlib.tests.test_version_info',
2749
'bzrlib.tests.test_weave',
2750
'bzrlib.tests.test_whitebox',
2751
'bzrlib.tests.test_win32utils',
2752
'bzrlib.tests.test_workingtree',
2753
'bzrlib.tests.test_workingtree_4',
2754
'bzrlib.tests.test_wsgi',
2755
'bzrlib.tests.test_xml',
2756
'bzrlib.tests.tree_implementations',
2757
'bzrlib.tests.workingtree_implementations',
2760
loader = TestUtil.TestLoader()
2762
if keep_only is None:
2763
loader = TestUtil.TestLoader()
2765
id_filter = TestIdList(keep_only)
2766
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2767
suite = loader.suiteClass()
2769
# modules building their suite with loadTestsFromModuleNames
2770
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2772
modules_to_doctest = [
2777
'bzrlib.iterablefile',
2782
'bzrlib.symbol_versioning',
2785
'bzrlib.version_info_formats.format_custom',
2788
for mod in modules_to_doctest:
2789
if not (keep_only is None or id_filter.refers_to(mod)):
2790
# No tests to keep here, move along
2793
doc_suite = doctest.DocTestSuite(mod)
2794
except ValueError, e:
2795
print '**failed to get doctest for: %s\n%s' % (mod, e)
2797
suite.addTest(doc_suite)
2799
default_encoding = sys.getdefaultencoding()
2800
for name, plugin in bzrlib.plugin.plugins().items():
2801
if keep_only is not None:
2802
if not id_filter.refers_to(plugin.module.__name__):
2804
plugin_suite = plugin.test_suite()
2805
# We used to catch ImportError here and turn it into just a warning,
2806
# but really if you don't have --no-plugins this should be a failure.
2807
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
2808
if plugin_suite is None:
2809
plugin_suite = plugin.load_plugin_tests(loader)
2810
if plugin_suite is not None:
2811
suite.addTest(plugin_suite)
2812
if default_encoding != sys.getdefaultencoding():
2813
bzrlib.trace.warning(
2814
'Plugin "%s" tried to reset default encoding to: %s', name,
2815
sys.getdefaultencoding())
2817
sys.setdefaultencoding(default_encoding)
2819
if keep_only is not None:
2820
# Now that the referred modules have loaded their tests, keep only the
2822
suite = filter_suite_by_id_list(suite, id_filter)
2823
# Do some sanity checks on the id_list filtering
2824
not_found, duplicates = suite_matches_id_list(suite, keep_only)
2825
for id in not_found:
2826
bzrlib.trace.warning('"%s" not found in the test suite', id)
2827
for id in duplicates:
2828
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
2833
def multiply_tests_from_modules(module_name_list, scenario_iter, loader=None):
2834
"""Adapt all tests in some given modules to given scenarios.
2836
This is the recommended public interface for test parameterization.
2837
Typically the test_suite() method for a per-implementation test
2838
suite will call multiply_tests_from_modules and return the
2841
:param module_name_list: List of fully-qualified names of test
2843
:param scenario_iter: Iterable of pairs of (scenario_name,
2844
scenario_param_dict).
2845
:param loader: If provided, will be used instead of a new
2846
bzrlib.tests.TestLoader() instance.
2848
This returns a new TestSuite containing the cross product of
2849
all the tests in all the modules, each repeated for each scenario.
2850
Each test is adapted by adding the scenario name at the end
2851
of its name, and updating the test object's __dict__ with the
2852
scenario_param_dict.
2854
>>> r = multiply_tests_from_modules(
2855
... ['bzrlib.tests.test_sampler'],
2856
... [('one', dict(param=1)),
2857
... ('two', dict(param=2))])
2858
>>> tests = list(iter_suite_tests(r))
2862
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2868
# XXX: Isn't load_tests() a better way to provide the same functionality
2869
# without forcing a predefined TestScenarioApplier ? --vila 080215
2871
loader = TestUtil.TestLoader()
2873
suite = loader.suiteClass()
2875
adapter = TestScenarioApplier()
2876
adapter.scenarios = list(scenario_iter)
2877
adapt_modules(module_name_list, adapter, loader, suite)
2881
def multiply_scenarios(scenarios_left, scenarios_right):
2882
"""Multiply two sets of scenarios.
2884
:returns: the cartesian product of the two sets of scenarios, that is
2885
a scenario for every possible combination of a left scenario and a
2889
('%s,%s' % (left_name, right_name),
2890
dict(left_dict.items() + right_dict.items()))
2891
for left_name, left_dict in scenarios_left
2892
for right_name, right_dict in scenarios_right]
2896
def adapt_modules(mods_list, adapter, loader, suite):
2897
"""Adapt the modules in mods_list using adapter and add to suite."""
2898
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2899
suite.addTests(adapter.adapt(test))
2902
def adapt_tests(tests_list, adapter, loader, suite):
2903
"""Adapt the tests in tests_list using adapter and add to suite."""
2904
for test in tests_list:
2905
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2908
def _rmtree_temp_dir(dirname):
2909
# If LANG=C we probably have created some bogus paths
2910
# which rmtree(unicode) will fail to delete
2911
# so make sure we are using rmtree(str) to delete everything
2912
# except on win32, where rmtree(str) will fail
2913
# since it doesn't have the property of byte-stream paths
2914
# (they are either ascii or mbcs)
2915
if sys.platform == 'win32':
2916
# make sure we are using the unicode win32 api
2917
dirname = unicode(dirname)
2919
dirname = dirname.encode(sys.getfilesystemencoding())
2921
osutils.rmtree(dirname)
2923
if sys.platform == 'win32' and e.errno == errno.EACCES:
2924
sys.stderr.write(('Permission denied: '
2925
'unable to remove testing dir '
2926
'%s\n' % os.path.basename(dirname)))
2931
class Feature(object):
2932
"""An operating system Feature."""
2935
self._available = None
2937
def available(self):
2938
"""Is the feature available?
2940
:return: True if the feature is available.
2942
if self._available is None:
2943
self._available = self._probe()
2944
return self._available
2947
"""Implement this method in concrete features.
2949
:return: True if the feature is available.
2951
raise NotImplementedError
2954
if getattr(self, 'feature_name', None):
2955
return self.feature_name()
2956
return self.__class__.__name__
2959
class _SymlinkFeature(Feature):
2962
return osutils.has_symlinks()
2964
def feature_name(self):
2967
SymlinkFeature = _SymlinkFeature()
2970
class _HardlinkFeature(Feature):
2973
return osutils.has_hardlinks()
2975
def feature_name(self):
2978
HardlinkFeature = _HardlinkFeature()
2981
class _OsFifoFeature(Feature):
2984
return getattr(os, 'mkfifo', None)
2986
def feature_name(self):
2987
return 'filesystem fifos'
2989
OsFifoFeature = _OsFifoFeature()
2992
class TestScenarioApplier(object):
2993
"""A tool to apply scenarios to tests."""
2995
def adapt(self, test):
2996
"""Return a TestSuite containing a copy of test for each scenario."""
2997
result = unittest.TestSuite()
2998
for scenario in self.scenarios:
2999
result.addTest(self.adapt_test_to_scenario(test, scenario))
3002
def adapt_test_to_scenario(self, test, scenario):
3003
"""Copy test and apply scenario to it.
3005
:param test: A test to adapt.
3006
:param scenario: A tuple describing the scenarion.
3007
The first element of the tuple is the new test id.
3008
The second element is a dict containing attributes to set on the
3010
:return: The adapted test.
3012
from copy import deepcopy
3013
new_test = deepcopy(test)
3014
for name, value in scenario[1].items():
3015
setattr(new_test, name, value)
3016
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3017
new_test.id = lambda: new_id
3021
def probe_unicode_in_user_encoding():
3022
"""Try to encode several unicode strings to use in unicode-aware tests.
3023
Return first successfull match.
3025
:return: (unicode value, encoded plain string value) or (None, None)
3027
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3028
for uni_val in possible_vals:
3030
str_val = uni_val.encode(bzrlib.user_encoding)
3031
except UnicodeEncodeError:
3032
# Try a different character
3035
return uni_val, str_val
3039
def probe_bad_non_ascii(encoding):
3040
"""Try to find [bad] character with code [128..255]
3041
that cannot be decoded to unicode in some encoding.
3042
Return None if all non-ascii characters is valid
3045
for i in xrange(128, 256):
3048
char.decode(encoding)
3049
except UnicodeDecodeError:
3054
class _FTPServerFeature(Feature):
3055
"""Some tests want an FTP Server, check if one is available.
3057
Right now, the only way this is available is if 'medusa' is installed.
3058
http://www.amk.ca/python/code/medusa.html
3063
import bzrlib.tests.ftp_server
3068
def feature_name(self):
3071
FTPServerFeature = _FTPServerFeature()
3074
class _CaseInsensitiveFilesystemFeature(Feature):
3075
"""Check if underlined filesystem is case-insensitive
3076
(e.g. on Windows, Cygwin, MacOS)
3080
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3081
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3082
TestCaseWithMemoryTransport.TEST_ROOT = root
3084
root = TestCaseWithMemoryTransport.TEST_ROOT
3085
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3087
name_a = osutils.pathjoin(tdir, 'a')
3088
name_A = osutils.pathjoin(tdir, 'A')
3090
result = osutils.isdir(name_A)
3091
_rmtree_temp_dir(tdir)
3094
def feature_name(self):
3095
return 'case-insensitive filesystem'
3097
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
