319
241
def addError(self, test, err):
320
"""Tell result that test finished with an error.
322
Called from the TestCase run() method when the test
323
fails with an unexpected error.
242
self.extractBenchmarkTime(test)
243
self._cleanupLogFile(test)
244
if isinstance(err[1], TestSkipped):
245
return self.addSkipped(test, err)
246
elif isinstance(err[1], UnavailableFeature):
247
return self.addNotSupported(test, err[1].args[0])
326
248
unittest.TestResult.addError(self, test, err)
327
249
self.error_count += 1
328
250
self.report_error(test, err)
329
251
if self.stop_early:
254
def addFailure(self, test, err):
331
255
self._cleanupLogFile(test)
333
def addFailure(self, test, err):
334
"""Tell result that test failed.
336
Called from the TestCase run() method when the test
337
fails because e.g. an assert() method failed.
256
self.extractBenchmarkTime(test)
257
if isinstance(err[1], KnownFailure):
258
return self.addKnownFailure(test, err)
340
259
unittest.TestResult.addFailure(self, test, err)
341
260
self.failure_count += 1
342
261
self.report_failure(test, err)
343
262
if self.stop_early:
345
self._cleanupLogFile(test)
347
def addSuccess(self, test, details=None):
348
"""Tell result that test completed successfully.
350
Called from the TestCase run()
352
if self._bench_history is not None:
353
benchmark_time = self._extractBenchmarkTime(test, details)
354
if benchmark_time is not None:
355
self._bench_history.write("%s %s\n" % (
356
self._formatTime(benchmark_time),
358
self.report_success(test)
359
self._cleanupLogFile(test)
360
unittest.TestResult.addSuccess(self, test)
361
test._log_contents = ''
363
def addExpectedFailure(self, test, err):
265
def addKnownFailure(self, test, err):
364
266
self.known_failure_count += 1
365
267
self.report_known_failure(test, err)
367
269
def addNotSupported(self, test, feature):
368
"""The test will not be run because of a missing feature.
370
# this can be called in two different ways: it may be that the
371
# test started running, and then raised (through requireFeature)
372
# 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.
376
270
self.unsupported.setdefault(str(feature), 0)
377
271
self.unsupported[str(feature)] += 1
378
272
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
274
def addSuccess(self, test):
275
self.extractBenchmarkTime(test)
276
if self._bench_history is not None:
277
if self._benchmarkTime is not None:
278
self._bench_history.write("%s %s\n" % (
279
self._formatTime(self._benchmarkTime),
281
self.report_success(test)
282
unittest.TestResult.addSuccess(self, test)
284
def addSkipped(self, test, skip_excinfo):
285
self.report_skip(test, skip_excinfo)
286
# seems best to treat this as success from point-of-view of unittest
287
# -- it actually does nothing so it barely matters :)
290
except KeyboardInterrupt:
293
self.addError(test, test.__exc_info())
401
raise errors.BzrError("Unknown whence %r" % whence)
295
unittest.TestResult.addSuccess(self, test)
297
def printErrorList(self, flavour, errors):
298
for test, err in errors:
299
self.stream.writeln(self.separator1)
300
self.stream.write("%s: " % flavour)
301
if self.use_numbered_dirs:
302
self.stream.write('#%d ' % test.number)
303
self.stream.writeln(self.getDescription(test))
304
if getattr(test, '_get_log', None) is not None:
306
print >>self.stream, \
307
('vvvv[log from %s]' % test.id()).ljust(78,'-')
308
print >>self.stream, test._get_log()
309
print >>self.stream, \
310
('^^^^[log from %s]' % test.id()).ljust(78,'-')
311
self.stream.writeln(self.separator2)
312
self.stream.writeln("%s" % err)
403
317
def report_cleaning_up(self):
406
def startTestRun(self):
407
self.startTime = time.time()
409
320
def report_success(self, test):
412
def wasStrictlySuccessful(self):
413
if self.unsupported or self.known_failure_count:
415
return self.wasSuccessful()
418
324
class TextTestResult(ExtendedTestResult):
419
325
"""Displays progress and results of tests in text form"""
421
327
def __init__(self, stream, descriptions, verbosity,
422
328
bench_history=None,
331
use_numbered_dirs=False,
426
333
ExtendedTestResult.__init__(self, stream, descriptions, verbosity,
427
bench_history, strict)
428
# We no longer pass them around, but just rely on the UIFactory stack
431
warnings.warn("Passing pb to TextTestResult is deprecated")
432
self.pb = self.ui.nested_progress_bar()
334
bench_history, num_tests, use_numbered_dirs)
336
self.pb = self.ui.nested_progress_bar()
337
self._supplied_pb = False
340
self._supplied_pb = True
433
341
self.pb.show_pct = False
434
342
self.pb.show_spinner = False
435
343
self.pb.show_eta = False,
436
344
self.pb.show_count = False
437
345
self.pb.show_bar = False
438
self.pb.update_latency = 0
439
self.pb.show_transport_activity = False
441
def stopTestRun(self):
442
# called when the tests that are going to run have run
445
super(TextTestResult, self).stopTestRun()
447
def startTestRun(self):
448
super(TextTestResult, self).startTestRun()
449
self.pb.update('[test 0/%d] Starting' % (self.num_tests))
451
def printErrors(self):
452
# clear the pb to make room for the error listing
454
super(TextTestResult, self).printErrors()
347
def report_starting(self):
348
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
456
350
def _progress_prefix_text(self):
457
# the longer this text, the less space we have to show the test
459
a = '[%d' % self.count # total that have been run
460
# tests skipped as known not to be relevant are not important enough
462
## if self.skip_count:
463
## a += ', %d skip' % self.skip_count
464
## if self.known_failure_count:
465
## a += '+%dX' % self.known_failure_count
351
a = '[%d' % self.count
352
if self.num_tests is not None:
467
353
a +='/%d' % self.num_tests
469
runtime = time.time() - self._overall_start_time
471
a += '%dm%ds' % (runtime / 60, runtime % 60)
474
total_fail_count = self.error_count + self.failure_count
476
a += ', %d failed' % total_fail_count
477
# if self.unsupported:
478
# a += ', %d missing' % len(self.unsupported)
354
a += ' in %ds' % (time.time() - self._overall_start_time)
356
a += ', %d errors' % self.error_count
357
if self.failure_count:
358
a += ', %d failed' % self.failure_count
359
if self.known_failure_count:
360
a += ', %d known failures' % self.known_failure_count
362
a += ', %d skipped' % self.skip_count
364
a += ', %d missing features' % len(self.unsupported)
784
718
retrieved by _get_log(). We use a real OS file, not an in-memory object,
785
719
so that it can also capture file IO. When the test completes this file
786
720
is read into memory and removed from disk.
788
722
There are also convenience functions to invoke bzr's command-line
789
723
routine, and to build and check bzr trees.
791
725
In addition to the usual method of overriding tearDown(), this class also
792
726
allows subclasses to register functions into the _cleanups list, which is
793
727
run in order as the object is torn down. It's less likely this will be
794
728
accidentally overlooked.
797
_active_threads = None
798
_leaking_threads_tests = 0
799
_first_thread_leaker_id = None
800
731
_log_file_name = None
733
_keep_log_file = False
801
734
# record lsprof data when performing benchmark calls.
802
735
_gather_lsprof_in_benchmarks = False
804
737
def __init__(self, methodName='testMethod'):
805
738
super(TestCase, self).__init__(methodName)
806
739
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)]))
742
unittest.TestCase.setUp(self)
821
743
self._cleanEnvironment()
744
bzrlib.trace.disable_default_logging()
822
745
self._silenceUI()
823
746
self._startLogFile()
824
747
self._benchcalls = []
825
748
self._benchtime = None
826
749
self._clear_hooks()
827
self._track_transports()
829
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
def _clear_debug_flags(self):
854
"""Prevent externally set debug flags affecting tests.
856
Tests that want to use debug flags can just set them in the
857
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:
862
debug.debug_flags.clear()
863
if 'disable_lock_checks' not in selftest_debug_flags:
864
debug.debug_flags.add('strict_locks')
866
751
def _clear_hooks(self):
867
752
# 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)
754
import bzrlib.smart.server
755
self._preserved_hooks = {
756
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
757
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
873
759
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
760
# reset all hooks to an empty instance of the appropriate type
761
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
762
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
763
# FIXME: Rather than constructing new objects like this, how about
764
# having save() and clear() methods on the base Hook class? mbp
888
767
def _silenceUI(self):
889
768
"""Turn off UI for duration of test"""
890
769
# 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.")
770
saved = ui.ui_factory
772
ui.ui_factory = saved
773
ui.ui_factory = ui.SilentUIFactory()
774
self.addCleanup(_restore)
1071
776
def _ndiff_strings(self, a, b):
1072
777
"""Return ndiff between two strings containing lines.
1074
779
A trailing newline is added if missing to make the strings
1075
780
print properly."""
1076
781
if b and b[-1] != '\n':
2720
2060
for readonly urls.
2722
2062
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2723
be used without needed to redo it when a different
2063
be used without needed to redo it when a different
2724
2064
subclass is in use ?
2727
2067
def setUp(self):
2728
2068
super(ChrootedTestCase, self).setUp()
2729
if not self.vfs_transport_factory == memory.MemoryServer:
2069
if not self.vfs_transport_factory == MemoryServer:
2730
2070
self.transport_readonly_server = HttpServer
2733
def condition_id_re(pattern):
2734
"""Create a condition filter which performs a re check on a test's id.
2736
:param pattern: A regular expression string.
2737
:return: A callable that returns True if the re matches.
2739
filter_re = osutils.re_compile_checked(pattern, 0,
2741
def condition(test):
2073
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2074
random_order=False):
2075
"""Create a test suite by filtering another one.
2077
:param suite: the source suite
2078
:param pattern: pattern that names must match
2079
:param exclude_pattern: pattern that names must not match, if any
2080
:param random_order: if True, tests in the new suite will be put in
2082
:returns: the newly created suite
2084
return sort_suite_by_re(suite, pattern, exclude_pattern,
2085
random_order, False)
2088
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2089
random_order=False, append_rest=True):
2090
"""Create a test suite by sorting another one.
2092
:param suite: the source suite
2093
:param pattern: pattern that names must match in order to go
2094
first in the new suite
2095
:param exclude_pattern: pattern that names must not match, if any
2096
:param random_order: if True, tests in the new suite will be put in
2098
:param append_rest: if False, pattern is a strict filter and not
2099
just an ordering directive
2100
:returns: the newly created suite
2104
filter_re = re.compile(pattern)
2105
if exclude_pattern is not None:
2106
exclude_re = re.compile(exclude_pattern)
2107
for test in iter_suite_tests(suite):
2742
2108
test_id = test.id()
2743
return filter_re.search(test_id)
2747
def condition_isinstance(klass_or_klass_list):
2748
"""Create a condition filter which returns isinstance(param, klass).
2750
:return: A callable which when called with one parameter obj return the
2751
result of isinstance(obj, klass_or_klass_list).
2754
return isinstance(obj, klass_or_klass_list)
2758
def condition_id_in_list(id_list):
2759
"""Create a condition filter which verify that test's id in a list.
2761
:param id_list: A TestIdList object.
2762
:return: A callable that returns True if the test's id appears in the list.
2764
def condition(test):
2765
return id_list.includes(test.id())
2769
def condition_id_startswith(starts):
2770
"""Create a condition filter verifying that test's id starts with a string.
2772
:param starts: A list of string.
2773
:return: A callable that returns True if the test's id starts with one of
2776
def condition(test):
2777
for start in starts:
2778
if test.id().startswith(start):
2784
def exclude_tests_by_condition(suite, condition):
2785
"""Create a test suite which excludes some tests from suite.
2787
:param suite: The suite to get tests from.
2788
:param condition: A callable whose result evaluates True when called with a
2789
test case which should be excluded from the result.
2790
:return: A suite which contains the tests found in suite that fail
2794
for test in iter_suite_tests(suite):
2795
if not condition(test):
2797
return TestUtil.TestSuite(result)
2800
def filter_suite_by_condition(suite, condition):
2801
"""Create a test suite by filtering another one.
2803
:param suite: The source suite.
2804
:param condition: A callable whose result evaluates True when called with a
2805
test case which should be included in the result.
2806
:return: A suite which contains the tests found in suite that pass
2810
for test in iter_suite_tests(suite):
2813
return TestUtil.TestSuite(result)
2816
def filter_suite_by_re(suite, pattern):
2817
"""Create a test suite by filtering another one.
2819
:param suite: the source suite
2820
:param pattern: pattern that names must match
2821
:returns: the newly created suite
2823
condition = condition_id_re(pattern)
2824
result_suite = filter_suite_by_condition(suite, condition)
2828
def filter_suite_by_id_list(suite, test_id_list):
2829
"""Create a test suite by filtering another one.
2831
:param suite: The source suite.
2832
:param test_id_list: A list of the test ids to keep as strings.
2833
:returns: the newly created suite
2835
condition = condition_id_in_list(test_id_list)
2836
result_suite = filter_suite_by_condition(suite, condition)
2840
def filter_suite_by_id_startswith(suite, start):
2841
"""Create a test suite by filtering another one.
2843
:param suite: The source suite.
2844
:param start: A list of string the test id must start with one of.
2845
:returns: the newly created suite
2847
condition = condition_id_startswith(start)
2848
result_suite = filter_suite_by_condition(suite, condition)
2852
def exclude_tests_by_re(suite, pattern):
2853
"""Create a test suite which excludes some tests from suite.
2855
:param suite: The suite to get tests from.
2856
:param pattern: A regular expression string. Test ids that match this
2857
pattern will be excluded from the result.
2858
:return: A TestSuite that contains all the tests from suite without the
2859
tests that matched pattern. The order of tests is the same as it was in
2862
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2865
def preserve_input(something):
2866
"""A helper for performing test suite transformation chains.
2868
:param something: Anything you want to preserve.
2874
def randomize_suite(suite):
2875
"""Return a new TestSuite with suite's tests in random order.
2877
The tests in the input suite are flattened into a single suite in order to
2878
accomplish this. Any nested TestSuites are removed to provide global
2881
tests = list(iter_suite_tests(suite))
2882
random.shuffle(tests)
2883
return TestUtil.TestSuite(tests)
2886
def split_suite_by_condition(suite, condition):
2887
"""Split a test suite into two by a condition.
2889
:param suite: The suite to split.
2890
:param condition: The condition to match on. Tests that match this
2891
condition are returned in the first test suite, ones that do not match
2892
are in the second suite.
2893
:return: A tuple of two test suites, where the first contains tests from
2894
suite matching the condition, and the second contains the remainder
2895
from suite. The order within each output suite is the same as it was in
2900
for test in iter_suite_tests(suite):
2902
matched.append(test)
2904
did_not_match.append(test)
2905
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2908
def split_suite_by_re(suite, pattern):
2909
"""Split a test suite into two by a regular expression.
2911
:param suite: The suite to split.
2912
:param pattern: A regular expression string. Test ids that match this
2913
pattern will be in the first test suite returned, and the others in the
2914
second test suite returned.
2915
:return: A tuple of two test suites, where the first contains tests from
2916
suite matching pattern, and the second contains the remainder from
2917
suite. The order within each output suite is the same as it was in
2920
return split_suite_by_condition(suite, condition_id_re(pattern))
2109
if exclude_pattern is None or not exclude_re.search(test_id):
2110
if filter_re.search(test_id):
2115
random.shuffle(first)
2116
random.shuffle(second)
2117
return TestUtil.TestSuite(first + second)
2923
2120
def run_suite(suite, name='test', verbose=False, pattern=".*",
2924
2121
stop_on_failure=False,
2925
2122
transport=None, lsprof_timed=None, bench_history=None,
2926
2123
matching_tests_first=None,
2927
2125
list_only=False,
2928
2126
random_seed=None,
2929
2127
exclude_pattern=None,
2932
suite_decorators=None,
2934
result_decorators=None,
2936
"""Run a test suite for bzr selftest.
2129
use_numbered_dirs = bool(numbered_dirs)
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
2131
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2132
if numbered_dirs is not None:
2133
TestCaseInTempDir.use_numbered_dirs = use_numbered_dirs
2948
if runner_class is None:
2949
runner_class = TextTestRunner
2952
runner = runner_class(stream=stream,
2138
runner = TextTestRunner(stream=sys.stdout,
2953
2139
descriptions=0,
2954
2140
verbosity=verbosity,
2955
2141
bench_history=bench_history,
2957
result_decorators=result_decorators,
2142
use_numbered_dirs=use_numbered_dirs,
2143
list_only=list_only,
2959
2145
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))
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()))
2986
result = runner.run(suite)
2988
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())
2146
# Initialise the random number generator and display the seed used.
2147
# We convert the seed to a long to make it reuseable across invocations.
2148
random_order = False
2149
if random_seed is not None:
2151
if random_seed == "now":
2152
random_seed = long(time.time())
3164
2154
# Convert the seed to a long if we can
3166
self.random_seed = long(self.random_seed)
2156
random_seed = long(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)
2159
runner.stream.writeln("Randomizing test order using seed %s\n" %
2161
random.seed(random_seed)
2162
# Customise the list of tests if requested
2163
if pattern != '.*' or exclude_pattern is not None or random_order:
2164
if matching_tests_first:
2165
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
3262
stream = os.fdopen(c2pread, 'rb', 1)
3263
test = TestInOtherProcess(stream, pid)
3268
def reinvoke_for_tests(suite):
3269
"""Take suite and start up one runner per CPU using subprocess().
3271
:return: An iterable of TestCase-like objects which can each have
3272
run(result) called on them to feed tests to result.
3274
concurrency = osutils.local_concurrency()
3276
from subunit import ProtocolTestCase
3277
class TestInSubprocess(ProtocolTestCase):
3278
def __init__(self, process, name):
3279
ProtocolTestCase.__init__(self, process.stdout)
3280
self.process = process
3281
self.process.stdin.close()
3284
def run(self, result):
3286
ProtocolTestCase.run(self, result)
3289
os.unlink(self.name)
3290
# print "pid %d finished" % finished_process
3291
test_blocks = partition_tests(suite, concurrency)
3292
for process_tests in test_blocks:
3293
# ugly; currently reimplement rather than reuses TestCase methods.
3294
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3295
if not os.path.isfile(bzr_path):
3296
# We are probably installed. Assume sys.argv is the right file
3297
bzr_path = sys.argv[0]
3298
bzr_path = [bzr_path]
3299
if sys.platform == "win32":
3300
# if we're on windows, we can't execute the bzr script directly
3301
bzr_path = [sys.executable] + bzr_path
3302
fd, test_list_file_name = tempfile.mkstemp()
3303
test_list_file = os.fdopen(fd, 'wb', 1)
3304
for test in process_tests:
3305
test_list_file.write(test.id() + '\n')
3306
test_list_file.close()
3308
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3310
if '--no-plugins' in sys.argv:
3311
argv.append('--no-plugins')
3312
# stderr=STDOUT would be ideal, but until we prevent noise on
3313
# stderr it can interrupt the subunit protocol.
3314
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3316
test = TestInSubprocess(process, test_list_file_name)
3319
os.unlink(test_list_file_name)
3324
class ForwardingResult(unittest.TestResult):
3326
def __init__(self, target):
3327
unittest.TestResult.__init__(self)
3328
self.result = target
3330
def startTest(self, test):
3331
self.result.startTest(test)
3333
def stopTest(self, test):
3334
self.result.stopTest(test)
3336
def startTestRun(self):
3337
self.result.startTestRun()
3339
def stopTestRun(self):
3340
self.result.stopTestRun()
3342
def addSkip(self, test, reason):
3343
self.result.addSkip(test, reason)
3345
def addSuccess(self, test):
3346
self.result.addSuccess(test)
3348
def addError(self, test, err):
3349
self.result.addError(test, err)
3351
def addFailure(self, test, err):
3352
self.result.addFailure(test, err)
3353
ForwardingResult = testtools.ExtendedToOriginalDecorator
3356
class ProfileResult(ForwardingResult):
3357
"""Generate profiling data for all activity between start and success.
3359
The profile data is appended to the test's _benchcalls attribute and can
3360
be accessed by the forwarded-to TestResult.
3362
While it might be cleaner do accumulate this in stopTest, addSuccess is
3363
where our existing output support for lsprof is, and this class aims to
3364
fit in with that: while it could be moved it's not necessary to accomplish
3365
test profiling, nor would it be dramatically cleaner.
3368
def startTest(self, test):
3369
self.profiler = bzrlib.lsprof.BzrProfiler()
3370
self.profiler.start()
3371
ForwardingResult.startTest(self, test)
3373
def addSuccess(self, test):
3374
stats = self.profiler.stop()
3376
calls = test._benchcalls
3377
except AttributeError:
3378
test._benchcalls = []
3379
calls = test._benchcalls
3380
calls.append(((test.id(), "", ""), stats))
3381
ForwardingResult.addSuccess(self, test)
3383
def stopTest(self, test):
3384
ForwardingResult.stopTest(self, test)
3385
self.profiler = None
3388
# Controlled by "bzr selftest -E=..." option
3389
# Currently supported:
3390
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3391
# preserves any flags supplied at the command line.
3392
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3393
# rather than failing tests. And no longer raise
3394
# LockContention when fctnl locks are not being used
3395
# with proper exclusion rules.
3396
selftest_debug_flags = set()
2168
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2170
result = runner.run(suite)
2171
return result.wasSuccessful()
3399
2174
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3426
2193
transport = default_transport
3427
2194
old_transport = default_transport
3428
2195
default_transport = transport
3429
global selftest_debug_flags
3430
old_debug_flags = selftest_debug_flags
3431
if debug_flags is not None:
3432
selftest_debug_flags = set(debug_flags)
3434
if load_list is None:
3437
keep_only = load_test_id_list(load_list)
3439
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3440
for start in starting_with]
3441
2197
if test_suite_factory is None:
3442
# Reduce loading time by loading modules based on the starting_with
3444
suite = test_suite(keep_only, starting_with)
2198
suite = test_suite()
3446
2200
suite = test_suite_factory()
3448
# But always filter as requested.
3449
suite = filter_suite_by_id_startswith(suite, starting_with)
3450
result_decorators = []
3452
result_decorators.append(ProfileResult)
3453
2201
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3454
2202
stop_on_failure=stop_on_failure,
3455
2203
transport=transport,
3456
2204
lsprof_timed=lsprof_timed,
3457
2205
bench_history=bench_history,
3458
2206
matching_tests_first=matching_tests_first,
2207
numbered_dirs=numbered_dirs,
3459
2208
list_only=list_only,
3460
2209
random_seed=random_seed,
3461
exclude_pattern=exclude_pattern,
3463
runner_class=runner_class,
3464
suite_decorators=suite_decorators,
3466
result_decorators=result_decorators,
2210
exclude_pattern=exclude_pattern)
3469
2212
default_transport = old_transport
3470
selftest_debug_flags = old_debug_flags
3473
def load_test_id_list(file_name):
3474
"""Load a test id list from a text file.
3476
The format is one test id by line. No special care is taken to impose
3477
strict rules, these test ids are used to filter the test suite so a test id
3478
that do not match an existing test will do no harm. This allows user to add
3479
comments, leave blank lines, etc.
3483
ftest = open(file_name, 'rt')
3485
if e.errno != errno.ENOENT:
3488
raise errors.NoSuchFile(file_name)
3490
for test_name in ftest.readlines():
3491
test_list.append(test_name.strip())
3496
def suite_matches_id_list(test_suite, id_list):
3497
"""Warns about tests not appearing or appearing more than once.
3499
:param test_suite: A TestSuite object.
3500
:param test_id_list: The list of test ids that should be found in
3503
:return: (absents, duplicates) absents is a list containing the test found
3504
in id_list but not in test_suite, duplicates is a list containing the
3505
test found multiple times in test_suite.
3507
When using a prefined test id list, it may occurs that some tests do not
3508
exist anymore or that some tests use the same id. This function warns the
3509
tester about potential problems in his workflow (test lists are volatile)
3510
or in the test suite itself (using the same id for several tests does not
3511
help to localize defects).
3513
# Build a dict counting id occurrences
3515
for test in iter_suite_tests(test_suite):
3517
tests[id] = tests.get(id, 0) + 1
3522
occurs = tests.get(id, 0)
3524
not_found.append(id)
3526
duplicates.append(id)
3528
return not_found, duplicates
3531
class TestIdList(object):
3532
"""Test id list to filter a test suite.
3534
Relying on the assumption that test ids are built as:
3535
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3536
notation, this class offers methods to :
3537
- avoid building a test suite for modules not refered to in the test list,
3538
- keep only the tests listed from the module test suite.
3541
def __init__(self, test_id_list):
3542
# When a test suite needs to be filtered against us we compare test ids
3543
# for equality, so a simple dict offers a quick and simple solution.
3544
self.tests = dict().fromkeys(test_id_list, True)
3546
# While unittest.TestCase have ids like:
3547
# <module>.<class>.<method>[(<param+)],
3548
# doctest.DocTestCase can have ids like:
3551
# <module>.<function>
3552
# <module>.<class>.<method>
3554
# Since we can't predict a test class from its name only, we settle on
3555
# a simple constraint: a test id always begins with its module name.
3558
for test_id in test_id_list:
3559
parts = test_id.split('.')
3560
mod_name = parts.pop(0)
3561
modules[mod_name] = True
3563
mod_name += '.' + part
3564
modules[mod_name] = True
3565
self.modules = modules
3567
def refers_to(self, module_name):
3568
"""Is there tests for the module or one of its sub modules."""
3569
return self.modules.has_key(module_name)
3571
def includes(self, test_id):
3572
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
def test_suite(keep_only=None, starting_with=None):
3843
2216
"""Build and return TestSuite for the whole of bzrlib.
3845
:param keep_only: A list of test ids limiting the suite returned.
3847
:param starting_with: An id limiting the suite returned to the tests
3850
2218
This function can be replaced if you need to change the default test
3851
2219
suite on a global basis, but it is not encouraged.
2222
'bzrlib.tests.test_ancestry',
2223
'bzrlib.tests.test_annotate',
2224
'bzrlib.tests.test_api',
2225
'bzrlib.tests.test_atomicfile',
2226
'bzrlib.tests.test_bad_files',
2227
'bzrlib.tests.test_branch',
2228
'bzrlib.tests.test_branchbuilder',
2229
'bzrlib.tests.test_bugtracker',
2230
'bzrlib.tests.test_bundle',
2231
'bzrlib.tests.test_bzrdir',
2232
'bzrlib.tests.test_cache_utf8',
2233
'bzrlib.tests.test_commands',
2234
'bzrlib.tests.test_commit',
2235
'bzrlib.tests.test_commit_merge',
2236
'bzrlib.tests.test_config',
2237
'bzrlib.tests.test_conflicts',
2238
'bzrlib.tests.test_counted_lock',
2239
'bzrlib.tests.test_decorators',
2240
'bzrlib.tests.test_delta',
2241
'bzrlib.tests.test_deprecated_graph',
2242
'bzrlib.tests.test_diff',
2243
'bzrlib.tests.test_dirstate',
2244
'bzrlib.tests.test_errors',
2245
'bzrlib.tests.test_escaped_store',
2246
'bzrlib.tests.test_extract',
2247
'bzrlib.tests.test_fetch',
2248
'bzrlib.tests.test_ftp_transport',
2249
'bzrlib.tests.test_generate_docs',
2250
'bzrlib.tests.test_generate_ids',
2251
'bzrlib.tests.test_globbing',
2252
'bzrlib.tests.test_gpg',
2253
'bzrlib.tests.test_graph',
2254
'bzrlib.tests.test_hashcache',
2255
'bzrlib.tests.test_help',
2256
'bzrlib.tests.test_http',
2257
'bzrlib.tests.test_http_response',
2258
'bzrlib.tests.test_https_ca_bundle',
2259
'bzrlib.tests.test_identitymap',
2260
'bzrlib.tests.test_ignores',
2261
'bzrlib.tests.test_info',
2262
'bzrlib.tests.test_inv',
2263
'bzrlib.tests.test_knit',
2264
'bzrlib.tests.test_lazy_import',
2265
'bzrlib.tests.test_lazy_regex',
2266
'bzrlib.tests.test_lockdir',
2267
'bzrlib.tests.test_lockable_files',
2268
'bzrlib.tests.test_log',
2269
'bzrlib.tests.test_lsprof',
2270
'bzrlib.tests.test_memorytree',
2271
'bzrlib.tests.test_merge',
2272
'bzrlib.tests.test_merge3',
2273
'bzrlib.tests.test_merge_core',
2274
'bzrlib.tests.test_merge_directive',
2275
'bzrlib.tests.test_missing',
2276
'bzrlib.tests.test_msgeditor',
2277
'bzrlib.tests.test_nonascii',
2278
'bzrlib.tests.test_options',
2279
'bzrlib.tests.test_osutils',
2280
'bzrlib.tests.test_osutils_encodings',
2281
'bzrlib.tests.test_patch',
2282
'bzrlib.tests.test_patches',
2283
'bzrlib.tests.test_permissions',
2284
'bzrlib.tests.test_plugins',
2285
'bzrlib.tests.test_progress',
2286
'bzrlib.tests.test_reconcile',
2287
'bzrlib.tests.test_registry',
2288
'bzrlib.tests.test_remote',
2289
'bzrlib.tests.test_repository',
2290
'bzrlib.tests.test_revert',
2291
'bzrlib.tests.test_revision',
2292
'bzrlib.tests.test_revisionnamespaces',
2293
'bzrlib.tests.test_revisiontree',
2294
'bzrlib.tests.test_rio',
2295
'bzrlib.tests.test_sampler',
2296
'bzrlib.tests.test_selftest',
2297
'bzrlib.tests.test_setup',
2298
'bzrlib.tests.test_sftp_transport',
2299
'bzrlib.tests.test_smart',
2300
'bzrlib.tests.test_smart_add',
2301
'bzrlib.tests.test_smart_transport',
2302
'bzrlib.tests.test_smtp_connection',
2303
'bzrlib.tests.test_source',
2304
'bzrlib.tests.test_ssh_transport',
2305
'bzrlib.tests.test_status',
2306
'bzrlib.tests.test_store',
2307
'bzrlib.tests.test_strace',
2308
'bzrlib.tests.test_subsume',
2309
'bzrlib.tests.test_symbol_versioning',
2310
'bzrlib.tests.test_tag',
2311
'bzrlib.tests.test_testament',
2312
'bzrlib.tests.test_textfile',
2313
'bzrlib.tests.test_textmerge',
2314
'bzrlib.tests.test_timestamp',
2315
'bzrlib.tests.test_trace',
2316
'bzrlib.tests.test_transactions',
2317
'bzrlib.tests.test_transform',
2318
'bzrlib.tests.test_transport',
2319
'bzrlib.tests.test_tree',
2320
'bzrlib.tests.test_treebuilder',
2321
'bzrlib.tests.test_tsort',
2322
'bzrlib.tests.test_tuned_gzip',
2323
'bzrlib.tests.test_ui',
2324
'bzrlib.tests.test_upgrade',
2325
'bzrlib.tests.test_urlutils',
2326
'bzrlib.tests.test_versionedfile',
2327
'bzrlib.tests.test_version',
2328
'bzrlib.tests.test_version_info',
2329
'bzrlib.tests.test_weave',
2330
'bzrlib.tests.test_whitebox',
2331
'bzrlib.tests.test_workingtree',
2332
'bzrlib.tests.test_workingtree_4',
2333
'bzrlib.tests.test_wsgi',
2334
'bzrlib.tests.test_xml',
2336
test_transport_implementations = [
2337
'bzrlib.tests.test_transport_implementations',
2338
'bzrlib.tests.test_read_bundle',
2340
suite = TestUtil.TestSuite()
3854
2341
loader = TestUtil.TestLoader()
3856
if keep_only is not None:
3857
id_filter = TestIdList(keep_only)
3859
# We take precedence over keep_only because *at loading time* using
3860
# both options means we will load less tests for the same final result.
3861
def interesting_module(name):
3862
for start in starting_with:
3864
# Either the module name starts with the specified string
3865
name.startswith(start)
3866
# or it may contain tests starting with the specified string
3867
or start.startswith(name)
3871
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3873
elif keep_only is not None:
3874
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3875
def interesting_module(name):
3876
return id_filter.refers_to(name)
3879
loader = TestUtil.TestLoader()
3880
def interesting_module(name):
3881
# No filtering, all modules are interesting
3884
suite = loader.suiteClass()
3886
# modules building their suite with loadTestsFromModuleNames
3887
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3889
for mod in _test_suite_modules_to_doctest():
3890
if not interesting_module(mod):
3891
# No tests to keep here, move along
2342
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2343
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2344
adapter = TransportTestProviderAdapter()
2345
adapt_modules(test_transport_implementations, adapter, loader, suite)
2346
for package in packages_to_test():
2347
suite.addTest(package.test_suite())
2348
for m in MODULES_TO_TEST:
2349
suite.addTest(loader.loadTestsFromModule(m))
2350
for m in MODULES_TO_DOCTEST:
3894
# note that this really does mean "report only" -- doctest
3895
# still runs the rest of the examples
3896
doc_suite = doctest.DocTestSuite(mod,
3897
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
2352
suite.addTest(doctest.DocTestSuite(m))
3898
2353
except ValueError, e:
3899
print '**failed to get doctest for: %s\n%s' % (mod, e)
2354
print '**failed to get doctest for: %s\n%s' %(m,e)
3901
if len(doc_suite._tests) == 0:
3902
raise errors.BzrError("no doctests found in %s" % (mod,))
3903
suite.addTest(doc_suite)
3905
default_encoding = sys.getdefaultencoding()
3906
for name, plugin in bzrlib.plugin.plugins().items():
3907
if not interesting_module(plugin.module.__name__):
3909
plugin_suite = plugin.test_suite()
3910
# We used to catch ImportError here and turn it into just a warning,
3911
# but really if you don't have --no-plugins this should be a failure.
3912
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3913
if plugin_suite is None:
3914
plugin_suite = plugin.load_plugin_tests(loader)
3915
if plugin_suite is not None:
3916
suite.addTest(plugin_suite)
3917
if default_encoding != sys.getdefaultencoding():
3918
bzrlib.trace.warning(
3919
'Plugin "%s" tried to reset default encoding to: %s', name,
3920
sys.getdefaultencoding())
3922
sys.setdefaultencoding(default_encoding)
3924
if keep_only is not None:
3925
# Now that the referred modules have loaded their tests, keep only the
3927
suite = filter_suite_by_id_list(suite, id_filter)
3928
# Do some sanity checks on the id_list filtering
3929
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3931
# The tester has used both keep_only and starting_with, so he is
3932
# already aware that some tests are excluded from the list, there
3933
# is no need to tell him which.
3936
# Some tests mentioned in the list are not in the test suite. The
3937
# list may be out of date, report to the tester.
3938
for id in not_found:
3939
bzrlib.trace.warning('"%s" not found in the test suite', id)
3940
for id in duplicates:
3941
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
2356
for name, plugin in bzrlib.plugin.all_plugins().items():
2357
if getattr(plugin, 'test_suite', None) is not None:
2358
default_encoding = sys.getdefaultencoding()
2360
plugin_suite = plugin.test_suite()
2361
except ImportError, e:
2362
bzrlib.trace.warning(
2363
'Unable to test plugin "%s": %s', name, e)
2365
suite.addTest(plugin_suite)
2366
if default_encoding != sys.getdefaultencoding():
2367
bzrlib.trace.warning(
2368
'Plugin "%s" tried to reset default encoding to: %s', name,
2369
sys.getdefaultencoding())
2371
sys.setdefaultencoding(default_encoding)
3946
def multiply_scenarios(scenarios_left, scenarios_right):
3947
"""Multiply two sets of scenarios.
3949
:returns: the cartesian product of the two sets of scenarios, that is
3950
a scenario for every possible combination of a left scenario and a
3954
('%s,%s' % (left_name, right_name),
3955
dict(left_dict.items() + right_dict.items()))
3956
for left_name, left_dict in scenarios_left
3957
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):
2375
def adapt_modules(mods_list, adapter, loader, suite):
2376
"""Adapt the modules in mods_list using adapter and add to suite."""
2377
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2378
suite.addTests(adapter.adapt(test))
2381
def _rmtree_temp_dir(dirname):
4083
2382
# If LANG=C we probably have created some bogus paths
4084
2383
# which rmtree(unicode) will fail to delete
4085
2384
# so make sure we are using rmtree(str) to delete everything
4132
2447
return self.__class__.__name__
4135
class _SymlinkFeature(Feature):
4138
return osutils.has_symlinks()
4140
def feature_name(self):
4143
SymlinkFeature = _SymlinkFeature()
4146
class _HardlinkFeature(Feature):
4149
return osutils.has_hardlinks()
4151
def feature_name(self):
4154
HardlinkFeature = _HardlinkFeature()
4157
class _OsFifoFeature(Feature):
4160
return getattr(os, 'mkfifo', None)
4162
def feature_name(self):
4163
return 'filesystem fifos'
4165
OsFifoFeature = _OsFifoFeature()
4168
class _UnicodeFilenameFeature(Feature):
4169
"""Does the filesystem support Unicode filenames?"""
4173
# Check for character combinations unlikely to be covered by any
4174
# single non-unicode encoding. We use the characters
4175
# - greek small letter alpha (U+03B1) and
4176
# - braille pattern dots-123456 (U+283F).
4177
os.stat(u'\u03b1\u283f')
4178
except UnicodeEncodeError:
4180
except (IOError, OSError):
4181
# The filesystem allows the Unicode filename but the file doesn't
4185
# The filesystem allows the Unicode filename and the file exists,
4189
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')
4266
def probe_unicode_in_user_encoding():
4267
"""Try to encode several unicode strings to use in unicode-aware tests.
4268
Return first successfull match.
4270
:return: (unicode value, encoded plain string value) or (None, None)
4272
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4273
for uni_val in possible_vals:
4275
str_val = uni_val.encode(osutils.get_user_encoding())
4276
except UnicodeEncodeError:
4277
# Try a different character
4280
return uni_val, str_val
4284
def probe_bad_non_ascii(encoding):
4285
"""Try to find [bad] character with code [128..255]
4286
that cannot be decoded to unicode in some encoding.
4287
Return None if all non-ascii characters is valid
4290
for i in xrange(128, 256):
4293
char.decode(encoding)
4294
except UnicodeDecodeError:
4299
class _HTTPSServerFeature(Feature):
4300
"""Some tests want an https Server, check if one is available.
4302
Right now, the only way this is available is under python2.6 which provides
4313
def feature_name(self):
4314
return 'HTTPSServer'
4317
HTTPSServerFeature = _HTTPSServerFeature()
4320
class _UnicodeFilename(Feature):
4321
"""Does the filesystem support Unicode filenames?"""
4326
except UnicodeEncodeError:
4328
except (IOError, OSError):
4329
# The filesystem allows the Unicode filename but the file doesn't
4333
# The filesystem allows the Unicode filename and the file exists,
4337
UnicodeFilename = _UnicodeFilename()
4340
class _UTF8Filesystem(Feature):
4341
"""Is the filesystem UTF-8?"""
4344
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4348
UTF8Filesystem = _UTF8Filesystem()
4351
class _BreakinFeature(Feature):
4352
"""Does this platform support the breakin feature?"""
4355
from bzrlib import breakin
4356
if breakin.determine_signal() is None:
4358
if sys.platform == 'win32':
4359
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4360
# We trigger SIGBREAK via a Console api so we need ctypes to
4361
# access the function
4368
def feature_name(self):
4369
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4372
BreakinFeature = _BreakinFeature()
4375
class _CaseInsCasePresFilenameFeature(Feature):
4376
"""Is the file-system case insensitive, but case-preserving?"""
4379
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4381
# first check truly case-preserving for created files, then check
4382
# case insensitive when opening existing files.
4383
name = osutils.normpath(name)
4384
base, rel = osutils.split(name)
4385
found_rel = osutils.canonical_relpath(base, name)
4386
return (found_rel == rel
4387
and os.path.isfile(name.upper())
4388
and os.path.isfile(name.lower()))
4393
def feature_name(self):
4394
return "case-insensitive case-preserving filesystem"
4396
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4399
class _CaseInsensitiveFilesystemFeature(Feature):
4400
"""Check if underlying filesystem is case-insensitive but *not* case
4403
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4404
# more likely to be case preserving, so this case is rare.
4407
if CaseInsCasePresFilenameFeature.available():
4410
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4411
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4412
TestCaseWithMemoryTransport.TEST_ROOT = root
4414
root = TestCaseWithMemoryTransport.TEST_ROOT
4415
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4417
name_a = osutils.pathjoin(tdir, 'a')
4418
name_A = osutils.pathjoin(tdir, 'A')
4420
result = osutils.isdir(name_A)
4421
_rmtree_temp_dir(tdir)
2450
class TestScenarioApplier(object):
2451
"""A tool to apply scenarios to tests."""
2453
def adapt(self, test):
2454
"""Return a TestSuite containing a copy of test for each scenario."""
2455
result = unittest.TestSuite()
2456
for scenario in self.scenarios:
2457
result.addTest(self.adapt_test_to_scenario(test, scenario))
4424
def feature_name(self):
4425
return 'case-insensitive filesystem'
4427
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4430
class _CaseSensitiveFilesystemFeature(Feature):
4433
if CaseInsCasePresFilenameFeature.available():
4435
elif CaseInsensitiveFilesystemFeature.available():
4440
def feature_name(self):
4441
return 'case-sensitive filesystem'
4443
# new coding style is for feature instances to be lowercase
4444
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4447
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4448
SubUnitFeature = _CompatabilityThunkFeature(
4449
deprecated_in((2,1,0)),
4450
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4451
# Only define SubUnitBzrRunner if subunit is available.
4453
from subunit import TestProtocolClient
4454
from subunit.test_results import AutoTimingTestResultDecorator
4455
class SubUnitBzrRunner(TextTestRunner):
4456
def run(self, test):
4457
result = AutoTimingTestResultDecorator(
4458
TestProtocolClient(self.stream))
4464
class _PosixPermissionsFeature(Feature):
4468
# create temporary file and check if specified perms are maintained.
4471
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4472
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4475
os.chmod(name, write_perms)
4477
read_perms = os.stat(name).st_mode & 0777
4479
return (write_perms == read_perms)
4481
return (os.name == 'posix') and has_perms()
4483
def feature_name(self):
4484
return 'POSIX permissions support'
4486
posix_permissions_feature = _PosixPermissionsFeature()
2460
def adapt_test_to_scenario(self, test, scenario):
2461
"""Copy test and apply scenario to it.
2463
:param test: A test to adapt.
2464
:param scenario: A tuple describing the scenarion.
2465
The first element of the tuple is the new test id.
2466
The second element is a dict containing attributes to set on the
2468
:return: The adapted test.
2470
from copy import deepcopy
2471
new_test = deepcopy(test)
2472
for name, value in scenario[1].items():
2473
setattr(new_test, name, value)
2474
def make_new_test_id():
2475
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2476
return lambda: new_id
2477
new_test.id = make_new_test_id()
added
removed
bzrlib/tests/__init__.py
