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,
1231
'SSH_AUTH_SOCK': None,
1235
'https_proxy': None,
1236
'HTTPS_PROXY': None,
1241
# Nobody cares about these ones AFAIK. So far at
1242
# least. If you do (care), please update this comment
1246
'BZR_REMOTE_PATH': None,
1249
self.addCleanup(self._restoreEnvironment)
1250
for name, value in new_env.iteritems():
1251
self._captureVar(name, value)
1253
def _captureVar(self, name, newvalue):
1254
"""Set an environment variable, and reset it when finished."""
1255
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1257
def _restore_debug_flags(self):
1258
debug.debug_flags.clear()
1259
debug.debug_flags.update(self._preserved_debug_flags)
1261
def _restoreEnvironment(self):
1262
for name, value in self.__old_env.iteritems():
1263
osutils.set_or_unset_env(name, value)
1265
def _restoreHooks(self):
1266
for klass, hooks in self._preserved_hooks.items():
1267
setattr(klass, 'hooks', hooks)
1269
def knownFailure(self, reason):
1270
"""This test has failed for some known reason."""
1271
raise KnownFailure(reason)
1273
def run(self, result=None):
1274
if result is None: result = self.defaultTestResult()
1275
for feature in getattr(self, '_test_needs_features', []):
1276
if not feature.available():
1277
result.startTest(self)
1278
if getattr(result, 'addNotSupported', None):
1279
result.addNotSupported(self, feature)
1281
result.addSuccess(self)
1282
result.stopTest(self)
1284
return unittest.TestCase.run(self, result)
1288
unittest.TestCase.tearDown(self)
1290
def time(self, callable, *args, **kwargs):
1291
"""Run callable and accrue the time it takes to the benchmark time.
1293
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1294
this will cause lsprofile statistics to be gathered and stored in
1297
if self._benchtime is None:
1301
if not self._gather_lsprof_in_benchmarks:
1302
return callable(*args, **kwargs)
1304
# record this benchmark
1305
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1307
self._benchcalls.append(((callable, args, kwargs), stats))
1310
self._benchtime += time.time() - start
1312
def _runCleanups(self):
1313
"""Run registered cleanup functions.
1315
This should only be called from TestCase.tearDown.
1317
# TODO: Perhaps this should keep running cleanups even if
1318
# one of them fails?
1320
# Actually pop the cleanups from the list so tearDown running
1321
# twice is safe (this happens for skipped tests).
1322
while self._cleanups:
1323
self._cleanups.pop()()
1325
def log(self, *args):
1328
def _get_log(self, keep_log_file=False):
1329
"""Get the log from bzrlib.trace calls from this test.
1331
:param keep_log_file: When True, if the log is still a file on disk
1332
leave it as a file on disk. When False, if the log is still a file
1333
on disk, the log file is deleted and the log preserved as
1335
:return: A string containing the log.
1337
# flush the log file, to get all content
1339
bzrlib.trace._trace_file.flush()
1340
if self._log_contents:
1341
# XXX: this can hardly contain the content flushed above --vila
1343
return self._log_contents
1344
if self._log_file_name is not None:
1345
logfile = open(self._log_file_name)
1347
log_contents = logfile.read()
1350
if not keep_log_file:
1351
self._log_contents = log_contents
1353
os.remove(self._log_file_name)
1355
if sys.platform == 'win32' and e.errno == errno.EACCES:
1356
sys.stderr.write(('Unable to delete log file '
1357
' %r\n' % self._log_file_name))
1362
return "DELETED log file to reduce memory footprint"
1364
def requireFeature(self, feature):
1365
"""This test requires a specific feature is available.
1367
:raises UnavailableFeature: When feature is not available.
1369
if not feature.available():
1370
raise UnavailableFeature(feature)
1372
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1374
"""Run bazaar command line, splitting up a string command line."""
1375
if isinstance(args, basestring):
1376
# shlex don't understand unicode strings,
1377
# so args should be plain string (bialix 20070906)
1378
args = list(shlex.split(str(args)))
1379
return self._run_bzr_core(args, retcode=retcode,
1380
encoding=encoding, stdin=stdin, working_dir=working_dir,
1383
def _run_bzr_core(self, args, retcode, encoding, stdin,
1385
if encoding is None:
1386
encoding = bzrlib.user_encoding
1387
stdout = StringIOWrapper()
1388
stderr = StringIOWrapper()
1389
stdout.encoding = encoding
1390
stderr.encoding = encoding
1392
self.log('run bzr: %r', args)
1393
# FIXME: don't call into logging here
1394
handler = logging.StreamHandler(stderr)
1395
handler.setLevel(logging.INFO)
1396
logger = logging.getLogger('')
1397
logger.addHandler(handler)
1398
old_ui_factory = ui.ui_factory
1399
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1402
if working_dir is not None:
1403
cwd = osutils.getcwd()
1404
os.chdir(working_dir)
1407
result = self.apply_redirected(ui.ui_factory.stdin,
1409
bzrlib.commands.run_bzr_catch_user_errors,
1412
logger.removeHandler(handler)
1413
ui.ui_factory = old_ui_factory
1417
out = stdout.getvalue()
1418
err = stderr.getvalue()
1420
self.log('output:\n%r', out)
1422
self.log('errors:\n%r', err)
1423
if retcode is not None:
1424
self.assertEquals(retcode, result,
1425
message='Unexpected return code')
1428
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1429
working_dir=None, error_regexes=[], output_encoding=None):
1430
"""Invoke bzr, as if it were run from the command line.
1432
The argument list should not include the bzr program name - the
1433
first argument is normally the bzr command. Arguments may be
1434
passed in three ways:
1436
1- A list of strings, eg ["commit", "a"]. This is recommended
1437
when the command contains whitespace or metacharacters, or
1438
is built up at run time.
1440
2- A single string, eg "add a". This is the most convenient
1441
for hardcoded commands.
1443
This runs bzr through the interface that catches and reports
1444
errors, and with logging set to something approximating the
1445
default, so that error reporting can be checked.
1447
This should be the main method for tests that want to exercise the
1448
overall behavior of the bzr application (rather than a unit test
1449
or a functional test of the library.)
1451
This sends the stdout/stderr results into the test's log,
1452
where it may be useful for debugging. See also run_captured.
1454
:keyword stdin: A string to be used as stdin for the command.
1455
:keyword retcode: The status code the command should return;
1457
:keyword working_dir: The directory to run the command in
1458
:keyword error_regexes: A list of expected error messages. If
1459
specified they must be seen in the error output of the command.
1461
out, err = self._run_bzr_autosplit(
1466
working_dir=working_dir,
1468
for regex in error_regexes:
1469
self.assertContainsRe(err, regex)
1472
def run_bzr_error(self, error_regexes, *args, **kwargs):
1473
"""Run bzr, and check that stderr contains the supplied regexes
1475
:param error_regexes: Sequence of regular expressions which
1476
must each be found in the error output. The relative ordering
1478
:param args: command-line arguments for bzr
1479
:param kwargs: Keyword arguments which are interpreted by run_bzr
1480
This function changes the default value of retcode to be 3,
1481
since in most cases this is run when you expect bzr to fail.
1483
:return: (out, err) The actual output of running the command (in case
1484
you want to do more inspection)
1488
# Make sure that commit is failing because there is nothing to do
1489
self.run_bzr_error(['no changes to commit'],
1490
['commit', '-m', 'my commit comment'])
1491
# Make sure --strict is handling an unknown file, rather than
1492
# giving us the 'nothing to do' error
1493
self.build_tree(['unknown'])
1494
self.run_bzr_error(['Commit refused because there are unknown files'],
1495
['commit', --strict', '-m', 'my commit comment'])
1497
kwargs.setdefault('retcode', 3)
1498
kwargs['error_regexes'] = error_regexes
1499
out, err = self.run_bzr(*args, **kwargs)
1502
def run_bzr_subprocess(self, *args, **kwargs):
1503
"""Run bzr in a subprocess for testing.
1505
This starts a new Python interpreter and runs bzr in there.
1506
This should only be used for tests that have a justifiable need for
1507
this isolation: e.g. they are testing startup time, or signal
1508
handling, or early startup code, etc. Subprocess code can't be
1509
profiled or debugged so easily.
1511
:keyword retcode: The status code that is expected. Defaults to 0. If
1512
None is supplied, the status code is not checked.
1513
:keyword env_changes: A dictionary which lists changes to environment
1514
variables. A value of None will unset the env variable.
1515
The values must be strings. The change will only occur in the
1516
child, so you don't need to fix the environment after running.
1517
:keyword universal_newlines: Convert CRLF => LF
1518
:keyword allow_plugins: By default the subprocess is run with
1519
--no-plugins to ensure test reproducibility. Also, it is possible
1520
for system-wide plugins to create unexpected output on stderr,
1521
which can cause unnecessary test failures.
1523
env_changes = kwargs.get('env_changes', {})
1524
working_dir = kwargs.get('working_dir', None)
1525
allow_plugins = kwargs.get('allow_plugins', False)
1527
if isinstance(args[0], list):
1529
elif isinstance(args[0], basestring):
1530
args = list(shlex.split(args[0]))
1532
symbol_versioning.warn(zero_ninetyone %
1533
"passing varargs to run_bzr_subprocess",
1534
DeprecationWarning, stacklevel=3)
1535
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1536
working_dir=working_dir,
1537
allow_plugins=allow_plugins)
1538
# We distinguish between retcode=None and retcode not passed.
1539
supplied_retcode = kwargs.get('retcode', 0)
1540
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1541
universal_newlines=kwargs.get('universal_newlines', False),
1544
def start_bzr_subprocess(self, process_args, env_changes=None,
1545
skip_if_plan_to_signal=False,
1547
allow_plugins=False):
1548
"""Start bzr in a subprocess for testing.
1550
This starts a new Python interpreter and runs bzr in there.
1551
This should only be used for tests that have a justifiable need for
1552
this isolation: e.g. they are testing startup time, or signal
1553
handling, or early startup code, etc. Subprocess code can't be
1554
profiled or debugged so easily.
1556
:param process_args: a list of arguments to pass to the bzr executable,
1557
for example ``['--version']``.
1558
:param env_changes: A dictionary which lists changes to environment
1559
variables. A value of None will unset the env variable.
1560
The values must be strings. The change will only occur in the
1561
child, so you don't need to fix the environment after running.
1562
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1564
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1566
:returns: Popen object for the started process.
1568
if skip_if_plan_to_signal:
1569
if not getattr(os, 'kill', None):
1570
raise TestSkipped("os.kill not available.")
1572
if env_changes is None:
1576
def cleanup_environment():
1577
for env_var, value in env_changes.iteritems():
1578
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1580
def restore_environment():
1581
for env_var, value in old_env.iteritems():
1582
osutils.set_or_unset_env(env_var, value)
1584
bzr_path = self.get_bzr_path()
1587
if working_dir is not None:
1588
cwd = osutils.getcwd()
1589
os.chdir(working_dir)
1592
# win32 subprocess doesn't support preexec_fn
1593
# so we will avoid using it on all platforms, just to
1594
# make sure the code path is used, and we don't break on win32
1595
cleanup_environment()
1596
command = [sys.executable, bzr_path]
1597
if not allow_plugins:
1598
command.append('--no-plugins')
1599
command.extend(process_args)
1600
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1602
restore_environment()
1608
def _popen(self, *args, **kwargs):
1609
"""Place a call to Popen.
1611
Allows tests to override this method to intercept the calls made to
1612
Popen for introspection.
1614
return Popen(*args, **kwargs)
1616
def get_bzr_path(self):
1617
"""Return the path of the 'bzr' executable for this test suite."""
1618
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1619
if not os.path.isfile(bzr_path):
1620
# We are probably installed. Assume sys.argv is the right file
1621
bzr_path = sys.argv[0]
1624
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1625
universal_newlines=False, process_args=None):
1626
"""Finish the execution of process.
1628
:param process: the Popen object returned from start_bzr_subprocess.
1629
:param retcode: The status code that is expected. Defaults to 0. If
1630
None is supplied, the status code is not checked.
1631
:param send_signal: an optional signal to send to the process.
1632
:param universal_newlines: Convert CRLF => LF
1633
:returns: (stdout, stderr)
1635
if send_signal is not None:
1636
os.kill(process.pid, send_signal)
1637
out, err = process.communicate()
1639
if universal_newlines:
1640
out = out.replace('\r\n', '\n')
1641
err = err.replace('\r\n', '\n')
1643
if retcode is not None and retcode != process.returncode:
1644
if process_args is None:
1645
process_args = "(unknown args)"
1646
mutter('Output of bzr %s:\n%s', process_args, out)
1647
mutter('Error for bzr %s:\n%s', process_args, err)
1648
self.fail('Command bzr %s failed with retcode %s != %s'
1649
% (process_args, retcode, process.returncode))
1652
def check_inventory_shape(self, inv, shape):
1653
"""Compare an inventory to a list of expected names.
1655
Fail if they are not precisely equal.
1658
shape = list(shape) # copy
1659
for path, ie in inv.entries():
1660
name = path.replace('\\', '/')
1661
if ie.kind == 'directory':
1668
self.fail("expected paths not found in inventory: %r" % shape)
1670
self.fail("unexpected paths found in inventory: %r" % extras)
1672
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1673
a_callable=None, *args, **kwargs):
1674
"""Call callable with redirected std io pipes.
1676
Returns the return code."""
1677
if not callable(a_callable):
1678
raise ValueError("a_callable must be callable.")
1680
stdin = StringIO("")
1682
if getattr(self, "_log_file", None) is not None:
1683
stdout = self._log_file
1687
if getattr(self, "_log_file", None is not None):
1688
stderr = self._log_file
1691
real_stdin = sys.stdin
1692
real_stdout = sys.stdout
1693
real_stderr = sys.stderr
1698
return a_callable(*args, **kwargs)
1700
sys.stdout = real_stdout
1701
sys.stderr = real_stderr
1702
sys.stdin = real_stdin
1704
def reduceLockdirTimeout(self):
1705
"""Reduce the default lock timeout for the duration of the test, so that
1706
if LockContention occurs during a test, it does so quickly.
1708
Tests that expect to provoke LockContention errors should call this.
1710
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1712
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1713
self.addCleanup(resetTimeout)
1714
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1716
def make_utf8_encoded_stringio(self, encoding_type=None):
1717
"""Return a StringIOWrapper instance, that will encode Unicode
1720
if encoding_type is None:
1721
encoding_type = 'strict'
1723
output_encoding = 'utf-8'
1724
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1725
sio.encoding = output_encoding
1729
class TestCaseWithMemoryTransport(TestCase):
1730
"""Common test class for tests that do not need disk resources.
1732
Tests that need disk resources should derive from TestCaseWithTransport.
1734
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1736
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1737
a directory which does not exist. This serves to help ensure test isolation
1738
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1739
must exist. However, TestCaseWithMemoryTransport does not offer local
1740
file defaults for the transport in tests, nor does it obey the command line
1741
override, so tests that accidentally write to the common directory should
1744
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1745
a .bzr directory that stops us ascending higher into the filesystem.
1751
def __init__(self, methodName='runTest'):
1752
# allow test parameterization after test construction and before test
1753
# execution. Variables that the parameterizer sets need to be
1754
# ones that are not set by setUp, or setUp will trash them.
1755
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1756
self.vfs_transport_factory = default_transport
1757
self.transport_server = None
1758
self.transport_readonly_server = None
1759
self.__vfs_server = None
1761
def get_transport(self, relpath=None):
1762
"""Return a writeable transport.
1764
This transport is for the test scratch space relative to
1767
:param relpath: a path relative to the base url.
1769
t = get_transport(self.get_url(relpath))
1770
self.assertFalse(t.is_readonly())
1773
def get_readonly_transport(self, relpath=None):
1774
"""Return a readonly transport for the test scratch space
1776
This can be used to test that operations which should only need
1777
readonly access in fact do not try to write.
1779
:param relpath: a path relative to the base url.
1781
t = get_transport(self.get_readonly_url(relpath))
1782
self.assertTrue(t.is_readonly())
1785
def create_transport_readonly_server(self):
1786
"""Create a transport server from class defined at init.
1788
This is mostly a hook for daughter classes.
1790
return self.transport_readonly_server()
1792
def get_readonly_server(self):
1793
"""Get the server instance for the readonly transport
1795
This is useful for some tests with specific servers to do diagnostics.
1797
if self.__readonly_server is None:
1798
if self.transport_readonly_server is None:
1799
# readonly decorator requested
1800
# bring up the server
1801
self.__readonly_server = ReadonlyServer()
1802
self.__readonly_server.setUp(self.get_vfs_only_server())
1804
self.__readonly_server = self.create_transport_readonly_server()
1805
self.__readonly_server.setUp(self.get_vfs_only_server())
1806
self.addCleanup(self.__readonly_server.tearDown)
1807
return self.__readonly_server
1809
def get_readonly_url(self, relpath=None):
1810
"""Get a URL for the readonly transport.
1812
This will either be backed by '.' or a decorator to the transport
1813
used by self.get_url()
1814
relpath provides for clients to get a path relative to the base url.
1815
These should only be downwards relative, not upwards.
1817
base = self.get_readonly_server().get_url()
1818
return self._adjust_url(base, relpath)
1820
def get_vfs_only_server(self):
1821
"""Get the vfs only read/write server instance.
1823
This is useful for some tests with specific servers that need
1826
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1827
is no means to override it.
1829
if self.__vfs_server is None:
1830
self.__vfs_server = MemoryServer()
1831
self.__vfs_server.setUp()
1832
self.addCleanup(self.__vfs_server.tearDown)
1833
return self.__vfs_server
1835
def get_server(self):
1836
"""Get the read/write server instance.
1838
This is useful for some tests with specific servers that need
1841
This is built from the self.transport_server factory. If that is None,
1842
then the self.get_vfs_server is returned.
1844
if self.__server is None:
1845
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1846
return self.get_vfs_only_server()
1848
# bring up a decorated means of access to the vfs only server.
1849
self.__server = self.transport_server()
1851
self.__server.setUp(self.get_vfs_only_server())
1852
except TypeError, e:
1853
# This should never happen; the try:Except here is to assist
1854
# developers having to update code rather than seeing an
1855
# uninformative TypeError.
1856
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1857
self.addCleanup(self.__server.tearDown)
1858
return self.__server
1860
def _adjust_url(self, base, relpath):
1861
"""Get a URL (or maybe a path) for the readwrite transport.
1863
This will either be backed by '.' or to an equivalent non-file based
1865
relpath provides for clients to get a path relative to the base url.
1866
These should only be downwards relative, not upwards.
1868
if relpath is not None and relpath != '.':
1869
if not base.endswith('/'):
1871
# XXX: Really base should be a url; we did after all call
1872
# get_url()! But sometimes it's just a path (from
1873
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1874
# to a non-escaped local path.
1875
if base.startswith('./') or base.startswith('/'):
1878
base += urlutils.escape(relpath)
1881
def get_url(self, relpath=None):
1882
"""Get a URL (or maybe a path) for the readwrite transport.
1884
This will either be backed by '.' or to an equivalent non-file based
1886
relpath provides for clients to get a path relative to the base url.
1887
These should only be downwards relative, not upwards.
1889
base = self.get_server().get_url()
1890
return self._adjust_url(base, relpath)
1892
def get_vfs_only_url(self, relpath=None):
1893
"""Get a URL (or maybe a path for the plain old vfs transport.
1895
This will never be a smart protocol. It always has all the
1896
capabilities of the local filesystem, but it might actually be a
1897
MemoryTransport or some other similar virtual filesystem.
1899
This is the backing transport (if any) of the server returned by
1900
get_url and get_readonly_url.
1902
:param relpath: provides for clients to get a path relative to the base
1903
url. These should only be downwards relative, not upwards.
1906
base = self.get_vfs_only_server().get_url()
1907
return self._adjust_url(base, relpath)
1909
def _create_safety_net(self):
1910
"""Make a fake bzr directory.
1912
This prevents any tests propagating up onto the TEST_ROOT directory's
1915
root = TestCaseWithMemoryTransport.TEST_ROOT
1916
bzrdir.BzrDir.create_standalone_workingtree(root)
1918
def _check_safety_net(self):
1919
"""Check that the safety .bzr directory have not been touched.
1921
_make_test_root have created a .bzr directory to prevent tests from
1922
propagating. This method ensures than a test did not leaked.
1924
root = TestCaseWithMemoryTransport.TEST_ROOT
1925
wt = workingtree.WorkingTree.open(root)
1926
last_rev = wt.last_revision()
1927
if last_rev != 'null:':
1928
# The current test have modified the /bzr directory, we need to
1929
# recreate a new one or all the followng tests will fail.
1930
# If you need to inspect its content uncomment the following line
1931
# import pdb; pdb.set_trace()
1932
_rmtree_temp_dir(root + '/.bzr')
1933
self._create_safety_net()
1934
raise AssertionError('%s/.bzr should not be modified' % root)
1936
def _make_test_root(self):
1937
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1938
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1939
TestCaseWithMemoryTransport.TEST_ROOT = root
1941
self._create_safety_net()
1943
# The same directory is used by all tests, and we're not
1944
# specifically told when all tests are finished. This will do.
1945
atexit.register(_rmtree_temp_dir, root)
1947
self.addCleanup(self._check_safety_net)
1949
def makeAndChdirToTestDir(self):
1950
"""Create a temporary directories for this one test.
1952
This must set self.test_home_dir and self.test_dir and chdir to
1955
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1957
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1958
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1959
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1961
def make_branch(self, relpath, format=None):
1962
"""Create a branch on the transport at relpath."""
1963
repo = self.make_repository(relpath, format=format)
1964
return repo.bzrdir.create_branch()
1966
def make_bzrdir(self, relpath, format=None):
1968
# might be a relative or absolute path
1969
maybe_a_url = self.get_url(relpath)
1970
segments = maybe_a_url.rsplit('/', 1)
1971
t = get_transport(maybe_a_url)
1972
if len(segments) > 1 and segments[-1] not in ('', '.'):
1976
if isinstance(format, basestring):
1977
format = bzrdir.format_registry.make_bzrdir(format)
1978
return format.initialize_on_transport(t)
1979
except errors.UninitializableFormat:
1980
raise TestSkipped("Format %s is not initializable." % format)
1982
def make_repository(self, relpath, shared=False, format=None):
1983
"""Create a repository on our default transport at relpath.
1985
Note that relpath must be a relative path, not a full url.
1987
# FIXME: If you create a remoterepository this returns the underlying
1988
# real format, which is incorrect. Actually we should make sure that
1989
# RemoteBzrDir returns a RemoteRepository.
1990
# maybe mbp 20070410
1991
made_control = self.make_bzrdir(relpath, format=format)
1992
return made_control.create_repository(shared=shared)
1994
def make_branch_and_memory_tree(self, relpath, format=None):
1995
"""Create a branch on the default transport and a MemoryTree for it."""
1996
b = self.make_branch(relpath, format=format)
1997
return memorytree.MemoryTree.create_on_branch(b)
1999
def overrideEnvironmentForTesting(self):
2000
os.environ['HOME'] = self.test_home_dir
2001
os.environ['BZR_HOME'] = self.test_home_dir
2004
super(TestCaseWithMemoryTransport, self).setUp()
2005
self._make_test_root()
2006
_currentdir = os.getcwdu()
2007
def _leaveDirectory():
2008
os.chdir(_currentdir)
2009
self.addCleanup(_leaveDirectory)
2010
self.makeAndChdirToTestDir()
2011
self.overrideEnvironmentForTesting()
2012
self.__readonly_server = None
2013
self.__server = None
2014
self.reduceLockdirTimeout()
2017
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2018
"""Derived class that runs a test within a temporary directory.
2020
This is useful for tests that need to create a branch, etc.
2022
The directory is created in a slightly complex way: for each
2023
Python invocation, a new temporary top-level directory is created.
2024
All test cases create their own directory within that. If the
2025
tests complete successfully, the directory is removed.
2027
:ivar test_base_dir: The path of the top-level directory for this
2028
test, which contains a home directory and a work directory.
2030
:ivar test_home_dir: An initially empty directory under test_base_dir
2031
which is used as $HOME for this test.
2033
:ivar test_dir: A directory under test_base_dir used as the current
2034
directory when the test proper is run.
2037
OVERRIDE_PYTHON = 'python'
2039
def check_file_contents(self, filename, expect):
2040
self.log("check contents of file %s" % filename)
2041
contents = file(filename, 'r').read()
2042
if contents != expect:
2043
self.log("expected: %r" % expect)
2044
self.log("actually: %r" % contents)
2045
self.fail("contents of %s not as expected" % filename)
2047
def makeAndChdirToTestDir(self):
2048
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2050
For TestCaseInTempDir we create a temporary directory based on the test
2051
name and then create two subdirs - test and home under it.
2053
# create a directory within the top level test directory
2054
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2055
# now create test and home directories within this dir
2056
self.test_base_dir = candidate_dir
2057
self.test_home_dir = self.test_base_dir + '/home'
2058
os.mkdir(self.test_home_dir)
2059
self.test_dir = self.test_base_dir + '/work'
2060
os.mkdir(self.test_dir)
2061
os.chdir(self.test_dir)
2062
# put name of test inside
2063
f = file(self.test_base_dir + '/name', 'w')
2068
self.addCleanup(self.deleteTestDir)
2070
def deleteTestDir(self):
2071
os.chdir(self.TEST_ROOT)
2072
_rmtree_temp_dir(self.test_base_dir)
2074
def build_tree(self, shape, line_endings='binary', transport=None):
2075
"""Build a test tree according to a pattern.
2077
shape is a sequence of file specifications. If the final
2078
character is '/', a directory is created.
2080
This assumes that all the elements in the tree being built are new.
2082
This doesn't add anything to a branch.
2084
:type shape: list or tuple.
2085
:param line_endings: Either 'binary' or 'native'
2086
in binary mode, exact contents are written in native mode, the
2087
line endings match the default platform endings.
2088
:param transport: A transport to write to, for building trees on VFS's.
2089
If the transport is readonly or None, "." is opened automatically.
2092
if type(shape) not in (list, tuple):
2093
raise AssertionError("Parameter 'shape' should be "
2094
"a list or a tuple. Got %r instead" % (shape,))
2095
# It's OK to just create them using forward slashes on windows.
2096
if transport is None or transport.is_readonly():
2097
transport = get_transport(".")
2099
self.assert_(isinstance(name, basestring))
2101
transport.mkdir(urlutils.escape(name[:-1]))
2103
if line_endings == 'binary':
2105
elif line_endings == 'native':
2108
raise errors.BzrError(
2109
'Invalid line ending request %r' % line_endings)
2110
content = "contents of %s%s" % (name.encode('utf-8'), end)
2111
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2113
def build_tree_contents(self, shape):
2114
build_tree_contents(shape)
2116
def assertInWorkingTree(self, path, root_path='.', tree=None):
2117
"""Assert whether path or paths are in the WorkingTree"""
2119
tree = workingtree.WorkingTree.open(root_path)
2120
if not isinstance(path, basestring):
2122
self.assertInWorkingTree(p,tree=tree)
2124
self.assertIsNot(tree.path2id(path), None,
2125
path+' not in working tree.')
2127
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2128
"""Assert whether path or paths are not in the WorkingTree"""
2130
tree = workingtree.WorkingTree.open(root_path)
2131
if not isinstance(path, basestring):
2133
self.assertNotInWorkingTree(p,tree=tree)
2135
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2138
class TestCaseWithTransport(TestCaseInTempDir):
2139
"""A test case that provides get_url and get_readonly_url facilities.
2141
These back onto two transport servers, one for readonly access and one for
2144
If no explicit class is provided for readonly access, a
2145
ReadonlyTransportDecorator is used instead which allows the use of non disk
2146
based read write transports.
2148
If an explicit class is provided for readonly access, that server and the
2149
readwrite one must both define get_url() as resolving to os.getcwd().
2152
def get_vfs_only_server(self):
2153
"""See TestCaseWithMemoryTransport.
2155
This is useful for some tests with specific servers that need
2158
if self.__vfs_server is None:
2159
self.__vfs_server = self.vfs_transport_factory()
2160
self.__vfs_server.setUp()
2161
self.addCleanup(self.__vfs_server.tearDown)
2162
return self.__vfs_server
2164
def make_branch_and_tree(self, relpath, format=None):
2165
"""Create a branch on the transport and a tree locally.
2167
If the transport is not a LocalTransport, the Tree can't be created on
2168
the transport. In that case if the vfs_transport_factory is
2169
LocalURLServer the working tree is created in the local
2170
directory backing the transport, and the returned tree's branch and
2171
repository will also be accessed locally. Otherwise a lightweight
2172
checkout is created and returned.
2174
:param format: The BzrDirFormat.
2175
:returns: the WorkingTree.
2177
# TODO: always use the local disk path for the working tree,
2178
# this obviously requires a format that supports branch references
2179
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2181
b = self.make_branch(relpath, format=format)
2183
return b.bzrdir.create_workingtree()
2184
except errors.NotLocalUrl:
2185
# We can only make working trees locally at the moment. If the
2186
# transport can't support them, then we keep the non-disk-backed
2187
# branch and create a local checkout.
2188
if self.vfs_transport_factory is LocalURLServer:
2189
# the branch is colocated on disk, we cannot create a checkout.
2190
# hopefully callers will expect this.
2191
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2192
return local_controldir.create_workingtree()
2194
return b.create_checkout(relpath, lightweight=True)
2196
def assertIsDirectory(self, relpath, transport):
2197
"""Assert that relpath within transport is a directory.
2199
This may not be possible on all transports; in that case it propagates
2200
a TransportNotPossible.
2203
mode = transport.stat(relpath).st_mode
2204
except errors.NoSuchFile:
2205
self.fail("path %s is not a directory; no such file"
2207
if not stat.S_ISDIR(mode):
2208
self.fail("path %s is not a directory; has mode %#o"
2211
def assertTreesEqual(self, left, right):
2212
"""Check that left and right have the same content and properties."""
2213
# we use a tree delta to check for equality of the content, and we
2214
# manually check for equality of other things such as the parents list.
2215
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2216
differences = left.changes_from(right)
2217
self.assertFalse(differences.has_changed(),
2218
"Trees %r and %r are different: %r" % (left, right, differences))
2221
super(TestCaseWithTransport, self).setUp()
2222
self.__vfs_server = None
2225
class ChrootedTestCase(TestCaseWithTransport):
2226
"""A support class that provides readonly urls outside the local namespace.
2228
This is done by checking if self.transport_server is a MemoryServer. if it
2229
is then we are chrooted already, if it is not then an HttpServer is used
2232
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2233
be used without needed to redo it when a different
2234
subclass is in use ?
2238
super(ChrootedTestCase, self).setUp()
2239
if not self.vfs_transport_factory == MemoryServer:
2240
self.transport_readonly_server = HttpServer
2243
def condition_id_re(pattern):
2244
"""Create a condition filter which performs a re check on a test's id.
2246
:param pattern: A regular expression string.
2247
:return: A callable that returns True if the re matches.
2249
filter_re = re.compile(pattern)
2250
def condition(test):
2252
return filter_re.search(test_id)
2256
def condition_isinstance(klass_or_klass_list):
2257
"""Create a condition filter which returns isinstance(param, klass).
2259
:return: A callable which when called with one parameter obj return the
2260
result of isinstance(obj, klass_or_klass_list).
2263
return isinstance(obj, klass_or_klass_list)
2267
def condition_id_in_list(id_list):
2268
"""Create a condition filter which verify that test's id in a list.
2270
:param name: A TestIdList object.
2271
:return: A callable that returns True if the test's id appears in the list.
2273
def condition(test):
2274
return id_list.test_in(test.id())
2278
def exclude_tests_by_condition(suite, condition):
2279
"""Create a test suite which excludes some tests from suite.
2281
:param suite: The suite to get tests from.
2282
:param condition: A callable whose result evaluates True when called with a
2283
test case which should be excluded from the result.
2284
:return: A suite which contains the tests found in suite that fail
2288
for test in iter_suite_tests(suite):
2289
if not condition(test):
2291
return TestUtil.TestSuite(result)
2294
def filter_suite_by_condition(suite, condition):
2295
"""Create a test suite by filtering another one.
2297
:param suite: The source suite.
2298
:param condition: A callable whose result evaluates True when called with a
2299
test case which should be included in the result.
2300
:return: A suite which contains the tests found in suite that pass
2304
for test in iter_suite_tests(suite):
2307
return TestUtil.TestSuite(result)
2310
def filter_suite_by_re(suite, pattern, exclude_pattern=DEPRECATED_PARAMETER,
2311
random_order=DEPRECATED_PARAMETER):
2312
"""Create a test suite by filtering another one.
2314
:param suite: the source suite
2315
:param pattern: pattern that names must match
2316
:param exclude_pattern: A pattern that names must not match. This parameter
2317
is deprecated as of bzrlib 1.0. Please use the separate function
2318
exclude_tests_by_re instead.
2319
:param random_order: If True, tests in the new suite will be put in
2320
random order. This parameter is deprecated as of bzrlib 1.0. Please
2321
use the separate function randomize_suite instead.
2322
:returns: the newly created suite
2324
if deprecated_passed(exclude_pattern):
2325
symbol_versioning.warn(
2326
one_zero % "passing exclude_pattern to filter_suite_by_re",
2327
DeprecationWarning, stacklevel=2)
2328
if exclude_pattern is not None:
2329
suite = exclude_tests_by_re(suite, exclude_pattern)
2330
condition = condition_id_re(pattern)
2331
result_suite = filter_suite_by_condition(suite, condition)
2332
if deprecated_passed(random_order):
2333
symbol_versioning.warn(
2334
one_zero % "passing random_order to filter_suite_by_re",
2335
DeprecationWarning, stacklevel=2)
2337
result_suite = randomize_suite(result_suite)
2341
def filter_suite_by_id_list(suite, test_id_list):
2342
"""Create a test suite by filtering another one.
2344
:param suite: The source suite.
2345
:param test_id_list: A list of the test ids to keep as strings.
2346
:returns: the newly created suite
2348
condition = condition_id_in_list(test_id_list)
2349
result_suite = filter_suite_by_condition(suite, condition)
2353
def exclude_tests_by_re(suite, pattern):
2354
"""Create a test suite which excludes some tests from suite.
2356
:param suite: The suite to get tests from.
2357
:param pattern: A regular expression string. Test ids that match this
2358
pattern will be excluded from the result.
2359
:return: A TestSuite that contains all the tests from suite without the
2360
tests that matched pattern. The order of tests is the same as it was in
2363
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2366
def preserve_input(something):
2367
"""A helper for performing test suite transformation chains.
2369
:param something: Anything you want to preserve.
2375
def randomize_suite(suite):
2376
"""Return a new TestSuite with suite's tests in random order.
2378
The tests in the input suite are flattened into a single suite in order to
2379
accomplish this. Any nested TestSuites are removed to provide global
2382
tests = list(iter_suite_tests(suite))
2383
random.shuffle(tests)
2384
return TestUtil.TestSuite(tests)
2387
@deprecated_function(one_zero)
2388
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2389
random_order=False, append_rest=True):
2390
"""DEPRECATED: Create a test suite by sorting another one.
2392
This method has been decomposed into separate helper methods that should be
2394
- filter_suite_by_re
2395
- exclude_tests_by_re
2399
:param suite: the source suite
2400
:param pattern: pattern that names must match in order to go
2401
first in the new suite
2402
:param exclude_pattern: pattern that names must not match, if any
2403
:param random_order: if True, tests in the new suite will be put in
2404
random order (with all tests matching pattern
2406
:param append_rest: if False, pattern is a strict filter and not
2407
just an ordering directive
2408
:returns: the newly created suite
2410
if exclude_pattern is not None:
2411
suite = exclude_tests_by_re(suite, exclude_pattern)
2413
order_changer = randomize_suite
2415
order_changer = preserve_input
2417
suites = map(order_changer, split_suite_by_re(suite, pattern))
2418
return TestUtil.TestSuite(suites)
2420
return order_changer(filter_suite_by_re(suite, pattern))
2423
def split_suite_by_re(suite, pattern):
2424
"""Split a test suite into two by a regular expression.
2426
:param suite: The suite to split.
2427
:param pattern: A regular expression string. Test ids that match this
2428
pattern will be in the first test suite returned, and the others in the
2429
second test suite returned.
2430
:return: A tuple of two test suites, where the first contains tests from
2431
suite matching pattern, and the second contains the remainder from
2432
suite. The order within each output suite is the same as it was in
2437
filter_re = re.compile(pattern)
2438
for test in iter_suite_tests(suite):
2440
if filter_re.search(test_id):
2441
matched.append(test)
2443
did_not_match.append(test)
2444
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2447
def run_suite(suite, name='test', verbose=False, pattern=".*",
2448
stop_on_failure=False,
2449
transport=None, lsprof_timed=None, bench_history=None,
2450
matching_tests_first=None,
2453
exclude_pattern=None,
2455
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2460
runner = TextTestRunner(stream=sys.stdout,
2462
verbosity=verbosity,
2463
bench_history=bench_history,
2464
list_only=list_only,
2466
runner.stop_on_failure=stop_on_failure
2467
# Initialise the random number generator and display the seed used.
2468
# We convert the seed to a long to make it reuseable across invocations.
2469
random_order = False
2470
if random_seed is not None:
2472
if random_seed == "now":
2473
random_seed = long(time.time())
2475
# Convert the seed to a long if we can
2477
random_seed = long(random_seed)
2480
runner.stream.writeln("Randomizing test order using seed %s\n" %
2482
random.seed(random_seed)
2483
# Customise the list of tests if requested
2484
if exclude_pattern is not None:
2485
suite = exclude_tests_by_re(suite, exclude_pattern)
2487
order_changer = randomize_suite
2489
order_changer = preserve_input
2490
if pattern != '.*' or random_order:
2491
if matching_tests_first:
2492
suites = map(order_changer, split_suite_by_re(suite, pattern))
2493
suite = TestUtil.TestSuite(suites)
2495
suite = order_changer(filter_suite_by_re(suite, pattern))
2497
result = runner.run(suite)
2500
return result.wasStrictlySuccessful()
2502
return result.wasSuccessful()
2505
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2507
test_suite_factory=None,
2510
matching_tests_first=None,
2513
exclude_pattern=None,
2517
"""Run the whole test suite under the enhanced runner"""
2518
# XXX: Very ugly way to do this...
2519
# Disable warning about old formats because we don't want it to disturb
2520
# any blackbox tests.
2521
from bzrlib import repository
2522
repository._deprecation_warning_done = True
2524
global default_transport
2525
if transport is None:
2526
transport = default_transport
2527
old_transport = default_transport
2528
default_transport = transport
2530
if load_list is None:
2533
keep_only = load_test_id_list(load_list)
2534
if test_suite_factory is None:
2535
suite = test_suite(keep_only)
2537
suite = test_suite_factory()
2538
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2539
stop_on_failure=stop_on_failure,
2540
transport=transport,
2541
lsprof_timed=lsprof_timed,
2542
bench_history=bench_history,
2543
matching_tests_first=matching_tests_first,
2544
list_only=list_only,
2545
random_seed=random_seed,
2546
exclude_pattern=exclude_pattern,
2549
default_transport = old_transport
2552
def load_test_id_list(file_name):
2553
"""Load a test id list from a text file.
2555
The format is one test id by line. No special care is taken to impose
2556
strict rules, these test ids are used to filter the test suite so a test id
2557
that do not match an existing test will do no harm. This allows user to add
2558
comments, leave blank lines, etc.
2562
ftest = open(file_name, 'rt')
2564
if e.errno != errno.ENOENT:
2567
raise errors.NoSuchFile(file_name)
2569
for test_name in ftest.readlines():
2570
test_list.append(test_name.strip())
2575
class TestIdList(object):
2576
"""Test id list to filter a test suite.
2578
Relying on the assumption that test ids are built as:
2579
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2580
notation, this class offers methods to :
2581
- avoid building a test suite for modules not refered to in the test list,
2582
- keep only the tests listed from the module test suite.
2585
def __init__(self, test_id_list):
2586
# When a test suite needs to be filtered against us we compare test ids
2587
# for equality, so a simple dict offers a quick and simple solution.
2588
self.tests = dict().fromkeys(test_id_list, True)
2590
# While unittest.TestCase have ids like:
2591
# <module>.<class>.<method>[(<param+)],
2592
# doctest.DocTestCase can have ids like:
2595
# <module>.<function>
2596
# <module>.<class>.<method>
2598
# Since we can't predict a test class from its name only, we settle on
2599
# a simple constraint: a test id always begins with its module name.
2602
for test_id in test_id_list:
2603
parts = test_id.split('.')
2604
mod_name = parts.pop(0)
2605
modules[mod_name] = True
2607
mod_name += '.' + part
2608
modules[mod_name] = True
2609
self.modules = modules
2611
def is_module_name_used(self, module_name):
2612
"""Is there tests for the module or one of its sub modules."""
2613
return self.modules.has_key(module_name)
2615
def test_in(self, test_id):
2616
return self.tests.has_key(test_id)
2619
def test_suite(keep_only=None):
2620
"""Build and return TestSuite for the whole of bzrlib.
2622
:param keep_only: A list of test ids limiting the suite returned.
2624
This function can be replaced if you need to change the default test
2625
suite on a global basis, but it is not encouraged.
2628
'bzrlib.util.tests.test_bencode',
2629
'bzrlib.tests.test__dirstate_helpers',
2630
'bzrlib.tests.test_ancestry',
2631
'bzrlib.tests.test_annotate',
2632
'bzrlib.tests.test_api',
2633
'bzrlib.tests.test_atomicfile',
2634
'bzrlib.tests.test_bad_files',
2635
'bzrlib.tests.test_bisect_multi',
2636
'bzrlib.tests.test_branch',
2637
'bzrlib.tests.test_branchbuilder',
2638
'bzrlib.tests.test_bugtracker',
2639
'bzrlib.tests.test_bundle',
2640
'bzrlib.tests.test_bzrdir',
2641
'bzrlib.tests.test_cache_utf8',
2642
'bzrlib.tests.test_commands',
2643
'bzrlib.tests.test_commit',
2644
'bzrlib.tests.test_commit_merge',
2645
'bzrlib.tests.test_config',
2646
'bzrlib.tests.test_conflicts',
2647
'bzrlib.tests.test_counted_lock',
2648
'bzrlib.tests.test_decorators',
2649
'bzrlib.tests.test_delta',
2650
'bzrlib.tests.test_deprecated_graph',
2651
'bzrlib.tests.test_diff',
2652
'bzrlib.tests.test_dirstate',
2653
'bzrlib.tests.test_email_message',
2654
'bzrlib.tests.test_errors',
2655
'bzrlib.tests.test_escaped_store',
2656
'bzrlib.tests.test_extract',
2657
'bzrlib.tests.test_fetch',
2658
'bzrlib.tests.test_ftp_transport',
2659
'bzrlib.tests.test_generate_docs',
2660
'bzrlib.tests.test_generate_ids',
2661
'bzrlib.tests.test_globbing',
2662
'bzrlib.tests.test_gpg',
2663
'bzrlib.tests.test_graph',
2664
'bzrlib.tests.test_hashcache',
2665
'bzrlib.tests.test_help',
2666
'bzrlib.tests.test_hooks',
2667
'bzrlib.tests.test_http',
2668
'bzrlib.tests.test_http_implementations',
2669
'bzrlib.tests.test_http_response',
2670
'bzrlib.tests.test_https_ca_bundle',
2671
'bzrlib.tests.test_identitymap',
2672
'bzrlib.tests.test_ignores',
2673
'bzrlib.tests.test_index',
2674
'bzrlib.tests.test_info',
2675
'bzrlib.tests.test_inv',
2676
'bzrlib.tests.test_knit',
2677
'bzrlib.tests.test_lazy_import',
2678
'bzrlib.tests.test_lazy_regex',
2679
'bzrlib.tests.test_lockdir',
2680
'bzrlib.tests.test_lockable_files',
2681
'bzrlib.tests.test_log',
2682
'bzrlib.tests.test_lsprof',
2683
'bzrlib.tests.test_lru_cache',
2684
'bzrlib.tests.test_mail_client',
2685
'bzrlib.tests.test_memorytree',
2686
'bzrlib.tests.test_merge',
2687
'bzrlib.tests.test_merge3',
2688
'bzrlib.tests.test_merge_core',
2689
'bzrlib.tests.test_merge_directive',
2690
'bzrlib.tests.test_missing',
2691
'bzrlib.tests.test_msgeditor',
2692
'bzrlib.tests.test_multiparent',
2693
'bzrlib.tests.test_nonascii',
2694
'bzrlib.tests.test_options',
2695
'bzrlib.tests.test_osutils',
2696
'bzrlib.tests.test_osutils_encodings',
2697
'bzrlib.tests.test_pack',
2698
'bzrlib.tests.test_patch',
2699
'bzrlib.tests.test_patches',
2700
'bzrlib.tests.test_permissions',
2701
'bzrlib.tests.test_plugins',
2702
'bzrlib.tests.test_progress',
2703
'bzrlib.tests.test_reconfigure',
2704
'bzrlib.tests.test_reconcile',
2705
'bzrlib.tests.test_registry',
2706
'bzrlib.tests.test_remote',
2707
'bzrlib.tests.test_repository',
2708
'bzrlib.tests.test_revert',
2709
'bzrlib.tests.test_revision',
2710
'bzrlib.tests.test_revisionnamespaces',
2711
'bzrlib.tests.test_revisiontree',
2712
'bzrlib.tests.test_rio',
2713
'bzrlib.tests.test_sampler',
2714
'bzrlib.tests.test_selftest',
2715
'bzrlib.tests.test_setup',
2716
'bzrlib.tests.test_sftp_transport',
2717
'bzrlib.tests.test_smart',
2718
'bzrlib.tests.test_smart_add',
2719
'bzrlib.tests.test_smart_transport',
2720
'bzrlib.tests.test_smtp_connection',
2721
'bzrlib.tests.test_source',
2722
'bzrlib.tests.test_ssh_transport',
2723
'bzrlib.tests.test_status',
2724
'bzrlib.tests.test_store',
2725
'bzrlib.tests.test_strace',
2726
'bzrlib.tests.test_subsume',
2727
'bzrlib.tests.test_switch',
2728
'bzrlib.tests.test_symbol_versioning',
2729
'bzrlib.tests.test_tag',
2730
'bzrlib.tests.test_testament',
2731
'bzrlib.tests.test_textfile',
2732
'bzrlib.tests.test_textmerge',
2733
'bzrlib.tests.test_timestamp',
2734
'bzrlib.tests.test_trace',
2735
'bzrlib.tests.test_transactions',
2736
'bzrlib.tests.test_transform',
2737
'bzrlib.tests.test_transport',
2738
'bzrlib.tests.test_tree',
2739
'bzrlib.tests.test_treebuilder',
2740
'bzrlib.tests.test_tsort',
2741
'bzrlib.tests.test_tuned_gzip',
2742
'bzrlib.tests.test_ui',
2743
'bzrlib.tests.test_upgrade',
2744
'bzrlib.tests.test_urlutils',
2745
'bzrlib.tests.test_versionedfile',
2746
'bzrlib.tests.test_version',
2747
'bzrlib.tests.test_version_info',
2748
'bzrlib.tests.test_weave',
2749
'bzrlib.tests.test_whitebox',
2750
'bzrlib.tests.test_win32utils',
2751
'bzrlib.tests.test_workingtree',
2752
'bzrlib.tests.test_workingtree_4',
2753
'bzrlib.tests.test_wsgi',
2754
'bzrlib.tests.test_xml',
2756
test_transport_implementations = [
2757
'bzrlib.tests.test_transport_implementations',
2758
'bzrlib.tests.test_read_bundle',
2760
suite = TestUtil.TestSuite()
2761
loader = TestUtil.TestLoader()
2763
if keep_only is not None:
2764
id_filter = TestIdList(keep_only)
2766
# modules building their suite with loadTestsFromModuleNames
2767
if keep_only is None:
2768
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2770
for mod in [m for m in testmod_names
2771
if id_filter.is_module_name_used(m)]:
2772
mod_suite = loader.loadTestsFromModuleNames([mod])
2773
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2774
suite.addTest(mod_suite)
2776
# modules adapted for transport implementations
2777
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2778
adapter = TransportTestProviderAdapter()
2779
if keep_only is None:
2780
adapt_modules(test_transport_implementations, adapter, loader, suite)
2782
for mod in [m for m in test_transport_implementations
2783
if id_filter.is_module_name_used(m)]:
2784
mod_suite = TestUtil.TestSuite()
2785
adapt_modules([mod], adapter, loader, mod_suite)
2786
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2787
suite.addTest(mod_suite)
2789
# modules defining their own test_suite()
2790
for package in [p for p in packages_to_test()
2791
if (keep_only is None
2792
or id_filter.is_module_name_used(p.__name__))]:
2793
pack_suite = package.test_suite()
2794
if keep_only is not None:
2795
pack_suite = filter_suite_by_id_list(pack_suite, id_filter)
2796
suite.addTest(pack_suite)
2798
# XXX: MODULES_TO_TEST should be obsoleted ?
2799
for mod in [m for m in MODULES_TO_TEST
2800
if keep_only is None or id_filter.is_module_name_used(m)]:
2801
mod_suite = loader.loadTestsFromModule(mod)
2802
if keep_only is not None:
2803
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2804
suite.addTest(mod_suite)
2806
for mod in MODULES_TO_DOCTEST:
2808
doc_suite = doctest.DocTestSuite(mod)
2809
except ValueError, e:
2810
print '**failed to get doctest for: %s\n%s' % (mod, e)
2812
if keep_only is not None:
2813
# DocTests may use ids which doesn't contain the module name
2814
doc_suite = filter_suite_by_id_list(doc_suite, id_filter)
2815
suite.addTest(doc_suite)
2817
default_encoding = sys.getdefaultencoding()
2818
for name, plugin in [(n, p) for (n, p) in bzrlib.plugin.plugins().items()
2819
if (keep_only is None
2820
or id_filter.is_module_name_used(
2821
p.module.__name__))]:
2823
plugin_suite = plugin.test_suite()
2824
except ImportError, e:
2825
bzrlib.trace.warning(
2826
'Unable to test plugin "%s": %s', name, e)
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 _OsFifoFeature(Feature):
2975
return getattr(os, 'mkfifo', None)
2977
def feature_name(self):
2978
return 'filesystem fifos'
2980
OsFifoFeature = _OsFifoFeature()
2983
class TestScenarioApplier(object):
2984
"""A tool to apply scenarios to tests."""
2986
def adapt(self, test):
2987
"""Return a TestSuite containing a copy of test for each scenario."""
2988
result = unittest.TestSuite()
2989
for scenario in self.scenarios:
2990
result.addTest(self.adapt_test_to_scenario(test, scenario))
2993
def adapt_test_to_scenario(self, test, scenario):
2994
"""Copy test and apply scenario to it.
2996
:param test: A test to adapt.
2997
:param scenario: A tuple describing the scenarion.
2998
The first element of the tuple is the new test id.
2999
The second element is a dict containing attributes to set on the
3001
:return: The adapted test.
3003
from copy import deepcopy
3004
new_test = deepcopy(test)
3005
for name, value in scenario[1].items():
3006
setattr(new_test, name, value)
3007
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3008
new_test.id = lambda: new_id
3012
def probe_unicode_in_user_encoding():
3013
"""Try to encode several unicode strings to use in unicode-aware tests.
3014
Return first successfull match.
3016
:return: (unicode value, encoded plain string value) or (None, None)
3018
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3019
for uni_val in possible_vals:
3021
str_val = uni_val.encode(bzrlib.user_encoding)
3022
except UnicodeEncodeError:
3023
# Try a different character
3026
return uni_val, str_val
3030
def probe_bad_non_ascii(encoding):
3031
"""Try to find [bad] character with code [128..255]
3032
that cannot be decoded to unicode in some encoding.
3033
Return None if all non-ascii characters is valid
3036
for i in xrange(128, 256):
3039
char.decode(encoding)
3040
except UnicodeDecodeError:
3045
class _FTPServerFeature(Feature):
3046
"""Some tests want an FTP Server, check if one is available.
3048
Right now, the only way this is available is if 'medusa' is installed.
3049
http://www.amk.ca/python/code/medusa.html
3054
import bzrlib.tests.ftp_server
3059
def feature_name(self):
3062
FTPServerFeature = _FTPServerFeature()
3065
class _CaseInsensitiveFilesystemFeature(Feature):
3066
"""Check if underlined filesystem is case-insensitive
3067
(e.g. on Windows, Cygwin, MacOS)
3071
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3072
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3073
TestCaseWithMemoryTransport.TEST_ROOT = root
3075
root = TestCaseWithMemoryTransport.TEST_ROOT
3076
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3078
name_a = osutils.pathjoin(tdir, 'a')
3079
name_A = osutils.pathjoin(tdir, 'A')
3081
result = osutils.isdir(name_A)
3082
_rmtree_temp_dir(tdir)
3085
def feature_name(self):
3086
return 'case-insensitive filesystem'
3088
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
