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
113
def packages_to_test():
114
"""Return a list of packages to test.
116
The packages are not globally imported so that import failures are
117
triggered when running selftest, not when importing the command.
120
import bzrlib.tests.blackbox
121
import bzrlib.tests.branch_implementations
122
import bzrlib.tests.bzrdir_implementations
123
import bzrlib.tests.commands
124
import bzrlib.tests.interrepository_implementations
125
import bzrlib.tests.interversionedfile_implementations
126
import bzrlib.tests.intertree_implementations
127
import bzrlib.tests.inventory_implementations
128
import bzrlib.tests.per_lock
129
import bzrlib.tests.repository_implementations
130
import bzrlib.tests.revisionstore_implementations
131
import bzrlib.tests.tree_implementations
132
import bzrlib.tests.workingtree_implementations
135
bzrlib.tests.blackbox,
136
bzrlib.tests.branch_implementations,
137
bzrlib.tests.bzrdir_implementations,
138
bzrlib.tests.commands,
139
bzrlib.tests.interrepository_implementations,
140
bzrlib.tests.interversionedfile_implementations,
141
bzrlib.tests.intertree_implementations,
142
bzrlib.tests.inventory_implementations,
143
bzrlib.tests.per_lock,
144
bzrlib.tests.repository_implementations,
145
bzrlib.tests.revisionstore_implementations,
146
bzrlib.tests.tree_implementations,
147
bzrlib.tests.workingtree_implementations,
151
class ExtendedTestResult(unittest._TextTestResult):
152
"""Accepts, reports and accumulates the results of running tests.
154
Compared to the unittest version this class adds support for
155
profiling, benchmarking, stopping as soon as a test fails, and
156
skipping tests. There are further-specialized subclasses for
157
different types of display.
159
When a test finishes, in whatever way, it calls one of the addSuccess,
160
addFailure or addError classes. These in turn may redirect to a more
161
specific case for the special test results supported by our extended
164
Note that just one of these objects is fed the results from many tests.
169
def __init__(self, stream, descriptions, verbosity,
173
"""Construct new TestResult.
175
:param bench_history: Optionally, a writable file object to accumulate
178
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
179
if bench_history is not None:
180
from bzrlib.version import _get_bzr_source_tree
181
src_tree = _get_bzr_source_tree()
184
revision_id = src_tree.get_parent_ids()[0]
186
# XXX: if this is a brand new tree, do the same as if there
190
# XXX: If there's no branch, what should we do?
192
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
193
self._bench_history = bench_history
194
self.ui = ui.ui_factory
195
self.num_tests = num_tests
197
self.failure_count = 0
198
self.known_failure_count = 0
200
self.not_applicable_count = 0
201
self.unsupported = {}
203
self._overall_start_time = time.time()
205
def _extractBenchmarkTime(self, testCase):
206
"""Add a benchmark time for the current test case."""
207
return getattr(testCase, "_benchtime", None)
209
def _elapsedTestTimeString(self):
210
"""Return a time string for the overall time the current test has taken."""
211
return self._formatTime(time.time() - self._start_time)
213
def _testTimeString(self, testCase):
214
benchmark_time = self._extractBenchmarkTime(testCase)
215
if benchmark_time is not None:
217
self._formatTime(benchmark_time),
218
self._elapsedTestTimeString())
220
return " %s" % self._elapsedTestTimeString()
222
def _formatTime(self, seconds):
223
"""Format seconds as milliseconds with leading spaces."""
224
# some benchmarks can take thousands of seconds to run, so we need 8
226
return "%8dms" % (1000 * seconds)
228
def _shortened_test_description(self, test):
230
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
233
def startTest(self, test):
234
unittest.TestResult.startTest(self, test)
235
self.report_test_start(test)
236
test.number = self.count
237
self._recordTestStartTime()
239
def _recordTestStartTime(self):
240
"""Record that a test has started."""
241
self._start_time = time.time()
243
def _cleanupLogFile(self, test):
244
# We can only do this if we have one of our TestCases, not if
246
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
247
if setKeepLogfile is not None:
250
def addError(self, test, err):
251
"""Tell result that test finished with an error.
253
Called from the TestCase run() method when the test
254
fails with an unexpected error.
256
self._testConcluded(test)
257
if isinstance(err[1], TestSkipped):
258
return self._addSkipped(test, err)
259
elif isinstance(err[1], UnavailableFeature):
260
return self.addNotSupported(test, err[1].args[0])
262
self._cleanupLogFile(test)
263
unittest.TestResult.addError(self, test, err)
264
self.error_count += 1
265
self.report_error(test, err)
269
def addFailure(self, test, err):
270
"""Tell result that test failed.
272
Called from the TestCase run() method when the test
273
fails because e.g. an assert() method failed.
275
self._testConcluded(test)
276
if isinstance(err[1], KnownFailure):
277
return self._addKnownFailure(test, err)
279
self._cleanupLogFile(test)
280
unittest.TestResult.addFailure(self, test, err)
281
self.failure_count += 1
282
self.report_failure(test, err)
286
def addSuccess(self, test):
287
"""Tell result that test completed successfully.
289
Called from the TestCase run()
291
self._testConcluded(test)
292
if self._bench_history is not None:
293
benchmark_time = self._extractBenchmarkTime(test)
294
if benchmark_time is not None:
295
self._bench_history.write("%s %s\n" % (
296
self._formatTime(benchmark_time),
298
self.report_success(test)
299
self._cleanupLogFile(test)
300
unittest.TestResult.addSuccess(self, test)
301
test._log_contents = ''
303
def _testConcluded(self, test):
304
"""Common code when a test has finished.
306
Called regardless of whether it succeded, failed, etc.
310
def _addKnownFailure(self, test, err):
311
self.known_failure_count += 1
312
self.report_known_failure(test, err)
314
def addNotSupported(self, test, feature):
315
"""The test will not be run because of a missing feature.
317
# this can be called in two different ways: it may be that the
318
# test started running, and then raised (through addError)
319
# UnavailableFeature. Alternatively this method can be called
320
# while probing for features before running the tests; in that
321
# case we will see startTest and stopTest, but the test will never
323
self.unsupported.setdefault(str(feature), 0)
324
self.unsupported[str(feature)] += 1
325
self.report_unsupported(test, feature)
327
def _addSkipped(self, test, skip_excinfo):
328
if isinstance(skip_excinfo[1], TestNotApplicable):
329
self.not_applicable_count += 1
330
self.report_not_applicable(test, skip_excinfo)
333
self.report_skip(test, skip_excinfo)
336
except KeyboardInterrupt:
339
self.addError(test, test._exc_info())
341
# seems best to treat this as success from point-of-view of unittest
342
# -- it actually does nothing so it barely matters :)
343
unittest.TestResult.addSuccess(self, test)
344
test._log_contents = ''
346
def printErrorList(self, flavour, errors):
347
for test, err in errors:
348
self.stream.writeln(self.separator1)
349
self.stream.write("%s: " % flavour)
350
self.stream.writeln(self.getDescription(test))
351
if getattr(test, '_get_log', None) is not None:
352
self.stream.write('\n')
354
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
355
self.stream.write('\n')
356
self.stream.write(test._get_log())
357
self.stream.write('\n')
359
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
360
self.stream.write('\n')
361
self.stream.writeln(self.separator2)
362
self.stream.writeln("%s" % err)
367
def report_cleaning_up(self):
370
def report_success(self, test):
373
def wasStrictlySuccessful(self):
374
if self.unsupported or self.known_failure_count:
376
return self.wasSuccessful()
379
class TextTestResult(ExtendedTestResult):
380
"""Displays progress and results of tests in text form"""
382
def __init__(self, stream, descriptions, verbosity,
387
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
388
bench_history, num_tests)
390
self.pb = self.ui.nested_progress_bar()
391
self._supplied_pb = False
394
self._supplied_pb = True
395
self.pb.show_pct = False
396
self.pb.show_spinner = False
397
self.pb.show_eta = False,
398
self.pb.show_count = False
399
self.pb.show_bar = False
401
def report_starting(self):
402
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
404
def _progress_prefix_text(self):
405
a = '[%d' % self.count
406
if self.num_tests is not None:
407
a +='/%d' % self.num_tests
408
a += ' in %ds' % (time.time() - self._overall_start_time)
410
a += ', %d errors' % self.error_count
411
if self.failure_count:
412
a += ', %d failed' % self.failure_count
413
if self.known_failure_count:
414
a += ', %d known failures' % self.known_failure_count
416
a += ', %d skipped' % self.skip_count
418
a += ', %d missing features' % len(self.unsupported)
422
def report_test_start(self, test):
425
self._progress_prefix_text()
427
+ self._shortened_test_description(test))
429
def _test_description(self, test):
430
return self._shortened_test_description(test)
432
def report_error(self, test, err):
433
self.pb.note('ERROR: %s\n %s\n',
434
self._test_description(test),
438
def report_failure(self, test, err):
439
self.pb.note('FAIL: %s\n %s\n',
440
self._test_description(test),
444
def report_known_failure(self, test, err):
445
self.pb.note('XFAIL: %s\n%s\n',
446
self._test_description(test), err[1])
448
def report_skip(self, test, skip_excinfo):
451
def report_not_applicable(self, test, skip_excinfo):
454
def report_unsupported(self, test, feature):
455
"""test cannot be run because feature is missing."""
457
def report_cleaning_up(self):
458
self.pb.update('cleaning up...')
461
if not self._supplied_pb:
465
class VerboseTestResult(ExtendedTestResult):
466
"""Produce long output, with one line per test run plus times"""
468
def _ellipsize_to_right(self, a_string, final_width):
469
"""Truncate and pad a string, keeping the right hand side"""
470
if len(a_string) > final_width:
471
result = '...' + a_string[3-final_width:]
474
return result.ljust(final_width)
476
def report_starting(self):
477
self.stream.write('running %d tests...\n' % self.num_tests)
479
def report_test_start(self, test):
481
name = self._shortened_test_description(test)
482
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
483
# numbers, plus a trailing blank
484
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
485
self.stream.write(self._ellipsize_to_right(name,
486
osutils.terminal_width()-30))
489
def _error_summary(self, err):
491
return '%s%s' % (indent, err[1])
493
def report_error(self, test, err):
494
self.stream.writeln('ERROR %s\n%s'
495
% (self._testTimeString(test),
496
self._error_summary(err)))
498
def report_failure(self, test, err):
499
self.stream.writeln(' FAIL %s\n%s'
500
% (self._testTimeString(test),
501
self._error_summary(err)))
503
def report_known_failure(self, test, err):
504
self.stream.writeln('XFAIL %s\n%s'
505
% (self._testTimeString(test),
506
self._error_summary(err)))
508
def report_success(self, test):
509
self.stream.writeln(' OK %s' % self._testTimeString(test))
510
for bench_called, stats in getattr(test, '_benchcalls', []):
511
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
512
stats.pprint(file=self.stream)
513
# flush the stream so that we get smooth output. This verbose mode is
514
# used to show the output in PQM.
517
def report_skip(self, test, skip_excinfo):
518
self.stream.writeln(' SKIP %s\n%s'
519
% (self._testTimeString(test),
520
self._error_summary(skip_excinfo)))
522
def report_not_applicable(self, test, skip_excinfo):
523
self.stream.writeln(' N/A %s\n%s'
524
% (self._testTimeString(test),
525
self._error_summary(skip_excinfo)))
527
def report_unsupported(self, test, feature):
528
"""test cannot be run because feature is missing."""
529
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
530
%(self._testTimeString(test), feature))
533
class TextTestRunner(object):
534
stop_on_failure = False
543
self.stream = unittest._WritelnDecorator(stream)
544
self.descriptions = descriptions
545
self.verbosity = verbosity
546
self._bench_history = bench_history
547
self.list_only = list_only
550
"Run the given test case or test suite."
551
startTime = time.time()
552
if self.verbosity == 1:
553
result_class = TextTestResult
554
elif self.verbosity >= 2:
555
result_class = VerboseTestResult
556
result = result_class(self.stream,
559
bench_history=self._bench_history,
560
num_tests=test.countTestCases(),
562
result.stop_early = self.stop_on_failure
563
result.report_starting()
565
if self.verbosity >= 2:
566
self.stream.writeln("Listing tests only ...\n")
568
for t in iter_suite_tests(test):
569
self.stream.writeln("%s" % (t.id()))
571
actionTaken = "Listed"
574
run = result.testsRun
576
stopTime = time.time()
577
timeTaken = stopTime - startTime
579
self.stream.writeln(result.separator2)
580
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
581
run, run != 1 and "s" or "", timeTaken))
582
self.stream.writeln()
583
if not result.wasSuccessful():
584
self.stream.write("FAILED (")
585
failed, errored = map(len, (result.failures, result.errors))
587
self.stream.write("failures=%d" % failed)
589
if failed: self.stream.write(", ")
590
self.stream.write("errors=%d" % errored)
591
if result.known_failure_count:
592
if failed or errored: self.stream.write(", ")
593
self.stream.write("known_failure_count=%d" %
594
result.known_failure_count)
595
self.stream.writeln(")")
597
if result.known_failure_count:
598
self.stream.writeln("OK (known_failures=%d)" %
599
result.known_failure_count)
601
self.stream.writeln("OK")
602
if result.skip_count > 0:
603
skipped = result.skip_count
604
self.stream.writeln('%d test%s skipped' %
605
(skipped, skipped != 1 and "s" or ""))
606
if result.unsupported:
607
for feature, count in sorted(result.unsupported.items()):
608
self.stream.writeln("Missing feature '%s' skipped %d tests." %
614
def iter_suite_tests(suite):
615
"""Return all tests in a suite, recursing through nested suites"""
616
for item in suite._tests:
617
if isinstance(item, unittest.TestCase):
619
elif isinstance(item, unittest.TestSuite):
620
for r in iter_suite_tests(item):
623
raise Exception('unknown object %r inside test suite %r'
627
class TestSkipped(Exception):
628
"""Indicates that a test was intentionally skipped, rather than failing."""
631
class TestNotApplicable(TestSkipped):
632
"""A test is not applicable to the situation where it was run.
634
This is only normally raised by parameterized tests, if they find that
635
the instance they're constructed upon does not support one aspect
640
class KnownFailure(AssertionError):
641
"""Indicates that a test failed in a precisely expected manner.
643
Such failures dont block the whole test suite from passing because they are
644
indicators of partially completed code or of future work. We have an
645
explicit error for them so that we can ensure that they are always visible:
646
KnownFailures are always shown in the output of bzr selftest.
650
class UnavailableFeature(Exception):
651
"""A feature required for this test was not available.
653
The feature should be used to construct the exception.
657
class CommandFailed(Exception):
661
class StringIOWrapper(object):
662
"""A wrapper around cStringIO which just adds an encoding attribute.
664
Internally we can check sys.stdout to see what the output encoding
665
should be. However, cStringIO has no encoding attribute that we can
666
set. So we wrap it instead.
671
def __init__(self, s=None):
673
self.__dict__['_cstring'] = StringIO(s)
675
self.__dict__['_cstring'] = StringIO()
677
def __getattr__(self, name, getattr=getattr):
678
return getattr(self.__dict__['_cstring'], name)
680
def __setattr__(self, name, val):
681
if name == 'encoding':
682
self.__dict__['encoding'] = val
684
return setattr(self._cstring, name, val)
687
class TestUIFactory(ui.CLIUIFactory):
688
"""A UI Factory for testing.
690
Hide the progress bar but emit note()s.
692
Allows get_password to be tested without real tty attached.
699
super(TestUIFactory, self).__init__()
700
if stdin is not None:
701
# We use a StringIOWrapper to be able to test various
702
# encodings, but the user is still responsible to
703
# encode the string and to set the encoding attribute
704
# of StringIOWrapper.
705
self.stdin = StringIOWrapper(stdin)
707
self.stdout = sys.stdout
711
self.stderr = sys.stderr
716
"""See progress.ProgressBar.clear()."""
718
def clear_term(self):
719
"""See progress.ProgressBar.clear_term()."""
721
def clear_term(self):
722
"""See progress.ProgressBar.clear_term()."""
725
"""See progress.ProgressBar.finished()."""
727
def note(self, fmt_string, *args, **kwargs):
728
"""See progress.ProgressBar.note()."""
729
self.stdout.write((fmt_string + "\n") % args)
731
def progress_bar(self):
734
def nested_progress_bar(self):
737
def update(self, message, count=None, total=None):
738
"""See progress.ProgressBar.update()."""
740
def get_non_echoed_password(self, prompt):
741
"""Get password from stdin without trying to handle the echo mode"""
743
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
744
password = self.stdin.readline()
747
if password[-1] == '\n':
748
password = password[:-1]
752
class TestCase(unittest.TestCase):
753
"""Base class for bzr unit tests.
755
Tests that need access to disk resources should subclass
756
TestCaseInTempDir not TestCase.
758
Error and debug log messages are redirected from their usual
759
location into a temporary file, the contents of which can be
760
retrieved by _get_log(). We use a real OS file, not an in-memory object,
761
so that it can also capture file IO. When the test completes this file
762
is read into memory and removed from disk.
764
There are also convenience functions to invoke bzr's command-line
765
routine, and to build and check bzr trees.
767
In addition to the usual method of overriding tearDown(), this class also
768
allows subclasses to register functions into the _cleanups list, which is
769
run in order as the object is torn down. It's less likely this will be
770
accidentally overlooked.
773
_log_file_name = None
775
_keep_log_file = False
776
# record lsprof data when performing benchmark calls.
777
_gather_lsprof_in_benchmarks = False
778
attrs_to_keep = ('_testMethodName', '_testMethodDoc',
779
'_log_contents', '_log_file_name', '_benchtime',
780
'_TestCase__testMethodName')
782
def __init__(self, methodName='testMethod'):
783
super(TestCase, self).__init__(methodName)
787
unittest.TestCase.setUp(self)
788
self._cleanEnvironment()
791
self._benchcalls = []
792
self._benchtime = None
794
self._clear_debug_flags()
796
def _clear_debug_flags(self):
797
"""Prevent externally set debug flags affecting tests.
799
Tests that want to use debug flags can just set them in the
800
debug_flags set during setup/teardown.
802
if 'selftest_debug' not in debug.debug_flags:
803
self._preserved_debug_flags = set(debug.debug_flags)
804
debug.debug_flags.clear()
805
self.addCleanup(self._restore_debug_flags)
807
def _clear_hooks(self):
808
# prevent hooks affecting tests
810
import bzrlib.smart.server
811
self._preserved_hooks = {
812
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
813
bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
814
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
816
self.addCleanup(self._restoreHooks)
817
# reset all hooks to an empty instance of the appropriate type
818
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
819
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
821
def _silenceUI(self):
822
"""Turn off UI for duration of test"""
823
# by default the UI is off; tests can turn it on if they want it.
824
saved = ui.ui_factory
826
ui.ui_factory = saved
827
ui.ui_factory = ui.SilentUIFactory()
828
self.addCleanup(_restore)
830
def _ndiff_strings(self, a, b):
831
"""Return ndiff between two strings containing lines.
833
A trailing newline is added if missing to make the strings
835
if b and b[-1] != '\n':
837
if a and a[-1] != '\n':
839
difflines = difflib.ndiff(a.splitlines(True),
841
linejunk=lambda x: False,
842
charjunk=lambda x: False)
843
return ''.join(difflines)
845
def assertEqual(self, a, b, message=''):
849
except UnicodeError, e:
850
# If we can't compare without getting a UnicodeError, then
851
# obviously they are different
852
mutter('UnicodeError: %s', e)
855
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
857
pformat(a), pformat(b)))
859
assertEquals = assertEqual
861
def assertEqualDiff(self, a, b, message=None):
862
"""Assert two texts are equal, if not raise an exception.
864
This is intended for use with multi-line strings where it can
865
be hard to find the differences by eye.
867
# TODO: perhaps override assertEquals to call this for strings?
871
message = "texts not equal:\n"
872
raise AssertionError(message +
873
self._ndiff_strings(a, b))
875
def assertEqualMode(self, mode, mode_test):
876
self.assertEqual(mode, mode_test,
877
'mode mismatch %o != %o' % (mode, mode_test))
879
def assertPositive(self, val):
880
"""Assert that val is greater than 0."""
881
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
883
def assertNegative(self, val):
884
"""Assert that val is less than 0."""
885
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
887
def assertStartsWith(self, s, prefix):
888
if not s.startswith(prefix):
889
raise AssertionError('string %r does not start with %r' % (s, prefix))
891
def assertEndsWith(self, s, suffix):
892
"""Asserts that s ends with suffix."""
893
if not s.endswith(suffix):
894
raise AssertionError('string %r does not end with %r' % (s, suffix))
896
def assertContainsRe(self, haystack, needle_re):
897
"""Assert that a contains something matching a regular expression."""
898
if not re.search(needle_re, haystack):
899
if '\n' in haystack or len(haystack) > 60:
900
# a long string, format it in a more readable way
901
raise AssertionError(
902
'pattern "%s" not found in\n"""\\\n%s"""\n'
903
% (needle_re, haystack))
905
raise AssertionError('pattern "%s" not found in "%s"'
906
% (needle_re, haystack))
908
def assertNotContainsRe(self, haystack, needle_re):
909
"""Assert that a does not match a regular expression"""
910
if re.search(needle_re, haystack):
911
raise AssertionError('pattern "%s" found in "%s"'
912
% (needle_re, haystack))
914
def assertSubset(self, sublist, superlist):
915
"""Assert that every entry in sublist is present in superlist."""
916
missing = set(sublist) - set(superlist)
918
raise AssertionError("value(s) %r not present in container %r" %
919
(missing, superlist))
921
def assertListRaises(self, excClass, func, *args, **kwargs):
922
"""Fail unless excClass is raised when the iterator from func is used.
924
Many functions can return generators this makes sure
925
to wrap them in a list() call to make sure the whole generator
926
is run, and that the proper exception is raised.
929
list(func(*args, **kwargs))
933
if getattr(excClass,'__name__', None) is not None:
934
excName = excClass.__name__
936
excName = str(excClass)
937
raise self.failureException, "%s not raised" % excName
939
def assertRaises(self, excClass, callableObj, *args, **kwargs):
940
"""Assert that a callable raises a particular exception.
942
:param excClass: As for the except statement, this may be either an
943
exception class, or a tuple of classes.
944
:param callableObj: A callable, will be passed ``*args`` and
947
Returns the exception so that you can examine it.
950
callableObj(*args, **kwargs)
954
if getattr(excClass,'__name__', None) is not None:
955
excName = excClass.__name__
958
excName = str(excClass)
959
raise self.failureException, "%s not raised" % excName
961
def assertIs(self, left, right, message=None):
962
if not (left is right):
963
if message is not None:
964
raise AssertionError(message)
966
raise AssertionError("%r is not %r." % (left, right))
968
def assertIsNot(self, left, right, message=None):
970
if message is not None:
971
raise AssertionError(message)
973
raise AssertionError("%r is %r." % (left, right))
975
def assertTransportMode(self, transport, path, mode):
976
"""Fail if a path does not have mode mode.
978
If modes are not supported on this transport, the assertion is ignored.
980
if not transport._can_roundtrip_unix_modebits():
982
path_stat = transport.stat(path)
983
actual_mode = stat.S_IMODE(path_stat.st_mode)
984
self.assertEqual(mode, actual_mode,
985
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
987
def assertIsSameRealPath(self, path1, path2):
988
"""Fail if path1 and path2 points to different files"""
989
self.assertEqual(osutils.realpath(path1),
990
osutils.realpath(path2),
991
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
993
def assertIsInstance(self, obj, kls):
994
"""Fail if obj is not an instance of kls"""
995
if not isinstance(obj, kls):
996
self.fail("%r is an instance of %s rather than %s" % (
997
obj, obj.__class__, kls))
999
def expectFailure(self, reason, assertion, *args, **kwargs):
1000
"""Invoke a test, expecting it to fail for the given reason.
1002
This is for assertions that ought to succeed, but currently fail.
1003
(The failure is *expected* but not *wanted*.) Please be very precise
1004
about the failure you're expecting. If a new bug is introduced,
1005
AssertionError should be raised, not KnownFailure.
1007
Frequently, expectFailure should be followed by an opposite assertion.
1010
Intended to be used with a callable that raises AssertionError as the
1011
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1013
Raises KnownFailure if the test fails. Raises AssertionError if the
1018
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1020
self.assertEqual(42, dynamic_val)
1022
This means that a dynamic_val of 54 will cause the test to raise
1023
a KnownFailure. Once math is fixed and the expectFailure is removed,
1024
only a dynamic_val of 42 will allow the test to pass. Anything other
1025
than 54 or 42 will cause an AssertionError.
1028
assertion(*args, **kwargs)
1029
except AssertionError:
1030
raise KnownFailure(reason)
1032
self.fail('Unexpected success. Should have failed: %s' % reason)
1034
def assertFileEqual(self, content, path):
1035
"""Fail if path does not contain 'content'."""
1036
self.failUnlessExists(path)
1037
f = file(path, 'rb')
1042
self.assertEqualDiff(content, s)
1044
def failUnlessExists(self, path):
1045
"""Fail unless path or paths, which may be abs or relative, exist."""
1046
if not isinstance(path, basestring):
1048
self.failUnlessExists(p)
1050
self.failUnless(osutils.lexists(path),path+" does not exist")
1052
def failIfExists(self, path):
1053
"""Fail if path or paths, which may be abs or relative, exist."""
1054
if not isinstance(path, basestring):
1056
self.failIfExists(p)
1058
self.failIf(osutils.lexists(path),path+" exists")
1060
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1061
"""A helper for callDeprecated and applyDeprecated.
1063
:param a_callable: A callable to call.
1064
:param args: The positional arguments for the callable
1065
:param kwargs: The keyword arguments for the callable
1066
:return: A tuple (warnings, result). result is the result of calling
1067
a_callable(``*args``, ``**kwargs``).
1070
def capture_warnings(msg, cls=None, stacklevel=None):
1071
# we've hooked into a deprecation specific callpath,
1072
# only deprecations should getting sent via it.
1073
self.assertEqual(cls, DeprecationWarning)
1074
local_warnings.append(msg)
1075
original_warning_method = symbol_versioning.warn
1076
symbol_versioning.set_warning_method(capture_warnings)
1078
result = a_callable(*args, **kwargs)
1080
symbol_versioning.set_warning_method(original_warning_method)
1081
return (local_warnings, result)
1083
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1084
"""Call a deprecated callable without warning the user.
1086
Note that this only captures warnings raised by symbol_versioning.warn,
1087
not other callers that go direct to the warning module.
1089
To test that a deprecated method raises an error, do something like
1092
self.assertRaises(errors.ReservedId,
1093
self.applyDeprecated, zero_ninetyone,
1094
br.append_revision, 'current:')
1096
:param deprecation_format: The deprecation format that the callable
1097
should have been deprecated with. This is the same type as the
1098
parameter to deprecated_method/deprecated_function. If the
1099
callable is not deprecated with this format, an assertion error
1101
:param a_callable: A callable to call. This may be a bound method or
1102
a regular function. It will be called with ``*args`` and
1104
:param args: The positional arguments for the callable
1105
:param kwargs: The keyword arguments for the callable
1106
:return: The result of a_callable(``*args``, ``**kwargs``)
1108
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1110
expected_first_warning = symbol_versioning.deprecation_string(
1111
a_callable, deprecation_format)
1112
if len(call_warnings) == 0:
1113
self.fail("No deprecation warning generated by call to %s" %
1115
self.assertEqual(expected_first_warning, call_warnings[0])
1118
def callCatchWarnings(self, fn, *args, **kw):
1119
"""Call a callable that raises python warnings.
1121
The caller's responsible for examining the returned warnings.
1123
If the callable raises an exception, the exception is not
1124
caught and propagates up to the caller. In that case, the list
1125
of warnings is not available.
1127
:returns: ([warning_object, ...], fn_result)
1129
# XXX: This is not perfect, because it completely overrides the
1130
# warnings filters, and some code may depend on suppressing particular
1131
# warnings. It's the easiest way to insulate ourselves from -Werror,
1132
# though. -- Andrew, 20071062
1134
def _catcher(message, category, filename, lineno, file=None):
1135
# despite the name, 'message' is normally(?) a Warning subclass
1137
wlist.append(message)
1138
saved_showwarning = warnings.showwarning
1139
saved_filters = warnings.filters
1141
warnings.showwarning = _catcher
1142
warnings.filters = []
1143
result = fn(*args, **kw)
1145
warnings.showwarning = saved_showwarning
1146
warnings.filters = saved_filters
1147
return wlist, result
1149
def callDeprecated(self, expected, callable, *args, **kwargs):
1150
"""Assert that a callable is deprecated in a particular way.
1152
This is a very precise test for unusual requirements. The
1153
applyDeprecated helper function is probably more suited for most tests
1154
as it allows you to simply specify the deprecation format being used
1155
and will ensure that that is issued for the function being called.
1157
Note that this only captures warnings raised by symbol_versioning.warn,
1158
not other callers that go direct to the warning module. To catch
1159
general warnings, use callCatchWarnings.
1161
:param expected: a list of the deprecation warnings expected, in order
1162
:param callable: The callable to call
1163
:param args: The positional arguments for the callable
1164
:param kwargs: The keyword arguments for the callable
1166
call_warnings, result = self._capture_deprecation_warnings(callable,
1168
self.assertEqual(expected, call_warnings)
1171
def _startLogFile(self):
1172
"""Send bzr and test log messages to a temporary file.
1174
The file is removed as the test is torn down.
1176
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1177
self._log_file = os.fdopen(fileno, 'w+')
1178
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1179
self._log_file_name = name
1180
self.addCleanup(self._finishLogFile)
1182
def _finishLogFile(self):
1183
"""Finished with the log file.
1185
Close the file and delete it, unless setKeepLogfile was called.
1187
if self._log_file is None:
1189
bzrlib.trace.pop_log_file(self._log_memento)
1190
self._log_file.close()
1191
self._log_file = None
1192
if not self._keep_log_file:
1193
os.remove(self._log_file_name)
1194
self._log_file_name = None
1196
def setKeepLogfile(self):
1197
"""Make the logfile not be deleted when _finishLogFile is called."""
1198
self._keep_log_file = True
1200
def addCleanup(self, callable):
1201
"""Arrange to run a callable when this case is torn down.
1203
Callables are run in the reverse of the order they are registered,
1204
ie last-in first-out.
1206
if callable in self._cleanups:
1207
raise ValueError("cleanup function %r already registered on %s"
1209
self._cleanups.append(callable)
1211
def _cleanEnvironment(self):
1213
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1214
'HOME': os.getcwd(),
1215
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1216
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1218
'BZREMAIL': None, # may still be present in the environment
1220
'BZR_PROGRESS_BAR': None,
1223
'SSH_AUTH_SOCK': None,
1227
'https_proxy': None,
1228
'HTTPS_PROXY': None,
1233
# Nobody cares about these ones AFAIK. So far at
1234
# least. If you do (care), please update this comment
1238
'BZR_REMOTE_PATH': None,
1241
self.addCleanup(self._restoreEnvironment)
1242
for name, value in new_env.iteritems():
1243
self._captureVar(name, value)
1245
def _captureVar(self, name, newvalue):
1246
"""Set an environment variable, and reset it when finished."""
1247
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1249
def _restore_debug_flags(self):
1250
debug.debug_flags.clear()
1251
debug.debug_flags.update(self._preserved_debug_flags)
1253
def _restoreEnvironment(self):
1254
for name, value in self.__old_env.iteritems():
1255
osutils.set_or_unset_env(name, value)
1257
def _restoreHooks(self):
1258
for klass, hooks in self._preserved_hooks.items():
1259
setattr(klass, 'hooks', hooks)
1261
def knownFailure(self, reason):
1262
"""This test has failed for some known reason."""
1263
raise KnownFailure(reason)
1265
def run(self, result=None):
1266
if result is None: result = self.defaultTestResult()
1267
for feature in getattr(self, '_test_needs_features', []):
1268
if not feature.available():
1269
result.startTest(self)
1270
if getattr(result, 'addNotSupported', None):
1271
result.addNotSupported(self, feature)
1273
result.addSuccess(self)
1274
result.stopTest(self)
1277
return unittest.TestCase.run(self, result)
1280
absent_attr = object()
1281
for attr_name in self.attrs_to_keep:
1282
attr = getattr(self, attr_name, absent_attr)
1283
if attr is not absent_attr:
1284
saved_attrs[attr_name] = attr
1285
self.__dict__ = saved_attrs
1289
unittest.TestCase.tearDown(self)
1291
def time(self, callable, *args, **kwargs):
1292
"""Run callable and accrue the time it takes to the benchmark time.
1294
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1295
this will cause lsprofile statistics to be gathered and stored in
1298
if self._benchtime is None:
1302
if not self._gather_lsprof_in_benchmarks:
1303
return callable(*args, **kwargs)
1305
# record this benchmark
1306
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1308
self._benchcalls.append(((callable, args, kwargs), stats))
1311
self._benchtime += time.time() - start
1313
def _runCleanups(self):
1314
"""Run registered cleanup functions.
1316
This should only be called from TestCase.tearDown.
1318
# TODO: Perhaps this should keep running cleanups even if
1319
# one of them fails?
1321
# Actually pop the cleanups from the list so tearDown running
1322
# twice is safe (this happens for skipped tests).
1323
while self._cleanups:
1324
self._cleanups.pop()()
1326
def log(self, *args):
1329
def _get_log(self, keep_log_file=False):
1330
"""Get the log from bzrlib.trace calls from this test.
1332
:param keep_log_file: When True, if the log is still a file on disk
1333
leave it as a file on disk. When False, if the log is still a file
1334
on disk, the log file is deleted and the log preserved as
1336
:return: A string containing the log.
1338
# flush the log file, to get all content
1340
bzrlib.trace._trace_file.flush()
1341
if self._log_contents:
1342
# XXX: this can hardly contain the content flushed above --vila
1344
return self._log_contents
1345
if self._log_file_name is not None:
1346
logfile = open(self._log_file_name)
1348
log_contents = logfile.read()
1351
if not keep_log_file:
1352
self._log_contents = log_contents
1354
os.remove(self._log_file_name)
1356
if sys.platform == 'win32' and e.errno == errno.EACCES:
1357
sys.stderr.write(('Unable to delete log file '
1358
' %r\n' % self._log_file_name))
1363
return "DELETED log file to reduce memory footprint"
1365
def requireFeature(self, feature):
1366
"""This test requires a specific feature is available.
1368
:raises UnavailableFeature: When feature is not available.
1370
if not feature.available():
1371
raise UnavailableFeature(feature)
1373
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1375
"""Run bazaar command line, splitting up a string command line."""
1376
if isinstance(args, basestring):
1377
# shlex don't understand unicode strings,
1378
# so args should be plain string (bialix 20070906)
1379
args = list(shlex.split(str(args)))
1380
return self._run_bzr_core(args, retcode=retcode,
1381
encoding=encoding, stdin=stdin, working_dir=working_dir,
1384
def _run_bzr_core(self, args, retcode, encoding, stdin,
1386
if encoding is None:
1387
encoding = bzrlib.user_encoding
1388
stdout = StringIOWrapper()
1389
stderr = StringIOWrapper()
1390
stdout.encoding = encoding
1391
stderr.encoding = encoding
1393
self.log('run bzr: %r', args)
1394
# FIXME: don't call into logging here
1395
handler = logging.StreamHandler(stderr)
1396
handler.setLevel(logging.INFO)
1397
logger = logging.getLogger('')
1398
logger.addHandler(handler)
1399
old_ui_factory = ui.ui_factory
1400
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1403
if working_dir is not None:
1404
cwd = osutils.getcwd()
1405
os.chdir(working_dir)
1408
result = self.apply_redirected(ui.ui_factory.stdin,
1410
bzrlib.commands.run_bzr_catch_user_errors,
1413
logger.removeHandler(handler)
1414
ui.ui_factory = old_ui_factory
1418
out = stdout.getvalue()
1419
err = stderr.getvalue()
1421
self.log('output:\n%r', out)
1423
self.log('errors:\n%r', err)
1424
if retcode is not None:
1425
self.assertEquals(retcode, result,
1426
message='Unexpected return code')
1429
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1430
working_dir=None, error_regexes=[], output_encoding=None):
1431
"""Invoke bzr, as if it were run from the command line.
1433
The argument list should not include the bzr program name - the
1434
first argument is normally the bzr command. Arguments may be
1435
passed in three ways:
1437
1- A list of strings, eg ["commit", "a"]. This is recommended
1438
when the command contains whitespace or metacharacters, or
1439
is built up at run time.
1441
2- A single string, eg "add a". This is the most convenient
1442
for hardcoded commands.
1444
This runs bzr through the interface that catches and reports
1445
errors, and with logging set to something approximating the
1446
default, so that error reporting can be checked.
1448
This should be the main method for tests that want to exercise the
1449
overall behavior of the bzr application (rather than a unit test
1450
or a functional test of the library.)
1452
This sends the stdout/stderr results into the test's log,
1453
where it may be useful for debugging. See also run_captured.
1455
:keyword stdin: A string to be used as stdin for the command.
1456
:keyword retcode: The status code the command should return;
1458
:keyword working_dir: The directory to run the command in
1459
:keyword error_regexes: A list of expected error messages. If
1460
specified they must be seen in the error output of the command.
1462
out, err = self._run_bzr_autosplit(
1467
working_dir=working_dir,
1469
for regex in error_regexes:
1470
self.assertContainsRe(err, regex)
1473
def run_bzr_error(self, error_regexes, *args, **kwargs):
1474
"""Run bzr, and check that stderr contains the supplied regexes
1476
:param error_regexes: Sequence of regular expressions which
1477
must each be found in the error output. The relative ordering
1479
:param args: command-line arguments for bzr
1480
:param kwargs: Keyword arguments which are interpreted by run_bzr
1481
This function changes the default value of retcode to be 3,
1482
since in most cases this is run when you expect bzr to fail.
1484
:return: (out, err) The actual output of running the command (in case
1485
you want to do more inspection)
1489
# Make sure that commit is failing because there is nothing to do
1490
self.run_bzr_error(['no changes to commit'],
1491
['commit', '-m', 'my commit comment'])
1492
# Make sure --strict is handling an unknown file, rather than
1493
# giving us the 'nothing to do' error
1494
self.build_tree(['unknown'])
1495
self.run_bzr_error(['Commit refused because there are unknown files'],
1496
['commit', --strict', '-m', 'my commit comment'])
1498
kwargs.setdefault('retcode', 3)
1499
kwargs['error_regexes'] = error_regexes
1500
out, err = self.run_bzr(*args, **kwargs)
1503
def run_bzr_subprocess(self, *args, **kwargs):
1504
"""Run bzr in a subprocess for testing.
1506
This starts a new Python interpreter and runs bzr in there.
1507
This should only be used for tests that have a justifiable need for
1508
this isolation: e.g. they are testing startup time, or signal
1509
handling, or early startup code, etc. Subprocess code can't be
1510
profiled or debugged so easily.
1512
:keyword retcode: The status code that is expected. Defaults to 0. If
1513
None is supplied, the status code is not checked.
1514
:keyword env_changes: A dictionary which lists changes to environment
1515
variables. A value of None will unset the env variable.
1516
The values must be strings. The change will only occur in the
1517
child, so you don't need to fix the environment after running.
1518
:keyword universal_newlines: Convert CRLF => LF
1519
:keyword allow_plugins: By default the subprocess is run with
1520
--no-plugins to ensure test reproducibility. Also, it is possible
1521
for system-wide plugins to create unexpected output on stderr,
1522
which can cause unnecessary test failures.
1524
env_changes = kwargs.get('env_changes', {})
1525
working_dir = kwargs.get('working_dir', None)
1526
allow_plugins = kwargs.get('allow_plugins', False)
1528
if isinstance(args[0], list):
1530
elif isinstance(args[0], basestring):
1531
args = list(shlex.split(args[0]))
1533
symbol_versioning.warn(zero_ninetyone %
1534
"passing varargs to run_bzr_subprocess",
1535
DeprecationWarning, stacklevel=3)
1536
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1537
working_dir=working_dir,
1538
allow_plugins=allow_plugins)
1539
# We distinguish between retcode=None and retcode not passed.
1540
supplied_retcode = kwargs.get('retcode', 0)
1541
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1542
universal_newlines=kwargs.get('universal_newlines', False),
1545
def start_bzr_subprocess(self, process_args, env_changes=None,
1546
skip_if_plan_to_signal=False,
1548
allow_plugins=False):
1549
"""Start bzr in a subprocess for testing.
1551
This starts a new Python interpreter and runs bzr in there.
1552
This should only be used for tests that have a justifiable need for
1553
this isolation: e.g. they are testing startup time, or signal
1554
handling, or early startup code, etc. Subprocess code can't be
1555
profiled or debugged so easily.
1557
:param process_args: a list of arguments to pass to the bzr executable,
1558
for example ``['--version']``.
1559
:param env_changes: A dictionary which lists changes to environment
1560
variables. A value of None will unset the env variable.
1561
The values must be strings. The change will only occur in the
1562
child, so you don't need to fix the environment after running.
1563
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1565
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1567
:returns: Popen object for the started process.
1569
if skip_if_plan_to_signal:
1570
if not getattr(os, 'kill', None):
1571
raise TestSkipped("os.kill not available.")
1573
if env_changes is None:
1577
def cleanup_environment():
1578
for env_var, value in env_changes.iteritems():
1579
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1581
def restore_environment():
1582
for env_var, value in old_env.iteritems():
1583
osutils.set_or_unset_env(env_var, value)
1585
bzr_path = self.get_bzr_path()
1588
if working_dir is not None:
1589
cwd = osutils.getcwd()
1590
os.chdir(working_dir)
1593
# win32 subprocess doesn't support preexec_fn
1594
# so we will avoid using it on all platforms, just to
1595
# make sure the code path is used, and we don't break on win32
1596
cleanup_environment()
1597
command = [sys.executable, bzr_path]
1598
if not allow_plugins:
1599
command.append('--no-plugins')
1600
command.extend(process_args)
1601
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1603
restore_environment()
1609
def _popen(self, *args, **kwargs):
1610
"""Place a call to Popen.
1612
Allows tests to override this method to intercept the calls made to
1613
Popen for introspection.
1615
return Popen(*args, **kwargs)
1617
def get_bzr_path(self):
1618
"""Return the path of the 'bzr' executable for this test suite."""
1619
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1620
if not os.path.isfile(bzr_path):
1621
# We are probably installed. Assume sys.argv is the right file
1622
bzr_path = sys.argv[0]
1625
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1626
universal_newlines=False, process_args=None):
1627
"""Finish the execution of process.
1629
:param process: the Popen object returned from start_bzr_subprocess.
1630
:param retcode: The status code that is expected. Defaults to 0. If
1631
None is supplied, the status code is not checked.
1632
:param send_signal: an optional signal to send to the process.
1633
:param universal_newlines: Convert CRLF => LF
1634
:returns: (stdout, stderr)
1636
if send_signal is not None:
1637
os.kill(process.pid, send_signal)
1638
out, err = process.communicate()
1640
if universal_newlines:
1641
out = out.replace('\r\n', '\n')
1642
err = err.replace('\r\n', '\n')
1644
if retcode is not None and retcode != process.returncode:
1645
if process_args is None:
1646
process_args = "(unknown args)"
1647
mutter('Output of bzr %s:\n%s', process_args, out)
1648
mutter('Error for bzr %s:\n%s', process_args, err)
1649
self.fail('Command bzr %s failed with retcode %s != %s'
1650
% (process_args, retcode, process.returncode))
1653
def check_inventory_shape(self, inv, shape):
1654
"""Compare an inventory to a list of expected names.
1656
Fail if they are not precisely equal.
1659
shape = list(shape) # copy
1660
for path, ie in inv.entries():
1661
name = path.replace('\\', '/')
1662
if ie.kind == 'directory':
1669
self.fail("expected paths not found in inventory: %r" % shape)
1671
self.fail("unexpected paths found in inventory: %r" % extras)
1673
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1674
a_callable=None, *args, **kwargs):
1675
"""Call callable with redirected std io pipes.
1677
Returns the return code."""
1678
if not callable(a_callable):
1679
raise ValueError("a_callable must be callable.")
1681
stdin = StringIO("")
1683
if getattr(self, "_log_file", None) is not None:
1684
stdout = self._log_file
1688
if getattr(self, "_log_file", None is not None):
1689
stderr = self._log_file
1692
real_stdin = sys.stdin
1693
real_stdout = sys.stdout
1694
real_stderr = sys.stderr
1699
return a_callable(*args, **kwargs)
1701
sys.stdout = real_stdout
1702
sys.stderr = real_stderr
1703
sys.stdin = real_stdin
1705
def reduceLockdirTimeout(self):
1706
"""Reduce the default lock timeout for the duration of the test, so that
1707
if LockContention occurs during a test, it does so quickly.
1709
Tests that expect to provoke LockContention errors should call this.
1711
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1713
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1714
self.addCleanup(resetTimeout)
1715
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1717
def make_utf8_encoded_stringio(self, encoding_type=None):
1718
"""Return a StringIOWrapper instance, that will encode Unicode
1721
if encoding_type is None:
1722
encoding_type = 'strict'
1724
output_encoding = 'utf-8'
1725
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1726
sio.encoding = output_encoding
1730
class TestCaseWithMemoryTransport(TestCase):
1731
"""Common test class for tests that do not need disk resources.
1733
Tests that need disk resources should derive from TestCaseWithTransport.
1735
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1737
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1738
a directory which does not exist. This serves to help ensure test isolation
1739
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1740
must exist. However, TestCaseWithMemoryTransport does not offer local
1741
file defaults for the transport in tests, nor does it obey the command line
1742
override, so tests that accidentally write to the common directory should
1745
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1746
a .bzr directory that stops us ascending higher into the filesystem.
1752
def __init__(self, methodName='runTest'):
1753
# allow test parameterization after test construction and before test
1754
# execution. Variables that the parameterizer sets need to be
1755
# ones that are not set by setUp, or setUp will trash them.
1756
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1757
self.vfs_transport_factory = default_transport
1758
self.transport_server = None
1759
self.transport_readonly_server = None
1760
self.__vfs_server = None
1762
def get_transport(self, relpath=None):
1763
"""Return a writeable transport.
1765
This transport is for the test scratch space relative to
1768
:param relpath: a path relative to the base url.
1770
t = get_transport(self.get_url(relpath))
1771
self.assertFalse(t.is_readonly())
1774
def get_readonly_transport(self, relpath=None):
1775
"""Return a readonly transport for the test scratch space
1777
This can be used to test that operations which should only need
1778
readonly access in fact do not try to write.
1780
:param relpath: a path relative to the base url.
1782
t = get_transport(self.get_readonly_url(relpath))
1783
self.assertTrue(t.is_readonly())
1786
def create_transport_readonly_server(self):
1787
"""Create a transport server from class defined at init.
1789
This is mostly a hook for daughter classes.
1791
return self.transport_readonly_server()
1793
def get_readonly_server(self):
1794
"""Get the server instance for the readonly transport
1796
This is useful for some tests with specific servers to do diagnostics.
1798
if self.__readonly_server is None:
1799
if self.transport_readonly_server is None:
1800
# readonly decorator requested
1801
# bring up the server
1802
self.__readonly_server = ReadonlyServer()
1803
self.__readonly_server.setUp(self.get_vfs_only_server())
1805
self.__readonly_server = self.create_transport_readonly_server()
1806
self.__readonly_server.setUp(self.get_vfs_only_server())
1807
self.addCleanup(self.__readonly_server.tearDown)
1808
return self.__readonly_server
1810
def get_readonly_url(self, relpath=None):
1811
"""Get a URL for the readonly transport.
1813
This will either be backed by '.' or a decorator to the transport
1814
used by self.get_url()
1815
relpath provides for clients to get a path relative to the base url.
1816
These should only be downwards relative, not upwards.
1818
base = self.get_readonly_server().get_url()
1819
return self._adjust_url(base, relpath)
1821
def get_vfs_only_server(self):
1822
"""Get the vfs only read/write server instance.
1824
This is useful for some tests with specific servers that need
1827
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1828
is no means to override it.
1830
if self.__vfs_server is None:
1831
self.__vfs_server = MemoryServer()
1832
self.__vfs_server.setUp()
1833
self.addCleanup(self.__vfs_server.tearDown)
1834
return self.__vfs_server
1836
def get_server(self):
1837
"""Get the read/write server instance.
1839
This is useful for some tests with specific servers that need
1842
This is built from the self.transport_server factory. If that is None,
1843
then the self.get_vfs_server is returned.
1845
if self.__server is None:
1846
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1847
return self.get_vfs_only_server()
1849
# bring up a decorated means of access to the vfs only server.
1850
self.__server = self.transport_server()
1852
self.__server.setUp(self.get_vfs_only_server())
1853
except TypeError, e:
1854
# This should never happen; the try:Except here is to assist
1855
# developers having to update code rather than seeing an
1856
# uninformative TypeError.
1857
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1858
self.addCleanup(self.__server.tearDown)
1859
return self.__server
1861
def _adjust_url(self, base, relpath):
1862
"""Get a URL (or maybe a path) for the readwrite transport.
1864
This will either be backed by '.' or to an equivalent non-file based
1866
relpath provides for clients to get a path relative to the base url.
1867
These should only be downwards relative, not upwards.
1869
if relpath is not None and relpath != '.':
1870
if not base.endswith('/'):
1872
# XXX: Really base should be a url; we did after all call
1873
# get_url()! But sometimes it's just a path (from
1874
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1875
# to a non-escaped local path.
1876
if base.startswith('./') or base.startswith('/'):
1879
base += urlutils.escape(relpath)
1882
def get_url(self, relpath=None):
1883
"""Get a URL (or maybe a path) for the readwrite transport.
1885
This will either be backed by '.' or to an equivalent non-file based
1887
relpath provides for clients to get a path relative to the base url.
1888
These should only be downwards relative, not upwards.
1890
base = self.get_server().get_url()
1891
return self._adjust_url(base, relpath)
1893
def get_vfs_only_url(self, relpath=None):
1894
"""Get a URL (or maybe a path for the plain old vfs transport.
1896
This will never be a smart protocol. It always has all the
1897
capabilities of the local filesystem, but it might actually be a
1898
MemoryTransport or some other similar virtual filesystem.
1900
This is the backing transport (if any) of the server returned by
1901
get_url and get_readonly_url.
1903
:param relpath: provides for clients to get a path relative to the base
1904
url. These should only be downwards relative, not upwards.
1907
base = self.get_vfs_only_server().get_url()
1908
return self._adjust_url(base, relpath)
1910
def _create_safety_net(self):
1911
"""Make a fake bzr directory.
1913
This prevents any tests propagating up onto the TEST_ROOT directory's
1916
root = TestCaseWithMemoryTransport.TEST_ROOT
1917
bzrdir.BzrDir.create_standalone_workingtree(root)
1919
def _check_safety_net(self):
1920
"""Check that the safety .bzr directory have not been touched.
1922
_make_test_root have created a .bzr directory to prevent tests from
1923
propagating. This method ensures than a test did not leaked.
1925
root = TestCaseWithMemoryTransport.TEST_ROOT
1926
wt = workingtree.WorkingTree.open(root)
1927
last_rev = wt.last_revision()
1928
if last_rev != 'null:':
1929
# The current test have modified the /bzr directory, we need to
1930
# recreate a new one or all the followng tests will fail.
1931
# If you need to inspect its content uncomment the following line
1932
# import pdb; pdb.set_trace()
1933
_rmtree_temp_dir(root + '/.bzr')
1934
self._create_safety_net()
1935
raise AssertionError('%s/.bzr should not be modified' % root)
1937
def _make_test_root(self):
1938
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1939
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1940
TestCaseWithMemoryTransport.TEST_ROOT = root
1942
self._create_safety_net()
1944
# The same directory is used by all tests, and we're not
1945
# specifically told when all tests are finished. This will do.
1946
atexit.register(_rmtree_temp_dir, root)
1948
self.addCleanup(self._check_safety_net)
1950
def makeAndChdirToTestDir(self):
1951
"""Create a temporary directories for this one test.
1953
This must set self.test_home_dir and self.test_dir and chdir to
1956
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1958
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1959
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1960
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1962
def make_branch(self, relpath, format=None):
1963
"""Create a branch on the transport at relpath."""
1964
repo = self.make_repository(relpath, format=format)
1965
return repo.bzrdir.create_branch()
1967
def make_bzrdir(self, relpath, format=None):
1969
# might be a relative or absolute path
1970
maybe_a_url = self.get_url(relpath)
1971
segments = maybe_a_url.rsplit('/', 1)
1972
t = get_transport(maybe_a_url)
1973
if len(segments) > 1 and segments[-1] not in ('', '.'):
1977
if isinstance(format, basestring):
1978
format = bzrdir.format_registry.make_bzrdir(format)
1979
return format.initialize_on_transport(t)
1980
except errors.UninitializableFormat:
1981
raise TestSkipped("Format %s is not initializable." % format)
1983
def make_repository(self, relpath, shared=False, format=None):
1984
"""Create a repository on our default transport at relpath.
1986
Note that relpath must be a relative path, not a full url.
1988
# FIXME: If you create a remoterepository this returns the underlying
1989
# real format, which is incorrect. Actually we should make sure that
1990
# RemoteBzrDir returns a RemoteRepository.
1991
# maybe mbp 20070410
1992
made_control = self.make_bzrdir(relpath, format=format)
1993
return made_control.create_repository(shared=shared)
1995
def make_branch_and_memory_tree(self, relpath, format=None):
1996
"""Create a branch on the default transport and a MemoryTree for it."""
1997
b = self.make_branch(relpath, format=format)
1998
return memorytree.MemoryTree.create_on_branch(b)
2000
def overrideEnvironmentForTesting(self):
2001
os.environ['HOME'] = self.test_home_dir
2002
os.environ['BZR_HOME'] = self.test_home_dir
2005
super(TestCaseWithMemoryTransport, self).setUp()
2006
self._make_test_root()
2007
_currentdir = os.getcwdu()
2008
def _leaveDirectory():
2009
os.chdir(_currentdir)
2010
self.addCleanup(_leaveDirectory)
2011
self.makeAndChdirToTestDir()
2012
self.overrideEnvironmentForTesting()
2013
self.__readonly_server = None
2014
self.__server = None
2015
self.reduceLockdirTimeout()
2018
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2019
"""Derived class that runs a test within a temporary directory.
2021
This is useful for tests that need to create a branch, etc.
2023
The directory is created in a slightly complex way: for each
2024
Python invocation, a new temporary top-level directory is created.
2025
All test cases create their own directory within that. If the
2026
tests complete successfully, the directory is removed.
2028
:ivar test_base_dir: The path of the top-level directory for this
2029
test, which contains a home directory and a work directory.
2031
:ivar test_home_dir: An initially empty directory under test_base_dir
2032
which is used as $HOME for this test.
2034
:ivar test_dir: A directory under test_base_dir used as the current
2035
directory when the test proper is run.
2038
OVERRIDE_PYTHON = 'python'
2040
def check_file_contents(self, filename, expect):
2041
self.log("check contents of file %s" % filename)
2042
contents = file(filename, 'r').read()
2043
if contents != expect:
2044
self.log("expected: %r" % expect)
2045
self.log("actually: %r" % contents)
2046
self.fail("contents of %s not as expected" % filename)
2048
def makeAndChdirToTestDir(self):
2049
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2051
For TestCaseInTempDir we create a temporary directory based on the test
2052
name and then create two subdirs - test and home under it.
2054
# create a directory within the top level test directory
2055
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2056
# now create test and home directories within this dir
2057
self.test_base_dir = candidate_dir
2058
self.test_home_dir = self.test_base_dir + '/home'
2059
os.mkdir(self.test_home_dir)
2060
self.test_dir = self.test_base_dir + '/work'
2061
os.mkdir(self.test_dir)
2062
os.chdir(self.test_dir)
2063
# put name of test inside
2064
f = file(self.test_base_dir + '/name', 'w')
2069
self.addCleanup(self.deleteTestDir)
2071
def deleteTestDir(self):
2072
os.chdir(self.TEST_ROOT)
2073
_rmtree_temp_dir(self.test_base_dir)
2075
def build_tree(self, shape, line_endings='binary', transport=None):
2076
"""Build a test tree according to a pattern.
2078
shape is a sequence of file specifications. If the final
2079
character is '/', a directory is created.
2081
This assumes that all the elements in the tree being built are new.
2083
This doesn't add anything to a branch.
2085
:type shape: list or tuple.
2086
:param line_endings: Either 'binary' or 'native'
2087
in binary mode, exact contents are written in native mode, the
2088
line endings match the default platform endings.
2089
:param transport: A transport to write to, for building trees on VFS's.
2090
If the transport is readonly or None, "." is opened automatically.
2093
if type(shape) not in (list, tuple):
2094
raise AssertionError("Parameter 'shape' should be "
2095
"a list or a tuple. Got %r instead" % (shape,))
2096
# It's OK to just create them using forward slashes on windows.
2097
if transport is None or transport.is_readonly():
2098
transport = get_transport(".")
2100
self.assert_(isinstance(name, basestring))
2102
transport.mkdir(urlutils.escape(name[:-1]))
2104
if line_endings == 'binary':
2106
elif line_endings == 'native':
2109
raise errors.BzrError(
2110
'Invalid line ending request %r' % line_endings)
2111
content = "contents of %s%s" % (name.encode('utf-8'), end)
2112
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2114
def build_tree_contents(self, shape):
2115
build_tree_contents(shape)
2117
def assertInWorkingTree(self, path, root_path='.', tree=None):
2118
"""Assert whether path or paths are in the WorkingTree"""
2120
tree = workingtree.WorkingTree.open(root_path)
2121
if not isinstance(path, basestring):
2123
self.assertInWorkingTree(p,tree=tree)
2125
self.assertIsNot(tree.path2id(path), None,
2126
path+' not in working tree.')
2128
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2129
"""Assert whether path or paths are not in the WorkingTree"""
2131
tree = workingtree.WorkingTree.open(root_path)
2132
if not isinstance(path, basestring):
2134
self.assertNotInWorkingTree(p,tree=tree)
2136
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2139
class TestCaseWithTransport(TestCaseInTempDir):
2140
"""A test case that provides get_url and get_readonly_url facilities.
2142
These back onto two transport servers, one for readonly access and one for
2145
If no explicit class is provided for readonly access, a
2146
ReadonlyTransportDecorator is used instead which allows the use of non disk
2147
based read write transports.
2149
If an explicit class is provided for readonly access, that server and the
2150
readwrite one must both define get_url() as resolving to os.getcwd().
2153
def get_vfs_only_server(self):
2154
"""See TestCaseWithMemoryTransport.
2156
This is useful for some tests with specific servers that need
2159
if self.__vfs_server is None:
2160
self.__vfs_server = self.vfs_transport_factory()
2161
self.__vfs_server.setUp()
2162
self.addCleanup(self.__vfs_server.tearDown)
2163
return self.__vfs_server
2165
def make_branch_and_tree(self, relpath, format=None):
2166
"""Create a branch on the transport and a tree locally.
2168
If the transport is not a LocalTransport, the Tree can't be created on
2169
the transport. In that case if the vfs_transport_factory is
2170
LocalURLServer the working tree is created in the local
2171
directory backing the transport, and the returned tree's branch and
2172
repository will also be accessed locally. Otherwise a lightweight
2173
checkout is created and returned.
2175
:param format: The BzrDirFormat.
2176
:returns: the WorkingTree.
2178
# TODO: always use the local disk path for the working tree,
2179
# this obviously requires a format that supports branch references
2180
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2182
b = self.make_branch(relpath, format=format)
2184
return b.bzrdir.create_workingtree()
2185
except errors.NotLocalUrl:
2186
# We can only make working trees locally at the moment. If the
2187
# transport can't support them, then we keep the non-disk-backed
2188
# branch and create a local checkout.
2189
if self.vfs_transport_factory is LocalURLServer:
2190
# the branch is colocated on disk, we cannot create a checkout.
2191
# hopefully callers will expect this.
2192
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2193
return local_controldir.create_workingtree()
2195
return b.create_checkout(relpath, lightweight=True)
2197
def assertIsDirectory(self, relpath, transport):
2198
"""Assert that relpath within transport is a directory.
2200
This may not be possible on all transports; in that case it propagates
2201
a TransportNotPossible.
2204
mode = transport.stat(relpath).st_mode
2205
except errors.NoSuchFile:
2206
self.fail("path %s is not a directory; no such file"
2208
if not stat.S_ISDIR(mode):
2209
self.fail("path %s is not a directory; has mode %#o"
2212
def assertTreesEqual(self, left, right):
2213
"""Check that left and right have the same content and properties."""
2214
# we use a tree delta to check for equality of the content, and we
2215
# manually check for equality of other things such as the parents list.
2216
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2217
differences = left.changes_from(right)
2218
self.assertFalse(differences.has_changed(),
2219
"Trees %r and %r are different: %r" % (left, right, differences))
2222
super(TestCaseWithTransport, self).setUp()
2223
self.__vfs_server = None
2226
class ChrootedTestCase(TestCaseWithTransport):
2227
"""A support class that provides readonly urls outside the local namespace.
2229
This is done by checking if self.transport_server is a MemoryServer. if it
2230
is then we are chrooted already, if it is not then an HttpServer is used
2233
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2234
be used without needed to redo it when a different
2235
subclass is in use ?
2239
super(ChrootedTestCase, self).setUp()
2240
if not self.vfs_transport_factory == MemoryServer:
2241
self.transport_readonly_server = HttpServer
2244
def condition_id_re(pattern):
2245
"""Create a condition filter which performs a re check on a test's id.
2247
:param pattern: A regular expression string.
2248
:return: A callable that returns True if the re matches.
2250
filter_re = re.compile(pattern)
2251
def condition(test):
2253
return filter_re.search(test_id)
2257
def condition_isinstance(klass_or_klass_list):
2258
"""Create a condition filter which returns isinstance(param, klass).
2260
:return: A callable which when called with one parameter obj return the
2261
result of isinstance(obj, klass_or_klass_list).
2264
return isinstance(obj, klass_or_klass_list)
2268
def condition_id_in_list(id_list):
2269
"""Create a condition filter which verify that test's id in a list.
2271
:param id_list: A TestIdList object.
2272
:return: A callable that returns True if the test's id appears in the list.
2274
def condition(test):
2275
return id_list.includes(test.id())
2279
def exclude_tests_by_condition(suite, condition):
2280
"""Create a test suite which excludes some tests from suite.
2282
:param suite: The suite to get tests from.
2283
:param condition: A callable whose result evaluates True when called with a
2284
test case which should be excluded from the result.
2285
:return: A suite which contains the tests found in suite that fail
2289
for test in iter_suite_tests(suite):
2290
if not condition(test):
2292
return TestUtil.TestSuite(result)
2295
def filter_suite_by_condition(suite, condition):
2296
"""Create a test suite by filtering another one.
2298
:param suite: The source suite.
2299
:param condition: A callable whose result evaluates True when called with a
2300
test case which should be included in the result.
2301
:return: A suite which contains the tests found in suite that pass
2305
for test in iter_suite_tests(suite):
2308
return TestUtil.TestSuite(result)
2311
def filter_suite_by_re(suite, pattern, exclude_pattern=DEPRECATED_PARAMETER,
2312
random_order=DEPRECATED_PARAMETER):
2313
"""Create a test suite by filtering another one.
2315
:param suite: the source suite
2316
:param pattern: pattern that names must match
2317
:param exclude_pattern: A pattern that names must not match. This parameter
2318
is deprecated as of bzrlib 1.0. Please use the separate function
2319
exclude_tests_by_re instead.
2320
:param random_order: If True, tests in the new suite will be put in
2321
random order. This parameter is deprecated as of bzrlib 1.0. Please
2322
use the separate function randomize_suite instead.
2323
:returns: the newly created suite
2325
if deprecated_passed(exclude_pattern):
2326
symbol_versioning.warn(
2327
one_zero % "passing exclude_pattern to filter_suite_by_re",
2328
DeprecationWarning, stacklevel=2)
2329
if exclude_pattern is not None:
2330
suite = exclude_tests_by_re(suite, exclude_pattern)
2331
condition = condition_id_re(pattern)
2332
result_suite = filter_suite_by_condition(suite, condition)
2333
if deprecated_passed(random_order):
2334
symbol_versioning.warn(
2335
one_zero % "passing random_order to filter_suite_by_re",
2336
DeprecationWarning, stacklevel=2)
2338
result_suite = randomize_suite(result_suite)
2342
def filter_suite_by_id_list(suite, test_id_list):
2343
"""Create a test suite by filtering another one.
2345
:param suite: The source suite.
2346
:param test_id_list: A list of the test ids to keep as strings.
2347
:returns: the newly created suite
2349
condition = condition_id_in_list(test_id_list)
2350
result_suite = filter_suite_by_condition(suite, condition)
2354
def exclude_tests_by_re(suite, pattern):
2355
"""Create a test suite which excludes some tests from suite.
2357
:param suite: The suite to get tests from.
2358
:param pattern: A regular expression string. Test ids that match this
2359
pattern will be excluded from the result.
2360
:return: A TestSuite that contains all the tests from suite without the
2361
tests that matched pattern. The order of tests is the same as it was in
2364
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2367
def preserve_input(something):
2368
"""A helper for performing test suite transformation chains.
2370
:param something: Anything you want to preserve.
2376
def randomize_suite(suite):
2377
"""Return a new TestSuite with suite's tests in random order.
2379
The tests in the input suite are flattened into a single suite in order to
2380
accomplish this. Any nested TestSuites are removed to provide global
2383
tests = list(iter_suite_tests(suite))
2384
random.shuffle(tests)
2385
return TestUtil.TestSuite(tests)
2388
@deprecated_function(one_zero)
2389
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2390
random_order=False, append_rest=True):
2391
"""DEPRECATED: Create a test suite by sorting another one.
2393
This method has been decomposed into separate helper methods that should be
2395
- filter_suite_by_re
2396
- exclude_tests_by_re
2400
:param suite: the source suite
2401
:param pattern: pattern that names must match in order to go
2402
first in the new suite
2403
:param exclude_pattern: pattern that names must not match, if any
2404
:param random_order: if True, tests in the new suite will be put in
2405
random order (with all tests matching pattern
2407
:param append_rest: if False, pattern is a strict filter and not
2408
just an ordering directive
2409
:returns: the newly created suite
2411
if exclude_pattern is not None:
2412
suite = exclude_tests_by_re(suite, exclude_pattern)
2414
order_changer = randomize_suite
2416
order_changer = preserve_input
2418
suites = map(order_changer, split_suite_by_re(suite, pattern))
2419
return TestUtil.TestSuite(suites)
2421
return order_changer(filter_suite_by_re(suite, pattern))
2424
def split_suite_by_re(suite, pattern):
2425
"""Split a test suite into two by a regular expression.
2427
:param suite: The suite to split.
2428
:param pattern: A regular expression string. Test ids that match this
2429
pattern will be in the first test suite returned, and the others in the
2430
second test suite returned.
2431
:return: A tuple of two test suites, where the first contains tests from
2432
suite matching pattern, and the second contains the remainder from
2433
suite. The order within each output suite is the same as it was in
2438
filter_re = re.compile(pattern)
2439
for test in iter_suite_tests(suite):
2441
if filter_re.search(test_id):
2442
matched.append(test)
2444
did_not_match.append(test)
2445
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2448
def run_suite(suite, name='test', verbose=False, pattern=".*",
2449
stop_on_failure=False,
2450
transport=None, lsprof_timed=None, bench_history=None,
2451
matching_tests_first=None,
2454
exclude_pattern=None,
2456
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2461
runner = TextTestRunner(stream=sys.stdout,
2463
verbosity=verbosity,
2464
bench_history=bench_history,
2465
list_only=list_only,
2467
runner.stop_on_failure=stop_on_failure
2468
# Initialise the random number generator and display the seed used.
2469
# We convert the seed to a long to make it reuseable across invocations.
2470
random_order = False
2471
if random_seed is not None:
2473
if random_seed == "now":
2474
random_seed = long(time.time())
2476
# Convert the seed to a long if we can
2478
random_seed = long(random_seed)
2481
runner.stream.writeln("Randomizing test order using seed %s\n" %
2483
random.seed(random_seed)
2484
# Customise the list of tests if requested
2485
if exclude_pattern is not None:
2486
suite = exclude_tests_by_re(suite, exclude_pattern)
2488
order_changer = randomize_suite
2490
order_changer = preserve_input
2491
if pattern != '.*' or random_order:
2492
if matching_tests_first:
2493
suites = map(order_changer, split_suite_by_re(suite, pattern))
2494
suite = TestUtil.TestSuite(suites)
2496
suite = order_changer(filter_suite_by_re(suite, pattern))
2498
result = runner.run(suite)
2501
return result.wasStrictlySuccessful()
2503
return result.wasSuccessful()
2506
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2508
test_suite_factory=None,
2511
matching_tests_first=None,
2514
exclude_pattern=None,
2518
"""Run the whole test suite under the enhanced runner"""
2519
# XXX: Very ugly way to do this...
2520
# Disable warning about old formats because we don't want it to disturb
2521
# any blackbox tests.
2522
from bzrlib import repository
2523
repository._deprecation_warning_done = True
2525
global default_transport
2526
if transport is None:
2527
transport = default_transport
2528
old_transport = default_transport
2529
default_transport = transport
2531
if load_list is None:
2534
keep_only = load_test_id_list(load_list)
2535
if test_suite_factory is None:
2536
suite = test_suite(keep_only)
2538
suite = test_suite_factory()
2539
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2540
stop_on_failure=stop_on_failure,
2541
transport=transport,
2542
lsprof_timed=lsprof_timed,
2543
bench_history=bench_history,
2544
matching_tests_first=matching_tests_first,
2545
list_only=list_only,
2546
random_seed=random_seed,
2547
exclude_pattern=exclude_pattern,
2550
default_transport = old_transport
2553
def load_test_id_list(file_name):
2554
"""Load a test id list from a text file.
2556
The format is one test id by line. No special care is taken to impose
2557
strict rules, these test ids are used to filter the test suite so a test id
2558
that do not match an existing test will do no harm. This allows user to add
2559
comments, leave blank lines, etc.
2563
ftest = open(file_name, 'rt')
2565
if e.errno != errno.ENOENT:
2568
raise errors.NoSuchFile(file_name)
2570
for test_name in ftest.readlines():
2571
test_list.append(test_name.strip())
2576
def suite_matches_id_list(test_suite, id_list):
2577
"""Warns about tests not appearing or appearing more than once.
2579
:param test_suite: A TestSuite object.
2580
:param test_id_list: The list of test ids that should be found in
2583
:return: (absents, duplicates) absents is a list containing the test found
2584
in id_list but not in test_suite, duplicates is a list containing the
2585
test found multiple times in test_suite.
2587
When using a prefined test id list, it may occurs that some tests do not
2588
exist anymore or that some tests use the same id. This function warns the
2589
tester about potential problems in his workflow (test lists are volatile)
2590
or in the test suite itself (using the same id for several tests does not
2591
help to localize defects).
2593
# Build a dict counting id occurrences
2595
for test in iter_suite_tests(test_suite):
2597
tests[id] = tests.get(id, 0) + 1
2602
occurs = tests.get(id, 0)
2604
not_found.append(id)
2606
duplicates.append(id)
2608
return not_found, duplicates
2611
class TestIdList(object):
2612
"""Test id list to filter a test suite.
2614
Relying on the assumption that test ids are built as:
2615
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2616
notation, this class offers methods to :
2617
- avoid building a test suite for modules not refered to in the test list,
2618
- keep only the tests listed from the module test suite.
2621
def __init__(self, test_id_list):
2622
# When a test suite needs to be filtered against us we compare test ids
2623
# for equality, so a simple dict offers a quick and simple solution.
2624
self.tests = dict().fromkeys(test_id_list, True)
2626
# While unittest.TestCase have ids like:
2627
# <module>.<class>.<method>[(<param+)],
2628
# doctest.DocTestCase can have ids like:
2631
# <module>.<function>
2632
# <module>.<class>.<method>
2634
# Since we can't predict a test class from its name only, we settle on
2635
# a simple constraint: a test id always begins with its module name.
2638
for test_id in test_id_list:
2639
parts = test_id.split('.')
2640
mod_name = parts.pop(0)
2641
modules[mod_name] = True
2643
mod_name += '.' + part
2644
modules[mod_name] = True
2645
self.modules = modules
2647
def refers_to(self, module_name):
2648
"""Is there tests for the module or one of its sub modules."""
2649
return self.modules.has_key(module_name)
2651
def includes(self, test_id):
2652
return self.tests.has_key(test_id)
2655
def test_suite(keep_only=None):
2656
"""Build and return TestSuite for the whole of bzrlib.
2658
:param keep_only: A list of test ids limiting the suite returned.
2660
This function can be replaced if you need to change the default test
2661
suite on a global basis, but it is not encouraged.
2664
'bzrlib.util.tests.test_bencode',
2665
'bzrlib.tests.test__dirstate_helpers',
2666
'bzrlib.tests.test_ancestry',
2667
'bzrlib.tests.test_annotate',
2668
'bzrlib.tests.test_api',
2669
'bzrlib.tests.test_atomicfile',
2670
'bzrlib.tests.test_bad_files',
2671
'bzrlib.tests.test_bisect_multi',
2672
'bzrlib.tests.test_branch',
2673
'bzrlib.tests.test_branchbuilder',
2674
'bzrlib.tests.test_bugtracker',
2675
'bzrlib.tests.test_bundle',
2676
'bzrlib.tests.test_bzrdir',
2677
'bzrlib.tests.test_cache_utf8',
2678
'bzrlib.tests.test_commands',
2679
'bzrlib.tests.test_commit',
2680
'bzrlib.tests.test_commit_merge',
2681
'bzrlib.tests.test_config',
2682
'bzrlib.tests.test_conflicts',
2683
'bzrlib.tests.test_counted_lock',
2684
'bzrlib.tests.test_decorators',
2685
'bzrlib.tests.test_delta',
2686
'bzrlib.tests.test_deprecated_graph',
2687
'bzrlib.tests.test_diff',
2688
'bzrlib.tests.test_dirstate',
2689
'bzrlib.tests.test_directory_service',
2690
'bzrlib.tests.test_email_message',
2691
'bzrlib.tests.test_errors',
2692
'bzrlib.tests.test_escaped_store',
2693
'bzrlib.tests.test_extract',
2694
'bzrlib.tests.test_fetch',
2695
'bzrlib.tests.test_ftp_transport',
2696
'bzrlib.tests.test_generate_docs',
2697
'bzrlib.tests.test_generate_ids',
2698
'bzrlib.tests.test_globbing',
2699
'bzrlib.tests.test_gpg',
2700
'bzrlib.tests.test_graph',
2701
'bzrlib.tests.test_hashcache',
2702
'bzrlib.tests.test_help',
2703
'bzrlib.tests.test_hooks',
2704
'bzrlib.tests.test_http',
2705
'bzrlib.tests.test_http_implementations',
2706
'bzrlib.tests.test_http_response',
2707
'bzrlib.tests.test_https_ca_bundle',
2708
'bzrlib.tests.test_identitymap',
2709
'bzrlib.tests.test_ignores',
2710
'bzrlib.tests.test_index',
2711
'bzrlib.tests.test_info',
2712
'bzrlib.tests.test_inv',
2713
'bzrlib.tests.test_knit',
2714
'bzrlib.tests.test_lazy_import',
2715
'bzrlib.tests.test_lazy_regex',
2716
'bzrlib.tests.test_lockdir',
2717
'bzrlib.tests.test_lockable_files',
2718
'bzrlib.tests.test_log',
2719
'bzrlib.tests.test_lsprof',
2720
'bzrlib.tests.test_lru_cache',
2721
'bzrlib.tests.test_mail_client',
2722
'bzrlib.tests.test_memorytree',
2723
'bzrlib.tests.test_merge',
2724
'bzrlib.tests.test_merge3',
2725
'bzrlib.tests.test_merge_core',
2726
'bzrlib.tests.test_merge_directive',
2727
'bzrlib.tests.test_missing',
2728
'bzrlib.tests.test_msgeditor',
2729
'bzrlib.tests.test_multiparent',
2730
'bzrlib.tests.test_mutabletree',
2731
'bzrlib.tests.test_nonascii',
2732
'bzrlib.tests.test_options',
2733
'bzrlib.tests.test_osutils',
2734
'bzrlib.tests.test_osutils_encodings',
2735
'bzrlib.tests.test_pack',
2736
'bzrlib.tests.test_patch',
2737
'bzrlib.tests.test_patches',
2738
'bzrlib.tests.test_permissions',
2739
'bzrlib.tests.test_plugins',
2740
'bzrlib.tests.test_progress',
2741
'bzrlib.tests.test_reconfigure',
2742
'bzrlib.tests.test_reconcile',
2743
'bzrlib.tests.test_registry',
2744
'bzrlib.tests.test_remote',
2745
'bzrlib.tests.test_repository',
2746
'bzrlib.tests.test_revert',
2747
'bzrlib.tests.test_revision',
2748
'bzrlib.tests.test_revisionspec',
2749
'bzrlib.tests.test_revisiontree',
2750
'bzrlib.tests.test_rio',
2751
'bzrlib.tests.test_sampler',
2752
'bzrlib.tests.test_selftest',
2753
'bzrlib.tests.test_setup',
2754
'bzrlib.tests.test_sftp_transport',
2755
'bzrlib.tests.test_smart',
2756
'bzrlib.tests.test_smart_add',
2757
'bzrlib.tests.test_smart_transport',
2758
'bzrlib.tests.test_smtp_connection',
2759
'bzrlib.tests.test_source',
2760
'bzrlib.tests.test_ssh_transport',
2761
'bzrlib.tests.test_status',
2762
'bzrlib.tests.test_store',
2763
'bzrlib.tests.test_strace',
2764
'bzrlib.tests.test_subsume',
2765
'bzrlib.tests.test_switch',
2766
'bzrlib.tests.test_symbol_versioning',
2767
'bzrlib.tests.test_tag',
2768
'bzrlib.tests.test_testament',
2769
'bzrlib.tests.test_textfile',
2770
'bzrlib.tests.test_textmerge',
2771
'bzrlib.tests.test_timestamp',
2772
'bzrlib.tests.test_trace',
2773
'bzrlib.tests.test_transactions',
2774
'bzrlib.tests.test_transform',
2775
'bzrlib.tests.test_transport',
2776
'bzrlib.tests.test_tree',
2777
'bzrlib.tests.test_treebuilder',
2778
'bzrlib.tests.test_tsort',
2779
'bzrlib.tests.test_tuned_gzip',
2780
'bzrlib.tests.test_ui',
2781
'bzrlib.tests.test_uncommit',
2782
'bzrlib.tests.test_upgrade',
2783
'bzrlib.tests.test_urlutils',
2784
'bzrlib.tests.test_versionedfile',
2785
'bzrlib.tests.test_version',
2786
'bzrlib.tests.test_version_info',
2787
'bzrlib.tests.test_weave',
2788
'bzrlib.tests.test_whitebox',
2789
'bzrlib.tests.test_win32utils',
2790
'bzrlib.tests.test_workingtree',
2791
'bzrlib.tests.test_workingtree_4',
2792
'bzrlib.tests.test_wsgi',
2793
'bzrlib.tests.test_xml',
2795
test_transport_implementations = [
2796
'bzrlib.tests.test_transport_implementations',
2797
'bzrlib.tests.test_read_bundle',
2799
loader = TestUtil.TestLoader()
2801
if keep_only is None:
2802
loader = TestUtil.TestLoader()
2804
id_filter = TestIdList(keep_only)
2805
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2806
suite = loader.suiteClass()
2808
# modules building their suite with loadTestsFromModuleNames
2809
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2811
# modules adapted for transport implementations
2812
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2813
adapter = TransportTestProviderAdapter()
2814
adapt_modules(test_transport_implementations, adapter, loader, suite)
2816
# modules defining their own test_suite()
2817
for package in [p for p in packages_to_test()
2818
if (keep_only is None
2819
or id_filter.refers_to(p.__name__))]:
2820
pack_suite = package.test_suite()
2821
suite.addTest(pack_suite)
2823
modules_to_doctest = [
2828
'bzrlib.iterablefile',
2835
'bzrlib.version_info_formats.format_custom',
2838
for mod in modules_to_doctest:
2839
if not (keep_only is None or id_filter.refers_to(mod)):
2840
# No tests to keep here, move along
2843
doc_suite = doctest.DocTestSuite(mod)
2844
except ValueError, e:
2845
print '**failed to get doctest for: %s\n%s' % (mod, e)
2847
suite.addTest(doc_suite)
2849
default_encoding = sys.getdefaultencoding()
2850
for name, plugin in bzrlib.plugin.plugins().items():
2851
if keep_only is not None:
2852
if not id_filter.refers_to(plugin.module.__name__):
2854
plugin_suite = plugin.test_suite()
2855
# We used to catch ImportError here and turn it into just a warning,
2856
# but really if you don't have --no-plugins this should be a failure.
2857
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
2858
if plugin_suite is None:
2859
plugin_suite = plugin.load_plugin_tests(loader)
2860
if plugin_suite is not None:
2861
suite.addTest(plugin_suite)
2862
if default_encoding != sys.getdefaultencoding():
2863
bzrlib.trace.warning(
2864
'Plugin "%s" tried to reset default encoding to: %s', name,
2865
sys.getdefaultencoding())
2867
sys.setdefaultencoding(default_encoding)
2869
if keep_only is not None:
2870
# Now that the referred modules have loaded their tests, keep only the
2872
suite = filter_suite_by_id_list(suite, id_filter)
2873
# Do some sanity checks on the id_list filtering
2874
not_found, duplicates = suite_matches_id_list(suite, keep_only)
2875
for id in not_found:
2876
bzrlib.trace.warning('"%s" not found in the test suite', id)
2877
for id in duplicates:
2878
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
2883
def multiply_tests_from_modules(module_name_list, scenario_iter, loader=None):
2884
"""Adapt all tests in some given modules to given scenarios.
2886
This is the recommended public interface for test parameterization.
2887
Typically the test_suite() method for a per-implementation test
2888
suite will call multiply_tests_from_modules and return the
2891
:param module_name_list: List of fully-qualified names of test
2893
:param scenario_iter: Iterable of pairs of (scenario_name,
2894
scenario_param_dict).
2895
:param loader: If provided, will be used instead of a new
2896
bzrlib.tests.TestLoader() instance.
2898
This returns a new TestSuite containing the cross product of
2899
all the tests in all the modules, each repeated for each scenario.
2900
Each test is adapted by adding the scenario name at the end
2901
of its name, and updating the test object's __dict__ with the
2902
scenario_param_dict.
2904
>>> r = multiply_tests_from_modules(
2905
... ['bzrlib.tests.test_sampler'],
2906
... [('one', dict(param=1)),
2907
... ('two', dict(param=2))])
2908
>>> tests = list(iter_suite_tests(r))
2912
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2918
# XXX: Isn't load_tests() a better way to provide the same functionality
2919
# without forcing a predefined TestScenarioApplier ? --vila 080215
2921
loader = TestUtil.TestLoader()
2923
suite = loader.suiteClass()
2925
adapter = TestScenarioApplier()
2926
adapter.scenarios = list(scenario_iter)
2927
adapt_modules(module_name_list, adapter, loader, suite)
2931
def multiply_scenarios(scenarios_left, scenarios_right):
2932
"""Multiply two sets of scenarios.
2934
:returns: the cartesian product of the two sets of scenarios, that is
2935
a scenario for every possible combination of a left scenario and a
2939
('%s,%s' % (left_name, right_name),
2940
dict(left_dict.items() + right_dict.items()))
2941
for left_name, left_dict in scenarios_left
2942
for right_name, right_dict in scenarios_right]
2946
def adapt_modules(mods_list, adapter, loader, suite):
2947
"""Adapt the modules in mods_list using adapter and add to suite."""
2948
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2949
suite.addTests(adapter.adapt(test))
2952
def adapt_tests(tests_list, adapter, loader, suite):
2953
"""Adapt the tests in tests_list using adapter and add to suite."""
2954
for test in tests_list:
2955
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2958
def _rmtree_temp_dir(dirname):
2959
# If LANG=C we probably have created some bogus paths
2960
# which rmtree(unicode) will fail to delete
2961
# so make sure we are using rmtree(str) to delete everything
2962
# except on win32, where rmtree(str) will fail
2963
# since it doesn't have the property of byte-stream paths
2964
# (they are either ascii or mbcs)
2965
if sys.platform == 'win32':
2966
# make sure we are using the unicode win32 api
2967
dirname = unicode(dirname)
2969
dirname = dirname.encode(sys.getfilesystemencoding())
2971
osutils.rmtree(dirname)
2973
if sys.platform == 'win32' and e.errno == errno.EACCES:
2974
sys.stderr.write(('Permission denied: '
2975
'unable to remove testing dir '
2976
'%s\n' % os.path.basename(dirname)))
2981
class Feature(object):
2982
"""An operating system Feature."""
2985
self._available = None
2987
def available(self):
2988
"""Is the feature available?
2990
:return: True if the feature is available.
2992
if self._available is None:
2993
self._available = self._probe()
2994
return self._available
2997
"""Implement this method in concrete features.
2999
:return: True if the feature is available.
3001
raise NotImplementedError
3004
if getattr(self, 'feature_name', None):
3005
return self.feature_name()
3006
return self.__class__.__name__
3009
class _SymlinkFeature(Feature):
3012
return osutils.has_symlinks()
3014
def feature_name(self):
3017
SymlinkFeature = _SymlinkFeature()
3020
class _HardlinkFeature(Feature):
3023
return osutils.has_hardlinks()
3025
def feature_name(self):
3028
HardlinkFeature = _HardlinkFeature()
3031
class _OsFifoFeature(Feature):
3034
return getattr(os, 'mkfifo', None)
3036
def feature_name(self):
3037
return 'filesystem fifos'
3039
OsFifoFeature = _OsFifoFeature()
3042
class TestScenarioApplier(object):
3043
"""A tool to apply scenarios to tests."""
3045
def adapt(self, test):
3046
"""Return a TestSuite containing a copy of test for each scenario."""
3047
result = unittest.TestSuite()
3048
for scenario in self.scenarios:
3049
result.addTest(self.adapt_test_to_scenario(test, scenario))
3052
def adapt_test_to_scenario(self, test, scenario):
3053
"""Copy test and apply scenario to it.
3055
:param test: A test to adapt.
3056
:param scenario: A tuple describing the scenarion.
3057
The first element of the tuple is the new test id.
3058
The second element is a dict containing attributes to set on the
3060
:return: The adapted test.
3062
from copy import deepcopy
3063
new_test = deepcopy(test)
3064
for name, value in scenario[1].items():
3065
setattr(new_test, name, value)
3066
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3067
new_test.id = lambda: new_id
3071
def probe_unicode_in_user_encoding():
3072
"""Try to encode several unicode strings to use in unicode-aware tests.
3073
Return first successfull match.
3075
:return: (unicode value, encoded plain string value) or (None, None)
3077
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3078
for uni_val in possible_vals:
3080
str_val = uni_val.encode(bzrlib.user_encoding)
3081
except UnicodeEncodeError:
3082
# Try a different character
3085
return uni_val, str_val
3089
def probe_bad_non_ascii(encoding):
3090
"""Try to find [bad] character with code [128..255]
3091
that cannot be decoded to unicode in some encoding.
3092
Return None if all non-ascii characters is valid
3095
for i in xrange(128, 256):
3098
char.decode(encoding)
3099
except UnicodeDecodeError:
3104
class _FTPServerFeature(Feature):
3105
"""Some tests want an FTP Server, check if one is available.
3107
Right now, the only way this is available is if 'medusa' is installed.
3108
http://www.amk.ca/python/code/medusa.html
3113
import bzrlib.tests.ftp_server
3118
def feature_name(self):
3121
FTPServerFeature = _FTPServerFeature()
3124
class _CaseInsensitiveFilesystemFeature(Feature):
3125
"""Check if underlined filesystem is case-insensitive
3126
(e.g. on Windows, Cygwin, MacOS)
3130
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3131
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3132
TestCaseWithMemoryTransport.TEST_ROOT = root
3134
root = TestCaseWithMemoryTransport.TEST_ROOT
3135
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3137
name_a = osutils.pathjoin(tdir, 'a')
3138
name_A = osutils.pathjoin(tdir, 'A')
3140
result = osutils.isdir(name_A)
3141
_rmtree_temp_dir(tdir)
3144
def feature_name(self):
3145
return 'case-insensitive filesystem'
3147
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
