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