185
166
bench_history.write("--date %s %s\n" % (time.time(), revision_id))
186
167
self._bench_history = bench_history
187
self.ui = ui.ui_factory
190
self.failure_count = 0
191
self.known_failure_count = 0
193
self.not_applicable_count = 0
194
self.unsupported = {}
196
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):
169
def extractBenchmarkTime(self, testCase):
254
170
"""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)
171
self._benchmarkTime = getattr(testCase, "_benchtime", None)
259
173
def _elapsedTestTimeString(self):
260
174
"""Return a time string for the overall time the current test has taken."""
261
175
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) + "*"
177
def _testTimeString(self):
178
if self._benchmarkTime is not None:
180
self._formatTime(self._benchmarkTime),
181
self._elapsedTestTimeString())
268
return self._elapsedTestTimeString()
183
return " %s" % self._elapsedTestTimeString()
270
185
def _formatTime(self, seconds):
271
186
"""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)
187
return "%5dms" % (1000 * seconds)
276
def _shortened_test_description(self, test):
278
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
189
def _ellipsise_unimportant_words(self, a_string, final_width,
191
"""Add ellipses (sp?) for overly long strings.
193
:param keep_start: If true preserve the start of a_string rather
197
if len(a_string) > final_width:
198
result = a_string[:final_width-3] + '...'
202
if len(a_string) > final_width:
203
result = '...' + a_string[3-final_width:]
206
return result.ljust(final_width)
281
208
def startTest(self, test):
282
209
unittest.TestResult.startTest(self, test)
285
self.report_test_start(test)
286
test.number = self.count
210
# In a short description, the important words are in
211
# the beginning, but in an id, the important words are
213
SHOW_DESCRIPTIONS = False
215
if not self.showAll and self.dots and self.pb is not None:
218
final_width = osutils.terminal_width()
219
final_width = final_width - 15 - 8
221
if SHOW_DESCRIPTIONS:
222
what = test.shortDescription()
224
what = self._ellipsise_unimportant_words(what, final_width, keep_start=True)
227
if what.startswith('bzrlib.tests.'):
229
what = self._ellipsise_unimportant_words(what, final_width)
231
self.stream.write(what)
232
elif self.dots and self.pb is not None:
233
self.pb.update(what, self.testsRun - 1, None)
287
235
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
237
def _recordTestStartTime(self):
309
238
"""Record that a test has started."""
310
239
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
241
def addError(self, test, err):
320
"""Tell result that test finished with an error.
322
Called from the TestCase run() method when the test
323
fails with an unexpected error.
242
if isinstance(err[1], TestSkipped):
243
return self.addSkipped(test, err)
326
244
unittest.TestResult.addError(self, test, err)
327
self.error_count += 1
328
self.report_error(test, err)
245
test.setKeepLogfile()
246
self.extractBenchmarkTime(test)
248
self.stream.writeln("ERROR %s" % self._testTimeString())
249
elif self.dots and self.pb is None:
250
self.stream.write('E')
252
self.pb.update(self._ellipsise_unimportant_words('ERROR', 13), self.testsRun, None)
253
self.pb.note(self._ellipsise_unimportant_words(
254
test.id() + ': ERROR',
255
osutils.terminal_width()))
329
257
if self.stop_early:
331
self._cleanupLogFile(test)
333
260
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
261
unittest.TestResult.addFailure(self, test, err)
341
self.failure_count += 1
342
self.report_failure(test, err)
262
test.setKeepLogfile()
263
self.extractBenchmarkTime(test)
265
self.stream.writeln(" FAIL %s" % self._testTimeString())
266
elif self.dots and self.pb is None:
267
self.stream.write('F')
269
self.pb.update(self._ellipsise_unimportant_words('FAIL', 13), self.testsRun, None)
270
self.pb.note(self._ellipsise_unimportant_words(
271
test.id() + ': FAIL',
272
osutils.terminal_width()))
343
274
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()
277
def addSuccess(self, test):
278
self.extractBenchmarkTime(test)
352
279
if self._bench_history is not None:
353
benchmark_time = self._extractBenchmarkTime(test, details)
354
if benchmark_time is not None:
280
if self._benchmarkTime is not None:
355
281
self._bench_history.write("%s %s\n" % (
356
self._formatTime(benchmark_time),
282
self._formatTime(self._benchmarkTime),
358
self.report_success(test)
359
self._cleanupLogFile(test)
285
self.stream.writeln(' OK %s' % self._testTimeString())
286
for bench_called, stats in getattr(test, '_benchcalls', []):
287
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
288
stats.pprint(file=self.stream)
289
elif self.dots and self.pb is None:
290
self.stream.write('~')
292
self.pb.update(self._ellipsise_unimportant_words('OK', 13), self.testsRun, None)
360
294
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
401
raise errors.BzrError("Unknown whence %r" % whence)
403
def report_cleaning_up(self):
406
def startTestRun(self):
407
self.startTime = time.time()
409
def report_success(self, test):
412
def wasStrictlySuccessful(self):
413
if self.unsupported or self.known_failure_count:
415
return self.wasSuccessful()
418
class TextTestResult(ExtendedTestResult):
419
"""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")
432
self.pb = self.ui.nested_progress_bar()
433
self.pb.show_pct = False
434
self.pb.show_spinner = False
435
self.pb.show_eta = False,
436
self.pb.show_count = False
437
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()
456
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
467
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)
482
def report_test_start(self, test):
485
self._progress_prefix_text()
487
+ self._shortened_test_description(test))
489
def _test_description(self, test):
490
return self._shortened_test_description(test)
492
def report_error(self, test, err):
493
self.stream.write('ERROR: %s\n %s\n' % (
494
self._test_description(test),
498
def report_failure(self, test, err):
499
self.stream.write('FAIL: %s\n %s\n' % (
500
self._test_description(test),
504
def report_known_failure(self, test, err):
507
def report_skip(self, test, reason):
510
def report_not_applicable(self, test, reason):
513
def report_unsupported(self, test, feature):
514
"""test cannot be run because feature is missing."""
516
def report_cleaning_up(self):
517
self.pb.update('Cleaning up')
520
class VerboseTestResult(ExtendedTestResult):
521
"""Produce long output, with one line per test run plus times"""
523
def _ellipsize_to_right(self, a_string, final_width):
524
"""Truncate and pad a string, keeping the right hand side"""
525
if len(a_string) > final_width:
526
result = '...' + a_string[3-final_width:]
529
return result.ljust(final_width)
531
def startTestRun(self):
532
super(VerboseTestResult, self).startTestRun()
533
self.stream.write('running %d tests...\n' % self.num_tests)
535
def report_test_start(self, test):
537
name = self._shortened_test_description(test)
538
width = osutils.terminal_width()
539
if width is not None:
540
# width needs space for 6 char status, plus 1 for slash, plus an
541
# 11-char time string, plus a trailing blank
542
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
544
self.stream.write(self._ellipsize_to_right(name, width-18))
546
self.stream.write(name)
549
def _error_summary(self, err):
551
return '%s%s' % (indent, err[1])
553
def report_error(self, test, err):
554
self.stream.writeln('ERROR %s\n%s'
555
% (self._testTimeString(test),
556
self._error_summary(err)))
558
def report_failure(self, test, err):
559
self.stream.writeln(' FAIL %s\n%s'
560
% (self._testTimeString(test),
561
self._error_summary(err)))
563
def report_known_failure(self, test, err):
564
self.stream.writeln('XFAIL %s\n%s'
565
% (self._testTimeString(test),
566
self._error_summary(err)))
568
def report_success(self, test):
569
self.stream.writeln(' OK %s' % self._testTimeString(test))
570
for bench_called, stats in getattr(test, '_benchcalls', []):
571
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
572
stats.pprint(file=self.stream)
573
# flush the stream so that we get smooth output. This verbose mode is
574
# used to show the output in PQM.
577
def report_skip(self, test, reason):
578
self.stream.writeln(' SKIP %s\n%s'
579
% (self._testTimeString(test), reason))
581
def report_not_applicable(self, test, reason):
582
self.stream.writeln(' N/A %s\n %s'
583
% (self._testTimeString(test), reason))
585
def report_unsupported(self, test, feature):
586
"""test cannot be run because feature is missing."""
587
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
588
%(self._testTimeString(test), feature))
296
def addSkipped(self, test, skip_excinfo):
297
self.extractBenchmarkTime(test)
299
print >>self.stream, ' SKIP %s' % self._testTimeString()
300
print >>self.stream, ' %s' % skip_excinfo[1]
301
elif self.dots and self.pb is None:
302
self.stream.write('S')
304
self.pb.update(self._ellipsise_unimportant_words('SKIP', 13), self.testsRun, None)
306
# seems best to treat this as success from point-of-view of unittest
307
# -- it actually does nothing so it barely matters :)
310
except KeyboardInterrupt:
313
self.addError(test, test.__exc_info())
315
unittest.TestResult.addSuccess(self, test)
317
def printErrorList(self, flavour, errors):
318
for test, err in errors:
319
self.stream.writeln(self.separator1)
320
self.stream.writeln("%s: %s" % (flavour, self.getDescription(test)))
321
if getattr(test, '_get_log', None) is not None:
323
print >>self.stream, \
324
('vvvv[log from %s]' % test.id()).ljust(78,'-')
325
print >>self.stream, test._get_log()
326
print >>self.stream, \
327
('^^^^[log from %s]' % test.id()).ljust(78,'-')
328
self.stream.writeln(self.separator2)
329
self.stream.writeln("%s" % err)
591
332
class TextTestRunner(object):
784
474
retrieved by _get_log(). We use a real OS file, not an in-memory object,
785
475
so that it can also capture file IO. When the test completes this file
786
476
is read into memory and removed from disk.
788
478
There are also convenience functions to invoke bzr's command-line
789
479
routine, and to build and check bzr trees.
791
481
In addition to the usual method of overriding tearDown(), this class also
792
482
allows subclasses to register functions into the _cleanups list, which is
793
483
run in order as the object is torn down. It's less likely this will be
794
484
accidentally overlooked.
797
_active_threads = None
798
_leaking_threads_tests = 0
799
_first_thread_leaker_id = None
800
487
_log_file_name = None
489
_keep_log_file = False
801
490
# record lsprof data when performing benchmark calls.
802
491
_gather_lsprof_in_benchmarks = False
804
493
def __init__(self, methodName='testMethod'):
805
494
super(TestCase, self).__init__(methodName)
806
495
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)]))
498
unittest.TestCase.setUp(self)
821
499
self._cleanEnvironment()
500
bzrlib.trace.disable_default_logging()
823
501
self._startLogFile()
824
502
self._benchcalls = []
825
503
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
def _silenceUI(self):
889
"""Turn off UI for duration of test"""
890
# 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.")
1071
505
def _ndiff_strings(self, a, b):
1072
506
"""Return ndiff between two strings containing lines.
1074
508
A trailing newline is added if missing to make the strings
1075
509
print properly."""
1076
510
if b and b[-1] != '\n':
2094
1056
sys.stderr = real_stderr
2095
1057
sys.stdin = real_stdin
2097
def reduceLockdirTimeout(self):
2098
"""Reduce the default lock timeout for the duration of the test, so that
2099
if LockContention occurs during a test, it does so quickly.
2101
Tests that expect to provoke LockContention errors should call this.
2103
self.overrideAttr(bzrlib.lockdir, '_DEFAULT_TIMEOUT_SECONDS', 0)
2105
def make_utf8_encoded_stringio(self, encoding_type=None):
2106
"""Return a StringIOWrapper instance, that will encode Unicode
2109
if encoding_type is None:
2110
encoding_type = 'strict'
2112
output_encoding = 'utf-8'
2113
sio = codecs.getwriter(output_encoding)(sio, errors=encoding_type)
2114
sio.encoding = output_encoding
2117
def disable_verb(self, verb):
2118
"""Disable a smart server verb for one test."""
2119
from bzrlib.smart import request
2120
request_handlers = request.request_handlers
2121
orig_method = request_handlers.get(verb)
2122
request_handlers.remove(verb)
2123
self.addCleanup(request_handlers.register, verb, orig_method)
2126
class CapturedCall(object):
2127
"""A helper for capturing smart server calls for easy debug analysis."""
2129
def __init__(self, params, prefix_length):
2130
"""Capture the call with params and skip prefix_length stack frames."""
2133
# The last 5 frames are the __init__, the hook frame, and 3 smart
2134
# client frames. Beyond this we could get more clever, but this is good
2136
stack = traceback.extract_stack()[prefix_length:-5]
2137
self.stack = ''.join(traceback.format_list(stack))
2140
return self.call.method
2143
return self.call.method
2149
class TestCaseWithMemoryTransport(TestCase):
2150
"""Common test class for tests that do not need disk resources.
2152
Tests that need disk resources should derive from TestCaseWithTransport.
2154
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2156
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2157
a directory which does not exist. This serves to help ensure test isolation
2158
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2159
must exist. However, TestCaseWithMemoryTransport does not offer local
2160
file defaults for the transport in tests, nor does it obey the command line
2161
override, so tests that accidentally write to the common directory should
2164
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2165
a .bzr directory that stops us ascending higher into the filesystem.
1059
@symbol_versioning.deprecated_method(symbol_versioning.zero_eleven)
1060
def merge(self, branch_from, wt_to):
1061
"""A helper for tests to do a ui-less merge.
1063
This should move to the main library when someone has time to integrate
1066
# minimal ui-less merge.
1067
wt_to.branch.fetch(branch_from)
1068
base_rev = common_ancestor(branch_from.last_revision(),
1069
wt_to.branch.last_revision(),
1070
wt_to.branch.repository)
1071
merge_inner(wt_to.branch, branch_from.basis_tree(),
1072
wt_to.branch.repository.revision_tree(base_rev),
1074
wt_to.add_parent_tree_id(branch_from.last_revision())
1077
BzrTestBase = TestCase
1080
class TestCaseInTempDir(TestCase):
1081
"""Derived class that runs a test within a temporary directory.
1083
This is useful for tests that need to create a branch, etc.
1085
The directory is created in a slightly complex way: for each
1086
Python invocation, a new temporary top-level directory is created.
1087
All test cases create their own directory within that. If the
1088
tests complete successfully, the directory is removed.
1090
InTempDir is an old alias for FunctionalTestCase.
2168
1093
TEST_ROOT = None
2169
1094
_TEST_NAME = 'test'
2171
def __init__(self, methodName='runTest'):
2172
# allow test parameterization after test construction and before test
2173
# execution. Variables that the parameterizer sets need to be
2174
# ones that are not set by setUp, or setUp will trash them.
2175
super(TestCaseWithMemoryTransport, self).__init__(methodName)
2176
self.vfs_transport_factory = default_transport
2177
self.transport_server = None
1095
OVERRIDE_PYTHON = 'python'
1097
def check_file_contents(self, filename, expect):
1098
self.log("check contents of file %s" % filename)
1099
contents = file(filename, 'r').read()
1100
if contents != expect:
1101
self.log("expected: %r" % expect)
1102
self.log("actually: %r" % contents)
1103
self.fail("contents of %s not as expected" % filename)
1105
def _make_test_root(self):
1106
if TestCaseInTempDir.TEST_ROOT is not None:
1110
root = u'test%04d.tmp' % i
1114
if e.errno == errno.EEXIST:
1119
# successfully created
1120
TestCaseInTempDir.TEST_ROOT = osutils.abspath(root)
1122
# make a fake bzr directory there to prevent any tests propagating
1123
# up onto the source directory's real branch
1124
bzrdir.BzrDir.create_standalone_workingtree(TestCaseInTempDir.TEST_ROOT)
1127
super(TestCaseInTempDir, self).setUp()
1128
self._make_test_root()
1129
_currentdir = os.getcwdu()
1130
# shorten the name, to avoid test failures due to path length
1131
short_id = self.id().replace('bzrlib.tests.', '') \
1132
.replace('__main__.', '')[-100:]
1133
# it's possible the same test class is run several times for
1134
# parameterized tests, so make sure the names don't collide.
1138
candidate_dir = '%s/%s.%d' % (self.TEST_ROOT, short_id, i)
1140
candidate_dir = '%s/%s' % (self.TEST_ROOT, short_id)
1141
if os.path.exists(candidate_dir):
1145
os.mkdir(candidate_dir)
1146
self.test_home_dir = candidate_dir + '/home'
1147
os.mkdir(self.test_home_dir)
1148
self.test_dir = candidate_dir + '/work'
1149
os.mkdir(self.test_dir)
1150
os.chdir(self.test_dir)
1152
os.environ['HOME'] = self.test_home_dir
1153
os.environ['APPDATA'] = self.test_home_dir
1154
def _leaveDirectory():
1155
os.chdir(_currentdir)
1156
self.addCleanup(_leaveDirectory)
1158
def build_tree(self, shape, line_endings='native', transport=None):
1159
"""Build a test tree according to a pattern.
1161
shape is a sequence of file specifications. If the final
1162
character is '/', a directory is created.
1164
This assumes that all the elements in the tree being built are new.
1166
This doesn't add anything to a branch.
1167
:param line_endings: Either 'binary' or 'native'
1168
in binary mode, exact contents are written
1169
in native mode, the line endings match the
1170
default platform endings.
1172
:param transport: A transport to write to, for building trees on
1173
VFS's. If the transport is readonly or None,
1174
"." is opened automatically.
1176
# It's OK to just create them using forward slashes on windows.
1177
if transport is None or transport.is_readonly():
1178
transport = get_transport(".")
1180
self.assert_(isinstance(name, basestring))
1182
transport.mkdir(urlutils.escape(name[:-1]))
1184
if line_endings == 'binary':
1186
elif line_endings == 'native':
1189
raise errors.BzrError('Invalid line ending request %r' % (line_endings,))
1190
content = "contents of %s%s" % (name.encode('utf-8'), end)
1191
# Technically 'put()' is the right command. However, put
1192
# uses an AtomicFile, which requires an extra rename into place
1193
# As long as the files didn't exist in the past, append() will
1194
# do the same thing as put()
1195
# On jam's machine, make_kernel_like_tree is:
1196
# put: 4.5-7.5s (averaging 6s)
1198
# put_non_atomic: 2.9-4.5s
1199
transport.put_bytes_non_atomic(urlutils.escape(name), content)
1201
def build_tree_contents(self, shape):
1202
build_tree_contents(shape)
1204
def failUnlessExists(self, path):
1205
"""Fail unless path, which may be abs or relative, exists."""
1206
self.failUnless(osutils.lexists(path))
1208
def failIfExists(self, path):
1209
"""Fail if path, which may be abs or relative, exists."""
1210
self.failIf(osutils.lexists(path))
1212
def assertFileEqual(self, content, path):
1213
"""Fail if path does not contain 'content'."""
1214
self.failUnless(osutils.lexists(path))
1215
# TODO: jam 20060427 Shouldn't this be 'rb'?
1216
self.assertEqualDiff(content, open(path, 'r').read())
1219
class TestCaseWithTransport(TestCaseInTempDir):
1220
"""A test case that provides get_url and get_readonly_url facilities.
1222
These back onto two transport servers, one for readonly access and one for
1225
If no explicit class is provided for readonly access, a
1226
ReadonlyTransportDecorator is used instead which allows the use of non disk
1227
based read write transports.
1229
If an explicit class is provided for readonly access, that server and the
1230
readwrite one must both define get_url() as resolving to os.getcwd().
1233
def __init__(self, methodName='testMethod'):
1234
super(TestCaseWithTransport, self).__init__(methodName)
1235
self.__readonly_server = None
1236
self.__server = None
1237
self.transport_server = default_transport
2178
1238
self.transport_readonly_server = None
2179
self.__vfs_server = None
2181
def get_transport(self, relpath=None):
2182
"""Return a writeable transport.
2184
This transport is for the test scratch space relative to
2187
:param relpath: a path relative to the base url.
2189
t = get_transport(self.get_url(relpath))
2190
self.assertFalse(t.is_readonly())
2193
def get_readonly_transport(self, relpath=None):
2194
"""Return a readonly transport for the test scratch space
2196
This can be used to test that operations which should only need
2197
readonly access in fact do not try to write.
2199
:param relpath: a path relative to the base url.
2201
t = get_transport(self.get_readonly_url(relpath))
2202
self.assertTrue(t.is_readonly())
2205
def create_transport_readonly_server(self):
2206
"""Create a transport server from class defined at init.
2208
This is mostly a hook for daughter classes.
2210
return self.transport_readonly_server()
1240
def get_readonly_url(self, relpath=None):
1241
"""Get a URL for the readonly transport.
1243
This will either be backed by '.' or a decorator to the transport
1244
used by self.get_url()
1245
relpath provides for clients to get a path relative to the base url.
1246
These should only be downwards relative, not upwards.
1248
base = self.get_readonly_server().get_url()
1249
if relpath is not None:
1250
if not base.endswith('/'):
1252
base = base + relpath
2212
1255
def get_readonly_server(self):
2213
1256
"""Get the server instance for the readonly transport
2387
1332
segments = maybe_a_url.rsplit('/', 1)
2388
1333
t = get_transport(maybe_a_url)
2389
1334
if len(segments) > 1 and segments[-1] not in ('', '.'):
1337
except errors.FileExists:
2391
1339
if format is None:
2393
if isinstance(format, basestring):
2394
format = bzrdir.format_registry.make_bzrdir(format)
1340
format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
2395
1341
return format.initialize_on_transport(t)
2396
1342
except errors.UninitializableFormat:
2397
1343
raise TestSkipped("Format %s is not initializable." % format)
2399
1345
def make_repository(self, relpath, shared=False, format=None):
2400
"""Create a repository on our default transport at relpath.
2402
Note that relpath must be a relative path, not a full url.
2404
# FIXME: If you create a remoterepository this returns the underlying
2405
# real format, which is incorrect. Actually we should make sure that
2406
# RemoteBzrDir returns a RemoteRepository.
2407
# maybe mbp 20070410
1346
"""Create a repository on our default transport at relpath."""
2408
1347
made_control = self.make_bzrdir(relpath, format=format)
2409
1348
return made_control.create_repository(shared=shared)
2411
def make_smart_server(self, path):
2412
smart_server = test_server.SmartTCPServer_for_testing()
2413
self.start_server(smart_server, self.get_server())
2414
remote_transport = get_transport(smart_server.get_url()).clone(path)
2415
return remote_transport
2417
def make_branch_and_memory_tree(self, relpath, format=None):
1350
def make_branch_and_memory_tree(self, relpath):
2418
1351
"""Create a branch on the default transport and a MemoryTree for it."""
2419
b = self.make_branch(relpath, format=format)
1352
b = self.make_branch(relpath)
2420
1353
return memorytree.MemoryTree.create_on_branch(b)
2422
def make_branch_builder(self, relpath, format=None):
2423
branch = self.make_branch(relpath, format=format)
2424
return branchbuilder.BranchBuilder(branch=branch)
2426
def overrideEnvironmentForTesting(self):
2427
test_home_dir = self.test_home_dir
2428
if isinstance(test_home_dir, unicode):
2429
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2430
os.environ['HOME'] = test_home_dir
2431
os.environ['BZR_HOME'] = test_home_dir
2434
super(TestCaseWithMemoryTransport, self).setUp()
2435
self._make_test_root()
2436
self.addCleanup(os.chdir, os.getcwdu())
2437
self.makeAndChdirToTestDir()
2438
self.overrideEnvironmentForTesting()
2439
self.__readonly_server = None
2440
self.__server = None
2441
self.reduceLockdirTimeout()
2443
def setup_smart_server_with_call_log(self):
2444
"""Sets up a smart server as the transport server with a call log."""
2445
self.transport_server = test_server.SmartTCPServer_for_testing
2446
self.hpss_calls = []
2448
# Skip the current stack down to the caller of
2449
# setup_smart_server_with_call_log
2450
prefix_length = len(traceback.extract_stack()) - 2
2451
def capture_hpss_call(params):
2452
self.hpss_calls.append(
2453
CapturedCall(params, prefix_length))
2454
client._SmartClient.hooks.install_named_hook(
2455
'call', capture_hpss_call, None)
2457
def reset_smart_call_log(self):
2458
self.hpss_calls = []
2461
class TestCaseInTempDir(TestCaseWithMemoryTransport):
2462
"""Derived class that runs a test within a temporary directory.
2464
This is useful for tests that need to create a branch, etc.
2466
The directory is created in a slightly complex way: for each
2467
Python invocation, a new temporary top-level directory is created.
2468
All test cases create their own directory within that. If the
2469
tests complete successfully, the directory is removed.
2471
:ivar test_base_dir: The path of the top-level directory for this
2472
test, which contains a home directory and a work directory.
2474
:ivar test_home_dir: An initially empty directory under test_base_dir
2475
which is used as $HOME for this test.
2477
:ivar test_dir: A directory under test_base_dir used as the current
2478
directory when the test proper is run.
2481
OVERRIDE_PYTHON = 'python'
2483
def check_file_contents(self, filename, expect):
2484
self.log("check contents of file %s" % filename)
2485
contents = file(filename, 'r').read()
2486
if contents != expect:
2487
self.log("expected: %r" % expect)
2488
self.log("actually: %r" % contents)
2489
self.fail("contents of %s not as expected" % filename)
2491
def _getTestDirPrefix(self):
2492
# create a directory within the top level test directory
2493
if sys.platform in ('win32', 'cygwin'):
2494
name_prefix = re.sub('[<>*=+",:;_/\\-]', '_', self.id())
2495
# windows is likely to have path-length limits so use a short name
2496
name_prefix = name_prefix[-30:]
2498
name_prefix = re.sub('[/]', '_', self.id())
2501
def makeAndChdirToTestDir(self):
2502
"""See TestCaseWithMemoryTransport.makeAndChdirToTestDir().
2504
For TestCaseInTempDir we create a temporary directory based on the test
2505
name and then create two subdirs - test and home under it.
2507
name_prefix = osutils.pathjoin(TestCaseWithMemoryTransport.TEST_ROOT,
2508
self._getTestDirPrefix())
2510
for i in range(100):
2511
if os.path.exists(name):
2512
name = name_prefix + '_' + str(i)
2514
# now create test and home directories within this dir
2515
self.test_base_dir = name
2516
self.addCleanup(self.deleteTestDir)
2517
os.mkdir(self.test_base_dir)
2519
self.permit_dir(self.test_base_dir)
2520
# 'sprouting' and 'init' of a branch both walk up the tree to find
2521
# stacking policy to honour; create a bzr dir with an unshared
2522
# repository (but not a branch - our code would be trying to escape
2523
# then!) to stop them, and permit it to be read.
2524
# control = bzrdir.BzrDir.create(self.test_base_dir)
2525
# control.create_repository()
2526
self.test_home_dir = self.test_base_dir + '/home'
2527
os.mkdir(self.test_home_dir)
2528
self.test_dir = self.test_base_dir + '/work'
2529
os.mkdir(self.test_dir)
2530
os.chdir(self.test_dir)
2531
# put name of test inside
2532
f = file(self.test_base_dir + '/name', 'w')
2538
def deleteTestDir(self):
2539
os.chdir(TestCaseWithMemoryTransport.TEST_ROOT)
2540
_rmtree_temp_dir(self.test_base_dir, test_id=self.id())
2542
def build_tree(self, shape, line_endings='binary', transport=None):
2543
"""Build a test tree according to a pattern.
2545
shape is a sequence of file specifications. If the final
2546
character is '/', a directory is created.
2548
This assumes that all the elements in the tree being built are new.
2550
This doesn't add anything to a branch.
2552
:type shape: list or tuple.
2553
:param line_endings: Either 'binary' or 'native'
2554
in binary mode, exact contents are written in native mode, the
2555
line endings match the default platform endings.
2556
:param transport: A transport to write to, for building trees on VFS's.
2557
If the transport is readonly or None, "." is opened automatically.
2560
if type(shape) not in (list, tuple):
2561
raise AssertionError("Parameter 'shape' should be "
2562
"a list or a tuple. Got %r instead" % (shape,))
2563
# It's OK to just create them using forward slashes on windows.
2564
if transport is None or transport.is_readonly():
2565
transport = get_transport(".")
2567
self.assertIsInstance(name, basestring)
2569
transport.mkdir(urlutils.escape(name[:-1]))
2571
if line_endings == 'binary':
2573
elif line_endings == 'native':
2576
raise errors.BzrError(
2577
'Invalid line ending request %r' % line_endings)
2578
content = "contents of %s%s" % (name.encode('utf-8'), end)
2579
transport.put_bytes_non_atomic(urlutils.escape(name), content)
2581
build_tree_contents = treeshape.build_tree_contents
2583
def assertInWorkingTree(self, path, root_path='.', tree=None):
2584
"""Assert whether path or paths are in the WorkingTree"""
2586
tree = workingtree.WorkingTree.open(root_path)
2587
if not isinstance(path, basestring):
2589
self.assertInWorkingTree(p, tree=tree)
2591
self.assertIsNot(tree.path2id(path), None,
2592
path+' not in working tree.')
2594
def assertNotInWorkingTree(self, path, root_path='.', tree=None):
2595
"""Assert whether path or paths are not in the WorkingTree"""
2597
tree = workingtree.WorkingTree.open(root_path)
2598
if not isinstance(path, basestring):
2600
self.assertNotInWorkingTree(p,tree=tree)
2602
self.assertIs(tree.path2id(path), None, path+' in working tree.')
2605
class TestCaseWithTransport(TestCaseInTempDir):
2606
"""A test case that provides get_url and get_readonly_url facilities.
2608
These back onto two transport servers, one for readonly access and one for
2611
If no explicit class is provided for readonly access, a
2612
ReadonlyTransportDecorator is used instead which allows the use of non disk
2613
based read write transports.
2615
If an explicit class is provided for readonly access, that server and the
2616
readwrite one must both define get_url() as resolving to os.getcwd().
2619
def get_vfs_only_server(self):
2620
"""See TestCaseWithMemoryTransport.
2622
This is useful for some tests with specific servers that need
2625
if self.__vfs_server is None:
2626
self.__vfs_server = self.vfs_transport_factory()
2627
self.start_server(self.__vfs_server)
2628
return self.__vfs_server
2630
1355
def make_branch_and_tree(self, relpath, format=None):
2631
1356
"""Create a branch on the transport and a tree locally.
2633
1358
If the transport is not a LocalTransport, the Tree can't be created on
2634
the transport. In that case if the vfs_transport_factory is
2635
LocalURLServer the working tree is created in the local
2636
directory backing the transport, and the returned tree's branch and
2637
repository will also be accessed locally. Otherwise a lightweight
2638
checkout is created and returned.
1359
the transport. In that case the working tree is created in the local
1360
directory, and the returned tree's branch and repository will also be
2640
We do this because we can't physically create a tree in the local
2641
path, with a branch reference to the transport_factory url, and
2642
a branch + repository in the vfs_transport, unless the vfs_transport
2643
namespace is distinct from the local disk - the two branch objects
2644
would collide. While we could construct a tree with its branch object
2645
pointing at the transport_factory transport in memory, reopening it
2646
would behaving unexpectedly, and has in the past caused testing bugs
2647
when we tried to do it that way.
1363
This will fail if the original default transport for this test
1364
case wasn't backed by the working directory, as the branch won't
1365
be on disk for us to open it.
2649
1367
:param format: The BzrDirFormat.
2650
1368
:returns: the WorkingTree.
2720
1408
for readonly urls.
2722
1410
TODO RBC 20060127: make this an option to TestCaseWithTransport so it can
2723
be used without needed to redo it when a different
1411
be used without needed to redo it when a different
2724
1412
subclass is in use ?
2727
1415
def setUp(self):
2728
1416
super(ChrootedTestCase, self).setUp()
2729
if not self.vfs_transport_factory == memory.MemoryServer:
2730
self.transport_readonly_server = HttpServer
2733
def condition_id_re(pattern):
2734
"""Create a condition filter which performs a re check on a test's id.
2736
:param pattern: A regular expression string.
2737
:return: A callable that returns True if the re matches.
2739
filter_re = osutils.re_compile_checked(pattern, 0,
2741
def condition(test):
2743
return filter_re.search(test_id)
2747
def condition_isinstance(klass_or_klass_list):
2748
"""Create a condition filter which returns isinstance(param, klass).
2750
:return: A callable which when called with one parameter obj return the
2751
result of isinstance(obj, klass_or_klass_list).
2754
return isinstance(obj, klass_or_klass_list)
2758
def condition_id_in_list(id_list):
2759
"""Create a condition filter which verify that test's id in a list.
2761
:param id_list: A TestIdList object.
2762
:return: A callable that returns True if the test's id appears in the list.
2764
def condition(test):
2765
return id_list.includes(test.id())
2769
def condition_id_startswith(starts):
2770
"""Create a condition filter verifying that test's id starts with a string.
2772
:param starts: A list of string.
2773
:return: A callable that returns True if the test's id starts with one of
2776
def condition(test):
2777
for start in starts:
2778
if test.id().startswith(start):
2784
def exclude_tests_by_condition(suite, condition):
2785
"""Create a test suite which excludes some tests from suite.
2787
:param suite: The suite to get tests from.
2788
:param condition: A callable whose result evaluates True when called with a
2789
test case which should be excluded from the result.
2790
:return: A suite which contains the tests found in suite that fail
2794
for test in iter_suite_tests(suite):
2795
if not condition(test):
2797
return TestUtil.TestSuite(result)
2800
def filter_suite_by_condition(suite, condition):
2801
"""Create a test suite by filtering another one.
2803
:param suite: The source suite.
2804
:param condition: A callable whose result evaluates True when called with a
2805
test case which should be included in the result.
2806
:return: A suite which contains the tests found in suite that pass
2810
for test in iter_suite_tests(suite):
2813
return TestUtil.TestSuite(result)
1417
if not self.transport_server == bzrlib.transport.memory.MemoryServer:
1418
self.transport_readonly_server = bzrlib.transport.http.HttpServer
2816
1421
def filter_suite_by_re(suite, pattern):
2817
"""Create a test suite by filtering another one.
2819
:param suite: the source suite
2820
:param pattern: pattern that names must match
2821
:returns: the newly created suite
2823
condition = condition_id_re(pattern)
2824
result_suite = filter_suite_by_condition(suite, condition)
2828
def filter_suite_by_id_list(suite, test_id_list):
2829
"""Create a test suite by filtering another one.
2831
:param suite: The source suite.
2832
:param test_id_list: A list of the test ids to keep as strings.
2833
:returns: the newly created suite
2835
condition = condition_id_in_list(test_id_list)
2836
result_suite = filter_suite_by_condition(suite, condition)
2840
def filter_suite_by_id_startswith(suite, start):
2841
"""Create a test suite by filtering another one.
2843
:param suite: The source suite.
2844
:param start: A list of string the test id must start with one of.
2845
:returns: the newly created suite
2847
condition = condition_id_startswith(start)
2848
result_suite = filter_suite_by_condition(suite, condition)
2852
def exclude_tests_by_re(suite, pattern):
2853
"""Create a test suite which excludes some tests from suite.
2855
:param suite: The suite to get tests from.
2856
:param pattern: A regular expression string. Test ids that match this
2857
pattern will be excluded from the result.
2858
:return: A TestSuite that contains all the tests from suite without the
2859
tests that matched pattern. The order of tests is the same as it was in
2862
return exclude_tests_by_condition(suite, condition_id_re(pattern))
2865
def preserve_input(something):
2866
"""A helper for performing test suite transformation chains.
2868
:param something: Anything you want to preserve.
2874
def randomize_suite(suite):
2875
"""Return a new TestSuite with suite's tests in random order.
2877
The tests in the input suite are flattened into a single suite in order to
2878
accomplish this. Any nested TestSuites are removed to provide global
2881
tests = list(iter_suite_tests(suite))
2882
random.shuffle(tests)
2883
return TestUtil.TestSuite(tests)
2886
def split_suite_by_condition(suite, condition):
2887
"""Split a test suite into two by a condition.
2889
:param suite: The suite to split.
2890
:param condition: The condition to match on. Tests that match this
2891
condition are returned in the first test suite, ones that do not match
2892
are in the second suite.
2893
:return: A tuple of two test suites, where the first contains tests from
2894
suite matching the condition, and the second contains the remainder
2895
from suite. The order within each output suite is the same as it was in
1422
result = TestUtil.TestSuite()
1423
filter_re = re.compile(pattern)
2900
1424
for test in iter_suite_tests(suite):
2902
matched.append(test)
2904
did_not_match.append(test)
2905
return TestUtil.TestSuite(matched), TestUtil.TestSuite(did_not_match)
2908
def split_suite_by_re(suite, pattern):
2909
"""Split a test suite into two by a regular expression.
2911
:param suite: The suite to split.
2912
:param pattern: A regular expression string. Test ids that match this
2913
pattern will be in the first test suite returned, and the others in the
2914
second test suite returned.
2915
:return: A tuple of two test suites, where the first contains tests from
2916
suite matching pattern, and the second contains the remainder from
2917
suite. The order within each output suite is the same as it was in
2920
return split_suite_by_condition(suite, condition_id_re(pattern))
1425
if filter_re.search(test.id()):
1426
result.addTest(test)
2923
1430
def run_suite(suite, name='test', verbose=False, pattern=".*",
2924
stop_on_failure=False,
2925
transport=None, lsprof_timed=None, bench_history=None,
2926
matching_tests_first=None,
2929
exclude_pattern=None,
2932
suite_decorators=None,
2934
result_decorators=None,
2936
"""Run a test suite for bzr selftest.
2938
:param runner_class: The class of runner to use. Must support the
2939
constructor arguments passed by run_suite which are more than standard
2941
:return: A boolean indicating success.
1431
stop_on_failure=False, keep_output=False,
1432
transport=None, lsprof_timed=None, bench_history=None):
1433
TestCaseInTempDir._TEST_NAME = name
2943
1434
TestCase._gather_lsprof_in_benchmarks = lsprof_timed
2948
if runner_class is None:
2949
runner_class = TextTestRunner
2952
runner = runner_class(stream=stream,
1440
pb = progress.ProgressBar()
1441
runner = TextTestRunner(stream=sys.stdout,
2953
1442
descriptions=0,
2954
1443
verbosity=verbosity,
2955
bench_history=bench_history,
2957
result_decorators=result_decorators,
1444
keep_output=keep_output,
1446
bench_history=bench_history)
2959
1447
runner.stop_on_failure=stop_on_failure
2960
# built in decorator factories:
2962
random_order(random_seed, runner),
2963
exclude_tests(exclude_pattern),
2965
if matching_tests_first:
2966
decorators.append(tests_first(pattern))
2968
decorators.append(filter_tests(pattern))
2969
if suite_decorators:
2970
decorators.extend(suite_decorators)
2971
# tell the result object how many tests will be running: (except if
2972
# --parallel=fork is being used. Robert said he will provide a better
2973
# progress design later -- vila 20090817)
2974
if fork_decorator not in decorators:
2975
decorators.append(CountingDecorator)
2976
for decorator in decorators:
2977
suite = decorator(suite)
2979
# Done after test suite decoration to allow randomisation etc
2980
# to take effect, though that is of marginal benefit.
2982
stream.write("Listing tests only ...\n")
2983
for t in iter_suite_tests(suite):
2984
stream.write("%s\n" % (t.id()))
1449
suite = filter_suite_by_re(suite, pattern)
2986
1450
result = runner.run(suite)
2988
return result.wasStrictlySuccessful()
2990
return result.wasSuccessful()
2993
# A registry where get() returns a suite decorator.
2994
parallel_registry = registry.Registry()
2997
def fork_decorator(suite):
2998
concurrency = osutils.local_concurrency()
2999
if concurrency == 1:
3001
from testtools import ConcurrentTestSuite
3002
return ConcurrentTestSuite(suite, fork_for_tests)
3003
parallel_registry.register('fork', fork_decorator)
3006
def subprocess_decorator(suite):
3007
concurrency = osutils.local_concurrency()
3008
if concurrency == 1:
3010
from testtools import ConcurrentTestSuite
3011
return ConcurrentTestSuite(suite, reinvoke_for_tests)
3012
parallel_registry.register('subprocess', subprocess_decorator)
3015
def exclude_tests(exclude_pattern):
3016
"""Return a test suite decorator that excludes tests."""
3017
if exclude_pattern is None:
3018
return identity_decorator
3019
def decorator(suite):
3020
return ExcludeDecorator(suite, exclude_pattern)
3024
def filter_tests(pattern):
3026
return identity_decorator
3027
def decorator(suite):
3028
return FilterTestsDecorator(suite, pattern)
3032
def random_order(random_seed, runner):
3033
"""Return a test suite decorator factory for randomising tests order.
3035
:param random_seed: now, a string which casts to a long, or a long.
3036
:param runner: A test runner with a stream attribute to report on.
3038
if random_seed is None:
3039
return identity_decorator
3040
def decorator(suite):
3041
return RandomDecorator(suite, random_seed, runner.stream)
3045
def tests_first(pattern):
3047
return identity_decorator
3048
def decorator(suite):
3049
return TestFirstDecorator(suite, pattern)
3053
def identity_decorator(suite):
3058
class TestDecorator(TestSuite):
3059
"""A decorator for TestCase/TestSuite objects.
3061
Usually, subclasses should override __iter__(used when flattening test
3062
suites), which we do to filter, reorder, parallelise and so on, run() and
3066
def __init__(self, suite):
3067
TestSuite.__init__(self)
3070
def countTestCases(self):
3073
cases += test.countTestCases()
3080
def run(self, result):
3081
# Use iteration on self, not self._tests, to allow subclasses to hook
3084
if result.shouldStop:
3090
class CountingDecorator(TestDecorator):
3091
"""A decorator which calls result.progress(self.countTestCases)."""
3093
def run(self, result):
3094
progress_method = getattr(result, 'progress', None)
3095
if callable(progress_method):
3096
progress_method(self.countTestCases(), SUBUNIT_SEEK_SET)
3097
return super(CountingDecorator, self).run(result)
3100
class ExcludeDecorator(TestDecorator):
3101
"""A decorator which excludes test matching an exclude pattern."""
3103
def __init__(self, suite, exclude_pattern):
3104
TestDecorator.__init__(self, suite)
3105
self.exclude_pattern = exclude_pattern
3106
self.excluded = False
3110
return iter(self._tests)
3111
self.excluded = True
3112
suite = exclude_tests_by_re(self, self.exclude_pattern)
3114
self.addTests(suite)
3115
return iter(self._tests)
3118
class FilterTestsDecorator(TestDecorator):
3119
"""A decorator which filters tests to those matching a pattern."""
3121
def __init__(self, suite, pattern):
3122
TestDecorator.__init__(self, suite)
3123
self.pattern = pattern
3124
self.filtered = False
3128
return iter(self._tests)
3129
self.filtered = True
3130
suite = filter_suite_by_re(self, self.pattern)
3132
self.addTests(suite)
3133
return iter(self._tests)
3136
class RandomDecorator(TestDecorator):
3137
"""A decorator which randomises the order of its tests."""
3139
def __init__(self, suite, random_seed, stream):
3140
TestDecorator.__init__(self, suite)
3141
self.random_seed = random_seed
3142
self.randomised = False
3143
self.stream = stream
3147
return iter(self._tests)
3148
self.randomised = True
3149
self.stream.write("Randomizing test order using seed %s\n\n" %
3150
(self.actual_seed()))
3151
# Initialise the random number generator.
3152
random.seed(self.actual_seed())
3153
suite = randomize_suite(self)
3155
self.addTests(suite)
3156
return iter(self._tests)
3158
def actual_seed(self):
3159
if self.random_seed == "now":
3160
# We convert the seed to a long to make it reuseable across
3161
# invocations (because the user can reenter it).
3162
self.random_seed = long(time.time())
3164
# Convert the seed to a long if we can
3166
self.random_seed = long(self.random_seed)
3169
return self.random_seed
3172
class TestFirstDecorator(TestDecorator):
3173
"""A decorator which moves named tests to the front."""
3175
def __init__(self, suite, pattern):
3176
TestDecorator.__init__(self, suite)
3177
self.pattern = pattern
3178
self.filtered = False
3182
return iter(self._tests)
3183
self.filtered = True
3184
suites = split_suite_by_re(self, self.pattern)
3186
self.addTests(suites)
3187
return iter(self._tests)
3190
def partition_tests(suite, count):
3191
"""Partition suite into count lists of tests."""
3193
tests = list(iter_suite_tests(suite))
3194
tests_per_process = int(math.ceil(float(len(tests)) / count))
3195
for block in range(count):
3196
low_test = block * tests_per_process
3197
high_test = low_test + tests_per_process
3198
process_tests = tests[low_test:high_test]
3199
result.append(process_tests)
3203
def workaround_zealous_crypto_random():
3204
"""Crypto.Random want to help us being secure, but we don't care here.
3206
This workaround some test failure related to the sftp server. Once paramiko
3207
stop using the controversial API in Crypto.Random, we may get rid of it.
3210
from Crypto.Random import atfork
3216
def fork_for_tests(suite):
3217
"""Take suite and start up one runner per CPU by forking()
3219
:return: An iterable of TestCase-like objects which can each have
3220
run(result) called on them to feed tests to result.
3222
concurrency = osutils.local_concurrency()
3224
from subunit import TestProtocolClient, ProtocolTestCase
3225
from subunit.test_results import AutoTimingTestResultDecorator
3226
class TestInOtherProcess(ProtocolTestCase):
3227
# Should be in subunit, I think. RBC.
3228
def __init__(self, stream, pid):
3229
ProtocolTestCase.__init__(self, stream)
3232
def run(self, result):
3234
ProtocolTestCase.run(self, result)
3236
os.waitpid(self.pid, 0)
3238
test_blocks = partition_tests(suite, concurrency)
3239
for process_tests in test_blocks:
3240
process_suite = TestSuite()
3241
process_suite.addTests(process_tests)
3242
c2pread, c2pwrite = os.pipe()
3245
workaround_zealous_crypto_random()
3248
# Leave stderr and stdout open so we can see test noise
3249
# Close stdin so that the child goes away if it decides to
3250
# read from stdin (otherwise its a roulette to see what
3251
# child actually gets keystrokes for pdb etc).
3254
stream = os.fdopen(c2pwrite, 'wb', 1)
3255
subunit_result = AutoTimingTestResultDecorator(
3256
TestProtocolClient(stream))
3257
process_suite.run(subunit_result)
3262
stream = os.fdopen(c2pread, 'rb', 1)
3263
test = TestInOtherProcess(stream, pid)
3268
def reinvoke_for_tests(suite):
3269
"""Take suite and start up one runner per CPU using subprocess().
3271
:return: An iterable of TestCase-like objects which can each have
3272
run(result) called on them to feed tests to result.
3274
concurrency = osutils.local_concurrency()
3276
from subunit import ProtocolTestCase
3277
class TestInSubprocess(ProtocolTestCase):
3278
def __init__(self, process, name):
3279
ProtocolTestCase.__init__(self, process.stdout)
3280
self.process = process
3281
self.process.stdin.close()
3284
def run(self, result):
3286
ProtocolTestCase.run(self, result)
3289
os.unlink(self.name)
3290
# print "pid %d finished" % finished_process
3291
test_blocks = partition_tests(suite, concurrency)
3292
for process_tests in test_blocks:
3293
# ugly; currently reimplement rather than reuses TestCase methods.
3294
bzr_path = os.path.dirname(os.path.dirname(bzrlib.__file__))+'/bzr'
3295
if not os.path.isfile(bzr_path):
3296
# We are probably installed. Assume sys.argv is the right file
3297
bzr_path = sys.argv[0]
3298
bzr_path = [bzr_path]
3299
if sys.platform == "win32":
3300
# if we're on windows, we can't execute the bzr script directly
3301
bzr_path = [sys.executable] + bzr_path
3302
fd, test_list_file_name = tempfile.mkstemp()
3303
test_list_file = os.fdopen(fd, 'wb', 1)
3304
for test in process_tests:
3305
test_list_file.write(test.id() + '\n')
3306
test_list_file.close()
3308
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3310
if '--no-plugins' in sys.argv:
3311
argv.append('--no-plugins')
3312
# stderr=STDOUT would be ideal, but until we prevent noise on
3313
# stderr it can interrupt the subunit protocol.
3314
process = Popen(argv, stdin=PIPE, stdout=PIPE, stderr=PIPE,
3316
test = TestInSubprocess(process, test_list_file_name)
3319
os.unlink(test_list_file_name)
3324
class ForwardingResult(unittest.TestResult):
3326
def __init__(self, target):
3327
unittest.TestResult.__init__(self)
3328
self.result = target
3330
def startTest(self, test):
3331
self.result.startTest(test)
3333
def stopTest(self, test):
3334
self.result.stopTest(test)
3336
def startTestRun(self):
3337
self.result.startTestRun()
3339
def stopTestRun(self):
3340
self.result.stopTestRun()
3342
def addSkip(self, test, reason):
3343
self.result.addSkip(test, reason)
3345
def addSuccess(self, test):
3346
self.result.addSuccess(test)
3348
def addError(self, test, err):
3349
self.result.addError(test, err)
3351
def addFailure(self, test, err):
3352
self.result.addFailure(test, err)
3353
ForwardingResult = testtools.ExtendedToOriginalDecorator
3356
class ProfileResult(ForwardingResult):
3357
"""Generate profiling data for all activity between start and success.
3359
The profile data is appended to the test's _benchcalls attribute and can
3360
be accessed by the forwarded-to TestResult.
3362
While it might be cleaner do accumulate this in stopTest, addSuccess is
3363
where our existing output support for lsprof is, and this class aims to
3364
fit in with that: while it could be moved it's not necessary to accomplish
3365
test profiling, nor would it be dramatically cleaner.
3368
def startTest(self, test):
3369
self.profiler = bzrlib.lsprof.BzrProfiler()
3370
self.profiler.start()
3371
ForwardingResult.startTest(self, test)
3373
def addSuccess(self, test):
3374
stats = self.profiler.stop()
3376
calls = test._benchcalls
3377
except AttributeError:
3378
test._benchcalls = []
3379
calls = test._benchcalls
3380
calls.append(((test.id(), "", ""), stats))
3381
ForwardingResult.addSuccess(self, test)
3383
def stopTest(self, test):
3384
ForwardingResult.stopTest(self, test)
3385
self.profiler = None
3388
# Controlled by "bzr selftest -E=..." option
3389
# Currently supported:
3390
# -Eallow_debug Will no longer clear debug.debug_flags() so it
3391
# preserves any flags supplied at the command line.
3392
# -Edisable_lock_checks Turns errors in mismatched locks into simple prints
3393
# rather than failing tests. And no longer raise
3394
# LockContention when fctnl locks are not being used
3395
# with proper exclusion rules.
3396
selftest_debug_flags = set()
1451
return result.wasSuccessful()
3399
1454
def selftest(verbose=False, pattern=".*", stop_on_failure=True,
3400
1456
transport=None,
3401
1457
test_suite_factory=None,
3402
1458
lsprof_timed=None,
3404
matching_tests_first=None,
3407
exclude_pattern=None,
3413
suite_decorators=None,
1459
bench_history=None):
3417
1460
"""Run the whole test suite under the enhanced runner"""
3418
1461
# XXX: Very ugly way to do this...
3419
1462
# Disable warning about old formats because we don't want it to disturb
3426
1469
transport = default_transport
3427
1470
old_transport = default_transport
3428
1471
default_transport = transport
3429
global selftest_debug_flags
3430
old_debug_flags = selftest_debug_flags
3431
if debug_flags is not None:
3432
selftest_debug_flags = set(debug_flags)
3434
if load_list is None:
3437
keep_only = load_test_id_list(load_list)
3439
starting_with = [test_prefix_alias_registry.resolve_alias(start)
3440
for start in starting_with]
3441
1473
if test_suite_factory is None:
3442
# Reduce loading time by loading modules based on the starting_with
3444
suite = test_suite(keep_only, starting_with)
1474
suite = test_suite()
3446
1476
suite = test_suite_factory()
3448
# But always filter as requested.
3449
suite = filter_suite_by_id_startswith(suite, starting_with)
3450
result_decorators = []
3452
result_decorators.append(ProfileResult)
3453
1477
return run_suite(suite, 'testbzr', verbose=verbose, pattern=pattern,
3454
stop_on_failure=stop_on_failure,
1478
stop_on_failure=stop_on_failure, keep_output=keep_output,
3455
1479
transport=transport,
3456
1480
lsprof_timed=lsprof_timed,
3457
bench_history=bench_history,
3458
matching_tests_first=matching_tests_first,
3459
list_only=list_only,
3460
random_seed=random_seed,
3461
exclude_pattern=exclude_pattern,
3463
runner_class=runner_class,
3464
suite_decorators=suite_decorators,
3466
result_decorators=result_decorators,
1481
bench_history=bench_history)
3469
1483
default_transport = old_transport
3470
selftest_debug_flags = old_debug_flags
3473
def load_test_id_list(file_name):
3474
"""Load a test id list from a text file.
3476
The format is one test id by line. No special care is taken to impose
3477
strict rules, these test ids are used to filter the test suite so a test id
3478
that do not match an existing test will do no harm. This allows user to add
3479
comments, leave blank lines, etc.
3483
ftest = open(file_name, 'rt')
3485
if e.errno != errno.ENOENT:
3488
raise errors.NoSuchFile(file_name)
3490
for test_name in ftest.readlines():
3491
test_list.append(test_name.strip())
3496
def suite_matches_id_list(test_suite, id_list):
3497
"""Warns about tests not appearing or appearing more than once.
3499
:param test_suite: A TestSuite object.
3500
:param test_id_list: The list of test ids that should be found in
3503
:return: (absents, duplicates) absents is a list containing the test found
3504
in id_list but not in test_suite, duplicates is a list containing the
3505
test found multiple times in test_suite.
3507
When using a prefined test id list, it may occurs that some tests do not
3508
exist anymore or that some tests use the same id. This function warns the
3509
tester about potential problems in his workflow (test lists are volatile)
3510
or in the test suite itself (using the same id for several tests does not
3511
help to localize defects).
3513
# Build a dict counting id occurrences
3515
for test in iter_suite_tests(test_suite):
3517
tests[id] = tests.get(id, 0) + 1
3522
occurs = tests.get(id, 0)
3524
not_found.append(id)
3526
duplicates.append(id)
3528
return not_found, duplicates
3531
class TestIdList(object):
3532
"""Test id list to filter a test suite.
3534
Relying on the assumption that test ids are built as:
3535
<module>[.<class>.<method>][(<param>+)], <module> being in python dotted
3536
notation, this class offers methods to :
3537
- avoid building a test suite for modules not refered to in the test list,
3538
- keep only the tests listed from the module test suite.
3541
def __init__(self, test_id_list):
3542
# When a test suite needs to be filtered against us we compare test ids
3543
# for equality, so a simple dict offers a quick and simple solution.
3544
self.tests = dict().fromkeys(test_id_list, True)
3546
# While unittest.TestCase have ids like:
3547
# <module>.<class>.<method>[(<param+)],
3548
# doctest.DocTestCase can have ids like:
3551
# <module>.<function>
3552
# <module>.<class>.<method>
3554
# Since we can't predict a test class from its name only, we settle on
3555
# a simple constraint: a test id always begins with its module name.
3558
for test_id in test_id_list:
3559
parts = test_id.split('.')
3560
mod_name = parts.pop(0)
3561
modules[mod_name] = True
3563
mod_name += '.' + part
3564
modules[mod_name] = True
3565
self.modules = modules
3567
def refers_to(self, module_name):
3568
"""Is there tests for the module or one of its sub modules."""
3569
return self.modules.has_key(module_name)
3571
def includes(self, test_id):
3572
return self.tests.has_key(test_id)
3575
class TestPrefixAliasRegistry(registry.Registry):
3576
"""A registry for test prefix aliases.
3578
This helps implement shorcuts for the --starting-with selftest
3579
option. Overriding existing prefixes is not allowed but not fatal (a
3580
warning will be emitted).
3583
def register(self, key, obj, help=None, info=None,
3584
override_existing=False):
3585
"""See Registry.register.
3587
Trying to override an existing alias causes a warning to be emitted,
3588
not a fatal execption.
3591
super(TestPrefixAliasRegistry, self).register(
3592
key, obj, help=help, info=info, override_existing=False)
3594
actual = self.get(key)
3595
note('Test prefix alias %s is already used for %s, ignoring %s'
3596
% (key, actual, obj))
3598
def resolve_alias(self, id_start):
3599
"""Replace the alias by the prefix in the given string.
3601
Using an unknown prefix is an error to help catching typos.
3603
parts = id_start.split('.')
3605
parts[0] = self.get(parts[0])
3607
raise errors.BzrCommandError(
3608
'%s is not a known test prefix alias' % parts[0])
3609
return '.'.join(parts)
3612
test_prefix_alias_registry = TestPrefixAliasRegistry()
3613
"""Registry of test prefix aliases."""
3616
# This alias allows to detect typos ('bzrlin.') by making all valid test ids
3617
# appear prefixed ('bzrlib.' is "replaced" by 'bzrlib.').
3618
test_prefix_alias_registry.register('bzrlib', 'bzrlib')
3620
# Obvious highest levels prefixes, feel free to add your own via a plugin
3621
test_prefix_alias_registry.register('bd', 'bzrlib.doc')
3622
test_prefix_alias_registry.register('bu', 'bzrlib.utils')
3623
test_prefix_alias_registry.register('bt', 'bzrlib.tests')
3624
test_prefix_alias_registry.register('bb', 'bzrlib.tests.blackbox')
3625
test_prefix_alias_registry.register('bp', 'bzrlib.plugins')
3628
def _test_suite_testmod_names():
3629
"""Return the standard list of test module names to test."""
3632
'bzrlib.tests.blackbox',
3633
'bzrlib.tests.commands',
3634
'bzrlib.tests.per_branch',
3635
'bzrlib.tests.per_bzrdir',
3636
'bzrlib.tests.per_bzrdir_colo',
3637
'bzrlib.tests.per_foreign_vcs',
3638
'bzrlib.tests.per_interrepository',
3639
'bzrlib.tests.per_intertree',
3640
'bzrlib.tests.per_inventory',
3641
'bzrlib.tests.per_interbranch',
3642
'bzrlib.tests.per_lock',
3643
'bzrlib.tests.per_merger',
3644
'bzrlib.tests.per_transport',
3645
'bzrlib.tests.per_tree',
3646
'bzrlib.tests.per_pack_repository',
3647
'bzrlib.tests.per_repository',
3648
'bzrlib.tests.per_repository_chk',
3649
'bzrlib.tests.per_repository_reference',
3650
'bzrlib.tests.per_uifactory',
3651
'bzrlib.tests.per_versionedfile',
3652
'bzrlib.tests.per_workingtree',
3653
'bzrlib.tests.test__annotator',
3654
'bzrlib.tests.test__bencode',
3655
'bzrlib.tests.test__chk_map',
3656
'bzrlib.tests.test__dirstate_helpers',
3657
'bzrlib.tests.test__groupcompress',
3658
'bzrlib.tests.test__known_graph',
3659
'bzrlib.tests.test__rio',
3660
'bzrlib.tests.test__simple_set',
3661
'bzrlib.tests.test__static_tuple',
3662
'bzrlib.tests.test__walkdirs_win32',
3663
'bzrlib.tests.test_ancestry',
3664
'bzrlib.tests.test_annotate',
3665
'bzrlib.tests.test_api',
3666
'bzrlib.tests.test_atomicfile',
3667
'bzrlib.tests.test_bad_files',
3668
'bzrlib.tests.test_bisect_multi',
3669
'bzrlib.tests.test_branch',
3670
'bzrlib.tests.test_branchbuilder',
3671
'bzrlib.tests.test_btree_index',
3672
'bzrlib.tests.test_bugtracker',
3673
'bzrlib.tests.test_bundle',
3674
'bzrlib.tests.test_bzrdir',
3675
'bzrlib.tests.test__chunks_to_lines',
3676
'bzrlib.tests.test_cache_utf8',
3677
'bzrlib.tests.test_chk_map',
3678
'bzrlib.tests.test_chk_serializer',
3679
'bzrlib.tests.test_chunk_writer',
3680
'bzrlib.tests.test_clean_tree',
3681
'bzrlib.tests.test_cleanup',
3682
'bzrlib.tests.test_cmdline',
3683
'bzrlib.tests.test_commands',
3684
'bzrlib.tests.test_commit',
3685
'bzrlib.tests.test_commit_merge',
3686
'bzrlib.tests.test_config',
3687
'bzrlib.tests.test_conflicts',
3688
'bzrlib.tests.test_counted_lock',
3689
'bzrlib.tests.test_crash',
3690
'bzrlib.tests.test_decorators',
3691
'bzrlib.tests.test_delta',
3692
'bzrlib.tests.test_debug',
3693
'bzrlib.tests.test_deprecated_graph',
3694
'bzrlib.tests.test_diff',
3695
'bzrlib.tests.test_directory_service',
3696
'bzrlib.tests.test_dirstate',
3697
'bzrlib.tests.test_email_message',
3698
'bzrlib.tests.test_eol_filters',
3699
'bzrlib.tests.test_errors',
3700
'bzrlib.tests.test_export',
3701
'bzrlib.tests.test_extract',
3702
'bzrlib.tests.test_fetch',
3703
'bzrlib.tests.test_fifo_cache',
3704
'bzrlib.tests.test_filters',
3705
'bzrlib.tests.test_ftp_transport',
3706
'bzrlib.tests.test_foreign',
3707
'bzrlib.tests.test_generate_docs',
3708
'bzrlib.tests.test_generate_ids',
3709
'bzrlib.tests.test_globbing',
3710
'bzrlib.tests.test_gpg',
3711
'bzrlib.tests.test_graph',
3712
'bzrlib.tests.test_groupcompress',
3713
'bzrlib.tests.test_hashcache',
3714
'bzrlib.tests.test_help',
3715
'bzrlib.tests.test_hooks',
3716
'bzrlib.tests.test_http',
3717
'bzrlib.tests.test_http_response',
3718
'bzrlib.tests.test_https_ca_bundle',
3719
'bzrlib.tests.test_identitymap',
3720
'bzrlib.tests.test_ignores',
3721
'bzrlib.tests.test_index',
3722
'bzrlib.tests.test_import_tariff',
3723
'bzrlib.tests.test_info',
3724
'bzrlib.tests.test_inv',
3725
'bzrlib.tests.test_inventory_delta',
3726
'bzrlib.tests.test_knit',
3727
'bzrlib.tests.test_lazy_import',
3728
'bzrlib.tests.test_lazy_regex',
3729
'bzrlib.tests.test_lock',
3730
'bzrlib.tests.test_lockable_files',
3731
'bzrlib.tests.test_lockdir',
3732
'bzrlib.tests.test_log',
3733
'bzrlib.tests.test_lru_cache',
3734
'bzrlib.tests.test_lsprof',
3735
'bzrlib.tests.test_mail_client',
3736
'bzrlib.tests.test_memorytree',
3737
'bzrlib.tests.test_merge',
3738
'bzrlib.tests.test_merge3',
3739
'bzrlib.tests.test_merge_core',
3740
'bzrlib.tests.test_merge_directive',
3741
'bzrlib.tests.test_missing',
3742
'bzrlib.tests.test_msgeditor',
3743
'bzrlib.tests.test_multiparent',
3744
'bzrlib.tests.test_mutabletree',
3745
'bzrlib.tests.test_nonascii',
3746
'bzrlib.tests.test_options',
3747
'bzrlib.tests.test_osutils',
3748
'bzrlib.tests.test_osutils_encodings',
3749
'bzrlib.tests.test_pack',
3750
'bzrlib.tests.test_patch',
3751
'bzrlib.tests.test_patches',
3752
'bzrlib.tests.test_permissions',
3753
'bzrlib.tests.test_plugins',
3754
'bzrlib.tests.test_progress',
3755
'bzrlib.tests.test_read_bundle',
3756
'bzrlib.tests.test_reconcile',
3757
'bzrlib.tests.test_reconfigure',
3758
'bzrlib.tests.test_registry',
3759
'bzrlib.tests.test_remote',
3760
'bzrlib.tests.test_rename_map',
3761
'bzrlib.tests.test_repository',
3762
'bzrlib.tests.test_revert',
3763
'bzrlib.tests.test_revision',
3764
'bzrlib.tests.test_revisionspec',
3765
'bzrlib.tests.test_revisiontree',
3766
'bzrlib.tests.test_rio',
3767
'bzrlib.tests.test_rules',
3768
'bzrlib.tests.test_sampler',
3769
'bzrlib.tests.test_script',
3770
'bzrlib.tests.test_selftest',
3771
'bzrlib.tests.test_serializer',
3772
'bzrlib.tests.test_setup',
3773
'bzrlib.tests.test_sftp_transport',
3774
'bzrlib.tests.test_shelf',
3775
'bzrlib.tests.test_shelf_ui',
3776
'bzrlib.tests.test_smart',
3777
'bzrlib.tests.test_smart_add',
3778
'bzrlib.tests.test_smart_request',
3779
'bzrlib.tests.test_smart_transport',
3780
'bzrlib.tests.test_smtp_connection',
3781
'bzrlib.tests.test_source',
3782
'bzrlib.tests.test_ssh_transport',
3783
'bzrlib.tests.test_status',
3784
'bzrlib.tests.test_store',
3785
'bzrlib.tests.test_strace',
3786
'bzrlib.tests.test_subsume',
3787
'bzrlib.tests.test_switch',
3788
'bzrlib.tests.test_symbol_versioning',
3789
'bzrlib.tests.test_tag',
3790
'bzrlib.tests.test_testament',
3791
'bzrlib.tests.test_textfile',
3792
'bzrlib.tests.test_textmerge',
3793
'bzrlib.tests.test_timestamp',
3794
'bzrlib.tests.test_trace',
3795
'bzrlib.tests.test_transactions',
3796
'bzrlib.tests.test_transform',
3797
'bzrlib.tests.test_transport',
3798
'bzrlib.tests.test_transport_log',
3799
'bzrlib.tests.test_tree',
3800
'bzrlib.tests.test_treebuilder',
3801
'bzrlib.tests.test_tsort',
3802
'bzrlib.tests.test_tuned_gzip',
3803
'bzrlib.tests.test_ui',
3804
'bzrlib.tests.test_uncommit',
3805
'bzrlib.tests.test_upgrade',
3806
'bzrlib.tests.test_upgrade_stacked',
3807
'bzrlib.tests.test_urlutils',
3808
'bzrlib.tests.test_version',
3809
'bzrlib.tests.test_version_info',
3810
'bzrlib.tests.test_weave',
3811
'bzrlib.tests.test_whitebox',
3812
'bzrlib.tests.test_win32utils',
3813
'bzrlib.tests.test_workingtree',
3814
'bzrlib.tests.test_workingtree_4',
3815
'bzrlib.tests.test_wsgi',
3816
'bzrlib.tests.test_xml',
3820
def _test_suite_modules_to_doctest():
3821
"""Return the list of modules to doctest."""
3823
# GZ 2009-03-31: No docstrings with -OO so there's nothing to doctest
3827
'bzrlib.branchbuilder',
3828
'bzrlib.decorators',
3831
'bzrlib.iterablefile',
3835
'bzrlib.symbol_versioning',
3838
'bzrlib.version_info_formats.format_custom',
3842
def test_suite(keep_only=None, starting_with=None):
3843
1487
"""Build and return TestSuite for the whole of bzrlib.
3845
:param keep_only: A list of test ids limiting the suite returned.
3847
:param starting_with: An id limiting the suite returned to the tests
3850
1489
This function can be replaced if you need to change the default test
3851
1490
suite on a global basis, but it is not encouraged.
1493
'bzrlib.tests.test_ancestry',
1494
'bzrlib.tests.test_api',
1495
'bzrlib.tests.test_atomicfile',
1496
'bzrlib.tests.test_bad_files',
1497
'bzrlib.tests.test_branch',
1498
'bzrlib.tests.test_bundle',
1499
'bzrlib.tests.test_bzrdir',
1500
'bzrlib.tests.test_cache_utf8',
1501
'bzrlib.tests.test_command',
1502
'bzrlib.tests.test_commit',
1503
'bzrlib.tests.test_commit_merge',
1504
'bzrlib.tests.test_config',
1505
'bzrlib.tests.test_conflicts',
1506
'bzrlib.tests.test_decorators',
1507
'bzrlib.tests.test_diff',
1508
'bzrlib.tests.test_doc_generate',
1509
'bzrlib.tests.test_errors',
1510
'bzrlib.tests.test_escaped_store',
1511
'bzrlib.tests.test_fetch',
1512
'bzrlib.tests.test_ftp_transport',
1513
'bzrlib.tests.test_gpg',
1514
'bzrlib.tests.test_graph',
1515
'bzrlib.tests.test_hashcache',
1516
'bzrlib.tests.test_http',
1517
'bzrlib.tests.test_http_response',
1518
'bzrlib.tests.test_identitymap',
1519
'bzrlib.tests.test_ignores',
1520
'bzrlib.tests.test_inv',
1521
'bzrlib.tests.test_knit',
1522
'bzrlib.tests.test_lazy_import',
1523
'bzrlib.tests.test_lockdir',
1524
'bzrlib.tests.test_lockable_files',
1525
'bzrlib.tests.test_log',
1526
'bzrlib.tests.test_memorytree',
1527
'bzrlib.tests.test_merge',
1528
'bzrlib.tests.test_merge3',
1529
'bzrlib.tests.test_merge_core',
1530
'bzrlib.tests.test_missing',
1531
'bzrlib.tests.test_msgeditor',
1532
'bzrlib.tests.test_nonascii',
1533
'bzrlib.tests.test_options',
1534
'bzrlib.tests.test_osutils',
1535
'bzrlib.tests.test_patch',
1536
'bzrlib.tests.test_patches',
1537
'bzrlib.tests.test_permissions',
1538
'bzrlib.tests.test_plugins',
1539
'bzrlib.tests.test_progress',
1540
'bzrlib.tests.test_reconcile',
1541
'bzrlib.tests.test_repository',
1542
'bzrlib.tests.test_revert',
1543
'bzrlib.tests.test_revision',
1544
'bzrlib.tests.test_revisionnamespaces',
1545
'bzrlib.tests.test_revisiontree',
1546
'bzrlib.tests.test_rio',
1547
'bzrlib.tests.test_sampler',
1548
'bzrlib.tests.test_selftest',
1549
'bzrlib.tests.test_setup',
1550
'bzrlib.tests.test_sftp_transport',
1551
'bzrlib.tests.test_smart_add',
1552
'bzrlib.tests.test_smart_transport',
1553
'bzrlib.tests.test_source',
1554
'bzrlib.tests.test_status',
1555
'bzrlib.tests.test_store',
1556
'bzrlib.tests.test_symbol_versioning',
1557
'bzrlib.tests.test_testament',
1558
'bzrlib.tests.test_textfile',
1559
'bzrlib.tests.test_textmerge',
1560
'bzrlib.tests.test_trace',
1561
'bzrlib.tests.test_transactions',
1562
'bzrlib.tests.test_transform',
1563
'bzrlib.tests.test_transport',
1564
'bzrlib.tests.test_tree',
1565
'bzrlib.tests.test_treebuilder',
1566
'bzrlib.tests.test_tsort',
1567
'bzrlib.tests.test_tuned_gzip',
1568
'bzrlib.tests.test_ui',
1569
'bzrlib.tests.test_upgrade',
1570
'bzrlib.tests.test_urlutils',
1571
'bzrlib.tests.test_versionedfile',
1572
'bzrlib.tests.test_version',
1573
'bzrlib.tests.test_version_info',
1574
'bzrlib.tests.test_weave',
1575
'bzrlib.tests.test_whitebox',
1576
'bzrlib.tests.test_workingtree',
1577
'bzrlib.tests.test_xml',
1579
test_transport_implementations = [
1580
'bzrlib.tests.test_transport_implementations',
1581
'bzrlib.tests.test_read_bundle',
1583
suite = TestUtil.TestSuite()
3854
1584
loader = TestUtil.TestLoader()
3856
if keep_only is not None:
3857
id_filter = TestIdList(keep_only)
3859
# We take precedence over keep_only because *at loading time* using
3860
# both options means we will load less tests for the same final result.
3861
def interesting_module(name):
3862
for start in starting_with:
3864
# Either the module name starts with the specified string
3865
name.startswith(start)
3866
# or it may contain tests starting with the specified string
3867
or start.startswith(name)
3871
loader = TestUtil.FilteredByModuleTestLoader(interesting_module)
3873
elif keep_only is not None:
3874
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3875
def interesting_module(name):
3876
return id_filter.refers_to(name)
3879
loader = TestUtil.TestLoader()
3880
def interesting_module(name):
3881
# No filtering, all modules are interesting
3884
suite = loader.suiteClass()
3886
# modules building their suite with loadTestsFromModuleNames
3887
suite.addTest(loader.loadTestsFromModuleNames(_test_suite_testmod_names()))
3889
for mod in _test_suite_modules_to_doctest():
3890
if not interesting_module(mod):
3891
# No tests to keep here, move along
3894
# note that this really does mean "report only" -- doctest
3895
# still runs the rest of the examples
3896
doc_suite = doctest.DocTestSuite(mod,
3897
optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)
3898
except ValueError, e:
3899
print '**failed to get doctest for: %s\n%s' % (mod, e)
3901
if len(doc_suite._tests) == 0:
3902
raise errors.BzrError("no doctests found in %s" % (mod,))
3903
suite.addTest(doc_suite)
3905
default_encoding = sys.getdefaultencoding()
3906
for name, plugin in bzrlib.plugin.plugins().items():
3907
if not interesting_module(plugin.module.__name__):
3909
plugin_suite = plugin.test_suite()
3910
# We used to catch ImportError here and turn it into just a warning,
3911
# but really if you don't have --no-plugins this should be a failure.
3912
# mbp 20080213 - see http://bugs.launchpad.net/bugs/189771
3913
if plugin_suite is None:
3914
plugin_suite = plugin.load_plugin_tests(loader)
3915
if plugin_suite is not None:
3916
suite.addTest(plugin_suite)
3917
if default_encoding != sys.getdefaultencoding():
3918
bzrlib.trace.warning(
3919
'Plugin "%s" tried to reset default encoding to: %s', name,
3920
sys.getdefaultencoding())
3922
sys.setdefaultencoding(default_encoding)
3924
if keep_only is not None:
3925
# Now that the referred modules have loaded their tests, keep only the
3927
suite = filter_suite_by_id_list(suite, id_filter)
3928
# Do some sanity checks on the id_list filtering
3929
not_found, duplicates = suite_matches_id_list(suite, keep_only)
3931
# The tester has used both keep_only and starting_with, so he is
3932
# already aware that some tests are excluded from the list, there
3933
# is no need to tell him which.
3936
# Some tests mentioned in the list are not in the test suite. The
3937
# list may be out of date, report to the tester.
3938
for id in not_found:
3939
bzrlib.trace.warning('"%s" not found in the test suite', id)
3940
for id in duplicates:
3941
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
1585
suite.addTest(loader.loadTestsFromModuleNames(testmod_names))
1586
from bzrlib.transport import TransportTestProviderAdapter
1587
adapter = TransportTestProviderAdapter()
1588
adapt_modules(test_transport_implementations, adapter, loader, suite)
1589
for package in packages_to_test():
1590
suite.addTest(package.test_suite())
1591
for m in MODULES_TO_TEST:
1592
suite.addTest(loader.loadTestsFromModule(m))
1593
for m in MODULES_TO_DOCTEST:
1594
suite.addTest(doctest.DocTestSuite(m))
1595
for name, plugin in bzrlib.plugin.all_plugins().items():
1596
if getattr(plugin, 'test_suite', None) is not None:
1597
suite.addTest(plugin.test_suite())
3946
def multiply_scenarios(scenarios_left, scenarios_right):
3947
"""Multiply two sets of scenarios.
3949
:returns: the cartesian product of the two sets of scenarios, that is
3950
a scenario for every possible combination of a left scenario and a
3954
('%s,%s' % (left_name, right_name),
3955
dict(left_dict.items() + right_dict.items()))
3956
for left_name, left_dict in scenarios_left
3957
for right_name, right_dict in scenarios_right]
3960
def multiply_tests(tests, scenarios, result):
3961
"""Multiply tests_list by scenarios into result.
3963
This is the core workhorse for test parameterisation.
3965
Typically the load_tests() method for a per-implementation test suite will
3966
call multiply_tests and return the result.
3968
:param tests: The tests to parameterise.
3969
:param scenarios: The scenarios to apply: pairs of (scenario_name,
3970
scenario_param_dict).
3971
:param result: A TestSuite to add created tests to.
3973
This returns the passed in result TestSuite with the cross product of all
3974
the tests repeated once for each scenario. Each test is adapted by adding
3975
the scenario name at the end of its id(), and updating the test object's
3976
__dict__ with the scenario_param_dict.
3978
>>> import bzrlib.tests.test_sampler
3979
>>> r = multiply_tests(
3980
... bzrlib.tests.test_sampler.DemoTest('test_nothing'),
3981
... [('one', dict(param=1)),
3982
... ('two', dict(param=2))],
3984
>>> tests = list(iter_suite_tests(r))
3988
'bzrlib.tests.test_sampler.DemoTest.test_nothing(one)'
3994
for test in iter_suite_tests(tests):
3995
apply_scenarios(test, scenarios, result)
3999
def apply_scenarios(test, scenarios, result):
4000
"""Apply the scenarios in scenarios to test and add to result.
4002
:param test: The test to apply scenarios to.
4003
:param scenarios: An iterable of scenarios to apply to test.
4005
:seealso: apply_scenario
4007
for scenario in scenarios:
4008
result.addTest(apply_scenario(test, scenario))
4012
def apply_scenario(test, scenario):
4013
"""Copy test and apply scenario to it.
4015
:param test: A test to adapt.
4016
:param scenario: A tuple describing the scenarion.
4017
The first element of the tuple is the new test id.
4018
The second element is a dict containing attributes to set on the
4020
:return: The adapted test.
4022
new_id = "%s(%s)" % (test.id(), scenario[0])
4023
new_test = clone_test(test, new_id)
4024
for name, value in scenario[1].items():
4025
setattr(new_test, name, value)
4029
def clone_test(test, new_id):
4030
"""Clone a test giving it a new id.
4032
:param test: The test to clone.
4033
:param new_id: The id to assign to it.
4034
:return: The new test.
4036
new_test = copy(test)
4037
new_test.id = lambda: new_id
4041
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4043
"""Helper for permutating tests against an extension module.
4045
This is meant to be used inside a modules 'load_tests()' function. It will
4046
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4047
against both implementations. Setting 'test.module' to the appropriate
4048
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4050
:param standard_tests: A test suite to permute
4051
:param loader: A TestLoader
4052
:param py_module_name: The python path to a python module that can always
4053
be loaded, and will be considered the 'python' implementation. (eg
4054
'bzrlib._chk_map_py')
4055
:param ext_module_name: The python path to an extension module. If the
4056
module cannot be loaded, a single test will be added, which notes that
4057
the module is not available. If it can be loaded, all standard_tests
4058
will be run against that module.
4059
:return: (suite, feature) suite is a test-suite that has all the permuted
4060
tests. feature is the Feature object that can be used to determine if
4061
the module is available.
4064
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4066
('python', {'module': py_module}),
4068
suite = loader.suiteClass()
4069
feature = ModuleAvailableFeature(ext_module_name)
4070
if feature.available():
4071
scenarios.append(('C', {'module': feature.module}))
4073
# the compiled module isn't available, so we add a failing test
4074
class FailWithoutFeature(TestCase):
4075
def test_fail(self):
4076
self.requireFeature(feature)
4077
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4078
result = multiply_tests(standard_tests, scenarios, suite)
4079
return result, feature
4082
def _rmtree_temp_dir(dirname, test_id=None):
4083
# If LANG=C we probably have created some bogus paths
4084
# which rmtree(unicode) will fail to delete
4085
# so make sure we are using rmtree(str) to delete everything
4086
# except on win32, where rmtree(str) will fail
4087
# since it doesn't have the property of byte-stream paths
4088
# (they are either ascii or mbcs)
4089
if sys.platform == 'win32':
4090
# make sure we are using the unicode win32 api
4091
dirname = unicode(dirname)
4093
dirname = dirname.encode(sys.getfilesystemencoding())
4095
osutils.rmtree(dirname)
4097
# We don't want to fail here because some useful display will be lost
4098
# otherwise. Polluting the tmp dir is bad, but not giving all the
4099
# possible info to the test runner is even worse.
4101
ui.ui_factory.clear_term()
4102
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4103
sys.stderr.write('Unable to remove testing dir %s\n%s'
4104
% (os.path.basename(dirname), e))
4107
class Feature(object):
4108
"""An operating system Feature."""
4111
self._available = None
4113
def available(self):
4114
"""Is the feature available?
4116
:return: True if the feature is available.
4118
if self._available is None:
4119
self._available = self._probe()
4120
return self._available
4123
"""Implement this method in concrete features.
4125
:return: True if the feature is available.
4127
raise NotImplementedError
4130
if getattr(self, 'feature_name', None):
4131
return self.feature_name()
4132
return self.__class__.__name__
4135
class _SymlinkFeature(Feature):
4138
return osutils.has_symlinks()
4140
def feature_name(self):
4143
SymlinkFeature = _SymlinkFeature()
4146
class _HardlinkFeature(Feature):
4149
return osutils.has_hardlinks()
4151
def feature_name(self):
4154
HardlinkFeature = _HardlinkFeature()
4157
class _OsFifoFeature(Feature):
4160
return getattr(os, 'mkfifo', None)
4162
def feature_name(self):
4163
return 'filesystem fifos'
4165
OsFifoFeature = _OsFifoFeature()
4168
class _UnicodeFilenameFeature(Feature):
4169
"""Does the filesystem support Unicode filenames?"""
4173
# Check for character combinations unlikely to be covered by any
4174
# single non-unicode encoding. We use the characters
4175
# - greek small letter alpha (U+03B1) and
4176
# - braille pattern dots-123456 (U+283F).
4177
os.stat(u'\u03b1\u283f')
4178
except UnicodeEncodeError:
4180
except (IOError, OSError):
4181
# The filesystem allows the Unicode filename but the file doesn't
4185
# The filesystem allows the Unicode filename and the file exists,
4189
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4192
class _CompatabilityThunkFeature(Feature):
4193
"""This feature is just a thunk to another feature.
4195
It issues a deprecation warning if it is accessed, to let you know that you
4196
should really use a different feature.
4199
def __init__(self, dep_version, module, name,
4200
replacement_name, replacement_module=None):
4201
super(_CompatabilityThunkFeature, self).__init__()
4202
self._module = module
4203
if replacement_module is None:
4204
replacement_module = module
4205
self._replacement_module = replacement_module
4207
self._replacement_name = replacement_name
4208
self._dep_version = dep_version
4209
self._feature = None
4212
if self._feature is None:
4213
depr_msg = self._dep_version % ('%s.%s'
4214
% (self._module, self._name))
4215
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4216
self._replacement_name)
4217
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4218
# Import the new feature and use it as a replacement for the
4220
mod = __import__(self._replacement_module, {}, {},
4221
[self._replacement_name])
4222
self._feature = getattr(mod, self._replacement_name)
4226
return self._feature._probe()
4229
class ModuleAvailableFeature(Feature):
4230
"""This is a feature than describes a module we want to be available.
4232
Declare the name of the module in __init__(), and then after probing, the
4233
module will be available as 'self.module'.
4235
:ivar module: The module if it is available, else None.
4238
def __init__(self, module_name):
4239
super(ModuleAvailableFeature, self).__init__()
4240
self.module_name = module_name
4244
self._module = __import__(self.module_name, {}, {}, [''])
4251
if self.available(): # Make sure the probe has been done
4255
def feature_name(self):
4256
return self.module_name
4259
# This is kept here for compatibility, it is recommended to use
4260
# 'bzrlib.tests.feature.paramiko' instead
4261
ParamikoFeature = _CompatabilityThunkFeature(
4262
deprecated_in((2,1,0)),
4263
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4266
def probe_unicode_in_user_encoding():
4267
"""Try to encode several unicode strings to use in unicode-aware tests.
4268
Return first successfull match.
4270
:return: (unicode value, encoded plain string value) or (None, None)
4272
possible_vals = [u'm\xb5', u'\xe1', u'\u0410']
4273
for uni_val in possible_vals:
4275
str_val = uni_val.encode(osutils.get_user_encoding())
4276
except UnicodeEncodeError:
4277
# Try a different character
4280
return uni_val, str_val
4284
def probe_bad_non_ascii(encoding):
4285
"""Try to find [bad] character with code [128..255]
4286
that cannot be decoded to unicode in some encoding.
4287
Return None if all non-ascii characters is valid
4290
for i in xrange(128, 256):
4293
char.decode(encoding)
4294
except UnicodeDecodeError:
4299
class _HTTPSServerFeature(Feature):
4300
"""Some tests want an https Server, check if one is available.
4302
Right now, the only way this is available is under python2.6 which provides
4313
def feature_name(self):
4314
return 'HTTPSServer'
4317
HTTPSServerFeature = _HTTPSServerFeature()
4320
class _UnicodeFilename(Feature):
4321
"""Does the filesystem support Unicode filenames?"""
4326
except UnicodeEncodeError:
4328
except (IOError, OSError):
4329
# The filesystem allows the Unicode filename but the file doesn't
4333
# The filesystem allows the Unicode filename and the file exists,
4337
UnicodeFilename = _UnicodeFilename()
4340
class _UTF8Filesystem(Feature):
4341
"""Is the filesystem UTF-8?"""
4344
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4348
UTF8Filesystem = _UTF8Filesystem()
4351
class _BreakinFeature(Feature):
4352
"""Does this platform support the breakin feature?"""
4355
from bzrlib import breakin
4356
if breakin.determine_signal() is None:
4358
if sys.platform == 'win32':
4359
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4360
# We trigger SIGBREAK via a Console api so we need ctypes to
4361
# access the function
4368
def feature_name(self):
4369
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4372
BreakinFeature = _BreakinFeature()
4375
class _CaseInsCasePresFilenameFeature(Feature):
4376
"""Is the file-system case insensitive, but case-preserving?"""
4379
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4381
# first check truly case-preserving for created files, then check
4382
# case insensitive when opening existing files.
4383
name = osutils.normpath(name)
4384
base, rel = osutils.split(name)
4385
found_rel = osutils.canonical_relpath(base, name)
4386
return (found_rel == rel
4387
and os.path.isfile(name.upper())
4388
and os.path.isfile(name.lower()))
4393
def feature_name(self):
4394
return "case-insensitive case-preserving filesystem"
4396
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4399
class _CaseInsensitiveFilesystemFeature(Feature):
4400
"""Check if underlying filesystem is case-insensitive but *not* case
4403
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4404
# more likely to be case preserving, so this case is rare.
4407
if CaseInsCasePresFilenameFeature.available():
4410
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4411
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4412
TestCaseWithMemoryTransport.TEST_ROOT = root
4414
root = TestCaseWithMemoryTransport.TEST_ROOT
4415
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4417
name_a = osutils.pathjoin(tdir, 'a')
4418
name_A = osutils.pathjoin(tdir, 'A')
4420
result = osutils.isdir(name_A)
4421
_rmtree_temp_dir(tdir)
4424
def feature_name(self):
4425
return 'case-insensitive filesystem'
4427
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4430
class _CaseSensitiveFilesystemFeature(Feature):
4433
if CaseInsCasePresFilenameFeature.available():
4435
elif CaseInsensitiveFilesystemFeature.available():
4440
def feature_name(self):
4441
return 'case-sensitive filesystem'
4443
# new coding style is for feature instances to be lowercase
4444
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4447
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4448
SubUnitFeature = _CompatabilityThunkFeature(
4449
deprecated_in((2,1,0)),
4450
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4451
# Only define SubUnitBzrRunner if subunit is available.
4453
from subunit import TestProtocolClient
4454
from subunit.test_results import AutoTimingTestResultDecorator
4455
class SubUnitBzrRunner(TextTestRunner):
4456
def run(self, test):
4457
result = AutoTimingTestResultDecorator(
4458
TestProtocolClient(self.stream))
4464
class _PosixPermissionsFeature(Feature):
4468
# create temporary file and check if specified perms are maintained.
4471
write_perms = stat.S_IRUSR | stat.S_IWUSR | stat.S_IXUSR
4472
f = tempfile.mkstemp(prefix='bzr_perms_chk_')
4475
os.chmod(name, write_perms)
4477
read_perms = os.stat(name).st_mode & 0777
4479
return (write_perms == read_perms)
4481
return (os.name == 'posix') and has_perms()
4483
def feature_name(self):
4484
return 'POSIX permissions support'
4486
posix_permissions_feature = _PosixPermissionsFeature()
1601
def adapt_modules(mods_list, adapter, loader, suite):
1602
"""Adapt the modules in mods_list using adapter and add to suite."""
1603
for test in iter_suite_tests(loader.loadTestsFromModuleNames(mods_list)):
1604
suite.addTests(adapter.adapt(test))
added
removed
bzrlib/tests/__init__.py
