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
62
import bzrlib.commands
63
import bzrlib.timestamp
65
import bzrlib.inventory
66
import bzrlib.iterablefile
71
# lsprof not available
73
from bzrlib.merge import merge_inner
76
from bzrlib.revision import common_ancestor
78
from bzrlib import symbol_versioning
79
from bzrlib.symbol_versioning import (
89
from bzrlib.transport import get_transport
90
import bzrlib.transport
91
from bzrlib.transport.local import LocalURLServer
92
from bzrlib.transport.memory import MemoryServer
93
from bzrlib.transport.readonly import ReadonlyServer
94
from bzrlib.trace import mutter, note
95
from bzrlib.tests import TestUtil
96
from bzrlib.tests.http_server import HttpServer
97
from bzrlib.tests.TestUtil import (
101
from bzrlib.tests.treeshape import build_tree_contents
102
import bzrlib.version_info_formats.format_custom
103
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
105
# Mark this python module as being part of the implementation
106
# of unittest: this gives us better tracebacks where the last
107
# shown frame is the test code, not our assertXYZ.
110
default_transport = LocalURLServer
112
MODULES_TO_DOCTEST = [
123
bzrlib.version_info_formats.format_custom,
124
# quoted to avoid module-loading circularity
129
def packages_to_test():
130
"""Return a list of packages to test.
132
The packages are not globally imported so that import failures are
133
triggered when running selftest, not when importing the command.
136
import bzrlib.tests.blackbox
137
import bzrlib.tests.branch_implementations
138
import bzrlib.tests.bzrdir_implementations
139
import bzrlib.tests.commands
140
import bzrlib.tests.interrepository_implementations
141
import bzrlib.tests.interversionedfile_implementations
142
import bzrlib.tests.intertree_implementations
143
import bzrlib.tests.inventory_implementations
144
import bzrlib.tests.per_lock
145
import bzrlib.tests.repository_implementations
146
import bzrlib.tests.revisionstore_implementations
147
import bzrlib.tests.tree_implementations
148
import bzrlib.tests.workingtree_implementations
151
bzrlib.tests.blackbox,
152
bzrlib.tests.branch_implementations,
153
bzrlib.tests.bzrdir_implementations,
154
bzrlib.tests.commands,
155
bzrlib.tests.interrepository_implementations,
156
bzrlib.tests.interversionedfile_implementations,
157
bzrlib.tests.intertree_implementations,
158
bzrlib.tests.inventory_implementations,
159
bzrlib.tests.per_lock,
160
bzrlib.tests.repository_implementations,
161
bzrlib.tests.revisionstore_implementations,
162
bzrlib.tests.tree_implementations,
163
bzrlib.tests.workingtree_implementations,
167
class ExtendedTestResult(unittest._TextTestResult):
168
"""Accepts, reports and accumulates the results of running tests.
170
Compared to the unittest version this class adds support for
171
profiling, benchmarking, stopping as soon as a test fails, and
172
skipping tests. There are further-specialized subclasses for
173
different types of display.
175
When a test finishes, in whatever way, it calls one of the addSuccess,
176
addFailure or addError classes. These in turn may redirect to a more
177
specific case for the special test results supported by our extended
180
Note that just one of these objects is fed the results from many tests.
185
def __init__(self, stream, descriptions, verbosity,
189
"""Construct new TestResult.
191
:param bench_history: Optionally, a writable file object to accumulate
194
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
195
if bench_history is not None:
196
from bzrlib.version import _get_bzr_source_tree
197
src_tree = _get_bzr_source_tree()
200
revision_id = src_tree.get_parent_ids()[0]
202
# XXX: if this is a brand new tree, do the same as if there
206
# XXX: If there's no branch, what should we do?
208
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
209
self._bench_history = bench_history
210
self.ui = ui.ui_factory
211
self.num_tests = num_tests
213
self.failure_count = 0
214
self.known_failure_count = 0
216
self.not_applicable_count = 0
217
self.unsupported = {}
219
self._overall_start_time = time.time()
221
def _extractBenchmarkTime(self, testCase):
222
"""Add a benchmark time for the current test case."""
223
return getattr(testCase, "_benchtime", None)
225
def _elapsedTestTimeString(self):
226
"""Return a time string for the overall time the current test has taken."""
227
return self._formatTime(time.time() - self._start_time)
229
def _testTimeString(self, testCase):
230
benchmark_time = self._extractBenchmarkTime(testCase)
231
if benchmark_time is not None:
233
self._formatTime(benchmark_time),
234
self._elapsedTestTimeString())
236
return " %s" % self._elapsedTestTimeString()
238
def _formatTime(self, seconds):
239
"""Format seconds as milliseconds with leading spaces."""
240
# some benchmarks can take thousands of seconds to run, so we need 8
242
return "%8dms" % (1000 * seconds)
244
def _shortened_test_description(self, test):
246
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
249
def startTest(self, test):
250
unittest.TestResult.startTest(self, test)
251
self.report_test_start(test)
252
test.number = self.count
253
self._recordTestStartTime()
255
def _recordTestStartTime(self):
256
"""Record that a test has started."""
257
self._start_time = time.time()
259
def _cleanupLogFile(self, test):
260
# We can only do this if we have one of our TestCases, not if
262
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
263
if setKeepLogfile is not None:
266
def addError(self, test, err):
267
"""Tell result that test finished with an error.
269
Called from the TestCase run() method when the test
270
fails with an unexpected error.
272
self._testConcluded(test)
273
if isinstance(err[1], TestSkipped):
274
return self._addSkipped(test, err)
275
elif isinstance(err[1], UnavailableFeature):
276
return self.addNotSupported(test, err[1].args[0])
278
self._cleanupLogFile(test)
279
unittest.TestResult.addError(self, test, err)
280
self.error_count += 1
281
self.report_error(test, err)
285
def addFailure(self, test, err):
286
"""Tell result that test failed.
288
Called from the TestCase run() method when the test
289
fails because e.g. an assert() method failed.
291
self._testConcluded(test)
292
if isinstance(err[1], KnownFailure):
293
return self._addKnownFailure(test, err)
295
self._cleanupLogFile(test)
296
unittest.TestResult.addFailure(self, test, err)
297
self.failure_count += 1
298
self.report_failure(test, err)
302
def addSuccess(self, test):
303
"""Tell result that test completed successfully.
305
Called from the TestCase run()
307
self._testConcluded(test)
308
if self._bench_history is not None:
309
benchmark_time = self._extractBenchmarkTime(test)
310
if benchmark_time is not None:
311
self._bench_history.write("%s %s\n" % (
312
self._formatTime(benchmark_time),
314
self.report_success(test)
315
self._cleanupLogFile(test)
316
unittest.TestResult.addSuccess(self, test)
317
test._log_contents = ''
319
def _testConcluded(self, test):
320
"""Common code when a test has finished.
322
Called regardless of whether it succeded, failed, etc.
326
def _addKnownFailure(self, test, err):
327
self.known_failure_count += 1
328
self.report_known_failure(test, err)
330
def addNotSupported(self, test, feature):
331
"""The test will not be run because of a missing feature.
333
# this can be called in two different ways: it may be that the
334
# test started running, and then raised (through addError)
335
# UnavailableFeature. Alternatively this method can be called
336
# while probing for features before running the tests; in that
337
# case we will see startTest and stopTest, but the test will never
339
self.unsupported.setdefault(str(feature), 0)
340
self.unsupported[str(feature)] += 1
341
self.report_unsupported(test, feature)
343
def _addSkipped(self, test, skip_excinfo):
344
if isinstance(skip_excinfo[1], TestNotApplicable):
345
self.not_applicable_count += 1
346
self.report_not_applicable(test, skip_excinfo)
349
self.report_skip(test, skip_excinfo)
352
except KeyboardInterrupt:
355
self.addError(test, test._exc_info())
357
# seems best to treat this as success from point-of-view of unittest
358
# -- it actually does nothing so it barely matters :)
359
unittest.TestResult.addSuccess(self, test)
360
test._log_contents = ''
362
def printErrorList(self, flavour, errors):
363
for test, err in errors:
364
self.stream.writeln(self.separator1)
365
self.stream.write("%s: " % flavour)
366
self.stream.writeln(self.getDescription(test))
367
if getattr(test, '_get_log', None) is not None:
368
self.stream.write('\n')
370
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
371
self.stream.write('\n')
372
self.stream.write(test._get_log())
373
self.stream.write('\n')
375
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
376
self.stream.write('\n')
377
self.stream.writeln(self.separator2)
378
self.stream.writeln("%s" % err)
383
def report_cleaning_up(self):
386
def report_success(self, test):
389
def wasStrictlySuccessful(self):
390
if self.unsupported or self.known_failure_count:
392
return self.wasSuccessful()
395
class TextTestResult(ExtendedTestResult):
396
"""Displays progress and results of tests in text form"""
398
def __init__(self, stream, descriptions, verbosity,
403
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
404
bench_history, num_tests)
406
self.pb = self.ui.nested_progress_bar()
407
self._supplied_pb = False
410
self._supplied_pb = True
411
self.pb.show_pct = False
412
self.pb.show_spinner = False
413
self.pb.show_eta = False,
414
self.pb.show_count = False
415
self.pb.show_bar = False
417
def report_starting(self):
418
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
420
def _progress_prefix_text(self):
421
a = '[%d' % self.count
422
if self.num_tests is not None:
423
a +='/%d' % self.num_tests
424
a += ' in %ds' % (time.time() - self._overall_start_time)
426
a += ', %d errors' % self.error_count
427
if self.failure_count:
428
a += ', %d failed' % self.failure_count
429
if self.known_failure_count:
430
a += ', %d known failures' % self.known_failure_count
432
a += ', %d skipped' % self.skip_count
434
a += ', %d missing features' % len(self.unsupported)
438
def report_test_start(self, test):
441
self._progress_prefix_text()
443
+ self._shortened_test_description(test))
445
def _test_description(self, test):
446
return self._shortened_test_description(test)
448
def report_error(self, test, err):
449
self.pb.note('ERROR: %s\n %s\n',
450
self._test_description(test),
454
def report_failure(self, test, err):
455
self.pb.note('FAIL: %s\n %s\n',
456
self._test_description(test),
460
def report_known_failure(self, test, err):
461
self.pb.note('XFAIL: %s\n%s\n',
462
self._test_description(test), err[1])
464
def report_skip(self, test, skip_excinfo):
467
def report_not_applicable(self, test, skip_excinfo):
470
def report_unsupported(self, test, feature):
471
"""test cannot be run because feature is missing."""
473
def report_cleaning_up(self):
474
self.pb.update('cleaning up...')
477
if not self._supplied_pb:
481
class VerboseTestResult(ExtendedTestResult):
482
"""Produce long output, with one line per test run plus times"""
484
def _ellipsize_to_right(self, a_string, final_width):
485
"""Truncate and pad a string, keeping the right hand side"""
486
if len(a_string) > final_width:
487
result = '...' + a_string[3-final_width:]
490
return result.ljust(final_width)
492
def report_starting(self):
493
self.stream.write('running %d tests...\n' % self.num_tests)
495
def report_test_start(self, test):
497
name = self._shortened_test_description(test)
498
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
499
# numbers, plus a trailing blank
500
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
501
self.stream.write(self._ellipsize_to_right(name,
502
osutils.terminal_width()-30))
505
def _error_summary(self, err):
507
return '%s%s' % (indent, err[1])
509
def report_error(self, test, err):
510
self.stream.writeln('ERROR %s\n%s'
511
% (self._testTimeString(test),
512
self._error_summary(err)))
514
def report_failure(self, test, err):
515
self.stream.writeln(' FAIL %s\n%s'
516
% (self._testTimeString(test),
517
self._error_summary(err)))
519
def report_known_failure(self, test, err):
520
self.stream.writeln('XFAIL %s\n%s'
521
% (self._testTimeString(test),
522
self._error_summary(err)))
524
def report_success(self, test):
525
self.stream.writeln(' OK %s' % self._testTimeString(test))
526
for bench_called, stats in getattr(test, '_benchcalls', []):
527
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
528
stats.pprint(file=self.stream)
529
# flush the stream so that we get smooth output. This verbose mode is
530
# used to show the output in PQM.
533
def report_skip(self, test, skip_excinfo):
534
self.stream.writeln(' SKIP %s\n%s'
535
% (self._testTimeString(test),
536
self._error_summary(skip_excinfo)))
538
def report_not_applicable(self, test, skip_excinfo):
539
self.stream.writeln(' N/A %s\n%s'
540
% (self._testTimeString(test),
541
self._error_summary(skip_excinfo)))
543
def report_unsupported(self, test, feature):
544
"""test cannot be run because feature is missing."""
545
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
546
%(self._testTimeString(test), feature))
549
class TextTestRunner(object):
550
stop_on_failure = False
559
self.stream = unittest._WritelnDecorator(stream)
560
self.descriptions = descriptions
561
self.verbosity = verbosity
562
self._bench_history = bench_history
563
self.list_only = list_only
566
"Run the given test case or test suite."
567
startTime = time.time()
568
if self.verbosity == 1:
569
result_class = TextTestResult
570
elif self.verbosity >= 2:
571
result_class = VerboseTestResult
572
result = result_class(self.stream,
575
bench_history=self._bench_history,
576
num_tests=test.countTestCases(),
578
result.stop_early = self.stop_on_failure
579
result.report_starting()
581
if self.verbosity >= 2:
582
self.stream.writeln("Listing tests only ...\n")
584
for t in iter_suite_tests(test):
585
self.stream.writeln("%s" % (t.id()))
587
actionTaken = "Listed"
590
run = result.testsRun
592
stopTime = time.time()
593
timeTaken = stopTime - startTime
595
self.stream.writeln(result.separator2)
596
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
597
run, run != 1 and "s" or "", timeTaken))
598
self.stream.writeln()
599
if not result.wasSuccessful():
600
self.stream.write("FAILED (")
601
failed, errored = map(len, (result.failures, result.errors))
603
self.stream.write("failures=%d" % failed)
605
if failed: self.stream.write(", ")
606
self.stream.write("errors=%d" % errored)
607
if result.known_failure_count:
608
if failed or errored: self.stream.write(", ")
609
self.stream.write("known_failure_count=%d" %
610
result.known_failure_count)
611
self.stream.writeln(")")
613
if result.known_failure_count:
614
self.stream.writeln("OK (known_failures=%d)" %
615
result.known_failure_count)
617
self.stream.writeln("OK")
618
if result.skip_count > 0:
619
skipped = result.skip_count
620
self.stream.writeln('%d test%s skipped' %
621
(skipped, skipped != 1 and "s" or ""))
622
if result.unsupported:
623
for feature, count in sorted(result.unsupported.items()):
624
self.stream.writeln("Missing feature '%s' skipped %d tests." %
630
def iter_suite_tests(suite):
631
"""Return all tests in a suite, recursing through nested suites"""
632
for item in suite._tests:
633
if isinstance(item, unittest.TestCase):
635
elif isinstance(item, unittest.TestSuite):
636
for r in iter_suite_tests(item):
639
raise Exception('unknown object %r inside test suite %r'
643
class TestSkipped(Exception):
644
"""Indicates that a test was intentionally skipped, rather than failing."""
647
class TestNotApplicable(TestSkipped):
648
"""A test is not applicable to the situation where it was run.
650
This is only normally raised by parameterized tests, if they find that
651
the instance they're constructed upon does not support one aspect
656
class KnownFailure(AssertionError):
657
"""Indicates that a test failed in a precisely expected manner.
659
Such failures dont block the whole test suite from passing because they are
660
indicators of partially completed code or of future work. We have an
661
explicit error for them so that we can ensure that they are always visible:
662
KnownFailures are always shown in the output of bzr selftest.
666
class UnavailableFeature(Exception):
667
"""A feature required for this test was not available.
669
The feature should be used to construct the exception.
673
class CommandFailed(Exception):
677
class StringIOWrapper(object):
678
"""A wrapper around cStringIO which just adds an encoding attribute.
680
Internally we can check sys.stdout to see what the output encoding
681
should be. However, cStringIO has no encoding attribute that we can
682
set. So we wrap it instead.
687
def __init__(self, s=None):
689
self.__dict__['_cstring'] = StringIO(s)
691
self.__dict__['_cstring'] = StringIO()
693
def __getattr__(self, name, getattr=getattr):
694
return getattr(self.__dict__['_cstring'], name)
696
def __setattr__(self, name, val):
697
if name == 'encoding':
698
self.__dict__['encoding'] = val
700
return setattr(self._cstring, name, val)
703
class TestUIFactory(ui.CLIUIFactory):
704
"""A UI Factory for testing.
706
Hide the progress bar but emit note()s.
708
Allows get_password to be tested without real tty attached.
715
super(TestUIFactory, self).__init__()
716
if stdin is not None:
717
# We use a StringIOWrapper to be able to test various
718
# encodings, but the user is still responsible to
719
# encode the string and to set the encoding attribute
720
# of StringIOWrapper.
721
self.stdin = StringIOWrapper(stdin)
723
self.stdout = sys.stdout
727
self.stderr = sys.stderr
732
"""See progress.ProgressBar.clear()."""
734
def clear_term(self):
735
"""See progress.ProgressBar.clear_term()."""
737
def clear_term(self):
738
"""See progress.ProgressBar.clear_term()."""
741
"""See progress.ProgressBar.finished()."""
743
def note(self, fmt_string, *args, **kwargs):
744
"""See progress.ProgressBar.note()."""
745
self.stdout.write((fmt_string + "\n") % args)
747
def progress_bar(self):
750
def nested_progress_bar(self):
753
def update(self, message, count=None, total=None):
754
"""See progress.ProgressBar.update()."""
756
def get_non_echoed_password(self, prompt):
757
"""Get password from stdin without trying to handle the echo mode"""
759
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
760
password = self.stdin.readline()
763
if password[-1] == '\n':
764
password = password[:-1]
768
class TestCase(unittest.TestCase):
769
"""Base class for bzr unit tests.
771
Tests that need access to disk resources should subclass
772
TestCaseInTempDir not TestCase.
774
Error and debug log messages are redirected from their usual
775
location into a temporary file, the contents of which can be
776
retrieved by _get_log(). We use a real OS file, not an in-memory object,
777
so that it can also capture file IO. When the test completes this file
778
is read into memory and removed from disk.
780
There are also convenience functions to invoke bzr's command-line
781
routine, and to build and check bzr trees.
783
In addition to the usual method of overriding tearDown(), this class also
784
allows subclasses to register functions into the _cleanups list, which is
785
run in order as the object is torn down. It's less likely this will be
786
accidentally overlooked.
789
_log_file_name = None
791
_keep_log_file = False
792
# record lsprof data when performing benchmark calls.
793
_gather_lsprof_in_benchmarks = False
794
attrs_to_keep = ('_testMethodName', '_testMethodDoc',
795
'_log_contents', '_log_file_name', '_benchtime',
796
'_TestCase__testMethodName')
798
def __init__(self, methodName='testMethod'):
799
super(TestCase, self).__init__(methodName)
803
unittest.TestCase.setUp(self)
804
self._cleanEnvironment()
807
self._benchcalls = []
808
self._benchtime = None
810
self._clear_debug_flags()
812
def _clear_debug_flags(self):
813
"""Prevent externally set debug flags affecting tests.
815
Tests that want to use debug flags can just set them in the
816
debug_flags set during setup/teardown.
818
if 'selftest_debug' not in debug.debug_flags:
819
self._preserved_debug_flags = set(debug.debug_flags)
820
debug.debug_flags.clear()
821
self.addCleanup(self._restore_debug_flags)
823
def _clear_hooks(self):
824
# prevent hooks affecting tests
826
import bzrlib.smart.server
827
self._preserved_hooks = {
828
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
829
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
831
self.addCleanup(self._restoreHooks)
832
# reset all hooks to an empty instance of the appropriate type
833
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
834
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
836
def _silenceUI(self):
837
"""Turn off UI for duration of test"""
838
# by default the UI is off; tests can turn it on if they want it.
839
saved = ui.ui_factory
841
ui.ui_factory = saved
842
ui.ui_factory = ui.SilentUIFactory()
843
self.addCleanup(_restore)
845
def _ndiff_strings(self, a, b):
846
"""Return ndiff between two strings containing lines.
848
A trailing newline is added if missing to make the strings
850
if b and b[-1] != '\n':
852
if a and a[-1] != '\n':
854
difflines = difflib.ndiff(a.splitlines(True),
856
linejunk=lambda x: False,
857
charjunk=lambda x: False)
858
return ''.join(difflines)
860
def assertEqual(self, a, b, message=''):
864
except UnicodeError, e:
865
# If we can't compare without getting a UnicodeError, then
866
# obviously they are different
867
mutter('UnicodeError: %s', e)
870
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
872
pformat(a), pformat(b)))
874
assertEquals = assertEqual
876
def assertEqualDiff(self, a, b, message=None):
877
"""Assert two texts are equal, if not raise an exception.
879
This is intended for use with multi-line strings where it can
880
be hard to find the differences by eye.
882
# TODO: perhaps override assertEquals to call this for strings?
886
message = "texts not equal:\n"
887
raise AssertionError(message +
888
self._ndiff_strings(a, b))
890
def assertEqualMode(self, mode, mode_test):
891
self.assertEqual(mode, mode_test,
892
'mode mismatch %o != %o' % (mode, mode_test))
894
def assertPositive(self, val):
895
"""Assert that val is greater than 0."""
896
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
898
def assertNegative(self, val):
899
"""Assert that val is less than 0."""
900
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
902
def assertStartsWith(self, s, prefix):
903
if not s.startswith(prefix):
904
raise AssertionError('string %r does not start with %r' % (s, prefix))
906
def assertEndsWith(self, s, suffix):
907
"""Asserts that s ends with suffix."""
908
if not s.endswith(suffix):
909
raise AssertionError('string %r does not end with %r' % (s, suffix))
911
def assertContainsRe(self, haystack, needle_re):
912
"""Assert that a contains something matching a regular expression."""
913
if not re.search(needle_re, haystack):
914
if '\n' in haystack or len(haystack) > 60:
915
# a long string, format it in a more readable way
916
raise AssertionError(
917
'pattern "%s" not found in\n"""\\\n%s"""\n'
918
% (needle_re, haystack))
920
raise AssertionError('pattern "%s" not found in "%s"'
921
% (needle_re, haystack))
923
def assertNotContainsRe(self, haystack, needle_re):
924
"""Assert that a does not match a regular expression"""
925
if re.search(needle_re, haystack):
926
raise AssertionError('pattern "%s" found in "%s"'
927
% (needle_re, haystack))
929
def assertSubset(self, sublist, superlist):
930
"""Assert that every entry in sublist is present in superlist."""
931
missing = set(sublist) - set(superlist)
933
raise AssertionError("value(s) %r not present in container %r" %
934
(missing, superlist))
936
def assertListRaises(self, excClass, func, *args, **kwargs):
937
"""Fail unless excClass is raised when the iterator from func is used.
939
Many functions can return generators this makes sure
940
to wrap them in a list() call to make sure the whole generator
941
is run, and that the proper exception is raised.
944
list(func(*args, **kwargs))
948
if getattr(excClass,'__name__', None) is not None:
949
excName = excClass.__name__
951
excName = str(excClass)
952
raise self.failureException, "%s not raised" % excName
954
def assertRaises(self, excClass, callableObj, *args, **kwargs):
955
"""Assert that a callable raises a particular exception.
957
:param excClass: As for the except statement, this may be either an
958
exception class, or a tuple of classes.
959
:param callableObj: A callable, will be passed ``*args`` and
962
Returns the exception so that you can examine it.
965
callableObj(*args, **kwargs)
969
if getattr(excClass,'__name__', None) is not None:
970
excName = excClass.__name__
973
excName = str(excClass)
974
raise self.failureException, "%s not raised" % excName
976
def assertIs(self, left, right, message=None):
977
if not (left is right):
978
if message is not None:
979
raise AssertionError(message)
981
raise AssertionError("%r is not %r." % (left, right))
983
def assertIsNot(self, left, right, message=None):
985
if message is not None:
986
raise AssertionError(message)
988
raise AssertionError("%r is %r." % (left, right))
990
def assertTransportMode(self, transport, path, mode):
991
"""Fail if a path does not have mode mode.
993
If modes are not supported on this transport, the assertion is ignored.
995
if not transport._can_roundtrip_unix_modebits():
997
path_stat = transport.stat(path)
998
actual_mode = stat.S_IMODE(path_stat.st_mode)
999
self.assertEqual(mode, actual_mode,
1000
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
1002
def assertIsSameRealPath(self, path1, path2):
1003
"""Fail if path1 and path2 points to different files"""
1004
self.assertEqual(osutils.realpath(path1),
1005
osutils.realpath(path2),
1006
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1008
def assertIsInstance(self, obj, kls):
1009
"""Fail if obj is not an instance of kls"""
1010
if not isinstance(obj, kls):
1011
self.fail("%r is an instance of %s rather than %s" % (
1012
obj, obj.__class__, kls))
1014
def expectFailure(self, reason, assertion, *args, **kwargs):
1015
"""Invoke a test, expecting it to fail for the given reason.
1017
This is for assertions that ought to succeed, but currently fail.
1018
(The failure is *expected* but not *wanted*.) Please be very precise
1019
about the failure you're expecting. If a new bug is introduced,
1020
AssertionError should be raised, not KnownFailure.
1022
Frequently, expectFailure should be followed by an opposite assertion.
1025
Intended to be used with a callable that raises AssertionError as the
1026
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1028
Raises KnownFailure if the test fails. Raises AssertionError if the
1033
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1035
self.assertEqual(42, dynamic_val)
1037
This means that a dynamic_val of 54 will cause the test to raise
1038
a KnownFailure. Once math is fixed and the expectFailure is removed,
1039
only a dynamic_val of 42 will allow the test to pass. Anything other
1040
than 54 or 42 will cause an AssertionError.
1043
assertion(*args, **kwargs)
1044
except AssertionError:
1045
raise KnownFailure(reason)
1047
self.fail('Unexpected success. Should have failed: %s' % reason)
1049
def assertFileEqual(self, content, path):
1050
"""Fail if path does not contain 'content'."""
1051
self.failUnlessExists(path)
1052
f = file(path, 'rb')
1057
self.assertEqualDiff(content, s)
1059
def failUnlessExists(self, path):
1060
"""Fail unless path or paths, which may be abs or relative, exist."""
1061
if not isinstance(path, basestring):
1063
self.failUnlessExists(p)
1065
self.failUnless(osutils.lexists(path),path+" does not exist")
1067
def failIfExists(self, path):
1068
"""Fail if path or paths, which may be abs or relative, exist."""
1069
if not isinstance(path, basestring):
1071
self.failIfExists(p)
1073
self.failIf(osutils.lexists(path),path+" exists")
1075
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1076
"""A helper for callDeprecated and applyDeprecated.
1078
:param a_callable: A callable to call.
1079
:param args: The positional arguments for the callable
1080
:param kwargs: The keyword arguments for the callable
1081
:return: A tuple (warnings, result). result is the result of calling
1082
a_callable(``*args``, ``**kwargs``).
1085
def capture_warnings(msg, cls=None, stacklevel=None):
1086
# we've hooked into a deprecation specific callpath,
1087
# only deprecations should getting sent via it.
1088
self.assertEqual(cls, DeprecationWarning)
1089
local_warnings.append(msg)
1090
original_warning_method = symbol_versioning.warn
1091
symbol_versioning.set_warning_method(capture_warnings)
1093
result = a_callable(*args, **kwargs)
1095
symbol_versioning.set_warning_method(original_warning_method)
1096
return (local_warnings, result)
1098
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1099
"""Call a deprecated callable without warning the user.
1101
Note that this only captures warnings raised by symbol_versioning.warn,
1102
not other callers that go direct to the warning module.
1104
To test that a deprecated method raises an error, do something like
1107
self.assertRaises(errors.ReservedId,
1108
self.applyDeprecated, zero_ninetyone,
1109
br.append_revision, 'current:')
1111
:param deprecation_format: The deprecation format that the callable
1112
should have been deprecated with. This is the same type as the
1113
parameter to deprecated_method/deprecated_function. If the
1114
callable is not deprecated with this format, an assertion error
1116
:param a_callable: A callable to call. This may be a bound method or
1117
a regular function. It will be called with ``*args`` and
1119
:param args: The positional arguments for the callable
1120
:param kwargs: The keyword arguments for the callable
1121
:return: The result of a_callable(``*args``, ``**kwargs``)
1123
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1125
expected_first_warning = symbol_versioning.deprecation_string(
1126
a_callable, deprecation_format)
1127
if len(call_warnings) == 0:
1128
self.fail("No deprecation warning generated by call to %s" %
1130
self.assertEqual(expected_first_warning, call_warnings[0])
1133
def callCatchWarnings(self, fn, *args, **kw):
1134
"""Call a callable that raises python warnings.
1136
The caller's responsible for examining the returned warnings.
1138
If the callable raises an exception, the exception is not
1139
caught and propagates up to the caller. In that case, the list
1140
of warnings is not available.
1142
:returns: ([warning_object, ...], fn_result)
1144
# XXX: This is not perfect, because it completely overrides the
1145
# warnings filters, and some code may depend on suppressing particular
1146
# warnings. It's the easiest way to insulate ourselves from -Werror,
1147
# though. -- Andrew, 20071062
1149
def _catcher(message, category, filename, lineno, file=None):
1150
# despite the name, 'message' is normally(?) a Warning subclass
1152
wlist.append(message)
1153
saved_showwarning = warnings.showwarning
1154
saved_filters = warnings.filters
1156
warnings.showwarning = _catcher
1157
warnings.filters = []
1158
result = fn(*args, **kw)
1160
warnings.showwarning = saved_showwarning
1161
warnings.filters = saved_filters
1162
return wlist, result
1164
def callDeprecated(self, expected, callable, *args, **kwargs):
1165
"""Assert that a callable is deprecated in a particular way.
1167
This is a very precise test for unusual requirements. The
1168
applyDeprecated helper function is probably more suited for most tests
1169
as it allows you to simply specify the deprecation format being used
1170
and will ensure that that is issued for the function being called.
1172
Note that this only captures warnings raised by symbol_versioning.warn,
1173
not other callers that go direct to the warning module. To catch
1174
general warnings, use callCatchWarnings.
1176
:param expected: a list of the deprecation warnings expected, in order
1177
:param callable: The callable to call
1178
:param args: The positional arguments for the callable
1179
:param kwargs: The keyword arguments for the callable
1181
call_warnings, result = self._capture_deprecation_warnings(callable,
1183
self.assertEqual(expected, call_warnings)
1186
def _startLogFile(self):
1187
"""Send bzr and test log messages to a temporary file.
1189
The file is removed as the test is torn down.
1191
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1192
self._log_file = os.fdopen(fileno, 'w+')
1193
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1194
self._log_file_name = name
1195
self.addCleanup(self._finishLogFile)
1197
def _finishLogFile(self):
1198
"""Finished with the log file.
1200
Close the file and delete it, unless setKeepLogfile was called.
1202
if self._log_file is None:
1204
bzrlib.trace.pop_log_file(self._log_memento)
1205
self._log_file.close()
1206
self._log_file = None
1207
if not self._keep_log_file:
1208
os.remove(self._log_file_name)
1209
self._log_file_name = None
1211
def setKeepLogfile(self):
1212
"""Make the logfile not be deleted when _finishLogFile is called."""
1213
self._keep_log_file = True
1215
def addCleanup(self, callable):
1216
"""Arrange to run a callable when this case is torn down.
1218
Callables are run in the reverse of the order they are registered,
1219
ie last-in first-out.
1221
if callable in self._cleanups:
1222
raise ValueError("cleanup function %r already registered on %s"
1224
self._cleanups.append(callable)
1226
def _cleanEnvironment(self):
1228
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1229
'HOME': os.getcwd(),
1230
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1231
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1233
'BZREMAIL': None, # may still be present in the environment
1235
'BZR_PROGRESS_BAR': None,
1238
'SSH_AUTH_SOCK': None,
1242
'https_proxy': None,
1243
'HTTPS_PROXY': None,
1248
# Nobody cares about these ones AFAIK. So far at
1249
# least. If you do (care), please update this comment
1253
'BZR_REMOTE_PATH': None,
1256
self.addCleanup(self._restoreEnvironment)
1257
for name, value in new_env.iteritems():
1258
self._captureVar(name, value)
1260
def _captureVar(self, name, newvalue):
1261
"""Set an environment variable, and reset it when finished."""
1262
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1264
def _restore_debug_flags(self):
1265
debug.debug_flags.clear()
1266
debug.debug_flags.update(self._preserved_debug_flags)
1268
def _restoreEnvironment(self):
1269
for name, value in self.__old_env.iteritems():
1270
osutils.set_or_unset_env(name, value)
1272
def _restoreHooks(self):
1273
for klass, hooks in self._preserved_hooks.items():
1274
setattr(klass, 'hooks', hooks)
1276
def knownFailure(self, reason):
1277
"""This test has failed for some known reason."""
1278
raise KnownFailure(reason)
1280
def run(self, result=None):
1281
if result is None: result = self.defaultTestResult()
1282
for feature in getattr(self, '_test_needs_features', []):
1283
if not feature.available():
1284
result.startTest(self)
1285
if getattr(result, 'addNotSupported', None):
1286
result.addNotSupported(self, feature)
1288
result.addSuccess(self)
1289
result.stopTest(self)
1292
return unittest.TestCase.run(self, result)
1295
absent_attr = object()
1296
for attr_name in self.attrs_to_keep:
1297
attr = getattr(self, attr_name, absent_attr)
1298
if attr is not absent_attr:
1299
saved_attrs[attr_name] = attr
1300
self.__dict__ = saved_attrs
1304
unittest.TestCase.tearDown(self)
1306
def time(self, callable, *args, **kwargs):
1307
"""Run callable and accrue the time it takes to the benchmark time.
1309
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1310
this will cause lsprofile statistics to be gathered and stored in
1313
if self._benchtime is None:
1317
if not self._gather_lsprof_in_benchmarks:
1318
return callable(*args, **kwargs)
1320
# record this benchmark
1321
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1323
self._benchcalls.append(((callable, args, kwargs), stats))
1326
self._benchtime += time.time() - start
1328
def _runCleanups(self):
1329
"""Run registered cleanup functions.
1331
This should only be called from TestCase.tearDown.
1333
# TODO: Perhaps this should keep running cleanups even if
1334
# one of them fails?
1336
# Actually pop the cleanups from the list so tearDown running
1337
# twice is safe (this happens for skipped tests).
1338
while self._cleanups:
1339
self._cleanups.pop()()
1341
def log(self, *args):
1344
def _get_log(self, keep_log_file=False):
1345
"""Get the log from bzrlib.trace calls from this test.
1347
:param keep_log_file: When True, if the log is still a file on disk
1348
leave it as a file on disk. When False, if the log is still a file
1349
on disk, the log file is deleted and the log preserved as
1351
:return: A string containing the log.
1353
# flush the log file, to get all content
1355
bzrlib.trace._trace_file.flush()
1356
if self._log_contents:
1357
# XXX: this can hardly contain the content flushed above --vila
1359
return self._log_contents
1360
if self._log_file_name is not None:
1361
logfile = open(self._log_file_name)
1363
log_contents = logfile.read()
1366
if not keep_log_file:
1367
self._log_contents = log_contents
1369
os.remove(self._log_file_name)
1371
if sys.platform == 'win32' and e.errno == errno.EACCES:
1372
sys.stderr.write(('Unable to delete log file '
1373
' %r\n' % self._log_file_name))
1378
return "DELETED log file to reduce memory footprint"
1380
def requireFeature(self, feature):
1381
"""This test requires a specific feature is available.
1383
:raises UnavailableFeature: When feature is not available.
1385
if not feature.available():
1386
raise UnavailableFeature(feature)
1388
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1390
"""Run bazaar command line, splitting up a string command line."""
1391
if isinstance(args, basestring):
1392
# shlex don't understand unicode strings,
1393
# so args should be plain string (bialix 20070906)
1394
args = list(shlex.split(str(args)))
1395
return self._run_bzr_core(args, retcode=retcode,
1396
encoding=encoding, stdin=stdin, working_dir=working_dir,
1399
def _run_bzr_core(self, args, retcode, encoding, stdin,
1401
if encoding is None:
1402
encoding = bzrlib.user_encoding
1403
stdout = StringIOWrapper()
1404
stderr = StringIOWrapper()
1405
stdout.encoding = encoding
1406
stderr.encoding = encoding
1408
self.log('run bzr: %r', args)
1409
# FIXME: don't call into logging here
1410
handler = logging.StreamHandler(stderr)
1411
handler.setLevel(logging.INFO)
1412
logger = logging.getLogger('')
1413
logger.addHandler(handler)
1414
old_ui_factory = ui.ui_factory
1415
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1418
if working_dir is not None:
1419
cwd = osutils.getcwd()
1420
os.chdir(working_dir)
1423
result = self.apply_redirected(ui.ui_factory.stdin,
1425
bzrlib.commands.run_bzr_catch_user_errors,
1428
logger.removeHandler(handler)
1429
ui.ui_factory = old_ui_factory
1433
out = stdout.getvalue()
1434
err = stderr.getvalue()
1436
self.log('output:\n%r', out)
1438
self.log('errors:\n%r', err)
1439
if retcode is not None:
1440
self.assertEquals(retcode, result,
1441
message='Unexpected return code')
1444
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1445
working_dir=None, error_regexes=[], output_encoding=None):
1446
"""Invoke bzr, as if it were run from the command line.
1448
The argument list should not include the bzr program name - the
1449
first argument is normally the bzr command. Arguments may be
1450
passed in three ways:
1452
1- A list of strings, eg ["commit", "a"]. This is recommended
1453
when the command contains whitespace or metacharacters, or
1454
is built up at run time.
1456
2- A single string, eg "add a". This is the most convenient
1457
for hardcoded commands.
1459
This runs bzr through the interface that catches and reports
1460
errors, and with logging set to something approximating the
1461
default, so that error reporting can be checked.
1463
This should be the main method for tests that want to exercise the
1464
overall behavior of the bzr application (rather than a unit test
1465
or a functional test of the library.)
1467
This sends the stdout/stderr results into the test's log,
1468
where it may be useful for debugging. See also run_captured.
1470
:keyword stdin: A string to be used as stdin for the command.
1471
:keyword retcode: The status code the command should return;
1473
:keyword working_dir: The directory to run the command in
1474
:keyword error_regexes: A list of expected error messages. If
1475
specified they must be seen in the error output of the command.
1477
out, err = self._run_bzr_autosplit(
1482
working_dir=working_dir,
1484
for regex in error_regexes:
1485
self.assertContainsRe(err, regex)
1488
def run_bzr_error(self, error_regexes, *args, **kwargs):
1489
"""Run bzr, and check that stderr contains the supplied regexes
1491
:param error_regexes: Sequence of regular expressions which
1492
must each be found in the error output. The relative ordering
1494
:param args: command-line arguments for bzr
1495
:param kwargs: Keyword arguments which are interpreted by run_bzr
1496
This function changes the default value of retcode to be 3,
1497
since in most cases this is run when you expect bzr to fail.
1499
:return: (out, err) The actual output of running the command (in case
1500
you want to do more inspection)
1504
# Make sure that commit is failing because there is nothing to do
1505
self.run_bzr_error(['no changes to commit'],
1506
['commit', '-m', 'my commit comment'])
1507
# Make sure --strict is handling an unknown file, rather than
1508
# giving us the 'nothing to do' error
1509
self.build_tree(['unknown'])
1510
self.run_bzr_error(['Commit refused because there are unknown files'],
1511
['commit', --strict', '-m', 'my commit comment'])
1513
kwargs.setdefault('retcode', 3)
1514
kwargs['error_regexes'] = error_regexes
1515
out, err = self.run_bzr(*args, **kwargs)
1518
def run_bzr_subprocess(self, *args, **kwargs):
1519
"""Run bzr in a subprocess for testing.
1521
This starts a new Python interpreter and runs bzr in there.
1522
This should only be used for tests that have a justifiable need for
1523
this isolation: e.g. they are testing startup time, or signal
1524
handling, or early startup code, etc. Subprocess code can't be
1525
profiled or debugged so easily.
1527
:keyword retcode: The status code that is expected. Defaults to 0. If
1528
None is supplied, the status code is not checked.
1529
:keyword env_changes: A dictionary which lists changes to environment
1530
variables. A value of None will unset the env variable.
1531
The values must be strings. The change will only occur in the
1532
child, so you don't need to fix the environment after running.
1533
:keyword universal_newlines: Convert CRLF => LF
1534
:keyword allow_plugins: By default the subprocess is run with
1535
--no-plugins to ensure test reproducibility. Also, it is possible
1536
for system-wide plugins to create unexpected output on stderr,
1537
which can cause unnecessary test failures.
1539
env_changes = kwargs.get('env_changes', {})
1540
working_dir = kwargs.get('working_dir', None)
1541
allow_plugins = kwargs.get('allow_plugins', False)
1543
if isinstance(args[0], list):
1545
elif isinstance(args[0], basestring):
1546
args = list(shlex.split(args[0]))
1548
symbol_versioning.warn(zero_ninetyone %
1549
"passing varargs to run_bzr_subprocess",
1550
DeprecationWarning, stacklevel=3)
1551
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1552
working_dir=working_dir,
1553
allow_plugins=allow_plugins)
1554
# We distinguish between retcode=None and retcode not passed.
1555
supplied_retcode = kwargs.get('retcode', 0)
1556
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1557
universal_newlines=kwargs.get('universal_newlines', False),
1560
def start_bzr_subprocess(self, process_args, env_changes=None,
1561
skip_if_plan_to_signal=False,
1563
allow_plugins=False):
1564
"""Start bzr in a subprocess for testing.
1566
This starts a new Python interpreter and runs bzr in there.
1567
This should only be used for tests that have a justifiable need for
1568
this isolation: e.g. they are testing startup time, or signal
1569
handling, or early startup code, etc. Subprocess code can't be
1570
profiled or debugged so easily.
1572
:param process_args: a list of arguments to pass to the bzr executable,
1573
for example ``['--version']``.
1574
:param env_changes: A dictionary which lists changes to environment
1575
variables. A value of None will unset the env variable.
1576
The values must be strings. The change will only occur in the
1577
child, so you don't need to fix the environment after running.
1578
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1580
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1582
:returns: Popen object for the started process.
1584
if skip_if_plan_to_signal:
1585
if not getattr(os, 'kill', None):
1586
raise TestSkipped("os.kill not available.")
1588
if env_changes is None:
1592
def cleanup_environment():
1593
for env_var, value in env_changes.iteritems():
1594
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1596
def restore_environment():
1597
for env_var, value in old_env.iteritems():
1598
osutils.set_or_unset_env(env_var, value)
1600
bzr_path = self.get_bzr_path()
1603
if working_dir is not None:
1604
cwd = osutils.getcwd()
1605
os.chdir(working_dir)
1608
# win32 subprocess doesn't support preexec_fn
1609
# so we will avoid using it on all platforms, just to
1610
# make sure the code path is used, and we don't break on win32
1611
cleanup_environment()
1612
command = [sys.executable, bzr_path]
1613
if not allow_plugins:
1614
command.append('--no-plugins')
1615
command.extend(process_args)
1616
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1618
restore_environment()
1624
def _popen(self, *args, **kwargs):
1625
"""Place a call to Popen.
1627
Allows tests to override this method to intercept the calls made to
1628
Popen for introspection.
1630
return Popen(*args, **kwargs)
1632
def get_bzr_path(self):
1633
"""Return the path of the 'bzr' executable for this test suite."""
1634
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1635
if not os.path.isfile(bzr_path):
1636
# We are probably installed. Assume sys.argv is the right file
1637
bzr_path = sys.argv[0]
1640
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1641
universal_newlines=False, process_args=None):
1642
"""Finish the execution of process.
1644
:param process: the Popen object returned from start_bzr_subprocess.
1645
:param retcode: The status code that is expected. Defaults to 0. If
1646
None is supplied, the status code is not checked.
1647
:param send_signal: an optional signal to send to the process.
1648
:param universal_newlines: Convert CRLF => LF
1649
:returns: (stdout, stderr)
1651
if send_signal is not None:
1652
os.kill(process.pid, send_signal)
1653
out, err = process.communicate()
1655
if universal_newlines:
1656
out = out.replace('\r\n', '\n')
1657
err = err.replace('\r\n', '\n')
1659
if retcode is not None and retcode != process.returncode:
1660
if process_args is None:
1661
process_args = "(unknown args)"
1662
mutter('Output of bzr %s:\n%s', process_args, out)
1663
mutter('Error for bzr %s:\n%s', process_args, err)
1664
self.fail('Command bzr %s failed with retcode %s != %s'
1665
% (process_args, retcode, process.returncode))
1668
def check_inventory_shape(self, inv, shape):
1669
"""Compare an inventory to a list of expected names.
1671
Fail if they are not precisely equal.
1674
shape = list(shape) # copy
1675
for path, ie in inv.entries():
1676
name = path.replace('\\', '/')
1677
if ie.kind == 'directory':
1684
self.fail("expected paths not found in inventory: %r" % shape)
1686
self.fail("unexpected paths found in inventory: %r" % extras)
1688
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1689
a_callable=None, *args, **kwargs):
1690
"""Call callable with redirected std io pipes.
1692
Returns the return code."""
1693
if not callable(a_callable):
1694
raise ValueError("a_callable must be callable.")
1696
stdin = StringIO("")
1698
if getattr(self, "_log_file", None) is not None:
1699
stdout = self._log_file
1703
if getattr(self, "_log_file", None is not None):
1704
stderr = self._log_file
1707
real_stdin = sys.stdin
1708
real_stdout = sys.stdout
1709
real_stderr = sys.stderr
1714
return a_callable(*args, **kwargs)
1716
sys.stdout = real_stdout
1717
sys.stderr = real_stderr
1718
sys.stdin = real_stdin
1720
def reduceLockdirTimeout(self):
1721
"""Reduce the default lock timeout for the duration of the test, so that
1722
if LockContention occurs during a test, it does so quickly.
1724
Tests that expect to provoke LockContention errors should call this.
1726
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1728
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1729
self.addCleanup(resetTimeout)
1730
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1732
def make_utf8_encoded_stringio(self, encoding_type=None):
1733
"""Return a StringIOWrapper instance, that will encode Unicode
1736
if encoding_type is None:
1737
encoding_type = 'strict'
1739
output_encoding = 'utf-8'
1740
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1741
sio.encoding = output_encoding
1745
class TestCaseWithMemoryTransport(TestCase):
1746
"""Common test class for tests that do not need disk resources.
1748
Tests that need disk resources should derive from TestCaseWithTransport.
1750
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1752
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1753
a directory which does not exist. This serves to help ensure test isolation
1754
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1755
must exist. However, TestCaseWithMemoryTransport does not offer local
1756
file defaults for the transport in tests, nor does it obey the command line
1757
override, so tests that accidentally write to the common directory should
1760
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1761
a .bzr directory that stops us ascending higher into the filesystem.
1767
def __init__(self, methodName='runTest'):
1768
# allow test parameterization after test construction and before test
1769
# execution. Variables that the parameterizer sets need to be
1770
# ones that are not set by setUp, or setUp will trash them.
1771
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1772
self.vfs_transport_factory = default_transport
1773
self.transport_server = None
1774
self.transport_readonly_server = None
1775
self.__vfs_server = None
1777
def get_transport(self, relpath=None):
1778
"""Return a writeable transport.
1780
This transport is for the test scratch space relative to
1783
:param relpath: a path relative to the base url.
1785
t = get_transport(self.get_url(relpath))
1786
self.assertFalse(t.is_readonly())
1789
def get_readonly_transport(self, relpath=None):
1790
"""Return a readonly transport for the test scratch space
1792
This can be used to test that operations which should only need
1793
readonly access in fact do not try to write.
1795
:param relpath: a path relative to the base url.
1797
t = get_transport(self.get_readonly_url(relpath))
1798
self.assertTrue(t.is_readonly())
1801
def create_transport_readonly_server(self):
1802
"""Create a transport server from class defined at init.
1804
This is mostly a hook for daughter classes.
1806
return self.transport_readonly_server()
1808
def get_readonly_server(self):
1809
"""Get the server instance for the readonly transport
1811
This is useful for some tests with specific servers to do diagnostics.
1813
if self.__readonly_server is None:
1814
if self.transport_readonly_server is None:
1815
# readonly decorator requested
1816
# bring up the server
1817
self.__readonly_server = ReadonlyServer()
1818
self.__readonly_server.setUp(self.get_vfs_only_server())
1820
self.__readonly_server = self.create_transport_readonly_server()
1821
self.__readonly_server.setUp(self.get_vfs_only_server())
1822
self.addCleanup(self.__readonly_server.tearDown)
1823
return self.__readonly_server
1825
def get_readonly_url(self, relpath=None):
1826
"""Get a URL for the readonly transport.
1828
This will either be backed by '.' or a decorator to the transport
1829
used by self.get_url()
1830
relpath provides for clients to get a path relative to the base url.
1831
These should only be downwards relative, not upwards.
1833
base = self.get_readonly_server().get_url()
1834
return self._adjust_url(base, relpath)
1836
def get_vfs_only_server(self):
1837
"""Get the vfs only read/write server instance.
1839
This is useful for some tests with specific servers that need
1842
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1843
is no means to override it.
1845
if self.__vfs_server is None:
1846
self.__vfs_server = MemoryServer()
1847
self.__vfs_server.setUp()
1848
self.addCleanup(self.__vfs_server.tearDown)
1849
return self.__vfs_server
1851
def get_server(self):
1852
"""Get the read/write server instance.
1854
This is useful for some tests with specific servers that need
1857
This is built from the self.transport_server factory. If that is None,
1858
then the self.get_vfs_server is returned.
1860
if self.__server is None:
1861
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1862
return self.get_vfs_only_server()
1864
# bring up a decorated means of access to the vfs only server.
1865
self.__server = self.transport_server()
1867
self.__server.setUp(self.get_vfs_only_server())
1868
except TypeError, e:
1869
# This should never happen; the try:Except here is to assist
1870
# developers having to update code rather than seeing an
1871
# uninformative TypeError.
1872
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1873
self.addCleanup(self.__server.tearDown)
1874
return self.__server
1876
def _adjust_url(self, base, relpath):
1877
"""Get a URL (or maybe a path) for the readwrite transport.
1879
This will either be backed by '.' or to an equivalent non-file based
1881
relpath provides for clients to get a path relative to the base url.
1882
These should only be downwards relative, not upwards.
1884
if relpath is not None and relpath != '.':
1885
if not base.endswith('/'):
1887
# XXX: Really base should be a url; we did after all call
1888
# get_url()! But sometimes it's just a path (from
1889
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1890
# to a non-escaped local path.
1891
if base.startswith('./') or base.startswith('/'):
1894
base += urlutils.escape(relpath)
1897
def get_url(self, relpath=None):
1898
"""Get a URL (or maybe a path) for the readwrite transport.
1900
This will either be backed by '.' or to an equivalent non-file based
1902
relpath provides for clients to get a path relative to the base url.
1903
These should only be downwards relative, not upwards.
1905
base = self.get_server().get_url()
1906
return self._adjust_url(base, relpath)
1908
def get_vfs_only_url(self, relpath=None):
1909
"""Get a URL (or maybe a path for the plain old vfs transport.
1911
This will never be a smart protocol. It always has all the
1912
capabilities of the local filesystem, but it might actually be a
1913
MemoryTransport or some other similar virtual filesystem.
1915
This is the backing transport (if any) of the server returned by
1916
get_url and get_readonly_url.
1918
:param relpath: provides for clients to get a path relative to the base
1919
url. These should only be downwards relative, not upwards.
1922
base = self.get_vfs_only_server().get_url()
1923
return self._adjust_url(base, relpath)
1925
def _create_safety_net(self):
1926
"""Make a fake bzr directory.
1928
This prevents any tests propagating up onto the TEST_ROOT directory's
1931
root = TestCaseWithMemoryTransport.TEST_ROOT
1932
bzrdir.BzrDir.create_standalone_workingtree(root)
1934
def _check_safety_net(self):
1935
"""Check that the safety .bzr directory have not been touched.
1937
_make_test_root have created a .bzr directory to prevent tests from
1938
propagating. This method ensures than a test did not leaked.
1940
root = TestCaseWithMemoryTransport.TEST_ROOT
1941
wt = workingtree.WorkingTree.open(root)
1942
last_rev = wt.last_revision()
1943
if last_rev != 'null:':
1944
# The current test have modified the /bzr directory, we need to
1945
# recreate a new one or all the followng tests will fail.
1946
# If you need to inspect its content uncomment the following line
1947
# import pdb; pdb.set_trace()
1948
_rmtree_temp_dir(root + '/.bzr')
1949
self._create_safety_net()
1950
raise AssertionError('%s/.bzr should not be modified' % root)
1952
def _make_test_root(self):
1953
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1954
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1955
TestCaseWithMemoryTransport.TEST_ROOT = root
1957
self._create_safety_net()
1959
# The same directory is used by all tests, and we're not
1960
# specifically told when all tests are finished. This will do.
1961
atexit.register(_rmtree_temp_dir, root)
1963
self.addCleanup(self._check_safety_net)
1965
def makeAndChdirToTestDir(self):
1966
"""Create a temporary directories for this one test.
1968
This must set self.test_home_dir and self.test_dir and chdir to
1971
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1973
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1974
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1975
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1977
def make_branch(self, relpath, format=None):
1978
"""Create a branch on the transport at relpath."""
1979
repo = self.make_repository(relpath, format=format)
1980
return repo.bzrdir.create_branch()
1982
def make_bzrdir(self, relpath, format=None):
1984
# might be a relative or absolute path
1985
maybe_a_url = self.get_url(relpath)
1986
segments = maybe_a_url.rsplit('/', 1)
1987
t = get_transport(maybe_a_url)
1988
if len(segments) > 1 and segments[-1] not in ('', '.'):
1992
if isinstance(format, basestring):
1993
format = bzrdir.format_registry.make_bzrdir(format)
1994
return format.initialize_on_transport(t)
1995
except errors.UninitializableFormat:
1996
raise TestSkipped("Format %s is not initializable." % format)
1998
def make_repository(self, relpath, shared=False, format=None):
1999
"""Create a repository on our default transport at relpath.
2001
Note that relpath must be a relative path, not a full url.
2003
# FIXME: If you create a remoterepository this returns the underlying
2004
# real format, which is incorrect. Actually we should make sure that
2005
# RemoteBzrDir returns a RemoteRepository.
2006
# maybe mbp 20070410
2007
made_control = self.make_bzrdir(relpath, format=format)
2008
return made_control.create_repository(shared=shared)
2010
def make_branch_and_memory_tree(self, relpath, format=None):
2011
"""Create a branch on the default transport and a MemoryTree for it."""
2012
b = self.make_branch(relpath, format=format)
2013
return memorytree.MemoryTree.create_on_branch(b)
2015
def overrideEnvironmentForTesting(self):
2016
os.environ['HOME'] = self.test_home_dir
2017
os.environ['BZR_HOME'] = self.test_home_dir
2020
super(TestCaseWithMemoryTransport, self).setUp()
2021
self._make_test_root()
2022
_currentdir = os.getcwdu()
2023
def _leaveDirectory():
2024
os.chdir(_currentdir)
2025
self.addCleanup(_leaveDirectory)
2026
self.makeAndChdirToTestDir()
2027
self.overrideEnvironmentForTesting()
2028
self.__readonly_server = None
2029
self.__server = None
2030
self.reduceLockdirTimeout()
2033
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2034
"""Derived class that runs a test within a temporary directory.
2036
This is useful for tests that need to create a branch, etc.
2038
The directory is created in a slightly complex way: for each
2039
Python invocation, a new temporary top-level directory is created.
2040
All test cases create their own directory within that. If the
2041
tests complete successfully, the directory is removed.
2043
:ivar test_base_dir: The path of the top-level directory for this
2044
test, which contains a home directory and a work directory.
2046
:ivar test_home_dir: An initially empty directory under test_base_dir
2047
which is used as $HOME for this test.
2049
:ivar test_dir: A directory under test_base_dir used as the current
2050
directory when the test proper is run.
2053
OVERRIDE_PYTHON = 'python'
2055
def check_file_contents(self, filename, expect):
2056
self.log("check contents of file %s" % filename)
2057
contents = file(filename, 'r').read()
2058
if contents != expect:
2059
self.log("expected: %r" % expect)
2060
self.log("actually: %r" % contents)
2061
self.fail("contents of %s not as expected" % filename)
2063
def makeAndChdirToTestDir(self):
2064
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2066
For TestCaseInTempDir we create a temporary directory based on the test
2067
name and then create two subdirs - test and home under it.
2069
# create a directory within the top level test directory
2070
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2071
# now create test and home directories within this dir
2072
self.test_base_dir = candidate_dir
2073
self.test_home_dir = self.test_base_dir + '/home'
2074
os.mkdir(self.test_home_dir)
2075
self.test_dir = self.test_base_dir + '/work'
2076
os.mkdir(self.test_dir)
2077
os.chdir(self.test_dir)
2078
# put name of test inside
2079
f = file(self.test_base_dir + '/name', 'w')
2084
self.addCleanup(self.deleteTestDir)
2086
def deleteTestDir(self):
2087
os.chdir(self.TEST_ROOT)
2088
_rmtree_temp_dir(self.test_base_dir)
2090
def build_tree(self, shape, line_endings='binary', transport=None):
2091
"""Build a test tree according to a pattern.
2093
shape is a sequence of file specifications. If the final
2094
character is '/', a directory is created.
2096
This assumes that all the elements in the tree being built are new.
2098
This doesn't add anything to a branch.
2100
:type shape: list or tuple.
2101
:param line_endings: Either 'binary' or 'native'
2102
in binary mode, exact contents are written in native mode, the
2103
line endings match the default platform endings.
2104
:param transport: A transport to write to, for building trees on VFS's.
2105
If the transport is readonly or None, "." is opened automatically.
2108
if type(shape) not in (list, tuple):
2109
raise AssertionError("Parameter 'shape' should be "
2110
"a list or a tuple. Got %r instead" % (shape,))
2111
# It's OK to just create them using forward slashes on windows.
2112
if transport is None or transport.is_readonly():
2113
transport = get_transport(".")
2115
self.assert_(isinstance(name, basestring))
2117
transport.mkdir(urlutils.escape(name[:-1]))
2119
if line_endings == 'binary':
2121
elif line_endings == 'native':
2124
raise errors.BzrError(
2125
'Invalid line ending request %r' % line_endings)
2126
content = "contents of %s%s" % (name.encode('utf-8'), end)
2127
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2129
def build_tree_contents(self, shape):
2130
build_tree_contents(shape)
2132
def assertInWorkingTree(self, path, root_path='.', tree=None):
2133
"""Assert whether path or paths are in the WorkingTree"""
2135
tree = workingtree.WorkingTree.open(root_path)
2136
if not isinstance(path, basestring):
2138
self.assertInWorkingTree(p,tree=tree)
2140
self.assertIsNot(tree.path2id(path), None,
2141
path+' not in working tree.')
2143
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2144
"""Assert whether path or paths are not in the WorkingTree"""
2146
tree = workingtree.WorkingTree.open(root_path)
2147
if not isinstance(path, basestring):
2149
self.assertNotInWorkingTree(p,tree=tree)
2151
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2154
class TestCaseWithTransport(TestCaseInTempDir):
2155
"""A test case that provides get_url and get_readonly_url facilities.
2157
These back onto two transport servers, one for readonly access and one for
2160
If no explicit class is provided for readonly access, a
2161
ReadonlyTransportDecorator is used instead which allows the use of non disk
2162
based read write transports.
2164
If an explicit class is provided for readonly access, that server and the
2165
readwrite one must both define get_url() as resolving to os.getcwd().
2168
def get_vfs_only_server(self):
2169
"""See TestCaseWithMemoryTransport.
2171
This is useful for some tests with specific servers that need
2174
if self.__vfs_server is None:
2175
self.__vfs_server = self.vfs_transport_factory()
2176
self.__vfs_server.setUp()
2177
self.addCleanup(self.__vfs_server.tearDown)
2178
return self.__vfs_server
2180
def make_branch_and_tree(self, relpath, format=None):
2181
"""Create a branch on the transport and a tree locally.
2183
If the transport is not a LocalTransport, the Tree can't be created on
2184
the transport. In that case if the vfs_transport_factory is
2185
LocalURLServer the working tree is created in the local
2186
directory backing the transport, and the returned tree's branch and
2187
repository will also be accessed locally. Otherwise a lightweight
2188
checkout is created and returned.
2190
:param format: The BzrDirFormat.
2191
:returns: the WorkingTree.
2193
# TODO: always use the local disk path for the working tree,
2194
# this obviously requires a format that supports branch references
2195
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2197
b = self.make_branch(relpath, format=format)
2199
return b.bzrdir.create_workingtree()
2200
except errors.NotLocalUrl:
2201
# We can only make working trees locally at the moment. If the
2202
# transport can't support them, then we keep the non-disk-backed
2203
# branch and create a local checkout.
2204
if self.vfs_transport_factory is LocalURLServer:
2205
# the branch is colocated on disk, we cannot create a checkout.
2206
# hopefully callers will expect this.
2207
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2208
return local_controldir.create_workingtree()
2210
return b.create_checkout(relpath, lightweight=True)
2212
def assertIsDirectory(self, relpath, transport):
2213
"""Assert that relpath within transport is a directory.
2215
This may not be possible on all transports; in that case it propagates
2216
a TransportNotPossible.
2219
mode = transport.stat(relpath).st_mode
2220
except errors.NoSuchFile:
2221
self.fail("path %s is not a directory; no such file"
2223
if not stat.S_ISDIR(mode):
2224
self.fail("path %s is not a directory; has mode %#o"
2227
def assertTreesEqual(self, left, right):
2228
"""Check that left and right have the same content and properties."""
2229
# we use a tree delta to check for equality of the content, and we
2230
# manually check for equality of other things such as the parents list.
2231
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2232
differences = left.changes_from(right)
2233
self.assertFalse(differences.has_changed(),
2234
"Trees %r and %r are different: %r" % (left, right, differences))
2237
super(TestCaseWithTransport, self).setUp()
2238
self.__vfs_server = None
2241
class ChrootedTestCase(TestCaseWithTransport):
2242
"""A support class that provides readonly urls outside the local namespace.
2244
This is done by checking if self.transport_server is a MemoryServer. if it
2245
is then we are chrooted already, if it is not then an HttpServer is used
2248
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2249
be used without needed to redo it when a different
2250
subclass is in use ?
2254
super(ChrootedTestCase, self).setUp()
2255
if not self.vfs_transport_factory == MemoryServer:
2256
self.transport_readonly_server = HttpServer
2259
def condition_id_re(pattern):
2260
"""Create a condition filter which performs a re check on a test's id.
2262
:param pattern: A regular expression string.
2263
:return: A callable that returns True if the re matches.
2265
filter_re = re.compile(pattern)
2266
def condition(test):
2268
return filter_re.search(test_id)
2272
def condition_isinstance(klass_or_klass_list):
2273
"""Create a condition filter which returns isinstance(param, klass).
2275
:return: A callable which when called with one parameter obj return the
2276
result of isinstance(obj, klass_or_klass_list).
2279
return isinstance(obj, klass_or_klass_list)
2283
def condition_id_in_list(id_list):
2284
"""Create a condition filter which verify that test's id in a list.
2286
:param name: A TestIdList object.
2287
:return: A callable that returns True if the test's id appears in the list.
2289
def condition(test):
2290
return id_list.test_in(test.id())
2294
def exclude_tests_by_condition(suite, condition):
2295
"""Create a test suite which excludes some tests from suite.
2297
:param suite: The suite to get tests from.
2298
:param condition: A callable whose result evaluates True when called with a
2299
test case which should be excluded from the result.
2300
:return: A suite which contains the tests found in suite that fail
2304
for test in iter_suite_tests(suite):
2305
if not condition(test):
2307
return TestUtil.TestSuite(result)
2310
def filter_suite_by_condition(suite, condition):
2311
"""Create a test suite by filtering another one.
2313
:param suite: The source suite.
2314
:param condition: A callable whose result evaluates True when called with a
2315
test case which should be included in the result.
2316
:return: A suite which contains the tests found in suite that pass
2320
for test in iter_suite_tests(suite):
2323
return TestUtil.TestSuite(result)
2326
def filter_suite_by_re(suite, pattern, exclude_pattern=DEPRECATED_PARAMETER,
2327
random_order=DEPRECATED_PARAMETER):
2328
"""Create a test suite by filtering another one.
2330
:param suite: the source suite
2331
:param pattern: pattern that names must match
2332
:param exclude_pattern: A pattern that names must not match. This parameter
2333
is deprecated as of bzrlib 1.0. Please use the separate function
2334
exclude_tests_by_re instead.
2335
:param random_order: If True, tests in the new suite will be put in
2336
random order. This parameter is deprecated as of bzrlib 1.0. Please
2337
use the separate function randomize_suite instead.
2338
:returns: the newly created suite
2340
if deprecated_passed(exclude_pattern):
2341
symbol_versioning.warn(
2342
one_zero % "passing exclude_pattern to filter_suite_by_re",
2343
DeprecationWarning, stacklevel=2)
2344
if exclude_pattern is not None:
2345
suite = exclude_tests_by_re(suite, exclude_pattern)
2346
condition = condition_id_re(pattern)
2347
result_suite = filter_suite_by_condition(suite, condition)
2348
if deprecated_passed(random_order):
2349
symbol_versioning.warn(
2350
one_zero % "passing random_order to filter_suite_by_re",
2351
DeprecationWarning, stacklevel=2)
2353
result_suite = randomize_suite(result_suite)
2357
def filter_suite_by_id_list(suite, test_id_list):
2358
"""Create a test suite by filtering another one.
2360
:param suite: The source suite.
2361
:param test_id_list: A list of the test ids to keep as strings.
2362
:returns: the newly created suite
2364
condition = condition_id_in_list(test_id_list)
2365
result_suite = filter_suite_by_condition(suite, condition)
2369
def exclude_tests_by_re(suite, pattern):
2370
"""Create a test suite which excludes some tests from suite.
2372
:param suite: The suite to get tests from.
2373
:param pattern: A regular expression string. Test ids that match this
2374
pattern will be excluded from the result.
2375
:return: A TestSuite that contains all the tests from suite without the
2376
tests that matched pattern. The order of tests is the same as it was in
2379
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2382
def preserve_input(something):
2383
"""A helper for performing test suite transformation chains.
2385
:param something: Anything you want to preserve.
2391
def randomize_suite(suite):
2392
"""Return a new TestSuite with suite's tests in random order.
2394
The tests in the input suite are flattened into a single suite in order to
2395
accomplish this. Any nested TestSuites are removed to provide global
2398
tests = list(iter_suite_tests(suite))
2399
random.shuffle(tests)
2400
return TestUtil.TestSuite(tests)
2403
@deprecated_function(one_zero)
2404
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2405
random_order=False, append_rest=True):
2406
"""DEPRECATED: Create a test suite by sorting another one.
2408
This method has been decomposed into separate helper methods that should be
2410
- filter_suite_by_re
2411
- exclude_tests_by_re
2415
:param suite: the source suite
2416
:param pattern: pattern that names must match in order to go
2417
first in the new suite
2418
:param exclude_pattern: pattern that names must not match, if any
2419
:param random_order: if True, tests in the new suite will be put in
2420
random order (with all tests matching pattern
2422
:param append_rest: if False, pattern is a strict filter and not
2423
just an ordering directive
2424
:returns: the newly created suite
2426
if exclude_pattern is not None:
2427
suite = exclude_tests_by_re(suite, exclude_pattern)
2429
order_changer = randomize_suite
2431
order_changer = preserve_input
2433
suites = map(order_changer, split_suite_by_re(suite, pattern))
2434
return TestUtil.TestSuite(suites)
2436
return order_changer(filter_suite_by_re(suite, pattern))
2439
def split_suite_by_re(suite, pattern):
2440
"""Split a test suite into two by a regular expression.
2442
:param suite: The suite to split.
2443
:param pattern: A regular expression string. Test ids that match this
2444
pattern will be in the first test suite returned, and the others in the
2445
second test suite returned.
2446
:return: A tuple of two test suites, where the first contains tests from
2447
suite matching pattern, and the second contains the remainder from
2448
suite. The order within each output suite is the same as it was in
2453
filter_re = re.compile(pattern)
2454
for test in iter_suite_tests(suite):
2456
if filter_re.search(test_id):
2457
matched.append(test)
2459
did_not_match.append(test)
2460
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2463
def run_suite(suite, name='test', verbose=False, pattern=".*",
2464
stop_on_failure=False,
2465
transport=None, lsprof_timed=None, bench_history=None,
2466
matching_tests_first=None,
2469
exclude_pattern=None,
2471
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2476
runner = TextTestRunner(stream=sys.stdout,
2478
verbosity=verbosity,
2479
bench_history=bench_history,
2480
list_only=list_only,
2482
runner.stop_on_failure=stop_on_failure
2483
# Initialise the random number generator and display the seed used.
2484
# We convert the seed to a long to make it reuseable across invocations.
2485
random_order = False
2486
if random_seed is not None:
2488
if random_seed == "now":
2489
random_seed = long(time.time())
2491
# Convert the seed to a long if we can
2493
random_seed = long(random_seed)
2496
runner.stream.writeln("Randomizing test order using seed %s\n" %
2498
random.seed(random_seed)
2499
# Customise the list of tests if requested
2500
if exclude_pattern is not None:
2501
suite = exclude_tests_by_re(suite, exclude_pattern)
2503
order_changer = randomize_suite
2505
order_changer = preserve_input
2506
if pattern != '.*' or random_order:
2507
if matching_tests_first:
2508
suites = map(order_changer, split_suite_by_re(suite, pattern))
2509
suite = TestUtil.TestSuite(suites)
2511
suite = order_changer(filter_suite_by_re(suite, pattern))
2513
result = runner.run(suite)
2516
return result.wasStrictlySuccessful()
2518
return result.wasSuccessful()
2521
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2523
test_suite_factory=None,
2526
matching_tests_first=None,
2529
exclude_pattern=None,
2533
"""Run the whole test suite under the enhanced runner"""
2534
# XXX: Very ugly way to do this...
2535
# Disable warning about old formats because we don't want it to disturb
2536
# any blackbox tests.
2537
from bzrlib import repository
2538
repository._deprecation_warning_done = True
2540
global default_transport
2541
if transport is None:
2542
transport = default_transport
2543
old_transport = default_transport
2544
default_transport = transport
2546
if load_list is None:
2549
keep_only = load_test_id_list(load_list)
2550
if test_suite_factory is None:
2551
suite = test_suite(keep_only)
2553
suite = test_suite_factory()
2554
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2555
stop_on_failure=stop_on_failure,
2556
transport=transport,
2557
lsprof_timed=lsprof_timed,
2558
bench_history=bench_history,
2559
matching_tests_first=matching_tests_first,
2560
list_only=list_only,
2561
random_seed=random_seed,
2562
exclude_pattern=exclude_pattern,
2565
default_transport = old_transport
2568
def load_test_id_list(file_name):
2569
"""Load a test id list from a text file.
2571
The format is one test id by line. No special care is taken to impose
2572
strict rules, these test ids are used to filter the test suite so a test id
2573
that do not match an existing test will do no harm. This allows user to add
2574
comments, leave blank lines, etc.
2578
ftest = open(file_name, 'rt')
2580
if e.errno != errno.ENOENT:
2583
raise errors.NoSuchFile(file_name)
2585
for test_name in ftest.readlines():
2586
test_list.append(test_name.strip())
2591
def suite_matches_id_list(test_suite, id_list):
2592
"""Warns about tests not appearing or appearing more than once.
2594
:param test_suite: A TestSuite object.
2595
:param test_id_list: The list of test ids that should be found in
2598
:return: (absents, duplicates) absents is a list containing the test found
2599
in id_list but not in test_suite, duplicates is a list containing the
2600
test found multiple times in test_suite.
2602
When using a prefined test id list, it may occurs that some tests do not
2603
exist anymore or that some tests use the same id. This function warns the
2604
tester about potential problems in his workflow (test lists are volatile)
2605
or in the test suite itself (using the same id for several tests does not
2606
help to localize defects).
2608
# Build a dict counting id occurrences
2610
for test in iter_suite_tests(test_suite):
2612
tests[id] = tests.get(id, 0) + 1
2617
occurs = tests.get(id, 0)
2619
not_found.append(id)
2621
duplicates.append(id)
2623
return not_found, duplicates
2626
class TestIdList(object):
2627
"""Test id list to filter a test suite.
2629
Relying on the assumption that test ids are built as:
2630
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2631
notation, this class offers methods to :
2632
- avoid building a test suite for modules not refered to in the test list,
2633
- keep only the tests listed from the module test suite.
2636
def __init__(self, test_id_list):
2637
# When a test suite needs to be filtered against us we compare test ids
2638
# for equality, so a simple dict offers a quick and simple solution.
2639
self.tests = dict().fromkeys(test_id_list, True)
2641
# While unittest.TestCase have ids like:
2642
# <module>.<class>.<method>[(<param+)],
2643
# doctest.DocTestCase can have ids like:
2646
# <module>.<function>
2647
# <module>.<class>.<method>
2649
# Since we can't predict a test class from its name only, we settle on
2650
# a simple constraint: a test id always begins with its module name.
2653
for test_id in test_id_list:
2654
parts = test_id.split('.')
2655
mod_name = parts.pop(0)
2656
modules[mod_name] = True
2658
mod_name += '.' + part
2659
modules[mod_name] = True
2660
self.modules = modules
2662
def is_module_name_used(self, module_name):
2663
"""Is there tests for the module or one of its sub modules."""
2664
return self.modules.has_key(module_name)
2666
def test_in(self, test_id):
2667
return self.tests.has_key(test_id)
2670
def test_suite(keep_only=None):
2671
"""Build and return TestSuite for the whole of bzrlib.
2673
:param keep_only: A list of test ids limiting the suite returned.
2675
This function can be replaced if you need to change the default test
2676
suite on a global basis, but it is not encouraged.
2679
'bzrlib.util.tests.test_bencode',
2680
'bzrlib.tests.test__dirstate_helpers',
2681
'bzrlib.tests.test_ancestry',
2682
'bzrlib.tests.test_annotate',
2683
'bzrlib.tests.test_api',
2684
'bzrlib.tests.test_atomicfile',
2685
'bzrlib.tests.test_bad_files',
2686
'bzrlib.tests.test_bisect_multi',
2687
'bzrlib.tests.test_branch',
2688
'bzrlib.tests.test_branchbuilder',
2689
'bzrlib.tests.test_bugtracker',
2690
'bzrlib.tests.test_bundle',
2691
'bzrlib.tests.test_bzrdir',
2692
'bzrlib.tests.test_cache_utf8',
2693
'bzrlib.tests.test_commands',
2694
'bzrlib.tests.test_commit',
2695
'bzrlib.tests.test_commit_merge',
2696
'bzrlib.tests.test_config',
2697
'bzrlib.tests.test_conflicts',
2698
'bzrlib.tests.test_counted_lock',
2699
'bzrlib.tests.test_decorators',
2700
'bzrlib.tests.test_delta',
2701
'bzrlib.tests.test_deprecated_graph',
2702
'bzrlib.tests.test_diff',
2703
'bzrlib.tests.test_dirstate',
2704
'bzrlib.tests.test_directory_service',
2705
'bzrlib.tests.test_email_message',
2706
'bzrlib.tests.test_errors',
2707
'bzrlib.tests.test_escaped_store',
2708
'bzrlib.tests.test_extract',
2709
'bzrlib.tests.test_fetch',
2710
'bzrlib.tests.test_ftp_transport',
2711
'bzrlib.tests.test_generate_docs',
2712
'bzrlib.tests.test_generate_ids',
2713
'bzrlib.tests.test_globbing',
2714
'bzrlib.tests.test_gpg',
2715
'bzrlib.tests.test_graph',
2716
'bzrlib.tests.test_hashcache',
2717
'bzrlib.tests.test_help',
2718
'bzrlib.tests.test_hooks',
2719
'bzrlib.tests.test_http',
2720
'bzrlib.tests.test_http_implementations',
2721
'bzrlib.tests.test_http_response',
2722
'bzrlib.tests.test_https_ca_bundle',
2723
'bzrlib.tests.test_identitymap',
2724
'bzrlib.tests.test_ignores',
2725
'bzrlib.tests.test_index',
2726
'bzrlib.tests.test_info',
2727
'bzrlib.tests.test_inv',
2728
'bzrlib.tests.test_knit',
2729
'bzrlib.tests.test_lazy_import',
2730
'bzrlib.tests.test_lazy_regex',
2731
'bzrlib.tests.test_lockdir',
2732
'bzrlib.tests.test_lockable_files',
2733
'bzrlib.tests.test_log',
2734
'bzrlib.tests.test_lsprof',
2735
'bzrlib.tests.test_lru_cache',
2736
'bzrlib.tests.test_mail_client',
2737
'bzrlib.tests.test_memorytree',
2738
'bzrlib.tests.test_merge',
2739
'bzrlib.tests.test_merge3',
2740
'bzrlib.tests.test_merge_core',
2741
'bzrlib.tests.test_merge_directive',
2742
'bzrlib.tests.test_missing',
2743
'bzrlib.tests.test_msgeditor',
2744
'bzrlib.tests.test_multiparent',
2745
'bzrlib.tests.test_nonascii',
2746
'bzrlib.tests.test_options',
2747
'bzrlib.tests.test_osutils',
2748
'bzrlib.tests.test_osutils_encodings',
2749
'bzrlib.tests.test_pack',
2750
'bzrlib.tests.test_patch',
2751
'bzrlib.tests.test_patches',
2752
'bzrlib.tests.test_permissions',
2753
'bzrlib.tests.test_plugins',
2754
'bzrlib.tests.test_progress',
2755
'bzrlib.tests.test_reconfigure',
2756
'bzrlib.tests.test_reconcile',
2757
'bzrlib.tests.test_registry',
2758
'bzrlib.tests.test_remote',
2759
'bzrlib.tests.test_repository',
2760
'bzrlib.tests.test_revert',
2761
'bzrlib.tests.test_revision',
2762
'bzrlib.tests.test_revisionspec',
2763
'bzrlib.tests.test_revisiontree',
2764
'bzrlib.tests.test_rio',
2765
'bzrlib.tests.test_sampler',
2766
'bzrlib.tests.test_selftest',
2767
'bzrlib.tests.test_setup',
2768
'bzrlib.tests.test_sftp_transport',
2769
'bzrlib.tests.test_smart',
2770
'bzrlib.tests.test_smart_add',
2771
'bzrlib.tests.test_smart_transport',
2772
'bzrlib.tests.test_smtp_connection',
2773
'bzrlib.tests.test_source',
2774
'bzrlib.tests.test_ssh_transport',
2775
'bzrlib.tests.test_status',
2776
'bzrlib.tests.test_store',
2777
'bzrlib.tests.test_strace',
2778
'bzrlib.tests.test_subsume',
2779
'bzrlib.tests.test_switch',
2780
'bzrlib.tests.test_symbol_versioning',
2781
'bzrlib.tests.test_tag',
2782
'bzrlib.tests.test_testament',
2783
'bzrlib.tests.test_textfile',
2784
'bzrlib.tests.test_textmerge',
2785
'bzrlib.tests.test_timestamp',
2786
'bzrlib.tests.test_trace',
2787
'bzrlib.tests.test_transactions',
2788
'bzrlib.tests.test_transform',
2789
'bzrlib.tests.test_transport',
2790
'bzrlib.tests.test_tree',
2791
'bzrlib.tests.test_treebuilder',
2792
'bzrlib.tests.test_tsort',
2793
'bzrlib.tests.test_tuned_gzip',
2794
'bzrlib.tests.test_ui',
2795
'bzrlib.tests.test_uncommit',
2796
'bzrlib.tests.test_upgrade',
2797
'bzrlib.tests.test_urlutils',
2798
'bzrlib.tests.test_versionedfile',
2799
'bzrlib.tests.test_version',
2800
'bzrlib.tests.test_version_info',
2801
'bzrlib.tests.test_weave',
2802
'bzrlib.tests.test_whitebox',
2803
'bzrlib.tests.test_win32utils',
2804
'bzrlib.tests.test_workingtree',
2805
'bzrlib.tests.test_workingtree_4',
2806
'bzrlib.tests.test_wsgi',
2807
'bzrlib.tests.test_xml',
2809
test_transport_implementations = [
2810
'bzrlib.tests.test_transport_implementations',
2811
'bzrlib.tests.test_read_bundle',
2813
suite = TestUtil.TestSuite()
2814
loader = TestUtil.TestLoader()
2816
if keep_only is not None:
2817
id_filter = TestIdList(keep_only)
2819
# modules building their suite with loadTestsFromModuleNames
2820
if keep_only is None:
2821
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2823
for mod in [m for m in testmod_names
2824
if id_filter.is_module_name_used(m)]:
2825
mod_suite = loader.loadTestsFromModuleNames([mod])
2826
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2827
suite.addTest(mod_suite)
2829
# modules adapted for transport implementations
2830
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2831
adapter = TransportTestProviderAdapter()
2832
if keep_only is None:
2833
adapt_modules(test_transport_implementations, adapter, loader, suite)
2835
for mod in [m for m in test_transport_implementations
2836
if id_filter.is_module_name_used(m)]:
2837
mod_suite = TestUtil.TestSuite()
2838
adapt_modules([mod], adapter, loader, mod_suite)
2839
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2840
suite.addTest(mod_suite)
2842
# modules defining their own test_suite()
2843
for package in [p for p in packages_to_test()
2844
if (keep_only is None
2845
or id_filter.is_module_name_used(p.__name__))]:
2846
pack_suite = package.test_suite()
2847
if keep_only is not None:
2848
pack_suite = filter_suite_by_id_list(pack_suite, id_filter)
2849
suite.addTest(pack_suite)
2851
for mod in MODULES_TO_DOCTEST:
2853
doc_suite = doctest.DocTestSuite(mod)
2854
except ValueError, e:
2855
print '**failed to get doctest for: %s\n%s' % (mod, e)
2857
if keep_only is not None:
2858
# DocTests may use ids which doesn't contain the module name
2859
doc_suite = filter_suite_by_id_list(doc_suite, id_filter)
2860
suite.addTest(doc_suite)
2862
default_encoding = sys.getdefaultencoding()
2863
for name, plugin in bzrlib.plugin.plugins().items():
2864
if keep_only is not None:
2865
if not id_filter.is_module_name_used(plugin.module.__name__):
2867
plugin_suite = plugin.test_suite()
2868
# We used to catch ImportError here and turn it into just a warning,
2869
# but really if you don't have --no-plugins this should be a failure.
2870
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
2871
if plugin_suite is not None:
2872
if keep_only is not None:
2873
plugin_suite = filter_suite_by_id_list(plugin_suite,
2875
suite.addTest(plugin_suite)
2876
if default_encoding != sys.getdefaultencoding():
2877
bzrlib.trace.warning(
2878
'Plugin "%s" tried to reset default encoding to: %s', name,
2879
sys.getdefaultencoding())
2881
sys.setdefaultencoding(default_encoding)
2883
if keep_only is not None:
2884
# Do some sanity checks on the id_list filtering
2885
not_found, duplicates = suite_matches_id_list(suite, keep_only)
2886
for id in not_found:
2887
bzrlib.trace.warning('"%s" not found in the test suite', id)
2888
for id in duplicates:
2889
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
2894
def multiply_tests_from_modules(module_name_list, scenario_iter, loader=None):
2895
"""Adapt all tests in some given modules to given scenarios.
2897
This is the recommended public interface for test parameterization.
2898
Typically the test_suite() method for a per-implementation test
2899
suite will call multiply_tests_from_modules and return the
2902
:param module_name_list: List of fully-qualified names of test
2904
:param scenario_iter: Iterable of pairs of (scenario_name,
2905
scenario_param_dict).
2906
:param loader: If provided, will be used instead of a new
2907
bzrlib.tests.TestLoader() instance.
2909
This returns a new TestSuite containing the cross product of
2910
all the tests in all the modules, each repeated for each scenario.
2911
Each test is adapted by adding the scenario name at the end
2912
of its name, and updating the test object's __dict__ with the
2913
scenario_param_dict.
2915
>>> r = multiply_tests_from_modules(
2916
... ['bzrlib.tests.test_sampler'],
2917
... [('one', dict(param=1)),
2918
... ('two', dict(param=2))])
2919
>>> tests = list(iter_suite_tests(r))
2923
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2929
# XXX: Isn't load_tests() a better way to provide the same functionality
2930
# without forcing a predefined TestScenarioApplier ? --vila 080215
2932
loader = TestUtil.TestLoader()
2934
suite = loader.suiteClass()
2936
adapter = TestScenarioApplier()
2937
adapter.scenarios = list(scenario_iter)
2938
adapt_modules(module_name_list, adapter, loader, suite)
2942
def multiply_scenarios(scenarios_left, scenarios_right):
2943
"""Multiply two sets of scenarios.
2945
:returns: the cartesian product of the two sets of scenarios, that is
2946
a scenario for every possible combination of a left scenario and a
2950
('%s,%s' % (left_name, right_name),
2951
dict(left_dict.items() + right_dict.items()))
2952
for left_name, left_dict in scenarios_left
2953
for right_name, right_dict in scenarios_right]
2957
def adapt_modules(mods_list, adapter, loader, suite):
2958
"""Adapt the modules in mods_list using adapter and add to suite."""
2959
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2960
suite.addTests(adapter.adapt(test))
2963
def adapt_tests(tests_list, adapter, loader, suite):
2964
"""Adapt the tests in tests_list using adapter and add to suite."""
2965
for test in tests_list:
2966
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2969
def _rmtree_temp_dir(dirname):
2970
# If LANG=C we probably have created some bogus paths
2971
# which rmtree(unicode) will fail to delete
2972
# so make sure we are using rmtree(str) to delete everything
2973
# except on win32, where rmtree(str) will fail
2974
# since it doesn't have the property of byte-stream paths
2975
# (they are either ascii or mbcs)
2976
if sys.platform == 'win32':
2977
# make sure we are using the unicode win32 api
2978
dirname = unicode(dirname)
2980
dirname = dirname.encode(sys.getfilesystemencoding())
2982
osutils.rmtree(dirname)
2984
if sys.platform == 'win32' and e.errno == errno.EACCES:
2985
sys.stderr.write(('Permission denied: '
2986
'unable to remove testing dir '
2987
'%s\n' % os.path.basename(dirname)))
2992
class Feature(object):
2993
"""An operating system Feature."""
2996
self._available = None
2998
def available(self):
2999
"""Is the feature available?
3001
:return: True if the feature is available.
3003
if self._available is None:
3004
self._available = self._probe()
3005
return self._available
3008
"""Implement this method in concrete features.
3010
:return: True if the feature is available.
3012
raise NotImplementedError
3015
if getattr(self, 'feature_name', None):
3016
return self.feature_name()
3017
return self.__class__.__name__
3020
class _SymlinkFeature(Feature):
3023
return osutils.has_symlinks()
3025
def feature_name(self):
3028
SymlinkFeature = _SymlinkFeature()
3031
class _HardlinkFeature(Feature):
3034
return osutils.has_hardlinks()
3036
def feature_name(self):
3039
HardlinkFeature = _HardlinkFeature()
3042
class _OsFifoFeature(Feature):
3045
return getattr(os, 'mkfifo', None)
3047
def feature_name(self):
3048
return 'filesystem fifos'
3050
OsFifoFeature = _OsFifoFeature()
3053
class TestScenarioApplier(object):
3054
"""A tool to apply scenarios to tests."""
3056
def adapt(self, test):
3057
"""Return a TestSuite containing a copy of test for each scenario."""
3058
result = unittest.TestSuite()
3059
for scenario in self.scenarios:
3060
result.addTest(self.adapt_test_to_scenario(test, scenario))
3063
def adapt_test_to_scenario(self, test, scenario):
3064
"""Copy test and apply scenario to it.
3066
:param test: A test to adapt.
3067
:param scenario: A tuple describing the scenarion.
3068
The first element of the tuple is the new test id.
3069
The second element is a dict containing attributes to set on the
3071
:return: The adapted test.
3073
from copy import deepcopy
3074
new_test = deepcopy(test)
3075
for name, value in scenario[1].items():
3076
setattr(new_test, name, value)
3077
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3078
new_test.id = lambda: new_id
3082
def probe_unicode_in_user_encoding():
3083
"""Try to encode several unicode strings to use in unicode-aware tests.
3084
Return first successfull match.
3086
:return: (unicode value, encoded plain string value) or (None, None)
3088
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3089
for uni_val in possible_vals:
3091
str_val = uni_val.encode(bzrlib.user_encoding)
3092
except UnicodeEncodeError:
3093
# Try a different character
3096
return uni_val, str_val
3100
def probe_bad_non_ascii(encoding):
3101
"""Try to find [bad] character with code [128..255]
3102
that cannot be decoded to unicode in some encoding.
3103
Return None if all non-ascii characters is valid
3106
for i in xrange(128, 256):
3109
char.decode(encoding)
3110
except UnicodeDecodeError:
3115
class _FTPServerFeature(Feature):
3116
"""Some tests want an FTP Server, check if one is available.
3118
Right now, the only way this is available is if 'medusa' is installed.
3119
http://www.amk.ca/python/code/medusa.html
3124
import bzrlib.tests.ftp_server
3129
def feature_name(self):
3132
FTPServerFeature = _FTPServerFeature()
3135
class _CaseInsensitiveFilesystemFeature(Feature):
3136
"""Check if underlined filesystem is case-insensitive
3137
(e.g. on Windows, Cygwin, MacOS)
3141
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3142
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3143
TestCaseWithMemoryTransport.TEST_ROOT = root
3145
root = TestCaseWithMemoryTransport.TEST_ROOT
3146
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3148
name_a = osutils.pathjoin(tdir, 'a')
3149
name_A = osutils.pathjoin(tdir, 'A')
3151
result = osutils.isdir(name_A)
3152
_rmtree_temp_dir(tdir)
3155
def feature_name(self):
3156
return 'case-insensitive filesystem'
3158
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
