1
# Copyright (C) 2005, 2006, 2007 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
unittest.TestResult.addError(self, test, err)
279
self.error_count += 1
280
self.report_error(test, err)
284
def addFailure(self, test, err):
285
"""Tell result that test failed.
287
Called from the TestCase run() method when the test
288
fails because e.g. an assert() method failed.
290
self._testConcluded(test)
291
if isinstance(err[1], KnownFailure):
292
return self._addKnownFailure(test, err)
294
unittest.TestResult.addFailure(self, test, err)
295
self.failure_count += 1
296
self.report_failure(test, err)
300
def addSuccess(self, test):
301
"""Tell result that test completed successfully.
303
Called from the TestCase run()
305
self._testConcluded(test)
306
if self._bench_history is not None:
307
benchmark_time = self._extractBenchmarkTime(test)
308
if benchmark_time is not None:
309
self._bench_history.write("%s %s\n" % (
310
self._formatTime(benchmark_time),
312
self.report_success(test)
313
unittest.TestResult.addSuccess(self, test)
315
def _testConcluded(self, test):
316
"""Common code when a test has finished.
318
Called regardless of whether it succeded, failed, etc.
320
self._cleanupLogFile(test)
322
def _addKnownFailure(self, test, err):
323
self.known_failure_count += 1
324
self.report_known_failure(test, err)
326
def addNotSupported(self, test, feature):
327
"""The test will not be run because of a missing feature.
329
# this can be called in two different ways: it may be that the
330
# test started running, and then raised (through addError)
331
# UnavailableFeature. Alternatively this method can be called
332
# while probing for features before running the tests; in that
333
# case we will see startTest and stopTest, but the test will never
335
self.unsupported.setdefault(str(feature), 0)
336
self.unsupported[str(feature)] += 1
337
self.report_unsupported(test, feature)
339
def _addSkipped(self, test, skip_excinfo):
340
if isinstance(skip_excinfo[1], TestNotApplicable):
341
self.not_applicable_count += 1
342
self.report_not_applicable(test, skip_excinfo)
345
self.report_skip(test, skip_excinfo)
348
except KeyboardInterrupt:
351
self.addError(test, test._exc_info())
353
# seems best to treat this as success from point-of-view of unittest
354
# -- it actually does nothing so it barely matters :)
355
unittest.TestResult.addSuccess(self, test)
357
def printErrorList(self, flavour, errors):
358
for test, err in errors:
359
self.stream.writeln(self.separator1)
360
self.stream.write("%s: " % flavour)
361
self.stream.writeln(self.getDescription(test))
362
if getattr(test, '_get_log', None) is not None:
363
self.stream.write('\n')
365
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
366
self.stream.write('\n')
367
self.stream.write(test._get_log())
368
self.stream.write('\n')
370
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
371
self.stream.write('\n')
372
self.stream.writeln(self.separator2)
373
self.stream.writeln("%s" % err)
378
def report_cleaning_up(self):
381
def report_success(self, test):
384
def wasStrictlySuccessful(self):
385
if self.unsupported or self.known_failure_count:
387
return self.wasSuccessful()
390
class TextTestResult(ExtendedTestResult):
391
"""Displays progress and results of tests in text form"""
393
def __init__(self, stream, descriptions, verbosity,
398
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
399
bench_history, num_tests)
401
self.pb = self.ui.nested_progress_bar()
402
self._supplied_pb = False
405
self._supplied_pb = True
406
self.pb.show_pct = False
407
self.pb.show_spinner = False
408
self.pb.show_eta = False,
409
self.pb.show_count = False
410
self.pb.show_bar = False
412
def report_starting(self):
413
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
415
def _progress_prefix_text(self):
416
a = '[%d' % self.count
417
if self.num_tests is not None:
418
a +='/%d' % self.num_tests
419
a += ' in %ds' % (time.time() - self._overall_start_time)
421
a += ', %d errors' % self.error_count
422
if self.failure_count:
423
a += ', %d failed' % self.failure_count
424
if self.known_failure_count:
425
a += ', %d known failures' % self.known_failure_count
427
a += ', %d skipped' % self.skip_count
429
a += ', %d missing features' % len(self.unsupported)
433
def report_test_start(self, test):
436
self._progress_prefix_text()
438
+ self._shortened_test_description(test))
440
def _test_description(self, test):
441
return self._shortened_test_description(test)
443
def report_error(self, test, err):
444
self.pb.note('ERROR: %s\n %s\n',
445
self._test_description(test),
449
def report_failure(self, test, err):
450
self.pb.note('FAIL: %s\n %s\n',
451
self._test_description(test),
455
def report_known_failure(self, test, err):
456
self.pb.note('XFAIL: %s\n%s\n',
457
self._test_description(test), err[1])
459
def report_skip(self, test, skip_excinfo):
462
def report_not_applicable(self, test, skip_excinfo):
465
def report_unsupported(self, test, feature):
466
"""test cannot be run because feature is missing."""
468
def report_cleaning_up(self):
469
self.pb.update('cleaning up...')
472
if not self._supplied_pb:
476
class VerboseTestResult(ExtendedTestResult):
477
"""Produce long output, with one line per test run plus times"""
479
def _ellipsize_to_right(self, a_string, final_width):
480
"""Truncate and pad a string, keeping the right hand side"""
481
if len(a_string) > final_width:
482
result = '...' + a_string[3-final_width:]
485
return result.ljust(final_width)
487
def report_starting(self):
488
self.stream.write('running %d tests...\n' % self.num_tests)
490
def report_test_start(self, test):
492
name = self._shortened_test_description(test)
493
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
494
# numbers, plus a trailing blank
495
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
496
self.stream.write(self._ellipsize_to_right(name,
497
osutils.terminal_width()-30))
500
def _error_summary(self, err):
502
return '%s%s' % (indent, err[1])
504
def report_error(self, test, err):
505
self.stream.writeln('ERROR %s\n%s'
506
% (self._testTimeString(test),
507
self._error_summary(err)))
509
def report_failure(self, test, err):
510
self.stream.writeln(' FAIL %s\n%s'
511
% (self._testTimeString(test),
512
self._error_summary(err)))
514
def report_known_failure(self, test, err):
515
self.stream.writeln('XFAIL %s\n%s'
516
% (self._testTimeString(test),
517
self._error_summary(err)))
519
def report_success(self, test):
520
self.stream.writeln(' OK %s' % self._testTimeString(test))
521
for bench_called, stats in getattr(test, '_benchcalls', []):
522
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
523
stats.pprint(file=self.stream)
524
# flush the stream so that we get smooth output. This verbose mode is
525
# used to show the output in PQM.
528
def report_skip(self, test, skip_excinfo):
529
self.stream.writeln(' SKIP %s\n%s'
530
% (self._testTimeString(test),
531
self._error_summary(skip_excinfo)))
533
def report_not_applicable(self, test, skip_excinfo):
534
self.stream.writeln(' N/A %s\n%s'
535
% (self._testTimeString(test),
536
self._error_summary(skip_excinfo)))
538
def report_unsupported(self, test, feature):
539
"""test cannot be run because feature is missing."""
540
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
541
%(self._testTimeString(test), feature))
544
class TextTestRunner(object):
545
stop_on_failure = False
554
self.stream = unittest._WritelnDecorator(stream)
555
self.descriptions = descriptions
556
self.verbosity = verbosity
557
self._bench_history = bench_history
558
self.list_only = list_only
561
"Run the given test case or test suite."
562
startTime = time.time()
563
if self.verbosity == 1:
564
result_class = TextTestResult
565
elif self.verbosity >= 2:
566
result_class = VerboseTestResult
567
result = result_class(self.stream,
570
bench_history=self._bench_history,
571
num_tests=test.countTestCases(),
573
result.stop_early = self.stop_on_failure
574
result.report_starting()
576
if self.verbosity >= 2:
577
self.stream.writeln("Listing tests only ...\n")
579
for t in iter_suite_tests(test):
580
self.stream.writeln("%s" % (t.id()))
582
actionTaken = "Listed"
585
run = result.testsRun
587
stopTime = time.time()
588
timeTaken = stopTime - startTime
590
self.stream.writeln(result.separator2)
591
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
592
run, run != 1 and "s" or "", timeTaken))
593
self.stream.writeln()
594
if not result.wasSuccessful():
595
self.stream.write("FAILED (")
596
failed, errored = map(len, (result.failures, result.errors))
598
self.stream.write("failures=%d" % failed)
600
if failed: self.stream.write(", ")
601
self.stream.write("errors=%d" % errored)
602
if result.known_failure_count:
603
if failed or errored: self.stream.write(", ")
604
self.stream.write("known_failure_count=%d" %
605
result.known_failure_count)
606
self.stream.writeln(")")
608
if result.known_failure_count:
609
self.stream.writeln("OK (known_failures=%d)" %
610
result.known_failure_count)
612
self.stream.writeln("OK")
613
if result.skip_count > 0:
614
skipped = result.skip_count
615
self.stream.writeln('%d test%s skipped' %
616
(skipped, skipped != 1 and "s" or ""))
617
if result.unsupported:
618
for feature, count in sorted(result.unsupported.items()):
619
self.stream.writeln("Missing feature '%s' skipped %d tests." %
625
def iter_suite_tests(suite):
626
"""Return all tests in a suite, recursing through nested suites"""
627
for item in suite._tests:
628
if isinstance(item, unittest.TestCase):
630
elif isinstance(item, unittest.TestSuite):
631
for r in iter_suite_tests(item):
634
raise Exception('unknown object %r inside test suite %r'
638
class TestSkipped(Exception):
639
"""Indicates that a test was intentionally skipped, rather than failing."""
642
class TestNotApplicable(TestSkipped):
643
"""A test is not applicable to the situation where it was run.
645
This is only normally raised by parameterized tests, if they find that
646
the instance they're constructed upon does not support one aspect
651
class KnownFailure(AssertionError):
652
"""Indicates that a test failed in a precisely expected manner.
654
Such failures dont block the whole test suite from passing because they are
655
indicators of partially completed code or of future work. We have an
656
explicit error for them so that we can ensure that they are always visible:
657
KnownFailures are always shown in the output of bzr selftest.
661
class UnavailableFeature(Exception):
662
"""A feature required for this test was not available.
664
The feature should be used to construct the exception.
668
class CommandFailed(Exception):
672
class StringIOWrapper(object):
673
"""A wrapper around cStringIO which just adds an encoding attribute.
675
Internally we can check sys.stdout to see what the output encoding
676
should be. However, cStringIO has no encoding attribute that we can
677
set. So we wrap it instead.
682
def __init__(self, s=None):
684
self.__dict__['_cstring'] = StringIO(s)
686
self.__dict__['_cstring'] = StringIO()
688
def __getattr__(self, name, getattr=getattr):
689
return getattr(self.__dict__['_cstring'], name)
691
def __setattr__(self, name, val):
692
if name == 'encoding':
693
self.__dict__['encoding'] = val
695
return setattr(self._cstring, name, val)
698
class TestUIFactory(ui.CLIUIFactory):
699
"""A UI Factory for testing.
701
Hide the progress bar but emit note()s.
703
Allows get_password to be tested without real tty attached.
710
super(TestUIFactory, self).__init__()
711
if stdin is not None:
712
# We use a StringIOWrapper to be able to test various
713
# encodings, but the user is still responsible to
714
# encode the string and to set the encoding attribute
715
# of StringIOWrapper.
716
self.stdin = StringIOWrapper(stdin)
718
self.stdout = sys.stdout
722
self.stderr = sys.stderr
727
"""See progress.ProgressBar.clear()."""
729
def clear_term(self):
730
"""See progress.ProgressBar.clear_term()."""
732
def clear_term(self):
733
"""See progress.ProgressBar.clear_term()."""
736
"""See progress.ProgressBar.finished()."""
738
def note(self, fmt_string, *args, **kwargs):
739
"""See progress.ProgressBar.note()."""
740
self.stdout.write((fmt_string + "\n") % args)
742
def progress_bar(self):
745
def nested_progress_bar(self):
748
def update(self, message, count=None, total=None):
749
"""See progress.ProgressBar.update()."""
751
def get_non_echoed_password(self, prompt):
752
"""Get password from stdin without trying to handle the echo mode"""
754
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
755
password = self.stdin.readline()
758
if password[-1] == '\n':
759
password = password[:-1]
763
class TestCase(unittest.TestCase):
764
"""Base class for bzr unit tests.
766
Tests that need access to disk resources should subclass
767
TestCaseInTempDir not TestCase.
769
Error and debug log messages are redirected from their usual
770
location into a temporary file, the contents of which can be
771
retrieved by _get_log(). We use a real OS file, not an in-memory object,
772
so that it can also capture file IO. When the test completes this file
773
is read into memory and removed from disk.
775
There are also convenience functions to invoke bzr's command-line
776
routine, and to build and check bzr trees.
778
In addition to the usual method of overriding tearDown(), this class also
779
allows subclasses to register functions into the _cleanups list, which is
780
run in order as the object is torn down. It's less likely this will be
781
accidentally overlooked.
784
_log_file_name = None
786
_keep_log_file = False
787
# record lsprof data when performing benchmark calls.
788
_gather_lsprof_in_benchmarks = False
790
def __init__(self, methodName='testMethod'):
791
super(TestCase, self).__init__(methodName)
795
unittest.TestCase.setUp(self)
796
self._cleanEnvironment()
797
bzrlib.trace.disable_default_logging()
800
self._benchcalls = []
801
self._benchtime = None
803
self._clear_debug_flags()
805
def _clear_debug_flags(self):
806
"""Prevent externally set debug flags affecting tests.
808
Tests that want to use debug flags can just set them in the
809
debug_flags set during setup/teardown.
811
self._preserved_debug_flags = set(debug.debug_flags)
812
debug.debug_flags.clear()
813
self.addCleanup(self._restore_debug_flags)
815
def _clear_hooks(self):
816
# prevent hooks affecting tests
818
import bzrlib.smart.server
819
self._preserved_hooks = {
820
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
821
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
823
self.addCleanup(self._restoreHooks)
824
# reset all hooks to an empty instance of the appropriate type
825
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
826
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
828
def _silenceUI(self):
829
"""Turn off UI for duration of test"""
830
# by default the UI is off; tests can turn it on if they want it.
831
saved = ui.ui_factory
833
ui.ui_factory = saved
834
ui.ui_factory = ui.SilentUIFactory()
835
self.addCleanup(_restore)
837
def _ndiff_strings(self, a, b):
838
"""Return ndiff between two strings containing lines.
840
A trailing newline is added if missing to make the strings
842
if b and b[-1] != '\n':
844
if a and a[-1] != '\n':
846
difflines = difflib.ndiff(a.splitlines(True),
848
linejunk=lambda x: False,
849
charjunk=lambda x: False)
850
return ''.join(difflines)
852
def assertEqual(self, a, b, message=''):
856
except UnicodeError, e:
857
# If we can't compare without getting a UnicodeError, then
858
# obviously they are different
859
mutter('UnicodeError: %s', e)
862
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
864
pformat(a), pformat(b)))
866
assertEquals = assertEqual
868
def assertEqualDiff(self, a, b, message=None):
869
"""Assert two texts are equal, if not raise an exception.
871
This is intended for use with multi-line strings where it can
872
be hard to find the differences by eye.
874
# TODO: perhaps override assertEquals to call this for strings?
878
message = "texts not equal:\n"
879
raise AssertionError(message +
880
self._ndiff_strings(a, b))
882
def assertEqualMode(self, mode, mode_test):
883
self.assertEqual(mode, mode_test,
884
'mode mismatch %o != %o' % (mode, mode_test))
886
def assertPositive(self, val):
887
"""Assert that val is greater than 0."""
888
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
890
def assertNegative(self, val):
891
"""Assert that val is less than 0."""
892
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
894
def assertStartsWith(self, s, prefix):
895
if not s.startswith(prefix):
896
raise AssertionError('string %r does not start with %r' % (s, prefix))
898
def assertEndsWith(self, s, suffix):
899
"""Asserts that s ends with suffix."""
900
if not s.endswith(suffix):
901
raise AssertionError('string %r does not end with %r' % (s, suffix))
903
def assertContainsRe(self, haystack, needle_re):
904
"""Assert that a contains something matching a regular expression."""
905
if not re.search(needle_re, haystack):
906
if '\n' in haystack or len(haystack) > 60:
907
# a long string, format it in a more readable way
908
raise AssertionError(
909
'pattern "%s" not found in\n"""\\\n%s"""\n'
910
% (needle_re, haystack))
912
raise AssertionError('pattern "%s" not found in "%s"'
913
% (needle_re, haystack))
915
def assertNotContainsRe(self, haystack, needle_re):
916
"""Assert that a does not match a regular expression"""
917
if re.search(needle_re, haystack):
918
raise AssertionError('pattern "%s" found in "%s"'
919
% (needle_re, haystack))
921
def assertSubset(self, sublist, superlist):
922
"""Assert that every entry in sublist is present in superlist."""
923
missing = set(sublist) - set(superlist)
925
raise AssertionError("value(s) %r not present in container %r" %
926
(missing, superlist))
928
def assertListRaises(self, excClass, func, *args, **kwargs):
929
"""Fail unless excClass is raised when the iterator from func is used.
931
Many functions can return generators this makes sure
932
to wrap them in a list() call to make sure the whole generator
933
is run, and that the proper exception is raised.
936
list(func(*args, **kwargs))
940
if getattr(excClass,'__name__', None) is not None:
941
excName = excClass.__name__
943
excName = str(excClass)
944
raise self.failureException, "%s not raised" % excName
946
def assertRaises(self, excClass, callableObj, *args, **kwargs):
947
"""Assert that a callable raises a particular exception.
949
:param excClass: As for the except statement, this may be either an
950
exception class, or a tuple of classes.
951
:param callableObj: A callable, will be passed ``*args`` and
954
Returns the exception so that you can examine it.
957
callableObj(*args, **kwargs)
961
if getattr(excClass,'__name__', None) is not None:
962
excName = excClass.__name__
965
excName = str(excClass)
966
raise self.failureException, "%s not raised" % excName
968
def assertIs(self, left, right, message=None):
969
if not (left is right):
970
if message is not None:
971
raise AssertionError(message)
973
raise AssertionError("%r is not %r." % (left, right))
975
def assertIsNot(self, left, right, message=None):
977
if message is not None:
978
raise AssertionError(message)
980
raise AssertionError("%r is %r." % (left, right))
982
def assertTransportMode(self, transport, path, mode):
983
"""Fail if a path does not have mode mode.
985
If modes are not supported on this transport, the assertion is ignored.
987
if not transport._can_roundtrip_unix_modebits():
989
path_stat = transport.stat(path)
990
actual_mode = stat.S_IMODE(path_stat.st_mode)
991
self.assertEqual(mode, actual_mode,
992
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
994
def assertIsSameRealPath(self, path1, path2):
995
"""Fail if path1 and path2 points to different files"""
996
self.assertEqual(osutils.realpath(path1),
997
osutils.realpath(path2),
998
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
1000
def assertIsInstance(self, obj, kls):
1001
"""Fail if obj is not an instance of kls"""
1002
if not isinstance(obj, kls):
1003
self.fail("%r is an instance of %s rather than %s" % (
1004
obj, obj.__class__, kls))
1006
def expectFailure(self, reason, assertion, *args, **kwargs):
1007
"""Invoke a test, expecting it to fail for the given reason.
1009
This is for assertions that ought to succeed, but currently fail.
1010
(The failure is *expected* but not *wanted*.) Please be very precise
1011
about the failure you're expecting. If a new bug is introduced,
1012
AssertionError should be raised, not KnownFailure.
1014
Frequently, expectFailure should be followed by an opposite assertion.
1017
Intended to be used with a callable that raises AssertionError as the
1018
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1020
Raises KnownFailure if the test fails. Raises AssertionError if the
1025
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1027
self.assertEqual(42, dynamic_val)
1029
This means that a dynamic_val of 54 will cause the test to raise
1030
a KnownFailure. Once math is fixed and the expectFailure is removed,
1031
only a dynamic_val of 42 will allow the test to pass. Anything other
1032
than 54 or 42 will cause an AssertionError.
1035
assertion(*args, **kwargs)
1036
except AssertionError:
1037
raise KnownFailure(reason)
1039
self.fail('Unexpected success. Should have failed: %s' % reason)
1041
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1042
"""A helper for callDeprecated and applyDeprecated.
1044
:param a_callable: A callable to call.
1045
:param args: The positional arguments for the callable
1046
:param kwargs: The keyword arguments for the callable
1047
:return: A tuple (warnings, result). result is the result of calling
1048
a_callable(``*args``, ``**kwargs``).
1051
def capture_warnings(msg, cls=None, stacklevel=None):
1052
# we've hooked into a deprecation specific callpath,
1053
# only deprecations should getting sent via it.
1054
self.assertEqual(cls, DeprecationWarning)
1055
local_warnings.append(msg)
1056
original_warning_method = symbol_versioning.warn
1057
symbol_versioning.set_warning_method(capture_warnings)
1059
result = a_callable(*args, **kwargs)
1061
symbol_versioning.set_warning_method(original_warning_method)
1062
return (local_warnings, result)
1064
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1065
"""Call a deprecated callable without warning the user.
1067
Note that this only captures warnings raised by symbol_versioning.warn,
1068
not other callers that go direct to the warning module.
1070
To test that a deprecated method raises an error, do something like
1073
self.assertRaises(errors.ReservedId,
1074
self.applyDeprecated, zero_ninetyone,
1075
br.append_revision, 'current:')
1077
:param deprecation_format: The deprecation format that the callable
1078
should have been deprecated with. This is the same type as the
1079
parameter to deprecated_method/deprecated_function. If the
1080
callable is not deprecated with this format, an assertion error
1082
:param a_callable: A callable to call. This may be a bound method or
1083
a regular function. It will be called with ``*args`` and
1085
:param args: The positional arguments for the callable
1086
:param kwargs: The keyword arguments for the callable
1087
:return: The result of a_callable(``*args``, ``**kwargs``)
1089
call_warnings, result = self._capture_deprecation_warnings(a_callable,
1091
expected_first_warning = symbol_versioning.deprecation_string(
1092
a_callable, deprecation_format)
1093
if len(call_warnings) == 0:
1094
self.fail("No deprecation warning generated by call to %s" %
1096
self.assertEqual(expected_first_warning, call_warnings[0])
1099
def callCatchWarnings(self, fn, *args, **kw):
1100
"""Call a callable that raises python warnings.
1102
The caller's responsible for examining the returned warnings.
1104
If the callable raises an exception, the exception is not
1105
caught and propagates up to the caller. In that case, the list
1106
of warnings is not available.
1108
:returns: ([warning_object, ...], fn_result)
1110
# XXX: This is not perfect, because it completely overrides the
1111
# warnings filters, and some code may depend on suppressing particular
1112
# warnings. It's the easiest way to insulate ourselves from -Werror,
1113
# though. -- Andrew, 20071062
1115
def _catcher(message, category, filename, lineno, file=None):
1116
# despite the name, 'message' is normally(?) a Warning subclass
1118
wlist.append(message)
1119
saved_showwarning = warnings.showwarning
1120
saved_filters = warnings.filters
1122
warnings.showwarning = _catcher
1123
warnings.filters = []
1124
result = fn(*args, **kw)
1126
warnings.showwarning = saved_showwarning
1127
warnings.filters = saved_filters
1128
return wlist, result
1130
def callDeprecated(self, expected, callable, *args, **kwargs):
1131
"""Assert that a callable is deprecated in a particular way.
1133
This is a very precise test for unusual requirements. The
1134
applyDeprecated helper function is probably more suited for most tests
1135
as it allows you to simply specify the deprecation format being used
1136
and will ensure that that is issued for the function being called.
1138
Note that this only captures warnings raised by symbol_versioning.warn,
1139
not other callers that go direct to the warning module. To catch
1140
general warnings, use callCatchWarnings.
1142
:param expected: a list of the deprecation warnings expected, in order
1143
:param callable: The callable to call
1144
:param args: The positional arguments for the callable
1145
:param kwargs: The keyword arguments for the callable
1147
call_warnings, result = self._capture_deprecation_warnings(callable,
1149
self.assertEqual(expected, call_warnings)
1152
def _startLogFile(self):
1153
"""Send bzr and test log messages to a temporary file.
1155
The file is removed as the test is torn down.
1157
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1158
self._log_file = os.fdopen(fileno, 'w+')
1159
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1160
self._log_file_name = name
1161
self.addCleanup(self._finishLogFile)
1163
def _finishLogFile(self):
1164
"""Finished with the log file.
1166
Close the file and delete it, unless setKeepLogfile was called.
1168
if self._log_file is None:
1170
bzrlib.trace.disable_test_log(self._log_nonce)
1171
self._log_file.close()
1172
self._log_file = None
1173
if not self._keep_log_file:
1174
os.remove(self._log_file_name)
1175
self._log_file_name = None
1177
def setKeepLogfile(self):
1178
"""Make the logfile not be deleted when _finishLogFile is called."""
1179
self._keep_log_file = True
1181
def addCleanup(self, callable):
1182
"""Arrange to run a callable when this case is torn down.
1184
Callables are run in the reverse of the order they are registered,
1185
ie last-in first-out.
1187
if callable in self._cleanups:
1188
raise ValueError("cleanup function %r already registered on %s"
1190
self._cleanups.append(callable)
1192
def _cleanEnvironment(self):
1194
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1195
'HOME': os.getcwd(),
1196
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1197
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1199
'BZREMAIL': None, # may still be present in the environment
1201
'BZR_PROGRESS_BAR': None,
1203
'SSH_AUTH_SOCK': None,
1207
'https_proxy': None,
1208
'HTTPS_PROXY': None,
1213
# Nobody cares about these ones AFAIK. So far at
1214
# least. If you do (care), please update this comment
1218
'BZR_REMOTE_PATH': None,
1221
self.addCleanup(self._restoreEnvironment)
1222
for name, value in new_env.iteritems():
1223
self._captureVar(name, value)
1225
def _captureVar(self, name, newvalue):
1226
"""Set an environment variable, and reset it when finished."""
1227
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1229
def _restore_debug_flags(self):
1230
debug.debug_flags.clear()
1231
debug.debug_flags.update(self._preserved_debug_flags)
1233
def _restoreEnvironment(self):
1234
for name, value in self.__old_env.iteritems():
1235
osutils.set_or_unset_env(name, value)
1237
def _restoreHooks(self):
1238
for klass, hooks in self._preserved_hooks.items():
1239
setattr(klass, 'hooks', hooks)
1241
def knownFailure(self, reason):
1242
"""This test has failed for some known reason."""
1243
raise KnownFailure(reason)
1245
def run(self, result=None):
1246
if result is None: result = self.defaultTestResult()
1247
for feature in getattr(self, '_test_needs_features', []):
1248
if not feature.available():
1249
result.startTest(self)
1250
if getattr(result, 'addNotSupported', None):
1251
result.addNotSupported(self, feature)
1253
result.addSuccess(self)
1254
result.stopTest(self)
1256
return unittest.TestCase.run(self, result)
1260
unittest.TestCase.tearDown(self)
1262
def time(self, callable, *args, **kwargs):
1263
"""Run callable and accrue the time it takes to the benchmark time.
1265
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1266
this will cause lsprofile statistics to be gathered and stored in
1269
if self._benchtime is None:
1273
if not self._gather_lsprof_in_benchmarks:
1274
return callable(*args, **kwargs)
1276
# record this benchmark
1277
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1279
self._benchcalls.append(((callable, args, kwargs), stats))
1282
self._benchtime += time.time() - start
1284
def _runCleanups(self):
1285
"""Run registered cleanup functions.
1287
This should only be called from TestCase.tearDown.
1289
# TODO: Perhaps this should keep running cleanups even if
1290
# one of them fails?
1292
# Actually pop the cleanups from the list so tearDown running
1293
# twice is safe (this happens for skipped tests).
1294
while self._cleanups:
1295
self._cleanups.pop()()
1297
def log(self, *args):
1300
def _get_log(self, keep_log_file=False):
1301
"""Get the log from bzrlib.trace calls from this test.
1303
:param keep_log_file: When True, if the log is still a file on disk
1304
leave it as a file on disk. When False, if the log is still a file
1305
on disk, the log file is deleted and the log preserved as
1307
:return: A string containing the log.
1309
# flush the log file, to get all content
1311
bzrlib.trace._trace_file.flush()
1312
if self._log_contents:
1313
return self._log_contents
1314
if self._log_file_name is not None:
1315
logfile = open(self._log_file_name)
1317
log_contents = logfile.read()
1320
if not keep_log_file:
1321
self._log_contents = log_contents
1323
os.remove(self._log_file_name)
1325
if sys.platform == 'win32' and e.errno == errno.EACCES:
1326
sys.stderr.write(('Unable to delete log file '
1327
' %r\n' % self._log_file_name))
1332
return "DELETED log file to reduce memory footprint"
1334
def requireFeature(self, feature):
1335
"""This test requires a specific feature is available.
1337
:raises UnavailableFeature: When feature is not available.
1339
if not feature.available():
1340
raise UnavailableFeature(feature)
1342
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1344
"""Run bazaar command line, splitting up a string command line."""
1345
if isinstance(args, basestring):
1346
# shlex don't understand unicode strings,
1347
# so args should be plain string (bialix 20070906)
1348
args = list(shlex.split(str(args)))
1349
return self._run_bzr_core(args, retcode=retcode,
1350
encoding=encoding, stdin=stdin, working_dir=working_dir,
1353
def _run_bzr_core(self, args, retcode, encoding, stdin,
1355
if encoding is None:
1356
encoding = bzrlib.user_encoding
1357
stdout = StringIOWrapper()
1358
stderr = StringIOWrapper()
1359
stdout.encoding = encoding
1360
stderr.encoding = encoding
1362
self.log('run bzr: %r', args)
1363
# FIXME: don't call into logging here
1364
handler = logging.StreamHandler(stderr)
1365
handler.setLevel(logging.INFO)
1366
logger = logging.getLogger('')
1367
logger.addHandler(handler)
1368
old_ui_factory = ui.ui_factory
1369
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1372
if working_dir is not None:
1373
cwd = osutils.getcwd()
1374
os.chdir(working_dir)
1377
result = self.apply_redirected(ui.ui_factory.stdin,
1379
bzrlib.commands.run_bzr_catch_user_errors,
1382
logger.removeHandler(handler)
1383
ui.ui_factory = old_ui_factory
1387
out = stdout.getvalue()
1388
err = stderr.getvalue()
1390
self.log('output:\n%r', out)
1392
self.log('errors:\n%r', err)
1393
if retcode is not None:
1394
self.assertEquals(retcode, result,
1395
message='Unexpected return code')
1398
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1399
working_dir=None, error_regexes=[], output_encoding=None):
1400
"""Invoke bzr, as if it were run from the command line.
1402
The argument list should not include the bzr program name - the
1403
first argument is normally the bzr command. Arguments may be
1404
passed in three ways:
1406
1- A list of strings, eg ["commit", "a"]. This is recommended
1407
when the command contains whitespace or metacharacters, or
1408
is built up at run time.
1410
2- A single string, eg "add a". This is the most convenient
1411
for hardcoded commands.
1413
This runs bzr through the interface that catches and reports
1414
errors, and with logging set to something approximating the
1415
default, so that error reporting can be checked.
1417
This should be the main method for tests that want to exercise the
1418
overall behavior of the bzr application (rather than a unit test
1419
or a functional test of the library.)
1421
This sends the stdout/stderr results into the test's log,
1422
where it may be useful for debugging. See also run_captured.
1424
:keyword stdin: A string to be used as stdin for the command.
1425
:keyword retcode: The status code the command should return;
1427
:keyword working_dir: The directory to run the command in
1428
:keyword error_regexes: A list of expected error messages. If
1429
specified they must be seen in the error output of the command.
1431
out, err = self._run_bzr_autosplit(
1436
working_dir=working_dir,
1438
for regex in error_regexes:
1439
self.assertContainsRe(err, regex)
1442
def run_bzr_error(self, error_regexes, *args, **kwargs):
1443
"""Run bzr, and check that stderr contains the supplied regexes
1445
:param error_regexes: Sequence of regular expressions which
1446
must each be found in the error output. The relative ordering
1448
:param args: command-line arguments for bzr
1449
:param kwargs: Keyword arguments which are interpreted by run_bzr
1450
This function changes the default value of retcode to be 3,
1451
since in most cases this is run when you expect bzr to fail.
1453
:return: (out, err) The actual output of running the command (in case
1454
you want to do more inspection)
1458
# Make sure that commit is failing because there is nothing to do
1459
self.run_bzr_error(['no changes to commit'],
1460
['commit', '-m', 'my commit comment'])
1461
# Make sure --strict is handling an unknown file, rather than
1462
# giving us the 'nothing to do' error
1463
self.build_tree(['unknown'])
1464
self.run_bzr_error(['Commit refused because there are unknown files'],
1465
['commit', --strict', '-m', 'my commit comment'])
1467
kwargs.setdefault('retcode', 3)
1468
kwargs['error_regexes'] = error_regexes
1469
out, err = self.run_bzr(*args, **kwargs)
1472
def run_bzr_subprocess(self, *args, **kwargs):
1473
"""Run bzr in a subprocess for testing.
1475
This starts a new Python interpreter and runs bzr in there.
1476
This should only be used for tests that have a justifiable need for
1477
this isolation: e.g. they are testing startup time, or signal
1478
handling, or early startup code, etc. Subprocess code can't be
1479
profiled or debugged so easily.
1481
:keyword retcode: The status code that is expected. Defaults to 0. If
1482
None is supplied, the status code is not checked.
1483
:keyword env_changes: A dictionary which lists changes to environment
1484
variables. A value of None will unset the env variable.
1485
The values must be strings. The change will only occur in the
1486
child, so you don't need to fix the environment after running.
1487
:keyword universal_newlines: Convert CRLF => LF
1488
:keyword allow_plugins: By default the subprocess is run with
1489
--no-plugins to ensure test reproducibility. Also, it is possible
1490
for system-wide plugins to create unexpected output on stderr,
1491
which can cause unnecessary test failures.
1493
env_changes = kwargs.get('env_changes', {})
1494
working_dir = kwargs.get('working_dir', None)
1495
allow_plugins = kwargs.get('allow_plugins', False)
1497
if isinstance(args[0], list):
1499
elif isinstance(args[0], basestring):
1500
args = list(shlex.split(args[0]))
1502
symbol_versioning.warn(zero_ninetyone %
1503
"passing varargs to run_bzr_subprocess",
1504
DeprecationWarning, stacklevel=3)
1505
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1506
working_dir=working_dir,
1507
allow_plugins=allow_plugins)
1508
# We distinguish between retcode=None and retcode not passed.
1509
supplied_retcode = kwargs.get('retcode', 0)
1510
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1511
universal_newlines=kwargs.get('universal_newlines', False),
1514
def start_bzr_subprocess(self, process_args, env_changes=None,
1515
skip_if_plan_to_signal=False,
1517
allow_plugins=False):
1518
"""Start 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
:param process_args: a list of arguments to pass to the bzr executable,
1527
for example ``['--version']``.
1528
:param 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
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1534
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1536
:returns: Popen object for the started process.
1538
if skip_if_plan_to_signal:
1539
if not getattr(os, 'kill', None):
1540
raise TestSkipped("os.kill not available.")
1542
if env_changes is None:
1546
def cleanup_environment():
1547
for env_var, value in env_changes.iteritems():
1548
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1550
def restore_environment():
1551
for env_var, value in old_env.iteritems():
1552
osutils.set_or_unset_env(env_var, value)
1554
bzr_path = self.get_bzr_path()
1557
if working_dir is not None:
1558
cwd = osutils.getcwd()
1559
os.chdir(working_dir)
1562
# win32 subprocess doesn't support preexec_fn
1563
# so we will avoid using it on all platforms, just to
1564
# make sure the code path is used, and we don't break on win32
1565
cleanup_environment()
1566
command = [sys.executable, bzr_path]
1567
if not allow_plugins:
1568
command.append('--no-plugins')
1569
command.extend(process_args)
1570
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1572
restore_environment()
1578
def _popen(self, *args, **kwargs):
1579
"""Place a call to Popen.
1581
Allows tests to override this method to intercept the calls made to
1582
Popen for introspection.
1584
return Popen(*args, **kwargs)
1586
def get_bzr_path(self):
1587
"""Return the path of the 'bzr' executable for this test suite."""
1588
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1589
if not os.path.isfile(bzr_path):
1590
# We are probably installed. Assume sys.argv is the right file
1591
bzr_path = sys.argv[0]
1594
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1595
universal_newlines=False, process_args=None):
1596
"""Finish the execution of process.
1598
:param process: the Popen object returned from start_bzr_subprocess.
1599
:param retcode: The status code that is expected. Defaults to 0. If
1600
None is supplied, the status code is not checked.
1601
:param send_signal: an optional signal to send to the process.
1602
:param universal_newlines: Convert CRLF => LF
1603
:returns: (stdout, stderr)
1605
if send_signal is not None:
1606
os.kill(process.pid, send_signal)
1607
out, err = process.communicate()
1609
if universal_newlines:
1610
out = out.replace('\r\n', '\n')
1611
err = err.replace('\r\n', '\n')
1613
if retcode is not None and retcode != process.returncode:
1614
if process_args is None:
1615
process_args = "(unknown args)"
1616
mutter('Output of bzr %s:\n%s', process_args, out)
1617
mutter('Error for bzr %s:\n%s', process_args, err)
1618
self.fail('Command bzr %s failed with retcode %s != %s'
1619
% (process_args, retcode, process.returncode))
1622
def check_inventory_shape(self, inv, shape):
1623
"""Compare an inventory to a list of expected names.
1625
Fail if they are not precisely equal.
1628
shape = list(shape) # copy
1629
for path, ie in inv.entries():
1630
name = path.replace('\\', '/')
1631
if ie.kind == 'directory':
1638
self.fail("expected paths not found in inventory: %r" % shape)
1640
self.fail("unexpected paths found in inventory: %r" % extras)
1642
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1643
a_callable=None, *args, **kwargs):
1644
"""Call callable with redirected std io pipes.
1646
Returns the return code."""
1647
if not callable(a_callable):
1648
raise ValueError("a_callable must be callable.")
1650
stdin = StringIO("")
1652
if getattr(self, "_log_file", None) is not None:
1653
stdout = self._log_file
1657
if getattr(self, "_log_file", None is not None):
1658
stderr = self._log_file
1661
real_stdin = sys.stdin
1662
real_stdout = sys.stdout
1663
real_stderr = sys.stderr
1668
return a_callable(*args, **kwargs)
1670
sys.stdout = real_stdout
1671
sys.stderr = real_stderr
1672
sys.stdin = real_stdin
1674
def reduceLockdirTimeout(self):
1675
"""Reduce the default lock timeout for the duration of the test, so that
1676
if LockContention occurs during a test, it does so quickly.
1678
Tests that expect to provoke LockContention errors should call this.
1680
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1682
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1683
self.addCleanup(resetTimeout)
1684
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1686
def make_utf8_encoded_stringio(self, encoding_type=None):
1687
"""Return a StringIOWrapper instance, that will encode Unicode
1690
if encoding_type is None:
1691
encoding_type = 'strict'
1693
output_encoding = 'utf-8'
1694
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1695
sio.encoding = output_encoding
1699
class TestCaseWithMemoryTransport(TestCase):
1700
"""Common test class for tests that do not need disk resources.
1702
Tests that need disk resources should derive from TestCaseWithTransport.
1704
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1706
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1707
a directory which does not exist. This serves to help ensure test isolation
1708
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1709
must exist. However, TestCaseWithMemoryTransport does not offer local
1710
file defaults for the transport in tests, nor does it obey the command line
1711
override, so tests that accidentally write to the common directory should
1714
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1715
a .bzr directory that stops us ascending higher into the filesystem.
1721
def __init__(self, methodName='runTest'):
1722
# allow test parameterization after test construction and before test
1723
# execution. Variables that the parameterizer sets need to be
1724
# ones that are not set by setUp, or setUp will trash them.
1725
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1726
self.vfs_transport_factory = default_transport
1727
self.transport_server = None
1728
self.transport_readonly_server = None
1729
self.__vfs_server = None
1731
def get_transport(self, relpath=None):
1732
"""Return a writeable transport.
1734
This transport is for the test scratch space relative to
1737
:param relpath: a path relative to the base url.
1739
t = get_transport(self.get_url(relpath))
1740
self.assertFalse(t.is_readonly())
1743
def get_readonly_transport(self, relpath=None):
1744
"""Return a readonly transport for the test scratch space
1746
This can be used to test that operations which should only need
1747
readonly access in fact do not try to write.
1749
:param relpath: a path relative to the base url.
1751
t = get_transport(self.get_readonly_url(relpath))
1752
self.assertTrue(t.is_readonly())
1755
def create_transport_readonly_server(self):
1756
"""Create a transport server from class defined at init.
1758
This is mostly a hook for daughter classes.
1760
return self.transport_readonly_server()
1762
def get_readonly_server(self):
1763
"""Get the server instance for the readonly transport
1765
This is useful for some tests with specific servers to do diagnostics.
1767
if self.__readonly_server is None:
1768
if self.transport_readonly_server is None:
1769
# readonly decorator requested
1770
# bring up the server
1771
self.__readonly_server = ReadonlyServer()
1772
self.__readonly_server.setUp(self.get_vfs_only_server())
1774
self.__readonly_server = self.create_transport_readonly_server()
1775
self.__readonly_server.setUp(self.get_vfs_only_server())
1776
self.addCleanup(self.__readonly_server.tearDown)
1777
return self.__readonly_server
1779
def get_readonly_url(self, relpath=None):
1780
"""Get a URL for the readonly transport.
1782
This will either be backed by '.' or a decorator to the transport
1783
used by self.get_url()
1784
relpath provides for clients to get a path relative to the base url.
1785
These should only be downwards relative, not upwards.
1787
base = self.get_readonly_server().get_url()
1788
return self._adjust_url(base, relpath)
1790
def get_vfs_only_server(self):
1791
"""Get the vfs only read/write server instance.
1793
This is useful for some tests with specific servers that need
1796
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1797
is no means to override it.
1799
if self.__vfs_server is None:
1800
self.__vfs_server = MemoryServer()
1801
self.__vfs_server.setUp()
1802
self.addCleanup(self.__vfs_server.tearDown)
1803
return self.__vfs_server
1805
def get_server(self):
1806
"""Get the read/write server instance.
1808
This is useful for some tests with specific servers that need
1811
This is built from the self.transport_server factory. If that is None,
1812
then the self.get_vfs_server is returned.
1814
if self.__server is None:
1815
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1816
return self.get_vfs_only_server()
1818
# bring up a decorated means of access to the vfs only server.
1819
self.__server = self.transport_server()
1821
self.__server.setUp(self.get_vfs_only_server())
1822
except TypeError, e:
1823
# This should never happen; the try:Except here is to assist
1824
# developers having to update code rather than seeing an
1825
# uninformative TypeError.
1826
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1827
self.addCleanup(self.__server.tearDown)
1828
return self.__server
1830
def _adjust_url(self, base, relpath):
1831
"""Get a URL (or maybe a path) for the readwrite transport.
1833
This will either be backed by '.' or to an equivalent non-file based
1835
relpath provides for clients to get a path relative to the base url.
1836
These should only be downwards relative, not upwards.
1838
if relpath is not None and relpath != '.':
1839
if not base.endswith('/'):
1841
# XXX: Really base should be a url; we did after all call
1842
# get_url()! But sometimes it's just a path (from
1843
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1844
# to a non-escaped local path.
1845
if base.startswith('./') or base.startswith('/'):
1848
base += urlutils.escape(relpath)
1851
def get_url(self, relpath=None):
1852
"""Get a URL (or maybe a path) for the readwrite transport.
1854
This will either be backed by '.' or to an equivalent non-file based
1856
relpath provides for clients to get a path relative to the base url.
1857
These should only be downwards relative, not upwards.
1859
base = self.get_server().get_url()
1860
return self._adjust_url(base, relpath)
1862
def get_vfs_only_url(self, relpath=None):
1863
"""Get a URL (or maybe a path for the plain old vfs transport.
1865
This will never be a smart protocol. It always has all the
1866
capabilities of the local filesystem, but it might actually be a
1867
MemoryTransport or some other similar virtual filesystem.
1869
This is the backing transport (if any) of the server returned by
1870
get_url and get_readonly_url.
1872
:param relpath: provides for clients to get a path relative to the base
1873
url. These should only be downwards relative, not upwards.
1876
base = self.get_vfs_only_server().get_url()
1877
return self._adjust_url(base, relpath)
1879
def _create_safety_net(self):
1880
"""Make a fake bzr directory.
1882
This prevents any tests propagating up onto the TEST_ROOT directory's
1885
root = TestCaseWithMemoryTransport.TEST_ROOT
1886
bzrdir.BzrDir.create_standalone_workingtree(root)
1888
def _check_safety_net(self):
1889
"""Check that the safety .bzr directory have not been touched.
1891
_make_test_root have created a .bzr directory to prevent tests from
1892
propagating. This method ensures than a test did not leaked.
1894
root = TestCaseWithMemoryTransport.TEST_ROOT
1895
wt = workingtree.WorkingTree.open(root)
1896
last_rev = wt.last_revision()
1897
if last_rev != 'null:':
1898
# The current test have modified the /bzr directory, we need to
1899
# recreate a new one or all the followng tests will fail.
1900
# If you need to inspect its content uncomment the following line
1901
# import pdb; pdb.set_trace()
1902
_rmtree_temp_dir(root + '/.bzr')
1903
self._create_safety_net()
1904
raise AssertionError('%s/.bzr should not be modified' % root)
1906
def _make_test_root(self):
1907
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1908
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1909
TestCaseWithMemoryTransport.TEST_ROOT = root
1911
self._create_safety_net()
1913
# The same directory is used by all tests, and we're not
1914
# specifically told when all tests are finished. This will do.
1915
atexit.register(_rmtree_temp_dir, root)
1917
self.addCleanup(self._check_safety_net)
1919
def makeAndChdirToTestDir(self):
1920
"""Create a temporary directories for this one test.
1922
This must set self.test_home_dir and self.test_dir and chdir to
1925
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1927
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1928
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1929
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1931
def make_branch(self, relpath, format=None):
1932
"""Create a branch on the transport at relpath."""
1933
repo = self.make_repository(relpath, format=format)
1934
return repo.bzrdir.create_branch()
1936
def make_bzrdir(self, relpath, format=None):
1938
# might be a relative or absolute path
1939
maybe_a_url = self.get_url(relpath)
1940
segments = maybe_a_url.rsplit('/', 1)
1941
t = get_transport(maybe_a_url)
1942
if len(segments) > 1 and segments[-1] not in ('', '.'):
1946
if isinstance(format, basestring):
1947
format = bzrdir.format_registry.make_bzrdir(format)
1948
return format.initialize_on_transport(t)
1949
except errors.UninitializableFormat:
1950
raise TestSkipped("Format %s is not initializable." % format)
1952
def make_repository(self, relpath, shared=False, format=None):
1953
"""Create a repository on our default transport at relpath.
1955
Note that relpath must be a relative path, not a full url.
1957
# FIXME: If you create a remoterepository this returns the underlying
1958
# real format, which is incorrect. Actually we should make sure that
1959
# RemoteBzrDir returns a RemoteRepository.
1960
# maybe mbp 20070410
1961
made_control = self.make_bzrdir(relpath, format=format)
1962
return made_control.create_repository(shared=shared)
1964
def make_branch_and_memory_tree(self, relpath, format=None):
1965
"""Create a branch on the default transport and a MemoryTree for it."""
1966
b = self.make_branch(relpath, format=format)
1967
return memorytree.MemoryTree.create_on_branch(b)
1969
def overrideEnvironmentForTesting(self):
1970
os.environ['HOME'] = self.test_home_dir
1971
os.environ['BZR_HOME'] = self.test_home_dir
1974
super(TestCaseWithMemoryTransport, self).setUp()
1975
self._make_test_root()
1976
_currentdir = os.getcwdu()
1977
def _leaveDirectory():
1978
os.chdir(_currentdir)
1979
self.addCleanup(_leaveDirectory)
1980
self.makeAndChdirToTestDir()
1981
self.overrideEnvironmentForTesting()
1982
self.__readonly_server = None
1983
self.__server = None
1984
self.reduceLockdirTimeout()
1987
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1988
"""Derived class that runs a test within a temporary directory.
1990
This is useful for tests that need to create a branch, etc.
1992
The directory is created in a slightly complex way: for each
1993
Python invocation, a new temporary top-level directory is created.
1994
All test cases create their own directory within that. If the
1995
tests complete successfully, the directory is removed.
1997
:ivar test_base_dir: The path of the top-level directory for this
1998
test, which contains a home directory and a work directory.
2000
:ivar test_home_dir: An initially empty directory under test_base_dir
2001
which is used as $HOME for this test.
2003
:ivar test_dir: A directory under test_base_dir used as the current
2004
directory when the test proper is run.
2007
OVERRIDE_PYTHON = 'python'
2009
def check_file_contents(self, filename, expect):
2010
self.log("check contents of file %s" % filename)
2011
contents = file(filename, 'r').read()
2012
if contents != expect:
2013
self.log("expected: %r" % expect)
2014
self.log("actually: %r" % contents)
2015
self.fail("contents of %s not as expected" % filename)
2017
def makeAndChdirToTestDir(self):
2018
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2020
For TestCaseInTempDir we create a temporary directory based on the test
2021
name and then create two subdirs - test and home under it.
2023
# create a directory within the top level test directory
2024
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2025
# now create test and home directories within this dir
2026
self.test_base_dir = candidate_dir
2027
self.test_home_dir = self.test_base_dir + '/home'
2028
os.mkdir(self.test_home_dir)
2029
self.test_dir = self.test_base_dir + '/work'
2030
os.mkdir(self.test_dir)
2031
os.chdir(self.test_dir)
2032
# put name of test inside
2033
f = file(self.test_base_dir + '/name', 'w')
2038
self.addCleanup(self.deleteTestDir)
2040
def deleteTestDir(self):
2041
os.chdir(self.TEST_ROOT)
2042
_rmtree_temp_dir(self.test_base_dir)
2044
def build_tree(self, shape, line_endings='binary', transport=None):
2045
"""Build a test tree according to a pattern.
2047
shape is a sequence of file specifications. If the final
2048
character is '/', a directory is created.
2050
This assumes that all the elements in the tree being built are new.
2052
This doesn't add anything to a branch.
2054
:type shape: list or tuple.
2055
:param line_endings: Either 'binary' or 'native'
2056
in binary mode, exact contents are written in native mode, the
2057
line endings match the default platform endings.
2058
:param transport: A transport to write to, for building trees on VFS's.
2059
If the transport is readonly or None, "." is opened automatically.
2062
if type(shape) not in (list, tuple):
2063
raise AssertionError("Parameter 'shape' should be "
2064
"a list or a tuple. Got %r instead" % (shape,))
2065
# It's OK to just create them using forward slashes on windows.
2066
if transport is None or transport.is_readonly():
2067
transport = get_transport(".")
2069
self.assert_(isinstance(name, basestring))
2071
transport.mkdir(urlutils.escape(name[:-1]))
2073
if line_endings == 'binary':
2075
elif line_endings == 'native':
2078
raise errors.BzrError(
2079
'Invalid line ending request %r' % line_endings)
2080
content = "contents of %s%s" % (name.encode('utf-8'), end)
2081
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2083
def build_tree_contents(self, shape):
2084
build_tree_contents(shape)
2086
def assertFileEqual(self, content, path):
2087
"""Fail if path does not contain 'content'."""
2088
self.failUnlessExists(path)
2089
f = file(path, 'rb')
2094
self.assertEqualDiff(content, s)
2096
def failUnlessExists(self, path):
2097
"""Fail unless path or paths, which may be abs or relative, exist."""
2098
if not isinstance(path, basestring):
2100
self.failUnlessExists(p)
2102
self.failUnless(osutils.lexists(path),path+" does not exist")
2104
def failIfExists(self, path):
2105
"""Fail if path or paths, which may be abs or relative, exist."""
2106
if not isinstance(path, basestring):
2108
self.failIfExists(p)
2110
self.failIf(osutils.lexists(path),path+" exists")
2112
def assertInWorkingTree(self, path, root_path='.', tree=None):
2113
"""Assert whether path or paths are in the WorkingTree"""
2115
tree = workingtree.WorkingTree.open(root_path)
2116
if not isinstance(path, basestring):
2118
self.assertInWorkingTree(p,tree=tree)
2120
self.assertIsNot(tree.path2id(path), None,
2121
path+' not in working tree.')
2123
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2124
"""Assert whether path or paths are not in the WorkingTree"""
2126
tree = workingtree.WorkingTree.open(root_path)
2127
if not isinstance(path, basestring):
2129
self.assertNotInWorkingTree(p,tree=tree)
2131
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2134
class TestCaseWithTransport(TestCaseInTempDir):
2135
"""A test case that provides get_url and get_readonly_url facilities.
2137
These back onto two transport servers, one for readonly access and one for
2140
If no explicit class is provided for readonly access, a
2141
ReadonlyTransportDecorator is used instead which allows the use of non disk
2142
based read write transports.
2144
If an explicit class is provided for readonly access, that server and the
2145
readwrite one must both define get_url() as resolving to os.getcwd().
2148
def get_vfs_only_server(self):
2149
"""See TestCaseWithMemoryTransport.
2151
This is useful for some tests with specific servers that need
2154
if self.__vfs_server is None:
2155
self.__vfs_server = self.vfs_transport_factory()
2156
self.__vfs_server.setUp()
2157
self.addCleanup(self.__vfs_server.tearDown)
2158
return self.__vfs_server
2160
def make_branch_and_tree(self, relpath, format=None):
2161
"""Create a branch on the transport and a tree locally.
2163
If the transport is not a LocalTransport, the Tree can't be created on
2164
the transport. In that case if the vfs_transport_factory is
2165
LocalURLServer the working tree is created in the local
2166
directory backing the transport, and the returned tree's branch and
2167
repository will also be accessed locally. Otherwise a lightweight
2168
checkout is created and returned.
2170
:param format: The BzrDirFormat.
2171
:returns: the WorkingTree.
2173
# TODO: always use the local disk path for the working tree,
2174
# this obviously requires a format that supports branch references
2175
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2177
b = self.make_branch(relpath, format=format)
2179
return b.bzrdir.create_workingtree()
2180
except errors.NotLocalUrl:
2181
# We can only make working trees locally at the moment. If the
2182
# transport can't support them, then we keep the non-disk-backed
2183
# branch and create a local checkout.
2184
if self.vfs_transport_factory is LocalURLServer:
2185
# the branch is colocated on disk, we cannot create a checkout.
2186
# hopefully callers will expect this.
2187
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2188
return local_controldir.create_workingtree()
2190
return b.create_checkout(relpath, lightweight=True)
2192
def assertIsDirectory(self, relpath, transport):
2193
"""Assert that relpath within transport is a directory.
2195
This may not be possible on all transports; in that case it propagates
2196
a TransportNotPossible.
2199
mode = transport.stat(relpath).st_mode
2200
except errors.NoSuchFile:
2201
self.fail("path %s is not a directory; no such file"
2203
if not stat.S_ISDIR(mode):
2204
self.fail("path %s is not a directory; has mode %#o"
2207
def assertTreesEqual(self, left, right):
2208
"""Check that left and right have the same content and properties."""
2209
# we use a tree delta to check for equality of the content, and we
2210
# manually check for equality of other things such as the parents list.
2211
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2212
differences = left.changes_from(right)
2213
self.assertFalse(differences.has_changed(),
2214
"Trees %r and %r are different: %r" % (left, right, differences))
2217
super(TestCaseWithTransport, self).setUp()
2218
self.__vfs_server = None
2221
class ChrootedTestCase(TestCaseWithTransport):
2222
"""A support class that provides readonly urls outside the local namespace.
2224
This is done by checking if self.transport_server is a MemoryServer. if it
2225
is then we are chrooted already, if it is not then an HttpServer is used
2228
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2229
be used without needed to redo it when a different
2230
subclass is in use ?
2234
super(ChrootedTestCase, self).setUp()
2235
if not self.vfs_transport_factory == MemoryServer:
2236
self.transport_readonly_server = HttpServer
2239
def condition_id_re(pattern):
2240
"""Create a condition filter which performs a re check on a test's id.
2242
:param pattern: A regular expression string.
2243
:return: A callable that returns True if the re matches.
2245
filter_re = re.compile(pattern)
2246
def condition(test):
2248
return filter_re.search(test_id)
2252
def condition_isinstance(klass_or_klass_list):
2253
"""Create a condition filter which returns isinstance(param, klass).
2255
:return: A callable which when called with one parameter obj return the
2256
result of isinstance(obj, klass_or_klass_list).
2259
return isinstance(obj, klass_or_klass_list)
2263
def condition_id_in_list(id_list):
2264
"""Create a condition filter which verify that test's id in a list.
2266
:param name: A TestIdList object.
2267
:return: A callable that returns True if the test's id appears in the list.
2269
def condition(test):
2270
return id_list.test_in(test.id())
2274
def exclude_tests_by_condition(suite, condition):
2275
"""Create a test suite which excludes some tests from suite.
2277
:param suite: The suite to get tests from.
2278
:param condition: A callable whose result evaluates True when called with a
2279
test case which should be excluded from the result.
2280
:return: A suite which contains the tests found in suite that fail
2284
for test in iter_suite_tests(suite):
2285
if not condition(test):
2287
return TestUtil.TestSuite(result)
2290
def filter_suite_by_condition(suite, condition):
2291
"""Create a test suite by filtering another one.
2293
:param suite: The source suite.
2294
:param condition: A callable whose result evaluates True when called with a
2295
test case which should be included in the result.
2296
:return: A suite which contains the tests found in suite that pass
2300
for test in iter_suite_tests(suite):
2303
return TestUtil.TestSuite(result)
2306
def filter_suite_by_re(suite, pattern, exclude_pattern=DEPRECATED_PARAMETER,
2307
random_order=DEPRECATED_PARAMETER):
2308
"""Create a test suite by filtering another one.
2310
:param suite: the source suite
2311
:param pattern: pattern that names must match
2312
:param exclude_pattern: A pattern that names must not match. This parameter
2313
is deprecated as of bzrlib 1.0. Please use the separate function
2314
exclude_tests_by_re instead.
2315
:param random_order: If True, tests in the new suite will be put in
2316
random order. This parameter is deprecated as of bzrlib 1.0. Please
2317
use the separate function randomize_suite instead.
2318
:returns: the newly created suite
2320
if deprecated_passed(exclude_pattern):
2321
symbol_versioning.warn(
2322
one_zero % "passing exclude_pattern to filter_suite_by_re",
2323
DeprecationWarning, stacklevel=2)
2324
if exclude_pattern is not None:
2325
suite = exclude_tests_by_re(suite, exclude_pattern)
2326
condition = condition_id_re(pattern)
2327
result_suite = filter_suite_by_condition(suite, condition)
2328
if deprecated_passed(random_order):
2329
symbol_versioning.warn(
2330
one_zero % "passing random_order to filter_suite_by_re",
2331
DeprecationWarning, stacklevel=2)
2333
result_suite = randomize_suite(result_suite)
2337
def filter_suite_by_id_list(suite, test_id_list):
2338
"""Create a test suite by filtering another one.
2340
:param suite: The source suite.
2341
:param test_id_list: A list of the test ids to keep as strings.
2342
:returns: the newly created suite
2344
condition = condition_id_in_list(test_id_list)
2345
result_suite = filter_suite_by_condition(suite, condition)
2349
def exclude_tests_by_re(suite, pattern):
2350
"""Create a test suite which excludes some tests from suite.
2352
:param suite: The suite to get tests from.
2353
:param pattern: A regular expression string. Test ids that match this
2354
pattern will be excluded from the result.
2355
:return: A TestSuite that contains all the tests from suite without the
2356
tests that matched pattern. The order of tests is the same as it was in
2359
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2362
def preserve_input(something):
2363
"""A helper for performing test suite transformation chains.
2365
:param something: Anything you want to preserve.
2371
def randomize_suite(suite):
2372
"""Return a new TestSuite with suite's tests in random order.
2374
The tests in the input suite are flattened into a single suite in order to
2375
accomplish this. Any nested TestSuites are removed to provide global
2378
tests = list(iter_suite_tests(suite))
2379
random.shuffle(tests)
2380
return TestUtil.TestSuite(tests)
2383
@deprecated_function(one_zero)
2384
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2385
random_order=False, append_rest=True):
2386
"""DEPRECATED: Create a test suite by sorting another one.
2388
This method has been decomposed into separate helper methods that should be
2390
- filter_suite_by_re
2391
- exclude_tests_by_re
2395
:param suite: the source suite
2396
:param pattern: pattern that names must match in order to go
2397
first in the new suite
2398
:param exclude_pattern: pattern that names must not match, if any
2399
:param random_order: if True, tests in the new suite will be put in
2400
random order (with all tests matching pattern
2402
:param append_rest: if False, pattern is a strict filter and not
2403
just an ordering directive
2404
:returns: the newly created suite
2406
if exclude_pattern is not None:
2407
suite = exclude_tests_by_re(suite, exclude_pattern)
2409
order_changer = randomize_suite
2411
order_changer = preserve_input
2413
suites = map(order_changer, split_suite_by_re(suite, pattern))
2414
return TestUtil.TestSuite(suites)
2416
return order_changer(filter_suite_by_re(suite, pattern))
2419
def split_suite_by_re(suite, pattern):
2420
"""Split a test suite into two by a regular expression.
2422
:param suite: The suite to split.
2423
:param pattern: A regular expression string. Test ids that match this
2424
pattern will be in the first test suite returned, and the others in the
2425
second test suite returned.
2426
:return: A tuple of two test suites, where the first contains tests from
2427
suite matching pattern, and the second contains the remainder from
2428
suite. The order within each output suite is the same as it was in
2433
filter_re = re.compile(pattern)
2434
for test in iter_suite_tests(suite):
2436
if filter_re.search(test_id):
2437
matched.append(test)
2439
did_not_match.append(test)
2440
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2443
def run_suite(suite, name='test', verbose=False, pattern=".*",
2444
stop_on_failure=False,
2445
transport=None, lsprof_timed=None, bench_history=None,
2446
matching_tests_first=None,
2449
exclude_pattern=None,
2451
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2456
runner = TextTestRunner(stream=sys.stdout,
2458
verbosity=verbosity,
2459
bench_history=bench_history,
2460
list_only=list_only,
2462
runner.stop_on_failure=stop_on_failure
2463
# Initialise the random number generator and display the seed used.
2464
# We convert the seed to a long to make it reuseable across invocations.
2465
random_order = False
2466
if random_seed is not None:
2468
if random_seed == "now":
2469
random_seed = long(time.time())
2471
# Convert the seed to a long if we can
2473
random_seed = long(random_seed)
2476
runner.stream.writeln("Randomizing test order using seed %s\n" %
2478
random.seed(random_seed)
2479
# Customise the list of tests if requested
2480
if exclude_pattern is not None:
2481
suite = exclude_tests_by_re(suite, exclude_pattern)
2483
order_changer = randomize_suite
2485
order_changer = preserve_input
2486
if pattern != '.*' or random_order:
2487
if matching_tests_first:
2488
suites = map(order_changer, split_suite_by_re(suite, pattern))
2489
suite = TestUtil.TestSuite(suites)
2491
suite = order_changer(filter_suite_by_re(suite, pattern))
2493
result = runner.run(suite)
2496
return result.wasStrictlySuccessful()
2498
return result.wasSuccessful()
2501
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2503
test_suite_factory=None,
2506
matching_tests_first=None,
2509
exclude_pattern=None,
2513
"""Run the whole test suite under the enhanced runner"""
2514
# XXX: Very ugly way to do this...
2515
# Disable warning about old formats because we don't want it to disturb
2516
# any blackbox tests.
2517
from bzrlib import repository
2518
repository._deprecation_warning_done = True
2520
global default_transport
2521
if transport is None:
2522
transport = default_transport
2523
old_transport = default_transport
2524
default_transport = transport
2526
if load_list is None:
2529
keep_only = load_test_id_list(load_list)
2530
if test_suite_factory is None:
2531
suite = test_suite(keep_only)
2533
suite = test_suite_factory()
2534
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2535
stop_on_failure=stop_on_failure,
2536
transport=transport,
2537
lsprof_timed=lsprof_timed,
2538
bench_history=bench_history,
2539
matching_tests_first=matching_tests_first,
2540
list_only=list_only,
2541
random_seed=random_seed,
2542
exclude_pattern=exclude_pattern,
2545
default_transport = old_transport
2548
def load_test_id_list(file_name):
2549
"""Load a test id list from a text file.
2551
The format is one test id by line. No special care is taken to impose
2552
strict rules, these test ids are used to filter the test suite so a test id
2553
that do not match an existing test will do no harm. This allows user to add
2554
comments, leave blank lines, etc.
2558
ftest = open(file_name, 'rt')
2560
if e.errno != errno.ENOENT:
2563
raise errors.NoSuchFile(file_name)
2565
for test_name in ftest.readlines():
2566
test_list.append(test_name.strip())
2571
class TestIdList(object):
2572
"""Test id list to filter a test suite.
2574
Relying on the assumption that test ids are built as:
2575
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
2576
notation, this class offers methods to :
2577
- avoid building a test suite for modules not refered to in the test list,
2578
- keep only the tests listed from the module test suite.
2581
def __init__(self, test_id_list):
2582
# When a test suite needs to be filtered against us we compare test ids
2583
# for equality, so a simple dict offers a quick and simple solution.
2584
self.tests = dict().fromkeys(test_id_list, True)
2586
# While unittest.TestCase have ids like:
2587
# <module>.<class>.<method>[(<param+)],
2588
# doctest.DocTestCase can have ids like:
2591
# <module>.<function>
2592
# <module>.<class>.<method>
2594
# Since we can't predict a test class from its name only, we settle on
2595
# a simple constraint: a test id always begins with its module name.
2598
for test_id in test_id_list:
2599
parts = test_id.split('.')
2600
mod_name = parts.pop(0)
2601
modules[mod_name] = True
2603
mod_name += '.' + part
2604
modules[mod_name] = True
2605
self.modules = modules
2607
def is_module_name_used(self, module_name):
2608
"""Is there tests for the module or one of its sub modules."""
2609
return self.modules.has_key(module_name)
2611
def test_in(self, test_id):
2612
return self.tests.has_key(test_id)
2615
def test_suite(keep_only=None):
2616
"""Build and return TestSuite for the whole of bzrlib.
2618
:param keep_only: A list of test ids limiting the suite returned.
2620
This function can be replaced if you need to change the default test
2621
suite on a global basis, but it is not encouraged.
2624
'bzrlib.util.tests.test_bencode',
2625
'bzrlib.tests.test__dirstate_helpers',
2626
'bzrlib.tests.test_ancestry',
2627
'bzrlib.tests.test_annotate',
2628
'bzrlib.tests.test_api',
2629
'bzrlib.tests.test_atomicfile',
2630
'bzrlib.tests.test_bad_files',
2631
'bzrlib.tests.test_bisect_multi',
2632
'bzrlib.tests.test_branch',
2633
'bzrlib.tests.test_branchbuilder',
2634
'bzrlib.tests.test_bugtracker',
2635
'bzrlib.tests.test_bundle',
2636
'bzrlib.tests.test_bzrdir',
2637
'bzrlib.tests.test_cache_utf8',
2638
'bzrlib.tests.test_commands',
2639
'bzrlib.tests.test_commit',
2640
'bzrlib.tests.test_commit_merge',
2641
'bzrlib.tests.test_config',
2642
'bzrlib.tests.test_conflicts',
2643
'bzrlib.tests.test_counted_lock',
2644
'bzrlib.tests.test_decorators',
2645
'bzrlib.tests.test_delta',
2646
'bzrlib.tests.test_deprecated_graph',
2647
'bzrlib.tests.test_diff',
2648
'bzrlib.tests.test_dirstate',
2649
'bzrlib.tests.test_email_message',
2650
'bzrlib.tests.test_errors',
2651
'bzrlib.tests.test_escaped_store',
2652
'bzrlib.tests.test_extract',
2653
'bzrlib.tests.test_fetch',
2654
'bzrlib.tests.test_ftp_transport',
2655
'bzrlib.tests.test_generate_docs',
2656
'bzrlib.tests.test_generate_ids',
2657
'bzrlib.tests.test_globbing',
2658
'bzrlib.tests.test_gpg',
2659
'bzrlib.tests.test_graph',
2660
'bzrlib.tests.test_hashcache',
2661
'bzrlib.tests.test_help',
2662
'bzrlib.tests.test_hooks',
2663
'bzrlib.tests.test_http',
2664
'bzrlib.tests.test_http_implementations',
2665
'bzrlib.tests.test_http_response',
2666
'bzrlib.tests.test_https_ca_bundle',
2667
'bzrlib.tests.test_identitymap',
2668
'bzrlib.tests.test_ignores',
2669
'bzrlib.tests.test_index',
2670
'bzrlib.tests.test_info',
2671
'bzrlib.tests.test_inv',
2672
'bzrlib.tests.test_knit',
2673
'bzrlib.tests.test_lazy_import',
2674
'bzrlib.tests.test_lazy_regex',
2675
'bzrlib.tests.test_lockdir',
2676
'bzrlib.tests.test_lockable_files',
2677
'bzrlib.tests.test_log',
2678
'bzrlib.tests.test_lsprof',
2679
'bzrlib.tests.test_lru_cache',
2680
'bzrlib.tests.test_mail_client',
2681
'bzrlib.tests.test_memorytree',
2682
'bzrlib.tests.test_merge',
2683
'bzrlib.tests.test_merge3',
2684
'bzrlib.tests.test_merge_core',
2685
'bzrlib.tests.test_merge_directive',
2686
'bzrlib.tests.test_missing',
2687
'bzrlib.tests.test_msgeditor',
2688
'bzrlib.tests.test_multiparent',
2689
'bzrlib.tests.test_nonascii',
2690
'bzrlib.tests.test_options',
2691
'bzrlib.tests.test_osutils',
2692
'bzrlib.tests.test_osutils_encodings',
2693
'bzrlib.tests.test_pack',
2694
'bzrlib.tests.test_patch',
2695
'bzrlib.tests.test_patches',
2696
'bzrlib.tests.test_permissions',
2697
'bzrlib.tests.test_plugins',
2698
'bzrlib.tests.test_progress',
2699
'bzrlib.tests.test_reconfigure',
2700
'bzrlib.tests.test_reconcile',
2701
'bzrlib.tests.test_registry',
2702
'bzrlib.tests.test_remote',
2703
'bzrlib.tests.test_repository',
2704
'bzrlib.tests.test_revert',
2705
'bzrlib.tests.test_revision',
2706
'bzrlib.tests.test_revisionnamespaces',
2707
'bzrlib.tests.test_revisiontree',
2708
'bzrlib.tests.test_rio',
2709
'bzrlib.tests.test_sampler',
2710
'bzrlib.tests.test_selftest',
2711
'bzrlib.tests.test_setup',
2712
'bzrlib.tests.test_sftp_transport',
2713
'bzrlib.tests.test_smart',
2714
'bzrlib.tests.test_smart_add',
2715
'bzrlib.tests.test_smart_transport',
2716
'bzrlib.tests.test_smtp_connection',
2717
'bzrlib.tests.test_source',
2718
'bzrlib.tests.test_ssh_transport',
2719
'bzrlib.tests.test_status',
2720
'bzrlib.tests.test_store',
2721
'bzrlib.tests.test_strace',
2722
'bzrlib.tests.test_subsume',
2723
'bzrlib.tests.test_switch',
2724
'bzrlib.tests.test_symbol_versioning',
2725
'bzrlib.tests.test_tag',
2726
'bzrlib.tests.test_testament',
2727
'bzrlib.tests.test_textfile',
2728
'bzrlib.tests.test_textmerge',
2729
'bzrlib.tests.test_timestamp',
2730
'bzrlib.tests.test_trace',
2731
'bzrlib.tests.test_transactions',
2732
'bzrlib.tests.test_transform',
2733
'bzrlib.tests.test_transport',
2734
'bzrlib.tests.test_tree',
2735
'bzrlib.tests.test_treebuilder',
2736
'bzrlib.tests.test_tsort',
2737
'bzrlib.tests.test_tuned_gzip',
2738
'bzrlib.tests.test_ui',
2739
'bzrlib.tests.test_upgrade',
2740
'bzrlib.tests.test_urlutils',
2741
'bzrlib.tests.test_versionedfile',
2742
'bzrlib.tests.test_version',
2743
'bzrlib.tests.test_version_info',
2744
'bzrlib.tests.test_weave',
2745
'bzrlib.tests.test_whitebox',
2746
'bzrlib.tests.test_win32utils',
2747
'bzrlib.tests.test_workingtree',
2748
'bzrlib.tests.test_workingtree_4',
2749
'bzrlib.tests.test_wsgi',
2750
'bzrlib.tests.test_xml',
2752
test_transport_implementations = [
2753
'bzrlib.tests.test_transport_implementations',
2754
'bzrlib.tests.test_read_bundle',
2756
suite = TestUtil.TestSuite()
2757
loader = TestUtil.TestLoader()
2759
if keep_only is not None:
2760
id_filter = TestIdList(keep_only)
2762
# modules building their suite with loadTestsFromModuleNames
2763
if keep_only is None:
2764
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2766
for mod in [m for m in testmod_names
2767
if id_filter.is_module_name_used(m)]:
2768
mod_suite = loader.loadTestsFromModuleNames([mod])
2769
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2770
suite.addTest(mod_suite)
2772
# modules adapted for transport implementations
2773
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2774
adapter = TransportTestProviderAdapter()
2775
if keep_only is None:
2776
adapt_modules(test_transport_implementations, adapter, loader, suite)
2778
for mod in [m for m in test_transport_implementations
2779
if id_filter.is_module_name_used(m)]:
2780
mod_suite = TestUtil.TestSuite()
2781
adapt_modules([mod], adapter, loader, mod_suite)
2782
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2783
suite.addTest(mod_suite)
2785
# modules defining their own test_suite()
2786
for package in [p for p in packages_to_test()
2787
if (keep_only is None
2788
or id_filter.is_module_name_used(p.__name__))]:
2789
pack_suite = package.test_suite()
2790
if keep_only is not None:
2791
pack_suite = filter_suite_by_id_list(pack_suite, id_filter)
2792
suite.addTest(pack_suite)
2794
# XXX: MODULES_TO_TEST should be obsoleted ?
2795
for mod in [m for m in MODULES_TO_TEST
2796
if keep_only is None or id_filter.is_module_name_used(m)]:
2797
mod_suite = loader.loadTestsFromModule(mod)
2798
if keep_only is not None:
2799
mod_suite = filter_suite_by_id_list(mod_suite, id_filter)
2800
suite.addTest(mod_suite)
2802
for mod in MODULES_TO_DOCTEST:
2804
doc_suite = doctest.DocTestSuite(mod)
2805
except ValueError, e:
2806
print '**failed to get doctest for: %s\n%s' % (mod, e)
2808
if keep_only is not None:
2809
# DocTests may use ids which doesn't contain the module name
2810
doc_suite = filter_suite_by_id_list(doc_suite, id_filter)
2811
suite.addTest(doc_suite)
2813
default_encoding = sys.getdefaultencoding()
2814
for name, plugin in [(n, p) for (n, p) in bzrlib.plugin.plugins().items()
2815
if (keep_only is None
2816
or id_filter.is_module_name_used(
2817
p.module.__name__))]:
2819
plugin_suite = plugin.test_suite()
2820
except ImportError, e:
2821
bzrlib.trace.warning(
2822
'Unable to test plugin "%s": %s', name, e)
2824
if plugin_suite is not None:
2825
if keep_only is not None:
2826
plugin_suite = filter_suite_by_id_list(plugin_suite,
2828
suite.addTest(plugin_suite)
2829
if default_encoding != sys.getdefaultencoding():
2830
bzrlib.trace.warning(
2831
'Plugin "%s" tried to reset default encoding to: %s', name,
2832
sys.getdefaultencoding())
2834
sys.setdefaultencoding(default_encoding)
2838
def multiply_tests_from_modules(module_name_list, scenario_iter):
2839
"""Adapt all tests in some given modules to given scenarios.
2841
This is the recommended public interface for test parameterization.
2842
Typically the test_suite() method for a per-implementation test
2843
suite will call multiply_tests_from_modules and return the
2846
:param module_name_list: List of fully-qualified names of test
2848
:param scenario_iter: Iterable of pairs of (scenario_name,
2849
scenario_param_dict).
2851
This returns a new TestSuite containing the cross product of
2852
all the tests in all the modules, each repeated for each scenario.
2853
Each test is adapted by adding the scenario name at the end
2854
of its name, and updating the test object's __dict__ with the
2855
scenario_param_dict.
2857
>>> r = multiply_tests_from_modules(
2858
... ['bzrlib.tests.test_sampler'],
2859
... [('one', dict(param=1)),
2860
... ('two', dict(param=2))])
2861
>>> tests = list(iter_suite_tests(r))
2865
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2871
loader = TestLoader()
2873
adapter = TestScenarioApplier()
2874
adapter.scenarios = list(scenario_iter)
2875
adapt_modules(module_name_list, adapter, loader, suite)
2879
def multiply_scenarios(scenarios_left, scenarios_right):
2880
"""Multiply two sets of scenarios.
2882
:returns: the cartesian product of the two sets of scenarios, that is
2883
a scenario for every possible combination of a left scenario and a
2887
('%s,%s' % (left_name, right_name),
2888
dict(left_dict.items() + right_dict.items()))
2889
for left_name, left_dict in scenarios_left
2890
for right_name, right_dict in scenarios_right]
2894
def adapt_modules(mods_list, adapter, loader, suite):
2895
"""Adapt the modules in mods_list using adapter and add to suite."""
2896
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2897
suite.addTests(adapter.adapt(test))
2900
def adapt_tests(tests_list, adapter, loader, suite):
2901
"""Adapt the tests in tests_list using adapter and add to suite."""
2902
for test in tests_list:
2903
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2906
def _rmtree_temp_dir(dirname):
2907
# If LANG=C we probably have created some bogus paths
2908
# which rmtree(unicode) will fail to delete
2909
# so make sure we are using rmtree(str) to delete everything
2910
# except on win32, where rmtree(str) will fail
2911
# since it doesn't have the property of byte-stream paths
2912
# (they are either ascii or mbcs)
2913
if sys.platform == 'win32':
2914
# make sure we are using the unicode win32 api
2915
dirname = unicode(dirname)
2917
dirname = dirname.encode(sys.getfilesystemencoding())
2919
osutils.rmtree(dirname)
2921
if sys.platform == 'win32' and e.errno == errno.EACCES:
2922
sys.stderr.write(('Permission denied: '
2923
'unable to remove testing dir '
2924
'%s\n' % os.path.basename(dirname)))
2929
class Feature(object):
2930
"""An operating system Feature."""
2933
self._available = None
2935
def available(self):
2936
"""Is the feature available?
2938
:return: True if the feature is available.
2940
if self._available is None:
2941
self._available = self._probe()
2942
return self._available
2945
"""Implement this method in concrete features.
2947
:return: True if the feature is available.
2949
raise NotImplementedError
2952
if getattr(self, 'feature_name', None):
2953
return self.feature_name()
2954
return self.__class__.__name__
2957
class _SymlinkFeature(Feature):
2960
return osutils.has_symlinks()
2962
def feature_name(self):
2965
SymlinkFeature = _SymlinkFeature()
2968
class _OsFifoFeature(Feature):
2971
return getattr(os, 'mkfifo', None)
2973
def feature_name(self):
2974
return 'filesystem fifos'
2976
OsFifoFeature = _OsFifoFeature()
2979
class TestScenarioApplier(object):
2980
"""A tool to apply scenarios to tests."""
2982
def adapt(self, test):
2983
"""Return a TestSuite containing a copy of test for each scenario."""
2984
result = unittest.TestSuite()
2985
for scenario in self.scenarios:
2986
result.addTest(self.adapt_test_to_scenario(test, scenario))
2989
def adapt_test_to_scenario(self, test, scenario):
2990
"""Copy test and apply scenario to it.
2992
:param test: A test to adapt.
2993
:param scenario: A tuple describing the scenarion.
2994
The first element of the tuple is the new test id.
2995
The second element is a dict containing attributes to set on the
2997
:return: The adapted test.
2999
from copy import deepcopy
3000
new_test = deepcopy(test)
3001
for name, value in scenario[1].items():
3002
setattr(new_test, name, value)
3003
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3004
new_test.id = lambda: new_id
3008
def probe_unicode_in_user_encoding():
3009
"""Try to encode several unicode strings to use in unicode-aware tests.
3010
Return first successfull match.
3012
:return: (unicode value, encoded plain string value) or (None, None)
3014
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
3015
for uni_val in possible_vals:
3017
str_val = uni_val.encode(bzrlib.user_encoding)
3018
except UnicodeEncodeError:
3019
# Try a different character
3022
return uni_val, str_val
3026
def probe_bad_non_ascii(encoding):
3027
"""Try to find [bad] character with code [128..255]
3028
that cannot be decoded to unicode in some encoding.
3029
Return None if all non-ascii characters is valid
3032
for i in xrange(128, 256):
3035
char.decode(encoding)
3036
except UnicodeDecodeError:
3041
class _FTPServerFeature(Feature):
3042
"""Some tests want an FTP Server, check if one is available.
3044
Right now, the only way this is available is if 'medusa' is installed.
3045
http://www.amk.ca/python/code/medusa.html
3050
import bzrlib.tests.ftp_server
3055
def feature_name(self):
3058
FTPServerFeature = _FTPServerFeature()
3061
class _CaseInsensitiveFilesystemFeature(Feature):
3062
"""Check if underlined filesystem is case-insensitive
3063
(e.g. on Windows, Cygwin, MacOS)
3067
if TestCaseWithMemoryTransport.TEST_ROOT is None:
3068
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
3069
TestCaseWithMemoryTransport.TEST_ROOT = root
3071
root = TestCaseWithMemoryTransport.TEST_ROOT
3072
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
3074
name_a = osutils.pathjoin(tdir, 'a')
3075
name_A = osutils.pathjoin(tdir, 'A')
3077
result = osutils.isdir(name_A)
3078
_rmtree_temp_dir(tdir)
3081
def feature_name(self):
3082
return 'case-insensitive filesystem'
3084
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
added
removed
bzrlib/tests/__init__.py
