368
275
"""The test will not be run because of a missing feature.
370
277
# this can be called in two different ways: it may be that the
371
# test started running, and then raised (through requireFeature)
278
# test started running, and then raised (through addError)
372
279
# UnavailableFeature. Alternatively this method can be called
373
# while probing for features before running the test code proper; in
374
# that case we will see startTest and stopTest, but the test will
375
# never actually run.
280
# while probing for features before running the tests; in that
281
# case we will see startTest and stopTest, but the test will never
376
283
self.unsupported.setdefault(str(feature), 0)
377
284
self.unsupported[str(feature)] += 1
378
285
self.report_unsupported(test, feature)
380
def addSkip(self, test, reason):
381
"""A test has not run for 'reason'."""
383
self.report_skip(test, reason)
385
def addNotApplicable(self, test, reason):
386
self.not_applicable_count += 1
387
self.report_not_applicable(test, reason)
389
def _post_mortem(self):
390
"""Start a PDB post mortem session."""
391
if os.environ.get('BZR_TEST_PDB', None):
392
import pdb;pdb.post_mortem()
394
def progress(self, offset, whence):
395
"""The test is adjusting the count of tests to run."""
396
if whence == SUBUNIT_SEEK_SET:
397
self.num_tests = offset
398
elif whence == SUBUNIT_SEEK_CUR:
399
self.num_tests += offset
401
raise errors.BzrError("Unknown whence %r" % whence)
287
def _addSkipped(self, test, skip_excinfo):
288
if isinstance(skip_excinfo[1], TestNotApplicable):
289
self.not_applicable_count += 1
290
self.report_not_applicable(test, skip_excinfo)
293
self.report_skip(test, skip_excinfo)
296
except KeyboardInterrupt:
299
self.addError(test, test._exc_info())
301
# seems best to treat this as success from point-of-view of unittest
302
# -- it actually does nothing so it barely matters :)
303
unittest.TestResult.addSuccess(self, test)
304
test._log_contents = ''
306
def printErrorList(self, flavour, errors):
307
for test, err in errors:
308
self.stream.writeln(self.separator1)
309
self.stream.write("%s: " % flavour)
310
self.stream.writeln(self.getDescription(test))
311
if getattr(test, '_get_log', None) is not None:
312
self.stream.write('\n')
314
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
315
self.stream.write('\n')
316
self.stream.write(test._get_log())
317
self.stream.write('\n')
319
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
320
self.stream.write('\n')
321
self.stream.writeln(self.separator2)
322
self.stream.writeln("%s" % err)
403
327
def report_cleaning_up(self):
406
def startTestRun(self):
407
self.startTime = time.time()
409
330
def report_success(self, test):
598
509
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
512
self.stream = unittest._WritelnDecorator(stream)
623
513
self.descriptions = descriptions
624
514
self.verbosity = verbosity
625
515
self._bench_history = bench_history
626
self._strict = strict
627
self._result_decorators = result_decorators or []
516
self.list_only = list_only
629
518
def run(self, test):
630
519
"Run the given test case or test suite."
520
startTime = time.time()
631
521
if self.verbosity == 1:
632
522
result_class = TextTestResult
633
523
elif self.verbosity >= 2:
634
524
result_class = VerboseTestResult
635
original_result = result_class(self.stream,
525
result = result_class(self.stream,
636
526
self.descriptions,
638
528
bench_history=self._bench_history,
529
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()
531
result.stop_early = self.stop_on_failure
532
result.report_starting()
534
if self.verbosity >= 2:
535
self.stream.writeln("Listing tests only ...\n")
537
for t in iter_suite_tests(test):
538
self.stream.writeln("%s" % (t.id()))
540
actionTaken = "Listed"
652
# higher level code uses our extended protocol to determine
653
# what exit code to give.
654
return original_result
543
run = result.testsRun
545
stopTime = time.time()
546
timeTaken = stopTime - startTime
548
self.stream.writeln(result.separator2)
549
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
550
run, run != 1 and "s" or "", timeTaken))
551
self.stream.writeln()
552
if not result.wasSuccessful():
553
self.stream.write("FAILED (")
554
failed, errored = map(len, (result.failures, result.errors))
556
self.stream.write("failures=%d" % failed)
558
if failed: self.stream.write(", ")
559
self.stream.write("errors=%d" % errored)
560
if result.known_failure_count:
561
if failed or errored: self.stream.write(", ")
562
self.stream.write("known_failure_count=%d" %
563
result.known_failure_count)
564
self.stream.writeln(")")
566
if result.known_failure_count:
567
self.stream.writeln("OK (known_failures=%d)" %
568
result.known_failure_count)
570
self.stream.writeln("OK")
571
if result.skip_count > 0:
572
skipped = result.skip_count
573
self.stream.writeln('%d test%s skipped' %
574
(skipped, skipped != 1 and "s" or ""))
575
if result.unsupported:
576
for feature, count in sorted(result.unsupported.items()):
577
self.stream.writeln("Missing feature '%s' skipped %d tests." %
657
583
def iter_suite_tests(suite):
658
584
"""Return all tests in a suite, recursing through nested suites"""
659
if isinstance(suite, unittest.TestCase):
661
elif isinstance(suite, unittest.TestSuite):
585
for item in suite._tests:
586
if isinstance(item, unittest.TestCase):
588
elif isinstance(item, unittest.TestSuite):
663
589
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
592
raise Exception('unknown object %r inside test suite %r'
596
class TestSkipped(Exception):
597
"""Indicates that a test was intentionally skipped, rather than failing."""
673
600
class TestNotApplicable(TestSkipped):
674
601
"""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
603
This is only normally raised by parameterized tests, if they find that
604
the instance they're constructed upon does not support one aspect
678
605
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
609
class KnownFailure(AssertionError):
610
"""Indicates that a test failed in a precisely expected manner.
612
Such failures dont block the whole test suite from passing because they are
613
indicators of partially completed code or of future work. We have an
614
explicit error for them so that we can ensure that they are always visible:
615
KnownFailures are always shown in the output of bzr selftest.
701
619
class UnavailableFeature(Exception):
702
620
"""A feature required for this test was not available.
704
This can be considered a specialised form of SkippedTest.
706
622
The feature should be used to construct the exception.
626
class CommandFailed(Exception):
710
630
class StringIOWrapper(object):
711
631
"""A wrapper around cStringIO which just adds an encoding attribute.
713
633
Internally we can check sys.stdout to see what the output encoding
714
634
should be. However, cStringIO has no encoding attribute that we can
715
635
set. So we wrap it instead.
798
749
_leaking_threads_tests = 0
799
750
_first_thread_leaker_id = None
800
751
_log_file_name = None
753
_keep_log_file = False
801
754
# record lsprof data when performing benchmark calls.
802
755
_gather_lsprof_in_benchmarks = False
756
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
757
'_log_contents', '_log_file_name', '_benchtime',
758
'_TestCase__testMethodName')
804
760
def __init__(self, methodName='testMethod'):
805
761
super(TestCase, self).__init__(methodName)
806
762
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)]))
765
unittest.TestCase.setUp(self)
821
766
self._cleanEnvironment()
822
767
self._silenceUI()
823
768
self._startLogFile()
824
769
self._benchcalls = []
825
770
self._benchtime = None
826
771
self._clear_hooks()
827
self._track_transports()
829
772
self._clear_debug_flags()
830
773
TestCase._active_threads = threading.activeCount()
831
774
self.addCleanup(self._check_leaked_threads)
836
pdb.Pdb().set_trace(sys._getframe().f_back)
838
776
def _check_leaked_threads(self):
839
777
active = threading.activeCount()
840
778
leaked_threads = active - TestCase._active_threads
841
779
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
781
TestCase._leaking_threads_tests += 1
850
782
if TestCase._first_thread_leaker_id is None:
851
783
TestCase._first_thread_leaker_id = self.id()
784
# we're not specifically told when all tests are finished.
785
# This will do. We use a function to avoid keeping a reference
786
# to a TestCase object.
787
atexit.register(_report_leaked_threads)
853
789
def _clear_debug_flags(self):
854
790
"""Prevent externally set debug flags affecting tests.
856
792
Tests that want to use debug flags can just set them in the
857
793
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
795
if 'allow_debug' not in selftest_debug_flags:
796
self._preserved_debug_flags = set(debug.debug_flags)
862
797
debug.debug_flags.clear()
863
if 'disable_lock_checks' not in selftest_debug_flags:
864
debug.debug_flags.add('strict_locks')
798
self.addCleanup(self._restore_debug_flags)
866
800
def _clear_hooks(self):
867
801
# 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)
803
import bzrlib.smart.server
804
self._preserved_hooks = {
805
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
806
bzrlib.mutabletree.MutableTree: bzrlib.mutabletree.MutableTree.hooks,
807
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
873
809
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
810
# reset all hooks to an empty instance of the appropriate type
811
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
812
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
888
814
def _silenceUI(self):
889
815
"""Turn off UI for duration of test"""
890
816
# 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.")
817
saved = ui.ui_factory
819
ui.ui_factory = saved
820
ui.ui_factory = ui.SilentUIFactory()
821
self.addCleanup(_restore)
1071
823
def _ndiff_strings(self, a, b):
1072
824
"""Return ndiff between two strings containing lines.
1074
826
A trailing newline is added if missing to make the strings
1075
827
print properly."""
1076
828
if b and b[-1] != '\n':
1111
863
if message is None:
1112
864
message = "texts not equal:\n"
866
message = 'first string is missing a final newline.\n'
1113
867
if a + '\n' == b:
1114
message = 'first string is missing a final newline.\n'
1116
868
message = 'second string is missing a final newline.\n'
1117
869
raise AssertionError(message +
1118
870
self._ndiff_strings(a, b))
1120
872
def assertEqualMode(self, mode, mode_test):
1121
873
self.assertEqual(mode, mode_test,
1122
874
'mode mismatch %o != %o' % (mode, mode_test))
1124
def assertEqualStat(self, expected, actual):
1125
"""assert that expected and actual are the same stat result.
1127
:param expected: A stat result.
1128
:param actual: A stat result.
1129
:raises AssertionError: If the expected and actual stat values differ
1130
other than by atime.
1132
self.assertEqual(expected.st_size, actual.st_size,
1133
'st_size did not match')
1134
self.assertEqual(expected.st_mtime, actual.st_mtime,
1135
'st_mtime did not match')
1136
self.assertEqual(expected.st_ctime, actual.st_ctime,
1137
'st_ctime did not match')
1138
if sys.platform != 'win32':
1139
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1140
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1141
# odd. Regardless we shouldn't actually try to assert anything
1142
# about their values
1143
self.assertEqual(expected.st_dev, actual.st_dev,
1144
'st_dev did not match')
1145
self.assertEqual(expected.st_ino, actual.st_ino,
1146
'st_ino did not match')
1147
self.assertEqual(expected.st_mode, actual.st_mode,
1148
'st_mode did not match')
1150
def assertLength(self, length, obj_with_len):
1151
"""Assert that obj_with_len is of length length."""
1152
if len(obj_with_len) != length:
1153
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1154
length, len(obj_with_len), obj_with_len))
1156
def assertLogsError(self, exception_class, func, *args, **kwargs):
1157
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1159
from bzrlib import trace
1161
orig_log_exception_quietly = trace.log_exception_quietly
1164
orig_log_exception_quietly()
1165
captured.append(sys.exc_info())
1166
trace.log_exception_quietly = capture
1167
func(*args, **kwargs)
1169
trace.log_exception_quietly = orig_log_exception_quietly
1170
self.assertLength(1, captured)
1171
err = captured[0][1]
1172
self.assertIsInstance(err, exception_class)
1175
876
def assertPositive(self, val):
1176
877
"""Assert that val is greater than 0."""
1177
878
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1467
1184
Close the file and delete it, unless setKeepLogfile was called.
1469
if bzrlib.trace._trace_file:
1470
# flush the log file, to get all content
1471
bzrlib.trace._trace_file.flush()
1186
if self._log_file is None:
1472
1188
bzrlib.trace.pop_log_file(self._log_memento)
1473
# Cache the log result and delete the file on disk
1474
self._get_log(False)
1476
def thisFailsStrictLockCheck(self):
1477
"""It is known that this test would fail with -Dstrict_locks.
1479
By default, all tests are run with strict lock checking unless
1480
-Edisable_lock_checks is supplied. However there are some tests which
1481
we know fail strict locks at this point that have not been fixed.
1482
They should call this function to disable the strict checking.
1484
This should be used sparingly, it is much better to fix the locking
1485
issues rather than papering over the problem by calling this function.
1487
debug.debug_flags.discard('strict_locks')
1489
def addCleanup(self, callable, *args, **kwargs):
1189
self._log_file.close()
1190
self._log_file = None
1191
if not self._keep_log_file:
1192
os.remove(self._log_file_name)
1193
self._log_file_name = None
1195
def setKeepLogfile(self):
1196
"""Make the logfile not be deleted when _finishLogFile is called."""
1197
self._keep_log_file = True
1199
def addCleanup(self, callable):
1490
1200
"""Arrange to run a callable when this case is torn down.
1492
Callables are run in the reverse of the order they are registered,
1202
Callables are run in the reverse of the order they are registered,
1493
1203
ie last-in first-out.
1495
self._cleanups.append((callable, args, kwargs))
1497
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1498
"""Overrides an object attribute restoring it after the test.
1500
:param obj: The object that will be mutated.
1502
:param attr_name: The attribute name we want to preserve/override in
1505
:param new: The optional value we want to set the attribute to.
1507
:returns: The actual attr value.
1509
value = getattr(obj, attr_name)
1510
# The actual value is captured by the call below
1511
self.addCleanup(setattr, obj, attr_name, value)
1512
if new is not _unitialized_attr:
1513
setattr(obj, attr_name, new)
1205
if callable in self._cleanups:
1206
raise ValueError("cleanup function %r already registered on %s"
1208
self._cleanups.append(callable)
1516
1210
def _cleanEnvironment(self):
1518
1212
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1519
1213
'HOME': os.getcwd(),
1520
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1521
# tests do check our impls match APPDATA
1214
'APPDATA': None, # bzr now use Win32 API and don't rely on APPDATA
1522
1215
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1525
1216
'BZR_EMAIL': None,
1526
1217
'BZREMAIL': None, # may still be present in the environment
1528
1219
'BZR_PROGRESS_BAR': None,
1529
1220
'BZR_LOG': None,
1530
'BZR_PLUGIN_PATH': None,
1531
'BZR_DISABLE_PLUGINS': None,
1532
'BZR_PLUGINS_AT': None,
1533
'BZR_CONCURRENCY': None,
1534
# Make sure that any text ui tests are consistent regardless of
1535
# the environment the test case is run in; you may want tests that
1536
# test other combinations. 'dumb' is a reasonable guess for tests
1537
# going to a pipe or a StringIO.
1541
'BZR_COLUMNS': '80',
1543
1222
'SSH_AUTH_SOCK': None,
1550
1229
'NO_PROXY': None,
1551
1230
'all_proxy': None,
1552
1231
'ALL_PROXY': None,
1553
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1232
# Nobody cares about these ones AFAIK. So far at
1554
1233
# least. If you do (care), please update this comment
1556
1235
'ftp_proxy': None,
1557
1236
'FTP_PROXY': None,
1558
1237
'BZR_REMOTE_PATH': None,
1559
# Generally speaking, we don't want apport reporting on crashes in
1560
# the test envirnoment unless we're specifically testing apport,
1561
# so that it doesn't leak into the real system environment. We
1562
# use an env var so it propagates to subprocesses.
1563
'APPORT_DISABLE': '1',
1566
1240
self.addCleanup(self._restoreEnvironment)
1567
1241
for name, value in new_env.iteritems():
1568
1242
self._captureVar(name, value)
1570
1244
def _captureVar(self, name, newvalue):
1571
1245
"""Set an environment variable, and reset it when finished."""
1572
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1246
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1248
def _restore_debug_flags(self):
1249
debug.debug_flags.clear()
1250
debug.debug_flags.update(self._preserved_debug_flags)
1574
1252
def _restoreEnvironment(self):
1575
for name, value in self._old_env.iteritems():
1253
for name, value in self.__old_env.iteritems():
1576
1254
osutils.set_or_unset_env(name, value)
1578
1256
def _restoreHooks(self):
1579
for klass, (name, hooks) in self._preserved_hooks.items():
1580
setattr(klass, name, hooks)
1257
for klass, hooks in self._preserved_hooks.items():
1258
setattr(klass, 'hooks', hooks)
1582
1260
def knownFailure(self, reason):
1583
1261
"""This test has failed for some known reason."""
1584
1262
raise KnownFailure(reason)
1586
def _do_skip(self, result, reason):
1587
addSkip = getattr(result, 'addSkip', None)
1588
if not callable(addSkip):
1589
result.addSuccess(result)
1591
addSkip(self, reason)
1594
def _do_known_failure(self, result, e):
1595
err = sys.exc_info()
1596
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1597
if addExpectedFailure is not None:
1598
addExpectedFailure(self, err)
1600
result.addSuccess(self)
1603
def _do_not_applicable(self, result, e):
1605
reason = 'No reason given'
1608
addNotApplicable = getattr(result, 'addNotApplicable', None)
1609
if addNotApplicable is not None:
1610
result.addNotApplicable(self, reason)
1612
self._do_skip(result, reason)
1615
def _do_unsupported_or_skip(self, result, e):
1617
addNotSupported = getattr(result, 'addNotSupported', None)
1618
if addNotSupported is not None:
1619
result.addNotSupported(self, reason)
1621
self._do_skip(result, reason)
1264
def run(self, result=None):
1265
if result is None: result = self.defaultTestResult()
1266
for feature in getattr(self, '_test_needs_features', []):
1267
if not feature.available():
1268
result.startTest(self)
1269
if getattr(result, 'addNotSupported', None):
1270
result.addNotSupported(self, feature)
1272
result.addSuccess(self)
1273
result.stopTest(self)
1276
return unittest.TestCase.run(self, result)
1279
absent_attr = object()
1280
for attr_name in self.attrs_to_keep:
1281
attr = getattr(self, attr_name, absent_attr)
1282
if attr is not absent_attr:
1283
saved_attrs[attr_name] = attr
1284
self.__dict__ = saved_attrs
1288
unittest.TestCase.tearDown(self)
1623
1290
def time(self, callable, *args, **kwargs):
1624
1291
"""Run callable and accrue the time it takes to the benchmark time.
1626
1293
If lsprofiling is enabled (i.e. by --lsprof-time to bzr selftest) then
1627
1294
this will cause lsprofile statistics to be gathered and stored in
1628
1295
self._benchcalls.
1630
1297
if self._benchtime is None:
1631
self.addDetail('benchtime', content.Content(content.ContentType(
1632
"text", "plain"), lambda:[str(self._benchtime)]))
1633
1298
self._benchtime = 0
1634
1299
start = time.time()
2399
1980
def make_repository(self, relpath, shared=False, format=None):
2400
1981
"""Create a repository on our default transport at relpath.
2402
1983
Note that relpath must be a relative path, not a full url.
2404
1985
# FIXME: If you create a remoterepository this returns the underlying
2405
# real format, which is incorrect. Actually we should make sure that
1986
# real format, which is incorrect. Actually we should make sure that
2406
1987
# RemoteBzrDir returns a RemoteRepository.
2407
1988
# maybe mbp 20070410
2408
1989
made_control = self.make_bzrdir(relpath, format=format)
2409
1990
return made_control.create_repository(shared=shared)
2411
def make_smart_server(self, path):
2412
smart_server = test_server.SmartTCPServer_for_testing()
2413
self.start_server(smart_server, self.get_server())
2414
remote_transport = get_transport(smart_server.get_url()).clone(path)
2415
return remote_transport
2417
1992
def make_branch_and_memory_tree(self, relpath, format=None):
2418
1993
"""Create a branch on the default transport and a MemoryTree for it."""
2419
1994
b = self.make_branch(relpath, format=format)
2420
1995
return memorytree.MemoryTree.create_on_branch(b)
2422
1997
def make_branch_builder(self, relpath, format=None):
2423
branch = self.make_branch(relpath, format=format)
2424
return branchbuilder.BranchBuilder(branch=branch)
1998
url = self.get_url(relpath)
1999
tran = get_transport(url)
2000
return branchbuilder.BranchBuilder(get_transport(url), format=format)
2426
2002
def overrideEnvironmentForTesting(self):
2427
test_home_dir = self.test_home_dir
2428
if isinstance(test_home_dir, unicode):
2429
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2430
os.environ['HOME'] = test_home_dir
2431
os.environ['BZR_HOME'] = test_home_dir
2003
os.environ['HOME'] = self.test_home_dir
2004
os.environ['BZR_HOME'] = self.test_home_dir
2433
2006
def setUp(self):
2434
2007
super(TestCaseWithMemoryTransport, self).setUp()
2435
2008
self._make_test_root()
2436
self.addCleanup(os.chdir, os.getcwdu())
2009
_currentdir = os.getcwdu()
2010
def _leaveDirectory():
2011
os.chdir(_currentdir)
2012
self.addCleanup(_leaveDirectory)
2437
2013
self.makeAndChdirToTestDir()
2438
2014
self.overrideEnvironmentForTesting()
2439
2015
self.__readonly_server = None
2440
2016
self.__server = None
2441
2017
self.reduceLockdirTimeout()
2443
def setup_smart_server_with_call_log(self):
2444
"""Sets up a smart server as the transport server with a call log."""
2445
self.transport_server = test_server.SmartTCPServer_for_testing
2446
self.hpss_calls = []
2448
# Skip the current stack down to the caller of
2449
# setup_smart_server_with_call_log
2450
prefix_length = len(traceback.extract_stack()) - 2
2451
def capture_hpss_call(params):
2452
self.hpss_calls.append(
2453
CapturedCall(params, prefix_length))
2454
client._SmartClient.hooks.install_named_hook(
2455
'call', capture_hpss_call, None)
2457
def reset_smart_call_log(self):
2458
self.hpss_calls = []
2461
2020
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2462
2021
"""Derived class that runs a test within a temporary directory.
2927
2459
list_only=False,
2928
2460
random_seed=None,
2929
2461
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
2463
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2948
if runner_class is None:
2949
runner_class = TextTestRunner
2952
runner = runner_class(stream=stream,
2468
runner = TextTestRunner(stream=sys.stdout,
2953
2469
descriptions=0,
2954
2470
verbosity=verbosity,
2955
2471
bench_history=bench_history,
2957
result_decorators=result_decorators,
2472
list_only=list_only,
2959
2474
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))
2475
# Initialise the random number generator and display the seed used.
2476
# We convert the seed to a long to make it reuseable across invocations.
2477
random_order = False
2478
if random_seed is not None:
2480
if random_seed == "now":
2481
random_seed = long(time.time())
2483
# Convert the seed to a long if we can
2485
random_seed = long(random_seed)
2488
runner.stream.writeln("Randomizing test order using seed %s\n" %
2490
random.seed(random_seed)
2491
# Customise the list of tests if requested
2492
if exclude_pattern is not None:
2493
suite = exclude_tests_by_re(suite, exclude_pattern)
2495
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()))
2497
order_changer = preserve_input
2498
if pattern != '.*' or random_order:
2499
if matching_tests_first:
2500
suites = map(order_changer, split_suite_by_re(suite, pattern))
2501
suite = TestUtil.TestSuite(suites)
2503
suite = order_changer(filter_suite_by_re(suite, pattern))
2986
2505
result = runner.run(suite)
2988
2508
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
2510
return result.wasSuccessful()
3388
2513
# 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
2514
selftest_debug_flags = set()
3572
2670
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).
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',
3755
'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
3827
'bzrlib.branchbuilder',
3828
'bzrlib.decorators',
3831
'bzrlib.iterablefile',
3835
'bzrlib.symbol_versioning',
3838
'bzrlib.version_info_formats.format_custom',
3842
2673
def test_suite(keep_only=None, starting_with=None):
3843
2674
"""Build and return TestSuite for the whole of bzrlib.
3850
2681
This function can be replaced if you need to change the default test
3851
2682
suite on a global basis, but it is not encouraged.
2686
'bzrlib.util.tests.test_bencode',
2687
'bzrlib.tests.blackbox',
2688
'bzrlib.tests.branch_implementations',
2689
'bzrlib.tests.bzrdir_implementations',
2690
'bzrlib.tests.commands',
2691
'bzrlib.tests.inventory_implementations',
2692
'bzrlib.tests.interrepository_implementations',
2693
'bzrlib.tests.intertree_implementations',
2694
'bzrlib.tests.per_lock',
2695
'bzrlib.tests.repository_implementations',
2696
'bzrlib.tests.test__dirstate_helpers',
2697
'bzrlib.tests.test_ancestry',
2698
'bzrlib.tests.test_annotate',
2699
'bzrlib.tests.test_api',
2700
'bzrlib.tests.test_atomicfile',
2701
'bzrlib.tests.test_bad_files',
2702
'bzrlib.tests.test_bisect_multi',
2703
'bzrlib.tests.test_branch',
2704
'bzrlib.tests.test_branchbuilder',
2705
'bzrlib.tests.test_bugtracker',
2706
'bzrlib.tests.test_bundle',
2707
'bzrlib.tests.test_bzrdir',
2708
'bzrlib.tests.test_cache_utf8',
2709
'bzrlib.tests.test_commands',
2710
'bzrlib.tests.test_commit',
2711
'bzrlib.tests.test_commit_merge',
2712
'bzrlib.tests.test_config',
2713
'bzrlib.tests.test_conflicts',
2714
'bzrlib.tests.test_counted_lock',
2715
'bzrlib.tests.test_decorators',
2716
'bzrlib.tests.test_delta',
2717
'bzrlib.tests.test_deprecated_graph',
2718
'bzrlib.tests.test_diff',
2719
'bzrlib.tests.test_dirstate',
2720
'bzrlib.tests.test_directory_service',
2721
'bzrlib.tests.test_email_message',
2722
'bzrlib.tests.test_errors',
2723
'bzrlib.tests.test_extract',
2724
'bzrlib.tests.test_fetch',
2725
'bzrlib.tests.test_ftp_transport',
2726
'bzrlib.tests.test_generate_docs',
2727
'bzrlib.tests.test_generate_ids',
2728
'bzrlib.tests.test_globbing',
2729
'bzrlib.tests.test_gpg',
2730
'bzrlib.tests.test_graph',
2731
'bzrlib.tests.test_hashcache',
2732
'bzrlib.tests.test_help',
2733
'bzrlib.tests.test_hooks',
2734
'bzrlib.tests.test_http',
2735
'bzrlib.tests.test_http_implementations',
2736
'bzrlib.tests.test_http_response',
2737
'bzrlib.tests.test_https_ca_bundle',
2738
'bzrlib.tests.test_identitymap',
2739
'bzrlib.tests.test_ignores',
2740
'bzrlib.tests.test_index',
2741
'bzrlib.tests.test_info',
2742
'bzrlib.tests.test_inv',
2743
'bzrlib.tests.test_knit',
2744
'bzrlib.tests.test_lazy_import',
2745
'bzrlib.tests.test_lazy_regex',
2746
'bzrlib.tests.test_lockdir',
2747
'bzrlib.tests.test_lockable_files',
2748
'bzrlib.tests.test_log',
2749
'bzrlib.tests.test_lsprof',
2750
'bzrlib.tests.test_lru_cache',
2751
'bzrlib.tests.test_mail_client',
2752
'bzrlib.tests.test_memorytree',
2753
'bzrlib.tests.test_merge',
2754
'bzrlib.tests.test_merge3',
2755
'bzrlib.tests.test_merge_core',
2756
'bzrlib.tests.test_merge_directive',
2757
'bzrlib.tests.test_missing',
2758
'bzrlib.tests.test_msgeditor',
2759
'bzrlib.tests.test_multiparent',
2760
'bzrlib.tests.test_mutabletree',
2761
'bzrlib.tests.test_nonascii',
2762
'bzrlib.tests.test_options',
2763
'bzrlib.tests.test_osutils',
2764
'bzrlib.tests.test_osutils_encodings',
2765
'bzrlib.tests.test_pack',
2766
'bzrlib.tests.test_pack_repository',
2767
'bzrlib.tests.test_patch',
2768
'bzrlib.tests.test_patches',
2769
'bzrlib.tests.test_permissions',
2770
'bzrlib.tests.test_plugins',
2771
'bzrlib.tests.test_progress',
2772
'bzrlib.tests.test_read_bundle',
2773
'bzrlib.tests.test_reconfigure',
2774
'bzrlib.tests.test_reconcile',
2775
'bzrlib.tests.test_registry',
2776
'bzrlib.tests.test_remote',
2777
'bzrlib.tests.test_repository',
2778
'bzrlib.tests.per_repository_reference',
2779
'bzrlib.tests.test_revert',
2780
'bzrlib.tests.test_revision',
2781
'bzrlib.tests.test_revisionspec',
2782
'bzrlib.tests.test_revisiontree',
2783
'bzrlib.tests.test_rio',
2784
'bzrlib.tests.test_rules',
2785
'bzrlib.tests.test_sampler',
2786
'bzrlib.tests.test_selftest',
2787
'bzrlib.tests.test_setup',
2788
'bzrlib.tests.test_sftp_transport',
2789
'bzrlib.tests.test_smart',
2790
'bzrlib.tests.test_smart_add',
2791
'bzrlib.tests.test_smart_transport',
2792
'bzrlib.tests.test_smtp_connection',
2793
'bzrlib.tests.test_source',
2794
'bzrlib.tests.test_ssh_transport',
2795
'bzrlib.tests.test_status',
2796
'bzrlib.tests.test_store',
2797
'bzrlib.tests.test_strace',
2798
'bzrlib.tests.test_subsume',
2799
'bzrlib.tests.test_switch',
2800
'bzrlib.tests.test_symbol_versioning',
2801
'bzrlib.tests.test_tag',
2802
'bzrlib.tests.test_testament',
2803
'bzrlib.tests.test_textfile',
2804
'bzrlib.tests.test_textmerge',
2805
'bzrlib.tests.test_timestamp',
2806
'bzrlib.tests.test_trace',
2807
'bzrlib.tests.test_transactions',
2808
'bzrlib.tests.test_transform',
2809
'bzrlib.tests.test_transport',
2810
'bzrlib.tests.test_transport_implementations',
2811
'bzrlib.tests.test_tree',
2812
'bzrlib.tests.test_treebuilder',
2813
'bzrlib.tests.test_tsort',
2814
'bzrlib.tests.test_tuned_gzip',
2815
'bzrlib.tests.test_ui',
2816
'bzrlib.tests.test_uncommit',
2817
'bzrlib.tests.test_upgrade',
2818
'bzrlib.tests.test_upgrade_stacked',
2819
'bzrlib.tests.test_urlutils',
2820
'bzrlib.tests.test_versionedfile',
2821
'bzrlib.tests.test_version',
2822
'bzrlib.tests.test_version_info',
2823
'bzrlib.tests.test__walkdirs_win32',
2824
'bzrlib.tests.test_weave',
2825
'bzrlib.tests.test_whitebox',
2826
'bzrlib.tests.test_win32utils',
2827
'bzrlib.tests.test_workingtree',
2828
'bzrlib.tests.test_workingtree_4',
2829
'bzrlib.tests.test_wsgi',
2830
'bzrlib.tests.test_xml',
2831
'bzrlib.tests.tree_implementations',
2832
'bzrlib.tests.workingtree_implementations',
3854
2835
loader = TestUtil.TestLoader()
3856
if keep_only is not None:
3857
id_filter = TestIdList(keep_only)
2837
if starting_with is not None:
3859
2838
# We take precedence over keep_only because *at loading time* using
3860
2839
# both options means we will load less tests for the same final result.
3861
2840
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)
2842
# Either the module name starts with the specified string
2843
name.startswith(starting_with)
2844
# or it may contain tests starting with the specified string
2845
or starting_with.startswith(name)
3871
2847
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3873
2849
elif keep_only is not None:
2850
id_filter = TestIdList(keep_only)
3874
2851
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3875
2852
def interesting_module(name):
3876
2853
return id_filter.refers_to(name)
3957
2996
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):
3000
def adapt_modules(mods_list, adapter, loader, suite):
3001
"""Adapt the modules in mods_list using adapter and add to suite."""
3002
tests = loader.loadTestsFromModuleNames(mods_list)
3003
adapt_tests(tests, adapter, suite)
3006
def adapt_tests(tests_list, adapter, suite):
3007
"""Adapt the tests in tests_list using adapter and add to suite."""
3008
for test in iter_suite_tests(tests_list):
3009
suite.addTests(adapter.adapt(test))
3012
def _rmtree_temp_dir(dirname):
4083
3013
# If LANG=C we probably have created some bogus paths
4084
3014
# which rmtree(unicode) will fail to delete
4085
3015
# so make sure we are using rmtree(str) to delete everything
4189
3117
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4192
class _CompatabilityThunkFeature(Feature):
4193
"""This feature is just a thunk to another feature.
4195
It issues a deprecation warning if it is accessed, to let you know that you
4196
should really use a different feature.
4199
def __init__(self, dep_version, module, name,
4200
replacement_name, replacement_module=None):
4201
super(_CompatabilityThunkFeature, self).__init__()
4202
self._module = module
4203
if replacement_module is None:
4204
replacement_module = module
4205
self._replacement_module = replacement_module
4207
self._replacement_name = replacement_name
4208
self._dep_version = dep_version
4209
self._feature = None
4212
if self._feature is None:
4213
depr_msg = self._dep_version % ('%s.%s'
4214
% (self._module, self._name))
4215
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4216
self._replacement_name)
4217
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4218
# Import the new feature and use it as a replacement for the
4220
mod = __import__(self._replacement_module, {}, {},
4221
[self._replacement_name])
4222
self._feature = getattr(mod, self._replacement_name)
4226
return self._feature._probe()
4229
class ModuleAvailableFeature(Feature):
4230
"""This is a feature than describes a module we want to be available.
4232
Declare the name of the module in __init__(), and then after probing, the
4233
module will be available as 'self.module'.
4235
:ivar module: The module if it is available, else None.
4238
def __init__(self, module_name):
4239
super(ModuleAvailableFeature, self).__init__()
4240
self.module_name = module_name
4244
self._module = __import__(self.module_name, {}, {}, [''])
4251
if self.available(): # Make sure the probe has been done
4255
def feature_name(self):
4256
return self.module_name
4259
# This is kept here for compatibility, it is recommended to use
4260
# 'bzrlib.tests.feature.paramiko' instead
4261
ParamikoFeature = _CompatabilityThunkFeature(
4262
deprecated_in((2,1,0)),
4263
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
3120
class TestScenarioApplier(object):
3121
"""A tool to apply scenarios to tests."""
3123
def adapt(self, test):
3124
"""Return a TestSuite containing a copy of test for each scenario."""
3125
result = unittest.TestSuite()
3126
for scenario in self.scenarios:
3127
result.addTest(self.adapt_test_to_scenario(test, scenario))
3130
def adapt_test_to_scenario(self, test, scenario):
3131
"""Copy test and apply scenario to it.
3133
:param test: A test to adapt.
3134
:param scenario: A tuple describing the scenarion.
3135
The first element of the tuple is the new test id.
3136
The second element is a dict containing attributes to set on the
3138
:return: The adapted test.
3140
from copy import deepcopy
3141
new_test = deepcopy(test)
3142
for name, value in scenario[1].items():
3143
setattr(new_test, name, value)
3144
new_id = "%s(%s)" % (new_test.id(), scenario[0])
3145
new_test.id = lambda: new_id
4266
3149
def probe_unicode_in_user_encoding():
added
removed
bzrlib/tests/__init__.py
