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_deprecation_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_deprecation_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 callCatchWarnings(self, fn, *args, **kw):
1094
"""Call a callable that raises python warnings.
1096
The caller's responsible for examining the returned warnings.
1098
If the callable raises an exception, the exception is not
1099
caught and propagates up to the caller. In that case, the list
1100
of warnings is not available.
1102
:returns: ([warning_object, ...], fn_result)
1104
# XXX: This is not perfect, because it completely overrides the
1105
# warnings filters, and some code may depend on suppressing particular
1106
# warnings. It's the easiest way to insulate ourselves from -Werror,
1107
# though. -- Andrew, 20071062
1109
def _catcher(message, category, filename, lineno, file=None):
1110
# despite the name, 'message' is normally(?) a Warning subclass
1112
wlist.append(message)
1113
saved_showwarning = warnings.showwarning
1114
saved_filters = warnings.filters
1116
warnings.showwarning = _catcher
1117
warnings.filters = []
1118
result = fn(*args, **kw)
1120
warnings.showwarning = saved_showwarning
1121
warnings.filters = saved_filters
1122
return wlist, result
1124
def callDeprecated(self, expected, callable, *args, **kwargs):
1125
"""Assert that a callable is deprecated in a particular way.
1127
This is a very precise test for unusual requirements. The
1128
applyDeprecated helper function is probably more suited for most tests
1129
as it allows you to simply specify the deprecation format being used
1130
and will ensure that that is issued for the function being called.
1132
Note that this only captures warnings raised by symbol_versioning.warn,
1133
not other callers that go direct to the warning module. To catch
1134
general warnings, use callCatchWarnings.
1136
:param expected: a list of the deprecation warnings expected, in order
1137
:param callable: The callable to call
1138
:param args: The positional arguments for the callable
1139
:param kwargs: The keyword arguments for the callable
1141
call_warnings, result = self._capture_deprecation_warnings(callable,
1143
self.assertEqual(expected, call_warnings)
1146
def _startLogFile(self):
1147
"""Send bzr and test log messages to a temporary file.
1149
The file is removed as the test is torn down.
1151
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1152
self._log_file = os.fdopen(fileno, 'w+')
1153
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1154
self._log_file_name = name
1155
self.addCleanup(self._finishLogFile)
1157
def _finishLogFile(self):
1158
"""Finished with the log file.
1160
Close the file and delete it, unless setKeepLogfile was called.
1162
if self._log_file is None:
1164
bzrlib.trace.disable_test_log(self._log_nonce)
1165
self._log_file.close()
1166
self._log_file = None
1167
if not self._keep_log_file:
1168
os.remove(self._log_file_name)
1169
self._log_file_name = None
1171
def setKeepLogfile(self):
1172
"""Make the logfile not be deleted when _finishLogFile is called."""
1173
self._keep_log_file = True
1175
def addCleanup(self, callable):
1176
"""Arrange to run a callable when this case is torn down.
1178
Callables are run in the reverse of the order they are registered,
1179
ie last-in first-out.
1181
if callable in self._cleanups:
1182
raise ValueError("cleanup function %r already registered on %s"
1184
self._cleanups.append(callable)
1186
def _cleanEnvironment(self):
1188
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1189
'HOME': os.getcwd(),
1190
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1191
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1193
'BZREMAIL': None, # may still be present in the environment
1195
'BZR_PROGRESS_BAR': None,
1197
'SSH_AUTH_SOCK': None,
1201
'https_proxy': None,
1202
'HTTPS_PROXY': None,
1207
# Nobody cares about these ones AFAIK. So far at
1208
# least. If you do (care), please update this comment
1212
'BZR_REMOTE_PATH': None,
1215
self.addCleanup(self._restoreEnvironment)
1216
for name, value in new_env.iteritems():
1217
self._captureVar(name, value)
1219
def _captureVar(self, name, newvalue):
1220
"""Set an environment variable, and reset it when finished."""
1221
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1223
def _restore_debug_flags(self):
1224
debug.debug_flags.clear()
1225
debug.debug_flags.update(self._preserved_debug_flags)
1227
def _restoreEnvironment(self):
1228
for name, value in self.__old_env.iteritems():
1229
osutils.set_or_unset_env(name, value)
1231
def _restoreHooks(self):
1232
for klass, hooks in self._preserved_hooks.items():
1233
setattr(klass, 'hooks', hooks)
1235
def knownFailure(self, reason):
1236
"""This test has failed for some known reason."""
1237
raise KnownFailure(reason)
1239
def run(self, result=None):
1240
if result is None: result = self.defaultTestResult()
1241
for feature in getattr(self, '_test_needs_features', []):
1242
if not feature.available():
1243
result.startTest(self)
1244
if getattr(result, 'addNotSupported', None):
1245
result.addNotSupported(self, feature)
1247
result.addSuccess(self)
1248
result.stopTest(self)
1250
return unittest.TestCase.run(self, result)
1254
unittest.TestCase.tearDown(self)
1256
def time(self, callable, *args, **kwargs):
1257
"""Run callable and accrue the time it takes to the benchmark time.
1259
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1260
this will cause lsprofile statistics to be gathered and stored in
1263
if self._benchtime is None:
1267
if not self._gather_lsprof_in_benchmarks:
1268
return callable(*args, **kwargs)
1270
# record this benchmark
1271
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1273
self._benchcalls.append(((callable, args, kwargs), stats))
1276
self._benchtime += time.time() - start
1278
def _runCleanups(self):
1279
"""Run registered cleanup functions.
1281
This should only be called from TestCase.tearDown.
1283
# TODO: Perhaps this should keep running cleanups even if
1284
# one of them fails?
1286
# Actually pop the cleanups from the list so tearDown running
1287
# twice is safe (this happens for skipped tests).
1288
while self._cleanups:
1289
self._cleanups.pop()()
1291
def log(self, *args):
1294
def _get_log(self, keep_log_file=False):
1295
"""Get the log from bzrlib.trace calls from this test.
1297
:param keep_log_file: When True, if the log is still a file on disk
1298
leave it as a file on disk. When False, if the log is still a file
1299
on disk, the log file is deleted and the log preserved as
1301
:return: A string containing the log.
1303
# flush the log file, to get all content
1305
bzrlib.trace._trace_file.flush()
1306
if self._log_contents:
1307
return self._log_contents
1308
if self._log_file_name is not None:
1309
logfile = open(self._log_file_name)
1311
log_contents = logfile.read()
1314
if not keep_log_file:
1315
self._log_contents = log_contents
1317
os.remove(self._log_file_name)
1319
if sys.platform == 'win32' and e.errno == errno.EACCES:
1320
sys.stderr.write(('Unable to delete log file '
1321
' %r\n' % self._log_file_name))
1326
return "DELETED log file to reduce memory footprint"
1328
def requireFeature(self, feature):
1329
"""This test requires a specific feature is available.
1331
:raises UnavailableFeature: When feature is not available.
1333
if not feature.available():
1334
raise UnavailableFeature(feature)
1336
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1338
"""Run bazaar command line, splitting up a string command line."""
1339
if isinstance(args, basestring):
1340
# shlex don't understand unicode strings,
1341
# so args should be plain string (bialix 20070906)
1342
args = list(shlex.split(str(args)))
1343
return self._run_bzr_core(args, retcode=retcode,
1344
encoding=encoding, stdin=stdin, working_dir=working_dir,
1347
def _run_bzr_core(self, args, retcode, encoding, stdin,
1349
if encoding is None:
1350
encoding = bzrlib.user_encoding
1351
stdout = StringIOWrapper()
1352
stderr = StringIOWrapper()
1353
stdout.encoding = encoding
1354
stderr.encoding = encoding
1356
self.log('run bzr: %r', args)
1357
# FIXME: don't call into logging here
1358
handler = logging.StreamHandler(stderr)
1359
handler.setLevel(logging.INFO)
1360
logger = logging.getLogger('')
1361
logger.addHandler(handler)
1362
old_ui_factory = ui.ui_factory
1363
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1366
if working_dir is not None:
1367
cwd = osutils.getcwd()
1368
os.chdir(working_dir)
1371
result = self.apply_redirected(ui.ui_factory.stdin,
1373
bzrlib.commands.run_bzr_catch_user_errors,
1376
logger.removeHandler(handler)
1377
ui.ui_factory = old_ui_factory
1381
out = stdout.getvalue()
1382
err = stderr.getvalue()
1384
self.log('output:\n%r', out)
1386
self.log('errors:\n%r', err)
1387
if retcode is not None:
1388
self.assertEquals(retcode, result,
1389
message='Unexpected return code')
1392
def run_bzr(self, args, retcode=0, encoding=None, stdin=None,
1393
working_dir=None, error_regexes=[], output_encoding=None):
1394
"""Invoke bzr, as if it were run from the command line.
1396
The argument list should not include the bzr program name - the
1397
first argument is normally the bzr command. Arguments may be
1398
passed in three ways:
1400
1- A list of strings, eg ["commit", "a"]. This is recommended
1401
when the command contains whitespace or metacharacters, or
1402
is built up at run time.
1404
2- A single string, eg "add a". This is the most convenient
1405
for hardcoded commands.
1407
This runs bzr through the interface that catches and reports
1408
errors, and with logging set to something approximating the
1409
default, so that error reporting can be checked.
1411
This should be the main method for tests that want to exercise the
1412
overall behavior of the bzr application (rather than a unit test
1413
or a functional test of the library.)
1415
This sends the stdout/stderr results into the test's log,
1416
where it may be useful for debugging. See also run_captured.
1418
:keyword stdin: A string to be used as stdin for the command.
1419
:keyword retcode: The status code the command should return;
1421
:keyword working_dir: The directory to run the command in
1422
:keyword error_regexes: A list of expected error messages. If
1423
specified they must be seen in the error output of the command.
1425
out, err = self._run_bzr_autosplit(
1430
working_dir=working_dir,
1432
for regex in error_regexes:
1433
self.assertContainsRe(err, regex)
1436
def run_bzr_error(self, error_regexes, *args, **kwargs):
1437
"""Run bzr, and check that stderr contains the supplied regexes
1439
:param error_regexes: Sequence of regular expressions which
1440
must each be found in the error output. The relative ordering
1442
:param args: command-line arguments for bzr
1443
:param kwargs: Keyword arguments which are interpreted by run_bzr
1444
This function changes the default value of retcode to be 3,
1445
since in most cases this is run when you expect bzr to fail.
1447
:return: (out, err) The actual output of running the command (in case
1448
you want to do more inspection)
1452
# Make sure that commit is failing because there is nothing to do
1453
self.run_bzr_error(['no changes to commit'],
1454
['commit', '-m', 'my commit comment'])
1455
# Make sure --strict is handling an unknown file, rather than
1456
# giving us the 'nothing to do' error
1457
self.build_tree(['unknown'])
1458
self.run_bzr_error(['Commit refused because there are unknown files'],
1459
['commit', --strict', '-m', 'my commit comment'])
1461
kwargs.setdefault('retcode', 3)
1462
kwargs['error_regexes'] = error_regexes
1463
out, err = self.run_bzr(*args, **kwargs)
1466
def run_bzr_subprocess(self, *args, **kwargs):
1467
"""Run bzr in a subprocess for testing.
1469
This starts a new Python interpreter and runs bzr in there.
1470
This should only be used for tests that have a justifiable need for
1471
this isolation: e.g. they are testing startup time, or signal
1472
handling, or early startup code, etc. Subprocess code can't be
1473
profiled or debugged so easily.
1475
:keyword retcode: The status code that is expected. Defaults to 0. If
1476
None is supplied, the status code is not checked.
1477
:keyword env_changes: A dictionary which lists changes to environment
1478
variables. A value of None will unset the env variable.
1479
The values must be strings. The change will only occur in the
1480
child, so you don't need to fix the environment after running.
1481
:keyword universal_newlines: Convert CRLF => LF
1482
:keyword allow_plugins: By default the subprocess is run with
1483
--no-plugins to ensure test reproducibility. Also, it is possible
1484
for system-wide plugins to create unexpected output on stderr,
1485
which can cause unnecessary test failures.
1487
env_changes = kwargs.get('env_changes', {})
1488
working_dir = kwargs.get('working_dir', None)
1489
allow_plugins = kwargs.get('allow_plugins', False)
1491
if isinstance(args[0], list):
1493
elif isinstance(args[0], basestring):
1494
args = list(shlex.split(args[0]))
1496
symbol_versioning.warn(zero_ninetyone %
1497
"passing varargs to run_bzr_subprocess",
1498
DeprecationWarning, stacklevel=3)
1499
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1500
working_dir=working_dir,
1501
allow_plugins=allow_plugins)
1502
# We distinguish between retcode=None and retcode not passed.
1503
supplied_retcode = kwargs.get('retcode', 0)
1504
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1505
universal_newlines=kwargs.get('universal_newlines', False),
1508
def start_bzr_subprocess(self, process_args, env_changes=None,
1509
skip_if_plan_to_signal=False,
1511
allow_plugins=False):
1512
"""Start bzr in a subprocess for testing.
1514
This starts a new Python interpreter and runs bzr in there.
1515
This should only be used for tests that have a justifiable need for
1516
this isolation: e.g. they are testing startup time, or signal
1517
handling, or early startup code, etc. Subprocess code can't be
1518
profiled or debugged so easily.
1520
:param process_args: a list of arguments to pass to the bzr executable,
1521
for example ``['--version']``.
1522
:param env_changes: A dictionary which lists changes to environment
1523
variables. A value of None will unset the env variable.
1524
The values must be strings. The change will only occur in the
1525
child, so you don't need to fix the environment after running.
1526
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1528
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1530
:returns: Popen object for the started process.
1532
if skip_if_plan_to_signal:
1533
if not getattr(os, 'kill', None):
1534
raise TestSkipped("os.kill not available.")
1536
if env_changes is None:
1540
def cleanup_environment():
1541
for env_var, value in env_changes.iteritems():
1542
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1544
def restore_environment():
1545
for env_var, value in old_env.iteritems():
1546
osutils.set_or_unset_env(env_var, value)
1548
bzr_path = self.get_bzr_path()
1551
if working_dir is not None:
1552
cwd = osutils.getcwd()
1553
os.chdir(working_dir)
1556
# win32 subprocess doesn't support preexec_fn
1557
# so we will avoid using it on all platforms, just to
1558
# make sure the code path is used, and we don't break on win32
1559
cleanup_environment()
1560
command = [sys.executable, bzr_path]
1561
if not allow_plugins:
1562
command.append('--no-plugins')
1563
command.extend(process_args)
1564
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1566
restore_environment()
1572
def _popen(self, *args, **kwargs):
1573
"""Place a call to Popen.
1575
Allows tests to override this method to intercept the calls made to
1576
Popen for introspection.
1578
return Popen(*args, **kwargs)
1580
def get_bzr_path(self):
1581
"""Return the path of the 'bzr' executable for this test suite."""
1582
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1583
if not os.path.isfile(bzr_path):
1584
# We are probably installed. Assume sys.argv is the right file
1585
bzr_path = sys.argv[0]
1588
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1589
universal_newlines=False, process_args=None):
1590
"""Finish the execution of process.
1592
:param process: the Popen object returned from start_bzr_subprocess.
1593
:param retcode: The status code that is expected. Defaults to 0. If
1594
None is supplied, the status code is not checked.
1595
:param send_signal: an optional signal to send to the process.
1596
:param universal_newlines: Convert CRLF => LF
1597
:returns: (stdout, stderr)
1599
if send_signal is not None:
1600
os.kill(process.pid, send_signal)
1601
out, err = process.communicate()
1603
if universal_newlines:
1604
out = out.replace('\r\n', '\n')
1605
err = err.replace('\r\n', '\n')
1607
if retcode is not None and retcode != process.returncode:
1608
if process_args is None:
1609
process_args = "(unknown args)"
1610
mutter('Output of bzr %s:\n%s', process_args, out)
1611
mutter('Error for bzr %s:\n%s', process_args, err)
1612
self.fail('Command bzr %s failed with retcode %s != %s'
1613
% (process_args, retcode, process.returncode))
1616
def check_inventory_shape(self, inv, shape):
1617
"""Compare an inventory to a list of expected names.
1619
Fail if they are not precisely equal.
1622
shape = list(shape) # copy
1623
for path, ie in inv.entries():
1624
name = path.replace('\\', '/')
1625
if ie.kind == 'directory':
1632
self.fail("expected paths not found in inventory: %r" % shape)
1634
self.fail("unexpected paths found in inventory: %r" % extras)
1636
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1637
a_callable=None, *args, **kwargs):
1638
"""Call callable with redirected std io pipes.
1640
Returns the return code."""
1641
if not callable(a_callable):
1642
raise ValueError("a_callable must be callable.")
1644
stdin = StringIO("")
1646
if getattr(self, "_log_file", None) is not None:
1647
stdout = self._log_file
1651
if getattr(self, "_log_file", None is not None):
1652
stderr = self._log_file
1655
real_stdin = sys.stdin
1656
real_stdout = sys.stdout
1657
real_stderr = sys.stderr
1662
return a_callable(*args, **kwargs)
1664
sys.stdout = real_stdout
1665
sys.stderr = real_stderr
1666
sys.stdin = real_stdin
1668
def reduceLockdirTimeout(self):
1669
"""Reduce the default lock timeout for the duration of the test, so that
1670
if LockContention occurs during a test, it does so quickly.
1672
Tests that expect to provoke LockContention errors should call this.
1674
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1676
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1677
self.addCleanup(resetTimeout)
1678
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1680
def make_utf8_encoded_stringio(self, encoding_type=None):
1681
"""Return a StringIOWrapper instance, that will encode Unicode
1684
if encoding_type is None:
1685
encoding_type = 'strict'
1687
output_encoding = 'utf-8'
1688
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1689
sio.encoding = output_encoding
1693
class TestCaseWithMemoryTransport(TestCase):
1694
"""Common test class for tests that do not need disk resources.
1696
Tests that need disk resources should derive from TestCaseWithTransport.
1698
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1700
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1701
a directory which does not exist. This serves to help ensure test isolation
1702
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1703
must exist. However, TestCaseWithMemoryTransport does not offer local
1704
file defaults for the transport in tests, nor does it obey the command line
1705
override, so tests that accidentally write to the common directory should
1708
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1709
a .bzr directory that stops us ascending higher into the filesystem.
1715
def __init__(self, methodName='runTest'):
1716
# allow test parameterisation after test construction and before test
1717
# execution. Variables that the parameteriser sets need to be
1718
# ones that are not set by setUp, or setUp will trash them.
1719
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1720
self.vfs_transport_factory = default_transport
1721
self.transport_server = None
1722
self.transport_readonly_server = None
1723
self.__vfs_server = None
1725
def get_transport(self, relpath=None):
1726
"""Return a writeable transport.
1728
This transport is for the test scratch space relative to
1731
:param relpath: a path relative to the base url.
1733
t = get_transport(self.get_url(relpath))
1734
self.assertFalse(t.is_readonly())
1737
def get_readonly_transport(self, relpath=None):
1738
"""Return a readonly transport for the test scratch space
1740
This can be used to test that operations which should only need
1741
readonly access in fact do not try to write.
1743
:param relpath: a path relative to the base url.
1745
t = get_transport(self.get_readonly_url(relpath))
1746
self.assertTrue(t.is_readonly())
1749
def create_transport_readonly_server(self):
1750
"""Create a transport server from class defined at init.
1752
This is mostly a hook for daughter classes.
1754
return self.transport_readonly_server()
1756
def get_readonly_server(self):
1757
"""Get the server instance for the readonly transport
1759
This is useful for some tests with specific servers to do diagnostics.
1761
if self.__readonly_server is None:
1762
if self.transport_readonly_server is None:
1763
# readonly decorator requested
1764
# bring up the server
1765
self.__readonly_server = ReadonlyServer()
1766
self.__readonly_server.setUp(self.get_vfs_only_server())
1768
self.__readonly_server = self.create_transport_readonly_server()
1769
self.__readonly_server.setUp(self.get_vfs_only_server())
1770
self.addCleanup(self.__readonly_server.tearDown)
1771
return self.__readonly_server
1773
def get_readonly_url(self, relpath=None):
1774
"""Get a URL for the readonly transport.
1776
This will either be backed by '.' or a decorator to the transport
1777
used by self.get_url()
1778
relpath provides for clients to get a path relative to the base url.
1779
These should only be downwards relative, not upwards.
1781
base = self.get_readonly_server().get_url()
1782
return self._adjust_url(base, relpath)
1784
def get_vfs_only_server(self):
1785
"""Get the vfs only read/write server instance.
1787
This is useful for some tests with specific servers that need
1790
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1791
is no means to override it.
1793
if self.__vfs_server is None:
1794
self.__vfs_server = MemoryServer()
1795
self.__vfs_server.setUp()
1796
self.addCleanup(self.__vfs_server.tearDown)
1797
return self.__vfs_server
1799
def get_server(self):
1800
"""Get the read/write server instance.
1802
This is useful for some tests with specific servers that need
1805
This is built from the self.transport_server factory. If that is None,
1806
then the self.get_vfs_server is returned.
1808
if self.__server is None:
1809
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1810
return self.get_vfs_only_server()
1812
# bring up a decorated means of access to the vfs only server.
1813
self.__server = self.transport_server()
1815
self.__server.setUp(self.get_vfs_only_server())
1816
except TypeError, e:
1817
# This should never happen; the try:Except here is to assist
1818
# developers having to update code rather than seeing an
1819
# uninformative TypeError.
1820
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1821
self.addCleanup(self.__server.tearDown)
1822
return self.__server
1824
def _adjust_url(self, base, relpath):
1825
"""Get a URL (or maybe a path) for the readwrite transport.
1827
This will either be backed by '.' or to an equivalent non-file based
1829
relpath provides for clients to get a path relative to the base url.
1830
These should only be downwards relative, not upwards.
1832
if relpath is not None and relpath != '.':
1833
if not base.endswith('/'):
1835
# XXX: Really base should be a url; we did after all call
1836
# get_url()! But sometimes it's just a path (from
1837
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1838
# to a non-escaped local path.
1839
if base.startswith('./') or base.startswith('/'):
1842
base += urlutils.escape(relpath)
1845
def get_url(self, relpath=None):
1846
"""Get a URL (or maybe a path) for the readwrite transport.
1848
This will either be backed by '.' or to an equivalent non-file based
1850
relpath provides for clients to get a path relative to the base url.
1851
These should only be downwards relative, not upwards.
1853
base = self.get_server().get_url()
1854
return self._adjust_url(base, relpath)
1856
def get_vfs_only_url(self, relpath=None):
1857
"""Get a URL (or maybe a path for the plain old vfs transport.
1859
This will never be a smart protocol. It always has all the
1860
capabilities of the local filesystem, but it might actually be a
1861
MemoryTransport or some other similar virtual filesystem.
1863
This is the backing transport (if any) of the server returned by
1864
get_url and get_readonly_url.
1866
:param relpath: provides for clients to get a path relative to the base
1867
url. These should only be downwards relative, not upwards.
1870
base = self.get_vfs_only_server().get_url()
1871
return self._adjust_url(base, relpath)
1873
def _create_safety_net(self):
1874
"""Make a fake bzr directory.
1876
This prevents any tests propagating up onto the TEST_ROOT directory's
1879
root = TestCaseWithMemoryTransport.TEST_ROOT
1880
bzrdir.BzrDir.create_standalone_workingtree(root)
1882
def _check_safety_net(self):
1883
"""Check that the safety .bzr directory have not been touched.
1885
_make_test_root have created a .bzr directory to prevent tests from
1886
propagating. This method ensures than a test did not leaked.
1888
root = TestCaseWithMemoryTransport.TEST_ROOT
1889
wt = workingtree.WorkingTree.open(root)
1890
last_rev = wt.last_revision()
1891
if last_rev != 'null:':
1892
# The current test have modified the /bzr directory, we need to
1893
# recreate a new one or all the followng tests will fail.
1894
# If you need to inspect its content uncomment the following line
1895
# import pdb; pdb.set_trace()
1896
_rmtree_temp_dir(root + '/.bzr')
1897
self._create_safety_net()
1898
raise AssertionError('%s/.bzr should not be modified' % root)
1900
def _make_test_root(self):
1901
if TestCaseWithMemoryTransport.TEST_ROOT is None:
1902
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1903
TestCaseWithMemoryTransport.TEST_ROOT = root
1905
self._create_safety_net()
1907
# The same directory is used by all tests, and we're not
1908
# specifically told when all tests are finished. This will do.
1909
atexit.register(_rmtree_temp_dir, root)
1911
self.addCleanup(self._check_safety_net)
1913
def makeAndChdirToTestDir(self):
1914
"""Create a temporary directories for this one test.
1916
This must set self.test_home_dir and self.test_dir and chdir to
1919
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1921
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1922
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1923
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1925
def make_branch(self, relpath, format=None):
1926
"""Create a branch on the transport at relpath."""
1927
repo = self.make_repository(relpath, format=format)
1928
return repo.bzrdir.create_branch()
1930
def make_bzrdir(self, relpath, format=None):
1932
# might be a relative or absolute path
1933
maybe_a_url = self.get_url(relpath)
1934
segments = maybe_a_url.rsplit('/', 1)
1935
t = get_transport(maybe_a_url)
1936
if len(segments) > 1 and segments[-1] not in ('', '.'):
1940
if isinstance(format, basestring):
1941
format = bzrdir.format_registry.make_bzrdir(format)
1942
return format.initialize_on_transport(t)
1943
except errors.UninitializableFormat:
1944
raise TestSkipped("Format %s is not initializable." % format)
1946
def make_repository(self, relpath, shared=False, format=None):
1947
"""Create a repository on our default transport at relpath.
1949
Note that relpath must be a relative path, not a full url.
1951
# FIXME: If you create a remoterepository this returns the underlying
1952
# real format, which is incorrect. Actually we should make sure that
1953
# RemoteBzrDir returns a RemoteRepository.
1954
# maybe mbp 20070410
1955
made_control = self.make_bzrdir(relpath, format=format)
1956
return made_control.create_repository(shared=shared)
1958
def make_branch_and_memory_tree(self, relpath, format=None):
1959
"""Create a branch on the default transport and a MemoryTree for it."""
1960
b = self.make_branch(relpath, format=format)
1961
return memorytree.MemoryTree.create_on_branch(b)
1963
def overrideEnvironmentForTesting(self):
1964
os.environ['HOME'] = self.test_home_dir
1965
os.environ['BZR_HOME'] = self.test_home_dir
1968
super(TestCaseWithMemoryTransport, self).setUp()
1969
self._make_test_root()
1970
_currentdir = os.getcwdu()
1971
def _leaveDirectory():
1972
os.chdir(_currentdir)
1973
self.addCleanup(_leaveDirectory)
1974
self.makeAndChdirToTestDir()
1975
self.overrideEnvironmentForTesting()
1976
self.__readonly_server = None
1977
self.__server = None
1978
self.reduceLockdirTimeout()
1981
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1982
"""Derived class that runs a test within a temporary directory.
1984
This is useful for tests that need to create a branch, etc.
1986
The directory is created in a slightly complex way: for each
1987
Python invocation, a new temporary top-level directory is created.
1988
All test cases create their own directory within that. If the
1989
tests complete successfully, the directory is removed.
1991
:ivar test_base_dir: The path of the top-level directory for this
1992
test, which contains a home directory and a work directory.
1994
:ivar test_home_dir: An initially empty directory under test_base_dir
1995
which is used as $HOME for this test.
1997
:ivar test_dir: A directory under test_base_dir used as the current
1998
directory when the test proper is run.
2001
OVERRIDE_PYTHON = 'python'
2003
def check_file_contents(self, filename, expect):
2004
self.log("check contents of file %s" % filename)
2005
contents = file(filename, 'r').read()
2006
if contents != expect:
2007
self.log("expected: %r" % expect)
2008
self.log("actually: %r" % contents)
2009
self.fail("contents of %s not as expected" % filename)
2011
def makeAndChdirToTestDir(self):
2012
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2014
For TestCaseInTempDir we create a temporary directory based on the test
2015
name and then create two subdirs - test and home under it.
2017
# create a directory within the top level test directory
2018
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
2019
# now create test and home directories within this dir
2020
self.test_base_dir = candidate_dir
2021
self.test_home_dir = self.test_base_dir + '/home'
2022
os.mkdir(self.test_home_dir)
2023
self.test_dir = self.test_base_dir + '/work'
2024
os.mkdir(self.test_dir)
2025
os.chdir(self.test_dir)
2026
# put name of test inside
2027
f = file(self.test_base_dir + '/name', 'w')
2032
self.addCleanup(self.deleteTestDir)
2034
def deleteTestDir(self):
2035
os.chdir(self.TEST_ROOT)
2036
_rmtree_temp_dir(self.test_base_dir)
2038
def build_tree(self, shape, line_endings='binary', transport=None):
2039
"""Build a test tree according to a pattern.
2041
shape is a sequence of file specifications. If the final
2042
character is '/', a directory is created.
2044
This assumes that all the elements in the tree being built are new.
2046
This doesn't add anything to a branch.
2048
:param line_endings: Either 'binary' or 'native'
2049
in binary mode, exact contents are written in native mode, the
2050
line endings match the default platform endings.
2051
:param transport: A transport to write to, for building trees on VFS's.
2052
If the transport is readonly or None, "." is opened automatically.
2055
# It's OK to just create them using forward slashes on windows.
2056
if transport is None or transport.is_readonly():
2057
transport = get_transport(".")
2059
self.assert_(isinstance(name, basestring))
2061
transport.mkdir(urlutils.escape(name[:-1]))
2063
if line_endings == 'binary':
2065
elif line_endings == 'native':
2068
raise errors.BzrError(
2069
'Invalid line ending request %r' % line_endings)
2070
content = "contents of %s%s" % (name.encode('utf-8'), end)
2071
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2073
def build_tree_contents(self, shape):
2074
build_tree_contents(shape)
2076
def assertFileEqual(self, content, path):
2077
"""Fail if path does not contain 'content'."""
2078
self.failUnlessExists(path)
2079
f = file(path, 'rb')
2084
self.assertEqualDiff(content, s)
2086
def failUnlessExists(self, path):
2087
"""Fail unless path or paths, which may be abs or relative, exist."""
2088
if not isinstance(path, basestring):
2090
self.failUnlessExists(p)
2092
self.failUnless(osutils.lexists(path),path+" does not exist")
2094
def failIfExists(self, path):
2095
"""Fail if path or paths, which may be abs or relative, exist."""
2096
if not isinstance(path, basestring):
2098
self.failIfExists(p)
2100
self.failIf(osutils.lexists(path),path+" exists")
2102
def assertInWorkingTree(self, path, root_path='.', tree=None):
2103
"""Assert whether path or paths are in the WorkingTree"""
2105
tree = workingtree.WorkingTree.open(root_path)
2106
if not isinstance(path, basestring):
2108
self.assertInWorkingTree(p,tree=tree)
2110
self.assertIsNot(tree.path2id(path), None,
2111
path+' not in working tree.')
2113
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2114
"""Assert whether path or paths are not in the WorkingTree"""
2116
tree = workingtree.WorkingTree.open(root_path)
2117
if not isinstance(path, basestring):
2119
self.assertNotInWorkingTree(p,tree=tree)
2121
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2124
class TestCaseWithTransport(TestCaseInTempDir):
2125
"""A test case that provides get_url and get_readonly_url facilities.
2127
These back onto two transport servers, one for readonly access and one for
2130
If no explicit class is provided for readonly access, a
2131
ReadonlyTransportDecorator is used instead which allows the use of non disk
2132
based read write transports.
2134
If an explicit class is provided for readonly access, that server and the
2135
readwrite one must both define get_url() as resolving to os.getcwd().
2138
def get_vfs_only_server(self):
2139
"""See TestCaseWithMemoryTransport.
2141
This is useful for some tests with specific servers that need
2144
if self.__vfs_server is None:
2145
self.__vfs_server = self.vfs_transport_factory()
2146
self.__vfs_server.setUp()
2147
self.addCleanup(self.__vfs_server.tearDown)
2148
return self.__vfs_server
2150
def make_branch_and_tree(self, relpath, format=None):
2151
"""Create a branch on the transport and a tree locally.
2153
If the transport is not a LocalTransport, the Tree can't be created on
2154
the transport. In that case if the vfs_transport_factory is
2155
LocalURLServer the working tree is created in the local
2156
directory backing the transport, and the returned tree's branch and
2157
repository will also be accessed locally. Otherwise a lightweight
2158
checkout is created and returned.
2160
:param format: The BzrDirFormat.
2161
:returns: the WorkingTree.
2163
# TODO: always use the local disk path for the working tree,
2164
# this obviously requires a format that supports branch references
2165
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2167
b = self.make_branch(relpath, format=format)
2169
return b.bzrdir.create_workingtree()
2170
except errors.NotLocalUrl:
2171
# We can only make working trees locally at the moment. If the
2172
# transport can't support them, then we keep the non-disk-backed
2173
# branch and create a local checkout.
2174
if self.vfs_transport_factory is LocalURLServer:
2175
# the branch is colocated on disk, we cannot create a checkout.
2176
# hopefully callers will expect this.
2177
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2178
return local_controldir.create_workingtree()
2180
return b.create_checkout(relpath, lightweight=True)
2182
def assertIsDirectory(self, relpath, transport):
2183
"""Assert that relpath within transport is a directory.
2185
This may not be possible on all transports; in that case it propagates
2186
a TransportNotPossible.
2189
mode = transport.stat(relpath).st_mode
2190
except errors.NoSuchFile:
2191
self.fail("path %s is not a directory; no such file"
2193
if not stat.S_ISDIR(mode):
2194
self.fail("path %s is not a directory; has mode %#o"
2197
def assertTreesEqual(self, left, right):
2198
"""Check that left and right have the same content and properties."""
2199
# we use a tree delta to check for equality of the content, and we
2200
# manually check for equality of other things such as the parents list.
2201
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2202
differences = left.changes_from(right)
2203
self.assertFalse(differences.has_changed(),
2204
"Trees %r and %r are different: %r" % (left, right, differences))
2207
super(TestCaseWithTransport, self).setUp()
2208
self.__vfs_server = None
2211
class ChrootedTestCase(TestCaseWithTransport):
2212
"""A support class that provides readonly urls outside the local namespace.
2214
This is done by checking if self.transport_server is a MemoryServer. if it
2215
is then we are chrooted already, if it is not then an HttpServer is used
2218
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2219
be used without needed to redo it when a different
2220
subclass is in use ?
2224
super(ChrootedTestCase, self).setUp()
2225
if not self.vfs_transport_factory == MemoryServer:
2226
self.transport_readonly_server = HttpServer
2229
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2230
random_order=False):
2231
"""Create a test suite by filtering another one.
2233
:param suite: the source suite
2234
:param pattern: pattern that names must match
2235
:param exclude_pattern: pattern that names must not match, if any
2236
:param random_order: if True, tests in the new suite will be put in
2238
:returns: the newly created suite
2240
return sort_suite_by_re(suite, pattern, exclude_pattern,
2241
random_order, False)
2244
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2245
random_order=False, append_rest=True):
2246
"""Create a test suite by sorting another one.
2248
:param suite: the source suite
2249
:param pattern: pattern that names must match in order to go
2250
first in the new suite
2251
:param exclude_pattern: pattern that names must not match, if any
2252
:param random_order: if True, tests in the new suite will be put in
2254
:param append_rest: if False, pattern is a strict filter and not
2255
just an ordering directive
2256
:returns: the newly created suite
2260
filter_re = re.compile(pattern)
2261
if exclude_pattern is not None:
2262
exclude_re = re.compile(exclude_pattern)
2263
for test in iter_suite_tests(suite):
2265
if exclude_pattern is None or not exclude_re.search(test_id):
2266
if filter_re.search(test_id):
2271
random.shuffle(first)
2272
random.shuffle(second)
2273
return TestUtil.TestSuite(first + second)
2276
def run_suite(suite, name='test', verbose=False, pattern=".*",
2277
stop_on_failure=False,
2278
transport=None, lsprof_timed=None, bench_history=None,
2279
matching_tests_first=None,
2282
exclude_pattern=None,
2285
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2290
runner = TextTestRunner(stream=sys.stdout,
2292
verbosity=verbosity,
2293
bench_history=bench_history,
2294
list_only=list_only,
2296
runner.stop_on_failure=stop_on_failure
2297
# Initialise the random number generator and display the seed used.
2298
# We convert the seed to a long to make it reuseable across invocations.
2299
random_order = False
2300
if random_seed is not None:
2302
if random_seed == "now":
2303
random_seed = long(time.time())
2305
# Convert the seed to a long if we can
2307
random_seed = long(random_seed)
2310
runner.stream.writeln("Randomizing test order using seed %s\n" %
2312
random.seed(random_seed)
2313
# Customise the list of tests if requested
2314
if pattern != '.*' or exclude_pattern is not None or random_order:
2315
if matching_tests_first:
2316
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2319
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2321
result = runner.run(suite)
2324
return result.wasStrictlySuccessful()
2326
return result.wasSuccessful()
2329
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2331
test_suite_factory=None,
2334
matching_tests_first=None,
2337
exclude_pattern=None,
2340
"""Run the whole test suite under the enhanced runner"""
2341
# XXX: Very ugly way to do this...
2342
# Disable warning about old formats because we don't want it to disturb
2343
# any blackbox tests.
2344
from bzrlib import repository
2345
repository._deprecation_warning_done = True
2347
global default_transport
2348
if transport is None:
2349
transport = default_transport
2350
old_transport = default_transport
2351
default_transport = transport
2353
if test_suite_factory is None:
2354
suite = test_suite()
2356
suite = test_suite_factory()
2357
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2358
stop_on_failure=stop_on_failure,
2359
transport=transport,
2360
lsprof_timed=lsprof_timed,
2361
bench_history=bench_history,
2362
matching_tests_first=matching_tests_first,
2363
list_only=list_only,
2364
random_seed=random_seed,
2365
exclude_pattern=exclude_pattern,
2368
default_transport = old_transport
2372
"""Build and return TestSuite for the whole of bzrlib.
2374
This function can be replaced if you need to change the default test
2375
suite on a global basis, but it is not encouraged.
2378
'bzrlib.util.tests.test_bencode',
2379
'bzrlib.tests.test__dirstate_helpers',
2380
'bzrlib.tests.test_ancestry',
2381
'bzrlib.tests.test_annotate',
2382
'bzrlib.tests.test_api',
2383
'bzrlib.tests.test_atomicfile',
2384
'bzrlib.tests.test_bad_files',
2385
'bzrlib.tests.test_bisect_multi',
2386
'bzrlib.tests.test_branch',
2387
'bzrlib.tests.test_branchbuilder',
2388
'bzrlib.tests.test_bugtracker',
2389
'bzrlib.tests.test_bundle',
2390
'bzrlib.tests.test_bzrdir',
2391
'bzrlib.tests.test_cache_utf8',
2392
'bzrlib.tests.test_commands',
2393
'bzrlib.tests.test_commit',
2394
'bzrlib.tests.test_commit_merge',
2395
'bzrlib.tests.test_config',
2396
'bzrlib.tests.test_conflicts',
2397
'bzrlib.tests.test_counted_lock',
2398
'bzrlib.tests.test_decorators',
2399
'bzrlib.tests.test_delta',
2400
'bzrlib.tests.test_deprecated_graph',
2401
'bzrlib.tests.test_diff',
2402
'bzrlib.tests.test_dirstate',
2403
'bzrlib.tests.test_email_message',
2404
'bzrlib.tests.test_errors',
2405
'bzrlib.tests.test_escaped_store',
2406
'bzrlib.tests.test_extract',
2407
'bzrlib.tests.test_fetch',
2408
'bzrlib.tests.test_ftp_transport',
2409
'bzrlib.tests.test_generate_docs',
2410
'bzrlib.tests.test_generate_ids',
2411
'bzrlib.tests.test_globbing',
2412
'bzrlib.tests.test_gpg',
2413
'bzrlib.tests.test_graph',
2414
'bzrlib.tests.test_hashcache',
2415
'bzrlib.tests.test_help',
2416
'bzrlib.tests.test_hooks',
2417
'bzrlib.tests.test_http',
2418
'bzrlib.tests.test_http_response',
2419
'bzrlib.tests.test_https_ca_bundle',
2420
'bzrlib.tests.test_identitymap',
2421
'bzrlib.tests.test_ignores',
2422
'bzrlib.tests.test_index',
2423
'bzrlib.tests.test_info',
2424
'bzrlib.tests.test_inv',
2425
'bzrlib.tests.test_knit',
2426
'bzrlib.tests.test_lazy_import',
2427
'bzrlib.tests.test_lazy_regex',
2428
'bzrlib.tests.test_lockdir',
2429
'bzrlib.tests.test_lockable_files',
2430
'bzrlib.tests.test_log',
2431
'bzrlib.tests.test_lsprof',
2432
'bzrlib.tests.test_mail_client',
2433
'bzrlib.tests.test_memorytree',
2434
'bzrlib.tests.test_merge',
2435
'bzrlib.tests.test_merge3',
2436
'bzrlib.tests.test_merge_core',
2437
'bzrlib.tests.test_merge_directive',
2438
'bzrlib.tests.test_missing',
2439
'bzrlib.tests.test_msgeditor',
2440
'bzrlib.tests.test_multiparent',
2441
'bzrlib.tests.test_nonascii',
2442
'bzrlib.tests.test_options',
2443
'bzrlib.tests.test_osutils',
2444
'bzrlib.tests.test_osutils_encodings',
2445
'bzrlib.tests.test_pack',
2446
'bzrlib.tests.test_patch',
2447
'bzrlib.tests.test_patches',
2448
'bzrlib.tests.test_permissions',
2449
'bzrlib.tests.test_plugins',
2450
'bzrlib.tests.test_progress',
2451
'bzrlib.tests.test_reconfigure',
2452
'bzrlib.tests.test_reconcile',
2453
'bzrlib.tests.test_registry',
2454
'bzrlib.tests.test_remote',
2455
'bzrlib.tests.test_repository',
2456
'bzrlib.tests.test_revert',
2457
'bzrlib.tests.test_revision',
2458
'bzrlib.tests.test_revisionnamespaces',
2459
'bzrlib.tests.test_revisiontree',
2460
'bzrlib.tests.test_rio',
2461
'bzrlib.tests.test_sampler',
2462
'bzrlib.tests.test_selftest',
2463
'bzrlib.tests.test_setup',
2464
'bzrlib.tests.test_sftp_transport',
2465
'bzrlib.tests.test_smart',
2466
'bzrlib.tests.test_smart_add',
2467
'bzrlib.tests.test_smart_transport',
2468
'bzrlib.tests.test_smtp_connection',
2469
'bzrlib.tests.test_source',
2470
'bzrlib.tests.test_ssh_transport',
2471
'bzrlib.tests.test_status',
2472
'bzrlib.tests.test_store',
2473
'bzrlib.tests.test_strace',
2474
'bzrlib.tests.test_subsume',
2475
'bzrlib.tests.test_symbol_versioning',
2476
'bzrlib.tests.test_tag',
2477
'bzrlib.tests.test_testament',
2478
'bzrlib.tests.test_textfile',
2479
'bzrlib.tests.test_textmerge',
2480
'bzrlib.tests.test_timestamp',
2481
'bzrlib.tests.test_trace',
2482
'bzrlib.tests.test_transactions',
2483
'bzrlib.tests.test_transform',
2484
'bzrlib.tests.test_transport',
2485
'bzrlib.tests.test_tree',
2486
'bzrlib.tests.test_treebuilder',
2487
'bzrlib.tests.test_tsort',
2488
'bzrlib.tests.test_tuned_gzip',
2489
'bzrlib.tests.test_ui',
2490
'bzrlib.tests.test_upgrade',
2491
'bzrlib.tests.test_urlutils',
2492
'bzrlib.tests.test_versionedfile',
2493
'bzrlib.tests.test_version',
2494
'bzrlib.tests.test_version_info',
2495
'bzrlib.tests.test_weave',
2496
'bzrlib.tests.test_whitebox',
2497
'bzrlib.tests.test_win32utils',
2498
'bzrlib.tests.test_workingtree',
2499
'bzrlib.tests.test_workingtree_4',
2500
'bzrlib.tests.test_wsgi',
2501
'bzrlib.tests.test_xml',
2503
test_transport_implementations = [
2504
'bzrlib.tests.test_transport_implementations',
2505
'bzrlib.tests.test_read_bundle',
2507
suite = TestUtil.TestSuite()
2508
loader = TestUtil.TestLoader()
2509
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2510
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2511
adapter = TransportTestProviderAdapter()
2512
adapt_modules(test_transport_implementations, adapter, loader, suite)
2513
for package in packages_to_test():
2514
suite.addTest(package.test_suite())
2515
for m in MODULES_TO_TEST:
2516
suite.addTest(loader.loadTestsFromModule(m))
2517
for m in MODULES_TO_DOCTEST:
2519
suite.addTest(doctest.DocTestSuite(m))
2520
except ValueError, e:
2521
print '**failed to get doctest for: %s\n%s' %(m,e)
2523
default_encoding = sys.getdefaultencoding()
2524
for name, plugin in bzrlib.plugin.plugins().items():
2526
plugin_suite = plugin.test_suite()
2527
except ImportError, e:
2528
bzrlib.trace.warning(
2529
'Unable to test plugin "%s": %s', name, e)
2531
if plugin_suite is not None:
2532
suite.addTest(plugin_suite)
2533
if default_encoding != sys.getdefaultencoding():
2534
bzrlib.trace.warning(
2535
'Plugin "%s" tried to reset default encoding to: %s', name,
2536
sys.getdefaultencoding())
2538
sys.setdefaultencoding(default_encoding)
2542
def multiply_tests_from_modules(module_name_list, scenario_iter):
2543
"""Adapt all tests in some given modules to given scenarios.
2545
This is the recommended public interface for test parameterization.
2546
Typically the test_suite() method for a per-implementation test
2547
suite will call multiply_tests_from_modules and return the
2550
:param module_name_list: List of fully-qualified names of test
2552
:param scenario_iter: Iterable of pairs of (scenario_name,
2553
scenario_param_dict).
2555
This returns a new TestSuite containing the cross product of
2556
all the tests in all the modules, each repeated for each scenario.
2557
Each test is adapted by adding the scenario name at the end
2558
of its name, and updating the test object's __dict__ with the
2559
scenario_param_dict.
2561
>>> r = multiply_tests_from_modules(
2562
... ['bzrlib.tests.test_sampler'],
2563
... [('one', dict(param=1)),
2564
... ('two', dict(param=2))])
2565
>>> tests = list(iter_suite_tests(r))
2569
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2575
loader = TestLoader()
2577
adapter = TestScenarioApplier()
2578
adapter.scenarios = list(scenario_iter)
2579
adapt_modules(module_name_list, adapter, loader, suite)
2583
def multiply_scenarios(scenarios_left, scenarios_right):
2584
"""Multiply two sets of scenarios.
2586
:returns: the cartesian product of the two sets of scenarios, that is
2587
a scenario for every possible combination of a left scenario and a
2591
('%s,%s' % (left_name, right_name),
2592
dict(left_dict.items() + right_dict.items()))
2593
for left_name, left_dict in scenarios_left
2594
for right_name, right_dict in scenarios_right]
2598
def adapt_modules(mods_list, adapter, loader, suite):
2599
"""Adapt the modules in mods_list using adapter and add to suite."""
2600
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2601
suite.addTests(adapter.adapt(test))
2604
def _rmtree_temp_dir(dirname):
2605
# If LANG=C we probably have created some bogus paths
2606
# which rmtree(unicode) will fail to delete
2607
# so make sure we are using rmtree(str) to delete everything
2608
# except on win32, where rmtree(str) will fail
2609
# since it doesn't have the property of byte-stream paths
2610
# (they are either ascii or mbcs)
2611
if sys.platform == 'win32':
2612
# make sure we are using the unicode win32 api
2613
dirname = unicode(dirname)
2615
dirname = dirname.encode(sys.getfilesystemencoding())
2617
osutils.rmtree(dirname)
2619
if sys.platform == 'win32' and e.errno == errno.EACCES:
2620
sys.stderr.write(('Permission denied: '
2621
'unable to remove testing dir '
2622
'%s\n' % os.path.basename(dirname)))
2627
class Feature(object):
2628
"""An operating system Feature."""
2631
self._available = None
2633
def available(self):
2634
"""Is the feature available?
2636
:return: True if the feature is available.
2638
if self._available is None:
2639
self._available = self._probe()
2640
return self._available
2643
"""Implement this method in concrete features.
2645
:return: True if the feature is available.
2647
raise NotImplementedError
2650
if getattr(self, 'feature_name', None):
2651
return self.feature_name()
2652
return self.__class__.__name__
2655
class _SymlinkFeature(Feature):
2658
return osutils.has_symlinks()
2660
def feature_name(self):
2663
SymlinkFeature = _SymlinkFeature()
2666
class _OsFifoFeature(Feature):
2669
return getattr(os, 'mkfifo', None)
2671
def feature_name(self):
2672
return 'filesystem fifos'
2674
OsFifoFeature = _OsFifoFeature()
2677
class TestScenarioApplier(object):
2678
"""A tool to apply scenarios to tests."""
2680
def adapt(self, test):
2681
"""Return a TestSuite containing a copy of test for each scenario."""
2682
result = unittest.TestSuite()
2683
for scenario in self.scenarios:
2684
result.addTest(self.adapt_test_to_scenario(test, scenario))
2687
def adapt_test_to_scenario(self, test, scenario):
2688
"""Copy test and apply scenario to it.
2690
:param test: A test to adapt.
2691
:param scenario: A tuple describing the scenarion.
2692
The first element of the tuple is the new test id.
2693
The second element is a dict containing attributes to set on the
2695
:return: The adapted test.
2697
from copy import deepcopy
2698
new_test = deepcopy(test)
2699
for name, value in scenario[1].items():
2700
setattr(new_test, name, value)
2701
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2702
new_test.id = lambda: new_id
2706
def probe_unicode_in_user_encoding():
2707
"""Try to encode several unicode strings to use in unicode-aware tests.
2708
Return first successfull match.
2710
:return: (unicode value, encoded plain string value) or (None, None)
2712
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
2713
for uni_val in possible_vals:
2715
str_val = uni_val.encode(bzrlib.user_encoding)
2716
except UnicodeEncodeError:
2717
# Try a different character
2720
return uni_val, str_val
2724
def probe_bad_non_ascii(encoding):
2725
"""Try to find [bad] character with code [128..255]
2726
that cannot be decoded to unicode in some encoding.
2727
Return None if all non-ascii characters is valid
2730
for i in xrange(128, 256):
2733
char.decode(encoding)
2734
except UnicodeDecodeError:
2739
class _FTPServerFeature(Feature):
2740
"""Some tests want an FTP Server, check if one is available.
2742
Right now, the only way this is available is if 'medusa' is installed.
2743
http://www.amk.ca/python/code/medusa.html
2748
import bzrlib.tests.ftp_server
2753
def feature_name(self):
2756
FTPServerFeature = _FTPServerFeature()
added
removed
bzrlib/tests/__init__.py
