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 this 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:
358
print >>self.stream, \
359
('vvvv[log from %s]' % test.id()).ljust(78,'-')
360
print >>self.stream, test._get_log()
361
print >>self.stream, \
362
('^^^^[log from %s]' % test.id()).ljust(78,'-')
363
self.stream.writeln(self.separator2)
364
self.stream.writeln("%s" % err)
369
def report_cleaning_up(self):
372
def report_success(self, test):
375
def wasStrictlySuccessful(self):
376
if self.unsupported or self.known_failure_count:
378
return self.wasSuccessful()
381
class TextTestResult(ExtendedTestResult):
382
"""Displays progress and results of tests in text form"""
384
def __init__(self, stream, descriptions, verbosity,
389
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
390
bench_history, num_tests)
392
self.pb = self.ui.nested_progress_bar()
393
self._supplied_pb = False
396
self._supplied_pb = True
397
self.pb.show_pct = False
398
self.pb.show_spinner = False
399
self.pb.show_eta = False,
400
self.pb.show_count = False
401
self.pb.show_bar = False
403
def report_starting(self):
404
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
406
def _progress_prefix_text(self):
407
a = '[%d' % self.count
408
if self.num_tests is not None:
409
a +='/%d' % self.num_tests
410
a += ' in %ds' % (time.time() - self._overall_start_time)
412
a += ', %d errors' % self.error_count
413
if self.failure_count:
414
a += ', %d failed' % self.failure_count
415
if self.known_failure_count:
416
a += ', %d known failures' % self.known_failure_count
418
a += ', %d skipped' % self.skip_count
420
a += ', %d missing features' % len(self.unsupported)
424
def report_test_start(self, test):
427
self._progress_prefix_text()
429
+ self._shortened_test_description(test))
431
def _test_description(self, test):
432
return self._shortened_test_description(test)
434
def report_error(self, test, err):
435
self.pb.note('ERROR: %s\n %s\n',
436
self._test_description(test),
440
def report_failure(self, test, err):
441
self.pb.note('FAIL: %s\n %s\n',
442
self._test_description(test),
446
def report_known_failure(self, test, err):
447
self.pb.note('XFAIL: %s\n%s\n',
448
self._test_description(test), err[1])
450
def report_skip(self, test, skip_excinfo):
453
def report_not_applicable(self, test, skip_excinfo):
456
def report_unsupported(self, test, feature):
457
"""test cannot be run because feature is missing."""
459
def report_cleaning_up(self):
460
self.pb.update('cleaning up...')
463
if not self._supplied_pb:
467
class VerboseTestResult(ExtendedTestResult):
468
"""Produce long output, with one line per test run plus times"""
470
def _ellipsize_to_right(self, a_string, final_width):
471
"""Truncate and pad a string, keeping the right hand side"""
472
if len(a_string) > final_width:
473
result = '...' + a_string[3-final_width:]
476
return result.ljust(final_width)
478
def report_starting(self):
479
self.stream.write('running %d tests...\n' % self.num_tests)
481
def report_test_start(self, test):
483
name = self._shortened_test_description(test)
484
# width needs space for 6 char status, plus 1 for slash, plus 2 10-char
485
# numbers, plus a trailing blank
486
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
487
self.stream.write(self._ellipsize_to_right(name,
488
osutils.terminal_width()-30))
491
def _error_summary(self, err):
493
return '%s%s' % (indent, err[1])
495
def report_error(self, test, err):
496
self.stream.writeln('ERROR %s\n%s'
497
% (self._testTimeString(test),
498
self._error_summary(err)))
500
def report_failure(self, test, err):
501
self.stream.writeln(' FAIL %s\n%s'
502
% (self._testTimeString(test),
503
self._error_summary(err)))
505
def report_known_failure(self, test, err):
506
self.stream.writeln('XFAIL %s\n%s'
507
% (self._testTimeString(test),
508
self._error_summary(err)))
510
def report_success(self, test):
511
self.stream.writeln(' OK %s' % self._testTimeString(test))
512
for bench_called, stats in getattr(test, '_benchcalls', []):
513
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
514
stats.pprint(file=self.stream)
515
# flush the stream so that we get smooth output. This verbose mode is
516
# used to show the output in PQM.
519
def report_skip(self, test, skip_excinfo):
520
self.stream.writeln(' SKIP %s\n%s'
521
% (self._testTimeString(test),
522
self._error_summary(skip_excinfo)))
524
def report_not_applicable(self, test, skip_excinfo):
525
self.stream.writeln(' N/A %s\n%s'
526
% (self._testTimeString(test),
527
self._error_summary(skip_excinfo)))
529
def report_unsupported(self, test, feature):
530
"""test cannot be run because feature is missing."""
531
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
532
%(self._testTimeString(test), feature))
535
class TextTestRunner(object):
536
stop_on_failure = False
545
self.stream = unittest._WritelnDecorator(stream)
546
self.descriptions = descriptions
547
self.verbosity = verbosity
548
self._bench_history = bench_history
549
self.list_only = list_only
552
"Run the given test case or test suite."
553
startTime = time.time()
554
if self.verbosity == 1:
555
result_class = TextTestResult
556
elif self.verbosity >= 2:
557
result_class = VerboseTestResult
558
result = result_class(self.stream,
561
bench_history=self._bench_history,
562
num_tests=test.countTestCases(),
564
result.stop_early = self.stop_on_failure
565
result.report_starting()
567
if self.verbosity >= 2:
568
self.stream.writeln("Listing tests only ...\n")
570
for t in iter_suite_tests(test):
571
self.stream.writeln("%s" % (t.id()))
573
actionTaken = "Listed"
576
run = result.testsRun
578
stopTime = time.time()
579
timeTaken = stopTime - startTime
581
self.stream.writeln(result.separator2)
582
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
583
run, run != 1 and "s" or "", timeTaken))
584
self.stream.writeln()
585
if not result.wasSuccessful():
586
self.stream.write("FAILED (")
587
failed, errored = map(len, (result.failures, result.errors))
589
self.stream.write("failures=%d" % failed)
591
if failed: self.stream.write(", ")
592
self.stream.write("errors=%d" % errored)
593
if result.known_failure_count:
594
if failed or errored: self.stream.write(", ")
595
self.stream.write("known_failure_count=%d" %
596
result.known_failure_count)
597
self.stream.writeln(")")
599
if result.known_failure_count:
600
self.stream.writeln("OK (known_failures=%d)" %
601
result.known_failure_count)
603
self.stream.writeln("OK")
604
if result.skip_count > 0:
605
skipped = result.skip_count
606
self.stream.writeln('%d test%s skipped' %
607
(skipped, skipped != 1 and "s" or ""))
608
if result.unsupported:
609
for feature, count in sorted(result.unsupported.items()):
610
self.stream.writeln("Missing feature '%s' skipped %d tests." %
616
def iter_suite_tests(suite):
617
"""Return all tests in a suite, recursing through nested suites"""
618
for item in suite._tests:
619
if isinstance(item, unittest.TestCase):
621
elif isinstance(item, unittest.TestSuite):
622
for r in iter_suite_tests(item):
625
raise Exception('unknown object %r inside test suite %r'
629
class TestSkipped(Exception):
630
"""Indicates that a test was intentionally skipped, rather than failing."""
633
class TestNotApplicable(TestSkipped):
634
"""A test is not applicable to the situation where it was run.
636
This is only normally raised by parameterized tests, if they find that
637
the instance they're constructed upon does not support one aspect
642
class KnownFailure(AssertionError):
643
"""Indicates that a test failed in a precisely expected manner.
645
Such failures dont block the whole test suite from passing because they are
646
indicators of partially completed code or of future work. We have an
647
explicit error for them so that we can ensure that they are always visible:
648
KnownFailures are always shown in the output of bzr selftest.
652
class UnavailableFeature(Exception):
653
"""A feature required for this test was not available.
655
The feature should be used to construct the exception.
659
class CommandFailed(Exception):
663
class StringIOWrapper(object):
664
"""A wrapper around cStringIO which just adds an encoding attribute.
666
Internally we can check sys.stdout to see what the output encoding
667
should be. However, cStringIO has no encoding attribute that we can
668
set. So we wrap it instead.
673
def __init__(self, s=None):
675
self.__dict__['_cstring'] = StringIO(s)
677
self.__dict__['_cstring'] = StringIO()
679
def __getattr__(self, name, getattr=getattr):
680
return getattr(self.__dict__['_cstring'], name)
682
def __setattr__(self, name, val):
683
if name == 'encoding':
684
self.__dict__['encoding'] = val
686
return setattr(self._cstring, name, val)
689
class TestUIFactory(ui.CLIUIFactory):
690
"""A UI Factory for testing.
692
Hide the progress bar but emit note()s.
694
Allows get_password to be tested without real tty attached.
701
super(TestUIFactory, self).__init__()
702
if stdin is not None:
703
# We use a StringIOWrapper to be able to test various
704
# encodings, but the user is still responsible to
705
# encode the string and to set the encoding attribute
706
# of StringIOWrapper.
707
self.stdin = StringIOWrapper(stdin)
709
self.stdout = sys.stdout
713
self.stderr = sys.stderr
718
"""See progress.ProgressBar.clear()."""
720
def clear_term(self):
721
"""See progress.ProgressBar.clear_term()."""
723
def clear_term(self):
724
"""See progress.ProgressBar.clear_term()."""
727
"""See progress.ProgressBar.finished()."""
729
def note(self, fmt_string, *args, **kwargs):
730
"""See progress.ProgressBar.note()."""
731
self.stdout.write((fmt_string + "\n") % args)
733
def progress_bar(self):
736
def nested_progress_bar(self):
739
def update(self, message, count=None, total=None):
740
"""See progress.ProgressBar.update()."""
742
def get_non_echoed_password(self, prompt):
743
"""Get password from stdin without trying to handle the echo mode"""
745
self.stdout.write(prompt.encode(self.stdout.encoding, 'replace'))
746
password = self.stdin.readline()
749
if password[-1] == '\n':
750
password = password[:-1]
754
class TestCase(unittest.TestCase):
755
"""Base class for bzr unit tests.
757
Tests that need access to disk resources should subclass
758
TestCaseInTempDir not TestCase.
760
Error and debug log messages are redirected from their usual
761
location into a temporary file, the contents of which can be
762
retrieved by _get_log(). We use a real OS file, not an in-memory object,
763
so that it can also capture file IO. When the test completes this file
764
is read into memory and removed from disk.
766
There are also convenience functions to invoke bzr's command-line
767
routine, and to build and check bzr trees.
769
In addition to the usual method of overriding tearDown(), this class also
770
allows subclasses to register functions into the _cleanups list, which is
771
run in order as the object is torn down. It's less likely this will be
772
accidentally overlooked.
775
_log_file_name = None
777
_keep_log_file = False
778
# record lsprof data when performing benchmark calls.
779
_gather_lsprof_in_benchmarks = False
781
def __init__(self, methodName='testMethod'):
782
super(TestCase, self).__init__(methodName)
786
unittest.TestCase.setUp(self)
787
self._cleanEnvironment()
788
bzrlib.trace.disable_default_logging()
791
self._benchcalls = []
792
self._benchtime = None
794
self._clear_debug_flags()
796
def _clear_debug_flags(self):
797
"""Prevent externally set debug flags affecting tests.
799
Tests that want to use debug flags can just set them in the
800
debug_flags set during setup/teardown.
802
self._preserved_debug_flags = set(debug.debug_flags)
803
debug.debug_flags.clear()
804
self.addCleanup(self._restore_debug_flags)
806
def _clear_hooks(self):
807
# prevent hooks affecting tests
809
import bzrlib.smart.server
810
self._preserved_hooks = {
811
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
812
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
814
self.addCleanup(self._restoreHooks)
815
# reset all hooks to an empty instance of the appropriate type
816
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
817
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
819
def _silenceUI(self):
820
"""Turn off UI for duration of test"""
821
# by default the UI is off; tests can turn it on if they want it.
822
saved = ui.ui_factory
824
ui.ui_factory = saved
825
ui.ui_factory = ui.SilentUIFactory()
826
self.addCleanup(_restore)
828
def _ndiff_strings(self, a, b):
829
"""Return ndiff between two strings containing lines.
831
A trailing newline is added if missing to make the strings
833
if b and b[-1] != '\n':
835
if a and a[-1] != '\n':
837
difflines = difflib.ndiff(a.splitlines(True),
839
linejunk=lambda x: False,
840
charjunk=lambda x: False)
841
return ''.join(difflines)
843
def assertEqual(self, a, b, message=''):
847
except UnicodeError, e:
848
# If we can't compare without getting a UnicodeError, then
849
# obviously they are different
850
mutter('UnicodeError: %s', e)
853
raise AssertionError("%snot equal:\na = %s\nb = %s\n"
855
pformat(a), pformat(b)))
857
assertEquals = assertEqual
859
def assertEqualDiff(self, a, b, message=None):
860
"""Assert two texts are equal, if not raise an exception.
862
This is intended for use with multi-line strings where it can
863
be hard to find the differences by eye.
865
# TODO: perhaps override assertEquals to call this for strings?
869
message = "texts not equal:\n"
870
raise AssertionError(message +
871
self._ndiff_strings(a, b))
873
def assertEqualMode(self, mode, mode_test):
874
self.assertEqual(mode, mode_test,
875
'mode mismatch %o != %o' % (mode, mode_test))
877
def assertPositive(self, val):
878
"""Assert that val is greater than 0."""
879
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
881
def assertNegative(self, val):
882
"""Assert that val is less than 0."""
883
self.assertTrue(val < 0, 'expected a negative value, but got %s' % val)
885
def assertStartsWith(self, s, prefix):
886
if not s.startswith(prefix):
887
raise AssertionError('string %r does not start with %r' % (s, prefix))
889
def assertEndsWith(self, s, suffix):
890
"""Asserts that s ends with suffix."""
891
if not s.endswith(suffix):
892
raise AssertionError('string %r does not end with %r' % (s, suffix))
894
def assertContainsRe(self, haystack, needle_re):
895
"""Assert that a contains something matching a regular expression."""
896
if not re.search(needle_re, haystack):
897
if '\n' in haystack or len(haystack) > 60:
898
# a long string, format it in a more readable way
899
raise AssertionError(
900
'pattern "%s" not found in\n"""\\\n%s"""\n'
901
% (needle_re, haystack))
903
raise AssertionError('pattern "%s" not found in "%s"'
904
% (needle_re, haystack))
906
def assertNotContainsRe(self, haystack, needle_re):
907
"""Assert that a does not match a regular expression"""
908
if re.search(needle_re, haystack):
909
raise AssertionError('pattern "%s" found in "%s"'
910
% (needle_re, haystack))
912
def assertSubset(self, sublist, superlist):
913
"""Assert that every entry in sublist is present in superlist."""
914
missing = set(sublist) - set(superlist)
916
raise AssertionError("value(s) %r not present in container %r" %
917
(missing, superlist))
919
def assertListRaises(self, excClass, func, *args, **kwargs):
920
"""Fail unless excClass is raised when the iterator from func is used.
922
Many functions can return generators this makes sure
923
to wrap them in a list() call to make sure the whole generator
924
is run, and that the proper exception is raised.
927
list(func(*args, **kwargs))
931
if getattr(excClass,'__name__', None) is not None:
932
excName = excClass.__name__
934
excName = str(excClass)
935
raise self.failureException, "%s not raised" % excName
937
def assertRaises(self, excClass, callableObj, *args, **kwargs):
938
"""Assert that a callable raises a particular exception.
940
:param excClass: As for the except statement, this may be either an
941
exception class, or a tuple of classes.
942
:param callableObj: A callable, will be passed ``*args`` and
945
Returns the exception so that you can examine it.
948
callableObj(*args, **kwargs)
952
if getattr(excClass,'__name__', None) is not None:
953
excName = excClass.__name__
956
excName = str(excClass)
957
raise self.failureException, "%s not raised" % excName
959
def assertIs(self, left, right, message=None):
960
if not (left is right):
961
if message is not None:
962
raise AssertionError(message)
964
raise AssertionError("%r is not %r." % (left, right))
966
def assertIsNot(self, left, right, message=None):
968
if message is not None:
969
raise AssertionError(message)
971
raise AssertionError("%r is %r." % (left, right))
973
def assertTransportMode(self, transport, path, mode):
974
"""Fail if a path does not have mode mode.
976
If modes are not supported on this transport, the assertion is ignored.
978
if not transport._can_roundtrip_unix_modebits():
980
path_stat = transport.stat(path)
981
actual_mode = stat.S_IMODE(path_stat.st_mode)
982
self.assertEqual(mode, actual_mode,
983
'mode of %r incorrect (%o != %o)' % (path, mode, actual_mode))
985
def assertIsInstance(self, obj, kls):
986
"""Fail if obj is not an instance of kls"""
987
if not isinstance(obj, kls):
988
self.fail("%r is an instance of %s rather than %s" % (
989
obj, obj.__class__, kls))
991
def expectFailure(self, reason, assertion, *args, **kwargs):
992
"""Invoke a test, expecting it to fail for the given reason.
994
This is for assertions that ought to succeed, but currently fail.
995
(The failure is *expected* but not *wanted*.) Please be very precise
996
about the failure you're expecting. If a new bug is introduced,
997
AssertionError should be raised, not KnownFailure.
999
Frequently, expectFailure should be followed by an opposite assertion.
1002
Intended to be used with a callable that raises AssertionError as the
1003
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1005
Raises KnownFailure if the test fails. Raises AssertionError if the
1010
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1012
self.assertEqual(42, dynamic_val)
1014
This means that a dynamic_val of 54 will cause the test to raise
1015
a KnownFailure. Once math is fixed and the expectFailure is removed,
1016
only a dynamic_val of 42 will allow the test to pass. Anything other
1017
than 54 or 42 will cause an AssertionError.
1020
assertion(*args, **kwargs)
1021
except AssertionError:
1022
raise KnownFailure(reason)
1024
self.fail('Unexpected success. Should have failed: %s' % reason)
1026
def _capture_warnings(self, a_callable, *args, **kwargs):
1027
"""A helper for callDeprecated and applyDeprecated.
1029
:param a_callable: A callable to call.
1030
:param args: The positional arguments for the callable
1031
:param kwargs: The keyword arguments for the callable
1032
:return: A tuple (warnings, result). result is the result of calling
1033
a_callable(``*args``, ``**kwargs``).
1036
def capture_warnings(msg, cls=None, stacklevel=None):
1037
# we've hooked into a deprecation specific callpath,
1038
# only deprecations should getting sent via it.
1039
self.assertEqual(cls, DeprecationWarning)
1040
local_warnings.append(msg)
1041
original_warning_method = symbol_versioning.warn
1042
symbol_versioning.set_warning_method(capture_warnings)
1044
result = a_callable(*args, **kwargs)
1046
symbol_versioning.set_warning_method(original_warning_method)
1047
return (local_warnings, result)
1049
def applyDeprecated(self, deprecation_format, a_callable, *args, **kwargs):
1050
"""Call a deprecated callable without warning the user.
1052
Note that this only captures warnings raised by symbol_versioning.warn,
1053
not other callers that go direct to the warning module.
1055
To test that a deprecated method raises an error, do something like
1058
self.assertRaises(errors.ReservedId,
1059
self.applyDeprecated, zero_ninetyone,
1060
br.append_revision, 'current:')
1062
:param deprecation_format: The deprecation format that the callable
1063
should have been deprecated with. This is the same type as the
1064
parameter to deprecated_method/deprecated_function. If the
1065
callable is not deprecated with this format, an assertion error
1067
:param a_callable: A callable to call. This may be a bound method or
1068
a regular function. It will be called with ``*args`` and
1070
:param args: The positional arguments for the callable
1071
:param kwargs: The keyword arguments for the callable
1072
:return: The result of a_callable(``*args``, ``**kwargs``)
1074
call_warnings, result = self._capture_warnings(a_callable,
1076
expected_first_warning = symbol_versioning.deprecation_string(
1077
a_callable, deprecation_format)
1078
if len(call_warnings) == 0:
1079
self.fail("No deprecation warning generated by call to %s" %
1081
self.assertEqual(expected_first_warning, call_warnings[0])
1084
def callDeprecated(self, expected, callable, *args, **kwargs):
1085
"""Assert that a callable is deprecated in a particular way.
1087
This is a very precise test for unusual requirements. The
1088
applyDeprecated helper function is probably more suited for most tests
1089
as it allows you to simply specify the deprecation format being used
1090
and will ensure that that is issued for the function being called.
1092
Note that this only captures warnings raised by symbol_versioning.warn,
1093
not other callers that go direct to the warning module.
1095
:param expected: a list of the deprecation warnings expected, in order
1096
:param callable: The callable to call
1097
:param args: The positional arguments for the callable
1098
:param kwargs: The keyword arguments for the callable
1100
call_warnings, result = self._capture_warnings(callable,
1102
self.assertEqual(expected, call_warnings)
1105
def _startLogFile(self):
1106
"""Send bzr and test log messages to a temporary file.
1108
The file is removed as the test is torn down.
1110
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1111
self._log_file = os.fdopen(fileno, 'w+')
1112
self._log_nonce = bzrlib.trace.enable_test_log(self._log_file)
1113
self._log_file_name = name
1114
self.addCleanup(self._finishLogFile)
1116
def _finishLogFile(self):
1117
"""Finished with the log file.
1119
Close the file and delete it, unless setKeepLogfile was called.
1121
if self._log_file is None:
1123
bzrlib.trace.disable_test_log(self._log_nonce)
1124
self._log_file.close()
1125
self._log_file = None
1126
if not self._keep_log_file:
1127
os.remove(self._log_file_name)
1128
self._log_file_name = None
1130
def setKeepLogfile(self):
1131
"""Make the logfile not be deleted when _finishLogFile is called."""
1132
self._keep_log_file = True
1134
def addCleanup(self, callable):
1135
"""Arrange to run a callable when this case is torn down.
1137
Callables are run in the reverse of the order they are registered,
1138
ie last-in first-out.
1140
if callable in self._cleanups:
1141
raise ValueError("cleanup function %r already registered on %s"
1143
self._cleanups.append(callable)
1145
def _cleanEnvironment(self):
1147
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1148
'HOME': os.getcwd(),
1149
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1151
'BZREMAIL': None, # may still be present in the environment
1153
'BZR_PROGRESS_BAR': None,
1155
'SSH_AUTH_SOCK': None,
1159
'https_proxy': None,
1160
'HTTPS_PROXY': None,
1165
# Nobody cares about these ones AFAIK. So far at
1166
# least. If you do (care), please update this comment
1170
'BZR_REMOTE_PATH': None,
1173
self.addCleanup(self._restoreEnvironment)
1174
for name, value in new_env.iteritems():
1175
self._captureVar(name, value)
1177
def _captureVar(self, name, newvalue):
1178
"""Set an environment variable, and reset it when finished."""
1179
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1181
def _restore_debug_flags(self):
1182
debug.debug_flags.clear()
1183
debug.debug_flags.update(self._preserved_debug_flags)
1185
def _restoreEnvironment(self):
1186
for name, value in self.__old_env.iteritems():
1187
osutils.set_or_unset_env(name, value)
1189
def _restoreHooks(self):
1190
for klass, hooks in self._preserved_hooks.items():
1191
setattr(klass, 'hooks', hooks)
1193
def knownFailure(self, reason):
1194
"""This test has failed for some known reason."""
1195
raise KnownFailure(reason)
1197
def run(self, result=None):
1198
if result is None: result = self.defaultTestResult()
1199
for feature in getattr(self, '_test_needs_features', []):
1200
if not feature.available():
1201
result.startTest(self)
1202
if getattr(result, 'addNotSupported', None):
1203
result.addNotSupported(self, feature)
1205
result.addSuccess(self)
1206
result.stopTest(self)
1208
return unittest.TestCase.run(self, result)
1212
unittest.TestCase.tearDown(self)
1214
def time(self, callable, *args, **kwargs):
1215
"""Run callable and accrue the time it takes to the benchmark time.
1217
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1218
this will cause lsprofile statistics to be gathered and stored in
1221
if self._benchtime is None:
1225
if not self._gather_lsprof_in_benchmarks:
1226
return callable(*args, **kwargs)
1228
# record this benchmark
1229
ret, stats = bzrlib.lsprof.profile(callable, *args, **kwargs)
1231
self._benchcalls.append(((callable, args, kwargs), stats))
1234
self._benchtime += time.time() - start
1236
def _runCleanups(self):
1237
"""Run registered cleanup functions.
1239
This should only be called from TestCase.tearDown.
1241
# TODO: Perhaps this should keep running cleanups even if
1242
# one of them fails?
1244
# Actually pop the cleanups from the list so tearDown running
1245
# twice is safe (this happens for skipped tests).
1246
while self._cleanups:
1247
self._cleanups.pop()()
1249
def log(self, *args):
1252
def _get_log(self, keep_log_file=False):
1253
"""Get the log from bzrlib.trace calls from this test.
1255
:param keep_log_file: When True, if the log is still a file on disk
1256
leave it as a file on disk. When False, if the log is still a file
1257
on disk, the log file is deleted and the log preserved as
1259
:return: A string containing the log.
1261
# flush the log file, to get all content
1263
bzrlib.trace._trace_file.flush()
1264
if self._log_contents:
1265
return self._log_contents
1266
if self._log_file_name is not None:
1267
logfile = open(self._log_file_name)
1269
log_contents = logfile.read()
1272
if not keep_log_file:
1273
self._log_contents = log_contents
1275
os.remove(self._log_file_name)
1277
if sys.platform == 'win32' and e.errno == errno.EACCES:
1278
print >>sys.stderr, ('Unable to delete log file '
1279
' %r' % self._log_file_name)
1284
return "DELETED log file to reduce memory footprint"
1286
@deprecated_method(zero_eighteen)
1287
def capture(self, cmd, retcode=0):
1288
"""Shortcut that splits cmd into words, runs, and returns stdout"""
1289
return self.run_bzr_captured(cmd.split(), retcode=retcode)[0]
1291
def requireFeature(self, feature):
1292
"""This test requires a specific feature is available.
1294
:raises UnavailableFeature: When feature is not available.
1296
if not feature.available():
1297
raise UnavailableFeature(feature)
1299
@deprecated_method(zero_eighteen)
1300
def run_bzr_captured(self, argv, retcode=0, encoding=None, stdin=None,
1302
"""Invoke bzr and return (stdout, stderr).
1304
Don't call this method, just use run_bzr() which is equivalent.
1306
:param argv: Arguments to invoke bzr. This may be either a
1307
single string, in which case it is split by shlex into words,
1308
or a list of arguments.
1309
:param retcode: Expected return code, or None for don't-care.
1310
:param encoding: Encoding for sys.stdout and sys.stderr
1311
:param stdin: A string to be used as stdin for the command.
1312
:param working_dir: Change to this directory before running
1314
return self._run_bzr_autosplit(argv, retcode=retcode,
1315
encoding=encoding, stdin=stdin, working_dir=working_dir,
1318
def _run_bzr_autosplit(self, args, retcode, encoding, stdin,
1320
"""Run bazaar command line, splitting up a string command line."""
1321
if isinstance(args, basestring):
1322
args = list(shlex.split(args))
1323
return self._run_bzr_core(args, retcode=retcode,
1324
encoding=encoding, stdin=stdin, working_dir=working_dir,
1327
def _run_bzr_core(self, args, retcode, encoding, stdin,
1329
if encoding is None:
1330
encoding = bzrlib.user_encoding
1331
stdout = StringIOWrapper()
1332
stderr = StringIOWrapper()
1333
stdout.encoding = encoding
1334
stderr.encoding = encoding
1336
self.log('run bzr: %r', args)
1337
# FIXME: don't call into logging here
1338
handler = logging.StreamHandler(stderr)
1339
handler.setLevel(logging.INFO)
1340
logger = logging.getLogger('')
1341
logger.addHandler(handler)
1342
old_ui_factory = ui.ui_factory
1343
ui.ui_factory = TestUIFactory(stdin=stdin, stdout=stdout, stderr=stderr)
1346
if working_dir is not None:
1347
cwd = osutils.getcwd()
1348
os.chdir(working_dir)
1351
result = self.apply_redirected(ui.ui_factory.stdin,
1353
bzrlib.commands.run_bzr_catch_errors,
1356
logger.removeHandler(handler)
1357
ui.ui_factory = old_ui_factory
1361
out = stdout.getvalue()
1362
err = stderr.getvalue()
1364
self.log('output:\n%r', out)
1366
self.log('errors:\n%r', err)
1367
if retcode is not None:
1368
self.assertEquals(retcode, result,
1369
message='Unexpected return code')
1372
def run_bzr(self, *args, **kwargs):
1373
"""Invoke bzr, as if it were run from the command line.
1375
The argument list should not include the bzr program name - the
1376
first argument is normally the bzr command. Arguments may be
1377
passed in three ways:
1379
1- A list of strings, eg ["commit", "a"]. This is recommended
1380
when the command contains whitespace or metacharacters, or
1381
is built up at run time.
1383
2- A single string, eg "add a". This is the most convenient
1384
for hardcoded commands.
1386
3- Several varargs parameters, eg run_bzr("add", "a").
1387
This is not recommended for new code.
1389
This runs bzr through the interface that catches and reports
1390
errors, and with logging set to something approximating the
1391
default, so that error reporting can be checked.
1393
This should be the main method for tests that want to exercise the
1394
overall behavior of the bzr application (rather than a unit test
1395
or a functional test of the library.)
1397
This sends the stdout/stderr results into the test's log,
1398
where it may be useful for debugging. See also run_captured.
1400
:keyword stdin: A string to be used as stdin for the command.
1401
:keyword retcode: The status code the command should return;
1403
:keyword working_dir: The directory to run the command in
1404
:keyword error_regexes: A list of expected error messages. If
1405
specified they must be seen in the error output of the command.
1407
retcode = kwargs.pop('retcode', 0)
1408
encoding = kwargs.pop('encoding', None)
1409
stdin = kwargs.pop('stdin', None)
1410
working_dir = kwargs.pop('working_dir', None)
1411
error_regexes = kwargs.pop('error_regexes', [])
1414
raise TypeError("run_bzr() got unexpected keyword arguments '%s'"
1418
if isinstance(args[0], (list, basestring)):
1421
symbol_versioning.warn(zero_eighteen % "passing varargs to run_bzr",
1422
DeprecationWarning, stacklevel=3)
1424
out, err = self._run_bzr_autosplit(args=args,
1426
encoding=encoding, stdin=stdin, working_dir=working_dir,
1429
for regex in error_regexes:
1430
self.assertContainsRe(err, regex)
1433
def run_bzr_decode(self, *args, **kwargs):
1434
if 'encoding' in kwargs:
1435
encoding = kwargs['encoding']
1437
encoding = bzrlib.user_encoding
1438
return self.run_bzr(*args, **kwargs)[0].decode(encoding)
1440
def run_bzr_error(self, error_regexes, *args, **kwargs):
1441
"""Run bzr, and check that stderr contains the supplied regexes
1443
:param error_regexes: Sequence of regular expressions which
1444
must each be found in the error output. The relative ordering
1446
:param args: command-line arguments for bzr
1447
:param kwargs: Keyword arguments which are interpreted by run_bzr
1448
This function changes the default value of retcode to be 3,
1449
since in most cases this is run when you expect bzr to fail.
1451
:return: (out, err) The actual output of running the command (in case
1452
you want to do more inspection)
1456
# Make sure that commit is failing because there is nothing to do
1457
self.run_bzr_error(['no changes to commit'],
1458
['commit', '-m', 'my commit comment'])
1459
# Make sure --strict is handling an unknown file, rather than
1460
# giving us the 'nothing to do' error
1461
self.build_tree(['unknown'])
1462
self.run_bzr_error(['Commit refused because there are unknown files'],
1463
['commit', --strict', '-m', 'my commit comment'])
1465
kwargs.setdefault('retcode', 3)
1466
kwargs['error_regexes'] = error_regexes
1467
out, err = self.run_bzr(*args, **kwargs)
1470
def run_bzr_subprocess(self, *args, **kwargs):
1471
"""Run bzr in a subprocess for testing.
1473
This starts a new Python interpreter and runs bzr in there.
1474
This should only be used for tests that have a justifiable need for
1475
this isolation: e.g. they are testing startup time, or signal
1476
handling, or early startup code, etc. Subprocess code can't be
1477
profiled or debugged so easily.
1479
:keyword retcode: The status code that is expected. Defaults to 0. If
1480
None is supplied, the status code is not checked.
1481
:keyword env_changes: A dictionary which lists changes to environment
1482
variables. A value of None will unset the env variable.
1483
The values must be strings. The change will only occur in the
1484
child, so you don't need to fix the environment after running.
1485
:keyword universal_newlines: Convert CRLF => LF
1486
:keyword allow_plugins: By default the subprocess is run with
1487
--no-plugins to ensure test reproducibility. Also, it is possible
1488
for system-wide plugins to create unexpected output on stderr,
1489
which can cause unnecessary test failures.
1491
env_changes = kwargs.get('env_changes', {})
1492
working_dir = kwargs.get('working_dir', None)
1493
allow_plugins = kwargs.get('allow_plugins', False)
1495
if isinstance(args[0], list):
1497
elif isinstance(args[0], basestring):
1498
args = list(shlex.split(args[0]))
1500
symbol_versioning.warn(zero_ninetyone %
1501
"passing varargs to run_bzr_subprocess",
1502
DeprecationWarning, stacklevel=3)
1503
process = self.start_bzr_subprocess(args, env_changes=env_changes,
1504
working_dir=working_dir,
1505
allow_plugins=allow_plugins)
1506
# We distinguish between retcode=None and retcode not passed.
1507
supplied_retcode = kwargs.get('retcode', 0)
1508
return self.finish_bzr_subprocess(process, retcode=supplied_retcode,
1509
universal_newlines=kwargs.get('universal_newlines', False),
1512
def start_bzr_subprocess(self, process_args, env_changes=None,
1513
skip_if_plan_to_signal=False,
1515
allow_plugins=False):
1516
"""Start bzr in a subprocess for testing.
1518
This starts a new Python interpreter and runs bzr in there.
1519
This should only be used for tests that have a justifiable need for
1520
this isolation: e.g. they are testing startup time, or signal
1521
handling, or early startup code, etc. Subprocess code can't be
1522
profiled or debugged so easily.
1524
:param process_args: a list of arguments to pass to the bzr executable,
1525
for example ``['--version']``.
1526
:param env_changes: A dictionary which lists changes to environment
1527
variables. A value of None will unset the env variable.
1528
The values must be strings. The change will only occur in the
1529
child, so you don't need to fix the environment after running.
1530
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
1532
:param allow_plugins: If False (default) pass --no-plugins to bzr.
1534
:returns: Popen object for the started process.
1536
if skip_if_plan_to_signal:
1537
if not getattr(os, 'kill', None):
1538
raise TestSkipped("os.kill not available.")
1540
if env_changes is None:
1544
def cleanup_environment():
1545
for env_var, value in env_changes.iteritems():
1546
old_env[env_var] = osutils.set_or_unset_env(env_var, value)
1548
def restore_environment():
1549
for env_var, value in old_env.iteritems():
1550
osutils.set_or_unset_env(env_var, value)
1552
bzr_path = self.get_bzr_path()
1555
if working_dir is not None:
1556
cwd = osutils.getcwd()
1557
os.chdir(working_dir)
1560
# win32 subprocess doesn't support preexec_fn
1561
# so we will avoid using it on all platforms, just to
1562
# make sure the code path is used, and we don't break on win32
1563
cleanup_environment()
1564
command = [sys.executable, bzr_path]
1565
if not allow_plugins:
1566
command.append('--no-plugins')
1567
command.extend(process_args)
1568
process = self._popen(command, stdin=PIPE, stdout=PIPE, stderr=PIPE)
1570
restore_environment()
1576
def _popen(self, *args, **kwargs):
1577
"""Place a call to Popen.
1579
Allows tests to override this method to intercept the calls made to
1580
Popen for introspection.
1582
return Popen(*args, **kwargs)
1584
def get_bzr_path(self):
1585
"""Return the path of the 'bzr' executable for this test suite."""
1586
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
1587
if not os.path.isfile(bzr_path):
1588
# We are probably installed. Assume sys.argv is the right file
1589
bzr_path = sys.argv[0]
1592
def finish_bzr_subprocess(self, process, retcode=0, send_signal=None,
1593
universal_newlines=False, process_args=None):
1594
"""Finish the execution of process.
1596
:param process: the Popen object returned from start_bzr_subprocess.
1597
:param retcode: The status code that is expected. Defaults to 0. If
1598
None is supplied, the status code is not checked.
1599
:param send_signal: an optional signal to send to the process.
1600
:param universal_newlines: Convert CRLF => LF
1601
:returns: (stdout, stderr)
1603
if send_signal is not None:
1604
os.kill(process.pid, send_signal)
1605
out, err = process.communicate()
1607
if universal_newlines:
1608
out = out.replace('\r\n', '\n')
1609
err = err.replace('\r\n', '\n')
1611
if retcode is not None and retcode != process.returncode:
1612
if process_args is None:
1613
process_args = "(unknown args)"
1614
mutter('Output of bzr %s:\n%s', process_args, out)
1615
mutter('Error for bzr %s:\n%s', process_args, err)
1616
self.fail('Command bzr %s failed with retcode %s != %s'
1617
% (process_args, retcode, process.returncode))
1620
def check_inventory_shape(self, inv, shape):
1621
"""Compare an inventory to a list of expected names.
1623
Fail if they are not precisely equal.
1626
shape = list(shape) # copy
1627
for path, ie in inv.entries():
1628
name = path.replace('\\', '/')
1629
if ie.kind == 'directory':
1636
self.fail("expected paths not found in inventory: %r" % shape)
1638
self.fail("unexpected paths found in inventory: %r" % extras)
1640
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
1641
a_callable=None, *args, **kwargs):
1642
"""Call callable with redirected std io pipes.
1644
Returns the return code."""
1645
if not callable(a_callable):
1646
raise ValueError("a_callable must be callable.")
1648
stdin = StringIO("")
1650
if getattr(self, "_log_file", None) is not None:
1651
stdout = self._log_file
1655
if getattr(self, "_log_file", None is not None):
1656
stderr = self._log_file
1659
real_stdin = sys.stdin
1660
real_stdout = sys.stdout
1661
real_stderr = sys.stderr
1666
return a_callable(*args, **kwargs)
1668
sys.stdout = real_stdout
1669
sys.stderr = real_stderr
1670
sys.stdin = real_stdin
1672
def reduceLockdirTimeout(self):
1673
"""Reduce the default lock timeout for the duration of the test, so that
1674
if LockContention occurs during a test, it does so quickly.
1676
Tests that expect to provoke LockContention errors should call this.
1678
orig_timeout = bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS
1680
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = orig_timeout
1681
self.addCleanup(resetTimeout)
1682
bzrlib.lockdir._DEFAULT_TIMEOUT_SECONDS = 0
1684
def make_utf8_encoded_stringio(self, encoding_type=None):
1685
"""Return a StringIOWrapper instance, that will encode Unicode
1688
if encoding_type is None:
1689
encoding_type = 'strict'
1691
output_encoding = 'utf-8'
1692
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
1693
sio.encoding = output_encoding
1697
class TestCaseWithMemoryTransport(TestCase):
1698
"""Common test class for tests that do not need disk resources.
1700
Tests that need disk resources should derive from TestCaseWithTransport.
1702
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
1704
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
1705
a directory which does not exist. This serves to help ensure test isolation
1706
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
1707
must exist. However, TestCaseWithMemoryTransport does not offer local
1708
file defaults for the transport in tests, nor does it obey the command line
1709
override, so tests that accidentally write to the common directory should
1712
:cvar TEST_ROOT: Directory containing all temporary directories, plus
1713
a .bzr directory that stops us ascending higher into the filesystem.
1719
def __init__(self, methodName='runTest'):
1720
# allow test parameterisation after test construction and before test
1721
# execution. Variables that the parameteriser sets need to be
1722
# ones that are not set by setUp, or setUp will trash them.
1723
super(TestCaseWithMemoryTransport, self).__init__(methodName)
1724
self.vfs_transport_factory = default_transport
1725
self.transport_server = None
1726
self.transport_readonly_server = None
1727
self.__vfs_server = None
1729
def get_transport(self, relpath=None):
1730
"""Return a writeable transport.
1732
This transport is for the test scratch space relative to
1735
:param relpath: a path relative to the base url.
1737
t = get_transport(self.get_url(relpath))
1738
self.assertFalse(t.is_readonly())
1741
def get_readonly_transport(self, relpath=None):
1742
"""Return a readonly transport for the test scratch space
1744
This can be used to test that operations which should only need
1745
readonly access in fact do not try to write.
1747
:param relpath: a path relative to the base url.
1749
t = get_transport(self.get_readonly_url(relpath))
1750
self.assertTrue(t.is_readonly())
1753
def create_transport_readonly_server(self):
1754
"""Create a transport server from class defined at init.
1756
This is mostly a hook for daughter classes.
1758
return self.transport_readonly_server()
1760
def get_readonly_server(self):
1761
"""Get the server instance for the readonly transport
1763
This is useful for some tests with specific servers to do diagnostics.
1765
if self.__readonly_server is None:
1766
if self.transport_readonly_server is None:
1767
# readonly decorator requested
1768
# bring up the server
1769
self.__readonly_server = ReadonlyServer()
1770
self.__readonly_server.setUp(self.get_vfs_only_server())
1772
self.__readonly_server = self.create_transport_readonly_server()
1773
self.__readonly_server.setUp(self.get_vfs_only_server())
1774
self.addCleanup(self.__readonly_server.tearDown)
1775
return self.__readonly_server
1777
def get_readonly_url(self, relpath=None):
1778
"""Get a URL for the readonly transport.
1780
This will either be backed by '.' or a decorator to the transport
1781
used by self.get_url()
1782
relpath provides for clients to get a path relative to the base url.
1783
These should only be downwards relative, not upwards.
1785
base = self.get_readonly_server().get_url()
1786
return self._adjust_url(base, relpath)
1788
def get_vfs_only_server(self):
1789
"""Get the vfs only read/write server instance.
1791
This is useful for some tests with specific servers that need
1794
For TestCaseWithMemoryTransport this is always a MemoryServer, and there
1795
is no means to override it.
1797
if self.__vfs_server is None:
1798
self.__vfs_server = MemoryServer()
1799
self.__vfs_server.setUp()
1800
self.addCleanup(self.__vfs_server.tearDown)
1801
return self.__vfs_server
1803
def get_server(self):
1804
"""Get the read/write server instance.
1806
This is useful for some tests with specific servers that need
1809
This is built from the self.transport_server factory. If that is None,
1810
then the self.get_vfs_server is returned.
1812
if self.__server is None:
1813
if self.transport_server is None or self.transport_server is self.vfs_transport_factory:
1814
return self.get_vfs_only_server()
1816
# bring up a decorated means of access to the vfs only server.
1817
self.__server = self.transport_server()
1819
self.__server.setUp(self.get_vfs_only_server())
1820
except TypeError, e:
1821
# This should never happen; the try:Except here is to assist
1822
# developers having to update code rather than seeing an
1823
# uninformative TypeError.
1824
raise Exception, "Old server API in use: %s, %s" % (self.__server, e)
1825
self.addCleanup(self.__server.tearDown)
1826
return self.__server
1828
def _adjust_url(self, base, relpath):
1829
"""Get a URL (or maybe a path) for the readwrite transport.
1831
This will either be backed by '.' or to an equivalent non-file based
1833
relpath provides for clients to get a path relative to the base url.
1834
These should only be downwards relative, not upwards.
1836
if relpath is not None and relpath != '.':
1837
if not base.endswith('/'):
1839
# XXX: Really base should be a url; we did after all call
1840
# get_url()! But sometimes it's just a path (from
1841
# LocalAbspathServer), and it'd be wrong to append urlescaped data
1842
# to a non-escaped local path.
1843
if base.startswith('./') or base.startswith('/'):
1846
base += urlutils.escape(relpath)
1849
def get_url(self, relpath=None):
1850
"""Get a URL (or maybe a path) for the readwrite transport.
1852
This will either be backed by '.' or to an equivalent non-file based
1854
relpath provides for clients to get a path relative to the base url.
1855
These should only be downwards relative, not upwards.
1857
base = self.get_server().get_url()
1858
return self._adjust_url(base, relpath)
1860
def get_vfs_only_url(self, relpath=None):
1861
"""Get a URL (or maybe a path for the plain old vfs transport.
1863
This will never be a smart protocol. It always has all the
1864
capabilities of the local filesystem, but it might actually be a
1865
MemoryTransport or some other similar virtual filesystem.
1867
This is the backing transport (if any) of the server returned by
1868
get_url and get_readonly_url.
1870
:param relpath: provides for clients to get a path relative to the base
1871
url. These should only be downwards relative, not upwards.
1874
base = self.get_vfs_only_server().get_url()
1875
return self._adjust_url(base, relpath)
1877
def _make_test_root(self):
1878
if TestCaseWithMemoryTransport.TEST_ROOT is not None:
1880
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
1881
TestCaseWithMemoryTransport.TEST_ROOT = root
1883
# make a fake bzr directory there to prevent any tests propagating
1884
# up onto the source directory's real branch
1885
bzrdir.BzrDir.create_standalone_workingtree(root)
1887
# The same directory is used by all tests, and we're not specifically
1888
# told when all tests are finished. This will do.
1889
atexit.register(_rmtree_temp_dir, root)
1891
def makeAndChdirToTestDir(self):
1892
"""Create a temporary directories for this one test.
1894
This must set self.test_home_dir and self.test_dir and chdir to
1897
For TestCaseWithMemoryTransport we chdir to the TEST_ROOT for this test.
1899
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
1900
self.test_dir = TestCaseWithMemoryTransport.TEST_ROOT
1901
self.test_home_dir = self.test_dir + "/MemoryTransportMissingHomeDir"
1903
def make_branch(self, relpath, format=None):
1904
"""Create a branch on the transport at relpath."""
1905
repo = self.make_repository(relpath, format=format)
1906
return repo.bzrdir.create_branch()
1908
def make_bzrdir(self, relpath, format=None):
1910
# might be a relative or absolute path
1911
maybe_a_url = self.get_url(relpath)
1912
segments = maybe_a_url.rsplit('/', 1)
1913
t = get_transport(maybe_a_url)
1914
if len(segments) > 1 and segments[-1] not in ('', '.'):
1918
if isinstance(format, basestring):
1919
format = bzrdir.format_registry.make_bzrdir(format)
1920
return format.initialize_on_transport(t)
1921
except errors.UninitializableFormat:
1922
raise TestSkipped("Format %s is not initializable." % format)
1924
def make_repository(self, relpath, shared=False, format=None):
1925
"""Create a repository on our default transport at relpath.
1927
Note that relpath must be a relative path, not a full url.
1929
# FIXME: If you create a remoterepository this returns the underlying
1930
# real format, which is incorrect. Actually we should make sure that
1931
# RemoteBzrDir returns a RemoteRepository.
1932
# maybe mbp 20070410
1933
made_control = self.make_bzrdir(relpath, format=format)
1934
return made_control.create_repository(shared=shared)
1936
def make_branch_and_memory_tree(self, relpath, format=None):
1937
"""Create a branch on the default transport and a MemoryTree for it."""
1938
b = self.make_branch(relpath, format=format)
1939
return memorytree.MemoryTree.create_on_branch(b)
1941
def overrideEnvironmentForTesting(self):
1942
os.environ['HOME'] = self.test_home_dir
1943
os.environ['BZR_HOME'] = self.test_home_dir
1946
super(TestCaseWithMemoryTransport, self).setUp()
1947
self._make_test_root()
1948
_currentdir = os.getcwdu()
1949
def _leaveDirectory():
1950
os.chdir(_currentdir)
1951
self.addCleanup(_leaveDirectory)
1952
self.makeAndChdirToTestDir()
1953
self.overrideEnvironmentForTesting()
1954
self.__readonly_server = None
1955
self.__server = None
1956
self.reduceLockdirTimeout()
1959
class TestCaseInTempDir(TestCaseWithMemoryTransport):
1960
"""Derived class that runs a test within a temporary directory.
1962
This is useful for tests that need to create a branch, etc.
1964
The directory is created in a slightly complex way: for each
1965
Python invocation, a new temporary top-level directory is created.
1966
All test cases create their own directory within that. If the
1967
tests complete successfully, the directory is removed.
1969
:ivar test_base_dir: The path of the top-level directory for this
1970
test, which contains a home directory and a work directory.
1972
:ivar test_home_dir: An initially empty directory under test_base_dir
1973
which is used as $HOME for this test.
1975
:ivar test_dir: A directory under test_base_dir used as the current
1976
directory when the test proper is run.
1979
OVERRIDE_PYTHON = 'python'
1981
def check_file_contents(self, filename, expect):
1982
self.log("check contents of file %s" % filename)
1983
contents = file(filename, 'r').read()
1984
if contents != expect:
1985
self.log("expected: %r" % expect)
1986
self.log("actually: %r" % contents)
1987
self.fail("contents of %s not as expected" % filename)
1989
def makeAndChdirToTestDir(self):
1990
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
1992
For TestCaseInTempDir we create a temporary directory based on the test
1993
name and then create two subdirs - test and home under it.
1995
# create a directory within the top level test directory
1996
candidate_dir = osutils.mkdtemp(dir=self.TEST_ROOT)
1997
# now create test and home directories within this dir
1998
self.test_base_dir = candidate_dir
1999
self.test_home_dir = self.test_base_dir + '/home'
2000
os.mkdir(self.test_home_dir)
2001
self.test_dir = self.test_base_dir + '/work'
2002
os.mkdir(self.test_dir)
2003
os.chdir(self.test_dir)
2004
# put name of test inside
2005
f = file(self.test_base_dir + '/name', 'w')
2010
self.addCleanup(self.deleteTestDir)
2012
def deleteTestDir(self):
2013
os.chdir(self.TEST_ROOT)
2014
_rmtree_temp_dir(self.test_base_dir)
2016
def build_tree(self, shape, line_endings='binary', transport=None):
2017
"""Build a test tree according to a pattern.
2019
shape is a sequence of file specifications. If the final
2020
character is '/', a directory is created.
2022
This assumes that all the elements in the tree being built are new.
2024
This doesn't add anything to a branch.
2026
:param line_endings: Either 'binary' or 'native'
2027
in binary mode, exact contents are written in native mode, the
2028
line endings match the default platform endings.
2029
:param transport: A transport to write to, for building trees on VFS's.
2030
If the transport is readonly or None, "." is opened automatically.
2033
# It's OK to just create them using forward slashes on windows.
2034
if transport is None or transport.is_readonly():
2035
transport = get_transport(".")
2037
self.assert_(isinstance(name, basestring))
2039
transport.mkdir(urlutils.escape(name[:-1]))
2041
if line_endings == 'binary':
2043
elif line_endings == 'native':
2046
raise errors.BzrError(
2047
'Invalid line ending request %r' % line_endings)
2048
content = "contents of %s%s" % (name.encode('utf-8'), end)
2049
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2051
def build_tree_contents(self, shape):
2052
build_tree_contents(shape)
2054
def assertFileEqual(self, content, path):
2055
"""Fail if path does not contain 'content'."""
2056
self.failUnlessExists(path)
2057
f = file(path, 'rb')
2062
self.assertEqualDiff(content, s)
2064
def failUnlessExists(self, path):
2065
"""Fail unless path or paths, which may be abs or relative, exist."""
2066
if not isinstance(path, basestring):
2068
self.failUnlessExists(p)
2070
self.failUnless(osutils.lexists(path),path+" does not exist")
2072
def failIfExists(self, path):
2073
"""Fail if path or paths, which may be abs or relative, exist."""
2074
if not isinstance(path, basestring):
2076
self.failIfExists(p)
2078
self.failIf(osutils.lexists(path),path+" exists")
2080
def assertInWorkingTree(self, path, root_path='.', tree=None):
2081
"""Assert whether path or paths are in the WorkingTree"""
2083
tree = workingtree.WorkingTree.open(root_path)
2084
if not isinstance(path, basestring):
2086
self.assertInWorkingTree(p,tree=tree)
2088
self.assertIsNot(tree.path2id(path), None,
2089
path+' not in working tree.')
2091
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2092
"""Assert whether path or paths are not in the WorkingTree"""
2094
tree = workingtree.WorkingTree.open(root_path)
2095
if not isinstance(path, basestring):
2097
self.assertNotInWorkingTree(p,tree=tree)
2099
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2102
class TestCaseWithTransport(TestCaseInTempDir):
2103
"""A test case that provides get_url and get_readonly_url facilities.
2105
These back onto two transport servers, one for readonly access and one for
2108
If no explicit class is provided for readonly access, a
2109
ReadonlyTransportDecorator is used instead which allows the use of non disk
2110
based read write transports.
2112
If an explicit class is provided for readonly access, that server and the
2113
readwrite one must both define get_url() as resolving to os.getcwd().
2116
def get_vfs_only_server(self):
2117
"""See TestCaseWithMemoryTransport.
2119
This is useful for some tests with specific servers that need
2122
if self.__vfs_server is None:
2123
self.__vfs_server = self.vfs_transport_factory()
2124
self.__vfs_server.setUp()
2125
self.addCleanup(self.__vfs_server.tearDown)
2126
return self.__vfs_server
2128
def make_branch_and_tree(self, relpath, format=None):
2129
"""Create a branch on the transport and a tree locally.
2131
If the transport is not a LocalTransport, the Tree can't be created on
2132
the transport. In that case if the vfs_transport_factory is
2133
LocalURLServer the working tree is created in the local
2134
directory backing the transport, and the returned tree's branch and
2135
repository will also be accessed locally. Otherwise a lightweight
2136
checkout is created and returned.
2138
:param format: The BzrDirFormat.
2139
:returns: the WorkingTree.
2141
# TODO: always use the local disk path for the working tree,
2142
# this obviously requires a format that supports branch references
2143
# so check for that by checking bzrdir.BzrDirFormat.get_default_format()
2145
b = self.make_branch(relpath, format=format)
2147
return b.bzrdir.create_workingtree()
2148
except errors.NotLocalUrl:
2149
# We can only make working trees locally at the moment. If the
2150
# transport can't support them, then we keep the non-disk-backed
2151
# branch and create a local checkout.
2152
if self.vfs_transport_factory is LocalURLServer:
2153
# the branch is colocated on disk, we cannot create a checkout.
2154
# hopefully callers will expect this.
2155
local_controldir= bzrdir.BzrDir.open(self.get_vfs_only_url(relpath))
2156
return local_controldir.create_workingtree()
2158
return b.create_checkout(relpath, lightweight=True)
2160
def assertIsDirectory(self, relpath, transport):
2161
"""Assert that relpath within transport is a directory.
2163
This may not be possible on all transports; in that case it propagates
2164
a TransportNotPossible.
2167
mode = transport.stat(relpath).st_mode
2168
except errors.NoSuchFile:
2169
self.fail("path %s is not a directory; no such file"
2171
if not stat.S_ISDIR(mode):
2172
self.fail("path %s is not a directory; has mode %#o"
2175
def assertTreesEqual(self, left, right):
2176
"""Check that left and right have the same content and properties."""
2177
# we use a tree delta to check for equality of the content, and we
2178
# manually check for equality of other things such as the parents list.
2179
self.assertEqual(left.get_parent_ids(), right.get_parent_ids())
2180
differences = left.changes_from(right)
2181
self.assertFalse(differences.has_changed(),
2182
"Trees %r and %r are different: %r" % (left, right, differences))
2185
super(TestCaseWithTransport, self).setUp()
2186
self.__vfs_server = None
2189
class ChrootedTestCase(TestCaseWithTransport):
2190
"""A support class that provides readonly urls outside the local namespace.
2192
This is done by checking if self.transport_server is a MemoryServer. if it
2193
is then we are chrooted already, if it is not then an HttpServer is used
2196
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2197
be used without needed to redo it when a different
2198
subclass is in use ?
2202
super(ChrootedTestCase, self).setUp()
2203
if not self.vfs_transport_factory == MemoryServer:
2204
self.transport_readonly_server = HttpServer
2207
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2208
random_order=False):
2209
"""Create a test suite by filtering another one.
2211
:param suite: the source suite
2212
:param pattern: pattern that names must match
2213
:param exclude_pattern: pattern that names must not match, if any
2214
:param random_order: if True, tests in the new suite will be put in
2216
:returns: the newly created suite
2218
return sort_suite_by_re(suite, pattern, exclude_pattern,
2219
random_order, False)
2222
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2223
random_order=False, append_rest=True):
2224
"""Create a test suite by sorting another one.
2226
:param suite: the source suite
2227
:param pattern: pattern that names must match in order to go
2228
first in the new suite
2229
:param exclude_pattern: pattern that names must not match, if any
2230
:param random_order: if True, tests in the new suite will be put in
2232
:param append_rest: if False, pattern is a strict filter and not
2233
just an ordering directive
2234
:returns: the newly created suite
2238
filter_re = re.compile(pattern)
2239
if exclude_pattern is not None:
2240
exclude_re = re.compile(exclude_pattern)
2241
for test in iter_suite_tests(suite):
2243
if exclude_pattern is None or not exclude_re.search(test_id):
2244
if filter_re.search(test_id):
2249
random.shuffle(first)
2250
random.shuffle(second)
2251
return TestUtil.TestSuite(first + second)
2254
def run_suite(suite, name='test', verbose=False, pattern=".*",
2255
stop_on_failure=False,
2256
transport=None, lsprof_timed=None, bench_history=None,
2257
matching_tests_first=None,
2260
exclude_pattern=None,
2263
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2268
runner = TextTestRunner(stream=sys.stdout,
2270
verbosity=verbosity,
2271
bench_history=bench_history,
2272
list_only=list_only,
2274
runner.stop_on_failure=stop_on_failure
2275
# Initialise the random number generator and display the seed used.
2276
# We convert the seed to a long to make it reuseable across invocations.
2277
random_order = False
2278
if random_seed is not None:
2280
if random_seed == "now":
2281
random_seed = long(time.time())
2283
# Convert the seed to a long if we can
2285
random_seed = long(random_seed)
2288
runner.stream.writeln("Randomizing test order using seed %s\n" %
2290
random.seed(random_seed)
2291
# Customise the list of tests if requested
2292
if pattern != '.*' or exclude_pattern is not None or random_order:
2293
if matching_tests_first:
2294
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
2297
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2299
result = runner.run(suite)
2302
return result.wasStrictlySuccessful()
2304
return result.wasSuccessful()
2307
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
2309
test_suite_factory=None,
2312
matching_tests_first=None,
2315
exclude_pattern=None,
2318
"""Run the whole test suite under the enhanced runner"""
2319
# XXX: Very ugly way to do this...
2320
# Disable warning about old formats because we don't want it to disturb
2321
# any blackbox tests.
2322
from bzrlib import repository
2323
repository._deprecation_warning_done = True
2325
global default_transport
2326
if transport is None:
2327
transport = default_transport
2328
old_transport = default_transport
2329
default_transport = transport
2331
if test_suite_factory is None:
2332
suite = test_suite()
2334
suite = test_suite_factory()
2335
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
2336
stop_on_failure=stop_on_failure,
2337
transport=transport,
2338
lsprof_timed=lsprof_timed,
2339
bench_history=bench_history,
2340
matching_tests_first=matching_tests_first,
2341
list_only=list_only,
2342
random_seed=random_seed,
2343
exclude_pattern=exclude_pattern,
2346
default_transport = old_transport
2350
"""Build and return TestSuite for the whole of bzrlib.
2352
This function can be replaced if you need to change the default test
2353
suite on a global basis, but it is not encouraged.
2356
'bzrlib.util.tests.test_bencode',
2357
'bzrlib.tests.test__dirstate_helpers',
2358
'bzrlib.tests.test_ancestry',
2359
'bzrlib.tests.test_annotate',
2360
'bzrlib.tests.test_api',
2361
'bzrlib.tests.test_atomicfile',
2362
'bzrlib.tests.test_bad_files',
2363
'bzrlib.tests.test_branch',
2364
'bzrlib.tests.test_branchbuilder',
2365
'bzrlib.tests.test_bugtracker',
2366
'bzrlib.tests.test_bundle',
2367
'bzrlib.tests.test_bzrdir',
2368
'bzrlib.tests.test_cache_utf8',
2369
'bzrlib.tests.test_commands',
2370
'bzrlib.tests.test_commit',
2371
'bzrlib.tests.test_commit_merge',
2372
'bzrlib.tests.test_config',
2373
'bzrlib.tests.test_conflicts',
2374
'bzrlib.tests.test_counted_lock',
2375
'bzrlib.tests.test_decorators',
2376
'bzrlib.tests.test_delta',
2377
'bzrlib.tests.test_deprecated_graph',
2378
'bzrlib.tests.test_diff',
2379
'bzrlib.tests.test_dirstate',
2380
'bzrlib.tests.test_email_message',
2381
'bzrlib.tests.test_errors',
2382
'bzrlib.tests.test_escaped_store',
2383
'bzrlib.tests.test_extract',
2384
'bzrlib.tests.test_fetch',
2385
'bzrlib.tests.test_ftp_transport',
2386
'bzrlib.tests.test_generate_docs',
2387
'bzrlib.tests.test_generate_ids',
2388
'bzrlib.tests.test_globbing',
2389
'bzrlib.tests.test_gpg',
2390
'bzrlib.tests.test_graph',
2391
'bzrlib.tests.test_hashcache',
2392
'bzrlib.tests.test_help',
2393
'bzrlib.tests.test_hooks',
2394
'bzrlib.tests.test_http',
2395
'bzrlib.tests.test_http_response',
2396
'bzrlib.tests.test_https_ca_bundle',
2397
'bzrlib.tests.test_identitymap',
2398
'bzrlib.tests.test_ignores',
2399
'bzrlib.tests.test_index',
2400
'bzrlib.tests.test_info',
2401
'bzrlib.tests.test_inv',
2402
'bzrlib.tests.test_knit',
2403
'bzrlib.tests.test_lazy_import',
2404
'bzrlib.tests.test_lazy_regex',
2405
'bzrlib.tests.test_lockdir',
2406
'bzrlib.tests.test_lockable_files',
2407
'bzrlib.tests.test_log',
2408
'bzrlib.tests.test_lsprof',
2409
'bzrlib.tests.test_mail_client',
2410
'bzrlib.tests.test_memorytree',
2411
'bzrlib.tests.test_merge',
2412
'bzrlib.tests.test_merge3',
2413
'bzrlib.tests.test_merge_core',
2414
'bzrlib.tests.test_merge_directive',
2415
'bzrlib.tests.test_missing',
2416
'bzrlib.tests.test_msgeditor',
2417
'bzrlib.tests.test_multiparent',
2418
'bzrlib.tests.test_nonascii',
2419
'bzrlib.tests.test_options',
2420
'bzrlib.tests.test_osutils',
2421
'bzrlib.tests.test_osutils_encodings',
2422
'bzrlib.tests.test_pack',
2423
'bzrlib.tests.test_patch',
2424
'bzrlib.tests.test_patches',
2425
'bzrlib.tests.test_permissions',
2426
'bzrlib.tests.test_plugins',
2427
'bzrlib.tests.test_progress',
2428
'bzrlib.tests.test_reconfigure',
2429
'bzrlib.tests.test_reconcile',
2430
'bzrlib.tests.test_registry',
2431
'bzrlib.tests.test_remote',
2432
'bzrlib.tests.test_repository',
2433
'bzrlib.tests.test_revert',
2434
'bzrlib.tests.test_revision',
2435
'bzrlib.tests.test_revisionnamespaces',
2436
'bzrlib.tests.test_revisiontree',
2437
'bzrlib.tests.test_rio',
2438
'bzrlib.tests.test_sampler',
2439
'bzrlib.tests.test_selftest',
2440
'bzrlib.tests.test_setup',
2441
'bzrlib.tests.test_sftp_transport',
2442
'bzrlib.tests.test_smart',
2443
'bzrlib.tests.test_smart_add',
2444
'bzrlib.tests.test_smart_transport',
2445
'bzrlib.tests.test_smtp_connection',
2446
'bzrlib.tests.test_source',
2447
'bzrlib.tests.test_ssh_transport',
2448
'bzrlib.tests.test_status',
2449
'bzrlib.tests.test_store',
2450
'bzrlib.tests.test_strace',
2451
'bzrlib.tests.test_subsume',
2452
'bzrlib.tests.test_symbol_versioning',
2453
'bzrlib.tests.test_tag',
2454
'bzrlib.tests.test_testament',
2455
'bzrlib.tests.test_textfile',
2456
'bzrlib.tests.test_textmerge',
2457
'bzrlib.tests.test_timestamp',
2458
'bzrlib.tests.test_trace',
2459
'bzrlib.tests.test_transactions',
2460
'bzrlib.tests.test_transform',
2461
'bzrlib.tests.test_transport',
2462
'bzrlib.tests.test_tree',
2463
'bzrlib.tests.test_treebuilder',
2464
'bzrlib.tests.test_tsort',
2465
'bzrlib.tests.test_tuned_gzip',
2466
'bzrlib.tests.test_ui',
2467
'bzrlib.tests.test_upgrade',
2468
'bzrlib.tests.test_urlutils',
2469
'bzrlib.tests.test_versionedfile',
2470
'bzrlib.tests.test_version',
2471
'bzrlib.tests.test_version_info',
2472
'bzrlib.tests.test_weave',
2473
'bzrlib.tests.test_whitebox',
2474
'bzrlib.tests.test_win32utils',
2475
'bzrlib.tests.test_workingtree',
2476
'bzrlib.tests.test_workingtree_4',
2477
'bzrlib.tests.test_wsgi',
2478
'bzrlib.tests.test_xml',
2480
test_transport_implementations = [
2481
'bzrlib.tests.test_transport_implementations',
2482
'bzrlib.tests.test_read_bundle',
2484
suite = TestUtil.TestSuite()
2485
loader = TestUtil.TestLoader()
2486
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2487
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2488
adapter = TransportTestProviderAdapter()
2489
adapt_modules(test_transport_implementations, adapter, loader, suite)
2490
for package in packages_to_test():
2491
suite.addTest(package.test_suite())
2492
for m in MODULES_TO_TEST:
2493
suite.addTest(loader.loadTestsFromModule(m))
2494
for m in MODULES_TO_DOCTEST:
2496
suite.addTest(doctest.DocTestSuite(m))
2497
except ValueError, e:
2498
print '**failed to get doctest for: %s\n%s' %(m,e)
2500
default_encoding = sys.getdefaultencoding()
2501
for name, plugin in bzrlib.plugin.plugins().items():
2503
plugin_suite = plugin.test_suite()
2504
except ImportError, e:
2505
bzrlib.trace.warning(
2506
'Unable to test plugin "%s": %s', name, e)
2508
if plugin_suite is not None:
2509
suite.addTest(plugin_suite)
2510
if default_encoding != sys.getdefaultencoding():
2511
bzrlib.trace.warning(
2512
'Plugin "%s" tried to reset default encoding to: %s', name,
2513
sys.getdefaultencoding())
2515
sys.setdefaultencoding(default_encoding)
2519
def multiply_tests_from_modules(module_name_list, scenario_iter):
2520
"""Adapt all tests in some given modules to given scenarios.
2522
This is the recommended public interface for test parameterization.
2523
Typically the test_suite() method for a per-implementation test
2524
suite will call multiply_tests_from_modules and return the
2527
:param module_name_list: List of fully-qualified names of test
2529
:param scenario_iter: Iterable of pairs of (scenario_name,
2530
scenario_param_dict).
2532
This returns a new TestSuite containing the cross product of
2533
all the tests in all the modules, each repeated for each scenario.
2534
Each test is adapted by adding the scenario name at the end
2535
of its name, and updating the test object's __dict__ with the
2536
scenario_param_dict.
2538
>>> r = multiply_tests_from_modules(
2539
... ['bzrlib.tests.test_sampler'],
2540
... [('one', dict(param=1)),
2541
... ('two', dict(param=2))])
2542
>>> tests = list(iter_suite_tests(r))
2546
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
2552
loader = TestLoader()
2554
adapter = TestScenarioApplier()
2555
adapter.scenarios = list(scenario_iter)
2556
adapt_modules(module_name_list, adapter, loader, suite)
2560
def adapt_modules(mods_list, adapter, loader, suite):
2561
"""Adapt the modules in mods_list using adapter and add to suite."""
2562
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2563
suite.addTests(adapter.adapt(test))
2566
def _rmtree_temp_dir(dirname):
2567
# If LANG=C we probably have created some bogus paths
2568
# which rmtree(unicode) will fail to delete
2569
# so make sure we are using rmtree(str) to delete everything
2570
# except on win32, where rmtree(str) will fail
2571
# since it doesn't have the property of byte-stream paths
2572
# (they are either ascii or mbcs)
2573
if sys.platform == 'win32':
2574
# make sure we are using the unicode win32 api
2575
dirname = unicode(dirname)
2577
dirname = dirname.encode(sys.getfilesystemencoding())
2579
osutils.rmtree(dirname)
2581
if sys.platform == 'win32' and e.errno == errno.EACCES:
2582
print >>sys.stderr, ('Permission denied: '
2583
'unable to remove testing dir '
2584
'%s' % os.path.basename(dirname))
2589
class Feature(object):
2590
"""An operating system Feature."""
2593
self._available = None
2595
def available(self):
2596
"""Is the feature available?
2598
:return: True if the feature is available.
2600
if self._available is None:
2601
self._available = self._probe()
2602
return self._available
2605
"""Implement this method in concrete features.
2607
:return: True if the feature is available.
2609
raise NotImplementedError
2612
if getattr(self, 'feature_name', None):
2613
return self.feature_name()
2614
return self.__class__.__name__
2617
class _SymlinkFeature(Feature):
2620
return osutils.has_symlinks()
2622
def feature_name(self):
2625
SymlinkFeature = _SymlinkFeature()
2628
class TestScenarioApplier(object):
2629
"""A tool to apply scenarios to tests."""
2631
def adapt(self, test):
2632
"""Return a TestSuite containing a copy of test for each scenario."""
2633
result = unittest.TestSuite()
2634
for scenario in self.scenarios:
2635
result.addTest(self.adapt_test_to_scenario(test, scenario))
2638
def adapt_test_to_scenario(self, test, scenario):
2639
"""Copy test and apply scenario to it.
2641
:param test: A test to adapt.
2642
:param scenario: A tuple describing the scenarion.
2643
The first element of the tuple is the new test id.
2644
The second element is a dict containing attributes to set on the
2646
:return: The adapted test.
2648
from copy import deepcopy
2649
new_test = deepcopy(test)
2650
for name, value in scenario[1].items():
2651
setattr(new_test, name, value)
2652
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2653
new_test.id = lambda: new_id
2657
def probe_unicode_in_user_encoding():
2658
"""Try to encode several unicode strings to use in unicode-aware tests.
2659
Return first successfull match.
2661
:return: (unicode value, encoded plain string value) or (None, None)
2663
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
2664
for uni_val in possible_vals:
2666
str_val = uni_val.encode(bzrlib.user_encoding)
2667
except UnicodeEncodeError:
2668
# Try a different character
2671
return uni_val, str_val
added
removed
bzrlib/tests/__init__.py
