598
549
bench_history=None,
600
result_decorators=None,
602
"""Create a TextTestRunner.
604
:param result_decorators: An optional list of decorators to apply
605
to the result object being used by the runner. Decorators are
606
applied left to right - the first element in the list is the
609
# stream may know claim to know to write unicode strings, but in older
610
# pythons this goes sufficiently wrong that it is a bad idea. (
611
# specifically a built in file with encoding 'UTF-8' will still try
612
# to encode using ascii.
613
new_encoding = osutils.get_terminal_encoding()
614
codec = codecs.lookup(new_encoding)
615
if type(codec) is tuple:
619
encode = codec.encode
620
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
621
stream.encoding = new_encoding
622
552
self.stream = unittest._WritelnDecorator(stream)
623
553
self.descriptions = descriptions
624
554
self.verbosity = verbosity
625
555
self._bench_history = bench_history
626
self._strict = strict
627
self._result_decorators = result_decorators or []
556
self.list_only = list_only
629
558
def run(self, test):
630
559
"Run the given test case or test suite."
560
startTime = time.time()
631
561
if self.verbosity == 1:
632
562
result_class = TextTestResult
633
563
elif self.verbosity >= 2:
634
564
result_class = VerboseTestResult
635
original_result = result_class(self.stream,
565
result = result_class(self.stream,
636
566
self.descriptions,
638
568
bench_history=self._bench_history,
569
num_tests=test.countTestCases(),
641
# Signal to result objects that look at stop early policy to stop,
642
original_result.stop_early = self.stop_on_failure
643
result = original_result
644
for decorator in self._result_decorators:
645
result = decorator(result)
646
result.stop_early = self.stop_on_failure
647
result.startTestRun()
571
result.stop_early = self.stop_on_failure
572
result.report_starting()
574
if self.verbosity >= 2:
575
self.stream.writeln("Listing tests only ...\n")
577
for t in iter_suite_tests(test):
578
self.stream.writeln("%s" % (t.id()))
580
actionTaken = "Listed"
652
# higher level code uses our extended protocol to determine
653
# what exit code to give.
654
return original_result
583
run = result.testsRun
585
stopTime = time.time()
586
timeTaken = stopTime - startTime
588
self.stream.writeln(result.separator2)
589
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
590
run, run != 1 and "s" or "", timeTaken))
591
self.stream.writeln()
592
if not result.wasSuccessful():
593
self.stream.write("FAILED (")
594
failed, errored = map(len, (result.failures, result.errors))
596
self.stream.write("failures=%d" % failed)
598
if failed: self.stream.write(", ")
599
self.stream.write("errors=%d" % errored)
600
if result.known_failure_count:
601
if failed or errored: self.stream.write(", ")
602
self.stream.write("known_failure_count=%d" %
603
result.known_failure_count)
604
self.stream.writeln(")")
606
if result.known_failure_count:
607
self.stream.writeln("OK (known_failures=%d)" %
608
result.known_failure_count)
610
self.stream.writeln("OK")
611
if result.skip_count > 0:
612
skipped = result.skip_count
613
self.stream.writeln('%d test%s skipped' %
614
(skipped, skipped != 1 and "s" or ""))
615
if result.unsupported:
616
for feature, count in sorted(result.unsupported.items()):
617
self.stream.writeln("Missing feature '%s' skipped %d tests." %
657
623
def iter_suite_tests(suite):
658
624
"""Return all tests in a suite, recursing through nested suites"""
659
if isinstance(suite, unittest.TestCase):
661
elif isinstance(suite, unittest.TestSuite):
625
for item in suite._tests:
626
if isinstance(item, unittest.TestCase):
628
elif isinstance(item, unittest.TestSuite):
663
629
for r in iter_suite_tests(item):
666
raise Exception('unknown type %r for object %r'
667
% (type(suite), suite))
670
TestSkipped = testtools.testcase.TestSkipped
632
raise Exception('unknown object %r inside test suite %r'
636
class TestSkipped(Exception):
637
"""Indicates that a test was intentionally skipped, rather than failing."""
673
640
class TestNotApplicable(TestSkipped):
674
641
"""A test is not applicable to the situation where it was run.
676
This is only normally raised by parameterized tests, if they find that
677
the instance they're constructed upon does not support one aspect
643
This is only normally raised by parameterized tests, if they find that
644
the instance they're constructed upon does not support one aspect
678
645
of its interface.
682
# traceback._some_str fails to format exceptions that have the default
683
# __str__ which does an implicit ascii conversion. However, repr() on those
684
# objects works, for all that its not quite what the doctor may have ordered.
685
def _clever_some_str(value):
690
return repr(value).replace('\\n', '\n')
692
return '<unprintable %s object>' % type(value).__name__
694
traceback._some_str = _clever_some_str
697
# deprecated - use self.knownFailure(), or self.expectFailure.
698
KnownFailure = testtools.testcase._ExpectedFailure
649
class KnownFailure(AssertionError):
650
"""Indicates that a test failed in a precisely expected manner.
652
Such failures dont block the whole test suite from passing because they are
653
indicators of partially completed code or of future work. We have an
654
explicit error for them so that we can ensure that they are always visible:
655
KnownFailures are always shown in the output of bzr selftest.
701
659
class UnavailableFeature(Exception):
702
660
"""A feature required for this test was not available.
704
This can be considered a specialised form of SkippedTest.
706
662
The feature should be used to construct the exception.
666
class CommandFailed(Exception):
710
670
class StringIOWrapper(object):
711
671
"""A wrapper around cStringIO which just adds an encoding attribute.
713
673
Internally we can check sys.stdout to see what the output encoding
714
674
should be. However, cStringIO has no encoding attribute that we can
715
675
set. So we wrap it instead.
784
769
retrieved by _get_log(). We use a real OS file, not an in-memory object,
785
770
so that it can also capture file IO. When the test completes this file
786
771
is read into memory and removed from disk.
788
773
There are also convenience functions to invoke bzr's command-line
789
774
routine, and to build and check bzr trees.
791
776
In addition to the usual method of overriding tearDown(), this class also
792
777
allows subclasses to register functions into the _cleanups list, which is
793
778
run in order as the object is torn down. It's less likely this will be
794
779
accidentally overlooked.
797
_active_threads = None
798
_leaking_threads_tests = 0
799
_first_thread_leaker_id = None
800
782
_log_file_name = None
784
_keep_log_file = False
801
785
# record lsprof data when performing benchmark calls.
802
786
_gather_lsprof_in_benchmarks = False
787
attrs_to_keep = ('_testMethodName', '_testMethodDoc',
788
'_log_contents', '_log_file_name', '_benchtime',
789
'_TestCase__testMethodName')
804
791
def __init__(self, methodName='testMethod'):
805
792
super(TestCase, self).__init__(methodName)
806
793
self._cleanups = []
807
self._directory_isolation = True
808
self.exception_handlers.insert(0,
809
(UnavailableFeature, self._do_unsupported_or_skip))
810
self.exception_handlers.insert(0,
811
(TestNotApplicable, self._do_not_applicable))
814
super(TestCase, self).setUp()
815
for feature in getattr(self, '_test_needs_features', []):
816
self.requireFeature(feature)
817
self._log_contents = None
818
self.addDetail("log", content.Content(content.ContentType("text",
819
"plain", {"charset": "utf8"}),
820
lambda:[self._get_log(keep_log_file=True)]))
796
unittest.TestCase.setUp(self)
821
797
self._cleanEnvironment()
822
798
self._silenceUI()
823
799
self._startLogFile()
824
800
self._benchcalls = []
825
801
self._benchtime = None
826
802
self._clear_hooks()
827
self._track_transports()
829
803
self._clear_debug_flags()
830
TestCase._active_threads = threading.activeCount()
831
self.addCleanup(self._check_leaked_threads)
836
pdb.Pdb().set_trace(sys._getframe().f_back)
838
def _check_leaked_threads(self):
839
active = threading.activeCount()
840
leaked_threads = active - TestCase._active_threads
841
TestCase._active_threads = active
842
# If some tests make the number of threads *decrease*, we'll consider
843
# that they are just observing old threads dieing, not agressively kill
844
# random threads. So we don't report these tests as leaking. The risk
845
# is that we have false positives that way (the test see 2 threads
846
# going away but leak one) but it seems less likely than the actual
847
# false positives (the test see threads going away and does not leak).
848
if leaked_threads > 0:
849
TestCase._leaking_threads_tests += 1
850
if TestCase._first_thread_leaker_id is None:
851
TestCase._first_thread_leaker_id = self.id()
853
805
def _clear_debug_flags(self):
854
806
"""Prevent externally set debug flags affecting tests.
856
808
Tests that want to use debug flags can just set them in the
857
809
debug_flags set during setup/teardown.
859
# Start with a copy of the current debug flags we can safely modify.
860
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
861
if 'allow_debug' not in selftest_debug_flags:
811
if 'selftest_debug' not in debug.debug_flags:
812
self._preserved_debug_flags = set(debug.debug_flags)
862
813
debug.debug_flags.clear()
863
if 'disable_lock_checks' not in selftest_debug_flags:
864
debug.debug_flags.add('strict_locks')
814
self.addCleanup(self._restore_debug_flags)
866
816
def _clear_hooks(self):
867
817
# prevent hooks affecting tests
868
self._preserved_hooks = {}
869
for key, factory in hooks.known_hooks.items():
870
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
871
current_hooks = hooks.known_hooks_key_to_object(key)
872
self._preserved_hooks[parent] = (name, current_hooks)
819
import bzrlib.smart.server
820
self._preserved_hooks = {
821
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
822
bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
823
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
873
825
self.addCleanup(self._restoreHooks)
874
for key, factory in hooks.known_hooks.items():
875
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
876
setattr(parent, name, factory())
877
# this hook should always be installed
878
request._install_hook()
880
def disable_directory_isolation(self):
881
"""Turn off directory isolation checks."""
882
self._directory_isolation = False
884
def enable_directory_isolation(self):
885
"""Enable directory isolation checks."""
886
self._directory_isolation = True
826
# reset all hooks to an empty instance of the appropriate type
827
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
828
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
888
830
def _silenceUI(self):
889
831
"""Turn off UI for duration of test"""
890
832
# by default the UI is off; tests can turn it on if they want it.
891
self.overrideAttr(ui, 'ui_factory', ui.SilentUIFactory())
893
def _check_locks(self):
894
"""Check that all lock take/release actions have been paired."""
895
# We always check for mismatched locks. If a mismatch is found, we
896
# fail unless -Edisable_lock_checks is supplied to selftest, in which
897
# case we just print a warning.
899
acquired_locks = [lock for action, lock in self._lock_actions
900
if action == 'acquired']
901
released_locks = [lock for action, lock in self._lock_actions
902
if action == 'released']
903
broken_locks = [lock for action, lock in self._lock_actions
904
if action == 'broken']
905
# trivially, given the tests for lock acquistion and release, if we
906
# have as many in each list, it should be ok. Some lock tests also
907
# break some locks on purpose and should be taken into account by
908
# considering that breaking a lock is just a dirty way of releasing it.
909
if len(acquired_locks) != (len(released_locks) + len(broken_locks)):
910
message = ('Different number of acquired and '
911
'released or broken locks. (%s, %s + %s)' %
912
(acquired_locks, released_locks, broken_locks))
913
if not self._lock_check_thorough:
914
# Rather than fail, just warn
915
print "Broken test %s: %s" % (self, message)
919
def _track_locks(self):
920
"""Track lock activity during tests."""
921
self._lock_actions = []
922
if 'disable_lock_checks' in selftest_debug_flags:
923
self._lock_check_thorough = False
925
self._lock_check_thorough = True
927
self.addCleanup(self._check_locks)
928
_mod_lock.Lock.hooks.install_named_hook('lock_acquired',
929
self._lock_acquired, None)
930
_mod_lock.Lock.hooks.install_named_hook('lock_released',
931
self._lock_released, None)
932
_mod_lock.Lock.hooks.install_named_hook('lock_broken',
933
self._lock_broken, None)
935
def _lock_acquired(self, result):
936
self._lock_actions.append(('acquired', result))
938
def _lock_released(self, result):
939
self._lock_actions.append(('released', result))
941
def _lock_broken(self, result):
942
self._lock_actions.append(('broken', result))
944
def permit_dir(self, name):
945
"""Permit a directory to be used by this test. See permit_url."""
946
name_transport = get_transport(name)
947
self.permit_url(name)
948
self.permit_url(name_transport.base)
950
def permit_url(self, url):
951
"""Declare that url is an ok url to use in this test.
953
Do this for memory transports, temporary test directory etc.
955
Do not do this for the current working directory, /tmp, or any other
956
preexisting non isolated url.
958
if not url.endswith('/'):
960
self._bzr_selftest_roots.append(url)
962
def permit_source_tree_branch_repo(self):
963
"""Permit the source tree bzr is running from to be opened.
965
Some code such as bzrlib.version attempts to read from the bzr branch
966
that bzr is executing from (if any). This method permits that directory
967
to be used in the test suite.
969
path = self.get_source_path()
970
self.record_directory_isolation()
973
workingtree.WorkingTree.open(path)
974
except (errors.NotBranchError, errors.NoWorkingTree):
977
self.enable_directory_isolation()
979
def _preopen_isolate_transport(self, transport):
980
"""Check that all transport openings are done in the test work area."""
981
while isinstance(transport, pathfilter.PathFilteringTransport):
982
# Unwrap pathfiltered transports
983
transport = transport.server.backing_transport.clone(
984
transport._filter('.'))
986
# ReadonlySmartTCPServer_for_testing decorates the backing transport
987
# urls it is given by prepending readonly+. This is appropriate as the
988
# client shouldn't know that the server is readonly (or not readonly).
989
# We could register all servers twice, with readonly+ prepending, but
990
# that makes for a long list; this is about the same but easier to
992
if url.startswith('readonly+'):
993
url = url[len('readonly+'):]
994
self._preopen_isolate_url(url)
996
def _preopen_isolate_url(self, url):
997
if not self._directory_isolation:
999
if self._directory_isolation == 'record':
1000
self._bzr_selftest_roots.append(url)
1002
# This prevents all transports, including e.g. sftp ones backed on disk
1003
# from working unless they are explicitly granted permission. We then
1004
# depend on the code that sets up test transports to check that they are
1005
# appropriately isolated and enable their use by calling
1006
# self.permit_transport()
1007
if not osutils.is_inside_any(self._bzr_selftest_roots, url):
1008
raise errors.BzrError("Attempt to escape test isolation: %r %r"
1009
% (url, self._bzr_selftest_roots))
1011
def record_directory_isolation(self):
1012
"""Gather accessed directories to permit later access.
1014
This is used for tests that access the branch bzr is running from.
1016
self._directory_isolation = "record"
1018
def start_server(self, transport_server, backing_server=None):
1019
"""Start transport_server for this test.
1021
This starts the server, registers a cleanup for it and permits the
1022
server's urls to be used.
1024
if backing_server is None:
1025
transport_server.start_server()
1027
transport_server.start_server(backing_server)
1028
self.addCleanup(transport_server.stop_server)
1029
# Obtain a real transport because if the server supplies a password, it
1030
# will be hidden from the base on the client side.
1031
t = get_transport(transport_server.get_url())
1032
# Some transport servers effectively chroot the backing transport;
1033
# others like SFTPServer don't - users of the transport can walk up the
1034
# transport to read the entire backing transport. This wouldn't matter
1035
# except that the workdir tests are given - and that they expect the
1036
# server's url to point at - is one directory under the safety net. So
1037
# Branch operations into the transport will attempt to walk up one
1038
# directory. Chrooting all servers would avoid this but also mean that
1039
# we wouldn't be testing directly against non-root urls. Alternatively
1040
# getting the test framework to start the server with a backing server
1041
# at the actual safety net directory would work too, but this then
1042
# means that the self.get_url/self.get_transport methods would need
1043
# to transform all their results. On balance its cleaner to handle it
1044
# here, and permit a higher url when we have one of these transports.
1045
if t.base.endswith('/work/'):
1046
# we have safety net/test root/work
1047
t = t.clone('../..')
1048
elif isinstance(transport_server,
1049
test_server.SmartTCPServer_for_testing):
1050
# The smart server adds a path similar to work, which is traversed
1051
# up from by the client. But the server is chrooted - the actual
1052
# backing transport is not escaped from, and VFS requests to the
1053
# root will error (because they try to escape the chroot).
1055
while t2.base != t.base:
1058
self.permit_url(t.base)
1060
def _track_transports(self):
1061
"""Install checks for transport usage."""
1062
# TestCase has no safe place it can write to.
1063
self._bzr_selftest_roots = []
1064
# Currently the easiest way to be sure that nothing is going on is to
1065
# hook into bzr dir opening. This leaves a small window of error for
1066
# transport tests, but they are well known, and we can improve on this
1068
bzrdir.BzrDir.hooks.install_named_hook("pre_open",
1069
self._preopen_isolate_transport, "Check bzr directories are safe.")
833
saved = ui.ui_factory
835
ui.ui_factory = saved
836
ui.ui_factory = ui.SilentUIFactory()
837
self.addCleanup(_restore)
1071
839
def _ndiff_strings(self, a, b):
1072
840
"""Return ndiff between two strings containing lines.
1074
842
A trailing newline is added if missing to make the strings
1075
843
print properly."""
1076
844
if b and b[-1] != '\n':
2927
2461
list_only=False,
2928
2462
random_seed=None,
2929
2463
exclude_pattern=None,
2932
suite_decorators=None,
2934
result_decorators=None,
2936
"""Run a test suite for bzr selftest.
2938
:param runner_class: The class of runner to use. Must support the
2939
constructor arguments passed by run_suite which are more than standard
2941
:return: A boolean indicating success.
2943
2465
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2948
if runner_class is None:
2949
runner_class = TextTestRunner
2952
runner = runner_class(stream=stream,
2470
runner = TextTestRunner(stream=sys.stdout,
2953
2471
descriptions=0,
2954
2472
verbosity=verbosity,
2955
2473
bench_history=bench_history,
2957
result_decorators=result_decorators,
2474
list_only=list_only,
2959
2476
runner.stop_on_failure=stop_on_failure
2960
# built in decorator factories:
2962
random_order(random_seed, runner),
2963
exclude_tests(exclude_pattern),
2965
if matching_tests_first:
2966
decorators.append(tests_first(pattern))
2477
# Initialise the random number generator and display the seed used.
2478
# We convert the seed to a long to make it reuseable across invocations.
2479
random_order = False
2480
if random_seed is not None:
2482
if random_seed == "now":
2483
random_seed = long(time.time())
2485
# Convert the seed to a long if we can
2487
random_seed = long(random_seed)
2490
runner.stream.writeln("Randomizing test order using seed %s\n" %
2492
random.seed(random_seed)
2493
# Customise the list of tests if requested
2494
if exclude_pattern is not None:
2495
suite = exclude_tests_by_re(suite, exclude_pattern)
2497
order_changer = randomize_suite
2968
decorators.append(filter_tests(pattern))
2969
if suite_decorators:
2970
decorators.extend(suite_decorators)
2971
# tell the result object how many tests will be running: (except if
2972
# --parallel=fork is being used. Robert said he will provide a better
2973
# progress design later -- vila 20090817)
2974
if fork_decorator not in decorators:
2975
decorators.append(CountingDecorator)
2976
for decorator in decorators:
2977
suite = decorator(suite)
2979
# Done after test suite decoration to allow randomisation etc
2980
# to take effect, though that is of marginal benefit.
2982
stream.write("Listing tests only ...\n")
2983
for t in iter_suite_tests(suite):
2984
stream.write("%s\n" % (t.id()))
2499
order_changer = preserve_input
2500
if pattern != '.*' or random_order:
2501
if matching_tests_first:
2502
suites = map(order_changer, split_suite_by_re(suite, pattern))
2503
suite = TestUtil.TestSuite(suites)
2505
suite = order_changer(filter_suite_by_re(suite, pattern))
2986
2507
result = runner.run(suite)
2988
2510
return result.wasStrictlySuccessful()
2990
return result.wasSuccessful()
2993
# A registry where get() returns a suite decorator.
2994
parallel_registry = registry.Registry()
2997
def fork_decorator(suite):
2998
concurrency = osutils.local_concurrency()
2999
if concurrency == 1:
3001
from testtools import ConcurrentTestSuite
3002
return ConcurrentTestSuite(suite, fork_for_tests)
3003
parallel_registry.register('fork', fork_decorator)
3006
def subprocess_decorator(suite):
3007
concurrency = osutils.local_concurrency()
3008
if concurrency == 1:
3010
from testtools import ConcurrentTestSuite
3011
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3012
parallel_registry.register('subprocess', subprocess_decorator)
3015
def exclude_tests(exclude_pattern):
3016
"""Return a test suite decorator that excludes tests."""
3017
if exclude_pattern is None:
3018
return identity_decorator
3019
def decorator(suite):
3020
return ExcludeDecorator(suite, exclude_pattern)
3024
def filter_tests(pattern):
3026
return identity_decorator
3027
def decorator(suite):
3028
return FilterTestsDecorator(suite, pattern)
3032
def random_order(random_seed, runner):
3033
"""Return a test suite decorator factory for randomising tests order.
3035
:param random_seed: now, a string which casts to a long, or a long.
3036
:param runner: A test runner with a stream attribute to report on.
3038
if random_seed is None:
3039
return identity_decorator
3040
def decorator(suite):
3041
return RandomDecorator(suite, random_seed, runner.stream)
3045
def tests_first(pattern):
3047
return identity_decorator
3048
def decorator(suite):
3049
return TestFirstDecorator(suite, pattern)
3053
def identity_decorator(suite):
3058
class TestDecorator(TestSuite):
3059
"""A decorator for TestCase/TestSuite objects.
3061
Usually, subclasses should override __iter__(used when flattening test
3062
suites), which we do to filter, reorder, parallelise and so on, run() and
3066
def __init__(self, suite):
3067
TestSuite.__init__(self)
3070
def countTestCases(self):
3073
cases += test.countTestCases()
3080
def run(self, result):
3081
# Use iteration on self, not self._tests, to allow subclasses to hook
3084
if result.shouldStop:
3090
class CountingDecorator(TestDecorator):
3091
"""A decorator which calls result.progress(self.countTestCases)."""
3093
def run(self, result):
3094
progress_method = getattr(result, 'progress', None)
3095
if callable(progress_method):
3096
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3097
return super(CountingDecorator, self).run(result)
3100
class ExcludeDecorator(TestDecorator):
3101
"""A decorator which excludes test matching an exclude pattern."""
3103
def __init__(self, suite, exclude_pattern):
3104
TestDecorator.__init__(self, suite)
3105
self.exclude_pattern = exclude_pattern
3106
self.excluded = False
3110
return iter(self._tests)
3111
self.excluded = True
3112
suite = exclude_tests_by_re(self, self.exclude_pattern)
3114
self.addTests(suite)
3115
return iter(self._tests)
3118
class FilterTestsDecorator(TestDecorator):
3119
"""A decorator which filters tests to those matching a pattern."""
3121
def __init__(self, suite, pattern):
3122
TestDecorator.__init__(self, suite)
3123
self.pattern = pattern
3124
self.filtered = False
3128
return iter(self._tests)
3129
self.filtered = True
3130
suite = filter_suite_by_re(self, self.pattern)
3132
self.addTests(suite)
3133
return iter(self._tests)
3136
class RandomDecorator(TestDecorator):
3137
"""A decorator which randomises the order of its tests."""
3139
def __init__(self, suite, random_seed, stream):
3140
TestDecorator.__init__(self, suite)
3141
self.random_seed = random_seed
3142
self.randomised = False
3143
self.stream = stream
3147
return iter(self._tests)
3148
self.randomised = True
3149
self.stream.write("Randomizing test order using seed %s\n\n" %
3150
(self.actual_seed()))
3151
# Initialise the random number generator.
3152
random.seed(self.actual_seed())
3153
suite = randomize_suite(self)
3155
self.addTests(suite)
3156
return iter(self._tests)
3158
def actual_seed(self):
3159
if self.random_seed == "now":
3160
# We convert the seed to a long to make it reuseable across
3161
# invocations (because the user can reenter it).
3162
self.random_seed = long(time.time())
3164
# Convert the seed to a long if we can
3166
self.random_seed = long(self.random_seed)
3169
return self.random_seed
3172
class TestFirstDecorator(TestDecorator):
3173
"""A decorator which moves named tests to the front."""
3175
def __init__(self, suite, pattern):
3176
TestDecorator.__init__(self, suite)
3177
self.pattern = pattern
3178
self.filtered = False
3182
return iter(self._tests)
3183
self.filtered = True
3184
suites = split_suite_by_re(self, self.pattern)
3186
self.addTests(suites)
3187
return iter(self._tests)
3190
def partition_tests(suite, count):
3191
"""Partition suite into count lists of tests."""
3193
tests = list(iter_suite_tests(suite))
3194
tests_per_process = int(math.ceil(float(len(tests)) / count))
3195
for block in range(count):
3196
low_test = block * tests_per_process
3197
high_test = low_test + tests_per_process
3198
process_tests = tests[low_test:high_test]
3199
result.append(process_tests)
3203
def workaround_zealous_crypto_random():
3204
"""Crypto.Random want to help us being secure, but we don't care here.
3206
This workaround some test failure related to the sftp server. Once paramiko
3207
stop using the controversial API in Crypto.Random, we may get rid of it.
3210
from Crypto.Random import atfork
3216
def fork_for_tests(suite):
3217
"""Take suite and start up one runner per CPU by forking()
3219
:return: An iterable of TestCase-like objects which can each have
3220
run(result) called on them to feed tests to result.
3222
concurrency = osutils.local_concurrency()
3224
from subunit import TestProtocolClient, ProtocolTestCase
3225
from subunit.test_results import AutoTimingTestResultDecorator
3226
class TestInOtherProcess(ProtocolTestCase):
3227
# Should be in subunit, I think. RBC.
3228
def __init__(self, stream, pid):
3229
ProtocolTestCase.__init__(self, stream)
3232
def run(self, result):
3234
ProtocolTestCase.run(self, result)
3236
os.waitpid(self.pid, 0)
3238
test_blocks = partition_tests(suite, concurrency)
3239
for process_tests in test_blocks:
3240
process_suite = TestSuite()
3241
process_suite.addTests(process_tests)
3242
c2pread, c2pwrite = os.pipe()
3245
workaround_zealous_crypto_random()
3248
# Leave stderr and stdout open so we can see test noise
3249
# Close stdin so that the child goes away if it decides to
3250
# read from stdin (otherwise its a roulette to see what
3251
# child actually gets keystrokes for pdb etc).
3254
stream = os.fdopen(c2pwrite, 'wb', 1)
3255
subunit_result = AutoTimingTestResultDecorator(
3256
TestProtocolClient(stream))
3257
process_suite.run(subunit_result)
3262
stream = os.fdopen(c2pread, 'rb', 1)
3263
test = TestInOtherProcess(stream, pid)
3268
def reinvoke_for_tests(suite):
3269
"""Take suite and start up one runner per CPU using subprocess().
3271
:return: An iterable of TestCase-like objects which can each have
3272
run(result) called on them to feed tests to result.
3274
concurrency = osutils.local_concurrency()
3276
from subunit import ProtocolTestCase
3277
class TestInSubprocess(ProtocolTestCase):
3278
def __init__(self, process, name):
3279
ProtocolTestCase.__init__(self, process.stdout)
3280
self.process = process
3281
self.process.stdin.close()
3284
def run(self, result):
3286
ProtocolTestCase.run(self, result)
3289
os.unlink(self.name)
3290
# print "pid %d finished" % finished_process
3291
test_blocks = partition_tests(suite, concurrency)
3292
for process_tests in test_blocks:
3293
# ugly; currently reimplement rather than reuses TestCase methods.
3294
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3295
if not os.path.isfile(bzr_path):
3296
# We are probably installed. Assume sys.argv is the right file
3297
bzr_path = sys.argv[0]
3298
bzr_path = [bzr_path]
3299
if sys.platform == "win32":
3300
# if we're on windows, we can't execute the bzr script directly
3301
bzr_path = [sys.executable] + bzr_path
3302
fd, test_list_file_name = tempfile.mkstemp()
3303
test_list_file = os.fdopen(fd, 'wb', 1)
3304
for test in process_tests:
3305
test_list_file.write(test.id() + '\n')
3306
test_list_file.close()
3308
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3310
if '--no-plugins' in sys.argv:
3311
argv.append('--no-plugins')
3312
# stderr=STDOUT would be ideal, but until we prevent noise on
3313
# stderr it can interrupt the subunit protocol.
3314
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3316
test = TestInSubprocess(process, test_list_file_name)
3319
os.unlink(test_list_file_name)
3324
class ForwardingResult(unittest.TestResult):
3326
def __init__(self, target):
3327
unittest.TestResult.__init__(self)
3328
self.result = target
3330
def startTest(self, test):
3331
self.result.startTest(test)
3333
def stopTest(self, test):
3334
self.result.stopTest(test)
3336
def startTestRun(self):
3337
self.result.startTestRun()
3339
def stopTestRun(self):
3340
self.result.stopTestRun()
3342
def addSkip(self, test, reason):
3343
self.result.addSkip(test, reason)
3345
def addSuccess(self, test):
3346
self.result.addSuccess(test)
3348
def addError(self, test, err):
3349
self.result.addError(test, err)
3351
def addFailure(self, test, err):
3352
self.result.addFailure(test, err)
3353
ForwardingResult = testtools.ExtendedToOriginalDecorator
3356
class ProfileResult(ForwardingResult):
3357
"""Generate profiling data for all activity between start and success.
3359
The profile data is appended to the test's _benchcalls attribute and can
3360
be accessed by the forwarded-to TestResult.
3362
While it might be cleaner do accumulate this in stopTest, addSuccess is
3363
where our existing output support for lsprof is, and this class aims to
3364
fit in with that: while it could be moved it's not necessary to accomplish
3365
test profiling, nor would it be dramatically cleaner.
3368
def startTest(self, test):
3369
self.profiler = bzrlib.lsprof.BzrProfiler()
3370
self.profiler.start()
3371
ForwardingResult.startTest(self, test)
3373
def addSuccess(self, test):
3374
stats = self.profiler.stop()
3376
calls = test._benchcalls
3377
except AttributeError:
3378
test._benchcalls = []
3379
calls = test._benchcalls
3380
calls.append(((test.id(), "", ""), stats))
3381
ForwardingResult.addSuccess(self, test)
3383
def stopTest(self, test):
3384
ForwardingResult.stopTest(self, test)
3385
self.profiler = None
3388
# Controlled by "bzr selftest -E=..." option
3389
# Currently supported:
3390
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3391
# preserves any flags supplied at the command line.
3392
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3393
# rather than failing tests. And no longer raise
3394
# LockContention when fctnl locks are not being used
3395
# with proper exclusion rules.
3396
selftest_debug_flags = set()
2512
return result.wasSuccessful()
3399
2515
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3572
2661
return self.tests.has_key(test_id)
3575
class TestPrefixAliasRegistry(registry.Registry):
3576
"""A registry for test prefix aliases.
3578
This helps implement shorcuts for the --starting-with selftest
3579
option. Overriding existing prefixes is not allowed but not fatal (a
3580
warning will be emitted).
2664
def test_suite(keep_only=None):
2665
"""Build and return TestSuite for the whole of bzrlib.
2667
:param keep_only: A list of test ids limiting the suite returned.
2669
This function can be replaced if you need to change the default test
2670
suite on a global basis, but it is not encouraged.
3583
def register(self, key, obj, help=None, info=None,
3584
override_existing=False):
3585
"""See Registry.register.
3587
Trying to override an existing alias causes a warning to be emitted,
3588
not a fatal execption.
3591
super(TestPrefixAliasRegistry, self).register(
3592
key, obj, help=help, info=info, override_existing=False)
3594
actual = self.get(key)
3595
note('Test prefix alias %s is already used for %s, ignoring %s'
3596
% (key, actual, obj))
3598
def resolve_alias(self, id_start):
3599
"""Replace the alias by the prefix in the given string.
3601
Using an unknown prefix is an error to help catching typos.
3603
parts = id_start.split('.')
3605
parts[0] = self.get(parts[0])
3607
raise errors.BzrCommandError(
3608
'%s is not a known test prefix alias' % parts[0])
3609
return '.'.join(parts)
3612
test_prefix_alias_registry = TestPrefixAliasRegistry()
3613
"""Registry of test prefix aliases."""
3616
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3617
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3618
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3620
# Obvious highest levels prefixes, feel free to add your own via a plugin
3621
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3622
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3623
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3624
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3625
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3628
def _test_suite_testmod_names():
3629
"""Return the standard list of test module names to test."""
3632
'bzrlib.tests.blackbox',
3633
'bzrlib.tests.commands',
3634
'bzrlib.tests.per_branch',
3635
'bzrlib.tests.per_bzrdir',
3636
'bzrlib.tests.per_bzrdir_colo',
3637
'bzrlib.tests.per_foreign_vcs',
3638
'bzrlib.tests.per_interrepository',
3639
'bzrlib.tests.per_intertree',
3640
'bzrlib.tests.per_inventory',
3641
'bzrlib.tests.per_interbranch',
3642
'bzrlib.tests.per_lock',
3643
'bzrlib.tests.per_merger',
3644
'bzrlib.tests.per_transport',
3645
'bzrlib.tests.per_tree',
3646
'bzrlib.tests.per_pack_repository',
3647
'bzrlib.tests.per_repository',
3648
'bzrlib.tests.per_repository_chk',
3649
'bzrlib.tests.per_repository_reference',
3650
'bzrlib.tests.per_uifactory',
3651
'bzrlib.tests.per_versionedfile',
3652
'bzrlib.tests.per_workingtree',
3653
'bzrlib.tests.test__annotator',
3654
'bzrlib.tests.test__bencode',
3655
'bzrlib.tests.test__chk_map',
3656
'bzrlib.tests.test__dirstate_helpers',
3657
'bzrlib.tests.test__groupcompress',
3658
'bzrlib.tests.test__known_graph',
3659
'bzrlib.tests.test__rio',
3660
'bzrlib.tests.test__simple_set',
3661
'bzrlib.tests.test__static_tuple',
3662
'bzrlib.tests.test__walkdirs_win32',
3663
'bzrlib.tests.test_ancestry',
3664
'bzrlib.tests.test_annotate',
3665
'bzrlib.tests.test_api',
3666
'bzrlib.tests.test_atomicfile',
3667
'bzrlib.tests.test_bad_files',
3668
'bzrlib.tests.test_bisect_multi',
3669
'bzrlib.tests.test_branch',
3670
'bzrlib.tests.test_branchbuilder',
3671
'bzrlib.tests.test_btree_index',
3672
'bzrlib.tests.test_bugtracker',
3673
'bzrlib.tests.test_bundle',
3674
'bzrlib.tests.test_bzrdir',
3675
'bzrlib.tests.test__chunks_to_lines',
3676
'bzrlib.tests.test_cache_utf8',
3677
'bzrlib.tests.test_chk_map',
3678
'bzrlib.tests.test_chk_serializer',
3679
'bzrlib.tests.test_chunk_writer',
3680
'bzrlib.tests.test_clean_tree',
3681
'bzrlib.tests.test_cleanup',
3682
'bzrlib.tests.test_cmdline',
3683
'bzrlib.tests.test_commands',
3684
'bzrlib.tests.test_commit',
3685
'bzrlib.tests.test_commit_merge',
3686
'bzrlib.tests.test_config',
3687
'bzrlib.tests.test_conflicts',
3688
'bzrlib.tests.test_counted_lock',
3689
'bzrlib.tests.test_crash',
3690
'bzrlib.tests.test_decorators',
3691
'bzrlib.tests.test_delta',
3692
'bzrlib.tests.test_debug',
3693
'bzrlib.tests.test_deprecated_graph',
3694
'bzrlib.tests.test_diff',
3695
'bzrlib.tests.test_directory_service',
3696
'bzrlib.tests.test_dirstate',
3697
'bzrlib.tests.test_email_message',
3698
'bzrlib.tests.test_eol_filters',
3699
'bzrlib.tests.test_errors',
3700
'bzrlib.tests.test_export',
3701
'bzrlib.tests.test_extract',
3702
'bzrlib.tests.test_fetch',
3703
'bzrlib.tests.test_fifo_cache',
3704
'bzrlib.tests.test_filters',
3705
'bzrlib.tests.test_ftp_transport',
3706
'bzrlib.tests.test_foreign',
3707
'bzrlib.tests.test_generate_docs',
3708
'bzrlib.tests.test_generate_ids',
3709
'bzrlib.tests.test_globbing',
3710
'bzrlib.tests.test_gpg',
3711
'bzrlib.tests.test_graph',
3712
'bzrlib.tests.test_groupcompress',
3713
'bzrlib.tests.test_hashcache',
3714
'bzrlib.tests.test_help',
3715
'bzrlib.tests.test_hooks',
3716
'bzrlib.tests.test_http',
3717
'bzrlib.tests.test_http_response',
3718
'bzrlib.tests.test_https_ca_bundle',
3719
'bzrlib.tests.test_identitymap',
3720
'bzrlib.tests.test_ignores',
3721
'bzrlib.tests.test_index',
3722
'bzrlib.tests.test_import_tariff',
3723
'bzrlib.tests.test_info',
3724
'bzrlib.tests.test_inv',
3725
'bzrlib.tests.test_inventory_delta',
3726
'bzrlib.tests.test_knit',
3727
'bzrlib.tests.test_lazy_import',
3728
'bzrlib.tests.test_lazy_regex',
3729
'bzrlib.tests.test_lock',
3730
'bzrlib.tests.test_lockable_files',
3731
'bzrlib.tests.test_lockdir',
3732
'bzrlib.tests.test_log',
3733
'bzrlib.tests.test_lru_cache',
3734
'bzrlib.tests.test_lsprof',
3735
'bzrlib.tests.test_mail_client',
3736
'bzrlib.tests.test_memorytree',
3737
'bzrlib.tests.test_merge',
3738
'bzrlib.tests.test_merge3',
3739
'bzrlib.tests.test_merge_core',
3740
'bzrlib.tests.test_merge_directive',
3741
'bzrlib.tests.test_missing',
3742
'bzrlib.tests.test_msgeditor',
3743
'bzrlib.tests.test_multiparent',
3744
'bzrlib.tests.test_mutabletree',
3745
'bzrlib.tests.test_nonascii',
3746
'bzrlib.tests.test_options',
3747
'bzrlib.tests.test_osutils',
3748
'bzrlib.tests.test_osutils_encodings',
3749
'bzrlib.tests.test_pack',
3750
'bzrlib.tests.test_patch',
3751
'bzrlib.tests.test_patches',
3752
'bzrlib.tests.test_permissions',
3753
'bzrlib.tests.test_plugins',
3754
'bzrlib.tests.test_progress',
2673
'bzrlib.util.tests.test_bencode',
2674
'bzrlib.tests.test__dirstate_helpers',
2675
'bzrlib.tests.test_ancestry',
2676
'bzrlib.tests.test_annotate',
2677
'bzrlib.tests.test_api',
2678
'bzrlib.tests.test_atomicfile',
2679
'bzrlib.tests.test_bad_files',
2680
'bzrlib.tests.test_bisect_multi',
2681
'bzrlib.tests.test_branch',
2682
'bzrlib.tests.test_branchbuilder',
2683
'bzrlib.tests.test_bugtracker',
2684
'bzrlib.tests.test_bundle',
2685
'bzrlib.tests.test_bzrdir',
2686
'bzrlib.tests.test_cache_utf8',
2687
'bzrlib.tests.test_commands',
2688
'bzrlib.tests.test_commit',
2689
'bzrlib.tests.test_commit_merge',
2690
'bzrlib.tests.test_config',
2691
'bzrlib.tests.test_conflicts',
2692
'bzrlib.tests.test_counted_lock',
2693
'bzrlib.tests.test_decorators',
2694
'bzrlib.tests.test_delta',
2695
'bzrlib.tests.test_deprecated_graph',
2696
'bzrlib.tests.test_diff',
2697
'bzrlib.tests.test_dirstate',
2698
'bzrlib.tests.test_directory_service',
2699
'bzrlib.tests.test_email_message',
2700
'bzrlib.tests.test_errors',
2701
'bzrlib.tests.test_escaped_store',
2702
'bzrlib.tests.test_extract',
2703
'bzrlib.tests.test_fetch',
2704
'bzrlib.tests.test_ftp_transport',
2705
'bzrlib.tests.test_generate_docs',
2706
'bzrlib.tests.test_generate_ids',
2707
'bzrlib.tests.test_globbing',
2708
'bzrlib.tests.test_gpg',
2709
'bzrlib.tests.test_graph',
2710
'bzrlib.tests.test_hashcache',
2711
'bzrlib.tests.test_help',
2712
'bzrlib.tests.test_hooks',
2713
'bzrlib.tests.test_http',
2714
'bzrlib.tests.test_http_implementations',
2715
'bzrlib.tests.test_http_response',
2716
'bzrlib.tests.test_https_ca_bundle',
2717
'bzrlib.tests.test_identitymap',
2718
'bzrlib.tests.test_ignores',
2719
'bzrlib.tests.test_index',
2720
'bzrlib.tests.test_info',
2721
'bzrlib.tests.test_inv',
2722
'bzrlib.tests.test_knit',
2723
'bzrlib.tests.test_lazy_import',
2724
'bzrlib.tests.test_lazy_regex',
2725
'bzrlib.tests.test_lockdir',
2726
'bzrlib.tests.test_lockable_files',
2727
'bzrlib.tests.test_log',
2728
'bzrlib.tests.test_lsprof',
2729
'bzrlib.tests.test_lru_cache',
2730
'bzrlib.tests.test_mail_client',
2731
'bzrlib.tests.test_memorytree',
2732
'bzrlib.tests.test_merge',
2733
'bzrlib.tests.test_merge3',
2734
'bzrlib.tests.test_merge_core',
2735
'bzrlib.tests.test_merge_directive',
2736
'bzrlib.tests.test_missing',
2737
'bzrlib.tests.test_msgeditor',
2738
'bzrlib.tests.test_multiparent',
2739
'bzrlib.tests.test_mutabletree',
2740
'bzrlib.tests.test_nonascii',
2741
'bzrlib.tests.test_options',
2742
'bzrlib.tests.test_osutils',
2743
'bzrlib.tests.test_osutils_encodings',
2744
'bzrlib.tests.test_pack',
2745
'bzrlib.tests.test_patch',
2746
'bzrlib.tests.test_patches',
2747
'bzrlib.tests.test_permissions',
2748
'bzrlib.tests.test_plugins',
2749
'bzrlib.tests.test_progress',
2750
'bzrlib.tests.test_reconfigure',
2751
'bzrlib.tests.test_reconcile',
2752
'bzrlib.tests.test_registry',
2753
'bzrlib.tests.test_remote',
2754
'bzrlib.tests.test_repository',
2755
'bzrlib.tests.test_revert',
2756
'bzrlib.tests.test_revision',
2757
'bzrlib.tests.test_revisionspec',
2758
'bzrlib.tests.test_revisiontree',
2759
'bzrlib.tests.test_rio',
2760
'bzrlib.tests.test_sampler',
2761
'bzrlib.tests.test_selftest',
2762
'bzrlib.tests.test_setup',
2763
'bzrlib.tests.test_sftp_transport',
2764
'bzrlib.tests.test_smart',
2765
'bzrlib.tests.test_smart_add',
2766
'bzrlib.tests.test_smart_transport',
2767
'bzrlib.tests.test_smtp_connection',
2768
'bzrlib.tests.test_source',
2769
'bzrlib.tests.test_ssh_transport',
2770
'bzrlib.tests.test_status',
2771
'bzrlib.tests.test_store',
2772
'bzrlib.tests.test_strace',
2773
'bzrlib.tests.test_subsume',
2774
'bzrlib.tests.test_switch',
2775
'bzrlib.tests.test_symbol_versioning',
2776
'bzrlib.tests.test_tag',
2777
'bzrlib.tests.test_testament',
2778
'bzrlib.tests.test_textfile',
2779
'bzrlib.tests.test_textmerge',
2780
'bzrlib.tests.test_timestamp',
2781
'bzrlib.tests.test_trace',
2782
'bzrlib.tests.test_transactions',
2783
'bzrlib.tests.test_transform',
2784
'bzrlib.tests.test_transport',
2785
'bzrlib.tests.test_tree',
2786
'bzrlib.tests.test_treebuilder',
2787
'bzrlib.tests.test_tsort',
2788
'bzrlib.tests.test_tuned_gzip',
2789
'bzrlib.tests.test_ui',
2790
'bzrlib.tests.test_uncommit',
2791
'bzrlib.tests.test_upgrade',
2792
'bzrlib.tests.test_urlutils',
2793
'bzrlib.tests.test_versionedfile',
2794
'bzrlib.tests.test_version',
2795
'bzrlib.tests.test_version_info',
2796
'bzrlib.tests.test_weave',
2797
'bzrlib.tests.test_whitebox',
2798
'bzrlib.tests.test_win32utils',
2799
'bzrlib.tests.test_workingtree',
2800
'bzrlib.tests.test_workingtree_4',
2801
'bzrlib.tests.test_wsgi',
2802
'bzrlib.tests.test_xml',
2804
test_transport_implementations = [
2805
'bzrlib.tests.test_transport_implementations',
3755
2806
'bzrlib.tests.test_read_bundle',
3756
'bzrlib.tests.test_reconcile',
3757
'bzrlib.tests.test_reconfigure',
3758
'bzrlib.tests.test_registry',
3759
'bzrlib.tests.test_remote',
3760
'bzrlib.tests.test_rename_map',
3761
'bzrlib.tests.test_repository',
3762
'bzrlib.tests.test_revert',
3763
'bzrlib.tests.test_revision',
3764
'bzrlib.tests.test_revisionspec',
3765
'bzrlib.tests.test_revisiontree',
3766
'bzrlib.tests.test_rio',
3767
'bzrlib.tests.test_rules',
3768
'bzrlib.tests.test_sampler',
3769
'bzrlib.tests.test_script',
3770
'bzrlib.tests.test_selftest',
3771
'bzrlib.tests.test_serializer',
3772
'bzrlib.tests.test_setup',
3773
'bzrlib.tests.test_sftp_transport',
3774
'bzrlib.tests.test_shelf',
3775
'bzrlib.tests.test_shelf_ui',
3776
'bzrlib.tests.test_smart',
3777
'bzrlib.tests.test_smart_add',
3778
'bzrlib.tests.test_smart_request',
3779
'bzrlib.tests.test_smart_transport',
3780
'bzrlib.tests.test_smtp_connection',
3781
'bzrlib.tests.test_source',
3782
'bzrlib.tests.test_ssh_transport',
3783
'bzrlib.tests.test_status',
3784
'bzrlib.tests.test_store',
3785
'bzrlib.tests.test_strace',
3786
'bzrlib.tests.test_subsume',
3787
'bzrlib.tests.test_switch',
3788
'bzrlib.tests.test_symbol_versioning',
3789
'bzrlib.tests.test_tag',
3790
'bzrlib.tests.test_testament',
3791
'bzrlib.tests.test_textfile',
3792
'bzrlib.tests.test_textmerge',
3793
'bzrlib.tests.test_timestamp',
3794
'bzrlib.tests.test_trace',
3795
'bzrlib.tests.test_transactions',
3796
'bzrlib.tests.test_transform',
3797
'bzrlib.tests.test_transport',
3798
'bzrlib.tests.test_transport_log',
3799
'bzrlib.tests.test_tree',
3800
'bzrlib.tests.test_treebuilder',
3801
'bzrlib.tests.test_tsort',
3802
'bzrlib.tests.test_tuned_gzip',
3803
'bzrlib.tests.test_ui',
3804
'bzrlib.tests.test_uncommit',
3805
'bzrlib.tests.test_upgrade',
3806
'bzrlib.tests.test_upgrade_stacked',
3807
'bzrlib.tests.test_urlutils',
3808
'bzrlib.tests.test_version',
3809
'bzrlib.tests.test_version_info',
3810
'bzrlib.tests.test_weave',
3811
'bzrlib.tests.test_whitebox',
3812
'bzrlib.tests.test_win32utils',
3813
'bzrlib.tests.test_workingtree',
3814
'bzrlib.tests.test_workingtree_4',
3815
'bzrlib.tests.test_wsgi',
3816
'bzrlib.tests.test_xml',
3820
def _test_suite_modules_to_doctest():
3821
"""Return the list of modules to doctest."""
3823
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
2808
loader = TestUtil.TestLoader()
2810
if keep_only is None:
2811
loader = TestUtil.TestLoader()
2813
id_filter = TestIdList(keep_only)
2814
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2815
suite = loader.suiteClass()
2817
# modules building their suite with loadTestsFromModuleNames
2818
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2820
# modules adapted for transport implementations
2821
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2822
adapter = TransportTestProviderAdapter()
2823
adapt_modules(test_transport_implementations, adapter, loader, suite)
2825
# modules defining their own test_suite()
2826
for package in [p for p in packages_to_test()
2827
if (keep_only is None
2828
or id_filter.refers_to(p.__name__))]:
2829
pack_suite = package.test_suite()
2830
suite.addTest(pack_suite)
2832
modules_to_doctest = [
3827
'bzrlib.branchbuilder',
3828
'bzrlib.decorators',
3829
2835
'bzrlib.export',
3830
2836
'bzrlib.inventory',
3831
2837
'bzrlib.iterablefile',
3832
2838
'bzrlib.lockdir',
3833
2839
'bzrlib.merge3',
3834
2840
'bzrlib.option',
3835
'bzrlib.symbol_versioning',
3836
2842
'bzrlib.tests',
3837
2843
'bzrlib.timestamp',
3838
2844
'bzrlib.version_info_formats.format_custom',
3842
def test_suite(keep_only=None, starting_with=None):
3843
"""Build and return TestSuite for the whole of bzrlib.
3845
:param keep_only: A list of test ids limiting the suite returned.
3847
:param starting_with: An id limiting the suite returned to the tests
3850
This function can be replaced if you need to change the default test
3851
suite on a global basis, but it is not encouraged.
3854
loader = TestUtil.TestLoader()
3856
if keep_only is not None:
3857
id_filter = TestIdList(keep_only)
3859
# We take precedence over keep_only because *at loading time* using
3860
# both options means we will load less tests for the same final result.
3861
def interesting_module(name):
3862
for start in starting_with:
3864
# Either the module name starts with the specified string
3865
name.startswith(start)
3866
# or it may contain tests starting with the specified string
3867
or start.startswith(name)
3871
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3873
elif keep_only is not None:
3874
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3875
def interesting_module(name):
3876
return id_filter.refers_to(name)
3879
loader = TestUtil.TestLoader()
3880
def interesting_module(name):
3881
# No filtering, all modules are interesting
3884
suite = loader.suiteClass()
3886
# modules building their suite with loadTestsFromModuleNames
3887
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3889
for mod in _test_suite_modules_to_doctest():
3890
if not interesting_module(mod):
2847
for mod in modules_to_doctest:
2848
if not (keep_only is None or id_filter.refers_to(mod)):
3891
2849
# No tests to keep here, move along
3894
# note that this really does mean "report only" -- doctest
3895
# still runs the rest of the examples
3896
doc_suite = doctest.DocTestSuite(mod,
3897
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
2852
doc_suite = doctest.DocTestSuite(mod)
3898
2853
except ValueError, e:
3899
2854
print '**failed to get doctest for: %s\n%s' % (mod, e)
3901
if len(doc_suite._tests) == 0:
3902
raise errors.BzrError("no doctests found in %s" % (mod,))
3903
2856
suite.addTest(doc_suite)
3905
2858
default_encoding = sys.getdefaultencoding()
3906
2859
for name, plugin in bzrlib.plugin.plugins().items():
3907
if not interesting_module(plugin.module.__name__):
2860
if keep_only is not None:
2861
if not id_filter.refers_to(plugin.module.__name__):
3909
2863
plugin_suite = plugin.test_suite()
3910
2864
# We used to catch ImportError here and turn it into just a warning,
3911
2865
# but really if you don't have --no-plugins this should be a failure.
3957
2951
for right_name, right_dict in scenarios_right]
3960
def multiply_tests(tests, scenarios, result):
3961
"""Multiply tests_list by scenarios into result.
3963
This is the core workhorse for test parameterisation.
3965
Typically the load_tests() method for a per-implementation test suite will
3966
call multiply_tests and return the result.
3968
:param tests: The tests to parameterise.
3969
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3970
scenario_param_dict).
3971
:param result: A TestSuite to add created tests to.
3973
This returns the passed in result TestSuite with the cross product of all
3974
the tests repeated once for each scenario. Each test is adapted by adding
3975
the scenario name at the end of its id(), and updating the test object's
3976
__dict__ with the scenario_param_dict.
3978
>>> import bzrlib.tests.test_sampler
3979
>>> r = multiply_tests(
3980
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3981
... [('one', dict(param=1)),
3982
... ('two', dict(param=2))],
3984
>>> tests = list(iter_suite_tests(r))
3988
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3994
for test in iter_suite_tests(tests):
3995
apply_scenarios(test, scenarios, result)
3999
def apply_scenarios(test, scenarios, result):
4000
"""Apply the scenarios in scenarios to test and add to result.
4002
:param test: The test to apply scenarios to.
4003
:param scenarios: An iterable of scenarios to apply to test.
4005
:seealso: apply_scenario
4007
for scenario in scenarios:
4008
result.addTest(apply_scenario(test, scenario))
4012
def apply_scenario(test, scenario):
4013
"""Copy test and apply scenario to it.
4015
:param test: A test to adapt.
4016
:param scenario: A tuple describing the scenarion.
4017
The first element of the tuple is the new test id.
4018
The second element is a dict containing attributes to set on the
4020
:return: The adapted test.
4022
new_id = "%s(%s)" % (test.id(), scenario[0])
4023
new_test = clone_test(test, new_id)
4024
for name, value in scenario[1].items():
4025
setattr(new_test, name, value)
4029
def clone_test(test, new_id):
4030
"""Clone a test giving it a new id.
4032
:param test: The test to clone.
4033
:param new_id: The id to assign to it.
4034
:return: The new test.
4036
new_test = copy(test)
4037
new_test.id = lambda: new_id
4041
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4043
"""Helper for permutating tests against an extension module.
4045
This is meant to be used inside a modules 'load_tests()' function. It will
4046
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4047
against both implementations. Setting 'test.module' to the appropriate
4048
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4050
:param standard_tests: A test suite to permute
4051
:param loader: A TestLoader
4052
:param py_module_name: The python path to a python module that can always
4053
be loaded, and will be considered the 'python' implementation. (eg
4054
'bzrlib._chk_map_py')
4055
:param ext_module_name: The python path to an extension module. If the
4056
module cannot be loaded, a single test will be added, which notes that
4057
the module is not available. If it can be loaded, all standard_tests
4058
will be run against that module.
4059
:return: (suite, feature) suite is a test-suite that has all the permuted
4060
tests. feature is the Feature object that can be used to determine if
4061
the module is available.
4064
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4066
('python', {'module': py_module}),
4068
suite = loader.suiteClass()
4069
feature = ModuleAvailableFeature(ext_module_name)
4070
if feature.available():
4071
scenarios.append(('C', {'module': feature.module}))
4073
# the compiled module isn't available, so we add a failing test
4074
class FailWithoutFeature(TestCase):
4075
def test_fail(self):
4076
self.requireFeature(feature)
4077
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4078
result = multiply_tests(standard_tests, scenarios, suite)
4079
return result, feature
4082
def _rmtree_temp_dir(dirname, test_id=None):
2955
def adapt_modules(mods_list, adapter, loader, suite):
2956
"""Adapt the modules in mods_list using adapter and add to suite."""
2957
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2958
suite.addTests(adapter.adapt(test))
2961
def adapt_tests(tests_list, adapter, loader, suite):
2962
"""Adapt the tests in tests_list using adapter and add to suite."""
2963
for test in tests_list:
2964
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2967
def _rmtree_temp_dir(dirname):
4083
2968
# If LANG=C we probably have created some bogus paths
4084
2969
# which rmtree(unicode) will fail to delete
4085
2970
# so make sure we are using rmtree(str) to delete everything
added
removed
bzrlib/tests/__init__.py
