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
MODULES_TO_DOCTEST = [
124
bzrlib.version_info_formats.format_custom,
125
# quoted to avoid module-loading circularity
130
def packages_to_test():
131
"""Return a list of packages to test.
133
The packages are not globally imported so that import failures are
134
triggered when running selftest, not when importing the command.
137
import bzrlib.tests.blackbox
138
import bzrlib.tests.branch_implementations
139
import bzrlib.tests.bzrdir_implementations
140
import bzrlib.tests.commands
141
import bzrlib.tests.interrepository_implementations
142
import bzrlib.tests.interversionedfile_implementations
143
import bzrlib.tests.intertree_implementations
144
import bzrlib.tests.inventory_implementations
145
import bzrlib.tests.per_lock
146
import bzrlib.tests.repository_implementations
147
import bzrlib.tests.revisionstore_implementations
148
import bzrlib.tests.tree_implementations
149
import bzrlib.tests.workingtree_implementations
152
bzrlib.tests.blackbox,
153
bzrlib.tests.branch_implementations,
154
bzrlib.tests.bzrdir_implementations,
155
bzrlib.tests.commands,
156
bzrlib.tests.interrepository_implementations,
157
bzrlib.tests.interversionedfile_implementations,
158
bzrlib.tests.intertree_implementations,
159
bzrlib.tests.inventory_implementations,
160
bzrlib.tests.per_lock,
161
bzrlib.tests.repository_implementations,
162
bzrlib.tests.revisionstore_implementations,
163
bzrlib.tests.tree_implementations,
164
bzrlib.tests.workingtree_implementations,
168
class ExtendedTestResult(unittest._TextTestResult):
169
"""Accepts, reports and accumulates the results of running tests.
171
Compared to the unittest version this class adds support for
172
profiling, benchmarking, stopping as soon as a test fails, and
173
skipping tests. There are further-specialized subclasses for
174
different types of display.
176
When a test finishes, in whatever way, it calls one of the addSuccess,
177
addFailure or addError classes. These in turn may redirect to a more
178
specific case for the special test results supported by our extended
181
Note that just one of these objects is fed the results from many tests.
186
def __init__(self, stream, descriptions, verbosity,
190
"""Construct new TestResult.
192
:param bench_history: Optionally, a writable file object to accumulate
195
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
196
if bench_history is not None:
197
from bzrlib.version import _get_bzr_source_tree
198
src_tree = _get_bzr_source_tree()
201
revision_id = src_tree.get_parent_ids()[0]
203
# XXX: if this is a brand new tree, do the same as if there
207
# XXX: If there's no branch, what should we do?
209
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
210
self._bench_history = bench_history
211
self.ui = ui.ui_factory
212
self.num_tests = num_tests
214
self.failure_count = 0
215
self.known_failure_count = 0
217
self.not_applicable_count = 0
218
self.unsupported = {}
220
self._overall_start_time = time.time()
222
def _extractBenchmarkTime(self, testCase):
223
"""Add a benchmark time for the current test case."""
224
return getattr(testCase, "_benchtime", None)
226
def _elapsedTestTimeString(self):
227
"""Return a time string for the overall time the current test has taken."""
228
return self._formatTime(time.time() - self._start_time)
230
def _testTimeString(self, testCase):
231
benchmark_time = self._extractBenchmarkTime(testCase)
232
if benchmark_time is not None:
234
self._formatTime(benchmark_time),
235
self._elapsedTestTimeString())
237
return " %s" % self._elapsedTestTimeString()
239
def _formatTime(self, seconds):
240
"""Format seconds as milliseconds with leading spaces."""
241
# some benchmarks can take thousands of seconds to run, so we need 8
243
return "%8dms" % (1000 * seconds)
245
def _shortened_test_description(self, test):
247
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
250
def startTest(self, test):
251
unittest.TestResult.startTest(self, test)
252
self.report_test_start(test)
253
test.number = self.count
254
self._recordTestStartTime()
256
def _recordTestStartTime(self):
257
"""Record that a test has started."""
258
self._start_time = time.time()
260
def _cleanupLogFile(self, test):
261
# We can only do this if we have one of our TestCases, not if
263
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
264
if setKeepLogfile is not None:
267
def addError(self, test, err):
268
"""Tell result that test finished with an error.
270
Called from the TestCase run() method when the test
271
fails with an unexpected error.
273
self._testConcluded(test)
274
if isinstance(err[1], TestSkipped):
275
return self._addSkipped(test, err)
276
elif isinstance(err[1], UnavailableFeature):
277
return self.addNotSupported(test, err[1].args[0])
279
self._cleanupLogFile(test)
280
unittest.TestResult.addError(self, test, err)
281
self.error_count += 1
282
self.report_error(test, err)
286
def addFailure(self, test, err):
287
"""Tell result that test failed.
289
Called from the TestCase run() method when the test
290
fails because e.g. an assert() method failed.
292
self._testConcluded(test)
293
if isinstance(err[1], KnownFailure):
294
return self._addKnownFailure(test, err)
296
self._cleanupLogFile(test)
297
unittest.TestResult.addFailure(self, test, err)
298
self.failure_count += 1
299
self.report_failure(test, err)
303
def addSuccess(self, test):
304
"""Tell result that test completed successfully.
306
Called from the TestCase run()
308
self._testConcluded(test)
309
if self._bench_history is not None:
310
benchmark_time = self._extractBenchmarkTime(test)
311
if benchmark_time is not None:
312
self._bench_history.write("%s %s\n" % (
313
self._formatTime(benchmark_time),
315
self.report_success(test)
316
self._cleanupLogFile(test)
317
unittest.TestResult.addSuccess(self, test)
319
def _testConcluded(self, test):
320
"""Common code when a test has finished.
322
Called regardless of whether it succeded, failed, etc.
326
def _addKnownFailure(self, test, err):
327
self.known_failure_count += 1
328
self.report_known_failure(test, err)
330
def addNotSupported(self, test, feature):
331
"""The test will not be run because of a missing feature.
333
# this can be called in two different ways: it may be that the
334
# test started running, and then raised (through addError)
335
# UnavailableFeature. Alternatively this method can be called
336
# while probing for features before running the tests; in that
337
# case we will see startTest and stopTest, but the test will never
339
self.unsupported.setdefault(str(feature), 0)
340
self.unsupported[str(feature)] += 1
341
self.report_unsupported(test, feature)
343
def _addSkipped(self, test, skip_excinfo):
344
if isinstance(skip_excinfo[1], TestNotApplicable):
345
self.not_applicable_count += 1
346
self.report_not_applicable(test, skip_excinfo)
349
self.report_skip(test, skip_excinfo)
352
except KeyboardInterrupt:
355
self.addError(test, test._exc_info())
357
# seems best to treat this as success from point-of-view of unittest
358
# -- it actually does nothing so it barely matters :)
359
unittest.TestResult.addSuccess(self, test)
361
def printErrorList(self, flavour, errors):
362
for test, err in errors:
363
self.stream.writeln(self.separator1)
364
self.stream.write("%s: " % flavour)
365
self.stream.writeln(self.getDescription(test))
366
if getattr(test, '_get_log', None) is not None:
367
self.stream.write('\n')
369
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
370
self.stream.write('\n')
371
self.stream.write(test._get_log())
372
self.stream.write('\n')
374
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
375
self.stream.write('\n')
376
self.stream.writeln(self.separator2)
377
self.stream.writeln("%s" % err)
382
def report_cleaning_up(self):
385
def report_success(self, test):
388
def wasStrictlySuccessful(self):
389
if self.unsupported or self.known_failure_count:
391
return self.wasSuccessful()
394
class TextTestResult(ExtendedTestResult):
395
"""Displays progress and results of tests in text form"""
397
def __init__(self, stream, descriptions, verbosity,
402
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
403
bench_history, num_tests)
405
self.pb = self.ui.nested_progress_bar()
406
self._supplied_pb = False
409
self._supplied_pb = True
410
self.pb.show_pct = False
411
self.pb.show_spinner = False
412
self.pb.show_eta = False,
413
self.pb.show_count = False
414
self.pb.show_bar = False
416
def report_starting(self):
417
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
419
def _progress_prefix_text(self):
420
a = '[%d' % self.count
421
if self.num_tests is not None:
422
a +='/%d' % self.num_tests
423
a += ' in %ds' % (time.time() - self._overall_start_time)
425
a += ', %d errors' % self.error_count
426
if self.failure_count:
427
a += ', %d failed' % self.failure_count
428
if self.known_failure_count:
429
a += ', %d known failures' % self.known_failure_count
431
a += ', %d skipped' % self.skip_count
433
a += ', %d missing features' % len(self.unsupported)
437
def report_test_start(self, test):
440
self._progress_prefix_text()
442
+ self._shortened_test_description(test))
444
def _test_description(self, test):
445
return self._shortened_test_description(test)
447
def report_error(self, test, err):
448
self.pb.note('ERROR: %s\n %s\n',
449
self._test_description(test),
453
def report_failure(self, test, err):
454
self.pb.note('FAIL: %s\n %s\n',
455
self._test_description(test),
459
def report_known_failure(self, test, err):
460
self.pb.note('XFAIL: %s\n%s\n',
461
self._test_description(test), err[1])
463
def report_skip(self, test, skip_excinfo):
466
def report_not_applicable(self, test, skip_excinfo):
469
def report_unsupported(self, test, feature):
470
"""test cannot be run because feature is missing."""
472
def report_cleaning_up(self):
473
self.pb.update('cleaning up...')
476
if not self._supplied_pb:
480
class VerboseTestResult(ExtendedTestResult):
481
"""Produce long output, with one line per test run plus times"""
483
def _ellipsize_to_right(self, a_string, final_width):
484
"""Truncate and pad a string, keeping the right hand side"""
485
if len(a_string) > final_width:
486
result = '...' + a_string[3-final_width:]
489
return result.ljust(final_width)
491
def report_starting(self):
492
self.stream.write('running %d tests...\n' % self.num_tests)
494
def report_test_start(self, test):
496
name = self._shortened_test_description(test)
497
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
498
# numbers, plus a trailing blank
499
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
500
self.stream.write(self._ellipsize_to_right(name,
501
osutils.terminal_width()-30))
504
def _error_summary(self, err):
506
return '%s%s' % (indent, err[1])
508
def report_error(self, test, err):
509
self.stream.writeln('ERROR %s\n%s'
510
% (self._testTimeString(test),
511
self._error_summary(err)))
513
def report_failure(self, test, err):
514
self.stream.writeln(' FAIL %s\n%s'
515
% (self._testTimeString(test),
516
self._error_summary(err)))
518
def report_known_failure(self, test, err):
519
self.stream.writeln('XFAIL %s\n%s'
520
% (self._testTimeString(test),
521
self._error_summary(err)))
523
def report_success(self, test):
524
self.stream.writeln(' OK %s' % self._testTimeString(test))
525
for bench_called, stats in getattr(test, '_benchcalls', []):
526
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
527
stats.pprint(file=self.stream)
528
# flush the stream so that we get smooth output. This verbose mode is
529
# used to show the output in PQM.
532
def report_skip(self, test, skip_excinfo):
533
self.stream.writeln(' SKIP %s\n%s'
534
% (self._testTimeString(test),
535
self._error_summary(skip_excinfo)))
537
def report_not_applicable(self, test, skip_excinfo):
538
self.stream.writeln(' N/A %s\n%s'
539
% (self._testTimeString(test),
540
self._error_summary(skip_excinfo)))
542
def report_unsupported(self, test, feature):
543
"""test cannot be run because feature is missing."""
544
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
545
%(self._testTimeString(test), feature))
548
class TextTestRunner(object):
549
stop_on_failure = False
558
self.stream = unittest._WritelnDecorator(stream)
559
self.descriptions = descriptions
560
self.verbosity = verbosity
561
self._bench_history = bench_history
562
self.list_only = list_only
565
"Run the given test case or test suite."
566
startTime = time.time()
567
if self.verbosity == 1:
568
result_class = TextTestResult
569
elif self.verbosity >= 2:
570
result_class = VerboseTestResult
571
result = result_class(self.stream,
574
bench_history=self._bench_history,
575
num_tests=test.countTestCases(),
577
result.stop_early = self.stop_on_failure
578
result.report_starting()
580
if self.verbosity >= 2:
581
self.stream.writeln("Listing tests only ...\n")
583
for t in iter_suite_tests(test):
584
self.stream.writeln("%s" % (t.id()))
586
actionTaken = "Listed"
589
run = result.testsRun
591
stopTime = time.time()
592
timeTaken = stopTime - startTime
594
self.stream.writeln(result.separator2)
595
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
596
run, run != 1 and "s" or "", timeTaken))
597
self.stream.writeln()
598
if not result.wasSuccessful():
599
self.stream.write("FAILED (")
600
failed, errored = map(len, (result.failures, result.errors))
602
self.stream.write("failures=%d" % failed)
604
if failed: self.stream.write(", ")
605
self.stream.write("errors=%d" % errored)
606
if result.known_failure_count:
607
if failed or errored: self.stream.write(", ")
608
self.stream.write("known_failure_count=%d" %
609
result.known_failure_count)
610
self.stream.writeln(")")
612
if result.known_failure_count:
613
self.stream.writeln("OK (known_failures=%d)" %
614
result.known_failure_count)
616
self.stream.writeln("OK")
617
if result.skip_count > 0:
618
skipped = result.skip_count
619
self.stream.writeln('%d test%s skipped' %
620
(skipped, skipped != 1 and "s" or ""))
621
if result.unsupported:
622
for feature, count in sorted(result.unsupported.items()):
623
self.stream.writeln("Missing feature '%s' skipped %d tests." %
629
def iter_suite_tests(suite):
630
"""Return all tests in a suite, recursing through nested suites"""
631
for item in suite._tests:
632
if isinstance(item, unittest.TestCase):
634
elif isinstance(item, unittest.TestSuite):
635
for r in iter_suite_tests(item):
638
raise Exception('unknown object %r inside test suite %r'
642
class TestSkipped(Exception):
643
"""Indicates that a test was intentionally skipped, rather than failing."""
646
class TestNotApplicable(TestSkipped):
647
"""A test is not applicable to the situation where it was run.
649
This is only normally raised by parameterized tests, if they find that
650
the instance they're constructed upon does not support one aspect
655
class KnownFailure(AssertionError):
656
"""Indicates that a test failed in a precisely expected manner.
658
Such failures dont block the whole test suite from passing because they are
659
indicators of partially completed code or of future work. We have an
660
explicit error for them so that we can ensure that they are always visible:
661
KnownFailures are always shown in the output of bzr selftest.
665
class UnavailableFeature(Exception):
666
"""A feature required for this test was not available.
668
The feature should be used to construct the exception.
672
class CommandFailed(Exception):
676
class StringIOWrapper(object):
677
"""A wrapper around cStringIO which just adds an encoding attribute.
679
Internally we can check sys.stdout to see what the output encoding
680
should be. However, cStringIO has no encoding attribute that we can
681
set. So we wrap it instead.
686
def __init__(self, s=None):
688
self.__dict__['_cstring'] = StringIO(s)
690
self.__dict__['_cstring'] = StringIO()
692
def __getattr__(self, name, getattr=getattr):
693
return getattr(self.__dict__['_cstring'], name)
695
def __setattr__(self, name, val):
696
if name == 'encoding':
697
self.__dict__['encoding'] = val
699
return setattr(self._cstring, name, val)
702
class TestUIFactory(ui.CLIUIFactory):
703
"""A UI Factory for testing.
705
Hide the progress bar but emit note()s.
707
Allows get_password to be tested without real tty attached.
714
super(TestUIFactory, self).__init__()
715
if stdin is not None:
716
# We use a StringIOWrapper to be able to test various
717
# encodings, but the user is still responsible to
718
# encode the string and to set the encoding attribute
719
# of StringIOWrapper.
720
self.stdin = StringIOWrapper(stdin)
722
self.stdout = sys.stdout
726
self.stderr = sys.stderr
731
"""See progress.ProgressBar.clear()."""
733
def clear_term(self):
734
"""See progress.ProgressBar.clear_term()."""
736
def clear_term(self):
737
"""See progress.ProgressBar.clear_term()."""
740
"""See progress.ProgressBar.finished()."""
742
def note(self, fmt_string, *args, **kwargs):
743
"""See progress.ProgressBar.note()."""
744
self.stdout.write((fmt_string + "\n") % args)
746
def progress_bar(self):
749
def nested_progress_bar(self):
752
def update(self, message, count=None, total=None):
753
"""See progress.ProgressBar.update()."""
755
def get_non_echoed_password(self, prompt):
756
"""Get password from stdin without trying to handle the echo mode"""
758
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
759
password = self.stdin.readline()
762
if password[-1] == '\n':
763
password = password[:-1]
767
class TestCase(unittest.TestCase):
768
"""Base class for bzr unit tests.
770
Tests that need access to disk resources should subclass
771
TestCaseInTempDir not TestCase.
773
Error and debug log messages are redirected from their usual
774
location into a temporary file, the contents of which can be
775
retrieved by _get_log(). We use a real OS file, not an in-memory object,
776
so that it can also capture file IO. When the test completes this file
777
is read into memory and removed from disk.
779
There are also convenience functions to invoke bzr's command-line
780
routine, and to build and check bzr trees.
782
In addition to the usual method of overriding tearDown(), this class also
783
allows subclasses to register functions into the _cleanups list, which is
784
run in order as the object is torn down. It's less likely this will be
785
accidentally overlooked.
788
_log_file_name = None
790
_keep_log_file = False
791
# record lsprof data when performing benchmark calls.
792
_gather_lsprof_in_benchmarks = False
794
def __init__(self, methodName='testMethod'):
795
super(TestCase, self).__init__(methodName)
799
unittest.TestCase.setUp(self)
800
self._cleanEnvironment()
803
self._benchcalls = []
804
self._benchtime = None
806
self._clear_debug_flags()
808
def _clear_debug_flags(self):
809
"""Prevent externally set debug flags affecting tests.
811
Tests that want to use debug flags can just set them in the
812
debug_flags set during setup/teardown.
814
if 'selftest_debug' not in debug.debug_flags:
815
self._preserved_debug_flags = set(debug.debug_flags)
816
debug.debug_flags.clear()
817
self.addCleanup(self._restore_debug_flags)
819
def _clear_hooks(self):
820
# prevent hooks affecting tests
822
import bzrlib.smart.server
823
self._preserved_hooks = {
824
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
825
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
827
self.addCleanup(self._restoreHooks)
828
# reset all hooks to an empty instance of the appropriate type
829
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
830
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
832
def _silenceUI(self):
833
"""Turn off UI for duration of test"""
834
# by default the UI is off; tests can turn it on if they want it.
835
saved = ui.ui_factory
837
ui.ui_factory = saved
838
ui.ui_factory = ui.SilentUIFactory()
839
self.addCleanup(_restore)
841
def _ndiff_strings(self, a, b):
842
"""Return ndiff between two strings containing lines.
844
A trailing newline is added if missing to make the strings
846
if b and b[-1] != '\n':
848
if a and a[-1] != '\n':
850
difflines = difflib.ndiff(a.splitlines(True),
852
linejunk=lambda x: False,
853
charjunk=lambda x: False)
854
return ''.join(difflines)
856
def assertEqual(self, a, b, message=''):
860
except UnicodeError, e:
861
# If we can't compare without getting a UnicodeError, then
862
# obviously they are different
863
mutter('UnicodeError: %s', e)
866
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
868
pformat(a), pformat(b)))
870
assertEquals = assertEqual
872
def assertEqualDiff(self, a, b, message=None):
873
"""Assert two texts are equal, if not raise an exception.
875
This is intended for use with multi-line strings where it can
876
be hard to find the differences by eye.
878
# TODO: perhaps override assertEquals to call this for strings?
882
message = "texts not equal:\n"
883
raise AssertionError(message +
884
self._ndiff_strings(a, b))
886
def assertEqualMode(self, mode, mode_test):
887
self.assertEqual(mode, mode_test,
888
'mode mismatch %o != %o' % (mode, mode_test))
890
def assertPositive(self, val):
891
"""Assert that val is greater than 0."""
892
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
894
def assertNegative(self, val):
895
"""Assert that val is less than 0."""
896
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
898
def assertStartsWith(self, s, prefix):
899
if not s.startswith(prefix):
900
raise AssertionError('string %r does not start with %r' % (s, prefix))
902
def assertEndsWith(self, s, suffix):
903
"""Asserts that s ends with suffix."""
904
if not s.endswith(suffix):
905
raise AssertionError('string %r does not end with %r' % (s, suffix))
907
def assertContainsRe(self, haystack, needle_re):
908
"""Assert that a contains something matching a regular expression."""
909
if not re.search(needle_re, haystack):
910
if '\n' in haystack or len(haystack) > 60:
911
# a long string, format it in a more readable way
912
raise AssertionError(
913
'pattern "%s" not found in\n"""\\\n%s"""\n'
914
% (needle_re, haystack))
916
raise AssertionError('pattern "%s" not found in "%s"'
917
% (needle_re, haystack))
919
def assertNotContainsRe(self, haystack, needle_re):
920
"""Assert that a does not match a regular expression"""
921
if re.search(needle_re, haystack):
922
raise AssertionError('pattern "%s" found in "%s"'
923
% (needle_re, haystack))
925
def assertSubset(self, sublist, superlist):
926
"""Assert that every entry in sublist is present in superlist."""
927
missing = set(sublist) - set(superlist)
929
raise AssertionError("value(s) %r not present in container %r" %
930
(missing, superlist))
932
def assertListRaises(self, excClass, func, *args, **kwargs):
933
"""Fail unless excClass is raised when the iterator from func is used.
935
Many functions can return generators this makes sure
936
to wrap them in a list() call to make sure the whole generator
937
is run, and that the proper exception is raised.
940
list(func(*args, **kwargs))
944
if getattr(excClass,'__name__', None) is not None:
945
excName = excClass.__name__
947
excName = str(excClass)
948
raise self.failureException, "%s not raised" % excName
950
def assertRaises(self, excClass, callableObj, *args, **kwargs):
951
"""Assert that a callable raises a particular exception.
953
:param excClass: As for the except statement, this may be either an
954
exception class, or a tuple of classes.
955
:param callableObj: A callable, will be passed ``*args`` and
958
Returns the exception so that you can examine it.
961
callableObj(*args, **kwargs)
965
if getattr(excClass,'__name__', None) is not None:
966
excName = excClass.__name__
969
excName = str(excClass)
970
raise self.failureException, "%s not raised" % excName
972
def assertIs(self, left, right, message=None):
973
if not (left is right):
974
if message is not None:
975
raise AssertionError(message)
977
raise AssertionError("%r is not %r." % (left, right))
979
def assertIsNot(self, left, right, message=None):
981
if message is not None:
982
raise AssertionError(message)
984
raise AssertionError("%r is %r." % (left, right))
986
def assertTransportMode(self, transport, path, mode):
987
"""Fail if a path does not have mode mode.
989
If modes are not supported on this transport, the assertion is ignored.
991
if not transport._can_roundtrip_unix_modebits():
993
path_stat = transport.stat(path)
994
actual_mode = stat.S_IMODE(path_stat.st_mode)
995
self.assertEqual(mode, actual_mode,
996
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
998
def assertIsSameRealPath(self, path1, path2):
999
"""Fail if path1 and path2 points to different files"""
1000
self.assertEqual(osutils.realpath(path1),
1001
osutils.realpath(path2),
1002
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1004
def assertIsInstance(self, obj, kls):
1005
"""Fail if obj is not an instance of kls"""
1006
if not isinstance(obj, kls):
1007
self.fail("%r is an instance of %s rather than %s" % (
1008
obj, obj.__class__, kls))
1010
def expectFailure(self, reason, assertion, *args, **kwargs):
1011
"""Invoke a test, expecting it to fail for the given reason.
1013
This is for assertions that ought to succeed, but currently fail.
1014
(The failure is *expected* but not *wanted*.) Please be very precise
1015
about the failure you're expecting. If a new bug is introduced,
1016
AssertionError should be raised, not KnownFailure.
1018
Frequently, expectFailure should be followed by an opposite assertion.
1021
Intended to be used with a callable that raises AssertionError as the
1022
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1024
Raises KnownFailure if the test fails. Raises AssertionError if the
1029
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1031
self.assertEqual(42, dynamic_val)
1033
This means that a dynamic_val of 54 will cause the test to raise
1034
a KnownFailure. Once math is fixed and the expectFailure is removed,
1035
only a dynamic_val of 42 will allow the test to pass. Anything other
1036
than 54 or 42 will cause an AssertionError.
1039
assertion(*args, **kwargs)
1040
except AssertionError:
1041
raise KnownFailure(reason)
1043
self.fail('Unexpected success. Should have failed: %s' % reason)
1045
def assertFileEqual(self, content, path):
1046
"""Fail if path does not contain 'content'."""
1047
self.failUnlessExists(path)
1048
f = file(path, 'rb')
1053
self.assertEqualDiff(content, s)
1055
def failUnlessExists(self, path):
1056
"""Fail unless path or paths, which may be abs or relative, exist."""
1057
if not isinstance(path, basestring):
1059
self.failUnlessExists(p)
1061
self.failUnless(osutils.lexists(path),path+" does not exist")
1063
def failIfExists(self, path):
1064
"""Fail if path or paths, which may be abs or relative, exist."""
1065
if not isinstance(path, basestring):
1067
self.failIfExists(p)
1069
self.failIf(osutils.lexists(path),path+" exists")
1071
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1072
"""A helper for callDeprecated and applyDeprecated.
1074
:param a_callable: A callable to call.
1075
:param args: The positional arguments for the callable
1076
:param kwargs: The keyword arguments for the callable
1077
:return: A tuple (warnings, result). result is the result of calling
1078
a_callable(``*args``, ``**kwargs``).
1081
def capture_warnings(msg, cls=None, stacklevel=None):
1082
# we've hooked into a deprecation specific callpath,
1083
# only deprecations should getting sent via it.
1084
self.assertEqual(cls, DeprecationWarning)
1085
local_warnings.append(msg)
1086
original_warning_method = symbol_versioning.warn
1087
symbol_versioning.set_warning_method(capture_warnings)
1089
result = a_callable(*args, **kwargs)
1091
symbol_versioning.set_warning_method(original_warning_method)
1092
return (local_warnings, result)
1094
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1095
"""Call a deprecated callable without warning the user.
1097
Note that this only captures warnings raised by symbol_versioning.warn,
1098
not other callers that go direct to the warning module.
1100
To test that a deprecated method raises an error, do something like
1103
self.assertRaises(errors.ReservedId,
1104
self.applyDeprecated, zero_ninetyone,
1105
br.append_revision, 'current:')
1107
:param deprecation_format: The deprecation format that the callable
1108
should have been deprecated with. This is the same type as the
1109
parameter to deprecated_method/deprecated_function. If the
1110
callable is not deprecated with this format, an assertion error
1112
:param a_callable: A callable to call. This may be a bound method or
1113
a regular function. It will be called with ``*args`` and
1115
:param args: The positional arguments for the callable
1116
:param kwargs: The keyword arguments for the callable
1117
:return: The result of a_callable(``*args``, ``**kwargs``)
1119
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1121
expected_first_warning = symbol_versioning.deprecation_string(
1122
a_callable, deprecation_format)
1123
if len(call_warnings) == 0:
1124
self.fail("No deprecation warning generated by call to %s" %
1126
self.assertEqual(expected_first_warning, call_warnings[0])
1129
def callCatchWarnings(self, fn, *args, **kw):
1130
"""Call a callable that raises python warnings.
1132
The caller's responsible for examining the returned warnings.
1134
If the callable raises an exception, the exception is not
1135
caught and propagates up to the caller. In that case, the list
1136
of warnings is not available.
1138
:returns: ([warning_object, ...], fn_result)
1140
# XXX: This is not perfect, because it completely overrides the
1141
# warnings filters, and some code may depend on suppressing particular
1142
# warnings. It's the easiest way to insulate ourselves from -Werror,
1143
# though. -- Andrew, 20071062
1145
def _catcher(message, category, filename, lineno, file=None):
1146
# despite the name, 'message' is normally(?) a Warning subclass
1148
wlist.append(message)
1149
saved_showwarning = warnings.showwarning
1150
saved_filters = warnings.filters
1152
warnings.showwarning = _catcher
1153
warnings.filters = []
1154
result = fn(*args, **kw)
1156
warnings.showwarning = saved_showwarning
1157
warnings.filters = saved_filters
1158
return wlist, result
1160
def callDeprecated(self, expected, callable, *args, **kwargs):
1161
"""Assert that a callable is deprecated in a particular way.
1163
This is a very precise test for unusual requirements. The
1164
applyDeprecated helper function is probably more suited for most tests
1165
as it allows you to simply specify the deprecation format being used
1166
and will ensure that that is issued for the function being called.
1168
Note that this only captures warnings raised by symbol_versioning.warn,
1169
not other callers that go direct to the warning module. To catch
1170
general warnings, use callCatchWarnings.
1172
:param expected: a list of the deprecation warnings expected, in order
1173
:param callable: The callable to call
1174
:param args: The positional arguments for the callable
1175
:param kwargs: The keyword arguments for the callable
1177
call_warnings, result = self._capture_deprecation_warnings(callable,
1179
self.assertEqual(expected, call_warnings)
1182
def _startLogFile(self):
1183
"""Send bzr and test log messages to a temporary file.
1185
The file is removed as the test is torn down.
1187
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1188
self._log_file = os.fdopen(fileno, 'w+')
1189
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1190
self._log_file_name = name
1191
self.addCleanup(self._finishLogFile)
1193
def _finishLogFile(self):
1194
"""Finished with the log file.
1196
Close the file and delete it, unless setKeepLogfile was called.
1198
if self._log_file is None:
1200
bzrlib.trace.pop_log_file(self._log_memento)
1201
self._log_file.close()
1202
self._log_file = None
1203
if not self._keep_log_file:
1204
os.remove(self._log_file_name)
1205
self._log_file_name = None
1207
def setKeepLogfile(self):
1208
"""Make the logfile not be deleted when _finishLogFile is called."""
1209
self._keep_log_file = True
1211
def addCleanup(self, callable):
1212
"""Arrange to run a callable when this case is torn down.
1214
Callables are run in the reverse of the order they are registered,
1215
ie last-in first-out.
1217
if callable in self._cleanups:
1218
raise ValueError("cleanup function %r already registered on %s"
1220
self._cleanups.append(callable)
1222
def _cleanEnvironment(self):
1224
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1225
'HOME': os.getcwd(),
1226
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1227
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1229
'BZREMAIL': None, # may still be present in the environment
1231
'BZR_PROGRESS_BAR': None,
1234
'SSH_AUTH_SOCK': None,
1238
'https_proxy': None,
1239
'HTTPS_PROXY': None,
1244
# Nobody cares about these ones AFAIK. So far at
1245
# least. If you do (care), please update this comment
1249
'BZR_REMOTE_PATH': None,
1252
self.addCleanup(self._restoreEnvironment)
1253
for name, value in new_env.iteritems():
1254
self._captureVar(name, value)
1256
def _captureVar(self, name, newvalue):
1257
"""Set an environment variable, and reset it when finished."""
1258
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1260
def _restore_debug_flags(self):
1261
debug.debug_flags.clear()
1262
debug.debug_flags.update(self._preserved_debug_flags)
1264
def _restoreEnvironment(self):
1265
for name, value in self.__old_env.iteritems():
1266
osutils.set_or_unset_env(name, value)
1268
def _restoreHooks(self):
1269
for klass, hooks in self._preserved_hooks.items():
1270
setattr(klass, 'hooks', hooks)
1272
def knownFailure(self, reason):
1273
"""This test has failed for some known reason."""
1274
raise KnownFailure(reason)
1276
def run(self, result=None):
1277
if result is None: result = self.defaultTestResult()
1278
for feature in getattr(self, '_test_needs_features', []):
1279
if not feature.available():
1280
result.startTest(self)
1281
if getattr(result, 'addNotSupported', None):
1282
result.addNotSupported(self, feature)
1284
result.addSuccess(self)
1285
result.stopTest(self)
1287
return unittest.TestCase.run(self, result)
1291
unittest.TestCase.tearDown(self)
1293
def time(self, callable, *args, **kwargs):
1294
"""Run callable and accrue the time it takes to the benchmark time.
1296
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1297
this will cause lsprofile statistics to be gathered and stored in
1300
if self._benchtime is None:
1304
if not self._gather_lsprof_in_benchmarks:
1305
return callable(*args, **kwargs)
1307
# record this benchmark
1308
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1310
self._benchcalls.append(((callable, args, kwargs), stats))
1313
self._benchtime += time.time() - start
1315
def _runCleanups(self):
1316
"""Run registered cleanup functions.
1318
This should only be called from TestCase.tearDown.
1320
# TODO: Perhaps this should keep running cleanups even if
1321
# one of them fails?
1323
# Actually pop the cleanups from the list so tearDown running
1324
# twice is safe (this happens for skipped tests).
1325
while self._cleanups:
1326
self._cleanups.pop()()
1328
def log(self, *args):
1331
def _get_log(self, keep_log_file=False):
1332
"""Get the log from bzrlib.trace calls from this test.
1334
:param keep_log_file: When True, if the log is still a file on disk
1335
leave it as a file on disk. When False, if the log is still a file
1336
on disk, the log file is deleted and the log preserved as
1338
:return: A string containing the log.
1340
# flush the log file, to get all content
1342
bzrlib.trace._trace_file.flush()
1343
if self._log_contents:
1344
# XXX: this can hardly contain the content flushed above --vila
1346
return self._log_contents
1347
if self._log_file_name is not None:
1348
logfile = open(self._log_file_name)
1350
log_contents = logfile.read()
1353
if not keep_log_file:
1354
self._log_contents = log_contents
1356
os.remove(self._log_file_name)
1358
if sys.platform == 'win32' and e.errno == errno.EACCES:
1359
sys.stderr.write(('Unable to delete log file '
1360
' %r\n' % self._log_file_name))
1365
return "DELETED log file to reduce memory footprint"
1367
def requireFeature(self, feature):
1368
"""This test requires a specific feature is available.
1370
:raises UnavailableFeature: When feature is not available.
1372
if not feature.available():
1373
raise UnavailableFeature(feature)
1375
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1377
"""Run bazaar command line, splitting up a string command line."""
1378
if isinstance(args, basestring):
1379
# shlex don't understand unicode strings,
1380
# so args should be plain string (bialix 20070906)
1381
args = list(shlex.split(str(args)))
1382
return self._run_bzr_core(args, retcode=retcode,
1383
encoding=encoding, stdin=stdin, working_dir=working_dir,
1386
def _run_bzr_core(self, args, retcode, encoding, stdin,
1388
if encoding is None:
1389
encoding = bzrlib.user_encoding
1390
stdout = StringIOWrapper()
1391
stderr = StringIOWrapper()
1392
stdout.encoding = encoding
1393
stderr.encoding = encoding
1395
self.log('run bzr: %r', args)
1396
# FIXME: don't call into logging here
1397
handler = logging.StreamHandler(stderr)
1398
handler.setLevel(logging.INFO)
1399
logger = logging.getLogger('')
1400
logger.addHandler(handler)
1401
old_ui_factory = ui.ui_factory
1402
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1405
if working_dir is not None:
1406
cwd = osutils.getcwd()
1407
os.chdir(working_dir)
1410
result = self.apply_redirected(ui.ui_factory.stdin,
1412
bzrlib.commands.run_bzr_catch_user_errors,
1415
logger.removeHandler(handler)
1416
ui.ui_factory = old_ui_factory
1420
out = stdout.getvalue()
1421
err = stderr.getvalue()
1423
self.log('output:\n%r', out)
1425
self.log('errors:\n%r', err)
1426
if retcode is not None:
1427
self.assertEquals(retcode, result,
1428
message='Unexpected return code')
1431
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1432
working_dir=None, error_regexes=[], output_encoding=None):
1433
"""Invoke bzr, as if it were run from the command line.
1435
The argument list should not include the bzr program name - the
1436
first argument is normally the bzr command. Arguments may be
1437
passed in three ways:
1439
1- A list of strings, eg ["commit", "a"]. This is recommended
1440
when the command contains whitespace or metacharacters, or
1441
is built up at run time.
1443
2- A single string, eg "add a". This is the most convenient
1444
for hardcoded commands.
1446
This runs bzr through the interface that catches and reports
1447
errors, and with logging set to something approximating the
1448
default, so that error reporting can be checked.
1450
This should be the main method for tests that want to exercise the
1451
overall behavior of the bzr application (rather than a unit test
1452
or a functional test of the library.)
1454
This sends the stdout/stderr results into the test's log,
1455
where it may be useful for debugging. See also run_captured.
1457
:keyword stdin: A string to be used as stdin for the command.
1458
:keyword retcode: The status code the command should return;
1460
:keyword working_dir: The directory to run the command in
1461
:keyword error_regexes: A list of expected error messages. If
1462
specified they must be seen in the error output of the command.
1464
out, err = self._run_bzr_autosplit(
1469
working_dir=working_dir,
1471
for regex in error_regexes:
1472
self.assertContainsRe(err, regex)
1475
def run_bzr_error(self, error_regexes, *args, **kwargs):
1476
"""Run bzr, and check that stderr contains the supplied regexes
1478
:param error_regexes: Sequence of regular expressions which
1479
must each be found in the error output. The relative ordering
1481
:param args: command-line arguments for bzr
1482
:param kwargs: Keyword arguments which are interpreted by run_bzr
1483
This function changes the default value of retcode to be 3,
1484
since in most cases this is run when you expect bzr to fail.
1486
:return: (out, err) The actual output of running the command (in case
1487
you want to do more inspection)
1491
# Make sure that commit is failing because there is nothing to do
1492
self.run_bzr_error(['no changes to commit'],
1493
['commit', '-m', 'my commit comment'])
1494
# Make sure --strict is handling an unknown file, rather than
1495
# giving us the 'nothing to do' error
1496
self.build_tree(['unknown'])
1497
self.run_bzr_error(['Commit refused because there are unknown files'],
1498
['commit', --strict', '-m', 'my commit comment'])
1500
kwargs.setdefault('retcode', 3)
1501
kwargs['error_regexes'] = error_regexes
1502
out, err = self.run_bzr(*args, **kwargs)
1505
def run_bzr_subprocess(self, *args, **kwargs):
1506
"""Run bzr in a subprocess for testing.
1508
This starts a new Python interpreter and runs bzr in there.
1509
This should only be used for tests that have a justifiable need for
1510
this isolation: e.g. they are testing startup time, or signal
1511
handling, or early startup code, etc. Subprocess code can't be
1512
profiled or debugged so easily.
1514
:keyword retcode: The status code that is expected. Defaults to 0. If
1515
None is supplied, the status code is not checked.
1516
:keyword env_changes: A dictionary which lists changes to environment
1517
variables. A value of None will unset the env variable.
1518
The values must be strings. The change will only occur in the
1519
child, so you don't need to fix the environment after running.
1520
:keyword universal_newlines: Convert CRLF => LF
1521
:keyword allow_plugins: By default the subprocess is run with
1522
--no-plugins to ensure test reproducibility. Also, it is possible
1523
for system-wide plugins to create unexpected output on stderr,
1524
which can cause unnecessary test failures.
1526
env_changes = kwargs.get('env_changes', {})
1527
working_dir = kwargs.get('working_dir', None)
1528
allow_plugins = kwargs.get('allow_plugins', False)
1530
if isinstance(args[0], list):
1532
elif isinstance(args[0], basestring):
1533
args = list(shlex.split(args[0]))
1535
symbol_versioning.warn(zero_ninetyone %
1536
"passing varargs to run_bzr_subprocess",
1537
DeprecationWarning, stacklevel=3)
1538
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1539
working_dir=working_dir,
1540
allow_plugins=allow_plugins)
1541
# We distinguish between retcode=None and retcode not passed.
1542
supplied_retcode = kwargs.get('retcode', 0)
1543
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1544
universal_newlines=kwargs.get('universal_newlines', False),
1547
def start_bzr_subprocess(self, process_args, env_changes=None,
1548
skip_if_plan_to_signal=False,
1550
allow_plugins=False):
1551
"""Start bzr in a subprocess for testing.
1553
This starts a new Python interpreter and runs bzr in there.
1554
This should only be used for tests that have a justifiable need for
1555
this isolation: e.g. they are testing startup time, or signal
1556
handling, or early startup code, etc. Subprocess code can't be
1557
profiled or debugged so easily.
1559
:param process_args: a list of arguments to pass to the bzr executable,
1560
for example ``['--version']``.
1561
:param env_changes: A dictionary which lists changes to environment
1562
variables. A value of None will unset the env variable.
1563
The values must be strings. The change will only occur in the
1564
child, so you don't need to fix the environment after running.
1565
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1567
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1569
:returns: Popen object for the started process.
1571
if skip_if_plan_to_signal:
1572
if not getattr(os, 'kill', None):
1573
raise TestSkipped("os.kill not available.")
1575
if env_changes is None:
1579
def cleanup_environment():
1580
for env_var, value in env_changes.iteritems():
1581
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1583
def restore_environment():
1584
for env_var, value in old_env.iteritems():
1585
osutils.set_or_unset_env(env_var, value)
1587
bzr_path = self.get_bzr_path()
1590
if working_dir is not None:
1591
cwd = osutils.getcwd()
1592
os.chdir(working_dir)
1595
# win32 subprocess doesn't support preexec_fn
1596
# so we will avoid using it on all platforms, just to
1597
# make sure the code path is used, and we don't break on win32
1598
cleanup_environment()
1599
command = [sys.executable, bzr_path]
1600
if not allow_plugins:
1601
command.append('--no-plugins')
1602
command.extend(process_args)
1603
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1605
restore_environment()
1611
def _popen(self, *args, **kwargs):
1612
"""Place a call to Popen.
1614
Allows tests to override this method to intercept the calls made to
1615
Popen for introspection.
1617
return Popen(*args, **kwargs)
1619
def get_bzr_path(self):
1620
"""Return the path of the 'bzr' executable for this test suite."""
1621
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1622
if not os.path.isfile(bzr_path):
1623
# We are probably installed. Assume sys.argv is the right file
1624
bzr_path = sys.argv[0]
1627
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1628
universal_newlines=False, process_args=None):
1629
"""Finish the execution of process.
1631
:param process: the Popen object returned from start_bzr_subprocess.
1632
:param retcode: The status code that is expected. Defaults to 0. If
1633
None is supplied, the status code is not checked.
1634
:param send_signal: an optional signal to send to the process.
1635
:param universal_newlines: Convert CRLF => LF
1636
:returns: (stdout, stderr)
1638
if send_signal is not None:
1639
os.kill(process.pid, send_signal)
1640
out, err = process.communicate()
1642
if universal_newlines:
1643
out = out.replace('\r\n', '\n')
1644
err = err.replace('\r\n', '\n')
1646
if retcode is not None and retcode != process.returncode:
1647
if process_args is None:
1648
process_args = "(unknown args)"
1649
mutter('Output of bzr %s:\n%s', process_args, out)
1650
mutter('Error for bzr %s:\n%s', process_args, err)
1651
self.fail('Command bzr %s failed with retcode %s != %s'
1652
% (process_args, retcode, process.returncode))
1655
def check_inventory_shape(self, inv, shape):
1656
"""Compare an inventory to a list of expected names.
1658
Fail if they are not precisely equal.
1661
shape = list(shape) # copy
1662
for path, ie in inv.entries():
1663
name = path.replace('\\', '/')
1664
if ie.kind == 'directory':
1671
self.fail("expected paths not found in inventory: %r" % shape)
1673
self.fail("unexpected paths found in inventory: %r" % extras)
1675
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1676
a_callable=None, *args, **kwargs):
1677
"""Call callable with redirected std io pipes.
1679
Returns the return code."""
1680
if not callable(a_callable):
1681
raise ValueError("a_callable must be callable.")
1683
stdin = StringIO("")
1685
if getattr(self, "_log_file", None) is not None:
1686
stdout = self._log_file
1690
if getattr(self, "_log_file", None is not None):
1691
stderr = self._log_file
1694
real_stdin = sys.stdin
1695
real_stdout = sys.stdout
1696
real_stderr = sys.stderr
1701
return a_callable(*args, **kwargs)
1703
sys.stdout = real_stdout
1704
sys.stderr = real_stderr
1705
sys.stdin = real_stdin
1707
def reduceLockdirTimeout(self):
1708
"""Reduce the default lock timeout for the duration of the test, so that
1709
if LockContention occurs during a test, it does so quickly.
1711
Tests that expect to provoke LockContention errors should call this.
1713
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1715
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1716
self.addCleanup(resetTimeout)
1717
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1719
def make_utf8_encoded_stringio(self, encoding_type=None):
1720
"""Return a StringIOWrapper instance, that will encode Unicode
1723
if encoding_type is None:
1724
encoding_type = 'strict'
1726
output_encoding = 'utf-8'
1727
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1728
sio.encoding = output_encoding
1732
class TestCaseWithMemoryTransport(TestCase):
1733
"""Common test class for tests that do not need disk resources.
1735
Tests that need disk resources should derive from TestCaseWithTransport.
1737
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1739
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1740
a directory which does not exist. This serves to help ensure test isolation
1741
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1742
must exist. However, TestCaseWithMemoryTransport does not offer local
1743
file defaults for the transport in tests, nor does it obey the command line
1744
override, so tests that accidentally write to the common directory should
1747
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1748
a .bzr directory that stops us ascending higher into the filesystem.
1754
def __init__(self, methodName='runTest'):
1755
# allow test parameterization after test construction and before test
1756
# execution. Variables that the parameterizer sets need to be
1757
# ones that are not set by setUp, or setUp will trash them.
1758
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1759
self.vfs_transport_factory = default_transport
1760
self.transport_server = None
1761
self.transport_readonly_server = None
1762
self.__vfs_server = None
1764
def get_transport(self, relpath=None):
1765
"""Return a writeable transport.
1767
This transport is for the test scratch space relative to
1770
:param relpath: a path relative to the base url.
1772
t = get_transport(self.get_url(relpath))
1773
self.assertFalse(t.is_readonly())
1776
def get_readonly_transport(self, relpath=None):
1777
"""Return a readonly transport for the test scratch space
1779
This can be used to test that operations which should only need
1780
readonly access in fact do not try to write.
1782
:param relpath: a path relative to the base url.
1784
t = get_transport(self.get_readonly_url(relpath))
1785
self.assertTrue(t.is_readonly())
1788
def create_transport_readonly_server(self):
1789
"""Create a transport server from class defined at init.
1791
This is mostly a hook for daughter classes.
1793
return self.transport_readonly_server()
1795
def get_readonly_server(self):
1796
"""Get the server instance for the readonly transport
1798
This is useful for some tests with specific servers to do diagnostics.
1800
if self.__readonly_server is None:
1801
if self.transport_readonly_server is None:
1802
# readonly decorator requested
1803
# bring up the server
1804
self.__readonly_server = ReadonlyServer()
1805
self.__readonly_server.setUp(self.get_vfs_only_server())
1807
self.__readonly_server = self.create_transport_readonly_server()
1808
self.__readonly_server.setUp(self.get_vfs_only_server())
1809
self.addCleanup(self.__readonly_server.tearDown)
1810
return self.__readonly_server
1812
def get_readonly_url(self, relpath=None):
1813
"""Get a URL for the readonly transport.
1815
This will either be backed by '.' or a decorator to the transport
1816
used by self.get_url()
1817
relpath provides for clients to get a path relative to the base url.
1818
These should only be downwards relative, not upwards.
1820
base = self.get_readonly_server().get_url()
1821
return self._adjust_url(base, relpath)
1823
def get_vfs_only_server(self):
1824
"""Get the vfs only read/write server instance.
1826
This is useful for some tests with specific servers that need
1829
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1830
is no means to override it.
1832
if self.__vfs_server is None:
1833
self.__vfs_server = MemoryServer()
1834
self.__vfs_server.setUp()
1835
self.addCleanup(self.__vfs_server.tearDown)
1836
return self.__vfs_server
1838
def get_server(self):
1839
"""Get the read/write server instance.
1841
This is useful for some tests with specific servers that need
1844
This is built from the self.transport_server factory. If that is None,
1845
then the self.get_vfs_server is returned.
1847
if self.__server is None:
1848
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1849
return self.get_vfs_only_server()
1851
# bring up a decorated means of access to the vfs only server.
1852
self.__server = self.transport_server()
1854
self.__server.setUp(self.get_vfs_only_server())
1855
except TypeError, e:
1856
# This should never happen; the try:Except here is to assist
1857
# developers having to update code rather than seeing an
1858
# uninformative TypeError.
1859
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1860
self.addCleanup(self.__server.tearDown)
1861
return self.__server
1863
def _adjust_url(self, base, relpath):
1864
"""Get a URL (or maybe a path) for the readwrite transport.
1866
This will either be backed by '.' or to an equivalent non-file based
1868
relpath provides for clients to get a path relative to the base url.
1869
These should only be downwards relative, not upwards.
1871
if relpath is not None and relpath != '.':
1872
if not base.endswith('/'):
1874
# XXX: Really base should be a url; we did after all call
1875
# get_url()! But sometimes it's just a path (from
1876
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1877
# to a non-escaped local path.
1878
if base.startswith('./') or base.startswith('/'):
1881
base += urlutils.escape(relpath)
1884
def get_url(self, relpath=None):
1885
"""Get a URL (or maybe a path) for the readwrite transport.
1887
This will either be backed by '.' or to an equivalent non-file based
1889
relpath provides for clients to get a path relative to the base url.
1890
These should only be downwards relative, not upwards.
1892
base = self.get_server().get_url()
1893
return self._adjust_url(base, relpath)
1895
def get_vfs_only_url(self, relpath=None):
1896
"""Get a URL (or maybe a path for the plain old vfs transport.
1898
This will never be a smart protocol. It always has all the
1899
capabilities of the local filesystem, but it might actually be a
1900
MemoryTransport or some other similar virtual filesystem.
1902
This is the backing transport (if any) of the server returned by
1903
get_url and get_readonly_url.
1905
:param relpath: provides for clients to get a path relative to the base
1906
url. These should only be downwards relative, not upwards.
1909
base = self.get_vfs_only_server().get_url()
1910
return self._adjust_url(base, relpath)
1912
def _create_safety_net(self):
1913
"""Make a fake bzr directory.
1915
This prevents any tests propagating up onto the TEST_ROOT directory's
1918
root = TestCaseWithMemoryTransport.TEST_ROOT
1919
bzrdir.BzrDir.create_standalone_workingtree(root)
1921
def _check_safety_net(self):
1922
"""Check that the safety .bzr directory have not been touched.
1924
_make_test_root have created a .bzr directory to prevent tests from
1925
propagating. This method ensures than a test did not leaked.
1927
root = TestCaseWithMemoryTransport.TEST_ROOT
1928
wt = workingtree.WorkingTree.open(root)
1929
last_rev = wt.last_revision()
1930
if last_rev != 'null:':
1931
# The current test have modified the /bzr directory, we need to
1932
# recreate a new one or all the followng tests will fail.
1933
# If you need to inspect its content uncomment the following line
1934
# import pdb; pdb.set_trace()
1935
_rmtree_temp_dir(root + '/.bzr')
1936
self._create_safety_net()
1937
raise AssertionError('%s/.bzr should not be modified' % root)
1939
def _make_test_root(self):
1940
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1941
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1942
TestCaseWithMemoryTransport.TEST_ROOT = root
1944
self._create_safety_net()
1946
# The same directory is used by all tests, and we're not
1947
# specifically told when all tests are finished. This will do.
1948
atexit.register(_rmtree_temp_dir, root)
1950
self.addCleanup(self._check_safety_net)
1952
def makeAndChdirToTestDir(self):
1953
"""Create a temporary directories for this one test.
1955
This must set self.test_home_dir and self.test_dir and chdir to
1958
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1960
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1961
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1962
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1964
def make_branch(self, relpath, format=None):
1965
"""Create a branch on the transport at relpath."""
1966
repo = self.make_repository(relpath, format=format)
1967
return repo.bzrdir.create_branch()
1969
def make_bzrdir(self, relpath, format=None):
1971
# might be a relative or absolute path
1972
maybe_a_url = self.get_url(relpath)
1973
segments = maybe_a_url.rsplit('/', 1)
1974
t = get_transport(maybe_a_url)
1975
if len(segments) > 1 and segments[-1] not in ('', '.'):
1979
if isinstance(format, basestring):
1980
format = bzrdir.format_registry.make_bzrdir(format)
1981
return format.initialize_on_transport(t)
1982
except errors.UninitializableFormat:
1983
raise TestSkipped("Format %s is not initializable." % format)
1985
def make_repository(self, relpath, shared=False, format=None):
1986
"""Create a repository on our default transport at relpath.
1988
Note that relpath must be a relative path, not a full url.
1990
# FIXME: If you create a remoterepository this returns the underlying
1991
# real format, which is incorrect. Actually we should make sure that
1992
# RemoteBzrDir returns a RemoteRepository.
1993
# maybe mbp 20070410
1994
made_control = self.make_bzrdir(relpath, format=format)
1995
return made_control.create_repository(shared=shared)
1997
def make_branch_and_memory_tree(self, relpath, format=None):
1998
"""Create a branch on the default transport and a MemoryTree for it."""
1999
b = self.make_branch(relpath, format=format)
2000
return memorytree.MemoryTree.create_on_branch(b)
2002
def overrideEnvironmentForTesting(self):
2003
os.environ['HOME'] = self.test_home_dir
2004
os.environ['BZR_HOME'] = self.test_home_dir
2007
super(TestCaseWithMemoryTransport, self).setUp()
2008
self._make_test_root()
2009
_currentdir = os.getcwdu()
2010
def _leaveDirectory():
2011
os.chdir(_currentdir)
2012
self.addCleanup(_leaveDirectory)
2013
self.makeAndChdirToTestDir()
2014
self.overrideEnvironmentForTesting()
2015
self.__readonly_server = None
2016
self.__server = None
2017
self.reduceLockdirTimeout()
2020
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2021
"""Derived class that runs a test within a temporary directory.
2023
This is useful for tests that need to create a branch, etc.
2025
The directory is created in a slightly complex way: for each
2026
Python invocation, a new temporary top-level directory is created.
2027
All test cases create their own directory within that. If the
2028
tests complete successfully, the directory is removed.
2030
:ivar test_base_dir: The path of the top-level directory for this
2031
test, which contains a home directory and a work directory.
2033
:ivar test_home_dir: An initially empty directory under test_base_dir
2034
which is used as $HOME for this test.
2036
:ivar test_dir: A directory under test_base_dir used as the current
2037
directory when the test proper is run.
2040
OVERRIDE_PYTHON = 'python'
2042
def check_file_contents(self, filename, expect):
2043
self.log("check contents of file %s" % filename)
2044
contents = file(filename, 'r').read()
2045
if contents != expect:
2046
self.log("expected: %r" % expect)
2047
self.log("actually: %r" % contents)
2048
self.fail("contents of %s not as expected" % filename)
2050
def makeAndChdirToTestDir(self):
2051
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2053
For TestCaseInTempDir we create a temporary directory based on the test
2054
name and then create two subdirs - test and home under it.
2056
# create a directory within the top level test directory
2057
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2058
# now create test and home directories within this dir
2059
self.test_base_dir = candidate_dir
2060
self.test_home_dir = self.test_base_dir + '/home'
2061
os.mkdir(self.test_home_dir)
2062
self.test_dir = self.test_base_dir + '/work'
2063
os.mkdir(self.test_dir)
2064
os.chdir(self.test_dir)
2065
# put name of test inside
2066
f = file(self.test_base_dir + '/name', 'w')
2071
self.addCleanup(self.deleteTestDir)
2073
def deleteTestDir(self):
2074
os.chdir(self.TEST_ROOT)
2075
_rmtree_temp_dir(self.test_base_dir)
2077
def build_tree(self, shape, line_endings='binary', transport=None):
2078
"""Build a test tree according to a pattern.
2080
shape is a sequence of file specifications. If the final
2081
character is '/', a directory is created.
2083
This assumes that all the elements in the tree being built are new.
2085
This doesn't add anything to a branch.
2087
:type shape: list or tuple.
2088
:param line_endings: Either 'binary' or 'native'
2089
in binary mode, exact contents are written in native mode, the
2090
line endings match the default platform endings.
2091
:param transport: A transport to write to, for building trees on VFS's.
2092
If the transport is readonly or None, "." is opened automatically.
2095
if type(shape) not in (list, tuple):
2096
raise AssertionError("Parameter 'shape' should be "
2097
"a list or a tuple. Got %r instead" % (shape,))
2098
# It's OK to just create them using forward slashes on windows.
2099
if transport is None or transport.is_readonly():
2100
transport = get_transport(".")
2102
self.assert_(isinstance(name, basestring))
2104
transport.mkdir(urlutils.escape(name[:-1]))
2106
if line_endings == 'binary':
2108
elif line_endings == 'native':
2111
raise errors.BzrError(
2112
'Invalid line ending request %r' % line_endings)
2113
content = "contents of %s%s" % (name.encode('utf-8'), end)
2114
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2116
def build_tree_contents(self, shape):
2117
build_tree_contents(shape)
2119
def assertInWorkingTree(self, path, root_path='.', tree=None):
2120
"""Assert whether path or paths are in the WorkingTree"""
2122
tree = workingtree.WorkingTree.open(root_path)
2123
if not isinstance(path, basestring):
2125
self.assertInWorkingTree(p,tree=tree)
2127
self.assertIsNot(tree.path2id(path), None,
2128
path+' not in working tree.')
2130
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2131
"""Assert whether path or paths are not in the WorkingTree"""
2133
tree = workingtree.WorkingTree.open(root_path)
2134
if not isinstance(path, basestring):
2136
self.assertNotInWorkingTree(p,tree=tree)
2138
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2141
class TestCaseWithTransport(TestCaseInTempDir):
2142
"""A test case that provides get_url and get_readonly_url facilities.
2144
These back onto two transport servers, one for readonly access and one for
2147
If no explicit class is provided for readonly access, a
2148
ReadonlyTransportDecorator is used instead which allows the use of non disk
2149
based read write transports.
2151
If an explicit class is provided for readonly access, that server and the
2152
readwrite one must both define get_url() as resolving to os.getcwd().
2155
def get_vfs_only_server(self):
2156
"""See TestCaseWithMemoryTransport.
2158
This is useful for some tests with specific servers that need
2161
if self.__vfs_server is None:
2162
self.__vfs_server = self.vfs_transport_factory()
2163
self.__vfs_server.setUp()
2164
self.addCleanup(self.__vfs_server.tearDown)
2165
return self.__vfs_server
2167
def make_branch_and_tree(self, relpath, format=None):
2168
"""Create a branch on the transport and a tree locally.
2170
If the transport is not a LocalTransport, the Tree can't be created on
2171
the transport. In that case if the vfs_transport_factory is
2172
LocalURLServer the working tree is created in the local
2173
directory backing the transport, and the returned tree's branch and
2174
repository will also be accessed locally. Otherwise a lightweight
2175
checkout is created and returned.
2177
:param format: The BzrDirFormat.
2178
:returns: the WorkingTree.
2180
# TODO: always use the local disk path for the working tree,
2181
# this obviously requires a format that supports branch references
2182
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2184
b = self.make_branch(relpath, format=format)
2186
return b.bzrdir.create_workingtree()
2187
except errors.NotLocalUrl:
2188
# We can only make working trees locally at the moment. If the
2189
# transport can't support them, then we keep the non-disk-backed
2190
# branch and create a local checkout.
2191
if self.vfs_transport_factory is LocalURLServer:
2192
# the branch is colocated on disk, we cannot create a checkout.
2193
# hopefully callers will expect this.
2194
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2195
return local_controldir.create_workingtree()
2197
return b.create_checkout(relpath, lightweight=True)
2199
def assertIsDirectory(self, relpath, transport):
2200
"""Assert that relpath within transport is a directory.
2202
This may not be possible on all transports; in that case it propagates
2203
a TransportNotPossible.
2206
mode = transport.stat(relpath).st_mode
2207
except errors.NoSuchFile:
2208
self.fail("path %s is not a directory; no such file"
2210
if not stat.S_ISDIR(mode):
2211
self.fail("path %s is not a directory; has mode %#o"
2214
def assertTreesEqual(self, left, right):
2215
"""Check that left and right have the same content and properties."""
2216
# we use a tree delta to check for equality of the content, and we
2217
# manually check for equality of other things such as the parents list.
2218
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2219
differences = left.changes_from(right)
2220
self.assertFalse(differences.has_changed(),
2221
"Trees %r and %r are different: %r" % (left, right, differences))
2224
super(TestCaseWithTransport, self).setUp()
2225
self.__vfs_server = None
2228
class ChrootedTestCase(TestCaseWithTransport):
2229
"""A support class that provides readonly urls outside the local namespace.
2231
This is done by checking if self.transport_server is a MemoryServer. if it
2232
is then we are chrooted already, if it is not then an HttpServer is used
2235
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2236
be used without needed to redo it when a different
2237
subclass is in use ?
2241
super(ChrootedTestCase, self).setUp()
2242
if not self.vfs_transport_factory == MemoryServer:
2243
self.transport_readonly_server = HttpServer
2246
def condition_id_re(pattern):
2247
"""Create a condition filter which performs a re check on a test's id.
2249
:param pattern: A regular expression string.
2250
:return: A callable that returns True if the re matches.
2252
filter_re = re.compile(pattern)
2253
def condition(test):
2255
return filter_re.search(test_id)
2259
def condition_isinstance(klass_or_klass_list):
2260
"""Create a condition filter which returns isinstance(param, klass).
2262
:return: A callable which when called with one parameter obj return the
2263
result of isinstance(obj, klass_or_klass_list).
2266
return isinstance(obj, klass_or_klass_list)
2270
def condition_id_in_list(id_list):
2271
"""Create a condition filter which verify that test's id in a list.
2273
:param name: A TestIdList object.
2274
:return: A callable that returns True if the test's id appears in the list.
2276
def condition(test):
2277
return id_list.test_in(test.id())
2281
def exclude_tests_by_condition(suite, condition):
2282
"""Create a test suite which excludes some tests from suite.
2284
:param suite: The suite to get tests from.
2285
:param condition: A callable whose result evaluates True when called with a
2286
test case which should be excluded from the result.
2287
:return: A suite which contains the tests found in suite that fail
2291
for test in iter_suite_tests(suite):
2292
if not condition(test):
2294
return TestUtil.TestSuite(result)
2297
def filter_suite_by_condition(suite, condition):
2298
"""Create a test suite by filtering another one.
2300
:param suite: The source suite.
2301
:param condition: A callable whose result evaluates True when called with a
2302
test case which should be included in the result.
2303
:return: A suite which contains the tests found in suite that pass
2307
for test in iter_suite_tests(suite):
2310
return TestUtil.TestSuite(result)
2313
def filter_suite_by_re(suite, pattern, exclude_pattern=DEPRECATED_PARAMETER,
2314
random_order=DEPRECATED_PARAMETER):
2315
"""Create a test suite by filtering another one.
2317
:param suite: the source suite
2318
:param pattern: pattern that names must match
2319
:param exclude_pattern: A pattern that names must not match. This parameter
2320
is deprecated as of bzrlib 1.0. Please use the separate function
2321
exclude_tests_by_re instead.
2322
:param random_order: If True, tests in the new suite will be put in
2323
random order. This parameter is deprecated as of bzrlib 1.0. Please
2324
use the separate function randomize_suite instead.
2325
:returns: the newly created suite
2327
if deprecated_passed(exclude_pattern):
2328
symbol_versioning.warn(
2329
one_zero % "passing exclude_pattern to filter_suite_by_re",
2330
DeprecationWarning, stacklevel=2)
2331
if exclude_pattern is not None:
2332
suite = exclude_tests_by_re(suite, exclude_pattern)
2333
condition = condition_id_re(pattern)
2334
result_suite = filter_suite_by_condition(suite, condition)
2335
if deprecated_passed(random_order):
2336
symbol_versioning.warn(
2337
one_zero % "passing random_order to filter_suite_by_re",
2338
DeprecationWarning, stacklevel=2)
2340
result_suite = randomize_suite(result_suite)
2344
def filter_suite_by_id_list(suite, test_id_list):
2345
"""Create a test suite by filtering another one.
2347
:param suite: The source suite.
2348
:param test_id_list: A list of the test ids to keep as strings.
2349
:returns: the newly created suite
2351
condition = condition_id_in_list(test_id_list)
2352
result_suite = filter_suite_by_condition(suite, condition)
2356
def exclude_tests_by_re(suite, pattern):
2357
"""Create a test suite which excludes some tests from suite.
2359
:param suite: The suite to get tests from.
2360
:param pattern: A regular expression string. Test ids that match this
2361
pattern will be excluded from the result.
2362
:return: A TestSuite that contains all the tests from suite without the
2363
tests that matched pattern. The order of tests is the same as it was in
2366
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2369
def preserve_input(something):
2370
"""A helper for performing test suite transformation chains.
2372
:param something: Anything you want to preserve.
2378
def randomize_suite(suite):
2379
"""Return a new TestSuite with suite's tests in random order.
2381
The tests in the input suite are flattened into a single suite in order to
2382
accomplish this. Any nested TestSuites are removed to provide global
2385
tests = list(iter_suite_tests(suite))
2386
random.shuffle(tests)
2387
return TestUtil.TestSuite(tests)
2390
@deprecated_function(one_zero)
2391
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2392
random_order=False, append_rest=True):
2393
"""DEPRECATED: Create a test suite by sorting another one.
2395
This method has been decomposed into separate helper methods that should be
2397
- filter_suite_by_re
2398
- exclude_tests_by_re
2402
:param suite: the source suite
2403
:param pattern: pattern that names must match in order to go
2404
first in the new suite
2405
:param exclude_pattern: pattern that names must not match, if any
2406
:param random_order: if True, tests in the new suite will be put in
2407
random order (with all tests matching pattern
2409
:param append_rest: if False, pattern is a strict filter and not
2410
just an ordering directive
2411
:returns: the newly created suite
2413
if exclude_pattern is not None:
2414
suite = exclude_tests_by_re(suite, exclude_pattern)
2416
order_changer = randomize_suite
2418
order_changer = preserve_input
2420
suites = map(order_changer, split_suite_by_re(suite, pattern))
2421
return TestUtil.TestSuite(suites)
2423
return order_changer(filter_suite_by_re(suite, pattern))
2426
def split_suite_by_re(suite, pattern):
2427
"""Split a test suite into two by a regular expression.
2429
:param suite: The suite to split.
2430
:param pattern: A regular expression string. Test ids that match this
2431
pattern will be in the first test suite returned, and the others in the
2432
second test suite returned.
2433
:return: A tuple of two test suites, where the first contains tests from
2434
suite matching pattern, and the second contains the remainder from
2435
suite. The order within each output suite is the same as it was in
2440
filter_re = re.compile(pattern)
2441
for test in iter_suite_tests(suite):
2443
if filter_re.search(test_id):
2444
matched.append(test)
2446
did_not_match.append(test)
2447
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2450
def run_suite(suite, name='test', verbose=False, pattern=".*",
2451
stop_on_failure=False,
2452
transport=None, lsprof_timed=None, bench_history=None,
2453
matching_tests_first=None,
2456
exclude_pattern=None,
2458
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2463
runner = TextTestRunner(stream=sys.stdout,
2465
verbosity=verbosity,
2466
bench_history=bench_history,
2467
list_only=list_only,
2469
runner.stop_on_failure=stop_on_failure
2470
# Initialise the random number generator and display the seed used.
2471
# We convert the seed to a long to make it reuseable across invocations.
2472
random_order = False
2473
if random_seed is not None:
2475
if random_seed == "now":
2476
random_seed = long(time.time())
2478
# Convert the seed to a long if we can
2480
random_seed = long(random_seed)
2483
runner.stream.writeln("Randomizing test order using seed %s\n" %
2485
random.seed(random_seed)
2486
# Customise the list of tests if requested
2487
if exclude_pattern is not None:
2488
suite = exclude_tests_by_re(suite, exclude_pattern)
2490
order_changer = randomize_suite
2492
order_changer = preserve_input
2493
if pattern != '.*' or random_order:
2494
if matching_tests_first:
2495
suites = map(order_changer, split_suite_by_re(suite, pattern))
2496
suite = TestUtil.TestSuite(suites)
2498
suite = order_changer(filter_suite_by_re(suite, pattern))
2500
result = runner.run(suite)
2503
return result.wasStrictlySuccessful()
2505
return result.wasSuccessful()
2508
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2510
test_suite_factory=None,
2513
matching_tests_first=None,
2516
exclude_pattern=None,
2520
"""Run the whole test suite under the enhanced runner"""
2521
# XXX: Very ugly way to do this...
2522
# Disable warning about old formats because we don't want it to disturb
2523
# any blackbox tests.
2524
from bzrlib import repository
2525
repository._deprecation_warning_done = True
2527
global default_transport
2528
if transport is None:
2529
transport = default_transport
2530
old_transport = default_transport
2531
default_transport = transport
2533
if load_list is None:
2536
keep_only = load_test_id_list(load_list)
2537
if test_suite_factory is None:
2538
suite = test_suite(keep_only)
2540
suite = test_suite_factory()
2541
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2542
stop_on_failure=stop_on_failure,
2543
transport=transport,
2544
lsprof_timed=lsprof_timed,
2545
bench_history=bench_history,
2546
matching_tests_first=matching_tests_first,
2547
list_only=list_only,
2548
random_seed=random_seed,
2549
exclude_pattern=exclude_pattern,
2552
default_transport = old_transport
2555
def load_test_id_list(file_name):
2556
"""Load a test id list from a text file.
2558
The format is one test id by line. No special care is taken to impose
2559
strict rules, these test ids are used to filter the test suite so a test id
2560
that do not match an existing test will do no harm. This allows user to add
2561
comments, leave blank lines, etc.
2565
ftest = open(file_name, 'rt')
2567
if e.errno != errno.ENOENT:
2570
raise errors.NoSuchFile(file_name)
2572
for test_name in ftest.readlines():
2573
test_list.append(test_name.strip())
2578
class TestIdList(object):
2579
"""Test id list to filter a test suite.
2581
Relying on the assumption that test ids are built as:
2582
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2583
notation, this class offers methods to :
2584
- avoid building a test suite for modules not refered to in the test list,
2585
- keep only the tests listed from the module test suite.
2588
def __init__(self, test_id_list):
2589
# When a test suite needs to be filtered against us we compare test ids
2590
# for equality, so a simple dict offers a quick and simple solution.
2591
self.tests = dict().fromkeys(test_id_list, True)
2593
# While unittest.TestCase have ids like:
2594
# <module>.<class>.<method>[(<param+)],
2595
# doctest.DocTestCase can have ids like:
2598
# <module>.<function>
2599
# <module>.<class>.<method>
2601
# Since we can't predict a test class from its name only, we settle on
2602
# a simple constraint: a test id always begins with its module name.
2605
for test_id in test_id_list:
2606
parts = test_id.split('.')
2607
mod_name = parts.pop(0)
2608
modules[mod_name] = True
2610
mod_name += '.' + part
2611
modules[mod_name] = True
2612
self.modules = modules
2614
def is_module_name_used(self, module_name):
2615
"""Is there tests for the module or one of its sub modules."""
2616
return self.modules.has_key(module_name)
2618
def test_in(self, test_id):
2619
return self.tests.has_key(test_id)
2622
def test_suite(keep_only=None):
2623
"""Build and return TestSuite for the whole of bzrlib.
2625
:param keep_only: A list of test ids limiting the suite returned.
2627
This function can be replaced if you need to change the default test
2628
suite on a global basis, but it is not encouraged.
2631
'bzrlib.util.tests.test_bencode',
2632
'bzrlib.tests.test__dirstate_helpers',
2633
'bzrlib.tests.test_ancestry',
2634
'bzrlib.tests.test_annotate',
2635
'bzrlib.tests.test_api',
2636
'bzrlib.tests.test_atomicfile',
2637
'bzrlib.tests.test_bad_files',
2638
'bzrlib.tests.test_bisect_multi',
2639
'bzrlib.tests.test_branch',
2640
'bzrlib.tests.test_branchbuilder',
2641
'bzrlib.tests.test_bugtracker',
2642
'bzrlib.tests.test_bundle',
2643
'bzrlib.tests.test_bzrdir',
2644
'bzrlib.tests.test_cache_utf8',
2645
'bzrlib.tests.test_commands',
2646
'bzrlib.tests.test_commit',
2647
'bzrlib.tests.test_commit_merge',
2648
'bzrlib.tests.test_config',
2649
'bzrlib.tests.test_conflicts',
2650
'bzrlib.tests.test_counted_lock',
2651
'bzrlib.tests.test_decorators',
2652
'bzrlib.tests.test_delta',
2653
'bzrlib.tests.test_deprecated_graph',
2654
'bzrlib.tests.test_diff',
2655
'bzrlib.tests.test_dirstate',
2656
'bzrlib.tests.test_directory_service',
2657
'bzrlib.tests.test_email_message',
2658
'bzrlib.tests.test_errors',
2659
'bzrlib.tests.test_escaped_store',
2660
'bzrlib.tests.test_extract',
2661
'bzrlib.tests.test_fetch',
2662
'bzrlib.tests.test_ftp_transport',
2663
'bzrlib.tests.test_generate_docs',
2664
'bzrlib.tests.test_generate_ids',
2665
'bzrlib.tests.test_globbing',
2666
'bzrlib.tests.test_gpg',
2667
'bzrlib.tests.test_graph',
2668
'bzrlib.tests.test_hashcache',
2669
'bzrlib.tests.test_help',
2670
'bzrlib.tests.test_hooks',
2671
'bzrlib.tests.test_http',
2672
'bzrlib.tests.test_http_implementations',
2673
'bzrlib.tests.test_http_response',
2674
'bzrlib.tests.test_https_ca_bundle',
2675
'bzrlib.tests.test_identitymap',
2676
'bzrlib.tests.test_ignores',
2677
'bzrlib.tests.test_index',
2678
'bzrlib.tests.test_info',
2679
'bzrlib.tests.test_inv',
2680
'bzrlib.tests.test_knit',
2681
'bzrlib.tests.test_lazy_import',
2682
'bzrlib.tests.test_lazy_regex',
2683
'bzrlib.tests.test_lockdir',
2684
'bzrlib.tests.test_lockable_files',
2685
'bzrlib.tests.test_log',
2686
'bzrlib.tests.test_lsprof',
2687
'bzrlib.tests.test_lru_cache',
2688
'bzrlib.tests.test_mail_client',
2689
'bzrlib.tests.test_memorytree',
2690
'bzrlib.tests.test_merge',
2691
'bzrlib.tests.test_merge3',
2692
'bzrlib.tests.test_merge_core',
2693
'bzrlib.tests.test_merge_directive',
2694
'bzrlib.tests.test_missing',
2695
'bzrlib.tests.test_msgeditor',
2696
'bzrlib.tests.test_multiparent',
2697
'bzrlib.tests.test_nonascii',
2698
'bzrlib.tests.test_options',
2699
'bzrlib.tests.test_osutils',
2700
'bzrlib.tests.test_osutils_encodings',
2701
'bzrlib.tests.test_pack',
2702
'bzrlib.tests.test_patch',
2703
'bzrlib.tests.test_patches',
2704
'bzrlib.tests.test_permissions',
2705
'bzrlib.tests.test_plugins',
2706
'bzrlib.tests.test_progress',
2707
'bzrlib.tests.test_reconfigure',
2708
'bzrlib.tests.test_reconcile',
2709
'bzrlib.tests.test_registry',
2710
'bzrlib.tests.test_remote',
2711
'bzrlib.tests.test_repository',
2712
'bzrlib.tests.test_revert',
2713
'bzrlib.tests.test_revision',
2714
'bzrlib.tests.test_revisionnamespaces',
2715
'bzrlib.tests.test_revisiontree',
2716
'bzrlib.tests.test_rio',
2717
'bzrlib.tests.test_sampler',
2718
'bzrlib.tests.test_selftest',
2719
'bzrlib.tests.test_setup',
2720
'bzrlib.tests.test_sftp_transport',
2721
'bzrlib.tests.test_smart',
2722
'bzrlib.tests.test_smart_add',
2723
'bzrlib.tests.test_smart_transport',
2724
'bzrlib.tests.test_smtp_connection',
2725
'bzrlib.tests.test_source',
2726
'bzrlib.tests.test_ssh_transport',
2727
'bzrlib.tests.test_status',
2728
'bzrlib.tests.test_store',
2729
'bzrlib.tests.test_strace',
2730
'bzrlib.tests.test_subsume',
2731
'bzrlib.tests.test_switch',
2732
'bzrlib.tests.test_symbol_versioning',
2733
'bzrlib.tests.test_tag',
2734
'bzrlib.tests.test_testament',
2735
'bzrlib.tests.test_textfile',
2736
'bzrlib.tests.test_textmerge',
2737
'bzrlib.tests.test_timestamp',
2738
'bzrlib.tests.test_trace',
2739
'bzrlib.tests.test_transactions',
2740
'bzrlib.tests.test_transform',
2741
'bzrlib.tests.test_transport',
2742
'bzrlib.tests.test_tree',
2743
'bzrlib.tests.test_treebuilder',
2744
'bzrlib.tests.test_tsort',
2745
'bzrlib.tests.test_tuned_gzip',
2746
'bzrlib.tests.test_ui',
2747
'bzrlib.tests.test_uncommit',
2748
'bzrlib.tests.test_upgrade',
2749
'bzrlib.tests.test_urlutils',
2750
'bzrlib.tests.test_versionedfile',
2751
'bzrlib.tests.test_version',
2752
'bzrlib.tests.test_version_info',
2753
'bzrlib.tests.test_weave',
2754
'bzrlib.tests.test_whitebox',
2755
'bzrlib.tests.test_win32utils',
2756
'bzrlib.tests.test_workingtree',
2757
'bzrlib.tests.test_workingtree_4',
2758
'bzrlib.tests.test_wsgi',
2759
'bzrlib.tests.test_xml',
2761
test_transport_implementations = [
2762
'bzrlib.tests.test_transport_implementations',
2763
'bzrlib.tests.test_read_bundle',
2765
suite = TestUtil.TestSuite()
2766
loader = TestUtil.TestLoader()
2768
if keep_only is not None:
2769
id_filter = TestIdList(keep_only)
2771
# modules building their suite with loadTestsFromModuleNames
2772
if keep_only is None:
2773
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2775
for mod in [m for m in testmod_names
2776
if id_filter.is_module_name_used(m)]:
2777
mod_suite = loader.loadTestsFromModuleNames([mod])
2778
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2779
suite.addTest(mod_suite)
2781
# modules adapted for transport implementations
2782
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2783
adapter = TransportTestProviderAdapter()
2784
if keep_only is None:
2785
adapt_modules(test_transport_implementations, adapter, loader, suite)
2787
for mod in [m for m in test_transport_implementations
2788
if id_filter.is_module_name_used(m)]:
2789
mod_suite = TestUtil.TestSuite()
2790
adapt_modules([mod], adapter, loader, mod_suite)
2791
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2792
suite.addTest(mod_suite)
2794
# modules defining their own test_suite()
2795
for package in [p for p in packages_to_test()
2796
if (keep_only is None
2797
or id_filter.is_module_name_used(p.__name__))]:
2798
pack_suite = package.test_suite()
2799
if keep_only is not None:
2800
pack_suite = filter_suite_by_id_list(pack_suite, id_filter)
2801
suite.addTest(pack_suite)
2803
# XXX: MODULES_TO_TEST should be obsoleted ?
2804
for mod in [m for m in MODULES_TO_TEST
2805
if keep_only is None or id_filter.is_module_name_used(m)]:
2806
mod_suite = loader.loadTestsFromModule(mod)
2807
if keep_only is not None:
2808
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2809
suite.addTest(mod_suite)
2811
for mod in MODULES_TO_DOCTEST:
2813
doc_suite = doctest.DocTestSuite(mod)
2814
except ValueError, e:
2815
print '**failed to get doctest for: %s\n%s' % (mod, e)
2817
if keep_only is not None:
2818
# DocTests may use ids which doesn't contain the module name
2819
doc_suite = filter_suite_by_id_list(doc_suite, id_filter)
2820
suite.addTest(doc_suite)
2822
default_encoding = sys.getdefaultencoding()
2823
for name, plugin in bzrlib.plugin.plugins().items():
2824
if keep_only is not None:
2825
if not id_filter.is_module_name_used(plugin.module.__name__):
2827
plugin_suite = plugin.test_suite()
2828
# We used to catch ImportError here and turn it into just a warning,
2829
# but really if you don't have --no-plugins this should be a failure.
2830
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
2831
if plugin_suite is not None:
2832
if keep_only is not None:
2833
plugin_suite = filter_suite_by_id_list(plugin_suite,
2835
suite.addTest(plugin_suite)
2836
if default_encoding != sys.getdefaultencoding():
2837
bzrlib.trace.warning(
2838
'Plugin "%s" tried to reset default encoding to: %s', name,
2839
sys.getdefaultencoding())
2841
sys.setdefaultencoding(default_encoding)
2845
def multiply_tests_from_modules(module_name_list, scenario_iter):
2846
"""Adapt all tests in some given modules to given scenarios.
2848
This is the recommended public interface for test parameterization.
2849
Typically the test_suite() method for a per-implementation test
2850
suite will call multiply_tests_from_modules and return the
2853
:param module_name_list: List of fully-qualified names of test
2855
:param scenario_iter: Iterable of pairs of (scenario_name,
2856
scenario_param_dict).
2858
This returns a new TestSuite containing the cross product of
2859
all the tests in all the modules, each repeated for each scenario.
2860
Each test is adapted by adding the scenario name at the end
2861
of its name, and updating the test object's __dict__ with the
2862
scenario_param_dict.
2864
>>> r = multiply_tests_from_modules(
2865
... ['bzrlib.tests.test_sampler'],
2866
... [('one', dict(param=1)),
2867
... ('two', dict(param=2))])
2868
>>> tests = list(iter_suite_tests(r))
2872
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2878
loader = TestLoader()
2880
adapter = TestScenarioApplier()
2881
adapter.scenarios = list(scenario_iter)
2882
adapt_modules(module_name_list, adapter, loader, suite)
2886
def multiply_scenarios(scenarios_left, scenarios_right):
2887
"""Multiply two sets of scenarios.
2889
:returns: the cartesian product of the two sets of scenarios, that is
2890
a scenario for every possible combination of a left scenario and a
2894
('%s,%s' % (left_name, right_name),
2895
dict(left_dict.items() + right_dict.items()))
2896
for left_name, left_dict in scenarios_left
2897
for right_name, right_dict in scenarios_right]
2901
def adapt_modules(mods_list, adapter, loader, suite):
2902
"""Adapt the modules in mods_list using adapter and add to suite."""
2903
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2904
suite.addTests(adapter.adapt(test))
2907
def adapt_tests(tests_list, adapter, loader, suite):
2908
"""Adapt the tests in tests_list using adapter and add to suite."""
2909
for test in tests_list:
2910
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2913
def _rmtree_temp_dir(dirname):
2914
# If LANG=C we probably have created some bogus paths
2915
# which rmtree(unicode) will fail to delete
2916
# so make sure we are using rmtree(str) to delete everything
2917
# except on win32, where rmtree(str) will fail
2918
# since it doesn't have the property of byte-stream paths
2919
# (they are either ascii or mbcs)
2920
if sys.platform == 'win32':
2921
# make sure we are using the unicode win32 api
2922
dirname = unicode(dirname)
2924
dirname = dirname.encode(sys.getfilesystemencoding())
2926
osutils.rmtree(dirname)
2928
if sys.platform == 'win32' and e.errno == errno.EACCES:
2929
sys.stderr.write(('Permission denied: '
2930
'unable to remove testing dir '
2931
'%s\n' % os.path.basename(dirname)))
2936
class Feature(object):
2937
"""An operating system Feature."""
2940
self._available = None
2942
def available(self):
2943
"""Is the feature available?
2945
:return: True if the feature is available.
2947
if self._available is None:
2948
self._available = self._probe()
2949
return self._available
2952
"""Implement this method in concrete features.
2954
:return: True if the feature is available.
2956
raise NotImplementedError
2959
if getattr(self, 'feature_name', None):
2960
return self.feature_name()
2961
return self.__class__.__name__
2964
class _SymlinkFeature(Feature):
2967
return osutils.has_symlinks()
2969
def feature_name(self):
2972
SymlinkFeature = _SymlinkFeature()
2975
class _HardlinkFeature(Feature):
2978
return osutils.has_hardlinks()
2980
def feature_name(self):
2983
HardlinkFeature = _HardlinkFeature()
2986
class _OsFifoFeature(Feature):
2989
return getattr(os, 'mkfifo', None)
2991
def feature_name(self):
2992
return 'filesystem fifos'
2994
OsFifoFeature = _OsFifoFeature()
2997
class TestScenarioApplier(object):
2998
"""A tool to apply scenarios to tests."""
3000
def adapt(self, test):
3001
"""Return a TestSuite containing a copy of test for each scenario."""
3002
result = unittest.TestSuite()
3003
for scenario in self.scenarios:
3004
result.addTest(self.adapt_test_to_scenario(test, scenario))
3007
def adapt_test_to_scenario(self, test, scenario):
3008
"""Copy test and apply scenario to it.
3010
:param test: A test to adapt.
3011
:param scenario: A tuple describing the scenarion.
3012
The first element of the tuple is the new test id.
3013
The second element is a dict containing attributes to set on the
3015
:return: The adapted test.
3017
from copy import deepcopy
3018
new_test = deepcopy(test)
3019
for name, value in scenario[1].items():
3020
setattr(new_test, name, value)
3021
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3022
new_test.id = lambda: new_id
3026
def probe_unicode_in_user_encoding():
3027
"""Try to encode several unicode strings to use in unicode-aware tests.
3028
Return first successfull match.
3030
:return: (unicode value, encoded plain string value) or (None, None)
3032
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3033
for uni_val in possible_vals:
3035
str_val = uni_val.encode(bzrlib.user_encoding)
3036
except UnicodeEncodeError:
3037
# Try a different character
3040
return uni_val, str_val
3044
def probe_bad_non_ascii(encoding):
3045
"""Try to find [bad] character with code [128..255]
3046
that cannot be decoded to unicode in some encoding.
3047
Return None if all non-ascii characters is valid
3050
for i in xrange(128, 256):
3053
char.decode(encoding)
3054
except UnicodeDecodeError:
3059
class _FTPServerFeature(Feature):
3060
"""Some tests want an FTP Server, check if one is available.
3062
Right now, the only way this is available is if 'medusa' is installed.
3063
http://www.amk.ca/python/code/medusa.html
3068
import bzrlib.tests.ftp_server
3073
def feature_name(self):
3076
FTPServerFeature = _FTPServerFeature()
3079
class _CaseInsensitiveFilesystemFeature(Feature):
3080
"""Check if underlined filesystem is case-insensitive
3081
(e.g. on Windows, Cygwin, MacOS)
3085
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3086
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3087
TestCaseWithMemoryTransport.TEST_ROOT = root
3089
root = TestCaseWithMemoryTransport.TEST_ROOT
3090
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3092
name_a = osutils.pathjoin(tdir, 'a')
3093
name_A = osutils.pathjoin(tdir, 'A')
3095
result = osutils.isdir(name_A)
3096
_rmtree_temp_dir(tdir)
3099
def feature_name(self):
3100
return 'case-insensitive filesystem'
3102
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
