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)
317
if getattr(test, '_log_contents', '') != '':
318
del test._log_contents
320
def _testConcluded(self, test):
321
"""Common code when a test has finished.
323
Called regardless of whether it succeded, failed, etc.
327
def _addKnownFailure(self, test, err):
328
self.known_failure_count += 1
329
self.report_known_failure(test, err)
331
def addNotSupported(self, test, feature):
332
"""The test will not be run because of a missing feature.
334
# this can be called in two different ways: it may be that the
335
# test started running, and then raised (through addError)
336
# UnavailableFeature. Alternatively this method can be called
337
# while probing for features before running the tests; in that
338
# case we will see startTest and stopTest, but the test will never
340
self.unsupported.setdefault(str(feature), 0)
341
self.unsupported[str(feature)] += 1
342
self.report_unsupported(test, feature)
344
def _addSkipped(self, test, skip_excinfo):
345
if isinstance(skip_excinfo[1], TestNotApplicable):
346
self.not_applicable_count += 1
347
self.report_not_applicable(test, skip_excinfo)
350
self.report_skip(test, skip_excinfo)
353
except KeyboardInterrupt:
356
self.addError(test, test._exc_info())
358
# seems best to treat this as success from point-of-view of unittest
359
# -- it actually does nothing so it barely matters :)
360
unittest.TestResult.addSuccess(self, test)
361
if getattr(test, '_log_contents', '') != '':
362
del test._log_contents
364
def printErrorList(self, flavour, errors):
365
for test, err in errors:
366
self.stream.writeln(self.separator1)
367
self.stream.write("%s: " % flavour)
368
self.stream.writeln(self.getDescription(test))
369
if getattr(test, '_get_log', None) is not None:
370
self.stream.write('\n')
372
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
373
self.stream.write('\n')
374
self.stream.write(test._get_log())
375
self.stream.write('\n')
377
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
378
self.stream.write('\n')
379
self.stream.writeln(self.separator2)
380
self.stream.writeln("%s" % err)
385
def report_cleaning_up(self):
388
def report_success(self, test):
391
def wasStrictlySuccessful(self):
392
if self.unsupported or self.known_failure_count:
394
return self.wasSuccessful()
397
class TextTestResult(ExtendedTestResult):
398
"""Displays progress and results of tests in text form"""
400
def __init__(self, stream, descriptions, verbosity,
405
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
406
bench_history, num_tests)
408
self.pb = self.ui.nested_progress_bar()
409
self._supplied_pb = False
412
self._supplied_pb = True
413
self.pb.show_pct = False
414
self.pb.show_spinner = False
415
self.pb.show_eta = False,
416
self.pb.show_count = False
417
self.pb.show_bar = False
419
def report_starting(self):
420
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
422
def _progress_prefix_text(self):
423
a = '[%d' % self.count
424
if self.num_tests is not None:
425
a +='/%d' % self.num_tests
426
a += ' in %ds' % (time.time() - self._overall_start_time)
428
a += ', %d errors' % self.error_count
429
if self.failure_count:
430
a += ', %d failed' % self.failure_count
431
if self.known_failure_count:
432
a += ', %d known failures' % self.known_failure_count
434
a += ', %d skipped' % self.skip_count
436
a += ', %d missing features' % len(self.unsupported)
440
def report_test_start(self, test):
443
self._progress_prefix_text()
445
+ self._shortened_test_description(test))
447
def _test_description(self, test):
448
return self._shortened_test_description(test)
450
def report_error(self, test, err):
451
self.pb.note('ERROR: %s\n %s\n',
452
self._test_description(test),
456
def report_failure(self, test, err):
457
self.pb.note('FAIL: %s\n %s\n',
458
self._test_description(test),
462
def report_known_failure(self, test, err):
463
self.pb.note('XFAIL: %s\n%s\n',
464
self._test_description(test), err[1])
466
def report_skip(self, test, skip_excinfo):
469
def report_not_applicable(self, test, skip_excinfo):
472
def report_unsupported(self, test, feature):
473
"""test cannot be run because feature is missing."""
475
def report_cleaning_up(self):
476
self.pb.update('cleaning up...')
479
if not self._supplied_pb:
483
class VerboseTestResult(ExtendedTestResult):
484
"""Produce long output, with one line per test run plus times"""
486
def _ellipsize_to_right(self, a_string, final_width):
487
"""Truncate and pad a string, keeping the right hand side"""
488
if len(a_string) > final_width:
489
result = '...' + a_string[3-final_width:]
492
return result.ljust(final_width)
494
def report_starting(self):
495
self.stream.write('running %d tests...\n' % self.num_tests)
497
def report_test_start(self, test):
499
name = self._shortened_test_description(test)
500
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
501
# numbers, plus a trailing blank
502
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
503
self.stream.write(self._ellipsize_to_right(name,
504
osutils.terminal_width()-30))
507
def _error_summary(self, err):
509
return '%s%s' % (indent, err[1])
511
def report_error(self, test, err):
512
self.stream.writeln('ERROR %s\n%s'
513
% (self._testTimeString(test),
514
self._error_summary(err)))
516
def report_failure(self, test, err):
517
self.stream.writeln(' FAIL %s\n%s'
518
% (self._testTimeString(test),
519
self._error_summary(err)))
521
def report_known_failure(self, test, err):
522
self.stream.writeln('XFAIL %s\n%s'
523
% (self._testTimeString(test),
524
self._error_summary(err)))
526
def report_success(self, test):
527
self.stream.writeln(' OK %s' % self._testTimeString(test))
528
for bench_called, stats in getattr(test, '_benchcalls', []):
529
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
530
stats.pprint(file=self.stream)
531
# flush the stream so that we get smooth output. This verbose mode is
532
# used to show the output in PQM.
535
def report_skip(self, test, skip_excinfo):
536
self.stream.writeln(' SKIP %s\n%s'
537
% (self._testTimeString(test),
538
self._error_summary(skip_excinfo)))
540
def report_not_applicable(self, test, skip_excinfo):
541
self.stream.writeln(' N/A %s\n%s'
542
% (self._testTimeString(test),
543
self._error_summary(skip_excinfo)))
545
def report_unsupported(self, test, feature):
546
"""test cannot be run because feature is missing."""
547
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
548
%(self._testTimeString(test), feature))
551
class TextTestRunner(object):
552
stop_on_failure = False
561
self.stream = unittest._WritelnDecorator(stream)
562
self.descriptions = descriptions
563
self.verbosity = verbosity
564
self._bench_history = bench_history
565
self.list_only = list_only
568
"Run the given test case or test suite."
569
startTime = time.time()
570
if self.verbosity == 1:
571
result_class = TextTestResult
572
elif self.verbosity >= 2:
573
result_class = VerboseTestResult
574
result = result_class(self.stream,
577
bench_history=self._bench_history,
578
num_tests=test.countTestCases(),
580
result.stop_early = self.stop_on_failure
581
result.report_starting()
583
if self.verbosity >= 2:
584
self.stream.writeln("Listing tests only ...\n")
586
for t in iter_suite_tests(test):
587
self.stream.writeln("%s" % (t.id()))
589
actionTaken = "Listed"
592
run = result.testsRun
594
stopTime = time.time()
595
timeTaken = stopTime - startTime
597
self.stream.writeln(result.separator2)
598
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
599
run, run != 1 and "s" or "", timeTaken))
600
self.stream.writeln()
601
if not result.wasSuccessful():
602
self.stream.write("FAILED (")
603
failed, errored = map(len, (result.failures, result.errors))
605
self.stream.write("failures=%d" % failed)
607
if failed: self.stream.write(", ")
608
self.stream.write("errors=%d" % errored)
609
if result.known_failure_count:
610
if failed or errored: self.stream.write(", ")
611
self.stream.write("known_failure_count=%d" %
612
result.known_failure_count)
613
self.stream.writeln(")")
615
if result.known_failure_count:
616
self.stream.writeln("OK (known_failures=%d)" %
617
result.known_failure_count)
619
self.stream.writeln("OK")
620
if result.skip_count > 0:
621
skipped = result.skip_count
622
self.stream.writeln('%d test%s skipped' %
623
(skipped, skipped != 1 and "s" or ""))
624
if result.unsupported:
625
for feature, count in sorted(result.unsupported.items()):
626
self.stream.writeln("Missing feature '%s' skipped %d tests." %
632
def iter_suite_tests(suite):
633
"""Return all tests in a suite, recursing through nested suites"""
634
for item in suite._tests:
635
if isinstance(item, unittest.TestCase):
637
elif isinstance(item, unittest.TestSuite):
638
for r in iter_suite_tests(item):
641
raise Exception('unknown object %r inside test suite %r'
645
class TestSkipped(Exception):
646
"""Indicates that a test was intentionally skipped, rather than failing."""
649
class TestNotApplicable(TestSkipped):
650
"""A test is not applicable to the situation where it was run.
652
This is only normally raised by parameterized tests, if they find that
653
the instance they're constructed upon does not support one aspect
658
class KnownFailure(AssertionError):
659
"""Indicates that a test failed in a precisely expected manner.
661
Such failures dont block the whole test suite from passing because they are
662
indicators of partially completed code or of future work. We have an
663
explicit error for them so that we can ensure that they are always visible:
664
KnownFailures are always shown in the output of bzr selftest.
668
class UnavailableFeature(Exception):
669
"""A feature required for this test was not available.
671
The feature should be used to construct the exception.
675
class CommandFailed(Exception):
679
class StringIOWrapper(object):
680
"""A wrapper around cStringIO which just adds an encoding attribute.
682
Internally we can check sys.stdout to see what the output encoding
683
should be. However, cStringIO has no encoding attribute that we can
684
set. So we wrap it instead.
689
def __init__(self, s=None):
691
self.__dict__['_cstring'] = StringIO(s)
693
self.__dict__['_cstring'] = StringIO()
695
def __getattr__(self, name, getattr=getattr):
696
return getattr(self.__dict__['_cstring'], name)
698
def __setattr__(self, name, val):
699
if name == 'encoding':
700
self.__dict__['encoding'] = val
702
return setattr(self._cstring, name, val)
705
class TestUIFactory(ui.CLIUIFactory):
706
"""A UI Factory for testing.
708
Hide the progress bar but emit note()s.
710
Allows get_password to be tested without real tty attached.
717
super(TestUIFactory, self).__init__()
718
if stdin is not None:
719
# We use a StringIOWrapper to be able to test various
720
# encodings, but the user is still responsible to
721
# encode the string and to set the encoding attribute
722
# of StringIOWrapper.
723
self.stdin = StringIOWrapper(stdin)
725
self.stdout = sys.stdout
729
self.stderr = sys.stderr
734
"""See progress.ProgressBar.clear()."""
736
def clear_term(self):
737
"""See progress.ProgressBar.clear_term()."""
739
def clear_term(self):
740
"""See progress.ProgressBar.clear_term()."""
743
"""See progress.ProgressBar.finished()."""
745
def note(self, fmt_string, *args, **kwargs):
746
"""See progress.ProgressBar.note()."""
747
self.stdout.write((fmt_string + "\n") % args)
749
def progress_bar(self):
752
def nested_progress_bar(self):
755
def update(self, message, count=None, total=None):
756
"""See progress.ProgressBar.update()."""
758
def get_non_echoed_password(self, prompt):
759
"""Get password from stdin without trying to handle the echo mode"""
761
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
762
password = self.stdin.readline()
765
if password[-1] == '\n':
766
password = password[:-1]
770
class TestCase(unittest.TestCase):
771
"""Base class for bzr unit tests.
773
Tests that need access to disk resources should subclass
774
TestCaseInTempDir not TestCase.
776
Error and debug log messages are redirected from their usual
777
location into a temporary file, the contents of which can be
778
retrieved by _get_log(). We use a real OS file, not an in-memory object,
779
so that it can also capture file IO. When the test completes this file
780
is read into memory and removed from disk.
782
There are also convenience functions to invoke bzr's command-line
783
routine, and to build and check bzr trees.
785
In addition to the usual method of overriding tearDown(), this class also
786
allows subclasses to register functions into the _cleanups list, which is
787
run in order as the object is torn down. It's less likely this will be
788
accidentally overlooked.
791
_log_file_name = None
793
_keep_log_file = False
794
# record lsprof data when performing benchmark calls.
795
_gather_lsprof_in_benchmarks = False
796
attrs_to_keep = ('_testMethodName', '_testMethodDoc',
797
'_log_contents', '_log_file_name', '_benchtime')
799
def __init__(self, methodName='testMethod'):
800
super(TestCase, self).__init__(methodName)
804
unittest.TestCase.setUp(self)
805
self._cleanEnvironment()
808
self._benchcalls = []
809
self._benchtime = None
811
self._clear_debug_flags()
813
def _clear_debug_flags(self):
814
"""Prevent externally set debug flags affecting tests.
816
Tests that want to use debug flags can just set them in the
817
debug_flags set during setup/teardown.
819
self._preserved_debug_flags = set(debug.debug_flags)
820
debug.debug_flags.clear()
821
self.addCleanup(self._restore_debug_flags)
823
def _clear_hooks(self):
824
# prevent hooks affecting tests
826
import bzrlib.smart.server
827
self._preserved_hooks = {
828
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
829
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
831
self.addCleanup(self._restoreHooks)
832
# reset all hooks to an empty instance of the appropriate type
833
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
834
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
836
def _silenceUI(self):
837
"""Turn off UI for duration of test"""
838
# by default the UI is off; tests can turn it on if they want it.
839
saved = ui.ui_factory
841
ui.ui_factory = saved
842
ui.ui_factory = ui.SilentUIFactory()
843
self.addCleanup(_restore)
845
def _ndiff_strings(self, a, b):
846
"""Return ndiff between two strings containing lines.
848
A trailing newline is added if missing to make the strings
850
if b and b[-1] != '\n':
852
if a and a[-1] != '\n':
854
difflines = difflib.ndiff(a.splitlines(True),
856
linejunk=lambda x: False,
857
charjunk=lambda x: False)
858
return ''.join(difflines)
860
def assertEqual(self, a, b, message=''):
864
except UnicodeError, e:
865
# If we can't compare without getting a UnicodeError, then
866
# obviously they are different
867
mutter('UnicodeError: %s', e)
870
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
872
pformat(a), pformat(b)))
874
assertEquals = assertEqual
876
def assertEqualDiff(self, a, b, message=None):
877
"""Assert two texts are equal, if not raise an exception.
879
This is intended for use with multi-line strings where it can
880
be hard to find the differences by eye.
882
# TODO: perhaps override assertEquals to call this for strings?
886
message = "texts not equal:\n"
887
raise AssertionError(message +
888
self._ndiff_strings(a, b))
890
def assertEqualMode(self, mode, mode_test):
891
self.assertEqual(mode, mode_test,
892
'mode mismatch %o != %o' % (mode, mode_test))
894
def assertPositive(self, val):
895
"""Assert that val is greater than 0."""
896
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
898
def assertNegative(self, val):
899
"""Assert that val is less than 0."""
900
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
902
def assertStartsWith(self, s, prefix):
903
if not s.startswith(prefix):
904
raise AssertionError('string %r does not start with %r' % (s, prefix))
906
def assertEndsWith(self, s, suffix):
907
"""Asserts that s ends with suffix."""
908
if not s.endswith(suffix):
909
raise AssertionError('string %r does not end with %r' % (s, suffix))
911
def assertContainsRe(self, haystack, needle_re):
912
"""Assert that a contains something matching a regular expression."""
913
if not re.search(needle_re, haystack):
914
if '\n' in haystack or len(haystack) > 60:
915
# a long string, format it in a more readable way
916
raise AssertionError(
917
'pattern "%s" not found in\n"""\\\n%s"""\n'
918
% (needle_re, haystack))
920
raise AssertionError('pattern "%s" not found in "%s"'
921
% (needle_re, haystack))
923
def assertNotContainsRe(self, haystack, needle_re):
924
"""Assert that a does not match a regular expression"""
925
if re.search(needle_re, haystack):
926
raise AssertionError('pattern "%s" found in "%s"'
927
% (needle_re, haystack))
929
def assertSubset(self, sublist, superlist):
930
"""Assert that every entry in sublist is present in superlist."""
931
missing = set(sublist) - set(superlist)
933
raise AssertionError("value(s) %r not present in container %r" %
934
(missing, superlist))
936
def assertListRaises(self, excClass, func, *args, **kwargs):
937
"""Fail unless excClass is raised when the iterator from func is used.
939
Many functions can return generators this makes sure
940
to wrap them in a list() call to make sure the whole generator
941
is run, and that the proper exception is raised.
944
list(func(*args, **kwargs))
948
if getattr(excClass,'__name__', None) is not None:
949
excName = excClass.__name__
951
excName = str(excClass)
952
raise self.failureException, "%s not raised" % excName
954
def assertRaises(self, excClass, callableObj, *args, **kwargs):
955
"""Assert that a callable raises a particular exception.
957
:param excClass: As for the except statement, this may be either an
958
exception class, or a tuple of classes.
959
:param callableObj: A callable, will be passed ``*args`` and
962
Returns the exception so that you can examine it.
965
callableObj(*args, **kwargs)
969
if getattr(excClass,'__name__', None) is not None:
970
excName = excClass.__name__
973
excName = str(excClass)
974
raise self.failureException, "%s not raised" % excName
976
def assertIs(self, left, right, message=None):
977
if not (left is right):
978
if message is not None:
979
raise AssertionError(message)
981
raise AssertionError("%r is not %r." % (left, right))
983
def assertIsNot(self, left, right, message=None):
985
if message is not None:
986
raise AssertionError(message)
988
raise AssertionError("%r is %r." % (left, right))
990
def assertTransportMode(self, transport, path, mode):
991
"""Fail if a path does not have mode mode.
993
If modes are not supported on this transport, the assertion is ignored.
995
if not transport._can_roundtrip_unix_modebits():
997
path_stat = transport.stat(path)
998
actual_mode = stat.S_IMODE(path_stat.st_mode)
999
self.assertEqual(mode, actual_mode,
1000
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
1002
def assertIsSameRealPath(self, path1, path2):
1003
"""Fail if path1 and path2 points to different files"""
1004
self.assertEqual(osutils.realpath(path1),
1005
osutils.realpath(path2),
1006
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1008
def assertIsInstance(self, obj, kls):
1009
"""Fail if obj is not an instance of kls"""
1010
if not isinstance(obj, kls):
1011
self.fail("%r is an instance of %s rather than %s" % (
1012
obj, obj.__class__, kls))
1014
def expectFailure(self, reason, assertion, *args, **kwargs):
1015
"""Invoke a test, expecting it to fail for the given reason.
1017
This is for assertions that ought to succeed, but currently fail.
1018
(The failure is *expected* but not *wanted*.) Please be very precise
1019
about the failure you're expecting. If a new bug is introduced,
1020
AssertionError should be raised, not KnownFailure.
1022
Frequently, expectFailure should be followed by an opposite assertion.
1025
Intended to be used with a callable that raises AssertionError as the
1026
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1028
Raises KnownFailure if the test fails. Raises AssertionError if the
1033
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1035
self.assertEqual(42, dynamic_val)
1037
This means that a dynamic_val of 54 will cause the test to raise
1038
a KnownFailure. Once math is fixed and the expectFailure is removed,
1039
only a dynamic_val of 42 will allow the test to pass. Anything other
1040
than 54 or 42 will cause an AssertionError.
1043
assertion(*args, **kwargs)
1044
except AssertionError:
1045
raise KnownFailure(reason)
1047
self.fail('Unexpected success. Should have failed: %s' % reason)
1049
def assertFileEqual(self, content, path):
1050
"""Fail if path does not contain 'content'."""
1051
self.failUnlessExists(path)
1052
f = file(path, 'rb')
1057
self.assertEqualDiff(content, s)
1059
def failUnlessExists(self, path):
1060
"""Fail unless path or paths, which may be abs or relative, exist."""
1061
if not isinstance(path, basestring):
1063
self.failUnlessExists(p)
1065
self.failUnless(osutils.lexists(path),path+" does not exist")
1067
def failIfExists(self, path):
1068
"""Fail if path or paths, which may be abs or relative, exist."""
1069
if not isinstance(path, basestring):
1071
self.failIfExists(p)
1073
self.failIf(osutils.lexists(path),path+" exists")
1075
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1076
"""A helper for callDeprecated and applyDeprecated.
1078
:param a_callable: A callable to call.
1079
:param args: The positional arguments for the callable
1080
:param kwargs: The keyword arguments for the callable
1081
:return: A tuple (warnings, result). result is the result of calling
1082
a_callable(``*args``, ``**kwargs``).
1085
def capture_warnings(msg, cls=None, stacklevel=None):
1086
# we've hooked into a deprecation specific callpath,
1087
# only deprecations should getting sent via it.
1088
self.assertEqual(cls, DeprecationWarning)
1089
local_warnings.append(msg)
1090
original_warning_method = symbol_versioning.warn
1091
symbol_versioning.set_warning_method(capture_warnings)
1093
result = a_callable(*args, **kwargs)
1095
symbol_versioning.set_warning_method(original_warning_method)
1096
return (local_warnings, result)
1098
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1099
"""Call a deprecated callable without warning the user.
1101
Note that this only captures warnings raised by symbol_versioning.warn,
1102
not other callers that go direct to the warning module.
1104
To test that a deprecated method raises an error, do something like
1107
self.assertRaises(errors.ReservedId,
1108
self.applyDeprecated, zero_ninetyone,
1109
br.append_revision, 'current:')
1111
:param deprecation_format: The deprecation format that the callable
1112
should have been deprecated with. This is the same type as the
1113
parameter to deprecated_method/deprecated_function. If the
1114
callable is not deprecated with this format, an assertion error
1116
:param a_callable: A callable to call. This may be a bound method or
1117
a regular function. It will be called with ``*args`` and
1119
:param args: The positional arguments for the callable
1120
:param kwargs: The keyword arguments for the callable
1121
:return: The result of a_callable(``*args``, ``**kwargs``)
1123
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1125
expected_first_warning = symbol_versioning.deprecation_string(
1126
a_callable, deprecation_format)
1127
if len(call_warnings) == 0:
1128
self.fail("No deprecation warning generated by call to %s" %
1130
self.assertEqual(expected_first_warning, call_warnings[0])
1133
def callCatchWarnings(self, fn, *args, **kw):
1134
"""Call a callable that raises python warnings.
1136
The caller's responsible for examining the returned warnings.
1138
If the callable raises an exception, the exception is not
1139
caught and propagates up to the caller. In that case, the list
1140
of warnings is not available.
1142
:returns: ([warning_object, ...], fn_result)
1144
# XXX: This is not perfect, because it completely overrides the
1145
# warnings filters, and some code may depend on suppressing particular
1146
# warnings. It's the easiest way to insulate ourselves from -Werror,
1147
# though. -- Andrew, 20071062
1149
def _catcher(message, category, filename, lineno, file=None):
1150
# despite the name, 'message' is normally(?) a Warning subclass
1152
wlist.append(message)
1153
saved_showwarning = warnings.showwarning
1154
saved_filters = warnings.filters
1156
warnings.showwarning = _catcher
1157
warnings.filters = []
1158
result = fn(*args, **kw)
1160
warnings.showwarning = saved_showwarning
1161
warnings.filters = saved_filters
1162
return wlist, result
1164
def callDeprecated(self, expected, callable, *args, **kwargs):
1165
"""Assert that a callable is deprecated in a particular way.
1167
This is a very precise test for unusual requirements. The
1168
applyDeprecated helper function is probably more suited for most tests
1169
as it allows you to simply specify the deprecation format being used
1170
and will ensure that that is issued for the function being called.
1172
Note that this only captures warnings raised by symbol_versioning.warn,
1173
not other callers that go direct to the warning module. To catch
1174
general warnings, use callCatchWarnings.
1176
:param expected: a list of the deprecation warnings expected, in order
1177
:param callable: The callable to call
1178
:param args: The positional arguments for the callable
1179
:param kwargs: The keyword arguments for the callable
1181
call_warnings, result = self._capture_deprecation_warnings(callable,
1183
self.assertEqual(expected, call_warnings)
1186
def _startLogFile(self):
1187
"""Send bzr and test log messages to a temporary file.
1189
The file is removed as the test is torn down.
1191
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1192
self._log_file = os.fdopen(fileno, 'w+')
1193
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1194
self._log_file_name = name
1195
self.addCleanup(self._finishLogFile)
1197
def _finishLogFile(self):
1198
"""Finished with the log file.
1200
Close the file and delete it, unless setKeepLogfile was called.
1202
if self._log_file is None:
1204
bzrlib.trace.pop_log_file(self._log_memento)
1205
self._log_file.close()
1206
self._log_file = None
1207
if not self._keep_log_file:
1208
os.remove(self._log_file_name)
1209
self._log_file_name = None
1211
def setKeepLogfile(self):
1212
"""Make the logfile not be deleted when _finishLogFile is called."""
1213
self._keep_log_file = True
1215
def addCleanup(self, callable):
1216
"""Arrange to run a callable when this case is torn down.
1218
Callables are run in the reverse of the order they are registered,
1219
ie last-in first-out.
1221
if callable in self._cleanups:
1222
raise ValueError("cleanup function %r already registered on %s"
1224
self._cleanups.append(callable)
1226
def _cleanEnvironment(self):
1228
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1229
'HOME': os.getcwd(),
1230
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1231
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1233
'BZREMAIL': None, # may still be present in the environment
1235
'BZR_PROGRESS_BAR': None,
1237
'SSH_AUTH_SOCK': None,
1241
'https_proxy': None,
1242
'HTTPS_PROXY': None,
1247
# Nobody cares about these ones AFAIK. So far at
1248
# least. If you do (care), please update this comment
1252
'BZR_REMOTE_PATH': None,
1255
self.addCleanup(self._restoreEnvironment)
1256
for name, value in new_env.iteritems():
1257
self._captureVar(name, value)
1259
def _captureVar(self, name, newvalue):
1260
"""Set an environment variable, and reset it when finished."""
1261
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1263
def _restore_debug_flags(self):
1264
debug.debug_flags.clear()
1265
debug.debug_flags.update(self._preserved_debug_flags)
1267
def _restoreEnvironment(self):
1268
for name, value in self.__old_env.iteritems():
1269
osutils.set_or_unset_env(name, value)
1271
def _restoreHooks(self):
1272
for klass, hooks in self._preserved_hooks.items():
1273
setattr(klass, 'hooks', hooks)
1275
def knownFailure(self, reason):
1276
"""This test has failed for some known reason."""
1277
raise KnownFailure(reason)
1279
def run(self, result=None):
1280
if result is None: result = self.defaultTestResult()
1281
for feature in getattr(self, '_test_needs_features', []):
1282
if not feature.available():
1283
result.startTest(self)
1284
if getattr(result, 'addNotSupported', None):
1285
result.addNotSupported(self, feature)
1287
result.addSuccess(self)
1288
result.stopTest(self)
1291
return unittest.TestCase.run(self, result)
1294
not_found = object()
1295
for attr_name in self.attrs_to_keep:
1296
attr = getattr(self, attr_name, not_found)
1297
if attr is not not_found:
1298
saved_attrs[attr_name] = attr
1299
self.__dict__ = saved_attrs
1303
unittest.TestCase.tearDown(self)
1305
def time(self, callable, *args, **kwargs):
1306
"""Run callable and accrue the time it takes to the benchmark time.
1308
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1309
this will cause lsprofile statistics to be gathered and stored in
1312
if self._benchtime is None:
1316
if not self._gather_lsprof_in_benchmarks:
1317
return callable(*args, **kwargs)
1319
# record this benchmark
1320
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1322
self._benchcalls.append(((callable, args, kwargs), stats))
1325
self._benchtime += time.time() - start
1327
def _runCleanups(self):
1328
"""Run registered cleanup functions.
1330
This should only be called from TestCase.tearDown.
1332
# TODO: Perhaps this should keep running cleanups even if
1333
# one of them fails?
1335
# Actually pop the cleanups from the list so tearDown running
1336
# twice is safe (this happens for skipped tests).
1337
while self._cleanups:
1338
self._cleanups.pop()()
1340
def log(self, *args):
1343
def _get_log(self, keep_log_file=False):
1344
"""Get the log from bzrlib.trace calls from this test.
1346
:param keep_log_file: When True, if the log is still a file on disk
1347
leave it as a file on disk. When False, if the log is still a file
1348
on disk, the log file is deleted and the log preserved as
1350
:return: A string containing the log.
1352
# flush the log file, to get all content
1354
bzrlib.trace._trace_file.flush()
1355
if self._log_contents:
1356
# XXX: this can hardly contain the content flushed above --vila
1358
return self._log_contents
1359
if self._log_file_name is not None:
1360
logfile = open(self._log_file_name)
1362
log_contents = logfile.read()
1365
if not keep_log_file:
1366
self._log_contents = log_contents
1368
os.remove(self._log_file_name)
1370
if sys.platform == 'win32' and e.errno == errno.EACCES:
1371
sys.stderr.write(('Unable to delete log file '
1372
' %r\n' % self._log_file_name))
1377
return "DELETED log file to reduce memory footprint"
1379
def requireFeature(self, feature):
1380
"""This test requires a specific feature is available.
1382
:raises UnavailableFeature: When feature is not available.
1384
if not feature.available():
1385
raise UnavailableFeature(feature)
1387
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1389
"""Run bazaar command line, splitting up a string command line."""
1390
if isinstance(args, basestring):
1391
# shlex don't understand unicode strings,
1392
# so args should be plain string (bialix 20070906)
1393
args = list(shlex.split(str(args)))
1394
return self._run_bzr_core(args, retcode=retcode,
1395
encoding=encoding, stdin=stdin, working_dir=working_dir,
1398
def _run_bzr_core(self, args, retcode, encoding, stdin,
1400
if encoding is None:
1401
encoding = bzrlib.user_encoding
1402
stdout = StringIOWrapper()
1403
stderr = StringIOWrapper()
1404
stdout.encoding = encoding
1405
stderr.encoding = encoding
1407
self.log('run bzr: %r', args)
1408
# FIXME: don't call into logging here
1409
handler = logging.StreamHandler(stderr)
1410
handler.setLevel(logging.INFO)
1411
logger = logging.getLogger('')
1412
logger.addHandler(handler)
1413
old_ui_factory = ui.ui_factory
1414
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1417
if working_dir is not None:
1418
cwd = osutils.getcwd()
1419
os.chdir(working_dir)
1422
result = self.apply_redirected(ui.ui_factory.stdin,
1424
bzrlib.commands.run_bzr_catch_user_errors,
1427
logger.removeHandler(handler)
1428
ui.ui_factory = old_ui_factory
1432
out = stdout.getvalue()
1433
err = stderr.getvalue()
1435
self.log('output:\n%r', out)
1437
self.log('errors:\n%r', err)
1438
if retcode is not None:
1439
self.assertEquals(retcode, result,
1440
message='Unexpected return code')
1443
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1444
working_dir=None, error_regexes=[], output_encoding=None):
1445
"""Invoke bzr, as if it were run from the command line.
1447
The argument list should not include the bzr program name - the
1448
first argument is normally the bzr command. Arguments may be
1449
passed in three ways:
1451
1- A list of strings, eg ["commit", "a"]. This is recommended
1452
when the command contains whitespace or metacharacters, or
1453
is built up at run time.
1455
2- A single string, eg "add a". This is the most convenient
1456
for hardcoded commands.
1458
This runs bzr through the interface that catches and reports
1459
errors, and with logging set to something approximating the
1460
default, so that error reporting can be checked.
1462
This should be the main method for tests that want to exercise the
1463
overall behavior of the bzr application (rather than a unit test
1464
or a functional test of the library.)
1466
This sends the stdout/stderr results into the test's log,
1467
where it may be useful for debugging. See also run_captured.
1469
:keyword stdin: A string to be used as stdin for the command.
1470
:keyword retcode: The status code the command should return;
1472
:keyword working_dir: The directory to run the command in
1473
:keyword error_regexes: A list of expected error messages. If
1474
specified they must be seen in the error output of the command.
1476
out, err = self._run_bzr_autosplit(
1481
working_dir=working_dir,
1483
for regex in error_regexes:
1484
self.assertContainsRe(err, regex)
1487
def run_bzr_error(self, error_regexes, *args, **kwargs):
1488
"""Run bzr, and check that stderr contains the supplied regexes
1490
:param error_regexes: Sequence of regular expressions which
1491
must each be found in the error output. The relative ordering
1493
:param args: command-line arguments for bzr
1494
:param kwargs: Keyword arguments which are interpreted by run_bzr
1495
This function changes the default value of retcode to be 3,
1496
since in most cases this is run when you expect bzr to fail.
1498
:return: (out, err) The actual output of running the command (in case
1499
you want to do more inspection)
1503
# Make sure that commit is failing because there is nothing to do
1504
self.run_bzr_error(['no changes to commit'],
1505
['commit', '-m', 'my commit comment'])
1506
# Make sure --strict is handling an unknown file, rather than
1507
# giving us the 'nothing to do' error
1508
self.build_tree(['unknown'])
1509
self.run_bzr_error(['Commit refused because there are unknown files'],
1510
['commit', --strict', '-m', 'my commit comment'])
1512
kwargs.setdefault('retcode', 3)
1513
kwargs['error_regexes'] = error_regexes
1514
out, err = self.run_bzr(*args, **kwargs)
1517
def run_bzr_subprocess(self, *args, **kwargs):
1518
"""Run bzr in a subprocess for testing.
1520
This starts a new Python interpreter and runs bzr in there.
1521
This should only be used for tests that have a justifiable need for
1522
this isolation: e.g. they are testing startup time, or signal
1523
handling, or early startup code, etc. Subprocess code can't be
1524
profiled or debugged so easily.
1526
:keyword retcode: The status code that is expected. Defaults to 0. If
1527
None is supplied, the status code is not checked.
1528
:keyword env_changes: A dictionary which lists changes to environment
1529
variables. A value of None will unset the env variable.
1530
The values must be strings. The change will only occur in the
1531
child, so you don't need to fix the environment after running.
1532
:keyword universal_newlines: Convert CRLF => LF
1533
:keyword allow_plugins: By default the subprocess is run with
1534
--no-plugins to ensure test reproducibility. Also, it is possible
1535
for system-wide plugins to create unexpected output on stderr,
1536
which can cause unnecessary test failures.
1538
env_changes = kwargs.get('env_changes', {})
1539
working_dir = kwargs.get('working_dir', None)
1540
allow_plugins = kwargs.get('allow_plugins', False)
1542
if isinstance(args[0], list):
1544
elif isinstance(args[0], basestring):
1545
args = list(shlex.split(args[0]))
1547
symbol_versioning.warn(zero_ninetyone %
1548
"passing varargs to run_bzr_subprocess",
1549
DeprecationWarning, stacklevel=3)
1550
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1551
working_dir=working_dir,
1552
allow_plugins=allow_plugins)
1553
# We distinguish between retcode=None and retcode not passed.
1554
supplied_retcode = kwargs.get('retcode', 0)
1555
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1556
universal_newlines=kwargs.get('universal_newlines', False),
1559
def start_bzr_subprocess(self, process_args, env_changes=None,
1560
skip_if_plan_to_signal=False,
1562
allow_plugins=False):
1563
"""Start bzr in a subprocess for testing.
1565
This starts a new Python interpreter and runs bzr in there.
1566
This should only be used for tests that have a justifiable need for
1567
this isolation: e.g. they are testing startup time, or signal
1568
handling, or early startup code, etc. Subprocess code can't be
1569
profiled or debugged so easily.
1571
:param process_args: a list of arguments to pass to the bzr executable,
1572
for example ``['--version']``.
1573
:param env_changes: A dictionary which lists changes to environment
1574
variables. A value of None will unset the env variable.
1575
The values must be strings. The change will only occur in the
1576
child, so you don't need to fix the environment after running.
1577
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1579
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1581
:returns: Popen object for the started process.
1583
if skip_if_plan_to_signal:
1584
if not getattr(os, 'kill', None):
1585
raise TestSkipped("os.kill not available.")
1587
if env_changes is None:
1591
def cleanup_environment():
1592
for env_var, value in env_changes.iteritems():
1593
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1595
def restore_environment():
1596
for env_var, value in old_env.iteritems():
1597
osutils.set_or_unset_env(env_var, value)
1599
bzr_path = self.get_bzr_path()
1602
if working_dir is not None:
1603
cwd = osutils.getcwd()
1604
os.chdir(working_dir)
1607
# win32 subprocess doesn't support preexec_fn
1608
# so we will avoid using it on all platforms, just to
1609
# make sure the code path is used, and we don't break on win32
1610
cleanup_environment()
1611
command = [sys.executable, bzr_path]
1612
if not allow_plugins:
1613
command.append('--no-plugins')
1614
command.extend(process_args)
1615
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1617
restore_environment()
1623
def _popen(self, *args, **kwargs):
1624
"""Place a call to Popen.
1626
Allows tests to override this method to intercept the calls made to
1627
Popen for introspection.
1629
return Popen(*args, **kwargs)
1631
def get_bzr_path(self):
1632
"""Return the path of the 'bzr' executable for this test suite."""
1633
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1634
if not os.path.isfile(bzr_path):
1635
# We are probably installed. Assume sys.argv is the right file
1636
bzr_path = sys.argv[0]
1639
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1640
universal_newlines=False, process_args=None):
1641
"""Finish the execution of process.
1643
:param process: the Popen object returned from start_bzr_subprocess.
1644
:param retcode: The status code that is expected. Defaults to 0. If
1645
None is supplied, the status code is not checked.
1646
:param send_signal: an optional signal to send to the process.
1647
:param universal_newlines: Convert CRLF => LF
1648
:returns: (stdout, stderr)
1650
if send_signal is not None:
1651
os.kill(process.pid, send_signal)
1652
out, err = process.communicate()
1654
if universal_newlines:
1655
out = out.replace('\r\n', '\n')
1656
err = err.replace('\r\n', '\n')
1658
if retcode is not None and retcode != process.returncode:
1659
if process_args is None:
1660
process_args = "(unknown args)"
1661
mutter('Output of bzr %s:\n%s', process_args, out)
1662
mutter('Error for bzr %s:\n%s', process_args, err)
1663
self.fail('Command bzr %s failed with retcode %s != %s'
1664
% (process_args, retcode, process.returncode))
1667
def check_inventory_shape(self, inv, shape):
1668
"""Compare an inventory to a list of expected names.
1670
Fail if they are not precisely equal.
1673
shape = list(shape) # copy
1674
for path, ie in inv.entries():
1675
name = path.replace('\\', '/')
1676
if ie.kind == 'directory':
1683
self.fail("expected paths not found in inventory: %r" % shape)
1685
self.fail("unexpected paths found in inventory: %r" % extras)
1687
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1688
a_callable=None, *args, **kwargs):
1689
"""Call callable with redirected std io pipes.
1691
Returns the return code."""
1692
if not callable(a_callable):
1693
raise ValueError("a_callable must be callable.")
1695
stdin = StringIO("")
1697
if getattr(self, "_log_file", None) is not None:
1698
stdout = self._log_file
1702
if getattr(self, "_log_file", None is not None):
1703
stderr = self._log_file
1706
real_stdin = sys.stdin
1707
real_stdout = sys.stdout
1708
real_stderr = sys.stderr
1713
return a_callable(*args, **kwargs)
1715
sys.stdout = real_stdout
1716
sys.stderr = real_stderr
1717
sys.stdin = real_stdin
1719
def reduceLockdirTimeout(self):
1720
"""Reduce the default lock timeout for the duration of the test, so that
1721
if LockContention occurs during a test, it does so quickly.
1723
Tests that expect to provoke LockContention errors should call this.
1725
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1727
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1728
self.addCleanup(resetTimeout)
1729
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1731
def make_utf8_encoded_stringio(self, encoding_type=None):
1732
"""Return a StringIOWrapper instance, that will encode Unicode
1735
if encoding_type is None:
1736
encoding_type = 'strict'
1738
output_encoding = 'utf-8'
1739
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1740
sio.encoding = output_encoding
1744
class TestCaseWithMemoryTransport(TestCase):
1745
"""Common test class for tests that do not need disk resources.
1747
Tests that need disk resources should derive from TestCaseWithTransport.
1749
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1751
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1752
a directory which does not exist. This serves to help ensure test isolation
1753
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1754
must exist. However, TestCaseWithMemoryTransport does not offer local
1755
file defaults for the transport in tests, nor does it obey the command line
1756
override, so tests that accidentally write to the common directory should
1759
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1760
a .bzr directory that stops us ascending higher into the filesystem.
1766
def __init__(self, methodName='runTest'):
1767
# allow test parameterization after test construction and before test
1768
# execution. Variables that the parameterizer sets need to be
1769
# ones that are not set by setUp, or setUp will trash them.
1770
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1771
self.vfs_transport_factory = default_transport
1772
self.transport_server = None
1773
self.transport_readonly_server = None
1774
self.__vfs_server = None
1776
def get_transport(self, relpath=None):
1777
"""Return a writeable transport.
1779
This transport is for the test scratch space relative to
1782
:param relpath: a path relative to the base url.
1784
t = get_transport(self.get_url(relpath))
1785
self.assertFalse(t.is_readonly())
1788
def get_readonly_transport(self, relpath=None):
1789
"""Return a readonly transport for the test scratch space
1791
This can be used to test that operations which should only need
1792
readonly access in fact do not try to write.
1794
:param relpath: a path relative to the base url.
1796
t = get_transport(self.get_readonly_url(relpath))
1797
self.assertTrue(t.is_readonly())
1800
def create_transport_readonly_server(self):
1801
"""Create a transport server from class defined at init.
1803
This is mostly a hook for daughter classes.
1805
return self.transport_readonly_server()
1807
def get_readonly_server(self):
1808
"""Get the server instance for the readonly transport
1810
This is useful for some tests with specific servers to do diagnostics.
1812
if self.__readonly_server is None:
1813
if self.transport_readonly_server is None:
1814
# readonly decorator requested
1815
# bring up the server
1816
self.__readonly_server = ReadonlyServer()
1817
self.__readonly_server.setUp(self.get_vfs_only_server())
1819
self.__readonly_server = self.create_transport_readonly_server()
1820
self.__readonly_server.setUp(self.get_vfs_only_server())
1821
self.addCleanup(self.__readonly_server.tearDown)
1822
return self.__readonly_server
1824
def get_readonly_url(self, relpath=None):
1825
"""Get a URL for the readonly transport.
1827
This will either be backed by '.' or a decorator to the transport
1828
used by self.get_url()
1829
relpath provides for clients to get a path relative to the base url.
1830
These should only be downwards relative, not upwards.
1832
base = self.get_readonly_server().get_url()
1833
return self._adjust_url(base, relpath)
1835
def get_vfs_only_server(self):
1836
"""Get the vfs only read/write server instance.
1838
This is useful for some tests with specific servers that need
1841
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1842
is no means to override it.
1844
if self.__vfs_server is None:
1845
self.__vfs_server = MemoryServer()
1846
self.__vfs_server.setUp()
1847
self.addCleanup(self.__vfs_server.tearDown)
1848
return self.__vfs_server
1850
def get_server(self):
1851
"""Get the read/write server instance.
1853
This is useful for some tests with specific servers that need
1856
This is built from the self.transport_server factory. If that is None,
1857
then the self.get_vfs_server is returned.
1859
if self.__server is None:
1860
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1861
return self.get_vfs_only_server()
1863
# bring up a decorated means of access to the vfs only server.
1864
self.__server = self.transport_server()
1866
self.__server.setUp(self.get_vfs_only_server())
1867
except TypeError, e:
1868
# This should never happen; the try:Except here is to assist
1869
# developers having to update code rather than seeing an
1870
# uninformative TypeError.
1871
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1872
self.addCleanup(self.__server.tearDown)
1873
return self.__server
1875
def _adjust_url(self, base, relpath):
1876
"""Get a URL (or maybe a path) for the readwrite transport.
1878
This will either be backed by '.' or to an equivalent non-file based
1880
relpath provides for clients to get a path relative to the base url.
1881
These should only be downwards relative, not upwards.
1883
if relpath is not None and relpath != '.':
1884
if not base.endswith('/'):
1886
# XXX: Really base should be a url; we did after all call
1887
# get_url()! But sometimes it's just a path (from
1888
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1889
# to a non-escaped local path.
1890
if base.startswith('./') or base.startswith('/'):
1893
base += urlutils.escape(relpath)
1896
def get_url(self, relpath=None):
1897
"""Get a URL (or maybe a path) for the readwrite transport.
1899
This will either be backed by '.' or to an equivalent non-file based
1901
relpath provides for clients to get a path relative to the base url.
1902
These should only be downwards relative, not upwards.
1904
base = self.get_server().get_url()
1905
return self._adjust_url(base, relpath)
1907
def get_vfs_only_url(self, relpath=None):
1908
"""Get a URL (or maybe a path for the plain old vfs transport.
1910
This will never be a smart protocol. It always has all the
1911
capabilities of the local filesystem, but it might actually be a
1912
MemoryTransport or some other similar virtual filesystem.
1914
This is the backing transport (if any) of the server returned by
1915
get_url and get_readonly_url.
1917
:param relpath: provides for clients to get a path relative to the base
1918
url. These should only be downwards relative, not upwards.
1921
base = self.get_vfs_only_server().get_url()
1922
return self._adjust_url(base, relpath)
1924
def _create_safety_net(self):
1925
"""Make a fake bzr directory.
1927
This prevents any tests propagating up onto the TEST_ROOT directory's
1930
root = TestCaseWithMemoryTransport.TEST_ROOT
1931
bzrdir.BzrDir.create_standalone_workingtree(root)
1933
def _check_safety_net(self):
1934
"""Check that the safety .bzr directory have not been touched.
1936
_make_test_root have created a .bzr directory to prevent tests from
1937
propagating. This method ensures than a test did not leaked.
1939
root = TestCaseWithMemoryTransport.TEST_ROOT
1940
wt = workingtree.WorkingTree.open(root)
1941
last_rev = wt.last_revision()
1942
if last_rev != 'null:':
1943
# The current test have modified the /bzr directory, we need to
1944
# recreate a new one or all the followng tests will fail.
1945
# If you need to inspect its content uncomment the following line
1946
# import pdb; pdb.set_trace()
1947
_rmtree_temp_dir(root + '/.bzr')
1948
self._create_safety_net()
1949
raise AssertionError('%s/.bzr should not be modified' % root)
1951
def _make_test_root(self):
1952
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1953
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1954
TestCaseWithMemoryTransport.TEST_ROOT = root
1956
self._create_safety_net()
1958
# The same directory is used by all tests, and we're not
1959
# specifically told when all tests are finished. This will do.
1960
atexit.register(_rmtree_temp_dir, root)
1962
self.addCleanup(self._check_safety_net)
1964
def makeAndChdirToTestDir(self):
1965
"""Create a temporary directories for this one test.
1967
This must set self.test_home_dir and self.test_dir and chdir to
1970
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1972
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1973
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1974
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1976
def make_branch(self, relpath, format=None):
1977
"""Create a branch on the transport at relpath."""
1978
repo = self.make_repository(relpath, format=format)
1979
return repo.bzrdir.create_branch()
1981
def make_bzrdir(self, relpath, format=None):
1983
# might be a relative or absolute path
1984
maybe_a_url = self.get_url(relpath)
1985
segments = maybe_a_url.rsplit('/', 1)
1986
t = get_transport(maybe_a_url)
1987
if len(segments) > 1 and segments[-1] not in ('', '.'):
1991
if isinstance(format, basestring):
1992
format = bzrdir.format_registry.make_bzrdir(format)
1993
return format.initialize_on_transport(t)
1994
except errors.UninitializableFormat:
1995
raise TestSkipped("Format %s is not initializable." % format)
1997
def make_repository(self, relpath, shared=False, format=None):
1998
"""Create a repository on our default transport at relpath.
2000
Note that relpath must be a relative path, not a full url.
2002
# FIXME: If you create a remoterepository this returns the underlying
2003
# real format, which is incorrect. Actually we should make sure that
2004
# RemoteBzrDir returns a RemoteRepository.
2005
# maybe mbp 20070410
2006
made_control = self.make_bzrdir(relpath, format=format)
2007
return made_control.create_repository(shared=shared)
2009
def make_branch_and_memory_tree(self, relpath, format=None):
2010
"""Create a branch on the default transport and a MemoryTree for it."""
2011
b = self.make_branch(relpath, format=format)
2012
return memorytree.MemoryTree.create_on_branch(b)
2014
def overrideEnvironmentForTesting(self):
2015
os.environ['HOME'] = self.test_home_dir
2016
os.environ['BZR_HOME'] = self.test_home_dir
2019
super(TestCaseWithMemoryTransport, self).setUp()
2020
self._make_test_root()
2021
_currentdir = os.getcwdu()
2022
def _leaveDirectory():
2023
os.chdir(_currentdir)
2024
self.addCleanup(_leaveDirectory)
2025
self.makeAndChdirToTestDir()
2026
self.overrideEnvironmentForTesting()
2027
self.__readonly_server = None
2028
self.__server = None
2029
self.reduceLockdirTimeout()
2032
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2033
"""Derived class that runs a test within a temporary directory.
2035
This is useful for tests that need to create a branch, etc.
2037
The directory is created in a slightly complex way: for each
2038
Python invocation, a new temporary top-level directory is created.
2039
All test cases create their own directory within that. If the
2040
tests complete successfully, the directory is removed.
2042
:ivar test_base_dir: The path of the top-level directory for this
2043
test, which contains a home directory and a work directory.
2045
:ivar test_home_dir: An initially empty directory under test_base_dir
2046
which is used as $HOME for this test.
2048
:ivar test_dir: A directory under test_base_dir used as the current
2049
directory when the test proper is run.
2052
OVERRIDE_PYTHON = 'python'
2054
def check_file_contents(self, filename, expect):
2055
self.log("check contents of file %s" % filename)
2056
contents = file(filename, 'r').read()
2057
if contents != expect:
2058
self.log("expected: %r" % expect)
2059
self.log("actually: %r" % contents)
2060
self.fail("contents of %s not as expected" % filename)
2062
def makeAndChdirToTestDir(self):
2063
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2065
For TestCaseInTempDir we create a temporary directory based on the test
2066
name and then create two subdirs - test and home under it.
2068
# create a directory within the top level test directory
2069
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2070
# now create test and home directories within this dir
2071
self.test_base_dir = candidate_dir
2072
self.test_home_dir = self.test_base_dir + '/home'
2073
os.mkdir(self.test_home_dir)
2074
self.test_dir = self.test_base_dir + '/work'
2075
os.mkdir(self.test_dir)
2076
os.chdir(self.test_dir)
2077
# put name of test inside
2078
f = file(self.test_base_dir + '/name', 'w')
2083
self.addCleanup(self.deleteTestDir)
2085
def deleteTestDir(self):
2086
os.chdir(self.TEST_ROOT)
2087
_rmtree_temp_dir(self.test_base_dir)
2089
def build_tree(self, shape, line_endings='binary', transport=None):
2090
"""Build a test tree according to a pattern.
2092
shape is a sequence of file specifications. If the final
2093
character is '/', a directory is created.
2095
This assumes that all the elements in the tree being built are new.
2097
This doesn't add anything to a branch.
2099
:type shape: list or tuple.
2100
:param line_endings: Either 'binary' or 'native'
2101
in binary mode, exact contents are written in native mode, the
2102
line endings match the default platform endings.
2103
:param transport: A transport to write to, for building trees on VFS's.
2104
If the transport is readonly or None, "." is opened automatically.
2107
if type(shape) not in (list, tuple):
2108
raise AssertionError("Parameter 'shape' should be "
2109
"a list or a tuple. Got %r instead" % (shape,))
2110
# It's OK to just create them using forward slashes on windows.
2111
if transport is None or transport.is_readonly():
2112
transport = get_transport(".")
2114
self.assert_(isinstance(name, basestring))
2116
transport.mkdir(urlutils.escape(name[:-1]))
2118
if line_endings == 'binary':
2120
elif line_endings == 'native':
2123
raise errors.BzrError(
2124
'Invalid line ending request %r' % line_endings)
2125
content = "contents of %s%s" % (name.encode('utf-8'), end)
2126
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2128
def build_tree_contents(self, shape):
2129
build_tree_contents(shape)
2131
def assertInWorkingTree(self, path, root_path='.', tree=None):
2132
"""Assert whether path or paths are in the WorkingTree"""
2134
tree = workingtree.WorkingTree.open(root_path)
2135
if not isinstance(path, basestring):
2137
self.assertInWorkingTree(p,tree=tree)
2139
self.assertIsNot(tree.path2id(path), None,
2140
path+' not in working tree.')
2142
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2143
"""Assert whether path or paths are not in the WorkingTree"""
2145
tree = workingtree.WorkingTree.open(root_path)
2146
if not isinstance(path, basestring):
2148
self.assertNotInWorkingTree(p,tree=tree)
2150
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2153
class TestCaseWithTransport(TestCaseInTempDir):
2154
"""A test case that provides get_url and get_readonly_url facilities.
2156
These back onto two transport servers, one for readonly access and one for
2159
If no explicit class is provided for readonly access, a
2160
ReadonlyTransportDecorator is used instead which allows the use of non disk
2161
based read write transports.
2163
If an explicit class is provided for readonly access, that server and the
2164
readwrite one must both define get_url() as resolving to os.getcwd().
2167
def get_vfs_only_server(self):
2168
"""See TestCaseWithMemoryTransport.
2170
This is useful for some tests with specific servers that need
2173
if self.__vfs_server is None:
2174
self.__vfs_server = self.vfs_transport_factory()
2175
self.__vfs_server.setUp()
2176
self.addCleanup(self.__vfs_server.tearDown)
2177
return self.__vfs_server
2179
def make_branch_and_tree(self, relpath, format=None):
2180
"""Create a branch on the transport and a tree locally.
2182
If the transport is not a LocalTransport, the Tree can't be created on
2183
the transport. In that case if the vfs_transport_factory is
2184
LocalURLServer the working tree is created in the local
2185
directory backing the transport, and the returned tree's branch and
2186
repository will also be accessed locally. Otherwise a lightweight
2187
checkout is created and returned.
2189
:param format: The BzrDirFormat.
2190
:returns: the WorkingTree.
2192
# TODO: always use the local disk path for the working tree,
2193
# this obviously requires a format that supports branch references
2194
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2196
b = self.make_branch(relpath, format=format)
2198
return b.bzrdir.create_workingtree()
2199
except errors.NotLocalUrl:
2200
# We can only make working trees locally at the moment. If the
2201
# transport can't support them, then we keep the non-disk-backed
2202
# branch and create a local checkout.
2203
if self.vfs_transport_factory is LocalURLServer:
2204
# the branch is colocated on disk, we cannot create a checkout.
2205
# hopefully callers will expect this.
2206
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2207
return local_controldir.create_workingtree()
2209
return b.create_checkout(relpath, lightweight=True)
2211
def assertIsDirectory(self, relpath, transport):
2212
"""Assert that relpath within transport is a directory.
2214
This may not be possible on all transports; in that case it propagates
2215
a TransportNotPossible.
2218
mode = transport.stat(relpath).st_mode
2219
except errors.NoSuchFile:
2220
self.fail("path %s is not a directory; no such file"
2222
if not stat.S_ISDIR(mode):
2223
self.fail("path %s is not a directory; has mode %#o"
2226
def assertTreesEqual(self, left, right):
2227
"""Check that left and right have the same content and properties."""
2228
# we use a tree delta to check for equality of the content, and we
2229
# manually check for equality of other things such as the parents list.
2230
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2231
differences = left.changes_from(right)
2232
self.assertFalse(differences.has_changed(),
2233
"Trees %r and %r are different: %r" % (left, right, differences))
2236
super(TestCaseWithTransport, self).setUp()
2237
self.__vfs_server = None
2240
class ChrootedTestCase(TestCaseWithTransport):
2241
"""A support class that provides readonly urls outside the local namespace.
2243
This is done by checking if self.transport_server is a MemoryServer. if it
2244
is then we are chrooted already, if it is not then an HttpServer is used
2247
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2248
be used without needed to redo it when a different
2249
subclass is in use ?
2253
super(ChrootedTestCase, self).setUp()
2254
if not self.vfs_transport_factory == MemoryServer:
2255
self.transport_readonly_server = HttpServer
2258
def condition_id_re(pattern):
2259
"""Create a condition filter which performs a re check on a test's id.
2261
:param pattern: A regular expression string.
2262
:return: A callable that returns True if the re matches.
2264
filter_re = re.compile(pattern)
2265
def condition(test):
2267
return filter_re.search(test_id)
2271
def condition_isinstance(klass_or_klass_list):
2272
"""Create a condition filter which returns isinstance(param, klass).
2274
:return: A callable which when called with one parameter obj return the
2275
result of isinstance(obj, klass_or_klass_list).
2278
return isinstance(obj, klass_or_klass_list)
2282
def condition_id_in_list(id_list):
2283
"""Create a condition filter which verify that test's id in a list.
2285
:param name: A TestIdList object.
2286
:return: A callable that returns True if the test's id appears in the list.
2288
def condition(test):
2289
return id_list.test_in(test.id())
2293
def exclude_tests_by_condition(suite, condition):
2294
"""Create a test suite which excludes some tests from suite.
2296
:param suite: The suite to get tests from.
2297
:param condition: A callable whose result evaluates True when called with a
2298
test case which should be excluded from the result.
2299
:return: A suite which contains the tests found in suite that fail
2303
for test in iter_suite_tests(suite):
2304
if not condition(test):
2306
return TestUtil.TestSuite(result)
2309
def filter_suite_by_condition(suite, condition):
2310
"""Create a test suite by filtering another one.
2312
:param suite: The source suite.
2313
:param condition: A callable whose result evaluates True when called with a
2314
test case which should be included in the result.
2315
:return: A suite which contains the tests found in suite that pass
2319
for test in iter_suite_tests(suite):
2322
return TestUtil.TestSuite(result)
2325
def filter_suite_by_re(suite, pattern, exclude_pattern=DEPRECATED_PARAMETER,
2326
random_order=DEPRECATED_PARAMETER):
2327
"""Create a test suite by filtering another one.
2329
:param suite: the source suite
2330
:param pattern: pattern that names must match
2331
:param exclude_pattern: A pattern that names must not match. This parameter
2332
is deprecated as of bzrlib 1.0. Please use the separate function
2333
exclude_tests_by_re instead.
2334
:param random_order: If True, tests in the new suite will be put in
2335
random order. This parameter is deprecated as of bzrlib 1.0. Please
2336
use the separate function randomize_suite instead.
2337
:returns: the newly created suite
2339
if deprecated_passed(exclude_pattern):
2340
symbol_versioning.warn(
2341
one_zero % "passing exclude_pattern to filter_suite_by_re",
2342
DeprecationWarning, stacklevel=2)
2343
if exclude_pattern is not None:
2344
suite = exclude_tests_by_re(suite, exclude_pattern)
2345
condition = condition_id_re(pattern)
2346
result_suite = filter_suite_by_condition(suite, condition)
2347
if deprecated_passed(random_order):
2348
symbol_versioning.warn(
2349
one_zero % "passing random_order to filter_suite_by_re",
2350
DeprecationWarning, stacklevel=2)
2352
result_suite = randomize_suite(result_suite)
2356
def filter_suite_by_id_list(suite, test_id_list):
2357
"""Create a test suite by filtering another one.
2359
:param suite: The source suite.
2360
:param test_id_list: A list of the test ids to keep as strings.
2361
:returns: the newly created suite
2363
condition = condition_id_in_list(test_id_list)
2364
result_suite = filter_suite_by_condition(suite, condition)
2368
def exclude_tests_by_re(suite, pattern):
2369
"""Create a test suite which excludes some tests from suite.
2371
:param suite: The suite to get tests from.
2372
:param pattern: A regular expression string. Test ids that match this
2373
pattern will be excluded from the result.
2374
:return: A TestSuite that contains all the tests from suite without the
2375
tests that matched pattern. The order of tests is the same as it was in
2378
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2381
def preserve_input(something):
2382
"""A helper for performing test suite transformation chains.
2384
:param something: Anything you want to preserve.
2390
def randomize_suite(suite):
2391
"""Return a new TestSuite with suite's tests in random order.
2393
The tests in the input suite are flattened into a single suite in order to
2394
accomplish this. Any nested TestSuites are removed to provide global
2397
tests = list(iter_suite_tests(suite))
2398
random.shuffle(tests)
2399
return TestUtil.TestSuite(tests)
2402
@deprecated_function(one_zero)
2403
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2404
random_order=False, append_rest=True):
2405
"""DEPRECATED: Create a test suite by sorting another one.
2407
This method has been decomposed into separate helper methods that should be
2409
- filter_suite_by_re
2410
- exclude_tests_by_re
2414
:param suite: the source suite
2415
:param pattern: pattern that names must match in order to go
2416
first in the new suite
2417
:param exclude_pattern: pattern that names must not match, if any
2418
:param random_order: if True, tests in the new suite will be put in
2419
random order (with all tests matching pattern
2421
:param append_rest: if False, pattern is a strict filter and not
2422
just an ordering directive
2423
:returns: the newly created suite
2425
if exclude_pattern is not None:
2426
suite = exclude_tests_by_re(suite, exclude_pattern)
2428
order_changer = randomize_suite
2430
order_changer = preserve_input
2432
suites = map(order_changer, split_suite_by_re(suite, pattern))
2433
return TestUtil.TestSuite(suites)
2435
return order_changer(filter_suite_by_re(suite, pattern))
2438
def split_suite_by_re(suite, pattern):
2439
"""Split a test suite into two by a regular expression.
2441
:param suite: The suite to split.
2442
:param pattern: A regular expression string. Test ids that match this
2443
pattern will be in the first test suite returned, and the others in the
2444
second test suite returned.
2445
:return: A tuple of two test suites, where the first contains tests from
2446
suite matching pattern, and the second contains the remainder from
2447
suite. The order within each output suite is the same as it was in
2452
filter_re = re.compile(pattern)
2453
for test in iter_suite_tests(suite):
2455
if filter_re.search(test_id):
2456
matched.append(test)
2458
did_not_match.append(test)
2459
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2462
def run_suite(suite, name='test', verbose=False, pattern=".*",
2463
stop_on_failure=False,
2464
transport=None, lsprof_timed=None, bench_history=None,
2465
matching_tests_first=None,
2468
exclude_pattern=None,
2470
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2475
runner = TextTestRunner(stream=sys.stdout,
2477
verbosity=verbosity,
2478
bench_history=bench_history,
2479
list_only=list_only,
2481
runner.stop_on_failure=stop_on_failure
2482
# Initialise the random number generator and display the seed used.
2483
# We convert the seed to a long to make it reuseable across invocations.
2484
random_order = False
2485
if random_seed is not None:
2487
if random_seed == "now":
2488
random_seed = long(time.time())
2490
# Convert the seed to a long if we can
2492
random_seed = long(random_seed)
2495
runner.stream.writeln("Randomizing test order using seed %s\n" %
2497
random.seed(random_seed)
2498
# Customise the list of tests if requested
2499
if exclude_pattern is not None:
2500
suite = exclude_tests_by_re(suite, exclude_pattern)
2502
order_changer = randomize_suite
2504
order_changer = preserve_input
2505
if pattern != '.*' or random_order:
2506
if matching_tests_first:
2507
suites = map(order_changer, split_suite_by_re(suite, pattern))
2508
suite = TestUtil.TestSuite(suites)
2510
suite = order_changer(filter_suite_by_re(suite, pattern))
2512
result = runner.run(suite)
2515
return result.wasStrictlySuccessful()
2517
return result.wasSuccessful()
2520
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2522
test_suite_factory=None,
2525
matching_tests_first=None,
2528
exclude_pattern=None,
2532
"""Run the whole test suite under the enhanced runner"""
2533
# XXX: Very ugly way to do this...
2534
# Disable warning about old formats because we don't want it to disturb
2535
# any blackbox tests.
2536
from bzrlib import repository
2537
repository._deprecation_warning_done = True
2539
global default_transport
2540
if transport is None:
2541
transport = default_transport
2542
old_transport = default_transport
2543
default_transport = transport
2545
if load_list is None:
2548
keep_only = load_test_id_list(load_list)
2549
if test_suite_factory is None:
2550
suite = test_suite(keep_only)
2552
suite = test_suite_factory()
2553
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2554
stop_on_failure=stop_on_failure,
2555
transport=transport,
2556
lsprof_timed=lsprof_timed,
2557
bench_history=bench_history,
2558
matching_tests_first=matching_tests_first,
2559
list_only=list_only,
2560
random_seed=random_seed,
2561
exclude_pattern=exclude_pattern,
2564
default_transport = old_transport
2567
def load_test_id_list(file_name):
2568
"""Load a test id list from a text file.
2570
The format is one test id by line. No special care is taken to impose
2571
strict rules, these test ids are used to filter the test suite so a test id
2572
that do not match an existing test will do no harm. This allows user to add
2573
comments, leave blank lines, etc.
2577
ftest = open(file_name, 'rt')
2579
if e.errno != errno.ENOENT:
2582
raise errors.NoSuchFile(file_name)
2584
for test_name in ftest.readlines():
2585
test_list.append(test_name.strip())
2590
class TestIdList(object):
2591
"""Test id list to filter a test suite.
2593
Relying on the assumption that test ids are built as:
2594
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2595
notation, this class offers methods to :
2596
- avoid building a test suite for modules not refered to in the test list,
2597
- keep only the tests listed from the module test suite.
2600
def __init__(self, test_id_list):
2601
# When a test suite needs to be filtered against us we compare test ids
2602
# for equality, so a simple dict offers a quick and simple solution.
2603
self.tests = dict().fromkeys(test_id_list, True)
2605
# While unittest.TestCase have ids like:
2606
# <module>.<class>.<method>[(<param+)],
2607
# doctest.DocTestCase can have ids like:
2610
# <module>.<function>
2611
# <module>.<class>.<method>
2613
# Since we can't predict a test class from its name only, we settle on
2614
# a simple constraint: a test id always begins with its module name.
2617
for test_id in test_id_list:
2618
parts = test_id.split('.')
2619
mod_name = parts.pop(0)
2620
modules[mod_name] = True
2622
mod_name += '.' + part
2623
modules[mod_name] = True
2624
self.modules = modules
2626
def is_module_name_used(self, module_name):
2627
"""Is there tests for the module or one of its sub modules."""
2628
return self.modules.has_key(module_name)
2630
def test_in(self, test_id):
2631
return self.tests.has_key(test_id)
2634
def test_suite(keep_only=None):
2635
"""Build and return TestSuite for the whole of bzrlib.
2637
:param keep_only: A list of test ids limiting the suite returned.
2639
This function can be replaced if you need to change the default test
2640
suite on a global basis, but it is not encouraged.
2643
'bzrlib.util.tests.test_bencode',
2644
'bzrlib.tests.test__dirstate_helpers',
2645
'bzrlib.tests.test_ancestry',
2646
'bzrlib.tests.test_annotate',
2647
'bzrlib.tests.test_api',
2648
'bzrlib.tests.test_atomicfile',
2649
'bzrlib.tests.test_bad_files',
2650
'bzrlib.tests.test_bisect_multi',
2651
'bzrlib.tests.test_branch',
2652
'bzrlib.tests.test_branchbuilder',
2653
'bzrlib.tests.test_bugtracker',
2654
'bzrlib.tests.test_bundle',
2655
'bzrlib.tests.test_bzrdir',
2656
'bzrlib.tests.test_cache_utf8',
2657
'bzrlib.tests.test_commands',
2658
'bzrlib.tests.test_commit',
2659
'bzrlib.tests.test_commit_merge',
2660
'bzrlib.tests.test_config',
2661
'bzrlib.tests.test_conflicts',
2662
'bzrlib.tests.test_counted_lock',
2663
'bzrlib.tests.test_decorators',
2664
'bzrlib.tests.test_delta',
2665
'bzrlib.tests.test_deprecated_graph',
2666
'bzrlib.tests.test_diff',
2667
'bzrlib.tests.test_dirstate',
2668
'bzrlib.tests.test_email_message',
2669
'bzrlib.tests.test_errors',
2670
'bzrlib.tests.test_escaped_store',
2671
'bzrlib.tests.test_extract',
2672
'bzrlib.tests.test_fetch',
2673
'bzrlib.tests.test_ftp_transport',
2674
'bzrlib.tests.test_generate_docs',
2675
'bzrlib.tests.test_generate_ids',
2676
'bzrlib.tests.test_globbing',
2677
'bzrlib.tests.test_gpg',
2678
'bzrlib.tests.test_graph',
2679
'bzrlib.tests.test_hashcache',
2680
'bzrlib.tests.test_help',
2681
'bzrlib.tests.test_hooks',
2682
'bzrlib.tests.test_http',
2683
'bzrlib.tests.test_http_implementations',
2684
'bzrlib.tests.test_http_response',
2685
'bzrlib.tests.test_https_ca_bundle',
2686
'bzrlib.tests.test_identitymap',
2687
'bzrlib.tests.test_ignores',
2688
'bzrlib.tests.test_index',
2689
'bzrlib.tests.test_info',
2690
'bzrlib.tests.test_inv',
2691
'bzrlib.tests.test_knit',
2692
'bzrlib.tests.test_lazy_import',
2693
'bzrlib.tests.test_lazy_regex',
2694
'bzrlib.tests.test_lockdir',
2695
'bzrlib.tests.test_lockable_files',
2696
'bzrlib.tests.test_log',
2697
'bzrlib.tests.test_lsprof',
2698
'bzrlib.tests.test_lru_cache',
2699
'bzrlib.tests.test_mail_client',
2700
'bzrlib.tests.test_memorytree',
2701
'bzrlib.tests.test_merge',
2702
'bzrlib.tests.test_merge3',
2703
'bzrlib.tests.test_merge_core',
2704
'bzrlib.tests.test_merge_directive',
2705
'bzrlib.tests.test_missing',
2706
'bzrlib.tests.test_msgeditor',
2707
'bzrlib.tests.test_multiparent',
2708
'bzrlib.tests.test_nonascii',
2709
'bzrlib.tests.test_options',
2710
'bzrlib.tests.test_osutils',
2711
'bzrlib.tests.test_osutils_encodings',
2712
'bzrlib.tests.test_pack',
2713
'bzrlib.tests.test_patch',
2714
'bzrlib.tests.test_patches',
2715
'bzrlib.tests.test_permissions',
2716
'bzrlib.tests.test_plugins',
2717
'bzrlib.tests.test_progress',
2718
'bzrlib.tests.test_reconfigure',
2719
'bzrlib.tests.test_reconcile',
2720
'bzrlib.tests.test_registry',
2721
'bzrlib.tests.test_remote',
2722
'bzrlib.tests.test_repository',
2723
'bzrlib.tests.test_revert',
2724
'bzrlib.tests.test_revision',
2725
'bzrlib.tests.test_revisionnamespaces',
2726
'bzrlib.tests.test_revisiontree',
2727
'bzrlib.tests.test_rio',
2728
'bzrlib.tests.test_sampler',
2729
'bzrlib.tests.test_selftest',
2730
'bzrlib.tests.test_setup',
2731
'bzrlib.tests.test_sftp_transport',
2732
'bzrlib.tests.test_smart',
2733
'bzrlib.tests.test_smart_add',
2734
'bzrlib.tests.test_smart_transport',
2735
'bzrlib.tests.test_smtp_connection',
2736
'bzrlib.tests.test_source',
2737
'bzrlib.tests.test_ssh_transport',
2738
'bzrlib.tests.test_status',
2739
'bzrlib.tests.test_store',
2740
'bzrlib.tests.test_strace',
2741
'bzrlib.tests.test_subsume',
2742
'bzrlib.tests.test_switch',
2743
'bzrlib.tests.test_symbol_versioning',
2744
'bzrlib.tests.test_tag',
2745
'bzrlib.tests.test_testament',
2746
'bzrlib.tests.test_textfile',
2747
'bzrlib.tests.test_textmerge',
2748
'bzrlib.tests.test_timestamp',
2749
'bzrlib.tests.test_trace',
2750
'bzrlib.tests.test_transactions',
2751
'bzrlib.tests.test_transform',
2752
'bzrlib.tests.test_transport',
2753
'bzrlib.tests.test_tree',
2754
'bzrlib.tests.test_treebuilder',
2755
'bzrlib.tests.test_tsort',
2756
'bzrlib.tests.test_tuned_gzip',
2757
'bzrlib.tests.test_ui',
2758
'bzrlib.tests.test_upgrade',
2759
'bzrlib.tests.test_urlutils',
2760
'bzrlib.tests.test_versionedfile',
2761
'bzrlib.tests.test_version',
2762
'bzrlib.tests.test_version_info',
2763
'bzrlib.tests.test_weave',
2764
'bzrlib.tests.test_whitebox',
2765
'bzrlib.tests.test_win32utils',
2766
'bzrlib.tests.test_workingtree',
2767
'bzrlib.tests.test_workingtree_4',
2768
'bzrlib.tests.test_wsgi',
2769
'bzrlib.tests.test_xml',
2771
test_transport_implementations = [
2772
'bzrlib.tests.test_transport_implementations',
2773
'bzrlib.tests.test_read_bundle',
2775
suite = TestUtil.TestSuite()
2776
loader = TestUtil.TestLoader()
2778
if keep_only is not None:
2779
id_filter = TestIdList(keep_only)
2781
# modules building their suite with loadTestsFromModuleNames
2782
if keep_only is None:
2783
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2785
for mod in [m for m in testmod_names
2786
if id_filter.is_module_name_used(m)]:
2787
mod_suite = loader.loadTestsFromModuleNames([mod])
2788
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2789
suite.addTest(mod_suite)
2791
# modules adapted for transport implementations
2792
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2793
adapter = TransportTestProviderAdapter()
2794
if keep_only is None:
2795
adapt_modules(test_transport_implementations, adapter, loader, suite)
2797
for mod in [m for m in test_transport_implementations
2798
if id_filter.is_module_name_used(m)]:
2799
mod_suite = TestUtil.TestSuite()
2800
adapt_modules([mod], adapter, loader, mod_suite)
2801
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2802
suite.addTest(mod_suite)
2804
# modules defining their own test_suite()
2805
for package in [p for p in packages_to_test()
2806
if (keep_only is None
2807
or id_filter.is_module_name_used(p.__name__))]:
2808
pack_suite = package.test_suite()
2809
if keep_only is not None:
2810
pack_suite = filter_suite_by_id_list(pack_suite, id_filter)
2811
suite.addTest(pack_suite)
2813
# XXX: MODULES_TO_TEST should be obsoleted ?
2814
for mod in [m for m in MODULES_TO_TEST
2815
if keep_only is None or id_filter.is_module_name_used(m)]:
2816
mod_suite = loader.loadTestsFromModule(mod)
2817
if keep_only is not None:
2818
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2819
suite.addTest(mod_suite)
2821
for mod in MODULES_TO_DOCTEST:
2823
doc_suite = doctest.DocTestSuite(mod)
2824
except ValueError, e:
2825
print '**failed to get doctest for: %s\n%s' % (mod, e)
2827
if keep_only is not None:
2828
# DocTests may use ids which doesn't contain the module name
2829
doc_suite = filter_suite_by_id_list(doc_suite, id_filter)
2830
suite.addTest(doc_suite)
2832
default_encoding = sys.getdefaultencoding()
2833
for name, plugin in [(n, p) for (n, p) in bzrlib.plugin.plugins().items()
2834
if (keep_only is None
2835
or id_filter.is_module_name_used(
2836
p.module.__name__))]:
2838
plugin_suite = plugin.test_suite()
2839
except ImportError, e:
2840
bzrlib.trace.warning(
2841
'Unable to test plugin "%s": %s', name, e)
2843
if plugin_suite is not None:
2844
if keep_only is not None:
2845
plugin_suite = filter_suite_by_id_list(plugin_suite,
2847
suite.addTest(plugin_suite)
2848
if default_encoding != sys.getdefaultencoding():
2849
bzrlib.trace.warning(
2850
'Plugin "%s" tried to reset default encoding to: %s', name,
2851
sys.getdefaultencoding())
2853
sys.setdefaultencoding(default_encoding)
2857
def multiply_tests_from_modules(module_name_list, scenario_iter):
2858
"""Adapt all tests in some given modules to given scenarios.
2860
This is the recommended public interface for test parameterization.
2861
Typically the test_suite() method for a per-implementation test
2862
suite will call multiply_tests_from_modules and return the
2865
:param module_name_list: List of fully-qualified names of test
2867
:param scenario_iter: Iterable of pairs of (scenario_name,
2868
scenario_param_dict).
2870
This returns a new TestSuite containing the cross product of
2871
all the tests in all the modules, each repeated for each scenario.
2872
Each test is adapted by adding the scenario name at the end
2873
of its name, and updating the test object's __dict__ with the
2874
scenario_param_dict.
2876
>>> r = multiply_tests_from_modules(
2877
... ['bzrlib.tests.test_sampler'],
2878
... [('one', dict(param=1)),
2879
... ('two', dict(param=2))])
2880
>>> tests = list(iter_suite_tests(r))
2884
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2890
loader = TestLoader()
2892
adapter = TestScenarioApplier()
2893
adapter.scenarios = list(scenario_iter)
2894
adapt_modules(module_name_list, adapter, loader, suite)
2898
def multiply_scenarios(scenarios_left, scenarios_right):
2899
"""Multiply two sets of scenarios.
2901
:returns: the cartesian product of the two sets of scenarios, that is
2902
a scenario for every possible combination of a left scenario and a
2906
('%s,%s' % (left_name, right_name),
2907
dict(left_dict.items() + right_dict.items()))
2908
for left_name, left_dict in scenarios_left
2909
for right_name, right_dict in scenarios_right]
2913
def adapt_modules(mods_list, adapter, loader, suite):
2914
"""Adapt the modules in mods_list using adapter and add to suite."""
2915
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2916
suite.addTests(adapter.adapt(test))
2919
def adapt_tests(tests_list, adapter, loader, suite):
2920
"""Adapt the tests in tests_list using adapter and add to suite."""
2921
for test in tests_list:
2922
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2925
def _rmtree_temp_dir(dirname):
2926
# If LANG=C we probably have created some bogus paths
2927
# which rmtree(unicode) will fail to delete
2928
# so make sure we are using rmtree(str) to delete everything
2929
# except on win32, where rmtree(str) will fail
2930
# since it doesn't have the property of byte-stream paths
2931
# (they are either ascii or mbcs)
2932
if sys.platform == 'win32':
2933
# make sure we are using the unicode win32 api
2934
dirname = unicode(dirname)
2936
dirname = dirname.encode(sys.getfilesystemencoding())
2938
osutils.rmtree(dirname)
2940
if sys.platform == 'win32' and e.errno == errno.EACCES:
2941
sys.stderr.write(('Permission denied: '
2942
'unable to remove testing dir '
2943
'%s\n' % os.path.basename(dirname)))
2948
class Feature(object):
2949
"""An operating system Feature."""
2952
self._available = None
2954
def available(self):
2955
"""Is the feature available?
2957
:return: True if the feature is available.
2959
if self._available is None:
2960
self._available = self._probe()
2961
return self._available
2964
"""Implement this method in concrete features.
2966
:return: True if the feature is available.
2968
raise NotImplementedError
2971
if getattr(self, 'feature_name', None):
2972
return self.feature_name()
2973
return self.__class__.__name__
2976
class _SymlinkFeature(Feature):
2979
return osutils.has_symlinks()
2981
def feature_name(self):
2984
SymlinkFeature = _SymlinkFeature()
2987
class _OsFifoFeature(Feature):
2990
return getattr(os, 'mkfifo', None)
2992
def feature_name(self):
2993
return 'filesystem fifos'
2995
OsFifoFeature = _OsFifoFeature()
2998
class TestScenarioApplier(object):
2999
"""A tool to apply scenarios to tests."""
3001
def adapt(self, test):
3002
"""Return a TestSuite containing a copy of test for each scenario."""
3003
result = unittest.TestSuite()
3004
for scenario in self.scenarios:
3005
result.addTest(self.adapt_test_to_scenario(test, scenario))
3008
def adapt_test_to_scenario(self, test, scenario):
3009
"""Copy test and apply scenario to it.
3011
:param test: A test to adapt.
3012
:param scenario: A tuple describing the scenarion.
3013
The first element of the tuple is the new test id.
3014
The second element is a dict containing attributes to set on the
3016
:return: The adapted test.
3018
from copy import deepcopy
3019
new_test = deepcopy(test)
3020
for name, value in scenario[1].items():
3021
setattr(new_test, name, value)
3022
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3023
new_test.id = lambda: new_id
3027
def probe_unicode_in_user_encoding():
3028
"""Try to encode several unicode strings to use in unicode-aware tests.
3029
Return first successfull match.
3031
:return: (unicode value, encoded plain string value) or (None, None)
3033
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3034
for uni_val in possible_vals:
3036
str_val = uni_val.encode(bzrlib.user_encoding)
3037
except UnicodeEncodeError:
3038
# Try a different character
3041
return uni_val, str_val
3045
def probe_bad_non_ascii(encoding):
3046
"""Try to find [bad] character with code [128..255]
3047
that cannot be decoded to unicode in some encoding.
3048
Return None if all non-ascii characters is valid
3051
for i in xrange(128, 256):
3054
char.decode(encoding)
3055
except UnicodeDecodeError:
3060
class _FTPServerFeature(Feature):
3061
"""Some tests want an FTP Server, check if one is available.
3063
Right now, the only way this is available is if 'medusa' is installed.
3064
http://www.amk.ca/python/code/medusa.html
3069
import bzrlib.tests.ftp_server
3074
def feature_name(self):
3077
FTPServerFeature = _FTPServerFeature()
3080
class _CaseInsensitiveFilesystemFeature(Feature):
3081
"""Check if underlined filesystem is case-insensitive
3082
(e.g. on Windows, Cygwin, MacOS)
3086
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3087
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3088
TestCaseWithMemoryTransport.TEST_ROOT = root
3090
root = TestCaseWithMemoryTransport.TEST_ROOT
3091
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3093
name_a = osutils.pathjoin(tdir, 'a')
3094
name_A = osutils.pathjoin(tdir, 'A')
3096
result = osutils.isdir(name_A)
3097
_rmtree_temp_dir(tdir)
3100
def feature_name(self):
3101
return 'case-insensitive filesystem'
3103
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
