185
170
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
186
171
self._bench_history = bench_history
187
self.ui = ui.ui_factory
172
self.ui = bzrlib.ui.ui_factory
173
self.num_tests = num_tests
189
174
self.error_count = 0
190
175
self.failure_count = 0
191
self.known_failure_count = 0
192
176
self.skip_count = 0
193
self.not_applicable_count = 0
194
self.unsupported = {}
196
178
self._overall_start_time = time.time()
197
self._strict = strict
199
def stopTestRun(self):
202
stopTime = time.time()
203
timeTaken = stopTime - self.startTime
205
self.stream.writeln(self.separator2)
206
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
207
run, run != 1 and "s" or "", timeTaken))
208
self.stream.writeln()
209
if not self.wasSuccessful():
210
self.stream.write("FAILED (")
211
failed, errored = map(len, (self.failures, self.errors))
213
self.stream.write("failures=%d" % failed)
215
if failed: self.stream.write(", ")
216
self.stream.write("errors=%d" % errored)
217
if self.known_failure_count:
218
if failed or errored: self.stream.write(", ")
219
self.stream.write("known_failure_count=%d" %
220
self.known_failure_count)
221
self.stream.writeln(")")
223
if self.known_failure_count:
224
self.stream.writeln("OK (known_failures=%d)" %
225
self.known_failure_count)
227
self.stream.writeln("OK")
228
if self.skip_count > 0:
229
skipped = self.skip_count
230
self.stream.writeln('%d test%s skipped' %
231
(skipped, skipped != 1 and "s" or ""))
233
for feature, count in sorted(self.unsupported.items()):
234
self.stream.writeln("Missing feature '%s' skipped %d tests." %
237
ok = self.wasStrictlySuccessful()
239
ok = self.wasSuccessful()
240
if TestCase._first_thread_leaker_id:
242
'%s is leaking threads among %d leaking tests.\n' % (
243
TestCase._first_thread_leaker_id,
244
TestCase._leaking_threads_tests))
245
# We don't report the main thread as an active one.
247
'%d non-main threads were left active in the end.\n'
248
% (TestCase._active_threads - 1))
250
def getDescription(self, test):
253
def _extractBenchmarkTime(self, testCase, details=None):
180
def extractBenchmarkTime(self, testCase):
254
181
"""Add a benchmark time for the current test case."""
255
if details and 'benchtime' in details:
256
return float(''.join(details['benchtime'].iter_bytes()))
257
return getattr(testCase, "_benchtime", None)
182
self._benchmarkTime = getattr(testCase, "_benchtime", None)
259
184
def _elapsedTestTimeString(self):
260
185
"""Return a time string for the overall time the current test has taken."""
261
186
return self._formatTime(time.time() - self._start_time)
263
def _testTimeString(self, testCase):
264
benchmark_time = self._extractBenchmarkTime(testCase)
265
if benchmark_time is not None:
266
return self._formatTime(benchmark_time) + "*"
188
def _testTimeString(self):
189
if self._benchmarkTime is not None:
191
self._formatTime(self._benchmarkTime),
192
self._elapsedTestTimeString())
268
return self._elapsedTestTimeString()
194
return " %s" % self._elapsedTestTimeString()
270
196
def _formatTime(self, seconds):
271
197
"""Format seconds as milliseconds with leading spaces."""
272
# some benchmarks can take thousands of seconds to run, so we need 8
274
return "%8dms" % (1000 * seconds)
198
return "%5dms" % (1000 * seconds)
276
200
def _shortened_test_description(self, test):
278
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
202
what = re.sub(r'^bzrlib\.(tests|benchmark)\.', '', what)
281
205
def startTest(self, test):
282
206
unittest.TestResult.startTest(self, test)
285
207
self.report_test_start(test)
286
test.number = self.count
287
208
self._recordTestStartTime()
289
def startTests(self):
291
if getattr(sys, 'frozen', None) is None:
292
bzr_path = osutils.realpath(sys.argv[0])
294
bzr_path = sys.executable
296
'bzr selftest: %s\n' % (bzr_path,))
299
bzrlib.__path__[0],))
301
' bzr-%s python-%s %s\n' % (
302
bzrlib.version_string,
303
bzrlib._format_version_tuple(sys.version_info),
304
platform.platform(aliased=1),
306
self.stream.write('\n')
308
210
def _recordTestStartTime(self):
309
211
"""Record that a test has started."""
310
212
self._start_time = time.time()
312
def _cleanupLogFile(self, test):
313
# We can only do this if we have one of our TestCases, not if
315
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
316
if setKeepLogfile is not None:
319
214
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.
215
if isinstance(err[1], TestSkipped):
216
return self.addSkipped(test, err)
326
217
unittest.TestResult.addError(self, test, err)
327
self.error_count += 1
218
# We can only do this if we have one of our TestCases, not if
220
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
221
if setKeepLogfile is not None:
223
self.extractBenchmarkTime(test)
328
224
self.report_error(test, err)
329
225
if self.stop_early:
331
self._cleanupLogFile(test)
333
228
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.
340
229
unittest.TestResult.addFailure(self, test, err)
341
self.failure_count += 1
230
# We can only do this if we have one of our TestCases, not if
232
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
233
if setKeepLogfile is not None:
235
self.extractBenchmarkTime(test)
342
236
self.report_failure(test, err)
343
237
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()
240
def addSuccess(self, test):
241
self.extractBenchmarkTime(test)
352
242
if self._bench_history is not None:
353
benchmark_time = self._extractBenchmarkTime(test, details)
354
if benchmark_time is not None:
243
if self._benchmarkTime is not None:
355
244
self._bench_history.write("%s %s\n" % (
356
self._formatTime(benchmark_time),
245
self._formatTime(self._benchmarkTime),
358
247
self.report_success(test)
359
self._cleanupLogFile(test)
360
248
unittest.TestResult.addSuccess(self, test)
361
test._log_contents = ''
363
def addExpectedFailure(self, test, err):
364
self.known_failure_count += 1
365
self.report_known_failure(test, err)
367
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
self.unsupported.setdefault(str(feature), 0)
377
self.unsupported[str(feature)] += 1
378
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
250
def addSkipped(self, test, skip_excinfo):
251
self.extractBenchmarkTime(test)
252
self.report_skip(test, skip_excinfo)
253
# seems best to treat this as success from point-of-view of unittest
254
# -- it actually does nothing so it barely matters :)
257
except KeyboardInterrupt:
260
self.addError(test, test.__exc_info())
401
raise errors.BzrError("Unknown whence %r" % whence)
262
unittest.TestResult.addSuccess(self, test)
264
def printErrorList(self, flavour, errors):
265
for test, err in errors:
266
self.stream.writeln(self.separator1)
267
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
268
if getattr(test, '_get_log', None) is not None:
270
print >>self.stream, \
271
('vvvv[log from %s]' % test.id()).ljust(78,'-')
272
print >>self.stream, test._get_log()
273
print >>self.stream, \
274
('^^^^[log from %s]' % test.id()).ljust(78,'-')
275
self.stream.writeln(self.separator2)
276
self.stream.writeln("%s" % err)
403
281
def report_cleaning_up(self):
406
def startTestRun(self):
407
self.startTime = time.time()
409
284
def report_success(self, test):
412
def wasStrictlySuccessful(self):
413
if self.unsupported or self.known_failure_count:
415
return self.wasSuccessful()
418
288
class TextTestResult(ExtendedTestResult):
419
289
"""Displays progress and results of tests in text form"""
421
def __init__(self, stream, descriptions, verbosity,
426
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")
291
def __init__(self, *args, **kw):
292
ExtendedTestResult.__init__(self, *args, **kw)
432
293
self.pb = self.ui.nested_progress_bar()
433
294
self.pb.show_pct = False
434
295
self.pb.show_spinner = False
435
self.pb.show_eta = False,
296
self.pb.show_eta = False,
436
297
self.pb.show_count = False
437
298
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()
300
def report_starting(self):
301
self.pb.update('[test 0/%d] starting...' % (self.num_tests))
456
303
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
304
a = '[%d' % self.count
305
if self.num_tests is not None:
467
306
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)
307
a += ' in %ds' % (time.time() - self._overall_start_time)
309
a += ', %d errors' % self.error_count
310
if self.failure_count:
311
a += ', %d failed' % self.failure_count
313
a += ', %d skipped' % self.skip_count
784
535
retrieved by _get_log(). We use a real OS file, not an in-memory object,
785
536
so that it can also capture file IO. When the test completes this file
786
537
is read into memory and removed from disk.
788
539
There are also convenience functions to invoke bzr's command-line
789
540
routine, and to build and check bzr trees.
791
542
In addition to the usual method of overriding tearDown(), this class also
792
543
allows subclasses to register functions into the _cleanups list, which is
793
544
run in order as the object is torn down. It's less likely this will be
794
545
accidentally overlooked.
797
_active_threads = None
798
_leaking_threads_tests = 0
799
_first_thread_leaker_id = None
800
548
_log_file_name = None
550
_keep_log_file = False
801
551
# record lsprof data when performing benchmark calls.
802
552
_gather_lsprof_in_benchmarks = False
804
554
def __init__(self, methodName='testMethod'):
805
555
super(TestCase, self).__init__(methodName)
806
556
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)]))
559
unittest.TestCase.setUp(self)
821
560
self._cleanEnvironment()
561
bzrlib.trace.disable_default_logging()
822
562
self._silenceUI()
823
563
self._startLogFile()
824
564
self._benchcalls = []
825
565
self._benchtime = None
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
def _clear_hooks(self):
867
# 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)
873
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
888
567
def _silenceUI(self):
889
568
"""Turn off UI for duration of test"""
890
569
# 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.")
570
saved = bzrlib.ui.ui_factory
572
bzrlib.ui.ui_factory = saved
573
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
574
self.addCleanup(_restore)
1071
576
def _ndiff_strings(self, a, b):
1072
577
"""Return ndiff between two strings containing lines.
1074
579
A trailing newline is added if missing to make the strings
1075
580
print properly."""
1076
581
if b and b[-1] != '\n':
2721
1592
for readonly urls.
2723
1594
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2724
be used without needed to redo it when a different
1595
be used without needed to redo it when a different
2725
1596
subclass is in use ?
2728
1599
def setUp(self):
2729
1600
super(ChrootedTestCase, self).setUp()
2730
if not self.vfs_transport_factory == memory.MemoryServer:
2731
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):
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)
1601
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1602
self.transport_readonly_server = bzrlib.transport.http.HttpServer
2817
1605
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
1606
result = TestUtil.TestSuite()
1607
filter_re = re.compile(pattern)
2901
1608
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))
1609
if filter_re.search(test.id()):
1610
result.addTest(test)
2924
1614
def run_suite(suite, name='test', verbose=False, pattern=".*",
2925
stop_on_failure=False,
2926
transport=None, lsprof_timed=None, bench_history=None,
2927
matching_tests_first=None,
2930
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.
1615
stop_on_failure=False, keep_output=False,
1616
transport=None, lsprof_timed=None, bench_history=None):
2944
1617
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2949
if runner_class is None:
2950
runner_class = TextTestRunner
2953
runner = runner_class(stream=stream,
1622
runner = TextTestRunner(stream=sys.stdout,
2954
1623
descriptions=0,
2955
1624
verbosity=verbosity,
2956
bench_history=bench_history,
2958
result_decorators=result_decorators,
1625
keep_output=keep_output,
1626
bench_history=bench_history)
2960
1627
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()))
1629
suite = filter_suite_by_re(suite, pattern)
2987
1630
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())
3165
# Convert the seed to a long if we can
3167
self.random_seed = long(self.random_seed)
3170
return self.random_seed
3173
class TestFirstDecorator(TestDecorator):
3174
"""A decorator which moves named tests to the front."""
3176
def __init__(self, suite, pattern):
3177
TestDecorator.__init__(self, suite)
3178
self.pattern = pattern
3179
self.filtered = False
3183
return iter(self._tests)
3184
self.filtered = True
3185
suites = split_suite_by_re(self, self.pattern)
3187
self.addTests(suites)
3188
return iter(self._tests)
3191
def partition_tests(suite, count):
3192
"""Partition suite into count lists of tests."""
3194
tests = list(iter_suite_tests(suite))
3195
tests_per_process = int(math.ceil(float(len(tests)) / count))
3196
for block in range(count):
3197
low_test = block * tests_per_process
3198
high_test = low_test + tests_per_process
3199
process_tests = tests[low_test:high_test]
3200
result.append(process_tests)
3204
def workaround_zealous_crypto_random():
3205
"""Crypto.Random want to help us being secure, but we don't care here.
3207
This workaround some test failure related to the sftp server. Once paramiko
3208
stop using the controversial API in Crypto.Random, we may get rid of it.
3211
from Crypto.Random import atfork
3217
def fork_for_tests(suite):
3218
"""Take suite and start up one runner per CPU by forking()
3220
:return: An iterable of TestCase-like objects which can each have
3221
run(result) called on them to feed tests to result.
3223
concurrency = osutils.local_concurrency()
3225
from subunit import TestProtocolClient, ProtocolTestCase
3226
from subunit.test_results import AutoTimingTestResultDecorator
3227
class TestInOtherProcess(ProtocolTestCase):
3228
# Should be in subunit, I think. RBC.
3229
def __init__(self, stream, pid):
3230
ProtocolTestCase.__init__(self, stream)
3233
def run(self, result):
3235
ProtocolTestCase.run(self, result)
3237
os.waitpid(self.pid, 0)
3239
test_blocks = partition_tests(suite, concurrency)
3240
for process_tests in test_blocks:
3241
process_suite = TestSuite()
3242
process_suite.addTests(process_tests)
3243
c2pread, c2pwrite = os.pipe()
3246
workaround_zealous_crypto_random()
3249
# Leave stderr and stdout open so we can see test noise
3250
# Close stdin so that the child goes away if it decides to
3251
# read from stdin (otherwise its a roulette to see what
3252
# child actually gets keystrokes for pdb etc).
3255
stream = os.fdopen(c2pwrite, 'wb', 1)
3256
subunit_result = AutoTimingTestResultDecorator(
3257
TestProtocolClient(stream))
3258
process_suite.run(subunit_result)
3263
stream = os.fdopen(c2pread, 'rb', 1)
3264
test = TestInOtherProcess(stream, pid)
3269
def reinvoke_for_tests(suite):
3270
"""Take suite and start up one runner per CPU using subprocess().
3272
:return: An iterable of TestCase-like objects which can each have
3273
run(result) called on them to feed tests to result.
3275
concurrency = osutils.local_concurrency()
3277
from subunit import ProtocolTestCase
3278
class TestInSubprocess(ProtocolTestCase):
3279
def __init__(self, process, name):
3280
ProtocolTestCase.__init__(self, process.stdout)
3281
self.process = process
3282
self.process.stdin.close()
3285
def run(self, result):
3287
ProtocolTestCase.run(self, result)
3290
os.unlink(self.name)
3291
# print "pid %d finished" % finished_process
3292
test_blocks = partition_tests(suite, concurrency)
3293
for process_tests in test_blocks:
3294
# ugly; currently reimplement rather than reuses TestCase methods.
3295
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3296
if not os.path.isfile(bzr_path):
3297
# We are probably installed. Assume sys.argv is the right file
3298
bzr_path = sys.argv[0]
3299
bzr_path = [bzr_path]
3300
if sys.platform == "win32":
3301
# if we're on windows, we can't execute the bzr script directly
3302
bzr_path = [sys.executable] + bzr_path
3303
fd, test_list_file_name = tempfile.mkstemp()
3304
test_list_file = os.fdopen(fd, 'wb', 1)
3305
for test in process_tests:
3306
test_list_file.write(test.id() + '\n')
3307
test_list_file.close()
3309
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3311
if '--no-plugins' in sys.argv:
3312
argv.append('--no-plugins')
3313
# stderr=STDOUT would be ideal, but until we prevent noise on
3314
# stderr it can interrupt the subunit protocol.
3315
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3317
test = TestInSubprocess(process, test_list_file_name)
3320
os.unlink(test_list_file_name)
3325
class ForwardingResult(unittest.TestResult):
3327
def __init__(self, target):
3328
unittest.TestResult.__init__(self)
3329
self.result = target
3331
def startTest(self, test):
3332
self.result.startTest(test)
3334
def stopTest(self, test):
3335
self.result.stopTest(test)
3337
def startTestRun(self):
3338
self.result.startTestRun()
3340
def stopTestRun(self):
3341
self.result.stopTestRun()
3343
def addSkip(self, test, reason):
3344
self.result.addSkip(test, reason)
3346
def addSuccess(self, test):
3347
self.result.addSuccess(test)
3349
def addError(self, test, err):
3350
self.result.addError(test, err)
3352
def addFailure(self, test, err):
3353
self.result.addFailure(test, err)
3354
ForwardingResult = testtools.ExtendedToOriginalDecorator
3357
class ProfileResult(ForwardingResult):
3358
"""Generate profiling data for all activity between start and success.
3360
The profile data is appended to the test's _benchcalls attribute and can
3361
be accessed by the forwarded-to TestResult.
3363
While it might be cleaner do accumulate this in stopTest, addSuccess is
3364
where our existing output support for lsprof is, and this class aims to
3365
fit in with that: while it could be moved it's not necessary to accomplish
3366
test profiling, nor would it be dramatically cleaner.
3369
def startTest(self, test):
3370
self.profiler = bzrlib.lsprof.BzrProfiler()
3371
self.profiler.start()
3372
ForwardingResult.startTest(self, test)
3374
def addSuccess(self, test):
3375
stats = self.profiler.stop()
3377
calls = test._benchcalls
3378
except AttributeError:
3379
test._benchcalls = []
3380
calls = test._benchcalls
3381
calls.append(((test.id(), "", ""), stats))
3382
ForwardingResult.addSuccess(self, test)
3384
def stopTest(self, test):
3385
ForwardingResult.stopTest(self, test)
3386
self.profiler = None
3389
# Controlled by "bzr selftest -E=..." option
3390
# Currently supported:
3391
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3392
# preserves any flags supplied at the command line.
3393
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3394
# rather than failing tests. And no longer raise
3395
# LockContention when fctnl locks are not being used
3396
# with proper exclusion rules.
3397
selftest_debug_flags = set()
1631
return result.wasSuccessful()
3400
1634
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3401
1636
transport=None,
3402
1637
test_suite_factory=None,
3403
1638
lsprof_timed=None,
3405
matching_tests_first=None,
3408
exclude_pattern=None,
3414
suite_decorators=None,
1639
bench_history=None):
3418
1640
"""Run the whole test suite under the enhanced runner"""
3419
1641
# XXX: Very ugly way to do this...
3420
1642
# Disable warning about old formats because we don't want it to disturb
3427
1649
transport = default_transport
3428
1650
old_transport = default_transport
3429
1651
default_transport = transport
3430
global selftest_debug_flags
3431
old_debug_flags = selftest_debug_flags
3432
if debug_flags is not None:
3433
selftest_debug_flags = set(debug_flags)
3435
if load_list is None:
3438
keep_only = load_test_id_list(load_list)
3440
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3441
for start in starting_with]
3442
1653
if test_suite_factory is None:
3443
# Reduce loading time by loading modules based on the starting_with
3445
suite = test_suite(keep_only, starting_with)
1654
suite = test_suite()
3447
1656
suite = test_suite_factory()
3449
# But always filter as requested.
3450
suite = filter_suite_by_id_startswith(suite, starting_with)
3451
result_decorators = []
3453
result_decorators.append(ProfileResult)
3454
1657
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3455
stop_on_failure=stop_on_failure,
1658
stop_on_failure=stop_on_failure, keep_output=keep_output,
3456
1659
transport=transport,
3457
1660
lsprof_timed=lsprof_timed,
3458
bench_history=bench_history,
3459
matching_tests_first=matching_tests_first,
3460
list_only=list_only,
3461
random_seed=random_seed,
3462
exclude_pattern=exclude_pattern,
3464
runner_class=runner_class,
3465
suite_decorators=suite_decorators,
3467
result_decorators=result_decorators,
1661
bench_history=bench_history)
3470
1663
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_matchers',
3738
'bzrlib.tests.test_memorytree',
3739
'bzrlib.tests.test_merge',
3740
'bzrlib.tests.test_merge3',
3741
'bzrlib.tests.test_merge_core',
3742
'bzrlib.tests.test_merge_directive',
3743
'bzrlib.tests.test_missing',
3744
'bzrlib.tests.test_msgeditor',
3745
'bzrlib.tests.test_multiparent',
3746
'bzrlib.tests.test_mutabletree',
3747
'bzrlib.tests.test_nonascii',
3748
'bzrlib.tests.test_options',
3749
'bzrlib.tests.test_osutils',
3750
'bzrlib.tests.test_osutils_encodings',
3751
'bzrlib.tests.test_pack',
3752
'bzrlib.tests.test_patch',
3753
'bzrlib.tests.test_patches',
3754
'bzrlib.tests.test_permissions',
3755
'bzrlib.tests.test_plugins',
3756
'bzrlib.tests.test_progress',
3757
'bzrlib.tests.test_read_bundle',
3758
'bzrlib.tests.test_reconcile',
3759
'bzrlib.tests.test_reconfigure',
3760
'bzrlib.tests.test_registry',
3761
'bzrlib.tests.test_remote',
3762
'bzrlib.tests.test_rename_map',
3763
'bzrlib.tests.test_repository',
3764
'bzrlib.tests.test_revert',
3765
'bzrlib.tests.test_revision',
3766
'bzrlib.tests.test_revisionspec',
3767
'bzrlib.tests.test_revisiontree',
3768
'bzrlib.tests.test_rio',
3769
'bzrlib.tests.test_rules',
3770
'bzrlib.tests.test_sampler',
3771
'bzrlib.tests.test_script',
3772
'bzrlib.tests.test_selftest',
3773
'bzrlib.tests.test_serializer',
3774
'bzrlib.tests.test_setup',
3775
'bzrlib.tests.test_sftp_transport',
3776
'bzrlib.tests.test_shelf',
3777
'bzrlib.tests.test_shelf_ui',
3778
'bzrlib.tests.test_smart',
3779
'bzrlib.tests.test_smart_add',
3780
'bzrlib.tests.test_smart_request',
3781
'bzrlib.tests.test_smart_transport',
3782
'bzrlib.tests.test_smtp_connection',
3783
'bzrlib.tests.test_source',
3784
'bzrlib.tests.test_ssh_transport',
3785
'bzrlib.tests.test_status',
3786
'bzrlib.tests.test_store',
3787
'bzrlib.tests.test_strace',
3788
'bzrlib.tests.test_subsume',
3789
'bzrlib.tests.test_switch',
3790
'bzrlib.tests.test_symbol_versioning',
3791
'bzrlib.tests.test_tag',
3792
'bzrlib.tests.test_testament',
3793
'bzrlib.tests.test_textfile',
3794
'bzrlib.tests.test_textmerge',
3795
'bzrlib.tests.test_timestamp',
3796
'bzrlib.tests.test_trace',
3797
'bzrlib.tests.test_transactions',
3798
'bzrlib.tests.test_transform',
3799
'bzrlib.tests.test_transport',
3800
'bzrlib.tests.test_transport_log',
3801
'bzrlib.tests.test_tree',
3802
'bzrlib.tests.test_treebuilder',
3803
'bzrlib.tests.test_tsort',
3804
'bzrlib.tests.test_tuned_gzip',
3805
'bzrlib.tests.test_ui',
3806
'bzrlib.tests.test_uncommit',
3807
'bzrlib.tests.test_upgrade',
3808
'bzrlib.tests.test_upgrade_stacked',
3809
'bzrlib.tests.test_urlutils',
3810
'bzrlib.tests.test_version',
3811
'bzrlib.tests.test_version_info',
3812
'bzrlib.tests.test_weave',
3813
'bzrlib.tests.test_whitebox',
3814
'bzrlib.tests.test_win32utils',
3815
'bzrlib.tests.test_workingtree',
3816
'bzrlib.tests.test_workingtree_4',
3817
'bzrlib.tests.test_wsgi',
3818
'bzrlib.tests.test_xml',
3822
def _test_suite_modules_to_doctest():
3823
"""Return the list of modules to doctest."""
3825
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3829
'bzrlib.branchbuilder',
3830
'bzrlib.decorators',
3833
'bzrlib.iterablefile',
3837
'bzrlib.symbol_versioning',
3840
'bzrlib.version_info_formats.format_custom',
3844
def test_suite(keep_only=None, starting_with=None):
3845
1667
"""Build and return TestSuite for the whole of bzrlib.
3847
:param keep_only: A list of test ids limiting the suite returned.
3849
:param starting_with: An id limiting the suite returned to the tests
3852
1669
This function can be replaced if you need to change the default test
3853
1670
suite on a global basis, but it is not encouraged.
1673
'bzrlib.tests.test_ancestry',
1674
'bzrlib.tests.test_api',
1675
'bzrlib.tests.test_atomicfile',
1676
'bzrlib.tests.test_bad_files',
1677
'bzrlib.tests.test_branch',
1678
'bzrlib.tests.test_bundle',
1679
'bzrlib.tests.test_bzrdir',
1680
'bzrlib.tests.test_cache_utf8',
1681
'bzrlib.tests.test_command',
1682
'bzrlib.tests.test_commit',
1683
'bzrlib.tests.test_commit_merge',
1684
'bzrlib.tests.test_config',
1685
'bzrlib.tests.test_conflicts',
1686
'bzrlib.tests.test_decorators',
1687
'bzrlib.tests.test_diff',
1688
'bzrlib.tests.test_doc_generate',
1689
'bzrlib.tests.test_errors',
1690
'bzrlib.tests.test_escaped_store',
1691
'bzrlib.tests.test_fetch',
1692
'bzrlib.tests.test_ftp_transport',
1693
'bzrlib.tests.test_glob',
1694
'bzrlib.tests.test_generate_ids',
1695
'bzrlib.tests.test_gpg',
1696
'bzrlib.tests.test_graph',
1697
'bzrlib.tests.test_hashcache',
1698
'bzrlib.tests.test_http',
1699
'bzrlib.tests.test_http_response',
1700
'bzrlib.tests.test_identitymap',
1701
'bzrlib.tests.test_ignores',
1702
'bzrlib.tests.test_inv',
1703
'bzrlib.tests.test_knit',
1704
'bzrlib.tests.test_lazy_import',
1705
'bzrlib.tests.test_lazy_regex',
1706
'bzrlib.tests.test_lockdir',
1707
'bzrlib.tests.test_lockable_files',
1708
'bzrlib.tests.test_log',
1709
'bzrlib.tests.test_memorytree',
1710
'bzrlib.tests.test_merge',
1711
'bzrlib.tests.test_merge3',
1712
'bzrlib.tests.test_merge_core',
1713
'bzrlib.tests.test_missing',
1714
'bzrlib.tests.test_msgeditor',
1715
'bzrlib.tests.test_nonascii',
1716
'bzrlib.tests.test_options',
1717
'bzrlib.tests.test_osutils',
1718
'bzrlib.tests.test_patch',
1719
'bzrlib.tests.test_patches',
1720
'bzrlib.tests.test_permissions',
1721
'bzrlib.tests.test_plugins',
1722
'bzrlib.tests.test_progress',
1723
'bzrlib.tests.test_reconcile',
1724
'bzrlib.tests.test_registry',
1725
'bzrlib.tests.test_repository',
1726
'bzrlib.tests.test_revert',
1727
'bzrlib.tests.test_revision',
1728
'bzrlib.tests.test_revisionnamespaces',
1729
'bzrlib.tests.test_revisiontree',
1730
'bzrlib.tests.test_rio',
1731
'bzrlib.tests.test_sampler',
1732
'bzrlib.tests.test_selftest',
1733
'bzrlib.tests.test_setup',
1734
'bzrlib.tests.test_sftp_transport',
1735
'bzrlib.tests.test_smart_add',
1736
'bzrlib.tests.test_smart_transport',
1737
'bzrlib.tests.test_source',
1738
'bzrlib.tests.test_status',
1739
'bzrlib.tests.test_store',
1740
'bzrlib.tests.test_symbol_versioning',
1741
'bzrlib.tests.test_testament',
1742
'bzrlib.tests.test_textfile',
1743
'bzrlib.tests.test_textmerge',
1744
'bzrlib.tests.test_trace',
1745
'bzrlib.tests.test_transactions',
1746
'bzrlib.tests.test_transform',
1747
'bzrlib.tests.test_transport',
1748
'bzrlib.tests.test_tree',
1749
'bzrlib.tests.test_treebuilder',
1750
'bzrlib.tests.test_tsort',
1751
'bzrlib.tests.test_tuned_gzip',
1752
'bzrlib.tests.test_ui',
1753
'bzrlib.tests.test_upgrade',
1754
'bzrlib.tests.test_urlutils',
1755
'bzrlib.tests.test_versionedfile',
1756
'bzrlib.tests.test_version',
1757
'bzrlib.tests.test_version_info',
1758
'bzrlib.tests.test_weave',
1759
'bzrlib.tests.test_whitebox',
1760
'bzrlib.tests.test_workingtree',
1761
'bzrlib.tests.test_xml',
1763
test_transport_implementations = [
1764
'bzrlib.tests.test_transport_implementations',
1765
'bzrlib.tests.test_read_bundle',
1767
suite = TestUtil.TestSuite()
3856
1768
loader = TestUtil.TestLoader()
3858
if keep_only is not None:
3859
id_filter = TestIdList(keep_only)
3861
# We take precedence over keep_only because *at loading time* using
3862
# both options means we will load less tests for the same final result.
3863
def interesting_module(name):
3864
for start in starting_with:
3866
# Either the module name starts with the specified string
3867
name.startswith(start)
3868
# or it may contain tests starting with the specified string
3869
or start.startswith(name)
3873
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3875
elif keep_only is not None:
3876
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3877
def interesting_module(name):
3878
return id_filter.refers_to(name)
3881
loader = TestUtil.TestLoader()
3882
def interesting_module(name):
3883
# No filtering, all modules are interesting
3886
suite = loader.suiteClass()
3888
# modules building their suite with loadTestsFromModuleNames
3889
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3891
for mod in _test_suite_modules_to_doctest():
3892
if not interesting_module(mod):
3893
# No tests to keep here, move along
1769
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1770
from bzrlib.transport import TransportTestProviderAdapter
1771
adapter = TransportTestProviderAdapter()
1772
adapt_modules(test_transport_implementations, adapter, loader, suite)
1773
for package in packages_to_test():
1774
suite.addTest(package.test_suite())
1775
for m in MODULES_TO_TEST:
1776
suite.addTest(loader.loadTestsFromModule(m))
1777
for m in MODULES_TO_DOCTEST:
3896
# note that this really does mean "report only" -- doctest
3897
# still runs the rest of the examples
3898
doc_suite = doctest.DocTestSuite(mod,
3899
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
1779
suite.addTest(doctest.DocTestSuite(m))
3900
1780
except ValueError, e:
3901
print '**failed to get doctest for: %s\n%s' % (mod, e)
1781
print '**failed to get doctest for: %s\n%s' %(m,e)
3903
if len(doc_suite._tests) == 0:
3904
raise errors.BzrError("no doctests found in %s" % (mod,))
3905
suite.addTest(doc_suite)
3907
default_encoding = sys.getdefaultencoding()
3908
for name, plugin in bzrlib.plugin.plugins().items():
3909
if not interesting_module(plugin.module.__name__):
3911
plugin_suite = plugin.test_suite()
3912
# We used to catch ImportError here and turn it into just a warning,
3913
# but really if you don't have --no-plugins this should be a failure.
3914
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3915
if plugin_suite is None:
3916
plugin_suite = plugin.load_plugin_tests(loader)
3917
if plugin_suite is not None:
3918
suite.addTest(plugin_suite)
3919
if default_encoding != sys.getdefaultencoding():
3920
bzrlib.trace.warning(
3921
'Plugin "%s" tried to reset default encoding to: %s', name,
3922
sys.getdefaultencoding())
3924
sys.setdefaultencoding(default_encoding)
3926
if keep_only is not None:
3927
# Now that the referred modules have loaded their tests, keep only the
3929
suite = filter_suite_by_id_list(suite, id_filter)
3930
# Do some sanity checks on the id_list filtering
3931
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3933
# The tester has used both keep_only and starting_with, so he is
3934
# already aware that some tests are excluded from the list, there
3935
# is no need to tell him which.
3938
# Some tests mentioned in the list are not in the test suite. The
3939
# list may be out of date, report to the tester.
3940
for id in not_found:
3941
bzrlib.trace.warning('"%s" not found in the test suite', id)
3942
for id in duplicates:
3943
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
1783
for name, plugin in bzrlib.plugin.all_plugins().items():
1784
if getattr(plugin, 'test_suite', None) is not None:
1785
suite.addTest(plugin.test_suite())
3948
def multiply_scenarios(scenarios_left, scenarios_right):
3949
"""Multiply two sets of scenarios.
3951
:returns: the cartesian product of the two sets of scenarios, that is
3952
a scenario for every possible combination of a left scenario and a
3956
('%s,%s' % (left_name, right_name),
3957
dict(left_dict.items() + right_dict.items()))
3958
for left_name, left_dict in scenarios_left
3959
for right_name, right_dict in scenarios_right]
3962
def multiply_tests(tests, scenarios, result):
3963
"""Multiply tests_list by scenarios into result.
3965
This is the core workhorse for test parameterisation.
3967
Typically the load_tests() method for a per-implementation test suite will
3968
call multiply_tests and return the result.
3970
:param tests: The tests to parameterise.
3971
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3972
scenario_param_dict).
3973
:param result: A TestSuite to add created tests to.
3975
This returns the passed in result TestSuite with the cross product of all
3976
the tests repeated once for each scenario. Each test is adapted by adding
3977
the scenario name at the end of its id(), and updating the test object's
3978
__dict__ with the scenario_param_dict.
3980
>>> import bzrlib.tests.test_sampler
3981
>>> r = multiply_tests(
3982
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3983
... [('one', dict(param=1)),
3984
... ('two', dict(param=2))],
3986
>>> tests = list(iter_suite_tests(r))
3990
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3996
for test in iter_suite_tests(tests):
3997
apply_scenarios(test, scenarios, result)
4001
def apply_scenarios(test, scenarios, result):
4002
"""Apply the scenarios in scenarios to test and add to result.
4004
:param test: The test to apply scenarios to.
4005
:param scenarios: An iterable of scenarios to apply to test.
4007
:seealso: apply_scenario
4009
for scenario in scenarios:
4010
result.addTest(apply_scenario(test, scenario))
4014
def apply_scenario(test, scenario):
4015
"""Copy test and apply scenario to it.
4017
:param test: A test to adapt.
4018
:param scenario: A tuple describing the scenarion.
4019
The first element of the tuple is the new test id.
4020
The second element is a dict containing attributes to set on the
4022
:return: The adapted test.
4024
new_id = "%s(%s)" % (test.id(), scenario[0])
4025
new_test = clone_test(test, new_id)
4026
for name, value in scenario[1].items():
4027
setattr(new_test, name, value)
4031
def clone_test(test, new_id):
4032
"""Clone a test giving it a new id.
4034
:param test: The test to clone.
4035
:param new_id: The id to assign to it.
4036
:return: The new test.
4038
new_test = copy(test)
4039
new_test.id = lambda: new_id
4043
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4045
"""Helper for permutating tests against an extension module.
4047
This is meant to be used inside a modules 'load_tests()' function. It will
4048
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4049
against both implementations. Setting 'test.module' to the appropriate
4050
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4052
:param standard_tests: A test suite to permute
4053
:param loader: A TestLoader
4054
:param py_module_name: The python path to a python module that can always
4055
be loaded, and will be considered the 'python' implementation. (eg
4056
'bzrlib._chk_map_py')
4057
:param ext_module_name: The python path to an extension module. If the
4058
module cannot be loaded, a single test will be added, which notes that
4059
the module is not available. If it can be loaded, all standard_tests
4060
will be run against that module.
4061
:return: (suite, feature) suite is a test-suite that has all the permuted
4062
tests. feature is the Feature object that can be used to determine if
4063
the module is available.
4066
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4068
('python', {'module': py_module}),
4070
suite = loader.suiteClass()
4071
feature = ModuleAvailableFeature(ext_module_name)
4072
if feature.available():
4073
scenarios.append(('C', {'module': feature.module}))
4075
# the compiled module isn't available, so we add a failing test
4076
class FailWithoutFeature(TestCase):
4077
def test_fail(self):
4078
self.requireFeature(feature)
4079
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4080
result = multiply_tests(standard_tests, scenarios, suite)
4081
return result, feature
4084
def _rmtree_temp_dir(dirname, test_id=None):
4085
# If LANG=C we probably have created some bogus paths
4086
# which rmtree(unicode) will fail to delete
4087
# so make sure we are using rmtree(str) to delete everything
4088
# except on win32, where rmtree(str) will fail
4089
# since it doesn't have the property of byte-stream paths
4090
# (they are either ascii or mbcs)
4091
if sys.platform == 'win32':
4092
# make sure we are using the unicode win32 api
4093
dirname = unicode(dirname)
4095
dirname = dirname.encode(sys.getfilesystemencoding())
4097
osutils.rmtree(dirname)
4099
# We don't want to fail here because some useful display will be lost
4100
# otherwise. Polluting the tmp dir is bad, but not giving all the
4101
# possible info to the test runner is even worse.
4103
ui.ui_factory.clear_term()
4104
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4105
sys.stderr.write('Unable to remove testing dir %s\n%s'
4106
% (os.path.basename(dirname), e))
4109
class Feature(object):
4110
"""An operating system Feature."""
4113
self._available = None
4115
def available(self):
4116
"""Is the feature available?
4118
:return: True if the feature is available.
4120
if self._available is None:
4121
self._available = self._probe()
4122
return self._available
4125
"""Implement this method in concrete features.
4127
:return: True if the feature is available.
4129
raise NotImplementedError
4132
if getattr(self, 'feature_name', None):
4133
return self.feature_name()
4134
return self.__class__.__name__
4137
class _SymlinkFeature(Feature):
4140
return osutils.has_symlinks()
4142
def feature_name(self):
4145
SymlinkFeature = _SymlinkFeature()
4148
class _HardlinkFeature(Feature):
4151
return osutils.has_hardlinks()
4153
def feature_name(self):
4156
HardlinkFeature = _HardlinkFeature()
4159
class _OsFifoFeature(Feature):
4162
return getattr(os, 'mkfifo', None)
4164
def feature_name(self):
4165
return 'filesystem fifos'
4167
OsFifoFeature = _OsFifoFeature()
4170
class _UnicodeFilenameFeature(Feature):
4171
"""Does the filesystem support Unicode filenames?"""
4175
# Check for character combinations unlikely to be covered by any
4176
# single non-unicode encoding. We use the characters
4177
# - greek small letter alpha (U+03B1) and
4178
# - braille pattern dots-123456 (U+283F).
4179
os.stat(u'\u03b1\u283f')
4180
except UnicodeEncodeError:
4182
except (IOError, OSError):
4183
# The filesystem allows the Unicode filename but the file doesn't
4187
# The filesystem allows the Unicode filename and the file exists,
4191
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4194
class _CompatabilityThunkFeature(Feature):
4195
"""This feature is just a thunk to another feature.
4197
It issues a deprecation warning if it is accessed, to let you know that you
4198
should really use a different feature.
4201
def __init__(self, dep_version, module, name,
4202
replacement_name, replacement_module=None):
4203
super(_CompatabilityThunkFeature, self).__init__()
4204
self._module = module
4205
if replacement_module is None:
4206
replacement_module = module
4207
self._replacement_module = replacement_module
4209
self._replacement_name = replacement_name
4210
self._dep_version = dep_version
4211
self._feature = None
4214
if self._feature is None:
4215
depr_msg = self._dep_version % ('%s.%s'
4216
% (self._module, self._name))
4217
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4218
self._replacement_name)
4219
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4220
# Import the new feature and use it as a replacement for the
4222
mod = __import__(self._replacement_module, {}, {},
4223
[self._replacement_name])
4224
self._feature = getattr(mod, self._replacement_name)
4228
return self._feature._probe()
4231
class ModuleAvailableFeature(Feature):
4232
"""This is a feature than describes a module we want to be available.
4234
Declare the name of the module in __init__(), and then after probing, the
4235
module will be available as 'self.module'.
4237
:ivar module: The module if it is available, else None.
4240
def __init__(self, module_name):
4241
super(ModuleAvailableFeature, self).__init__()
4242
self.module_name = module_name
4246
self._module = __import__(self.module_name, {}, {}, [''])
4253
if self.available(): # Make sure the probe has been done
4257
def feature_name(self):
4258
return self.module_name
4261
# This is kept here for compatibility, it is recommended to use
4262
# 'bzrlib.tests.feature.paramiko' instead
4263
ParamikoFeature = _CompatabilityThunkFeature(
4264
deprecated_in((2,1,0)),
4265
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4268
def probe_unicode_in_user_encoding():
4269
"""Try to encode several unicode strings to use in unicode-aware tests.
4270
Return first successfull match.
4272
:return: (unicode value, encoded plain string value) or (None, None)
4274
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4275
for uni_val in possible_vals:
4277
str_val = uni_val.encode(osutils.get_user_encoding())
4278
except UnicodeEncodeError:
4279
# Try a different character
4282
return uni_val, str_val
4286
def probe_bad_non_ascii(encoding):
4287
"""Try to find [bad] character with code [128..255]
4288
that cannot be decoded to unicode in some encoding.
4289
Return None if all non-ascii characters is valid
4292
for i in xrange(128, 256):
4295
char.decode(encoding)
4296
except UnicodeDecodeError:
4301
class _HTTPSServerFeature(Feature):
4302
"""Some tests want an https Server, check if one is available.
4304
Right now, the only way this is available is under python2.6 which provides
4315
def feature_name(self):
4316
return 'HTTPSServer'
4319
HTTPSServerFeature = _HTTPSServerFeature()
4322
class _UnicodeFilename(Feature):
4323
"""Does the filesystem support Unicode filenames?"""
4328
except UnicodeEncodeError:
4330
except (IOError, OSError):
4331
# The filesystem allows the Unicode filename but the file doesn't
4335
# The filesystem allows the Unicode filename and the file exists,
4339
UnicodeFilename = _UnicodeFilename()
4342
class _UTF8Filesystem(Feature):
4343
"""Is the filesystem UTF-8?"""
4346
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4350
UTF8Filesystem = _UTF8Filesystem()
4353
class _BreakinFeature(Feature):
4354
"""Does this platform support the breakin feature?"""
4357
from bzrlib import breakin
4358
if breakin.determine_signal() is None:
4360
if sys.platform == 'win32':
4361
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4362
# We trigger SIGBREAK via a Console api so we need ctypes to
4363
# access the function
4370
def feature_name(self):
4371
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4374
BreakinFeature = _BreakinFeature()
4377
class _CaseInsCasePresFilenameFeature(Feature):
4378
"""Is the file-system case insensitive, but case-preserving?"""
4381
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4383
# first check truly case-preserving for created files, then check
4384
# case insensitive when opening existing files.
4385
name = osutils.normpath(name)
4386
base, rel = osutils.split(name)
4387
found_rel = osutils.canonical_relpath(base, name)
4388
return (found_rel == rel
4389
and os.path.isfile(name.upper())
4390
and os.path.isfile(name.lower()))
4395
def feature_name(self):
4396
return "case-insensitive case-preserving filesystem"
4398
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4401
class _CaseInsensitiveFilesystemFeature(Feature):
4402
"""Check if underlying filesystem is case-insensitive but *not* case
4405
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4406
# more likely to be case preserving, so this case is rare.
4409
if CaseInsCasePresFilenameFeature.available():
4412
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4413
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4414
TestCaseWithMemoryTransport.TEST_ROOT = root
4416
root = TestCaseWithMemoryTransport.TEST_ROOT
4417
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4419
name_a = osutils.pathjoin(tdir, 'a')
4420
name_A = osutils.pathjoin(tdir, 'A')
4422
result = osutils.isdir(name_A)
4423
_rmtree_temp_dir(tdir)
4426
def feature_name(self):
4427
return 'case-insensitive filesystem'
4429
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4432
class _CaseSensitiveFilesystemFeature(Feature):
4435
if CaseInsCasePresFilenameFeature.available():
4437
elif CaseInsensitiveFilesystemFeature.available():
4442
def feature_name(self):
4443
return 'case-sensitive filesystem'
4445
# new coding style is for feature instances to be lowercase
4446
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4449
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4450
SubUnitFeature = _CompatabilityThunkFeature(
4451
deprecated_in((2,1,0)),
4452
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4453
# Only define SubUnitBzrRunner if subunit is available.
4455
from subunit import TestProtocolClient
4456
from subunit.test_results import AutoTimingTestResultDecorator
4457
class SubUnitBzrRunner(TextTestRunner):
4458
def run(self, test):
4459
result = AutoTimingTestResultDecorator(
4460
TestProtocolClient(self.stream))
4466
class _PosixPermissionsFeature(Feature):
4470
# create temporary file and check if specified perms are maintained.
4473
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4474
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4477
os.chmod(name, write_perms)
4479
read_perms = os.stat(name).st_mode & 0777
4481
return (write_perms == read_perms)
4483
return (os.name == 'posix') and has_perms()
4485
def feature_name(self):
4486
return 'POSIX permissions support'
4488
posix_permissions_feature = _PosixPermissionsFeature()
1789
def adapt_modules(mods_list, adapter, loader, suite):
1790
"""Adapt the modules in mods_list using adapter and add to suite."""
1791
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1792
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
