319
244
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.
245
self.extractBenchmarkTime(test)
246
self._cleanupLogFile(test)
247
if isinstance(err[1], TestSkipped):
248
return self.addSkipped(test, err)
249
elif isinstance(err[1], UnavailableFeature):
250
return self.addNotSupported(test, err[1].args[0])
326
251
unittest.TestResult.addError(self, test, err)
327
252
self.error_count += 1
328
253
self.report_error(test, err)
329
254
if self.stop_early:
257
def addFailure(self, test, err):
331
258
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.
259
self.extractBenchmarkTime(test)
260
if isinstance(err[1], KnownFailure):
261
return self.addKnownFailure(test, err)
340
262
unittest.TestResult.addFailure(self, test, err)
341
263
self.failure_count += 1
342
264
self.report_failure(test, err)
343
265
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):
268
def addKnownFailure(self, test, err):
364
269
self.known_failure_count += 1
365
270
self.report_known_failure(test, err)
367
272
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
273
self.unsupported.setdefault(str(feature), 0)
377
274
self.unsupported[str(feature)] += 1
378
275
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
277
def addSuccess(self, test):
278
self.extractBenchmarkTime(test)
279
if self._bench_history is not None:
280
if self._benchmarkTime is not None:
281
self._bench_history.write("%s %s\n" % (
282
self._formatTime(self._benchmarkTime),
284
self.report_success(test)
285
unittest.TestResult.addSuccess(self, test)
287
def addSkipped(self, test, skip_excinfo):
288
self.report_skip(test, skip_excinfo)
289
# seems best to treat this as success from point-of-view of unittest
290
# -- it actually does nothing so it barely matters :)
293
except KeyboardInterrupt:
296
self.addError(test, test.__exc_info())
401
raise errors.BzrError("Unknown whence %r" % whence)
298
unittest.TestResult.addSuccess(self, test)
300
def printErrorList(self, flavour, errors):
301
for test, err in errors:
302
self.stream.writeln(self.separator1)
303
self.stream.write("%s: " % flavour)
304
self.stream.writeln(self.getDescription(test))
305
if getattr(test, '_get_log', None) is not None:
307
print >>self.stream, \
308
('vvvv[log from %s]' % test.id()).ljust(78,'-')
309
print >>self.stream, test._get_log()
310
print >>self.stream, \
311
('^^^^[log from %s]' % test.id()).ljust(78,'-')
312
self.stream.writeln(self.separator2)
313
self.stream.writeln("%s" % err)
403
318
def report_cleaning_up(self):
406
def startTestRun(self):
407
self.startTime = time.time()
409
321
def report_success(self, test):
412
def wasStrictlySuccessful(self):
413
if self.unsupported or self.known_failure_count:
415
return self.wasSuccessful()
418
325
class TextTestResult(ExtendedTestResult):
419
326
"""Displays progress and results of tests in text form"""
421
328
def __init__(self, stream, descriptions, verbosity,
422
329
bench_history=None,
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)
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
704
retrieved by _get_log(). We use a real OS file, not an in-memory object,
785
705
so that it can also capture file IO. When the test completes this file
786
706
is read into memory and removed from disk.
788
708
There are also convenience functions to invoke bzr's command-line
789
709
routine, and to build and check bzr trees.
791
711
In addition to the usual method of overriding tearDown(), this class also
792
712
allows subclasses to register functions into the _cleanups list, which is
793
713
run in order as the object is torn down. It's less likely this will be
794
714
accidentally overlooked.
797
_active_threads = None
798
_leaking_threads_tests = 0
799
_first_thread_leaker_id = None
800
717
_log_file_name = None
719
_keep_log_file = False
801
720
# record lsprof data when performing benchmark calls.
802
721
_gather_lsprof_in_benchmarks = False
804
723
def __init__(self, methodName='testMethod'):
805
724
super(TestCase, self).__init__(methodName)
806
725
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)]))
728
unittest.TestCase.setUp(self)
821
729
self._cleanEnvironment()
730
bzrlib.trace.disable_default_logging()
822
731
self._silenceUI()
823
732
self._startLogFile()
824
733
self._benchcalls = []
825
734
self._benchtime = None
826
735
self._clear_hooks()
827
self._track_transports()
829
736
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
738
def _clear_debug_flags(self):
854
739
"""Prevent externally set debug flags affecting tests.
856
741
Tests that want to use debug flags can just set them in the
857
742
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')
744
self._preserved_debug_flags = set(debug.debug_flags)
745
debug.debug_flags.clear()
746
self.addCleanup(self._restore_debug_flags)
866
748
def _clear_hooks(self):
867
749
# 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)
751
import bzrlib.smart.server
752
self._preserved_hooks = {
753
bzrlib.branch.Branch: bzrlib.branch.Branch.hooks,
754
bzrlib.smart.server.SmartTCPServer: bzrlib.smart.server.SmartTCPServer.hooks,
873
756
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
757
# reset all hooks to an empty instance of the appropriate type
758
bzrlib.branch.Branch.hooks = bzrlib.branch.BranchHooks()
759
bzrlib.smart.server.SmartTCPServer.hooks = bzrlib.smart.server.SmartServerHooks()
888
761
def _silenceUI(self):
889
762
"""Turn off UI for duration of test"""
890
763
# 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.")
764
saved = ui.ui_factory
766
ui.ui_factory = saved
767
ui.ui_factory = ui.SilentUIFactory()
768
self.addCleanup(_restore)
1071
770
def _ndiff_strings(self, a, b):
1072
771
"""Return ndiff between two strings containing lines.
1074
773
A trailing newline is added if missing to make the strings
1075
774
print properly."""
1076
775
if b and b[-1] != '\n':
2721
2102
for readonly urls.
2723
2104
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2724
be used without needed to redo it when a different
2105
be used without needed to redo it when a different
2725
2106
subclass is in use ?
2728
2109
def setUp(self):
2729
2110
super(ChrootedTestCase, self).setUp()
2730
if not self.vfs_transport_factory == memory.MemoryServer:
2111
if not self.vfs_transport_factory == MemoryServer:
2731
2112
self.transport_readonly_server = HttpServer
2734
def condition_id_re(pattern):
2735
"""Create a condition filter which performs a re check on a test's id.
2737
:param pattern: A regular expression string.
2738
:return: A callable that returns True if the re matches.
2740
filter_re = osutils.re_compile_checked(pattern, 0,
2742
def condition(test):
2115
def filter_suite_by_re(suite, pattern, exclude_pattern=None,
2116
random_order=False):
2117
"""Create a test suite by filtering another one.
2119
:param suite: the source suite
2120
:param pattern: pattern that names must match
2121
:param exclude_pattern: pattern that names must not match, if any
2122
:param random_order: if True, tests in the new suite will be put in
2124
:returns: the newly created suite
2126
return sort_suite_by_re(suite, pattern, exclude_pattern,
2127
random_order, False)
2130
def sort_suite_by_re(suite, pattern, exclude_pattern=None,
2131
random_order=False, append_rest=True):
2132
"""Create a test suite by sorting another one.
2134
:param suite: the source suite
2135
:param pattern: pattern that names must match in order to go
2136
first in the new suite
2137
:param exclude_pattern: pattern that names must not match, if any
2138
:param random_order: if True, tests in the new suite will be put in
2140
:param append_rest: if False, pattern is a strict filter and not
2141
just an ordering directive
2142
:returns: the newly created suite
2146
filter_re = re.compile(pattern)
2147
if exclude_pattern is not None:
2148
exclude_re = re.compile(exclude_pattern)
2149
for test in iter_suite_tests(suite):
2743
2150
test_id = test.id()
2744
return filter_re.search(test_id)
2748
def condition_isinstance(klass_or_klass_list):
2749
"""Create a condition filter which returns isinstance(param, klass).
2751
:return: A callable which when called with one parameter obj return the
2752
result of isinstance(obj, klass_or_klass_list).
2755
return isinstance(obj, klass_or_klass_list)
2759
def condition_id_in_list(id_list):
2760
"""Create a condition filter which verify that test's id in a list.
2762
:param id_list: A TestIdList object.
2763
:return: A callable that returns True if the test's id appears in the list.
2765
def condition(test):
2766
return id_list.includes(test.id())
2770
def condition_id_startswith(starts):
2771
"""Create a condition filter verifying that test's id starts with a string.
2773
:param starts: A list of string.
2774
:return: A callable that returns True if the test's id starts with one of
2777
def condition(test):
2778
for start in starts:
2779
if test.id().startswith(start):
2785
def exclude_tests_by_condition(suite, condition):
2786
"""Create a test suite which excludes some tests from suite.
2788
:param suite: The suite to get tests from.
2789
:param condition: A callable whose result evaluates True when called with a
2790
test case which should be excluded from the result.
2791
:return: A suite which contains the tests found in suite that fail
2795
for test in iter_suite_tests(suite):
2796
if not condition(test):
2798
return TestUtil.TestSuite(result)
2801
def filter_suite_by_condition(suite, condition):
2802
"""Create a test suite by filtering another one.
2804
:param suite: The source suite.
2805
:param condition: A callable whose result evaluates True when called with a
2806
test case which should be included in the result.
2807
:return: A suite which contains the tests found in suite that pass
2811
for test in iter_suite_tests(suite):
2814
return TestUtil.TestSuite(result)
2817
def filter_suite_by_re(suite, pattern):
2818
"""Create a test suite by filtering another one.
2820
:param suite: the source suite
2821
:param pattern: pattern that names must match
2822
:returns: the newly created suite
2824
condition = condition_id_re(pattern)
2825
result_suite = filter_suite_by_condition(suite, condition)
2829
def filter_suite_by_id_list(suite, test_id_list):
2830
"""Create a test suite by filtering another one.
2832
:param suite: The source suite.
2833
:param test_id_list: A list of the test ids to keep as strings.
2834
:returns: the newly created suite
2836
condition = condition_id_in_list(test_id_list)
2837
result_suite = filter_suite_by_condition(suite, condition)
2841
def filter_suite_by_id_startswith(suite, start):
2842
"""Create a test suite by filtering another one.
2844
:param suite: The source suite.
2845
:param start: A list of string the test id must start with one of.
2846
:returns: the newly created suite
2848
condition = condition_id_startswith(start)
2849
result_suite = filter_suite_by_condition(suite, condition)
2853
def exclude_tests_by_re(suite, pattern):
2854
"""Create a test suite which excludes some tests from suite.
2856
:param suite: The suite to get tests from.
2857
:param pattern: A regular expression string. Test ids that match this
2858
pattern will be excluded from the result.
2859
:return: A TestSuite that contains all the tests from suite without the
2860
tests that matched pattern. The order of tests is the same as it was in
2863
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2866
def preserve_input(something):
2867
"""A helper for performing test suite transformation chains.
2869
:param something: Anything you want to preserve.
2875
def randomize_suite(suite):
2876
"""Return a new TestSuite with suite's tests in random order.
2878
The tests in the input suite are flattened into a single suite in order to
2879
accomplish this. Any nested TestSuites are removed to provide global
2882
tests = list(iter_suite_tests(suite))
2883
random.shuffle(tests)
2884
return TestUtil.TestSuite(tests)
2887
def split_suite_by_condition(suite, condition):
2888
"""Split a test suite into two by a condition.
2890
:param suite: The suite to split.
2891
:param condition: The condition to match on. Tests that match this
2892
condition are returned in the first test suite, ones that do not match
2893
are in the second suite.
2894
:return: A tuple of two test suites, where the first contains tests from
2895
suite matching the condition, and the second contains the remainder
2896
from suite. The order within each output suite is the same as it was in
2901
for test in iter_suite_tests(suite):
2903
matched.append(test)
2905
did_not_match.append(test)
2906
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2909
def split_suite_by_re(suite, pattern):
2910
"""Split a test suite into two by a regular expression.
2912
:param suite: The suite to split.
2913
:param pattern: A regular expression string. Test ids that match this
2914
pattern will be in the first test suite returned, and the others in the
2915
second test suite returned.
2916
:return: A tuple of two test suites, where the first contains tests from
2917
suite matching pattern, and the second contains the remainder from
2918
suite. The order within each output suite is the same as it was in
2921
return split_suite_by_condition(suite, condition_id_re(pattern))
2151
if exclude_pattern is None or not exclude_re.search(test_id):
2152
if filter_re.search(test_id):
2157
random.shuffle(first)
2158
random.shuffle(second)
2159
return TestUtil.TestSuite(first + second)
2924
2162
def run_suite(suite, name='test', verbose=False, pattern=".*",
2928
2166
list_only=False,
2929
2167
random_seed=None,
2930
2168
exclude_pattern=None,
2933
suite_decorators=None,
2935
result_decorators=None,
2937
"""Run a test suite for bzr selftest.
2939
:param runner_class: The class of runner to use. Must support the
2940
constructor arguments passed by run_suite which are more than standard
2942
:return: A boolean indicating success.
2944
2170
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2949
if runner_class is None:
2950
runner_class = TextTestRunner
2953
runner = runner_class(stream=stream,
2175
runner = TextTestRunner(stream=sys.stdout,
2954
2176
descriptions=0,
2955
2177
verbosity=verbosity,
2956
2178
bench_history=bench_history,
2958
result_decorators=result_decorators,
2179
list_only=list_only,
2960
2181
runner.stop_on_failure=stop_on_failure
2961
# built in decorator factories:
2963
random_order(random_seed, runner),
2964
exclude_tests(exclude_pattern),
2966
if matching_tests_first:
2967
decorators.append(tests_first(pattern))
2969
decorators.append(filter_tests(pattern))
2970
if suite_decorators:
2971
decorators.extend(suite_decorators)
2972
# tell the result object how many tests will be running: (except if
2973
# --parallel=fork is being used. Robert said he will provide a better
2974
# progress design later -- vila 20090817)
2975
if fork_decorator not in decorators:
2976
decorators.append(CountingDecorator)
2977
for decorator in decorators:
2978
suite = decorator(suite)
2980
# Done after test suite decoration to allow randomisation etc
2981
# to take effect, though that is of marginal benefit.
2983
stream.write("Listing tests only ...\n")
2984
for t in iter_suite_tests(suite):
2985
stream.write("%s\n" % (t.id()))
2987
result = runner.run(suite)
2989
return result.wasStrictlySuccessful()
2991
return result.wasSuccessful()
2994
# A registry where get() returns a suite decorator.
2995
parallel_registry = registry.Registry()
2998
def fork_decorator(suite):
2999
concurrency = osutils.local_concurrency()
3000
if concurrency == 1:
3002
from testtools import ConcurrentTestSuite
3003
return ConcurrentTestSuite(suite, fork_for_tests)
3004
parallel_registry.register('fork', fork_decorator)
3007
def subprocess_decorator(suite):
3008
concurrency = osutils.local_concurrency()
3009
if concurrency == 1:
3011
from testtools import ConcurrentTestSuite
3012
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3013
parallel_registry.register('subprocess', subprocess_decorator)
3016
def exclude_tests(exclude_pattern):
3017
"""Return a test suite decorator that excludes tests."""
3018
if exclude_pattern is None:
3019
return identity_decorator
3020
def decorator(suite):
3021
return ExcludeDecorator(suite, exclude_pattern)
3025
def filter_tests(pattern):
3027
return identity_decorator
3028
def decorator(suite):
3029
return FilterTestsDecorator(suite, pattern)
3033
def random_order(random_seed, runner):
3034
"""Return a test suite decorator factory for randomising tests order.
3036
:param random_seed: now, a string which casts to a long, or a long.
3037
:param runner: A test runner with a stream attribute to report on.
3039
if random_seed is None:
3040
return identity_decorator
3041
def decorator(suite):
3042
return RandomDecorator(suite, random_seed, runner.stream)
3046
def tests_first(pattern):
3048
return identity_decorator
3049
def decorator(suite):
3050
return TestFirstDecorator(suite, pattern)
3054
def identity_decorator(suite):
3059
class TestDecorator(TestSuite):
3060
"""A decorator for TestCase/TestSuite objects.
3062
Usually, subclasses should override __iter__(used when flattening test
3063
suites), which we do to filter, reorder, parallelise and so on, run() and
3067
def __init__(self, suite):
3068
TestSuite.__init__(self)
3071
def countTestCases(self):
3074
cases += test.countTestCases()
3081
def run(self, result):
3082
# Use iteration on self, not self._tests, to allow subclasses to hook
3085
if result.shouldStop:
3091
class CountingDecorator(TestDecorator):
3092
"""A decorator which calls result.progress(self.countTestCases)."""
3094
def run(self, result):
3095
progress_method = getattr(result, 'progress', None)
3096
if callable(progress_method):
3097
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3098
return super(CountingDecorator, self).run(result)
3101
class ExcludeDecorator(TestDecorator):
3102
"""A decorator which excludes test matching an exclude pattern."""
3104
def __init__(self, suite, exclude_pattern):
3105
TestDecorator.__init__(self, suite)
3106
self.exclude_pattern = exclude_pattern
3107
self.excluded = False
3111
return iter(self._tests)
3112
self.excluded = True
3113
suite = exclude_tests_by_re(self, self.exclude_pattern)
3115
self.addTests(suite)
3116
return iter(self._tests)
3119
class FilterTestsDecorator(TestDecorator):
3120
"""A decorator which filters tests to those matching a pattern."""
3122
def __init__(self, suite, pattern):
3123
TestDecorator.__init__(self, suite)
3124
self.pattern = pattern
3125
self.filtered = False
3129
return iter(self._tests)
3130
self.filtered = True
3131
suite = filter_suite_by_re(self, self.pattern)
3133
self.addTests(suite)
3134
return iter(self._tests)
3137
class RandomDecorator(TestDecorator):
3138
"""A decorator which randomises the order of its tests."""
3140
def __init__(self, suite, random_seed, stream):
3141
TestDecorator.__init__(self, suite)
3142
self.random_seed = random_seed
3143
self.randomised = False
3144
self.stream = stream
3148
return iter(self._tests)
3149
self.randomised = True
3150
self.stream.write("Randomizing test order using seed %s\n\n" %
3151
(self.actual_seed()))
3152
# Initialise the random number generator.
3153
random.seed(self.actual_seed())
3154
suite = randomize_suite(self)
3156
self.addTests(suite)
3157
return iter(self._tests)
3159
def actual_seed(self):
3160
if self.random_seed == "now":
3161
# We convert the seed to a long to make it reuseable across
3162
# invocations (because the user can reenter it).
3163
self.random_seed = long(time.time())
2182
# Initialise the random number generator and display the seed used.
2183
# We convert the seed to a long to make it reuseable across invocations.
2184
random_order = False
2185
if random_seed is not None:
2187
if random_seed == "now":
2188
random_seed = long(time.time())
3165
2190
# Convert the seed to a long if we can
3167
self.random_seed = long(self.random_seed)
2192
random_seed = long(random_seed)
3170
return self.random_seed
3173
class TestFirstDecorator(TestDecorator):
3174
"""A decorator which moves named tests to the front."""
3176
def __init__(self, suite, pattern):
3177
TestDecorator.__init__(self, suite)
3178
self.pattern = pattern
3179
self.filtered = False
3183
return iter(self._tests)
3184
self.filtered = True
3185
suites = split_suite_by_re(self, self.pattern)
3187
self.addTests(suites)
3188
return iter(self._tests)
3191
def partition_tests(suite, count):
3192
"""Partition suite into count lists of tests."""
3194
tests = list(iter_suite_tests(suite))
3195
tests_per_process = int(math.ceil(float(len(tests)) / count))
3196
for block in range(count):
3197
low_test = block * tests_per_process
3198
high_test = low_test + tests_per_process
3199
process_tests = tests[low_test:high_test]
3200
result.append(process_tests)
3204
def workaround_zealous_crypto_random():
3205
"""Crypto.Random want to help us being secure, but we don't care here.
3207
This workaround some test failure related to the sftp server. Once paramiko
3208
stop using the controversial API in Crypto.Random, we may get rid of it.
3211
from Crypto.Random import atfork
3217
def fork_for_tests(suite):
3218
"""Take suite and start up one runner per CPU by forking()
3220
:return: An iterable of TestCase-like objects which can each have
3221
run(result) called on them to feed tests to result.
3223
concurrency = osutils.local_concurrency()
3225
from subunit import TestProtocolClient, ProtocolTestCase
3226
from subunit.test_results import AutoTimingTestResultDecorator
3227
class TestInOtherProcess(ProtocolTestCase):
3228
# Should be in subunit, I think. RBC.
3229
def __init__(self, stream, pid):
3230
ProtocolTestCase.__init__(self, stream)
3233
def run(self, result):
3235
ProtocolTestCase.run(self, result)
3237
os.waitpid(self.pid, 0)
3239
test_blocks = partition_tests(suite, concurrency)
3240
for process_tests in test_blocks:
3241
process_suite = TestSuite()
3242
process_suite.addTests(process_tests)
3243
c2pread, c2pwrite = os.pipe()
3246
workaround_zealous_crypto_random()
3249
# Leave stderr and stdout open so we can see test noise
3250
# Close stdin so that the child goes away if it decides to
3251
# read from stdin (otherwise its a roulette to see what
3252
# child actually gets keystrokes for pdb etc).
3255
stream = os.fdopen(c2pwrite, 'wb', 1)
3256
subunit_result = AutoTimingTestResultDecorator(
3257
TestProtocolClient(stream))
3258
process_suite.run(subunit_result)
2195
runner.stream.writeln("Randomizing test order using seed %s\n" %
2197
random.seed(random_seed)
2198
# Customise the list of tests if requested
2199
if pattern != '.*' or exclude_pattern is not None or random_order:
2200
if matching_tests_first:
2201
suite = sort_suite_by_re(suite, pattern, exclude_pattern,
3263
stream = os.fdopen(c2pread, 'rb', 1)
3264
test = TestInOtherProcess(stream, pid)
3269
def reinvoke_for_tests(suite):
3270
"""Take suite and start up one runner per CPU using subprocess().
3272
:return: An iterable of TestCase-like objects which can each have
3273
run(result) called on them to feed tests to result.
3275
concurrency = osutils.local_concurrency()
3277
from subunit import ProtocolTestCase
3278
class TestInSubprocess(ProtocolTestCase):
3279
def __init__(self, process, name):
3280
ProtocolTestCase.__init__(self, process.stdout)
3281
self.process = process
3282
self.process.stdin.close()
3285
def run(self, result):
3287
ProtocolTestCase.run(self, result)
3290
os.unlink(self.name)
3291
# print "pid %d finished" % finished_process
3292
test_blocks = partition_tests(suite, concurrency)
3293
for process_tests in test_blocks:
3294
# ugly; currently reimplement rather than reuses TestCase methods.
3295
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3296
if not os.path.isfile(bzr_path):
3297
# We are probably installed. Assume sys.argv is the right file
3298
bzr_path = sys.argv[0]
3299
bzr_path = [bzr_path]
3300
if sys.platform == "win32":
3301
# if we're on windows, we can't execute the bzr script directly
3302
bzr_path = [sys.executable] + bzr_path
3303
fd, test_list_file_name = tempfile.mkstemp()
3304
test_list_file = os.fdopen(fd, 'wb', 1)
3305
for test in process_tests:
3306
test_list_file.write(test.id() + '\n')
3307
test_list_file.close()
3309
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3311
if '--no-plugins' in sys.argv:
3312
argv.append('--no-plugins')
3313
# stderr=STDOUT would be ideal, but until we prevent noise on
3314
# stderr it can interrupt the subunit protocol.
3315
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3317
test = TestInSubprocess(process, test_list_file_name)
3320
os.unlink(test_list_file_name)
3325
class ForwardingResult(unittest.TestResult):
3327
def __init__(self, target):
3328
unittest.TestResult.__init__(self)
3329
self.result = target
3331
def startTest(self, test):
3332
self.result.startTest(test)
3334
def stopTest(self, test):
3335
self.result.stopTest(test)
3337
def startTestRun(self):
3338
self.result.startTestRun()
3340
def stopTestRun(self):
3341
self.result.stopTestRun()
3343
def addSkip(self, test, reason):
3344
self.result.addSkip(test, reason)
3346
def addSuccess(self, test):
3347
self.result.addSuccess(test)
3349
def addError(self, test, err):
3350
self.result.addError(test, err)
3352
def addFailure(self, test, err):
3353
self.result.addFailure(test, err)
3354
ForwardingResult = testtools.ExtendedToOriginalDecorator
3357
class ProfileResult(ForwardingResult):
3358
"""Generate profiling data for all activity between start and success.
3360
The profile data is appended to the test's _benchcalls attribute and can
3361
be accessed by the forwarded-to TestResult.
3363
While it might be cleaner do accumulate this in stopTest, addSuccess is
3364
where our existing output support for lsprof is, and this class aims to
3365
fit in with that: while it could be moved it's not necessary to accomplish
3366
test profiling, nor would it be dramatically cleaner.
3369
def startTest(self, test):
3370
self.profiler = bzrlib.lsprof.BzrProfiler()
3371
self.profiler.start()
3372
ForwardingResult.startTest(self, test)
3374
def addSuccess(self, test):
3375
stats = self.profiler.stop()
3377
calls = test._benchcalls
3378
except AttributeError:
3379
test._benchcalls = []
3380
calls = test._benchcalls
3381
calls.append(((test.id(), "", ""), stats))
3382
ForwardingResult.addSuccess(self, test)
3384
def stopTest(self, test):
3385
ForwardingResult.stopTest(self, test)
3386
self.profiler = None
3389
# Controlled by "bzr selftest -E=..." option
3390
# Currently supported:
3391
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3392
# preserves any flags supplied at the command line.
3393
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3394
# rather than failing tests. And no longer raise
3395
# LockContention when fctnl locks are not being used
3396
# with proper exclusion rules.
3397
selftest_debug_flags = set()
2204
suite = filter_suite_by_re(suite, pattern, exclude_pattern,
2206
result = runner.run(suite)
2207
return result.wasSuccessful()
3400
2210
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3459
2241
matching_tests_first=matching_tests_first,
3460
2242
list_only=list_only,
3461
2243
random_seed=random_seed,
3462
exclude_pattern=exclude_pattern,
3464
runner_class=runner_class,
3465
suite_decorators=suite_decorators,
3467
result_decorators=result_decorators,
2244
exclude_pattern=exclude_pattern)
3470
2246
default_transport = old_transport
3471
selftest_debug_flags = old_debug_flags
3474
def load_test_id_list(file_name):
3475
"""Load a test id list from a text file.
3477
The format is one test id by line. No special care is taken to impose
3478
strict rules, these test ids are used to filter the test suite so a test id
3479
that do not match an existing test will do no harm. This allows user to add
3480
comments, leave blank lines, etc.
3484
ftest = open(file_name, 'rt')
3486
if e.errno != errno.ENOENT:
3489
raise errors.NoSuchFile(file_name)
3491
for test_name in ftest.readlines():
3492
test_list.append(test_name.strip())
3497
def suite_matches_id_list(test_suite, id_list):
3498
"""Warns about tests not appearing or appearing more than once.
3500
:param test_suite: A TestSuite object.
3501
:param test_id_list: The list of test ids that should be found in
3504
:return: (absents, duplicates) absents is a list containing the test found
3505
in id_list but not in test_suite, duplicates is a list containing the
3506
test found multiple times in test_suite.
3508
When using a prefined test id list, it may occurs that some tests do not
3509
exist anymore or that some tests use the same id. This function warns the
3510
tester about potential problems in his workflow (test lists are volatile)
3511
or in the test suite itself (using the same id for several tests does not
3512
help to localize defects).
3514
# Build a dict counting id occurrences
3516
for test in iter_suite_tests(test_suite):
3518
tests[id] = tests.get(id, 0) + 1
3523
occurs = tests.get(id, 0)
3525
not_found.append(id)
3527
duplicates.append(id)
3529
return not_found, duplicates
3532
class TestIdList(object):
3533
"""Test id list to filter a test suite.
3535
Relying on the assumption that test ids are built as:
3536
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3537
notation, this class offers methods to :
3538
- avoid building a test suite for modules not refered to in the test list,
3539
- keep only the tests listed from the module test suite.
3542
def __init__(self, test_id_list):
3543
# When a test suite needs to be filtered against us we compare test ids
3544
# for equality, so a simple dict offers a quick and simple solution.
3545
self.tests = dict().fromkeys(test_id_list, True)
3547
# While unittest.TestCase have ids like:
3548
# <module>.<class>.<method>[(<param+)],
3549
# doctest.DocTestCase can have ids like:
3552
# <module>.<function>
3553
# <module>.<class>.<method>
3555
# Since we can't predict a test class from its name only, we settle on
3556
# a simple constraint: a test id always begins with its module name.
3559
for test_id in test_id_list:
3560
parts = test_id.split('.')
3561
mod_name = parts.pop(0)
3562
modules[mod_name] = True
3564
mod_name += '.' + part
3565
modules[mod_name] = True
3566
self.modules = modules
3568
def refers_to(self, module_name):
3569
"""Is there tests for the module or one of its sub modules."""
3570
return self.modules.has_key(module_name)
3572
def includes(self, test_id):
3573
return self.tests.has_key(test_id)
3576
class TestPrefixAliasRegistry(registry.Registry):
3577
"""A registry for test prefix aliases.
3579
This helps implement shorcuts for the --starting-with selftest
3580
option. Overriding existing prefixes is not allowed but not fatal (a
3581
warning will be emitted).
3584
def register(self, key, obj, help=None, info=None,
3585
override_existing=False):
3586
"""See Registry.register.
3588
Trying to override an existing alias causes a warning to be emitted,
3589
not a fatal execption.
3592
super(TestPrefixAliasRegistry, self).register(
3593
key, obj, help=help, info=info, override_existing=False)
3595
actual = self.get(key)
3596
note('Test prefix alias %s is already used for %s, ignoring %s'
3597
% (key, actual, obj))
3599
def resolve_alias(self, id_start):
3600
"""Replace the alias by the prefix in the given string.
3602
Using an unknown prefix is an error to help catching typos.
3604
parts = id_start.split('.')
3606
parts[0] = self.get(parts[0])
3608
raise errors.BzrCommandError(
3609
'%s is not a known test prefix alias' % parts[0])
3610
return '.'.join(parts)
3613
test_prefix_alias_registry = TestPrefixAliasRegistry()
3614
"""Registry of test prefix aliases."""
3617
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3618
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3619
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3621
# Obvious highest levels prefixes, feel free to add your own via a plugin
3622
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3623
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3624
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3625
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3626
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3629
def _test_suite_testmod_names():
3630
"""Return the standard list of test module names to test."""
3633
'bzrlib.tests.blackbox',
3634
'bzrlib.tests.commands',
3635
'bzrlib.tests.per_branch',
3636
'bzrlib.tests.per_bzrdir',
3637
'bzrlib.tests.per_bzrdir_colo',
3638
'bzrlib.tests.per_foreign_vcs',
3639
'bzrlib.tests.per_interrepository',
3640
'bzrlib.tests.per_intertree',
3641
'bzrlib.tests.per_inventory',
3642
'bzrlib.tests.per_interbranch',
3643
'bzrlib.tests.per_lock',
3644
'bzrlib.tests.per_merger',
3645
'bzrlib.tests.per_transport',
3646
'bzrlib.tests.per_tree',
3647
'bzrlib.tests.per_pack_repository',
3648
'bzrlib.tests.per_repository',
3649
'bzrlib.tests.per_repository_chk',
3650
'bzrlib.tests.per_repository_reference',
3651
'bzrlib.tests.per_uifactory',
3652
'bzrlib.tests.per_versionedfile',
3653
'bzrlib.tests.per_workingtree',
3654
'bzrlib.tests.test__annotator',
3655
'bzrlib.tests.test__bencode',
3656
'bzrlib.tests.test__chk_map',
3657
'bzrlib.tests.test__dirstate_helpers',
3658
'bzrlib.tests.test__groupcompress',
3659
'bzrlib.tests.test__known_graph',
3660
'bzrlib.tests.test__rio',
3661
'bzrlib.tests.test__simple_set',
3662
'bzrlib.tests.test__static_tuple',
3663
'bzrlib.tests.test__walkdirs_win32',
3664
'bzrlib.tests.test_ancestry',
3665
'bzrlib.tests.test_annotate',
3666
'bzrlib.tests.test_api',
3667
'bzrlib.tests.test_atomicfile',
3668
'bzrlib.tests.test_bad_files',
3669
'bzrlib.tests.test_bisect_multi',
3670
'bzrlib.tests.test_branch',
3671
'bzrlib.tests.test_branchbuilder',
3672
'bzrlib.tests.test_btree_index',
3673
'bzrlib.tests.test_bugtracker',
3674
'bzrlib.tests.test_bundle',
3675
'bzrlib.tests.test_bzrdir',
3676
'bzrlib.tests.test__chunks_to_lines',
3677
'bzrlib.tests.test_cache_utf8',
3678
'bzrlib.tests.test_chk_map',
3679
'bzrlib.tests.test_chk_serializer',
3680
'bzrlib.tests.test_chunk_writer',
3681
'bzrlib.tests.test_clean_tree',
3682
'bzrlib.tests.test_cleanup',
3683
'bzrlib.tests.test_cmdline',
3684
'bzrlib.tests.test_commands',
3685
'bzrlib.tests.test_commit',
3686
'bzrlib.tests.test_commit_merge',
3687
'bzrlib.tests.test_config',
3688
'bzrlib.tests.test_conflicts',
3689
'bzrlib.tests.test_counted_lock',
3690
'bzrlib.tests.test_crash',
3691
'bzrlib.tests.test_decorators',
3692
'bzrlib.tests.test_delta',
3693
'bzrlib.tests.test_debug',
3694
'bzrlib.tests.test_deprecated_graph',
3695
'bzrlib.tests.test_diff',
3696
'bzrlib.tests.test_directory_service',
3697
'bzrlib.tests.test_dirstate',
3698
'bzrlib.tests.test_email_message',
3699
'bzrlib.tests.test_eol_filters',
3700
'bzrlib.tests.test_errors',
3701
'bzrlib.tests.test_export',
3702
'bzrlib.tests.test_extract',
3703
'bzrlib.tests.test_fetch',
3704
'bzrlib.tests.test_fifo_cache',
3705
'bzrlib.tests.test_filters',
3706
'bzrlib.tests.test_ftp_transport',
3707
'bzrlib.tests.test_foreign',
3708
'bzrlib.tests.test_generate_docs',
3709
'bzrlib.tests.test_generate_ids',
3710
'bzrlib.tests.test_globbing',
3711
'bzrlib.tests.test_gpg',
3712
'bzrlib.tests.test_graph',
3713
'bzrlib.tests.test_groupcompress',
3714
'bzrlib.tests.test_hashcache',
3715
'bzrlib.tests.test_help',
3716
'bzrlib.tests.test_hooks',
3717
'bzrlib.tests.test_http',
3718
'bzrlib.tests.test_http_response',
3719
'bzrlib.tests.test_https_ca_bundle',
3720
'bzrlib.tests.test_identitymap',
3721
'bzrlib.tests.test_ignores',
3722
'bzrlib.tests.test_index',
3723
'bzrlib.tests.test_import_tariff',
3724
'bzrlib.tests.test_info',
3725
'bzrlib.tests.test_inv',
3726
'bzrlib.tests.test_inventory_delta',
3727
'bzrlib.tests.test_knit',
3728
'bzrlib.tests.test_lazy_import',
3729
'bzrlib.tests.test_lazy_regex',
3730
'bzrlib.tests.test_lock',
3731
'bzrlib.tests.test_lockable_files',
3732
'bzrlib.tests.test_lockdir',
3733
'bzrlib.tests.test_log',
3734
'bzrlib.tests.test_lru_cache',
3735
'bzrlib.tests.test_lsprof',
3736
'bzrlib.tests.test_mail_client',
3737
'bzrlib.tests.test_memorytree',
3738
'bzrlib.tests.test_merge',
3739
'bzrlib.tests.test_merge3',
3740
'bzrlib.tests.test_merge_core',
3741
'bzrlib.tests.test_merge_directive',
3742
'bzrlib.tests.test_missing',
3743
'bzrlib.tests.test_msgeditor',
3744
'bzrlib.tests.test_multiparent',
3745
'bzrlib.tests.test_mutabletree',
3746
'bzrlib.tests.test_nonascii',
3747
'bzrlib.tests.test_options',
3748
'bzrlib.tests.test_osutils',
3749
'bzrlib.tests.test_osutils_encodings',
3750
'bzrlib.tests.test_pack',
3751
'bzrlib.tests.test_patch',
3752
'bzrlib.tests.test_patches',
3753
'bzrlib.tests.test_permissions',
3754
'bzrlib.tests.test_plugins',
3755
'bzrlib.tests.test_progress',
3756
'bzrlib.tests.test_read_bundle',
3757
'bzrlib.tests.test_reconcile',
3758
'bzrlib.tests.test_reconfigure',
3759
'bzrlib.tests.test_registry',
3760
'bzrlib.tests.test_remote',
3761
'bzrlib.tests.test_rename_map',
3762
'bzrlib.tests.test_repository',
3763
'bzrlib.tests.test_revert',
3764
'bzrlib.tests.test_revision',
3765
'bzrlib.tests.test_revisionspec',
3766
'bzrlib.tests.test_revisiontree',
3767
'bzrlib.tests.test_rio',
3768
'bzrlib.tests.test_rules',
3769
'bzrlib.tests.test_sampler',
3770
'bzrlib.tests.test_script',
3771
'bzrlib.tests.test_selftest',
3772
'bzrlib.tests.test_serializer',
3773
'bzrlib.tests.test_setup',
3774
'bzrlib.tests.test_sftp_transport',
3775
'bzrlib.tests.test_shelf',
3776
'bzrlib.tests.test_shelf_ui',
3777
'bzrlib.tests.test_smart',
3778
'bzrlib.tests.test_smart_add',
3779
'bzrlib.tests.test_smart_request',
3780
'bzrlib.tests.test_smart_transport',
3781
'bzrlib.tests.test_smtp_connection',
3782
'bzrlib.tests.test_source',
3783
'bzrlib.tests.test_ssh_transport',
3784
'bzrlib.tests.test_status',
3785
'bzrlib.tests.test_store',
3786
'bzrlib.tests.test_strace',
3787
'bzrlib.tests.test_subsume',
3788
'bzrlib.tests.test_switch',
3789
'bzrlib.tests.test_symbol_versioning',
3790
'bzrlib.tests.test_tag',
3791
'bzrlib.tests.test_testament',
3792
'bzrlib.tests.test_textfile',
3793
'bzrlib.tests.test_textmerge',
3794
'bzrlib.tests.test_timestamp',
3795
'bzrlib.tests.test_trace',
3796
'bzrlib.tests.test_transactions',
3797
'bzrlib.tests.test_transform',
3798
'bzrlib.tests.test_transport',
3799
'bzrlib.tests.test_transport_log',
3800
'bzrlib.tests.test_tree',
3801
'bzrlib.tests.test_treebuilder',
3802
'bzrlib.tests.test_tsort',
3803
'bzrlib.tests.test_tuned_gzip',
3804
'bzrlib.tests.test_ui',
3805
'bzrlib.tests.test_uncommit',
3806
'bzrlib.tests.test_upgrade',
3807
'bzrlib.tests.test_upgrade_stacked',
3808
'bzrlib.tests.test_urlutils',
3809
'bzrlib.tests.test_version',
3810
'bzrlib.tests.test_version_info',
3811
'bzrlib.tests.test_weave',
3812
'bzrlib.tests.test_whitebox',
3813
'bzrlib.tests.test_win32utils',
3814
'bzrlib.tests.test_workingtree',
3815
'bzrlib.tests.test_workingtree_4',
3816
'bzrlib.tests.test_wsgi',
3817
'bzrlib.tests.test_xml',
3821
def _test_suite_modules_to_doctest():
3822
"""Return the list of modules to doctest."""
3824
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3828
'bzrlib.branchbuilder',
3829
'bzrlib.decorators',
3832
'bzrlib.iterablefile',
3836
'bzrlib.symbol_versioning',
3839
'bzrlib.version_info_formats.format_custom',
3843
def test_suite(keep_only=None, starting_with=None):
3844
2250
"""Build and return TestSuite for the whole of bzrlib.
3846
:param keep_only: A list of test ids limiting the suite returned.
3848
:param starting_with: An id limiting the suite returned to the tests
3851
2252
This function can be replaced if you need to change the default test
3852
2253
suite on a global basis, but it is not encouraged.
2256
'bzrlib.util.tests.test_bencode',
2257
'bzrlib.tests.test__dirstate_helpers',
2258
'bzrlib.tests.test_ancestry',
2259
'bzrlib.tests.test_annotate',
2260
'bzrlib.tests.test_api',
2261
'bzrlib.tests.test_atomicfile',
2262
'bzrlib.tests.test_bad_files',
2263
'bzrlib.tests.test_branch',
2264
'bzrlib.tests.test_branchbuilder',
2265
'bzrlib.tests.test_bugtracker',
2266
'bzrlib.tests.test_bundle',
2267
'bzrlib.tests.test_bzrdir',
2268
'bzrlib.tests.test_cache_utf8',
2269
'bzrlib.tests.test_commands',
2270
'bzrlib.tests.test_commit',
2271
'bzrlib.tests.test_commit_merge',
2272
'bzrlib.tests.test_config',
2273
'bzrlib.tests.test_conflicts',
2274
'bzrlib.tests.test_counted_lock',
2275
'bzrlib.tests.test_decorators',
2276
'bzrlib.tests.test_delta',
2277
'bzrlib.tests.test_deprecated_graph',
2278
'bzrlib.tests.test_diff',
2279
'bzrlib.tests.test_dirstate',
2280
'bzrlib.tests.test_email_message',
2281
'bzrlib.tests.test_errors',
2282
'bzrlib.tests.test_escaped_store',
2283
'bzrlib.tests.test_extract',
2284
'bzrlib.tests.test_fetch',
2285
'bzrlib.tests.test_file_names',
2286
'bzrlib.tests.test_ftp_transport',
2287
'bzrlib.tests.test_generate_docs',
2288
'bzrlib.tests.test_generate_ids',
2289
'bzrlib.tests.test_globbing',
2290
'bzrlib.tests.test_gpg',
2291
'bzrlib.tests.test_graph',
2292
'bzrlib.tests.test_hashcache',
2293
'bzrlib.tests.test_help',
2294
'bzrlib.tests.test_hooks',
2295
'bzrlib.tests.test_http',
2296
'bzrlib.tests.test_http_response',
2297
'bzrlib.tests.test_https_ca_bundle',
2298
'bzrlib.tests.test_identitymap',
2299
'bzrlib.tests.test_ignores',
2300
'bzrlib.tests.test_index',
2301
'bzrlib.tests.test_info',
2302
'bzrlib.tests.test_inv',
2303
'bzrlib.tests.test_knit',
2304
'bzrlib.tests.test_lazy_import',
2305
'bzrlib.tests.test_lazy_regex',
2306
'bzrlib.tests.test_lockdir',
2307
'bzrlib.tests.test_lockable_files',
2308
'bzrlib.tests.test_log',
2309
'bzrlib.tests.test_lsprof',
2310
'bzrlib.tests.test_memorytree',
2311
'bzrlib.tests.test_merge',
2312
'bzrlib.tests.test_merge3',
2313
'bzrlib.tests.test_merge_core',
2314
'bzrlib.tests.test_merge_directive',
2315
'bzrlib.tests.test_missing',
2316
'bzrlib.tests.test_msgeditor',
2317
'bzrlib.tests.test_multiparent',
2318
'bzrlib.tests.test_nonascii',
2319
'bzrlib.tests.test_options',
2320
'bzrlib.tests.test_osutils',
2321
'bzrlib.tests.test_osutils_encodings',
2322
'bzrlib.tests.test_pack',
2323
'bzrlib.tests.test_patch',
2324
'bzrlib.tests.test_patches',
2325
'bzrlib.tests.test_permissions',
2326
'bzrlib.tests.test_plugins',
2327
'bzrlib.tests.test_progress',
2328
'bzrlib.tests.test_reconcile',
2329
'bzrlib.tests.test_registry',
2330
'bzrlib.tests.test_remote',
2331
'bzrlib.tests.test_repository',
2332
'bzrlib.tests.test_revert',
2333
'bzrlib.tests.test_revision',
2334
'bzrlib.tests.test_revisionnamespaces',
2335
'bzrlib.tests.test_revisiontree',
2336
'bzrlib.tests.test_rio',
2337
'bzrlib.tests.test_sampler',
2338
'bzrlib.tests.test_selftest',
2339
'bzrlib.tests.test_setup',
2340
'bzrlib.tests.test_sftp_transport',
2341
'bzrlib.tests.test_smart',
2342
'bzrlib.tests.test_smart_add',
2343
'bzrlib.tests.test_smart_transport',
2344
'bzrlib.tests.test_smtp_connection',
2345
'bzrlib.tests.test_source',
2346
'bzrlib.tests.test_ssh_transport',
2347
'bzrlib.tests.test_status',
2348
'bzrlib.tests.test_store',
2349
'bzrlib.tests.test_strace',
2350
'bzrlib.tests.test_subsume',
2351
'bzrlib.tests.test_symbol_versioning',
2352
'bzrlib.tests.test_tag',
2353
'bzrlib.tests.test_testament',
2354
'bzrlib.tests.test_textfile',
2355
'bzrlib.tests.test_textmerge',
2356
'bzrlib.tests.test_timestamp',
2357
'bzrlib.tests.test_trace',
2358
'bzrlib.tests.test_transactions',
2359
'bzrlib.tests.test_transform',
2360
'bzrlib.tests.test_transport',
2361
'bzrlib.tests.test_tree',
2362
'bzrlib.tests.test_treebuilder',
2363
'bzrlib.tests.test_tsort',
2364
'bzrlib.tests.test_tuned_gzip',
2365
'bzrlib.tests.test_ui',
2366
'bzrlib.tests.test_upgrade',
2367
'bzrlib.tests.test_urlutils',
2368
'bzrlib.tests.test_versionedfile',
2369
'bzrlib.tests.test_version',
2370
'bzrlib.tests.test_version_info',
2371
'bzrlib.tests.test_weave',
2372
'bzrlib.tests.test_whitebox',
2373
'bzrlib.tests.test_workingtree',
2374
'bzrlib.tests.test_workingtree_4',
2375
'bzrlib.tests.test_wsgi',
2376
'bzrlib.tests.test_xml',
2378
test_transport_implementations = [
2379
'bzrlib.tests.test_transport_implementations',
2380
'bzrlib.tests.test_read_bundle',
2382
suite = TestUtil.TestSuite()
3855
2383
loader = TestUtil.TestLoader()
3857
if keep_only is not None:
3858
id_filter = TestIdList(keep_only)
3860
# We take precedence over keep_only because *at loading time* using
3861
# both options means we will load less tests for the same final result.
3862
def interesting_module(name):
3863
for start in starting_with:
3865
# Either the module name starts with the specified string
3866
name.startswith(start)
3867
# or it may contain tests starting with the specified string
3868
or start.startswith(name)
3872
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3874
elif keep_only is not None:
3875
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3876
def interesting_module(name):
3877
return id_filter.refers_to(name)
3880
loader = TestUtil.TestLoader()
3881
def interesting_module(name):
3882
# No filtering, all modules are interesting
3885
suite = loader.suiteClass()
3887
# modules building their suite with loadTestsFromModuleNames
3888
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3890
for mod in _test_suite_modules_to_doctest():
3891
if not interesting_module(mod):
3892
# No tests to keep here, move along
2384
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
2385
from bzrlib.tests.test_transport_implementations import TransportTestProviderAdapter
2386
adapter = TransportTestProviderAdapter()
2387
adapt_modules(test_transport_implementations, adapter, loader, suite)
2388
for package in packages_to_test():
2389
suite.addTest(package.test_suite())
2390
for m in MODULES_TO_TEST:
2391
suite.addTest(loader.loadTestsFromModule(m))
2392
for m in MODULES_TO_DOCTEST:
3895
# note that this really does mean "report only" -- doctest
3896
# still runs the rest of the examples
3897
doc_suite = doctest.DocTestSuite(mod,
3898
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
2394
suite.addTest(doctest.DocTestSuite(m))
3899
2395
except ValueError, e:
3900
print '**failed to get doctest for: %s\n%s' % (mod, e)
2396
print '**failed to get doctest for: %s\n%s' %(m,e)
3902
if len(doc_suite._tests) == 0:
3903
raise errors.BzrError("no doctests found in %s" % (mod,))
3904
suite.addTest(doc_suite)
3906
default_encoding = sys.getdefaultencoding()
3907
for name, plugin in bzrlib.plugin.plugins().items():
3908
if not interesting_module(plugin.module.__name__):
3910
plugin_suite = plugin.test_suite()
3911
# We used to catch ImportError here and turn it into just a warning,
3912
# but really if you don't have --no-plugins this should be a failure.
3913
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3914
if plugin_suite is None:
3915
plugin_suite = plugin.load_plugin_tests(loader)
3916
if plugin_suite is not None:
3917
suite.addTest(plugin_suite)
3918
if default_encoding != sys.getdefaultencoding():
3919
bzrlib.trace.warning(
3920
'Plugin "%s" tried to reset default encoding to: %s', name,
3921
sys.getdefaultencoding())
3923
sys.setdefaultencoding(default_encoding)
3925
if keep_only is not None:
3926
# Now that the referred modules have loaded their tests, keep only the
3928
suite = filter_suite_by_id_list(suite, id_filter)
3929
# Do some sanity checks on the id_list filtering
3930
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3932
# The tester has used both keep_only and starting_with, so he is
3933
# already aware that some tests are excluded from the list, there
3934
# is no need to tell him which.
3937
# Some tests mentioned in the list are not in the test suite. The
3938
# list may be out of date, report to the tester.
3939
for id in not_found:
3940
bzrlib.trace.warning('"%s" not found in the test suite', id)
3941
for id in duplicates:
3942
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
2398
for name, plugin in bzrlib.plugin.all_plugins().items():
2399
if getattr(plugin, 'test_suite', None) is not None:
2400
default_encoding = sys.getdefaultencoding()
2402
plugin_suite = plugin.test_suite()
2403
except ImportError, e:
2404
bzrlib.trace.warning(
2405
'Unable to test plugin "%s": %s', name, e)
2407
suite.addTest(plugin_suite)
2408
if default_encoding != sys.getdefaultencoding():
2409
bzrlib.trace.warning(
2410
'Plugin "%s" tried to reset default encoding to: %s', name,
2411
sys.getdefaultencoding())
2413
sys.setdefaultencoding(default_encoding)
3947
def multiply_scenarios(scenarios_left, scenarios_right):
3948
"""Multiply two sets of scenarios.
3950
:returns: the cartesian product of the two sets of scenarios, that is
3951
a scenario for every possible combination of a left scenario and a
3955
('%s,%s' % (left_name, right_name),
3956
dict(left_dict.items() + right_dict.items()))
3957
for left_name, left_dict in scenarios_left
3958
for right_name, right_dict in scenarios_right]
3961
def multiply_tests(tests, scenarios, result):
3962
"""Multiply tests_list by scenarios into result.
3964
This is the core workhorse for test parameterisation.
3966
Typically the load_tests() method for a per-implementation test suite will
3967
call multiply_tests and return the result.
3969
:param tests: The tests to parameterise.
3970
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3971
scenario_param_dict).
3972
:param result: A TestSuite to add created tests to.
3974
This returns the passed in result TestSuite with the cross product of all
3975
the tests repeated once for each scenario. Each test is adapted by adding
3976
the scenario name at the end of its id(), and updating the test object's
3977
__dict__ with the scenario_param_dict.
3979
>>> import bzrlib.tests.test_sampler
3980
>>> r = multiply_tests(
3981
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3982
... [('one', dict(param=1)),
3983
... ('two', dict(param=2))],
3985
>>> tests = list(iter_suite_tests(r))
3989
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3995
for test in iter_suite_tests(tests):
3996
apply_scenarios(test, scenarios, result)
4000
def apply_scenarios(test, scenarios, result):
4001
"""Apply the scenarios in scenarios to test and add to result.
4003
:param test: The test to apply scenarios to.
4004
:param scenarios: An iterable of scenarios to apply to test.
4006
:seealso: apply_scenario
4008
for scenario in scenarios:
4009
result.addTest(apply_scenario(test, scenario))
4013
def apply_scenario(test, scenario):
4014
"""Copy test and apply scenario to it.
4016
:param test: A test to adapt.
4017
:param scenario: A tuple describing the scenarion.
4018
The first element of the tuple is the new test id.
4019
The second element is a dict containing attributes to set on the
4021
:return: The adapted test.
4023
new_id = "%s(%s)" % (test.id(), scenario[0])
4024
new_test = clone_test(test, new_id)
4025
for name, value in scenario[1].items():
4026
setattr(new_test, name, value)
4030
def clone_test(test, new_id):
4031
"""Clone a test giving it a new id.
4033
:param test: The test to clone.
4034
:param new_id: The id to assign to it.
4035
:return: The new test.
4037
new_test = copy(test)
4038
new_test.id = lambda: new_id
4042
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4044
"""Helper for permutating tests against an extension module.
4046
This is meant to be used inside a modules 'load_tests()' function. It will
4047
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4048
against both implementations. Setting 'test.module' to the appropriate
4049
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4051
:param standard_tests: A test suite to permute
4052
:param loader: A TestLoader
4053
:param py_module_name: The python path to a python module that can always
4054
be loaded, and will be considered the 'python' implementation. (eg
4055
'bzrlib._chk_map_py')
4056
:param ext_module_name: The python path to an extension module. If the
4057
module cannot be loaded, a single test will be added, which notes that
4058
the module is not available. If it can be loaded, all standard_tests
4059
will be run against that module.
4060
:return: (suite, feature) suite is a test-suite that has all the permuted
4061
tests. feature is the Feature object that can be used to determine if
4062
the module is available.
4065
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4067
('python', {'module': py_module}),
4069
suite = loader.suiteClass()
4070
feature = ModuleAvailableFeature(ext_module_name)
4071
if feature.available():
4072
scenarios.append(('C', {'module': feature.module}))
4074
# the compiled module isn't available, so we add a failing test
4075
class FailWithoutFeature(TestCase):
4076
def test_fail(self):
4077
self.requireFeature(feature)
4078
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4079
result = multiply_tests(standard_tests, scenarios, suite)
4080
return result, feature
4083
def _rmtree_temp_dir(dirname, test_id=None):
2417
def adapt_modules(mods_list, adapter, loader, suite):
2418
"""Adapt the modules in mods_list using adapter and add to suite."""
2419
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
2420
suite.addTests(adapter.adapt(test))
2423
def _rmtree_temp_dir(dirname):
4084
2424
# If LANG=C we probably have created some bogus paths
4085
2425
# which rmtree(unicode) will fail to delete
4086
2426
# so make sure we are using rmtree(str) to delete everything
4133
2471
return self.__class__.__name__
4136
class _SymlinkFeature(Feature):
4139
return osutils.has_symlinks()
4141
def feature_name(self):
4144
SymlinkFeature = _SymlinkFeature()
4147
class _HardlinkFeature(Feature):
4150
return osutils.has_hardlinks()
4152
def feature_name(self):
4155
HardlinkFeature = _HardlinkFeature()
4158
class _OsFifoFeature(Feature):
4161
return getattr(os, 'mkfifo', None)
4163
def feature_name(self):
4164
return 'filesystem fifos'
4166
OsFifoFeature = _OsFifoFeature()
4169
class _UnicodeFilenameFeature(Feature):
4170
"""Does the filesystem support Unicode filenames?"""
4174
# Check for character combinations unlikely to be covered by any
4175
# single non-unicode encoding. We use the characters
4176
# - greek small letter alpha (U+03B1) and
4177
# - braille pattern dots-123456 (U+283F).
4178
os.stat(u'\u03b1\u283f')
4179
except UnicodeEncodeError:
4181
except (IOError, OSError):
4182
# The filesystem allows the Unicode filename but the file doesn't
4186
# The filesystem allows the Unicode filename and the file exists,
4190
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4193
class _CompatabilityThunkFeature(Feature):
4194
"""This feature is just a thunk to another feature.
4196
It issues a deprecation warning if it is accessed, to let you know that you
4197
should really use a different feature.
4200
def __init__(self, dep_version, module, name,
4201
replacement_name, replacement_module=None):
4202
super(_CompatabilityThunkFeature, self).__init__()
4203
self._module = module
4204
if replacement_module is None:
4205
replacement_module = module
4206
self._replacement_module = replacement_module
4208
self._replacement_name = replacement_name
4209
self._dep_version = dep_version
4210
self._feature = None
4213
if self._feature is None:
4214
depr_msg = self._dep_version % ('%s.%s'
4215
% (self._module, self._name))
4216
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4217
self._replacement_name)
4218
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4219
# Import the new feature and use it as a replacement for the
4221
mod = __import__(self._replacement_module, {}, {},
4222
[self._replacement_name])
4223
self._feature = getattr(mod, self._replacement_name)
4227
return self._feature._probe()
4230
class ModuleAvailableFeature(Feature):
4231
"""This is a feature than describes a module we want to be available.
4233
Declare the name of the module in __init__(), and then after probing, the
4234
module will be available as 'self.module'.
4236
:ivar module: The module if it is available, else None.
4239
def __init__(self, module_name):
4240
super(ModuleAvailableFeature, self).__init__()
4241
self.module_name = module_name
4245
self._module = __import__(self.module_name, {}, {}, [''])
4252
if self.available(): # Make sure the probe has been done
4256
def feature_name(self):
4257
return self.module_name
4260
# This is kept here for compatibility, it is recommended to use
4261
# 'bzrlib.tests.feature.paramiko' instead
4262
ParamikoFeature = _CompatabilityThunkFeature(
4263
deprecated_in((2,1,0)),
4264
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4267
def probe_unicode_in_user_encoding():
4268
"""Try to encode several unicode strings to use in unicode-aware tests.
4269
Return first successfull match.
4271
:return: (unicode value, encoded plain string value) or (None, None)
4273
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4274
for uni_val in possible_vals:
4276
str_val = uni_val.encode(osutils.get_user_encoding())
4277
except UnicodeEncodeError:
4278
# Try a different character
4281
return uni_val, str_val
4285
def probe_bad_non_ascii(encoding):
4286
"""Try to find [bad] character with code [128..255]
4287
that cannot be decoded to unicode in some encoding.
4288
Return None if all non-ascii characters is valid
4291
for i in xrange(128, 256):
4294
char.decode(encoding)
4295
except UnicodeDecodeError:
4300
class _HTTPSServerFeature(Feature):
4301
"""Some tests want an https Server, check if one is available.
4303
Right now, the only way this is available is under python2.6 which provides
4314
def feature_name(self):
4315
return 'HTTPSServer'
4318
HTTPSServerFeature = _HTTPSServerFeature()
4321
class _UnicodeFilename(Feature):
4322
"""Does the filesystem support Unicode filenames?"""
4327
except UnicodeEncodeError:
4329
except (IOError, OSError):
4330
# The filesystem allows the Unicode filename but the file doesn't
4334
# The filesystem allows the Unicode filename and the file exists,
4338
UnicodeFilename = _UnicodeFilename()
4341
class _UTF8Filesystem(Feature):
4342
"""Is the filesystem UTF-8?"""
4345
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4349
UTF8Filesystem = _UTF8Filesystem()
4352
class _BreakinFeature(Feature):
4353
"""Does this platform support the breakin feature?"""
4356
from bzrlib import breakin
4357
if breakin.determine_signal() is None:
4359
if sys.platform == 'win32':
4360
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4361
# We trigger SIGBREAK via a Console api so we need ctypes to
4362
# access the function
4369
def feature_name(self):
4370
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4373
BreakinFeature = _BreakinFeature()
4376
class _CaseInsCasePresFilenameFeature(Feature):
4377
"""Is the file-system case insensitive, but case-preserving?"""
4380
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4382
# first check truly case-preserving for created files, then check
4383
# case insensitive when opening existing files.
4384
name = osutils.normpath(name)
4385
base, rel = osutils.split(name)
4386
found_rel = osutils.canonical_relpath(base, name)
4387
return (found_rel == rel
4388
and os.path.isfile(name.upper())
4389
and os.path.isfile(name.lower()))
4394
def feature_name(self):
4395
return "case-insensitive case-preserving filesystem"
4397
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4400
class _CaseInsensitiveFilesystemFeature(Feature):
4401
"""Check if underlying filesystem is case-insensitive but *not* case
4404
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4405
# more likely to be case preserving, so this case is rare.
4408
if CaseInsCasePresFilenameFeature.available():
4411
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4412
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4413
TestCaseWithMemoryTransport.TEST_ROOT = root
4415
root = TestCaseWithMemoryTransport.TEST_ROOT
4416
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4418
name_a = osutils.pathjoin(tdir, 'a')
4419
name_A = osutils.pathjoin(tdir, 'A')
4421
result = osutils.isdir(name_A)
4422
_rmtree_temp_dir(tdir)
2474
class TestScenarioApplier(object):
2475
"""A tool to apply scenarios to tests."""
2477
def adapt(self, test):
2478
"""Return a TestSuite containing a copy of test for each scenario."""
2479
result = unittest.TestSuite()
2480
for scenario in self.scenarios:
2481
result.addTest(self.adapt_test_to_scenario(test, scenario))
4425
def feature_name(self):
4426
return 'case-insensitive filesystem'
4428
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4431
class _CaseSensitiveFilesystemFeature(Feature):
4434
if CaseInsCasePresFilenameFeature.available():
4436
elif CaseInsensitiveFilesystemFeature.available():
4441
def feature_name(self):
4442
return 'case-sensitive filesystem'
4444
# new coding style is for feature instances to be lowercase
4445
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4448
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4449
SubUnitFeature = _CompatabilityThunkFeature(
4450
deprecated_in((2,1,0)),
4451
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4452
# Only define SubUnitBzrRunner if subunit is available.
4454
from subunit import TestProtocolClient
4455
from subunit.test_results import AutoTimingTestResultDecorator
4456
class SubUnitBzrRunner(TextTestRunner):
4457
def run(self, test):
4458
result = AutoTimingTestResultDecorator(
4459
TestProtocolClient(self.stream))
4465
class _PosixPermissionsFeature(Feature):
4469
# create temporary file and check if specified perms are maintained.
4472
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4473
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4476
os.chmod(name, write_perms)
4478
read_perms = os.stat(name).st_mode & 0777
4480
return (write_perms == read_perms)
4482
return (os.name == 'posix') and has_perms()
4484
def feature_name(self):
4485
return 'POSIX permissions support'
4487
posix_permissions_feature = _PosixPermissionsFeature()
2484
def adapt_test_to_scenario(self, test, scenario):
2485
"""Copy test and apply scenario to it.
2487
:param test: A test to adapt.
2488
:param scenario: A tuple describing the scenarion.
2489
The first element of the tuple is the new test id.
2490
The second element is a dict containing attributes to set on the
2492
:return: The adapted test.
2494
from copy import deepcopy
2495
new_test = deepcopy(test)
2496
for name, value in scenario[1].items():
2497
setattr(new_test, name, value)
2498
new_id = "%s(%s)" % (new_test.id(), scenario[0])
2499
new_test.id = lambda: new_id
added
removed
bzrlib/tests/__init__.py
