598
540
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
543
self.stream = unittest._WritelnDecorator(stream)
623
544
self.descriptions = descriptions
624
545
self.verbosity = verbosity
625
546
self._bench_history = bench_history
626
self._strict = strict
627
self._result_decorators = result_decorators or []
547
self.list_only = list_only
629
549
def run(self, test):
630
550
"Run the given test case or test suite."
551
startTime = time.time()
631
552
if self.verbosity == 1:
632
553
result_class = TextTestResult
633
554
elif self.verbosity >= 2:
634
555
result_class = VerboseTestResult
635
original_result = result_class(self.stream,
556
result = result_class(self.stream,
636
557
self.descriptions,
638
559
bench_history=self._bench_history,
560
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()
562
result.stop_early = self.stop_on_failure
563
result.report_starting()
565
if self.verbosity >= 2:
566
self.stream.writeln("Listing tests only ...\n")
568
for t in iter_suite_tests(test):
569
self.stream.writeln("%s" % (t.id()))
571
actionTaken = "Listed"
652
# higher level code uses our extended protocol to determine
653
# what exit code to give.
654
return original_result
574
run = result.testsRun
576
stopTime = time.time()
577
timeTaken = stopTime - startTime
579
self.stream.writeln(result.separator2)
580
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
581
run, run != 1 and "s" or "", timeTaken))
582
self.stream.writeln()
583
if not result.wasSuccessful():
584
self.stream.write("FAILED (")
585
failed, errored = map(len, (result.failures, result.errors))
587
self.stream.write("failures=%d" % failed)
589
if failed: self.stream.write(", ")
590
self.stream.write("errors=%d" % errored)
591
if result.known_failure_count:
592
if failed or errored: self.stream.write(", ")
593
self.stream.write("known_failure_count=%d" %
594
result.known_failure_count)
595
self.stream.writeln(")")
597
if result.known_failure_count:
598
self.stream.writeln("OK (known_failures=%d)" %
599
result.known_failure_count)
601
self.stream.writeln("OK")
602
if result.skip_count > 0:
603
skipped = result.skip_count
604
self.stream.writeln('%d test%s skipped' %
605
(skipped, skipped != 1 and "s" or ""))
606
if result.unsupported:
607
for feature, count in sorted(result.unsupported.items()):
608
self.stream.writeln("Missing feature '%s' skipped %d tests." %
657
614
def iter_suite_tests(suite):
658
615
"""Return all tests in a suite, recursing through nested suites"""
659
if isinstance(suite, unittest.TestCase):
661
elif isinstance(suite, unittest.TestSuite):
616
for item in suite._tests:
617
if isinstance(item, unittest.TestCase):
619
elif isinstance(item, unittest.TestSuite):
663
620
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
623
raise Exception('unknown object %r inside test suite %r'
627
class TestSkipped(Exception):
628
"""Indicates that a test was intentionally skipped, rather than failing."""
673
631
class TestNotApplicable(TestSkipped):
674
632
"""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
634
This is only normally raised by parameterized tests, if they find that
635
the instance they're constructed upon does not support one aspect
678
636
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
640
class KnownFailure(AssertionError):
641
"""Indicates that a test failed in a precisely expected manner.
643
Such failures dont block the whole test suite from passing because they are
644
indicators of partially completed code or of future work. We have an
645
explicit error for them so that we can ensure that they are always visible:
646
KnownFailures are always shown in the output of bzr selftest.
701
650
class UnavailableFeature(Exception):
702
651
"""A feature required for this test was not available.
704
This can be considered a specialised form of SkippedTest.
706
653
The feature should be used to construct the exception.
657
class CommandFailed(Exception):
710
661
class StringIOWrapper(object):
711
662
"""A wrapper around cStringIO which just adds an encoding attribute.
713
664
Internally we can check sys.stdout to see what the output encoding
714
665
should be. However, cStringIO has no encoding attribute that we can
715
666
set. So we wrap it instead.
784
760
retrieved by _get_log(). We use a real OS file, not an in-memory object,
785
761
so that it can also capture file IO. When the test completes this file
786
762
is read into memory and removed from disk.
788
764
There are also convenience functions to invoke bzr's command-line
789
765
routine, and to build and check bzr trees.
791
767
In addition to the usual method of overriding tearDown(), this class also
792
768
allows subclasses to register functions into the _cleanups list, which is
793
769
run in order as the object is torn down. It's less likely this will be
794
770
accidentally overlooked.
797
_active_threads = None
798
_leaking_threads_tests = 0
799
_first_thread_leaker_id = None
800
773
_log_file_name = None
775
_keep_log_file = False
801
776
# record lsprof data when performing benchmark calls.
802
777
_gather_lsprof_in_benchmarks = False
778
attrs_to_keep = ('_testMethodName', '_testMethodDoc',
779
'_log_contents', '_log_file_name', '_benchtime',
780
'_TestCase__testMethodName')
804
782
def __init__(self, methodName='testMethod'):
805
783
super(TestCase, self).__init__(methodName)
806
784
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)]))
787
unittest.TestCase.setUp(self)
821
788
self._cleanEnvironment()
822
789
self._silenceUI()
823
790
self._startLogFile()
824
791
self._benchcalls = []
825
792
self._benchtime = None
826
793
self._clear_hooks()
827
self._track_transports()
829
794
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
796
def _clear_debug_flags(self):
854
797
"""Prevent externally set debug flags affecting tests.
856
799
Tests that want to use debug flags can just set them in the
857
800
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:
802
if 'selftest_debug' not in debug.debug_flags:
803
self._preserved_debug_flags = set(debug.debug_flags)
862
804
debug.debug_flags.clear()
863
if 'disable_lock_checks' not in selftest_debug_flags:
864
debug.debug_flags.add('strict_locks')
805
self.addCleanup(self._restore_debug_flags)
866
807
def _clear_hooks(self):
867
808
# 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)
810
import bzrlib.smart.server
811
self._preserved_hooks = {
812
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
813
bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
814
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
873
816
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
817
# reset all hooks to an empty instance of the appropriate type
818
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
819
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
888
821
def _silenceUI(self):
889
822
"""Turn off UI for duration of test"""
890
823
# 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.")
824
saved = ui.ui_factory
826
ui.ui_factory = saved
827
ui.ui_factory = ui.SilentUIFactory()
828
self.addCleanup(_restore)
1071
830
def _ndiff_strings(self, a, b):
1072
831
"""Return ndiff between two strings containing lines.
1074
833
A trailing newline is added if missing to make the strings
1075
834
print properly."""
1076
835
if b and b[-1] != '\n':
2928
2452
list_only=False,
2929
2453
random_seed=None,
2930
2454
exclude_pattern=None,
2933
suite_decorators=None,
2935
result_decorators=None,
2937
"""Run a test suite for bzr selftest.
2939
:param runner_class: The class of runner to use. Must support the
2940
constructor arguments passed by run_suite which are more than standard
2942
:return: A boolean indicating success.
2944
2456
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2949
if runner_class is None:
2950
runner_class = TextTestRunner
2953
runner = runner_class(stream=stream,
2461
runner = TextTestRunner(stream=sys.stdout,
2954
2462
descriptions=0,
2955
2463
verbosity=verbosity,
2956
2464
bench_history=bench_history,
2958
result_decorators=result_decorators,
2465
list_only=list_only,
2960
2467
runner.stop_on_failure=stop_on_failure
2961
# built in decorator factories:
2963
random_order(random_seed, runner),
2964
exclude_tests(exclude_pattern),
2966
if matching_tests_first:
2967
decorators.append(tests_first(pattern))
2468
# Initialise the random number generator and display the seed used.
2469
# We convert the seed to a long to make it reuseable across invocations.
2470
random_order = False
2471
if random_seed is not None:
2473
if random_seed == "now":
2474
random_seed = long(time.time())
2476
# Convert the seed to a long if we can
2478
random_seed = long(random_seed)
2481
runner.stream.writeln("Randomizing test order using seed %s\n" %
2483
random.seed(random_seed)
2484
# Customise the list of tests if requested
2485
if exclude_pattern is not None:
2486
suite = exclude_tests_by_re(suite, exclude_pattern)
2488
order_changer = randomize_suite
2969
decorators.append(filter_tests(pattern))
2970
if suite_decorators:
2971
decorators.extend(suite_decorators)
2972
# tell the result object how many tests will be running: (except if
2973
# --parallel=fork is being used. Robert said he will provide a better
2974
# progress design later -- vila 20090817)
2975
if fork_decorator not in decorators:
2976
decorators.append(CountingDecorator)
2977
for decorator in decorators:
2978
suite = decorator(suite)
2980
# Done after test suite decoration to allow randomisation etc
2981
# to take effect, though that is of marginal benefit.
2983
stream.write("Listing tests only ...\n")
2984
for t in iter_suite_tests(suite):
2985
stream.write("%s\n" % (t.id()))
2490
order_changer = preserve_input
2491
if pattern != '.*' or random_order:
2492
if matching_tests_first:
2493
suites = map(order_changer, split_suite_by_re(suite, pattern))
2494
suite = TestUtil.TestSuite(suites)
2496
suite = order_changer(filter_suite_by_re(suite, pattern))
2987
2498
result = runner.run(suite)
2989
2501
return result.wasStrictlySuccessful()
2991
return result.wasSuccessful()
2994
# A registry where get() returns a suite decorator.
2995
parallel_registry = registry.Registry()
2998
def fork_decorator(suite):
2999
concurrency = osutils.local_concurrency()
3000
if concurrency == 1:
3002
from testtools import ConcurrentTestSuite
3003
return ConcurrentTestSuite(suite, fork_for_tests)
3004
parallel_registry.register('fork', fork_decorator)
3007
def subprocess_decorator(suite):
3008
concurrency = osutils.local_concurrency()
3009
if concurrency == 1:
3011
from testtools import ConcurrentTestSuite
3012
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3013
parallel_registry.register('subprocess', subprocess_decorator)
3016
def exclude_tests(exclude_pattern):
3017
"""Return a test suite decorator that excludes tests."""
3018
if exclude_pattern is None:
3019
return identity_decorator
3020
def decorator(suite):
3021
return ExcludeDecorator(suite, exclude_pattern)
3025
def filter_tests(pattern):
3027
return identity_decorator
3028
def decorator(suite):
3029
return FilterTestsDecorator(suite, pattern)
3033
def random_order(random_seed, runner):
3034
"""Return a test suite decorator factory for randomising tests order.
3036
:param random_seed: now, a string which casts to a long, or a long.
3037
:param runner: A test runner with a stream attribute to report on.
3039
if random_seed is None:
3040
return identity_decorator
3041
def decorator(suite):
3042
return RandomDecorator(suite, random_seed, runner.stream)
3046
def tests_first(pattern):
3048
return identity_decorator
3049
def decorator(suite):
3050
return TestFirstDecorator(suite, pattern)
3054
def identity_decorator(suite):
3059
class TestDecorator(TestSuite):
3060
"""A decorator for TestCase/TestSuite objects.
3062
Usually, subclasses should override __iter__(used when flattening test
3063
suites), which we do to filter, reorder, parallelise and so on, run() and
3067
def __init__(self, suite):
3068
TestSuite.__init__(self)
3071
def countTestCases(self):
3074
cases += test.countTestCases()
3081
def run(self, result):
3082
# Use iteration on self, not self._tests, to allow subclasses to hook
3085
if result.shouldStop:
3091
class CountingDecorator(TestDecorator):
3092
"""A decorator which calls result.progress(self.countTestCases)."""
3094
def run(self, result):
3095
progress_method = getattr(result, 'progress', None)
3096
if callable(progress_method):
3097
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3098
return super(CountingDecorator, self).run(result)
3101
class ExcludeDecorator(TestDecorator):
3102
"""A decorator which excludes test matching an exclude pattern."""
3104
def __init__(self, suite, exclude_pattern):
3105
TestDecorator.__init__(self, suite)
3106
self.exclude_pattern = exclude_pattern
3107
self.excluded = False
3111
return iter(self._tests)
3112
self.excluded = True
3113
suite = exclude_tests_by_re(self, self.exclude_pattern)
3115
self.addTests(suite)
3116
return iter(self._tests)
3119
class FilterTestsDecorator(TestDecorator):
3120
"""A decorator which filters tests to those matching a pattern."""
3122
def __init__(self, suite, pattern):
3123
TestDecorator.__init__(self, suite)
3124
self.pattern = pattern
3125
self.filtered = False
3129
return iter(self._tests)
3130
self.filtered = True
3131
suite = filter_suite_by_re(self, self.pattern)
3133
self.addTests(suite)
3134
return iter(self._tests)
3137
class RandomDecorator(TestDecorator):
3138
"""A decorator which randomises the order of its tests."""
3140
def __init__(self, suite, random_seed, stream):
3141
TestDecorator.__init__(self, suite)
3142
self.random_seed = random_seed
3143
self.randomised = False
3144
self.stream = stream
3148
return iter(self._tests)
3149
self.randomised = True
3150
self.stream.write("Randomizing test order using seed %s\n\n" %
3151
(self.actual_seed()))
3152
# Initialise the random number generator.
3153
random.seed(self.actual_seed())
3154
suite = randomize_suite(self)
3156
self.addTests(suite)
3157
return iter(self._tests)
3159
def actual_seed(self):
3160
if self.random_seed == "now":
3161
# We convert the seed to a long to make it reuseable across
3162
# invocations (because the user can reenter it).
3163
self.random_seed = long(time.time())
3165
# Convert the seed to a long if we can
3167
self.random_seed = long(self.random_seed)
3170
return self.random_seed
3173
class TestFirstDecorator(TestDecorator):
3174
"""A decorator which moves named tests to the front."""
3176
def __init__(self, suite, pattern):
3177
TestDecorator.__init__(self, suite)
3178
self.pattern = pattern
3179
self.filtered = False
3183
return iter(self._tests)
3184
self.filtered = True
3185
suites = split_suite_by_re(self, self.pattern)
3187
self.addTests(suites)
3188
return iter(self._tests)
3191
def partition_tests(suite, count):
3192
"""Partition suite into count lists of tests."""
3194
tests = list(iter_suite_tests(suite))
3195
tests_per_process = int(math.ceil(float(len(tests)) / count))
3196
for block in range(count):
3197
low_test = block * tests_per_process
3198
high_test = low_test + tests_per_process
3199
process_tests = tests[low_test:high_test]
3200
result.append(process_tests)
3204
def workaround_zealous_crypto_random():
3205
"""Crypto.Random want to help us being secure, but we don't care here.
3207
This workaround some test failure related to the sftp server. Once paramiko
3208
stop using the controversial API in Crypto.Random, we may get rid of it.
3211
from Crypto.Random import atfork
3217
def fork_for_tests(suite):
3218
"""Take suite and start up one runner per CPU by forking()
3220
:return: An iterable of TestCase-like objects which can each have
3221
run(result) called on them to feed tests to result.
3223
concurrency = osutils.local_concurrency()
3225
from subunit import TestProtocolClient, ProtocolTestCase
3226
from subunit.test_results import AutoTimingTestResultDecorator
3227
class TestInOtherProcess(ProtocolTestCase):
3228
# Should be in subunit, I think. RBC.
3229
def __init__(self, stream, pid):
3230
ProtocolTestCase.__init__(self, stream)
3233
def run(self, result):
3235
ProtocolTestCase.run(self, result)
3237
os.waitpid(self.pid, 0)
3239
test_blocks = partition_tests(suite, concurrency)
3240
for process_tests in test_blocks:
3241
process_suite = TestSuite()
3242
process_suite.addTests(process_tests)
3243
c2pread, c2pwrite = os.pipe()
3246
workaround_zealous_crypto_random()
3249
# Leave stderr and stdout open so we can see test noise
3250
# Close stdin so that the child goes away if it decides to
3251
# read from stdin (otherwise its a roulette to see what
3252
# child actually gets keystrokes for pdb etc).
3255
stream = os.fdopen(c2pwrite, 'wb', 1)
3256
subunit_result = AutoTimingTestResultDecorator(
3257
TestProtocolClient(stream))
3258
process_suite.run(subunit_result)
3263
stream = os.fdopen(c2pread, 'rb', 1)
3264
test = TestInOtherProcess(stream, pid)
3269
def reinvoke_for_tests(suite):
3270
"""Take suite and start up one runner per CPU using subprocess().
3272
:return: An iterable of TestCase-like objects which can each have
3273
run(result) called on them to feed tests to result.
3275
concurrency = osutils.local_concurrency()
3277
from subunit import ProtocolTestCase
3278
class TestInSubprocess(ProtocolTestCase):
3279
def __init__(self, process, name):
3280
ProtocolTestCase.__init__(self, process.stdout)
3281
self.process = process
3282
self.process.stdin.close()
3285
def run(self, result):
3287
ProtocolTestCase.run(self, result)
3290
os.unlink(self.name)
3291
# print "pid %d finished" % finished_process
3292
test_blocks = partition_tests(suite, concurrency)
3293
for process_tests in test_blocks:
3294
# ugly; currently reimplement rather than reuses TestCase methods.
3295
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3296
if not os.path.isfile(bzr_path):
3297
# We are probably installed. Assume sys.argv is the right file
3298
bzr_path = sys.argv[0]
3299
bzr_path = [bzr_path]
3300
if sys.platform == "win32":
3301
# if we're on windows, we can't execute the bzr script directly
3302
bzr_path = [sys.executable] + bzr_path
3303
fd, test_list_file_name = tempfile.mkstemp()
3304
test_list_file = os.fdopen(fd, 'wb', 1)
3305
for test in process_tests:
3306
test_list_file.write(test.id() + '\n')
3307
test_list_file.close()
3309
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3311
if '--no-plugins' in sys.argv:
3312
argv.append('--no-plugins')
3313
# stderr=STDOUT would be ideal, but until we prevent noise on
3314
# stderr it can interrupt the subunit protocol.
3315
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3317
test = TestInSubprocess(process, test_list_file_name)
3320
os.unlink(test_list_file_name)
3325
class ForwardingResult(unittest.TestResult):
3327
def __init__(self, target):
3328
unittest.TestResult.__init__(self)
3329
self.result = target
3331
def startTest(self, test):
3332
self.result.startTest(test)
3334
def stopTest(self, test):
3335
self.result.stopTest(test)
3337
def startTestRun(self):
3338
self.result.startTestRun()
3340
def stopTestRun(self):
3341
self.result.stopTestRun()
3343
def addSkip(self, test, reason):
3344
self.result.addSkip(test, reason)
3346
def addSuccess(self, test):
3347
self.result.addSuccess(test)
3349
def addError(self, test, err):
3350
self.result.addError(test, err)
3352
def addFailure(self, test, err):
3353
self.result.addFailure(test, err)
3354
ForwardingResult = testtools.ExtendedToOriginalDecorator
3357
class ProfileResult(ForwardingResult):
3358
"""Generate profiling data for all activity between start and success.
3360
The profile data is appended to the test's _benchcalls attribute and can
3361
be accessed by the forwarded-to TestResult.
3363
While it might be cleaner do accumulate this in stopTest, addSuccess is
3364
where our existing output support for lsprof is, and this class aims to
3365
fit in with that: while it could be moved it's not necessary to accomplish
3366
test profiling, nor would it be dramatically cleaner.
3369
def startTest(self, test):
3370
self.profiler = bzrlib.lsprof.BzrProfiler()
3371
self.profiler.start()
3372
ForwardingResult.startTest(self, test)
3374
def addSuccess(self, test):
3375
stats = self.profiler.stop()
3377
calls = test._benchcalls
3378
except AttributeError:
3379
test._benchcalls = []
3380
calls = test._benchcalls
3381
calls.append(((test.id(), "", ""), stats))
3382
ForwardingResult.addSuccess(self, test)
3384
def stopTest(self, test):
3385
ForwardingResult.stopTest(self, test)
3386
self.profiler = None
3389
# Controlled by "bzr selftest -E=..." option
3390
# Currently supported:
3391
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3392
# preserves any flags supplied at the command line.
3393
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3394
# rather than failing tests. And no longer raise
3395
# LockContention when fctnl locks are not being used
3396
# with proper exclusion rules.
3397
selftest_debug_flags = set()
2503
return result.wasSuccessful()
3400
2506
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3573
2652
return self.tests.has_key(test_id)
3576
class TestPrefixAliasRegistry(registry.Registry):
3577
"""A registry for test prefix aliases.
3579
This helps implement shorcuts for the --starting-with selftest
3580
option. Overriding existing prefixes is not allowed but not fatal (a
3581
warning will be emitted).
2655
def test_suite(keep_only=None):
2656
"""Build and return TestSuite for the whole of bzrlib.
2658
:param keep_only: A list of test ids limiting the suite returned.
2660
This function can be replaced if you need to change the default test
2661
suite on a global basis, but it is not encouraged.
3584
def register(self, key, obj, help=None, info=None,
3585
override_existing=False):
3586
"""See Registry.register.
3588
Trying to override an existing alias causes a warning to be emitted,
3589
not a fatal execption.
3592
super(TestPrefixAliasRegistry, self).register(
3593
key, obj, help=help, info=info, override_existing=False)
3595
actual = self.get(key)
3596
note('Test prefix alias %s is already used for %s, ignoring %s'
3597
% (key, actual, obj))
3599
def resolve_alias(self, id_start):
3600
"""Replace the alias by the prefix in the given string.
3602
Using an unknown prefix is an error to help catching typos.
3604
parts = id_start.split('.')
3606
parts[0] = self.get(parts[0])
3608
raise errors.BzrCommandError(
3609
'%s is not a known test prefix alias' % parts[0])
3610
return '.'.join(parts)
3613
test_prefix_alias_registry = TestPrefixAliasRegistry()
3614
"""Registry of test prefix aliases."""
3617
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3618
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3619
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3621
# Obvious highest levels prefixes, feel free to add your own via a plugin
3622
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3623
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3624
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3625
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3626
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3629
def _test_suite_testmod_names():
3630
"""Return the standard list of test module names to test."""
3633
'bzrlib.tests.blackbox',
3634
'bzrlib.tests.commands',
3635
'bzrlib.tests.per_branch',
3636
'bzrlib.tests.per_bzrdir',
3637
'bzrlib.tests.per_bzrdir_colo',
3638
'bzrlib.tests.per_foreign_vcs',
3639
'bzrlib.tests.per_interrepository',
3640
'bzrlib.tests.per_intertree',
3641
'bzrlib.tests.per_inventory',
3642
'bzrlib.tests.per_interbranch',
3643
'bzrlib.tests.per_lock',
3644
'bzrlib.tests.per_merger',
3645
'bzrlib.tests.per_transport',
3646
'bzrlib.tests.per_tree',
3647
'bzrlib.tests.per_pack_repository',
3648
'bzrlib.tests.per_repository',
3649
'bzrlib.tests.per_repository_chk',
3650
'bzrlib.tests.per_repository_reference',
3651
'bzrlib.tests.per_uifactory',
3652
'bzrlib.tests.per_versionedfile',
3653
'bzrlib.tests.per_workingtree',
3654
'bzrlib.tests.test__annotator',
3655
'bzrlib.tests.test__bencode',
3656
'bzrlib.tests.test__chk_map',
3657
'bzrlib.tests.test__dirstate_helpers',
3658
'bzrlib.tests.test__groupcompress',
3659
'bzrlib.tests.test__known_graph',
3660
'bzrlib.tests.test__rio',
3661
'bzrlib.tests.test__simple_set',
3662
'bzrlib.tests.test__static_tuple',
3663
'bzrlib.tests.test__walkdirs_win32',
3664
'bzrlib.tests.test_ancestry',
3665
'bzrlib.tests.test_annotate',
3666
'bzrlib.tests.test_api',
3667
'bzrlib.tests.test_atomicfile',
3668
'bzrlib.tests.test_bad_files',
3669
'bzrlib.tests.test_bisect_multi',
3670
'bzrlib.tests.test_branch',
3671
'bzrlib.tests.test_branchbuilder',
3672
'bzrlib.tests.test_btree_index',
3673
'bzrlib.tests.test_bugtracker',
3674
'bzrlib.tests.test_bundle',
3675
'bzrlib.tests.test_bzrdir',
3676
'bzrlib.tests.test__chunks_to_lines',
3677
'bzrlib.tests.test_cache_utf8',
3678
'bzrlib.tests.test_chk_map',
3679
'bzrlib.tests.test_chk_serializer',
3680
'bzrlib.tests.test_chunk_writer',
3681
'bzrlib.tests.test_clean_tree',
3682
'bzrlib.tests.test_cleanup',
3683
'bzrlib.tests.test_cmdline',
3684
'bzrlib.tests.test_commands',
3685
'bzrlib.tests.test_commit',
3686
'bzrlib.tests.test_commit_merge',
3687
'bzrlib.tests.test_config',
3688
'bzrlib.tests.test_conflicts',
3689
'bzrlib.tests.test_counted_lock',
3690
'bzrlib.tests.test_crash',
3691
'bzrlib.tests.test_decorators',
3692
'bzrlib.tests.test_delta',
3693
'bzrlib.tests.test_debug',
3694
'bzrlib.tests.test_deprecated_graph',
3695
'bzrlib.tests.test_diff',
3696
'bzrlib.tests.test_directory_service',
3697
'bzrlib.tests.test_dirstate',
3698
'bzrlib.tests.test_email_message',
3699
'bzrlib.tests.test_eol_filters',
3700
'bzrlib.tests.test_errors',
3701
'bzrlib.tests.test_export',
3702
'bzrlib.tests.test_extract',
3703
'bzrlib.tests.test_fetch',
3704
'bzrlib.tests.test_fifo_cache',
3705
'bzrlib.tests.test_filters',
3706
'bzrlib.tests.test_ftp_transport',
3707
'bzrlib.tests.test_foreign',
3708
'bzrlib.tests.test_generate_docs',
3709
'bzrlib.tests.test_generate_ids',
3710
'bzrlib.tests.test_globbing',
3711
'bzrlib.tests.test_gpg',
3712
'bzrlib.tests.test_graph',
3713
'bzrlib.tests.test_groupcompress',
3714
'bzrlib.tests.test_hashcache',
3715
'bzrlib.tests.test_help',
3716
'bzrlib.tests.test_hooks',
3717
'bzrlib.tests.test_http',
3718
'bzrlib.tests.test_http_response',
3719
'bzrlib.tests.test_https_ca_bundle',
3720
'bzrlib.tests.test_identitymap',
3721
'bzrlib.tests.test_ignores',
3722
'bzrlib.tests.test_index',
3723
'bzrlib.tests.test_import_tariff',
3724
'bzrlib.tests.test_info',
3725
'bzrlib.tests.test_inv',
3726
'bzrlib.tests.test_inventory_delta',
3727
'bzrlib.tests.test_knit',
3728
'bzrlib.tests.test_lazy_import',
3729
'bzrlib.tests.test_lazy_regex',
3730
'bzrlib.tests.test_lock',
3731
'bzrlib.tests.test_lockable_files',
3732
'bzrlib.tests.test_lockdir',
3733
'bzrlib.tests.test_log',
3734
'bzrlib.tests.test_lru_cache',
3735
'bzrlib.tests.test_lsprof',
3736
'bzrlib.tests.test_mail_client',
3737
'bzrlib.tests.test_matchers',
3738
'bzrlib.tests.test_memorytree',
3739
'bzrlib.tests.test_merge',
3740
'bzrlib.tests.test_merge3',
3741
'bzrlib.tests.test_merge_core',
3742
'bzrlib.tests.test_merge_directive',
3743
'bzrlib.tests.test_missing',
3744
'bzrlib.tests.test_msgeditor',
3745
'bzrlib.tests.test_multiparent',
3746
'bzrlib.tests.test_mutabletree',
3747
'bzrlib.tests.test_nonascii',
3748
'bzrlib.tests.test_options',
3749
'bzrlib.tests.test_osutils',
3750
'bzrlib.tests.test_osutils_encodings',
3751
'bzrlib.tests.test_pack',
3752
'bzrlib.tests.test_patch',
3753
'bzrlib.tests.test_patches',
3754
'bzrlib.tests.test_permissions',
3755
'bzrlib.tests.test_plugins',
3756
'bzrlib.tests.test_progress',
2664
'bzrlib.util.tests.test_bencode',
2665
'bzrlib.tests.test__dirstate_helpers',
2666
'bzrlib.tests.test_ancestry',
2667
'bzrlib.tests.test_annotate',
2668
'bzrlib.tests.test_api',
2669
'bzrlib.tests.test_atomicfile',
2670
'bzrlib.tests.test_bad_files',
2671
'bzrlib.tests.test_bisect_multi',
2672
'bzrlib.tests.test_branch',
2673
'bzrlib.tests.test_branchbuilder',
2674
'bzrlib.tests.test_bugtracker',
2675
'bzrlib.tests.test_bundle',
2676
'bzrlib.tests.test_bzrdir',
2677
'bzrlib.tests.test_cache_utf8',
2678
'bzrlib.tests.test_commands',
2679
'bzrlib.tests.test_commit',
2680
'bzrlib.tests.test_commit_merge',
2681
'bzrlib.tests.test_config',
2682
'bzrlib.tests.test_conflicts',
2683
'bzrlib.tests.test_counted_lock',
2684
'bzrlib.tests.test_decorators',
2685
'bzrlib.tests.test_delta',
2686
'bzrlib.tests.test_deprecated_graph',
2687
'bzrlib.tests.test_diff',
2688
'bzrlib.tests.test_dirstate',
2689
'bzrlib.tests.test_directory_service',
2690
'bzrlib.tests.test_email_message',
2691
'bzrlib.tests.test_errors',
2692
'bzrlib.tests.test_escaped_store',
2693
'bzrlib.tests.test_extract',
2694
'bzrlib.tests.test_fetch',
2695
'bzrlib.tests.test_ftp_transport',
2696
'bzrlib.tests.test_generate_docs',
2697
'bzrlib.tests.test_generate_ids',
2698
'bzrlib.tests.test_globbing',
2699
'bzrlib.tests.test_gpg',
2700
'bzrlib.tests.test_graph',
2701
'bzrlib.tests.test_hashcache',
2702
'bzrlib.tests.test_help',
2703
'bzrlib.tests.test_hooks',
2704
'bzrlib.tests.test_http',
2705
'bzrlib.tests.test_http_implementations',
2706
'bzrlib.tests.test_http_response',
2707
'bzrlib.tests.test_https_ca_bundle',
2708
'bzrlib.tests.test_identitymap',
2709
'bzrlib.tests.test_ignores',
2710
'bzrlib.tests.test_index',
2711
'bzrlib.tests.test_info',
2712
'bzrlib.tests.test_inv',
2713
'bzrlib.tests.test_knit',
2714
'bzrlib.tests.test_lazy_import',
2715
'bzrlib.tests.test_lazy_regex',
2716
'bzrlib.tests.test_lockdir',
2717
'bzrlib.tests.test_lockable_files',
2718
'bzrlib.tests.test_log',
2719
'bzrlib.tests.test_lsprof',
2720
'bzrlib.tests.test_lru_cache',
2721
'bzrlib.tests.test_mail_client',
2722
'bzrlib.tests.test_memorytree',
2723
'bzrlib.tests.test_merge',
2724
'bzrlib.tests.test_merge3',
2725
'bzrlib.tests.test_merge_core',
2726
'bzrlib.tests.test_merge_directive',
2727
'bzrlib.tests.test_missing',
2728
'bzrlib.tests.test_msgeditor',
2729
'bzrlib.tests.test_multiparent',
2730
'bzrlib.tests.test_mutabletree',
2731
'bzrlib.tests.test_nonascii',
2732
'bzrlib.tests.test_options',
2733
'bzrlib.tests.test_osutils',
2734
'bzrlib.tests.test_osutils_encodings',
2735
'bzrlib.tests.test_pack',
2736
'bzrlib.tests.test_patch',
2737
'bzrlib.tests.test_patches',
2738
'bzrlib.tests.test_permissions',
2739
'bzrlib.tests.test_plugins',
2740
'bzrlib.tests.test_progress',
2741
'bzrlib.tests.test_reconfigure',
2742
'bzrlib.tests.test_reconcile',
2743
'bzrlib.tests.test_registry',
2744
'bzrlib.tests.test_remote',
2745
'bzrlib.tests.test_repository',
2746
'bzrlib.tests.test_revert',
2747
'bzrlib.tests.test_revision',
2748
'bzrlib.tests.test_revisionspec',
2749
'bzrlib.tests.test_revisiontree',
2750
'bzrlib.tests.test_rio',
2751
'bzrlib.tests.test_sampler',
2752
'bzrlib.tests.test_selftest',
2753
'bzrlib.tests.test_setup',
2754
'bzrlib.tests.test_sftp_transport',
2755
'bzrlib.tests.test_smart',
2756
'bzrlib.tests.test_smart_add',
2757
'bzrlib.tests.test_smart_transport',
2758
'bzrlib.tests.test_smtp_connection',
2759
'bzrlib.tests.test_source',
2760
'bzrlib.tests.test_ssh_transport',
2761
'bzrlib.tests.test_status',
2762
'bzrlib.tests.test_store',
2763
'bzrlib.tests.test_strace',
2764
'bzrlib.tests.test_subsume',
2765
'bzrlib.tests.test_switch',
2766
'bzrlib.tests.test_symbol_versioning',
2767
'bzrlib.tests.test_tag',
2768
'bzrlib.tests.test_testament',
2769
'bzrlib.tests.test_textfile',
2770
'bzrlib.tests.test_textmerge',
2771
'bzrlib.tests.test_timestamp',
2772
'bzrlib.tests.test_trace',
2773
'bzrlib.tests.test_transactions',
2774
'bzrlib.tests.test_transform',
2775
'bzrlib.tests.test_transport',
2776
'bzrlib.tests.test_tree',
2777
'bzrlib.tests.test_treebuilder',
2778
'bzrlib.tests.test_tsort',
2779
'bzrlib.tests.test_tuned_gzip',
2780
'bzrlib.tests.test_ui',
2781
'bzrlib.tests.test_uncommit',
2782
'bzrlib.tests.test_upgrade',
2783
'bzrlib.tests.test_urlutils',
2784
'bzrlib.tests.test_versionedfile',
2785
'bzrlib.tests.test_version',
2786
'bzrlib.tests.test_version_info',
2787
'bzrlib.tests.test_weave',
2788
'bzrlib.tests.test_whitebox',
2789
'bzrlib.tests.test_win32utils',
2790
'bzrlib.tests.test_workingtree',
2791
'bzrlib.tests.test_workingtree_4',
2792
'bzrlib.tests.test_wsgi',
2793
'bzrlib.tests.test_xml',
2795
test_transport_implementations = [
2796
'bzrlib.tests.test_transport_implementations',
3757
2797
'bzrlib.tests.test_read_bundle',
3758
'bzrlib.tests.test_reconcile',
3759
'bzrlib.tests.test_reconfigure',
3760
'bzrlib.tests.test_registry',
3761
'bzrlib.tests.test_remote',
3762
'bzrlib.tests.test_rename_map',
3763
'bzrlib.tests.test_repository',
3764
'bzrlib.tests.test_revert',
3765
'bzrlib.tests.test_revision',
3766
'bzrlib.tests.test_revisionspec',
3767
'bzrlib.tests.test_revisiontree',
3768
'bzrlib.tests.test_rio',
3769
'bzrlib.tests.test_rules',
3770
'bzrlib.tests.test_sampler',
3771
'bzrlib.tests.test_script',
3772
'bzrlib.tests.test_selftest',
3773
'bzrlib.tests.test_serializer',
3774
'bzrlib.tests.test_setup',
3775
'bzrlib.tests.test_sftp_transport',
3776
'bzrlib.tests.test_shelf',
3777
'bzrlib.tests.test_shelf_ui',
3778
'bzrlib.tests.test_smart',
3779
'bzrlib.tests.test_smart_add',
3780
'bzrlib.tests.test_smart_request',
3781
'bzrlib.tests.test_smart_transport',
3782
'bzrlib.tests.test_smtp_connection',
3783
'bzrlib.tests.test_source',
3784
'bzrlib.tests.test_ssh_transport',
3785
'bzrlib.tests.test_status',
3786
'bzrlib.tests.test_store',
3787
'bzrlib.tests.test_strace',
3788
'bzrlib.tests.test_subsume',
3789
'bzrlib.tests.test_switch',
3790
'bzrlib.tests.test_symbol_versioning',
3791
'bzrlib.tests.test_tag',
3792
'bzrlib.tests.test_testament',
3793
'bzrlib.tests.test_textfile',
3794
'bzrlib.tests.test_textmerge',
3795
'bzrlib.tests.test_timestamp',
3796
'bzrlib.tests.test_trace',
3797
'bzrlib.tests.test_transactions',
3798
'bzrlib.tests.test_transform',
3799
'bzrlib.tests.test_transport',
3800
'bzrlib.tests.test_transport_log',
3801
'bzrlib.tests.test_tree',
3802
'bzrlib.tests.test_treebuilder',
3803
'bzrlib.tests.test_tsort',
3804
'bzrlib.tests.test_tuned_gzip',
3805
'bzrlib.tests.test_ui',
3806
'bzrlib.tests.test_uncommit',
3807
'bzrlib.tests.test_upgrade',
3808
'bzrlib.tests.test_upgrade_stacked',
3809
'bzrlib.tests.test_urlutils',
3810
'bzrlib.tests.test_version',
3811
'bzrlib.tests.test_version_info',
3812
'bzrlib.tests.test_weave',
3813
'bzrlib.tests.test_whitebox',
3814
'bzrlib.tests.test_win32utils',
3815
'bzrlib.tests.test_workingtree',
3816
'bzrlib.tests.test_workingtree_4',
3817
'bzrlib.tests.test_wsgi',
3818
'bzrlib.tests.test_xml',
3822
def _test_suite_modules_to_doctest():
3823
"""Return the list of modules to doctest."""
3825
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
2799
loader = TestUtil.TestLoader()
2801
if keep_only is None:
2802
loader = TestUtil.TestLoader()
2804
id_filter = TestIdList(keep_only)
2805
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
2806
suite = loader.suiteClass()
2808
# modules building their suite with loadTestsFromModuleNames
2809
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2811
# modules adapted for transport implementations
2812
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2813
adapter = TransportTestProviderAdapter()
2814
adapt_modules(test_transport_implementations, adapter, loader, suite)
2816
# modules defining their own test_suite()
2817
for package in [p for p in packages_to_test()
2818
if (keep_only is None
2819
or id_filter.refers_to(p.__name__))]:
2820
pack_suite = package.test_suite()
2821
suite.addTest(pack_suite)
2823
modules_to_doctest = [
3829
'bzrlib.branchbuilder',
3830
'bzrlib.decorators',
3831
2826
'bzrlib.export',
3832
2827
'bzrlib.inventory',
3833
2828
'bzrlib.iterablefile',
3834
2829
'bzrlib.lockdir',
3835
2830
'bzrlib.merge3',
3836
2831
'bzrlib.option',
3837
'bzrlib.symbol_versioning',
3838
2833
'bzrlib.tests',
3839
2834
'bzrlib.timestamp',
3840
2835
'bzrlib.version_info_formats.format_custom',
3844
def test_suite(keep_only=None, starting_with=None):
3845
"""Build and return TestSuite for the whole of bzrlib.
3847
:param keep_only: A list of test ids limiting the suite returned.
3849
:param starting_with: An id limiting the suite returned to the tests
3852
This function can be replaced if you need to change the default test
3853
suite on a global basis, but it is not encouraged.
3856
loader = TestUtil.TestLoader()
3858
if keep_only is not None:
3859
id_filter = TestIdList(keep_only)
3861
# We take precedence over keep_only because *at loading time* using
3862
# both options means we will load less tests for the same final result.
3863
def interesting_module(name):
3864
for start in starting_with:
3866
# Either the module name starts with the specified string
3867
name.startswith(start)
3868
# or it may contain tests starting with the specified string
3869
or start.startswith(name)
3873
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3875
elif keep_only is not None:
3876
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3877
def interesting_module(name):
3878
return id_filter.refers_to(name)
3881
loader = TestUtil.TestLoader()
3882
def interesting_module(name):
3883
# No filtering, all modules are interesting
3886
suite = loader.suiteClass()
3888
# modules building their suite with loadTestsFromModuleNames
3889
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3891
for mod in _test_suite_modules_to_doctest():
3892
if not interesting_module(mod):
2838
for mod in modules_to_doctest:
2839
if not (keep_only is None or id_filter.refers_to(mod)):
3893
2840
# No tests to keep here, move along
3896
# note that this really does mean "report only" -- doctest
3897
# still runs the rest of the examples
3898
doc_suite = doctest.DocTestSuite(mod,
3899
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
2843
doc_suite = doctest.DocTestSuite(mod)
3900
2844
except ValueError, e:
3901
2845
print '**failed to get doctest for: %s\n%s' % (mod, e)
3903
if len(doc_suite._tests) == 0:
3904
raise errors.BzrError("no doctests found in %s" % (mod,))
3905
2847
suite.addTest(doc_suite)
3907
2849
default_encoding = sys.getdefaultencoding()
3908
2850
for name, plugin in bzrlib.plugin.plugins().items():
3909
if not interesting_module(plugin.module.__name__):
2851
if keep_only is not None:
2852
if not id_filter.refers_to(plugin.module.__name__):
3911
2854
plugin_suite = plugin.test_suite()
3912
2855
# We used to catch ImportError here and turn it into just a warning,
3913
2856
# but really if you don't have --no-plugins this should be a failure.
3959
2942
for right_name, right_dict in scenarios_right]
3962
def multiply_tests(tests, scenarios, result):
3963
"""Multiply tests_list by scenarios into result.
3965
This is the core workhorse for test parameterisation.
3967
Typically the load_tests() method for a per-implementation test suite will
3968
call multiply_tests and return the result.
3970
:param tests: The tests to parameterise.
3971
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3972
scenario_param_dict).
3973
:param result: A TestSuite to add created tests to.
3975
This returns the passed in result TestSuite with the cross product of all
3976
the tests repeated once for each scenario. Each test is adapted by adding
3977
the scenario name at the end of its id(), and updating the test object's
3978
__dict__ with the scenario_param_dict.
3980
>>> import bzrlib.tests.test_sampler
3981
>>> r = multiply_tests(
3982
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3983
... [('one', dict(param=1)),
3984
... ('two', dict(param=2))],
3986
>>> tests = list(iter_suite_tests(r))
3990
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3996
for test in iter_suite_tests(tests):
3997
apply_scenarios(test, scenarios, result)
4001
def apply_scenarios(test, scenarios, result):
4002
"""Apply the scenarios in scenarios to test and add to result.
4004
:param test: The test to apply scenarios to.
4005
:param scenarios: An iterable of scenarios to apply to test.
4007
:seealso: apply_scenario
4009
for scenario in scenarios:
4010
result.addTest(apply_scenario(test, scenario))
4014
def apply_scenario(test, scenario):
4015
"""Copy test and apply scenario to it.
4017
:param test: A test to adapt.
4018
:param scenario: A tuple describing the scenarion.
4019
The first element of the tuple is the new test id.
4020
The second element is a dict containing attributes to set on the
4022
:return: The adapted test.
4024
new_id = "%s(%s)" % (test.id(), scenario[0])
4025
new_test = clone_test(test, new_id)
4026
for name, value in scenario[1].items():
4027
setattr(new_test, name, value)
4031
def clone_test(test, new_id):
4032
"""Clone a test giving it a new id.
4034
:param test: The test to clone.
4035
:param new_id: The id to assign to it.
4036
:return: The new test.
4038
new_test = copy(test)
4039
new_test.id = lambda: new_id
4043
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4045
"""Helper for permutating tests against an extension module.
4047
This is meant to be used inside a modules 'load_tests()' function. It will
4048
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4049
against both implementations. Setting 'test.module' to the appropriate
4050
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4052
:param standard_tests: A test suite to permute
4053
:param loader: A TestLoader
4054
:param py_module_name: The python path to a python module that can always
4055
be loaded, and will be considered the 'python' implementation. (eg
4056
'bzrlib._chk_map_py')
4057
:param ext_module_name: The python path to an extension module. If the
4058
module cannot be loaded, a single test will be added, which notes that
4059
the module is not available. If it can be loaded, all standard_tests
4060
will be run against that module.
4061
:return: (suite, feature) suite is a test-suite that has all the permuted
4062
tests. feature is the Feature object that can be used to determine if
4063
the module is available.
4066
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4068
('python', {'module': py_module}),
4070
suite = loader.suiteClass()
4071
feature = ModuleAvailableFeature(ext_module_name)
4072
if feature.available():
4073
scenarios.append(('C', {'module': feature.module}))
4075
# the compiled module isn't available, so we add a failing test
4076
class FailWithoutFeature(TestCase):
4077
def test_fail(self):
4078
self.requireFeature(feature)
4079
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4080
result = multiply_tests(standard_tests, scenarios, suite)
4081
return result, feature
4084
def _rmtree_temp_dir(dirname, test_id=None):
2946
def adapt_modules(mods_list, adapter, loader, suite):
2947
"""Adapt the modules in mods_list using adapter and add to suite."""
2948
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2949
suite.addTests(adapter.adapt(test))
2952
def adapt_tests(tests_list, adapter, loader, suite):
2953
"""Adapt the tests in tests_list using adapter and add to suite."""
2954
for test in tests_list:
2955
suite.addTests(adapter.adapt(loader.loadTestsFromName(test)))
2958
def _rmtree_temp_dir(dirname):
4085
2959
# If LANG=C we probably have created some bogus paths
4086
2960
# which rmtree(unicode) will fail to delete
4087
2961
# so make sure we are using rmtree(str) to delete everything
added
removed
bzrlib/tests/__init__.py
