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 (
85
from bzrlib.transport import get_transport
86
import bzrlib.transport
87
from bzrlib.transport.local import LocalURLServer
88
from bzrlib.transport.memory import MemoryServer
89
from bzrlib.transport.readonly import ReadonlyServer
90
from bzrlib.trace import mutter, note
91
from bzrlib.tests import TestUtil
92
from bzrlib.tests.HttpServer import HttpServer
93
from bzrlib.tests.TestUtil import (
97
from bzrlib.tests.treeshape import build_tree_contents
98
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
100
# Mark this python module as being part of the implementation
101
# of unittest: this gives us better tracebacks where the last
102
# shown frame is the test code, not our assertXYZ.
105
default_transport = LocalURLServer
108
MODULES_TO_DOCTEST = [
118
# quoted to avoid module-loading circularity
123
def packages_to_test():
124
"""Return a list of packages to test.
126
The packages are not globally imported so that import failures are
127
triggered when running selftest, not when importing the command.
130
import bzrlib.tests.blackbox
131
import bzrlib.tests.branch_implementations
132
import bzrlib.tests.bzrdir_implementations
133
import bzrlib.tests.commands
134
import bzrlib.tests.interrepository_implementations
135
import bzrlib.tests.interversionedfile_implementations
136
import bzrlib.tests.intertree_implementations
137
import bzrlib.tests.inventory_implementations
138
import bzrlib.tests.per_lock
139
import bzrlib.tests.repository_implementations
140
import bzrlib.tests.revisionstore_implementations
141
import bzrlib.tests.tree_implementations
142
import bzrlib.tests.workingtree_implementations
145
bzrlib.tests.blackbox,
146
bzrlib.tests.branch_implementations,
147
bzrlib.tests.bzrdir_implementations,
148
bzrlib.tests.commands,
149
bzrlib.tests.interrepository_implementations,
150
bzrlib.tests.interversionedfile_implementations,
151
bzrlib.tests.intertree_implementations,
152
bzrlib.tests.inventory_implementations,
153
bzrlib.tests.per_lock,
154
bzrlib.tests.repository_implementations,
155
bzrlib.tests.revisionstore_implementations,
156
bzrlib.tests.tree_implementations,
157
bzrlib.tests.workingtree_implementations,
161
class ExtendedTestResult(unittest._TextTestResult):
162
"""Accepts, reports and accumulates the results of running tests.
164
Compared to the unittest version this class adds support for
165
profiling, benchmarking, stopping as soon as a test fails, and
166
skipping tests. There are further-specialized subclasses for
167
different types of display.
169
When a test finishes, in whatever way, it calls one of the addSuccess,
170
addFailure or addError classes. These in turn may redirect to a more
171
specific case for the special test results supported by our extended
174
Note that just one of these objects is fed the results from many tests.
179
def __init__(self, stream, descriptions, verbosity,
183
"""Construct new TestResult.
185
:param bench_history: Optionally, a writable file object to accumulate
188
unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
189
if bench_history is not None:
190
from bzrlib.version import _get_bzr_source_tree
191
src_tree = _get_bzr_source_tree()
194
revision_id = src_tree.get_parent_ids()[0]
196
# XXX: if this is a brand new tree, do the same as if there
200
# XXX: If there's no branch, what should we do?
202
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
203
self._bench_history = bench_history
204
self.ui = ui.ui_factory
205
self.num_tests = num_tests
207
self.failure_count = 0
208
self.known_failure_count = 0
210
self.not_applicable_count = 0
211
self.unsupported = {}
213
self._overall_start_time = time.time()
215
def _extractBenchmarkTime(self, testCase):
216
"""Add a benchmark time for the current test case."""
217
return getattr(testCase, "_benchtime", None)
219
def _elapsedTestTimeString(self):
220
"""Return a time string for the overall time the current test has taken."""
221
return self._formatTime(time.time() - self._start_time)
223
def _testTimeString(self, testCase):
224
benchmark_time = self._extractBenchmarkTime(testCase)
225
if benchmark_time is not None:
227
self._formatTime(benchmark_time),
228
self._elapsedTestTimeString())
230
return " %s" % self._elapsedTestTimeString()
232
def _formatTime(self, seconds):
233
"""Format seconds as milliseconds with leading spaces."""
234
# some benchmarks can take thousands of seconds to run, so we need 8
236
return "%8dms" % (1000 * seconds)
238
def _shortened_test_description(self, test):
240
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
243
def startTest(self, test):
244
unittest.TestResult.startTest(self, test)
245
self.report_test_start(test)
246
test.number = self.count
247
self._recordTestStartTime()
249
def _recordTestStartTime(self):
250
"""Record that a test has started."""
251
self._start_time = time.time()
253
def _cleanupLogFile(self, test):
254
# We can only do this if we have one of our TestCases, not if
256
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
257
if setKeepLogfile is not None:
260
def addError(self, test, err):
261
"""Tell result that test finished with an error.
263
Called from the TestCase run() method when the test
264
fails with an unexpected error.
266
self._testConcluded(test)
267
if isinstance(err[1], TestSkipped):
268
return self._addSkipped(test, err)
269
elif isinstance(err[1], UnavailableFeature):
270
return self.addNotSupported(test, err[1].args[0])
272
unittest.TestResult.addError(self, test, err)
273
self.error_count += 1
274
self.report_error(test, err)
278
def addFailure(self, test, err):
279
"""Tell result that test failed.
281
Called from the TestCase run() method when the test
282
fails because e.g. an assert() method failed.
284
self._testConcluded(test)
285
if isinstance(err[1], KnownFailure):
286
return self._addKnownFailure(test, err)
288
unittest.TestResult.addFailure(self, test, err)
289
self.failure_count += 1
290
self.report_failure(test, err)
294
def addSuccess(self, test):
295
"""Tell result that test completed successfully.
297
Called from the TestCase run()
299
self._testConcluded(test)
300
if self._bench_history is not None:
301
benchmark_time = self._extractBenchmarkTime(test)
302
if benchmark_time is not None:
303
self._bench_history.write("%s %s\n" % (
304
self._formatTime(benchmark_time),
306
self.report_success(test)
307
unittest.TestResult.addSuccess(self, test)
309
def _testConcluded(self, test):
310
"""Common code when a test has finished.
312
Called regardless of whether it succeded, failed, etc.
314
self._cleanupLogFile(test)
316
def _addKnownFailure(self, test, err):
317
self.known_failure_count += 1
318
self.report_known_failure(test, err)
320
def addNotSupported(self, test, feature):
321
"""The test will not be run because of a missing feature.
323
# this can be called in two different ways: it may be that the
324
# test started running, and then raised (through addError)
325
# UnavailableFeature. Alternatively this method can be called
326
# while probing for features before running the tests; in that
327
# case we will see startTest and stopTest, but the test will never
329
self.unsupported.setdefault(str(feature), 0)
330
self.unsupported[str(feature)] += 1
331
self.report_unsupported(test, feature)
333
def _addSkipped(self, test, skip_excinfo):
334
if isinstance(skip_excinfo[1], TestNotApplicable):
335
self.not_applicable_count += 1
336
self.report_not_applicable(test, skip_excinfo)
339
self.report_skip(test, skip_excinfo)
342
except KeyboardInterrupt:
345
self.addError(test, test._exc_info())
347
# seems best to treat this as success from point-of-view of unittest
348
# -- it actually does nothing so it barely matters :)
349
unittest.TestResult.addSuccess(self, test)
351
def printErrorList(self, flavour, errors):
352
for test, err in errors:
353
self.stream.writeln(self.separator1)
354
self.stream.write("%s: " % flavour)
355
self.stream.writeln(self.getDescription(test))
356
if getattr(test, '_get_log', None) is not None:
357
self.stream.write('\n')
359
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
360
self.stream.write('\n')
361
self.stream.write(test._get_log())
362
self.stream.write('\n')
364
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
365
self.stream.write('\n')
366
self.stream.writeln(self.separator2)
367
self.stream.writeln("%s" % err)
372
def report_cleaning_up(self):
375
def report_success(self, test):
378
def wasStrictlySuccessful(self):
379
if self.unsupported or self.known_failure_count:
381
return self.wasSuccessful()
384
class TextTestResult(ExtendedTestResult):
385
"""Displays progress and results of tests in text form"""
387
def __init__(self, stream, descriptions, verbosity,
392
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
393
bench_history, num_tests)
395
self.pb = self.ui.nested_progress_bar()
396
self._supplied_pb = False
399
self._supplied_pb = True
400
self.pb.show_pct = False
401
self.pb.show_spinner = False
402
self.pb.show_eta = False,
403
self.pb.show_count = False
404
self.pb.show_bar = False
406
def report_starting(self):
407
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
409
def _progress_prefix_text(self):
410
a = '[%d' % self.count
411
if self.num_tests is not None:
412
a +='/%d' % self.num_tests
413
a += ' in %ds' % (time.time() - self._overall_start_time)
415
a += ', %d errors' % self.error_count
416
if self.failure_count:
417
a += ', %d failed' % self.failure_count
418
if self.known_failure_count:
419
a += ', %d known failures' % self.known_failure_count
421
a += ', %d skipped' % self.skip_count
423
a += ', %d missing features' % len(self.unsupported)
427
def report_test_start(self, test):
430
self._progress_prefix_text()
432
+ self._shortened_test_description(test))
434
def _test_description(self, test):
435
return self._shortened_test_description(test)
437
def report_error(self, test, err):
438
self.pb.note('ERROR: %s\n %s\n',
439
self._test_description(test),
443
def report_failure(self, test, err):
444
self.pb.note('FAIL: %s\n %s\n',
445
self._test_description(test),
449
def report_known_failure(self, test, err):
450
self.pb.note('XFAIL: %s\n%s\n',
451
self._test_description(test), err[1])
453
def report_skip(self, test, skip_excinfo):
456
def report_not_applicable(self, test, skip_excinfo):
459
def report_unsupported(self, test, feature):
460
"""test cannot be run because feature is missing."""
462
def report_cleaning_up(self):
463
self.pb.update('cleaning up...')
466
if not self._supplied_pb:
470
class VerboseTestResult(ExtendedTestResult):
471
"""Produce long output, with one line per test run plus times"""
473
def _ellipsize_to_right(self, a_string, final_width):
474
"""Truncate and pad a string, keeping the right hand side"""
475
if len(a_string) > final_width:
476
result = '...' + a_string[3-final_width:]
479
return result.ljust(final_width)
481
def report_starting(self):
482
self.stream.write('running %d tests...\n' % self.num_tests)
484
def report_test_start(self, test):
486
name = self._shortened_test_description(test)
487
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
488
# numbers, plus a trailing blank
489
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
490
self.stream.write(self._ellipsize_to_right(name,
491
osutils.terminal_width()-30))
494
def _error_summary(self, err):
496
return '%s%s' % (indent, err[1])
498
def report_error(self, test, err):
499
self.stream.writeln('ERROR %s\n%s'
500
% (self._testTimeString(test),
501
self._error_summary(err)))
503
def report_failure(self, test, err):
504
self.stream.writeln(' FAIL %s\n%s'
505
% (self._testTimeString(test),
506
self._error_summary(err)))
508
def report_known_failure(self, test, err):
509
self.stream.writeln('XFAIL %s\n%s'
510
% (self._testTimeString(test),
511
self._error_summary(err)))
513
def report_success(self, test):
514
self.stream.writeln(' OK %s' % self._testTimeString(test))
515
for bench_called, stats in getattr(test, '_benchcalls', []):
516
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
517
stats.pprint(file=self.stream)
518
# flush the stream so that we get smooth output. This verbose mode is
519
# used to show the output in PQM.
522
def report_skip(self, test, skip_excinfo):
523
self.stream.writeln(' SKIP %s\n%s'
524
% (self._testTimeString(test),
525
self._error_summary(skip_excinfo)))
527
def report_not_applicable(self, test, skip_excinfo):
528
self.stream.writeln(' N/A %s\n%s'
529
% (self._testTimeString(test),
530
self._error_summary(skip_excinfo)))
532
def report_unsupported(self, test, feature):
533
"""test cannot be run because feature is missing."""
534
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
535
%(self._testTimeString(test), feature))
538
class TextTestRunner(object):
539
stop_on_failure = False
548
self.stream = unittest._WritelnDecorator(stream)
549
self.descriptions = descriptions
550
self.verbosity = verbosity
551
self._bench_history = bench_history
552
self.list_only = list_only
555
"Run the given test case or test suite."
556
startTime = time.time()
557
if self.verbosity == 1:
558
result_class = TextTestResult
559
elif self.verbosity >= 2:
560
result_class = VerboseTestResult
561
result = result_class(self.stream,
564
bench_history=self._bench_history,
565
num_tests=test.countTestCases(),
567
result.stop_early = self.stop_on_failure
568
result.report_starting()
570
if self.verbosity >= 2:
571
self.stream.writeln("Listing tests only ...\n")
573
for t in iter_suite_tests(test):
574
self.stream.writeln("%s" % (t.id()))
576
actionTaken = "Listed"
579
run = result.testsRun
581
stopTime = time.time()
582
timeTaken = stopTime - startTime
584
self.stream.writeln(result.separator2)
585
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
586
run, run != 1 and "s" or "", timeTaken))
587
self.stream.writeln()
588
if not result.wasSuccessful():
589
self.stream.write("FAILED (")
590
failed, errored = map(len, (result.failures, result.errors))
592
self.stream.write("failures=%d" % failed)
594
if failed: self.stream.write(", ")
595
self.stream.write("errors=%d" % errored)
596
if result.known_failure_count:
597
if failed or errored: self.stream.write(", ")
598
self.stream.write("known_failure_count=%d" %
599
result.known_failure_count)
600
self.stream.writeln(")")
602
if result.known_failure_count:
603
self.stream.writeln("OK (known_failures=%d)" %
604
result.known_failure_count)
606
self.stream.writeln("OK")
607
if result.skip_count > 0:
608
skipped = result.skip_count
609
self.stream.writeln('%d test%s skipped' %
610
(skipped, skipped != 1 and "s" or ""))
611
if result.unsupported:
612
for feature, count in sorted(result.unsupported.items()):
613
self.stream.writeln("Missing feature '%s' skipped %d tests." %
619
def iter_suite_tests(suite):
620
"""Return all tests in a suite, recursing through nested suites"""
621
for item in suite._tests:
622
if isinstance(item, unittest.TestCase):
624
elif isinstance(item, unittest.TestSuite):
625
for r in iter_suite_tests(item):
628
raise Exception('unknown object %r inside test suite %r'
632
class TestSkipped(Exception):
633
"""Indicates that a test was intentionally skipped, rather than failing."""
636
class TestNotApplicable(TestSkipped):
637
"""A test is not applicable to the situation where it was run.
639
This is only normally raised by parameterized tests, if they find that
640
the instance they're constructed upon does not support one aspect
645
class KnownFailure(AssertionError):
646
"""Indicates that a test failed in a precisely expected manner.
648
Such failures dont block the whole test suite from passing because they are
649
indicators of partially completed code or of future work. We have an
650
explicit error for them so that we can ensure that they are always visible:
651
KnownFailures are always shown in the output of bzr selftest.
655
class UnavailableFeature(Exception):
656
"""A feature required for this test was not available.
658
The feature should be used to construct the exception.
662
class CommandFailed(Exception):
666
class StringIOWrapper(object):
667
"""A wrapper around cStringIO which just adds an encoding attribute.
669
Internally we can check sys.stdout to see what the output encoding
670
should be. However, cStringIO has no encoding attribute that we can
671
set. So we wrap it instead.
676
def __init__(self, s=None):
678
self.__dict__['_cstring'] = StringIO(s)
680
self.__dict__['_cstring'] = StringIO()
682
def __getattr__(self, name, getattr=getattr):
683
return getattr(self.__dict__['_cstring'], name)
685
def __setattr__(self, name, val):
686
if name == 'encoding':
687
self.__dict__['encoding'] = val
689
return setattr(self._cstring, name, val)
692
class TestUIFactory(ui.CLIUIFactory):
693
"""A UI Factory for testing.
695
Hide the progress bar but emit note()s.
697
Allows get_password to be tested without real tty attached.
704
super(TestUIFactory, self).__init__()
705
if stdin is not None:
706
# We use a StringIOWrapper to be able to test various
707
# encodings, but the user is still responsible to
708
# encode the string and to set the encoding attribute
709
# of StringIOWrapper.
710
self.stdin = StringIOWrapper(stdin)
712
self.stdout = sys.stdout
716
self.stderr = sys.stderr
721
"""See progress.ProgressBar.clear()."""
723
def clear_term(self):
724
"""See progress.ProgressBar.clear_term()."""
726
def clear_term(self):
727
"""See progress.ProgressBar.clear_term()."""
730
"""See progress.ProgressBar.finished()."""
732
def note(self, fmt_string, *args, **kwargs):
733
"""See progress.ProgressBar.note()."""
734
self.stdout.write((fmt_string + "\n") % args)
736
def progress_bar(self):
739
def nested_progress_bar(self):
742
def update(self, message, count=None, total=None):
743
"""See progress.ProgressBar.update()."""
745
def get_non_echoed_password(self, prompt):
746
"""Get password from stdin without trying to handle the echo mode"""
748
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
749
password = self.stdin.readline()
752
if password[-1] == '\n':
753
password = password[:-1]
757
class TestCase(unittest.TestCase):
758
"""Base class for bzr unit tests.
760
Tests that need access to disk resources should subclass
761
TestCaseInTempDir not TestCase.
763
Error and debug log messages are redirected from their usual
764
location into a temporary file, the contents of which can be
765
retrieved by _get_log(). We use a real OS file, not an in-memory object,
766
so that it can also capture file IO. When the test completes this file
767
is read into memory and removed from disk.
769
There are also convenience functions to invoke bzr's command-line
770
routine, and to build and check bzr trees.
772
In addition to the usual method of overriding tearDown(), this class also
773
allows subclasses to register functions into the _cleanups list, which is
774
run in order as the object is torn down. It's less likely this will be
775
accidentally overlooked.
778
_log_file_name = None
780
_keep_log_file = False
781
# record lsprof data when performing benchmark calls.
782
_gather_lsprof_in_benchmarks = False
784
def __init__(self, methodName='testMethod'):
785
super(TestCase, self).__init__(methodName)
789
unittest.TestCase.setUp(self)
790
self._cleanEnvironment()
791
bzrlib.trace.disable_default_logging()
794
self._benchcalls = []
795
self._benchtime = None
797
self._clear_debug_flags()
799
def _clear_debug_flags(self):
800
"""Prevent externally set debug flags affecting tests.
802
Tests that want to use debug flags can just set them in the
803
debug_flags set during setup/teardown.
805
self._preserved_debug_flags = set(debug.debug_flags)
806
debug.debug_flags.clear()
807
self.addCleanup(self._restore_debug_flags)
809
def _clear_hooks(self):
810
# prevent hooks affecting tests
812
import bzrlib.smart.server
813
self._preserved_hooks = {
814
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
815
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
817
self.addCleanup(self._restoreHooks)
818
# reset all hooks to an empty instance of the appropriate type
819
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
820
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
822
def _silenceUI(self):
823
"""Turn off UI for duration of test"""
824
# by default the UI is off; tests can turn it on if they want it.
825
saved = ui.ui_factory
827
ui.ui_factory = saved
828
ui.ui_factory = ui.SilentUIFactory()
829
self.addCleanup(_restore)
831
def _ndiff_strings(self, a, b):
832
"""Return ndiff between two strings containing lines.
834
A trailing newline is added if missing to make the strings
836
if b and b[-1] != '\n':
838
if a and a[-1] != '\n':
840
difflines = difflib.ndiff(a.splitlines(True),
842
linejunk=lambda x: False,
843
charjunk=lambda x: False)
844
return ''.join(difflines)
846
def assertEqual(self, a, b, message=''):
850
except UnicodeError, e:
851
# If we can't compare without getting a UnicodeError, then
852
# obviously they are different
853
mutter('UnicodeError: %s', e)
856
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
858
pformat(a), pformat(b)))
860
assertEquals = assertEqual
862
def assertEqualDiff(self, a, b, message=None):
863
"""Assert two texts are equal, if not raise an exception.
865
This is intended for use with multi-line strings where it can
866
be hard to find the differences by eye.
868
# TODO: perhaps override assertEquals to call this for strings?
872
message = "texts not equal:\n"
873
raise AssertionError(message +
874
self._ndiff_strings(a, b))
876
def assertEqualMode(self, mode, mode_test):
877
self.assertEqual(mode, mode_test,
878
'mode mismatch %o != %o' % (mode, mode_test))
880
def assertPositive(self, val):
881
"""Assert that val is greater than 0."""
882
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
884
def assertNegative(self, val):
885
"""Assert that val is less than 0."""
886
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
888
def assertStartsWith(self, s, prefix):
889
if not s.startswith(prefix):
890
raise AssertionError('string %r does not start with %r' % (s, prefix))
892
def assertEndsWith(self, s, suffix):
893
"""Asserts that s ends with suffix."""
894
if not s.endswith(suffix):
895
raise AssertionError('string %r does not end with %r' % (s, suffix))
897
def assertContainsRe(self, haystack, needle_re):
898
"""Assert that a contains something matching a regular expression."""
899
if not re.search(needle_re, haystack):
900
if '\n' in haystack or len(haystack) > 60:
901
# a long string, format it in a more readable way
902
raise AssertionError(
903
'pattern "%s" not found in\n"""\\\n%s"""\n'
904
% (needle_re, haystack))
906
raise AssertionError('pattern "%s" not found in "%s"'
907
% (needle_re, haystack))
909
def assertNotContainsRe(self, haystack, needle_re):
910
"""Assert that a does not match a regular expression"""
911
if re.search(needle_re, haystack):
912
raise AssertionError('pattern "%s" found in "%s"'
913
% (needle_re, haystack))
915
def assertSubset(self, sublist, superlist):
916
"""Assert that every entry in sublist is present in superlist."""
917
missing = set(sublist) - set(superlist)
919
raise AssertionError("value(s) %r not present in container %r" %
920
(missing, superlist))
922
def assertListRaises(self, excClass, func, *args, **kwargs):
923
"""Fail unless excClass is raised when the iterator from func is used.
925
Many functions can return generators this makes sure
926
to wrap them in a list() call to make sure the whole generator
927
is run, and that the proper exception is raised.
930
list(func(*args, **kwargs))
934
if getattr(excClass,'__name__', None) is not None:
935
excName = excClass.__name__
937
excName = str(excClass)
938
raise self.failureException, "%s not raised" % excName
940
def assertRaises(self, excClass, callableObj, *args, **kwargs):
941
"""Assert that a callable raises a particular exception.
943
:param excClass: As for the except statement, this may be either an
944
exception class, or a tuple of classes.
945
:param callableObj: A callable, will be passed ``*args`` and
948
Returns the exception so that you can examine it.
951
callableObj(*args, **kwargs)
955
if getattr(excClass,'__name__', None) is not None:
956
excName = excClass.__name__
959
excName = str(excClass)
960
raise self.failureException, "%s not raised" % excName
962
def assertIs(self, left, right, message=None):
963
if not (left is right):
964
if message is not None:
965
raise AssertionError(message)
967
raise AssertionError("%r is not %r." % (left, right))
969
def assertIsNot(self, left, right, message=None):
971
if message is not None:
972
raise AssertionError(message)
974
raise AssertionError("%r is %r." % (left, right))
976
def assertTransportMode(self, transport, path, mode):
977
"""Fail if a path does not have mode mode.
979
If modes are not supported on this transport, the assertion is ignored.
981
if not transport._can_roundtrip_unix_modebits():
983
path_stat = transport.stat(path)
984
actual_mode = stat.S_IMODE(path_stat.st_mode)
985
self.assertEqual(mode, actual_mode,
986
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
988
def assertIsSameRealPath(self, path1, path2):
989
"""Fail if path1 and path2 points to different files"""
990
self.assertEqual(osutils.realpath(path1),
991
osutils.realpath(path2),
992
"apparent paths:\na = %s\nb = %s\n," % (path1, path2))
994
def assertIsInstance(self, obj, kls):
995
"""Fail if obj is not an instance of kls"""
996
if not isinstance(obj, kls):
997
self.fail("%r is an instance of %s rather than %s" % (
998
obj, obj.__class__, kls))
1000
def expectFailure(self, reason, assertion, *args, **kwargs):
1001
"""Invoke a test, expecting it to fail for the given reason.
1003
This is for assertions that ought to succeed, but currently fail.
1004
(The failure is *expected* but not *wanted*.) Please be very precise
1005
about the failure you're expecting. If a new bug is introduced,
1006
AssertionError should be raised, not KnownFailure.
1008
Frequently, expectFailure should be followed by an opposite assertion.
1011
Intended to be used with a callable that raises AssertionError as the
1012
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1014
Raises KnownFailure if the test fails. Raises AssertionError if the
1019
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1021
self.assertEqual(42, dynamic_val)
1023
This means that a dynamic_val of 54 will cause the test to raise
1024
a KnownFailure. Once math is fixed and the expectFailure is removed,
1025
only a dynamic_val of 42 will allow the test to pass. Anything other
1026
than 54 or 42 will cause an AssertionError.
1029
assertion(*args, **kwargs)
1030
except AssertionError:
1031
raise KnownFailure(reason)
1033
self.fail('Unexpected success. Should have failed: %s' % reason)
1035
def _capture_warnings(self, a_callable, *args, **kwargs):
1036
"""A helper for callDeprecated and applyDeprecated.
1038
:param a_callable: A callable to call.
1039
:param args: The positional arguments for the callable
1040
:param kwargs: The keyword arguments for the callable
1041
:return: A tuple (warnings, result). result is the result of calling
1042
a_callable(``*args``, ``**kwargs``).
1045
def capture_warnings(msg, cls=None, stacklevel=None):
1046
# we've hooked into a deprecation specific callpath,
1047
# only deprecations should getting sent via it.
1048
self.assertEqual(cls, DeprecationWarning)
1049
local_warnings.append(msg)
1050
original_warning_method = symbol_versioning.warn
1051
symbol_versioning.set_warning_method(capture_warnings)
1053
result = a_callable(*args, **kwargs)
1055
symbol_versioning.set_warning_method(original_warning_method)
1056
return (local_warnings, result)
1058
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1059
"""Call a deprecated callable without warning the user.
1061
Note that this only captures warnings raised by symbol_versioning.warn,
1062
not other callers that go direct to the warning module.
1064
To test that a deprecated method raises an error, do something like
1067
self.assertRaises(errors.ReservedId,
1068
self.applyDeprecated, zero_ninetyone,
1069
br.append_revision, 'current:')
1071
:param deprecation_format: The deprecation format that the callable
1072
should have been deprecated with. This is the same type as the
1073
parameter to deprecated_method/deprecated_function. If the
1074
callable is not deprecated with this format, an assertion error
1076
:param a_callable: A callable to call. This may be a bound method or
1077
a regular function. It will be called with ``*args`` and
1079
:param args: The positional arguments for the callable
1080
:param kwargs: The keyword arguments for the callable
1081
:return: The result of a_callable(``*args``, ``**kwargs``)
1083
call_warnings, result = self._capture_warnings(a_callable,
1085
expected_first_warning = symbol_versioning.deprecation_string(
1086
a_callable, deprecation_format)
1087
if len(call_warnings) == 0:
1088
self.fail("No deprecation warning generated by call to %s" %
1090
self.assertEqual(expected_first_warning, call_warnings[0])
1093
def callDeprecated(self, expected, callable, *args, **kwargs):
1094
"""Assert that a callable is deprecated in a particular way.
1096
This is a very precise test for unusual requirements. The
1097
applyDeprecated helper function is probably more suited for most tests
1098
as it allows you to simply specify the deprecation format being used
1099
and will ensure that that is issued for the function being called.
1101
Note that this only captures warnings raised by symbol_versioning.warn,
1102
not other callers that go direct to the warning module.
1104
:param expected: a list of the deprecation warnings expected, in order
1105
:param callable: The callable to call
1106
:param args: The positional arguments for the callable
1107
:param kwargs: The keyword arguments for the callable
1109
call_warnings, result = self._capture_warnings(callable,
1111
self.assertEqual(expected, call_warnings)
1114
def _startLogFile(self):
1115
"""Send bzr and test log messages to a temporary file.
1117
The file is removed as the test is torn down.
1119
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1120
self._log_file = os.fdopen(fileno, 'w+')
1121
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1122
self._log_file_name = name
1123
self.addCleanup(self._finishLogFile)
1125
def _finishLogFile(self):
1126
"""Finished with the log file.
1128
Close the file and delete it, unless setKeepLogfile was called.
1130
if self._log_file is None:
1132
bzrlib.trace.disable_test_log(self._log_nonce)
1133
self._log_file.close()
1134
self._log_file = None
1135
if not self._keep_log_file:
1136
os.remove(self._log_file_name)
1137
self._log_file_name = None
1139
def setKeepLogfile(self):
1140
"""Make the logfile not be deleted when _finishLogFile is called."""
1141
self._keep_log_file = True
1143
def addCleanup(self, callable):
1144
"""Arrange to run a callable when this case is torn down.
1146
Callables are run in the reverse of the order they are registered,
1147
ie last-in first-out.
1149
if callable in self._cleanups:
1150
raise ValueError("cleanup function %r already registered on %s"
1152
self._cleanups.append(callable)
1154
def _cleanEnvironment(self):
1156
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1157
'HOME': os.getcwd(),
1158
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1159
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1161
'BZREMAIL': None, # may still be present in the environment
1163
'BZR_PROGRESS_BAR': None,
1165
'SSH_AUTH_SOCK': None,
1169
'https_proxy': None,
1170
'HTTPS_PROXY': None,
1175
# Nobody cares about these ones AFAIK. So far at
1176
# least. If you do (care), please update this comment
1180
'BZR_REMOTE_PATH': None,
1183
self.addCleanup(self._restoreEnvironment)
1184
for name, value in new_env.iteritems():
1185
self._captureVar(name, value)
1187
def _captureVar(self, name, newvalue):
1188
"""Set an environment variable, and reset it when finished."""
1189
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1191
def _restore_debug_flags(self):
1192
debug.debug_flags.clear()
1193
debug.debug_flags.update(self._preserved_debug_flags)
1195
def _restoreEnvironment(self):
1196
for name, value in self.__old_env.iteritems():
1197
osutils.set_or_unset_env(name, value)
1199
def _restoreHooks(self):
1200
for klass, hooks in self._preserved_hooks.items():
1201
setattr(klass, 'hooks', hooks)
1203
def knownFailure(self, reason):
1204
"""This test has failed for some known reason."""
1205
raise KnownFailure(reason)
1207
def run(self, result=None):
1208
if result is None: result = self.defaultTestResult()
1209
for feature in getattr(self, '_test_needs_features', []):
1210
if not feature.available():
1211
result.startTest(self)
1212
if getattr(result, 'addNotSupported', None):
1213
result.addNotSupported(self, feature)
1215
result.addSuccess(self)
1216
result.stopTest(self)
1218
return unittest.TestCase.run(self, result)
1222
unittest.TestCase.tearDown(self)
1224
def time(self, callable, *args, **kwargs):
1225
"""Run callable and accrue the time it takes to the benchmark time.
1227
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1228
this will cause lsprofile statistics to be gathered and stored in
1231
if self._benchtime is None:
1235
if not self._gather_lsprof_in_benchmarks:
1236
return callable(*args, **kwargs)
1238
# record this benchmark
1239
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1241
self._benchcalls.append(((callable, args, kwargs), stats))
1244
self._benchtime += time.time() - start
1246
def _runCleanups(self):
1247
"""Run registered cleanup functions.
1249
This should only be called from TestCase.tearDown.
1251
# TODO: Perhaps this should keep running cleanups even if
1252
# one of them fails?
1254
# Actually pop the cleanups from the list so tearDown running
1255
# twice is safe (this happens for skipped tests).
1256
while self._cleanups:
1257
self._cleanups.pop()()
1259
def log(self, *args):
1262
def _get_log(self, keep_log_file=False):
1263
"""Get the log from bzrlib.trace calls from this test.
1265
:param keep_log_file: When True, if the log is still a file on disk
1266
leave it as a file on disk. When False, if the log is still a file
1267
on disk, the log file is deleted and the log preserved as
1269
:return: A string containing the log.
1271
# flush the log file, to get all content
1273
bzrlib.trace._trace_file.flush()
1274
if self._log_contents:
1275
return self._log_contents
1276
if self._log_file_name is not None:
1277
logfile = open(self._log_file_name)
1279
log_contents = logfile.read()
1282
if not keep_log_file:
1283
self._log_contents = log_contents
1285
os.remove(self._log_file_name)
1287
if sys.platform == 'win32' and e.errno == errno.EACCES:
1288
sys.stderr.write(('Unable to delete log file '
1289
' %r\n' % self._log_file_name))
1294
return "DELETED log file to reduce memory footprint"
1296
def requireFeature(self, feature):
1297
"""This test requires a specific feature is available.
1299
:raises UnavailableFeature: When feature is not available.
1301
if not feature.available():
1302
raise UnavailableFeature(feature)
1304
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1306
"""Run bazaar command line, splitting up a string command line."""
1307
if isinstance(args, basestring):
1308
# shlex don't understand unicode strings,
1309
# so args should be plain string (bialix 20070906)
1310
args = list(shlex.split(str(args)))
1311
return self._run_bzr_core(args, retcode=retcode,
1312
encoding=encoding, stdin=stdin, working_dir=working_dir,
1315
def _run_bzr_core(self, args, retcode, encoding, stdin,
1317
if encoding is None:
1318
encoding = bzrlib.user_encoding
1319
stdout = StringIOWrapper()
1320
stderr = StringIOWrapper()
1321
stdout.encoding = encoding
1322
stderr.encoding = encoding
1324
self.log('run bzr: %r', args)
1325
# FIXME: don't call into logging here
1326
handler = logging.StreamHandler(stderr)
1327
handler.setLevel(logging.INFO)
1328
logger = logging.getLogger('')
1329
logger.addHandler(handler)
1330
old_ui_factory = ui.ui_factory
1331
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1334
if working_dir is not None:
1335
cwd = osutils.getcwd()
1336
os.chdir(working_dir)
1339
result = self.apply_redirected(ui.ui_factory.stdin,
1341
bzrlib.commands.run_bzr_catch_user_errors,
1344
logger.removeHandler(handler)
1345
ui.ui_factory = old_ui_factory
1349
out = stdout.getvalue()
1350
err = stderr.getvalue()
1352
self.log('output:\n%r', out)
1354
self.log('errors:\n%r', err)
1355
if retcode is not None:
1356
self.assertEquals(retcode, result,
1357
message='Unexpected return code')
1360
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1361
working_dir=None, error_regexes=[], output_encoding=None):
1362
"""Invoke bzr, as if it were run from the command line.
1364
The argument list should not include the bzr program name - the
1365
first argument is normally the bzr command. Arguments may be
1366
passed in three ways:
1368
1- A list of strings, eg ["commit", "a"]. This is recommended
1369
when the command contains whitespace or metacharacters, or
1370
is built up at run time.
1372
2- A single string, eg "add a". This is the most convenient
1373
for hardcoded commands.
1375
This runs bzr through the interface that catches and reports
1376
errors, and with logging set to something approximating the
1377
default, so that error reporting can be checked.
1379
This should be the main method for tests that want to exercise the
1380
overall behavior of the bzr application (rather than a unit test
1381
or a functional test of the library.)
1383
This sends the stdout/stderr results into the test's log,
1384
where it may be useful for debugging. See also run_captured.
1386
:keyword stdin: A string to be used as stdin for the command.
1387
:keyword retcode: The status code the command should return;
1389
:keyword working_dir: The directory to run the command in
1390
:keyword error_regexes: A list of expected error messages. If
1391
specified they must be seen in the error output of the command.
1393
out, err = self._run_bzr_autosplit(
1398
working_dir=working_dir,
1400
for regex in error_regexes:
1401
self.assertContainsRe(err, regex)
1404
def run_bzr_error(self, error_regexes, *args, **kwargs):
1405
"""Run bzr, and check that stderr contains the supplied regexes
1407
:param error_regexes: Sequence of regular expressions which
1408
must each be found in the error output. The relative ordering
1410
:param args: command-line arguments for bzr
1411
:param kwargs: Keyword arguments which are interpreted by run_bzr
1412
This function changes the default value of retcode to be 3,
1413
since in most cases this is run when you expect bzr to fail.
1415
:return: (out, err) The actual output of running the command (in case
1416
you want to do more inspection)
1420
# Make sure that commit is failing because there is nothing to do
1421
self.run_bzr_error(['no changes to commit'],
1422
['commit', '-m', 'my commit comment'])
1423
# Make sure --strict is handling an unknown file, rather than
1424
# giving us the 'nothing to do' error
1425
self.build_tree(['unknown'])
1426
self.run_bzr_error(['Commit refused because there are unknown files'],
1427
['commit', --strict', '-m', 'my commit comment'])
1429
kwargs.setdefault('retcode', 3)
1430
kwargs['error_regexes'] = error_regexes
1431
out, err = self.run_bzr(*args, **kwargs)
1434
def run_bzr_subprocess(self, *args, **kwargs):
1435
"""Run bzr in a subprocess for testing.
1437
This starts a new Python interpreter and runs bzr in there.
1438
This should only be used for tests that have a justifiable need for
1439
this isolation: e.g. they are testing startup time, or signal
1440
handling, or early startup code, etc. Subprocess code can't be
1441
profiled or debugged so easily.
1443
:keyword retcode: The status code that is expected. Defaults to 0. If
1444
None is supplied, the status code is not checked.
1445
:keyword env_changes: A dictionary which lists changes to environment
1446
variables. A value of None will unset the env variable.
1447
The values must be strings. The change will only occur in the
1448
child, so you don't need to fix the environment after running.
1449
:keyword universal_newlines: Convert CRLF => LF
1450
:keyword allow_plugins: By default the subprocess is run with
1451
--no-plugins to ensure test reproducibility. Also, it is possible
1452
for system-wide plugins to create unexpected output on stderr,
1453
which can cause unnecessary test failures.
1455
env_changes = kwargs.get('env_changes', {})
1456
working_dir = kwargs.get('working_dir', None)
1457
allow_plugins = kwargs.get('allow_plugins', False)
1459
if isinstance(args[0], list):
1461
elif isinstance(args[0], basestring):
1462
args = list(shlex.split(args[0]))
1464
symbol_versioning.warn(zero_ninetyone %
1465
"passing varargs to run_bzr_subprocess",
1466
DeprecationWarning, stacklevel=3)
1467
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1468
working_dir=working_dir,
1469
allow_plugins=allow_plugins)
1470
# We distinguish between retcode=None and retcode not passed.
1471
supplied_retcode = kwargs.get('retcode', 0)
1472
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1473
universal_newlines=kwargs.get('universal_newlines', False),
1476
def start_bzr_subprocess(self, process_args, env_changes=None,
1477
skip_if_plan_to_signal=False,
1479
allow_plugins=False):
1480
"""Start bzr in a subprocess for testing.
1482
This starts a new Python interpreter and runs bzr in there.
1483
This should only be used for tests that have a justifiable need for
1484
this isolation: e.g. they are testing startup time, or signal
1485
handling, or early startup code, etc. Subprocess code can't be
1486
profiled or debugged so easily.
1488
:param process_args: a list of arguments to pass to the bzr executable,
1489
for example ``['--version']``.
1490
:param env_changes: A dictionary which lists changes to environment
1491
variables. A value of None will unset the env variable.
1492
The values must be strings. The change will only occur in the
1493
child, so you don't need to fix the environment after running.
1494
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1496
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1498
:returns: Popen object for the started process.
1500
if skip_if_plan_to_signal:
1501
if not getattr(os, 'kill', None):
1502
raise TestSkipped("os.kill not available.")
1504
if env_changes is None:
1508
def cleanup_environment():
1509
for env_var, value in env_changes.iteritems():
1510
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1512
def restore_environment():
1513
for env_var, value in old_env.iteritems():
1514
osutils.set_or_unset_env(env_var, value)
1516
bzr_path = self.get_bzr_path()
1519
if working_dir is not None:
1520
cwd = osutils.getcwd()
1521
os.chdir(working_dir)
1524
# win32 subprocess doesn't support preexec_fn
1525
# so we will avoid using it on all platforms, just to
1526
# make sure the code path is used, and we don't break on win32
1527
cleanup_environment()
1528
command = [sys.executable, bzr_path]
1529
if not allow_plugins:
1530
command.append('--no-plugins')
1531
command.extend(process_args)
1532
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1534
restore_environment()
1540
def _popen(self, *args, **kwargs):
1541
"""Place a call to Popen.
1543
Allows tests to override this method to intercept the calls made to
1544
Popen for introspection.
1546
return Popen(*args, **kwargs)
1548
def get_bzr_path(self):
1549
"""Return the path of the 'bzr' executable for this test suite."""
1550
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1551
if not os.path.isfile(bzr_path):
1552
# We are probably installed. Assume sys.argv is the right file
1553
bzr_path = sys.argv[0]
1556
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1557
universal_newlines=False, process_args=None):
1558
"""Finish the execution of process.
1560
:param process: the Popen object returned from start_bzr_subprocess.
1561
:param retcode: The status code that is expected. Defaults to 0. If
1562
None is supplied, the status code is not checked.
1563
:param send_signal: an optional signal to send to the process.
1564
:param universal_newlines: Convert CRLF => LF
1565
:returns: (stdout, stderr)
1567
if send_signal is not None:
1568
os.kill(process.pid, send_signal)
1569
out, err = process.communicate()
1571
if universal_newlines:
1572
out = out.replace('\r\n', '\n')
1573
err = err.replace('\r\n', '\n')
1575
if retcode is not None and retcode != process.returncode:
1576
if process_args is None:
1577
process_args = "(unknown args)"
1578
mutter('Output of bzr %s:\n%s', process_args, out)
1579
mutter('Error for bzr %s:\n%s', process_args, err)
1580
self.fail('Command bzr %s failed with retcode %s != %s'
1581
% (process_args, retcode, process.returncode))
1584
def check_inventory_shape(self, inv, shape):
1585
"""Compare an inventory to a list of expected names.
1587
Fail if they are not precisely equal.
1590
shape = list(shape) # copy
1591
for path, ie in inv.entries():
1592
name = path.replace('\\', '/')
1593
if ie.kind == 'directory':
1600
self.fail("expected paths not found in inventory: %r" % shape)
1602
self.fail("unexpected paths found in inventory: %r" % extras)
1604
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1605
a_callable=None, *args, **kwargs):
1606
"""Call callable with redirected std io pipes.
1608
Returns the return code."""
1609
if not callable(a_callable):
1610
raise ValueError("a_callable must be callable.")
1612
stdin = StringIO("")
1614
if getattr(self, "_log_file", None) is not None:
1615
stdout = self._log_file
1619
if getattr(self, "_log_file", None is not None):
1620
stderr = self._log_file
1623
real_stdin = sys.stdin
1624
real_stdout = sys.stdout
1625
real_stderr = sys.stderr
1630
return a_callable(*args, **kwargs)
1632
sys.stdout = real_stdout
1633
sys.stderr = real_stderr
1634
sys.stdin = real_stdin
1636
def reduceLockdirTimeout(self):
1637
"""Reduce the default lock timeout for the duration of the test, so that
1638
if LockContention occurs during a test, it does so quickly.
1640
Tests that expect to provoke LockContention errors should call this.
1642
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1644
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1645
self.addCleanup(resetTimeout)
1646
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1648
def make_utf8_encoded_stringio(self, encoding_type=None):
1649
"""Return a StringIOWrapper instance, that will encode Unicode
1652
if encoding_type is None:
1653
encoding_type = 'strict'
1655
output_encoding = 'utf-8'
1656
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1657
sio.encoding = output_encoding
1661
class TestCaseWithMemoryTransport(TestCase):
1662
"""Common test class for tests that do not need disk resources.
1664
Tests that need disk resources should derive from TestCaseWithTransport.
1666
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1668
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1669
a directory which does not exist. This serves to help ensure test isolation
1670
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1671
must exist. However, TestCaseWithMemoryTransport does not offer local
1672
file defaults for the transport in tests, nor does it obey the command line
1673
override, so tests that accidentally write to the common directory should
1676
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1677
a .bzr directory that stops us ascending higher into the filesystem.
1683
def __init__(self, methodName='runTest'):
1684
# allow test parameterisation after test construction and before test
1685
# execution. Variables that the parameteriser sets need to be
1686
# ones that are not set by setUp, or setUp will trash them.
1687
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1688
self.vfs_transport_factory = default_transport
1689
self.transport_server = None
1690
self.transport_readonly_server = None
1691
self.__vfs_server = None
1693
def get_transport(self, relpath=None):
1694
"""Return a writeable transport.
1696
This transport is for the test scratch space relative to
1699
:param relpath: a path relative to the base url.
1701
t = get_transport(self.get_url(relpath))
1702
self.assertFalse(t.is_readonly())
1705
def get_readonly_transport(self, relpath=None):
1706
"""Return a readonly transport for the test scratch space
1708
This can be used to test that operations which should only need
1709
readonly access in fact do not try to write.
1711
:param relpath: a path relative to the base url.
1713
t = get_transport(self.get_readonly_url(relpath))
1714
self.assertTrue(t.is_readonly())
1717
def create_transport_readonly_server(self):
1718
"""Create a transport server from class defined at init.
1720
This is mostly a hook for daughter classes.
1722
return self.transport_readonly_server()
1724
def get_readonly_server(self):
1725
"""Get the server instance for the readonly transport
1727
This is useful for some tests with specific servers to do diagnostics.
1729
if self.__readonly_server is None:
1730
if self.transport_readonly_server is None:
1731
# readonly decorator requested
1732
# bring up the server
1733
self.__readonly_server = ReadonlyServer()
1734
self.__readonly_server.setUp(self.get_vfs_only_server())
1736
self.__readonly_server = self.create_transport_readonly_server()
1737
self.__readonly_server.setUp(self.get_vfs_only_server())
1738
self.addCleanup(self.__readonly_server.tearDown)
1739
return self.__readonly_server
1741
def get_readonly_url(self, relpath=None):
1742
"""Get a URL for the readonly transport.
1744
This will either be backed by '.' or a decorator to the transport
1745
used by self.get_url()
1746
relpath provides for clients to get a path relative to the base url.
1747
These should only be downwards relative, not upwards.
1749
base = self.get_readonly_server().get_url()
1750
return self._adjust_url(base, relpath)
1752
def get_vfs_only_server(self):
1753
"""Get the vfs only read/write server instance.
1755
This is useful for some tests with specific servers that need
1758
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1759
is no means to override it.
1761
if self.__vfs_server is None:
1762
self.__vfs_server = MemoryServer()
1763
self.__vfs_server.setUp()
1764
self.addCleanup(self.__vfs_server.tearDown)
1765
return self.__vfs_server
1767
def get_server(self):
1768
"""Get the read/write server instance.
1770
This is useful for some tests with specific servers that need
1773
This is built from the self.transport_server factory. If that is None,
1774
then the self.get_vfs_server is returned.
1776
if self.__server is None:
1777
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1778
return self.get_vfs_only_server()
1780
# bring up a decorated means of access to the vfs only server.
1781
self.__server = self.transport_server()
1783
self.__server.setUp(self.get_vfs_only_server())
1784
except TypeError, e:
1785
# This should never happen; the try:Except here is to assist
1786
# developers having to update code rather than seeing an
1787
# uninformative TypeError.
1788
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1789
self.addCleanup(self.__server.tearDown)
1790
return self.__server
1792
def _adjust_url(self, base, relpath):
1793
"""Get a URL (or maybe a path) for the readwrite transport.
1795
This will either be backed by '.' or to an equivalent non-file based
1797
relpath provides for clients to get a path relative to the base url.
1798
These should only be downwards relative, not upwards.
1800
if relpath is not None and relpath != '.':
1801
if not base.endswith('/'):
1803
# XXX: Really base should be a url; we did after all call
1804
# get_url()! But sometimes it's just a path (from
1805
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1806
# to a non-escaped local path.
1807
if base.startswith('./') or base.startswith('/'):
1810
base += urlutils.escape(relpath)
1813
def get_url(self, relpath=None):
1814
"""Get a URL (or maybe a path) for the readwrite transport.
1816
This will either be backed by '.' or to an equivalent non-file based
1818
relpath provides for clients to get a path relative to the base url.
1819
These should only be downwards relative, not upwards.
1821
base = self.get_server().get_url()
1822
return self._adjust_url(base, relpath)
1824
def get_vfs_only_url(self, relpath=None):
1825
"""Get a URL (or maybe a path for the plain old vfs transport.
1827
This will never be a smart protocol. It always has all the
1828
capabilities of the local filesystem, but it might actually be a
1829
MemoryTransport or some other similar virtual filesystem.
1831
This is the backing transport (if any) of the server returned by
1832
get_url and get_readonly_url.
1834
:param relpath: provides for clients to get a path relative to the base
1835
url. These should only be downwards relative, not upwards.
1838
base = self.get_vfs_only_server().get_url()
1839
return self._adjust_url(base, relpath)
1841
def _create_safety_net(self):
1842
"""Make a fake bzr directory.
1844
This prevents any tests propagating up onto the TEST_ROOT directory's
1847
root = TestCaseWithMemoryTransport.TEST_ROOT
1848
bzrdir.BzrDir.create_standalone_workingtree(root)
1850
def _check_safety_net(self):
1851
"""Check that the safety .bzr directory have not been touched.
1853
_make_test_root have created a .bzr directory to prevent tests from
1854
propagating. This method ensures than a test did not leaked.
1856
root = TestCaseWithMemoryTransport.TEST_ROOT
1857
wt = workingtree.WorkingTree.open(root)
1858
last_rev = wt.last_revision()
1859
if last_rev != 'null:':
1860
# The current test have modified the /bzr directory, we need to
1861
# recreate a new one or all the followng tests will fail.
1862
# If you need to inspect its content uncomment the following line
1863
# import pdb; pdb.set_trace()
1864
_rmtree_temp_dir(root + '/.bzr')
1865
self._create_safety_net()
1866
raise AssertionError('%s/.bzr should not be modified' % root)
1868
def _make_test_root(self):
1869
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1870
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1871
TestCaseWithMemoryTransport.TEST_ROOT = root
1873
self._create_safety_net()
1875
# The same directory is used by all tests, and we're not
1876
# specifically told when all tests are finished. This will do.
1877
atexit.register(_rmtree_temp_dir, root)
1879
self.addCleanup(self._check_safety_net)
1881
def makeAndChdirToTestDir(self):
1882
"""Create a temporary directories for this one test.
1884
This must set self.test_home_dir and self.test_dir and chdir to
1887
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1889
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1890
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1891
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1893
def make_branch(self, relpath, format=None):
1894
"""Create a branch on the transport at relpath."""
1895
repo = self.make_repository(relpath, format=format)
1896
return repo.bzrdir.create_branch()
1898
def make_bzrdir(self, relpath, format=None):
1900
# might be a relative or absolute path
1901
maybe_a_url = self.get_url(relpath)
1902
segments = maybe_a_url.rsplit('/', 1)
1903
t = get_transport(maybe_a_url)
1904
if len(segments) > 1 and segments[-1] not in ('', '.'):
1908
if isinstance(format, basestring):
1909
format = bzrdir.format_registry.make_bzrdir(format)
1910
return format.initialize_on_transport(t)
1911
except errors.UninitializableFormat:
1912
raise TestSkipped("Format %s is not initializable." % format)
1914
def make_repository(self, relpath, shared=False, format=None):
1915
"""Create a repository on our default transport at relpath.
1917
Note that relpath must be a relative path, not a full url.
1919
# FIXME: If you create a remoterepository this returns the underlying
1920
# real format, which is incorrect. Actually we should make sure that
1921
# RemoteBzrDir returns a RemoteRepository.
1922
# maybe mbp 20070410
1923
made_control = self.make_bzrdir(relpath, format=format)
1924
return made_control.create_repository(shared=shared)
1926
def make_branch_and_memory_tree(self, relpath, format=None):
1927
"""Create a branch on the default transport and a MemoryTree for it."""
1928
b = self.make_branch(relpath, format=format)
1929
return memorytree.MemoryTree.create_on_branch(b)
1931
def overrideEnvironmentForTesting(self):
1932
os.environ['HOME'] = self.test_home_dir
1933
os.environ['BZR_HOME'] = self.test_home_dir
1936
super(TestCaseWithMemoryTransport, self).setUp()
1937
self._make_test_root()
1938
_currentdir = os.getcwdu()
1939
def _leaveDirectory():
1940
os.chdir(_currentdir)
1941
self.addCleanup(_leaveDirectory)
1942
self.makeAndChdirToTestDir()
1943
self.overrideEnvironmentForTesting()
1944
self.__readonly_server = None
1945
self.__server = None
1946
self.reduceLockdirTimeout()
1949
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1950
"""Derived class that runs a test within a temporary directory.
1952
This is useful for tests that need to create a branch, etc.
1954
The directory is created in a slightly complex way: for each
1955
Python invocation, a new temporary top-level directory is created.
1956
All test cases create their own directory within that. If the
1957
tests complete successfully, the directory is removed.
1959
:ivar test_base_dir: The path of the top-level directory for this
1960
test, which contains a home directory and a work directory.
1962
:ivar test_home_dir: An initially empty directory under test_base_dir
1963
which is used as $HOME for this test.
1965
:ivar test_dir: A directory under test_base_dir used as the current
1966
directory when the test proper is run.
1969
OVERRIDE_PYTHON = 'python'
1971
def check_file_contents(self, filename, expect):
1972
self.log("check contents of file %s" % filename)
1973
contents = file(filename, 'r').read()
1974
if contents != expect:
1975
self.log("expected: %r" % expect)
1976
self.log("actually: %r" % contents)
1977
self.fail("contents of %s not as expected" % filename)
1979
def makeAndChdirToTestDir(self):
1980
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1982
For TestCaseInTempDir we create a temporary directory based on the test
1983
name and then create two subdirs - test and home under it.
1985
# create a directory within the top level test directory
1986
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
1987
# now create test and home directories within this dir
1988
self.test_base_dir = candidate_dir
1989
self.test_home_dir = self.test_base_dir + '/home'
1990
os.mkdir(self.test_home_dir)
1991
self.test_dir = self.test_base_dir + '/work'
1992
os.mkdir(self.test_dir)
1993
os.chdir(self.test_dir)
1994
# put name of test inside
1995
f = file(self.test_base_dir + '/name', 'w')
2000
self.addCleanup(self.deleteTestDir)
2002
def deleteTestDir(self):
2003
os.chdir(self.TEST_ROOT)
2004
_rmtree_temp_dir(self.test_base_dir)
2006
def build_tree(self, shape, line_endings='binary', transport=None):
2007
"""Build a test tree according to a pattern.
2009
shape is a sequence of file specifications. If the final
2010
character is '/', a directory is created.
2012
This assumes that all the elements in the tree being built are new.
2014
This doesn't add anything to a branch.
2016
:param line_endings: Either 'binary' or 'native'
2017
in binary mode, exact contents are written in native mode, the
2018
line endings match the default platform endings.
2019
:param transport: A transport to write to, for building trees on VFS's.
2020
If the transport is readonly or None, "." is opened automatically.
2023
# It's OK to just create them using forward slashes on windows.
2024
if transport is None or transport.is_readonly():
2025
transport = get_transport(".")
2027
self.assert_(isinstance(name, basestring))
2029
transport.mkdir(urlutils.escape(name[:-1]))
2031
if line_endings == 'binary':
2033
elif line_endings == 'native':
2036
raise errors.BzrError(
2037
'Invalid line ending request %r' % line_endings)
2038
content = "contents of %s%s" % (name.encode('utf-8'), end)
2039
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2041
def build_tree_contents(self, shape):
2042
build_tree_contents(shape)
2044
def assertFileEqual(self, content, path):
2045
"""Fail if path does not contain 'content'."""
2046
self.failUnlessExists(path)
2047
f = file(path, 'rb')
2052
self.assertEqualDiff(content, s)
2054
def failUnlessExists(self, path):
2055
"""Fail unless path or paths, which may be abs or relative, exist."""
2056
if not isinstance(path, basestring):
2058
self.failUnlessExists(p)
2060
self.failUnless(osutils.lexists(path),path+" does not exist")
2062
def failIfExists(self, path):
2063
"""Fail if path or paths, which may be abs or relative, exist."""
2064
if not isinstance(path, basestring):
2066
self.failIfExists(p)
2068
self.failIf(osutils.lexists(path),path+" exists")
2070
def assertInWorkingTree(self, path, root_path='.', tree=None):
2071
"""Assert whether path or paths are in the WorkingTree"""
2073
tree = workingtree.WorkingTree.open(root_path)
2074
if not isinstance(path, basestring):
2076
self.assertInWorkingTree(p,tree=tree)
2078
self.assertIsNot(tree.path2id(path), None,
2079
path+' not in working tree.')
2081
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2082
"""Assert whether path or paths are not in the WorkingTree"""
2084
tree = workingtree.WorkingTree.open(root_path)
2085
if not isinstance(path, basestring):
2087
self.assertNotInWorkingTree(p,tree=tree)
2089
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2092
class TestCaseWithTransport(TestCaseInTempDir):
2093
"""A test case that provides get_url and get_readonly_url facilities.
2095
These back onto two transport servers, one for readonly access and one for
2098
If no explicit class is provided for readonly access, a
2099
ReadonlyTransportDecorator is used instead which allows the use of non disk
2100
based read write transports.
2102
If an explicit class is provided for readonly access, that server and the
2103
readwrite one must both define get_url() as resolving to os.getcwd().
2106
def get_vfs_only_server(self):
2107
"""See TestCaseWithMemoryTransport.
2109
This is useful for some tests with specific servers that need
2112
if self.__vfs_server is None:
2113
self.__vfs_server = self.vfs_transport_factory()
2114
self.__vfs_server.setUp()
2115
self.addCleanup(self.__vfs_server.tearDown)
2116
return self.__vfs_server
2118
def make_branch_and_tree(self, relpath, format=None):
2119
"""Create a branch on the transport and a tree locally.
2121
If the transport is not a LocalTransport, the Tree can't be created on
2122
the transport. In that case if the vfs_transport_factory is
2123
LocalURLServer the working tree is created in the local
2124
directory backing the transport, and the returned tree's branch and
2125
repository will also be accessed locally. Otherwise a lightweight
2126
checkout is created and returned.
2128
:param format: The BzrDirFormat.
2129
:returns: the WorkingTree.
2131
# TODO: always use the local disk path for the working tree,
2132
# this obviously requires a format that supports branch references
2133
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2135
b = self.make_branch(relpath, format=format)
2137
return b.bzrdir.create_workingtree()
2138
except errors.NotLocalUrl:
2139
# We can only make working trees locally at the moment. If the
2140
# transport can't support them, then we keep the non-disk-backed
2141
# branch and create a local checkout.
2142
if self.vfs_transport_factory is LocalURLServer:
2143
# the branch is colocated on disk, we cannot create a checkout.
2144
# hopefully callers will expect this.
2145
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2146
return local_controldir.create_workingtree()
2148
return b.create_checkout(relpath, lightweight=True)
2150
def assertIsDirectory(self, relpath, transport):
2151
"""Assert that relpath within transport is a directory.
2153
This may not be possible on all transports; in that case it propagates
2154
a TransportNotPossible.
2157
mode = transport.stat(relpath).st_mode
2158
except errors.NoSuchFile:
2159
self.fail("path %s is not a directory; no such file"
2161
if not stat.S_ISDIR(mode):
2162
self.fail("path %s is not a directory; has mode %#o"
2165
def assertTreesEqual(self, left, right):
2166
"""Check that left and right have the same content and properties."""
2167
# we use a tree delta to check for equality of the content, and we
2168
# manually check for equality of other things such as the parents list.
2169
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2170
differences = left.changes_from(right)
2171
self.assertFalse(differences.has_changed(),
2172
"Trees %r and %r are different: %r" % (left, right, differences))
2175
super(TestCaseWithTransport, self).setUp()
2176
self.__vfs_server = None
2179
class ChrootedTestCase(TestCaseWithTransport):
2180
"""A support class that provides readonly urls outside the local namespace.
2182
This is done by checking if self.transport_server is a MemoryServer. if it
2183
is then we are chrooted already, if it is not then an HttpServer is used
2186
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2187
be used without needed to redo it when a different
2188
subclass is in use ?
2192
super(ChrootedTestCase, self).setUp()
2193
if not self.vfs_transport_factory == MemoryServer:
2194
self.transport_readonly_server = HttpServer
2197
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2198
random_order=False):
2199
"""Create a test suite by filtering another one.
2201
:param suite: the source suite
2202
:param pattern: pattern that names must match
2203
:param exclude_pattern: pattern that names must not match, if any
2204
:param random_order: if True, tests in the new suite will be put in
2206
:returns: the newly created suite
2208
return sort_suite_by_re(suite, pattern, exclude_pattern,
2209
random_order, False)
2212
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2213
random_order=False, append_rest=True):
2214
"""Create a test suite by sorting another one.
2216
:param suite: the source suite
2217
:param pattern: pattern that names must match in order to go
2218
first in the new suite
2219
:param exclude_pattern: pattern that names must not match, if any
2220
:param random_order: if True, tests in the new suite will be put in
2222
:param append_rest: if False, pattern is a strict filter and not
2223
just an ordering directive
2224
:returns: the newly created suite
2228
filter_re = re.compile(pattern)
2229
if exclude_pattern is not None:
2230
exclude_re = re.compile(exclude_pattern)
2231
for test in iter_suite_tests(suite):
2233
if exclude_pattern is None or not exclude_re.search(test_id):
2234
if filter_re.search(test_id):
2239
random.shuffle(first)
2240
random.shuffle(second)
2241
return TestUtil.TestSuite(first + second)
2244
def run_suite(suite, name='test', verbose=False, pattern=".*",
2245
stop_on_failure=False,
2246
transport=None, lsprof_timed=None, bench_history=None,
2247
matching_tests_first=None,
2250
exclude_pattern=None,
2253
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2258
runner = TextTestRunner(stream=sys.stdout,
2260
verbosity=verbosity,
2261
bench_history=bench_history,
2262
list_only=list_only,
2264
runner.stop_on_failure=stop_on_failure
2265
# Initialise the random number generator and display the seed used.
2266
# We convert the seed to a long to make it reuseable across invocations.
2267
random_order = False
2268
if random_seed is not None:
2270
if random_seed == "now":
2271
random_seed = long(time.time())
2273
# Convert the seed to a long if we can
2275
random_seed = long(random_seed)
2278
runner.stream.writeln("Randomizing test order using seed %s\n" %
2280
random.seed(random_seed)
2281
# Customise the list of tests if requested
2282
if pattern != '.*' or exclude_pattern is not None or random_order:
2283
if matching_tests_first:
2284
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2287
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2289
result = runner.run(suite)
2292
return result.wasStrictlySuccessful()
2294
return result.wasSuccessful()
2297
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2299
test_suite_factory=None,
2302
matching_tests_first=None,
2305
exclude_pattern=None,
2308
"""Run the whole test suite under the enhanced runner"""
2309
# XXX: Very ugly way to do this...
2310
# Disable warning about old formats because we don't want it to disturb
2311
# any blackbox tests.
2312
from bzrlib import repository
2313
repository._deprecation_warning_done = True
2315
global default_transport
2316
if transport is None:
2317
transport = default_transport
2318
old_transport = default_transport
2319
default_transport = transport
2321
if test_suite_factory is None:
2322
suite = test_suite()
2324
suite = test_suite_factory()
2325
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2326
stop_on_failure=stop_on_failure,
2327
transport=transport,
2328
lsprof_timed=lsprof_timed,
2329
bench_history=bench_history,
2330
matching_tests_first=matching_tests_first,
2331
list_only=list_only,
2332
random_seed=random_seed,
2333
exclude_pattern=exclude_pattern,
2336
default_transport = old_transport
2340
"""Build and return TestSuite for the whole of bzrlib.
2342
This function can be replaced if you need to change the default test
2343
suite on a global basis, but it is not encouraged.
2346
'bzrlib.util.tests.test_bencode',
2347
'bzrlib.tests.test__dirstate_helpers',
2348
'bzrlib.tests.test_ancestry',
2349
'bzrlib.tests.test_annotate',
2350
'bzrlib.tests.test_api',
2351
'bzrlib.tests.test_atomicfile',
2352
'bzrlib.tests.test_bad_files',
2353
'bzrlib.tests.test_bisect_multi',
2354
'bzrlib.tests.test_branch',
2355
'bzrlib.tests.test_branchbuilder',
2356
'bzrlib.tests.test_bugtracker',
2357
'bzrlib.tests.test_bundle',
2358
'bzrlib.tests.test_bzrdir',
2359
'bzrlib.tests.test_cache_utf8',
2360
'bzrlib.tests.test_commands',
2361
'bzrlib.tests.test_commit',
2362
'bzrlib.tests.test_commit_merge',
2363
'bzrlib.tests.test_config',
2364
'bzrlib.tests.test_conflicts',
2365
'bzrlib.tests.test_counted_lock',
2366
'bzrlib.tests.test_decorators',
2367
'bzrlib.tests.test_delta',
2368
'bzrlib.tests.test_deprecated_graph',
2369
'bzrlib.tests.test_diff',
2370
'bzrlib.tests.test_dirstate',
2371
'bzrlib.tests.test_email_message',
2372
'bzrlib.tests.test_errors',
2373
'bzrlib.tests.test_escaped_store',
2374
'bzrlib.tests.test_extract',
2375
'bzrlib.tests.test_fetch',
2376
'bzrlib.tests.test_ftp_transport',
2377
'bzrlib.tests.test_generate_docs',
2378
'bzrlib.tests.test_generate_ids',
2379
'bzrlib.tests.test_globbing',
2380
'bzrlib.tests.test_gpg',
2381
'bzrlib.tests.test_graph',
2382
'bzrlib.tests.test_hashcache',
2383
'bzrlib.tests.test_help',
2384
'bzrlib.tests.test_hooks',
2385
'bzrlib.tests.test_http',
2386
'bzrlib.tests.test_http_response',
2387
'bzrlib.tests.test_https_ca_bundle',
2388
'bzrlib.tests.test_identitymap',
2389
'bzrlib.tests.test_ignores',
2390
'bzrlib.tests.test_index',
2391
'bzrlib.tests.test_info',
2392
'bzrlib.tests.test_inv',
2393
'bzrlib.tests.test_knit',
2394
'bzrlib.tests.test_lazy_import',
2395
'bzrlib.tests.test_lazy_regex',
2396
'bzrlib.tests.test_lockdir',
2397
'bzrlib.tests.test_lockable_files',
2398
'bzrlib.tests.test_log',
2399
'bzrlib.tests.test_lsprof',
2400
'bzrlib.tests.test_mail_client',
2401
'bzrlib.tests.test_memorytree',
2402
'bzrlib.tests.test_merge',
2403
'bzrlib.tests.test_merge3',
2404
'bzrlib.tests.test_merge_core',
2405
'bzrlib.tests.test_merge_directive',
2406
'bzrlib.tests.test_missing',
2407
'bzrlib.tests.test_msgeditor',
2408
'bzrlib.tests.test_multiparent',
2409
'bzrlib.tests.test_nonascii',
2410
'bzrlib.tests.test_options',
2411
'bzrlib.tests.test_osutils',
2412
'bzrlib.tests.test_osutils_encodings',
2413
'bzrlib.tests.test_pack',
2414
'bzrlib.tests.test_patch',
2415
'bzrlib.tests.test_patches',
2416
'bzrlib.tests.test_permissions',
2417
'bzrlib.tests.test_plugins',
2418
'bzrlib.tests.test_progress',
2419
'bzrlib.tests.test_reconfigure',
2420
'bzrlib.tests.test_reconcile',
2421
'bzrlib.tests.test_registry',
2422
'bzrlib.tests.test_remote',
2423
'bzrlib.tests.test_repository',
2424
'bzrlib.tests.test_revert',
2425
'bzrlib.tests.test_revision',
2426
'bzrlib.tests.test_revisionnamespaces',
2427
'bzrlib.tests.test_revisiontree',
2428
'bzrlib.tests.test_rio',
2429
'bzrlib.tests.test_sampler',
2430
'bzrlib.tests.test_selftest',
2431
'bzrlib.tests.test_setup',
2432
'bzrlib.tests.test_sftp_transport',
2433
'bzrlib.tests.test_smart',
2434
'bzrlib.tests.test_smart_add',
2435
'bzrlib.tests.test_smart_transport',
2436
'bzrlib.tests.test_smtp_connection',
2437
'bzrlib.tests.test_source',
2438
'bzrlib.tests.test_ssh_transport',
2439
'bzrlib.tests.test_status',
2440
'bzrlib.tests.test_store',
2441
'bzrlib.tests.test_strace',
2442
'bzrlib.tests.test_subsume',
2443
'bzrlib.tests.test_symbol_versioning',
2444
'bzrlib.tests.test_tag',
2445
'bzrlib.tests.test_testament',
2446
'bzrlib.tests.test_textfile',
2447
'bzrlib.tests.test_textmerge',
2448
'bzrlib.tests.test_timestamp',
2449
'bzrlib.tests.test_trace',
2450
'bzrlib.tests.test_transactions',
2451
'bzrlib.tests.test_transform',
2452
'bzrlib.tests.test_transport',
2453
'bzrlib.tests.test_tree',
2454
'bzrlib.tests.test_treebuilder',
2455
'bzrlib.tests.test_tsort',
2456
'bzrlib.tests.test_tuned_gzip',
2457
'bzrlib.tests.test_ui',
2458
'bzrlib.tests.test_upgrade',
2459
'bzrlib.tests.test_urlutils',
2460
'bzrlib.tests.test_versionedfile',
2461
'bzrlib.tests.test_version',
2462
'bzrlib.tests.test_version_info',
2463
'bzrlib.tests.test_weave',
2464
'bzrlib.tests.test_whitebox',
2465
'bzrlib.tests.test_win32utils',
2466
'bzrlib.tests.test_workingtree',
2467
'bzrlib.tests.test_workingtree_4',
2468
'bzrlib.tests.test_wsgi',
2469
'bzrlib.tests.test_xml',
2471
test_transport_implementations = [
2472
'bzrlib.tests.test_transport_implementations',
2473
'bzrlib.tests.test_read_bundle',
2475
suite = TestUtil.TestSuite()
2476
loader = TestUtil.TestLoader()
2477
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2478
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2479
adapter = TransportTestProviderAdapter()
2480
adapt_modules(test_transport_implementations, adapter, loader, suite)
2481
for package in packages_to_test():
2482
suite.addTest(package.test_suite())
2483
for m in MODULES_TO_TEST:
2484
suite.addTest(loader.loadTestsFromModule(m))
2485
for m in MODULES_TO_DOCTEST:
2487
suite.addTest(doctest.DocTestSuite(m))
2488
except ValueError, e:
2489
print '**failed to get doctest for: %s\n%s' %(m,e)
2491
default_encoding = sys.getdefaultencoding()
2492
for name, plugin in bzrlib.plugin.plugins().items():
2494
plugin_suite = plugin.test_suite()
2495
except ImportError, e:
2496
bzrlib.trace.warning(
2497
'Unable to test plugin "%s": %s', name, e)
2499
if plugin_suite is not None:
2500
suite.addTest(plugin_suite)
2501
if default_encoding != sys.getdefaultencoding():
2502
bzrlib.trace.warning(
2503
'Plugin "%s" tried to reset default encoding to: %s', name,
2504
sys.getdefaultencoding())
2506
sys.setdefaultencoding(default_encoding)
2510
def multiply_tests_from_modules(module_name_list, scenario_iter):
2511
"""Adapt all tests in some given modules to given scenarios.
2513
This is the recommended public interface for test parameterization.
2514
Typically the test_suite() method for a per-implementation test
2515
suite will call multiply_tests_from_modules and return the
2518
:param module_name_list: List of fully-qualified names of test
2520
:param scenario_iter: Iterable of pairs of (scenario_name,
2521
scenario_param_dict).
2523
This returns a new TestSuite containing the cross product of
2524
all the tests in all the modules, each repeated for each scenario.
2525
Each test is adapted by adding the scenario name at the end
2526
of its name, and updating the test object's __dict__ with the
2527
scenario_param_dict.
2529
>>> r = multiply_tests_from_modules(
2530
... ['bzrlib.tests.test_sampler'],
2531
... [('one', dict(param=1)),
2532
... ('two', dict(param=2))])
2533
>>> tests = list(iter_suite_tests(r))
2537
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2543
loader = TestLoader()
2545
adapter = TestScenarioApplier()
2546
adapter.scenarios = list(scenario_iter)
2547
adapt_modules(module_name_list, adapter, loader, suite)
2551
def multiply_scenarios(scenarios_left, scenarios_right):
2552
"""Multiply two sets of scenarios.
2554
:returns: the cartesian product of the two sets of scenarios, that is
2555
a scenario for every possible combination of a left scenario and a
2559
('%s,%s' % (left_name, right_name),
2560
dict(left_dict.items() + right_dict.items()))
2561
for left_name, left_dict in scenarios_left
2562
for right_name, right_dict in scenarios_right]
2566
def adapt_modules(mods_list, adapter, loader, suite):
2567
"""Adapt the modules in mods_list using adapter and add to suite."""
2568
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2569
suite.addTests(adapter.adapt(test))
2572
def _rmtree_temp_dir(dirname):
2573
# If LANG=C we probably have created some bogus paths
2574
# which rmtree(unicode) will fail to delete
2575
# so make sure we are using rmtree(str) to delete everything
2576
# except on win32, where rmtree(str) will fail
2577
# since it doesn't have the property of byte-stream paths
2578
# (they are either ascii or mbcs)
2579
if sys.platform == 'win32':
2580
# make sure we are using the unicode win32 api
2581
dirname = unicode(dirname)
2583
dirname = dirname.encode(sys.getfilesystemencoding())
2585
osutils.rmtree(dirname)
2587
if sys.platform == 'win32' and e.errno == errno.EACCES:
2588
sys.stderr.write(('Permission denied: '
2589
'unable to remove testing dir '
2590
'%\n' % os.path.basename(dirname)))
2595
class Feature(object):
2596
"""An operating system Feature."""
2599
self._available = None
2601
def available(self):
2602
"""Is the feature available?
2604
:return: True if the feature is available.
2606
if self._available is None:
2607
self._available = self._probe()
2608
return self._available
2611
"""Implement this method in concrete features.
2613
:return: True if the feature is available.
2615
raise NotImplementedError
2618
if getattr(self, 'feature_name', None):
2619
return self.feature_name()
2620
return self.__class__.__name__
2623
class _SymlinkFeature(Feature):
2626
return osutils.has_symlinks()
2628
def feature_name(self):
2631
SymlinkFeature = _SymlinkFeature()
2634
class TestScenarioApplier(object):
2635
"""A tool to apply scenarios to tests."""
2637
def adapt(self, test):
2638
"""Return a TestSuite containing a copy of test for each scenario."""
2639
result = unittest.TestSuite()
2640
for scenario in self.scenarios:
2641
result.addTest(self.adapt_test_to_scenario(test, scenario))
2644
def adapt_test_to_scenario(self, test, scenario):
2645
"""Copy test and apply scenario to it.
2647
:param test: A test to adapt.
2648
:param scenario: A tuple describing the scenarion.
2649
The first element of the tuple is the new test id.
2650
The second element is a dict containing attributes to set on the
2652
:return: The adapted test.
2654
from copy import deepcopy
2655
new_test = deepcopy(test)
2656
for name, value in scenario[1].items():
2657
setattr(new_test, name, value)
2658
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2659
new_test.id = lambda: new_id
2663
def probe_unicode_in_user_encoding():
2664
"""Try to encode several unicode strings to use in unicode-aware tests.
2665
Return first successfull match.
2667
:return: (unicode value, encoded plain string value) or (None, None)
2669
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
2670
for uni_val in possible_vals:
2672
str_val = uni_val.encode(bzrlib.user_encoding)
2673
except UnicodeEncodeError:
2674
# Try a different character
2677
return uni_val, str_val
2681
def probe_bad_non_ascii(encoding):
2682
"""Try to find [bad] character with code [128..255]
2683
that cannot be decoded to unicode in some encoding.
2684
Return None if all non-ascii characters is valid
2687
for i in xrange(128, 256):
2690
char.decode(encoding)
2691
except UnicodeDecodeError:
added
removed
bzrlib/tests/__init__.py
