55
50
# nb: check this before importing anything else from within it
56
51
_testtools_version = getattr(testtools, '__version__', ())
57
if _testtools_version < (0, 9, 2):
58
raise ImportError("need at least testtools 0.9.2: %s is %r"
52
if _testtools_version < (0, 9, 5):
53
raise ImportError("need at least testtools 0.9.5: %s is %r"
59
54
% (testtools.__file__, _testtools_version))
60
55
from testtools import content
62
58
from bzrlib import (
62
commands as _mod_commands,
72
plugin as _mod_plugin,
79
transport as _mod_transport,
80
import bzrlib.commands
81
import bzrlib.timestamp
83
import bzrlib.inventory
84
import bzrlib.iterablefile
87
83
import bzrlib.lsprof
88
84
except ImportError:
89
85
# lsprof not available
91
from bzrlib.merge import merge_inner
94
from bzrlib.smart import client, request, server
96
from bzrlib import symbol_versioning
87
from bzrlib.smart import client, request
88
from bzrlib.transport import (
97
92
from bzrlib.symbol_versioning import (
99
93
deprecated_function,
105
from bzrlib.transport import (
110
import bzrlib.transport
111
from bzrlib.trace import mutter, note
112
96
from bzrlib.tests import (
117
from bzrlib.tests.http_server import HttpServer
118
from bzrlib.tests.TestUtil import (
122
101
from bzrlib.ui import NullProgressView
123
102
from bzrlib.ui.text import TextUIFactory
124
import bzrlib.version_info_formats.format_custom
125
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
127
104
# Mark this python module as being part of the implementation
128
105
# of unittest: this gives us better tracebacks where the last
140
117
SUBUNIT_SEEK_SET = 0
141
118
SUBUNIT_SEEK_CUR = 1
144
class ExtendedTestResult(unittest._TextTestResult):
120
# These are intentionally brought into this namespace. That way plugins, etc
121
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
122
TestSuite = TestUtil.TestSuite
123
TestLoader = TestUtil.TestLoader
125
# Tests should run in a clean and clearly defined environment. The goal is to
126
# keep them isolated from the running environment as mush as possible. The test
127
# framework ensures the variables defined below are set (or deleted if the
128
# value is None) before a test is run and reset to their original value after
129
# the test is run. Generally if some code depends on an environment variable,
130
# the tests should start without this variable in the environment. There are a
131
# few exceptions but you shouldn't violate this rule lightly.
135
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
136
# tests do check our impls match APPDATA
137
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
141
'BZREMAIL': None, # may still be present in the environment
142
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
143
'BZR_PROGRESS_BAR': None,
144
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
145
# as a base class instead of TestCaseInTempDir. Tests inheriting from
146
# TestCase should not use disk resources, BZR_LOG is one.
147
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
148
'BZR_PLUGIN_PATH': None,
149
'BZR_DISABLE_PLUGINS': None,
150
'BZR_PLUGINS_AT': None,
151
'BZR_CONCURRENCY': None,
152
# Make sure that any text ui tests are consistent regardless of
153
# the environment the test case is run in; you may want tests that
154
# test other combinations. 'dumb' is a reasonable guess for tests
155
# going to a pipe or a StringIO.
161
'SSH_AUTH_SOCK': None,
171
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
172
# least. If you do (care), please update this comment
176
'BZR_REMOTE_PATH': None,
177
# Generally speaking, we don't want apport reporting on crashes in
178
# the test envirnoment unless we're specifically testing apport,
179
# so that it doesn't leak into the real system environment. We
180
# use an env var so it propagates to subprocesses.
181
'APPORT_DISABLE': '1',
185
def override_os_environ(test, env=None):
186
"""Modify os.environ keeping a copy.
188
:param test: A test instance
190
:param env: A dict containing variable definitions to be installed
193
env = isolated_environ
194
test._original_os_environ = dict([(var, value)
195
for var, value in os.environ.iteritems()])
196
for var, value in env.iteritems():
197
osutils.set_or_unset_env(var, value)
198
if var not in test._original_os_environ:
199
# The var is new, add it with a value of None, so
200
# restore_os_environ will delete it
201
test._original_os_environ[var] = None
204
def restore_os_environ(test):
205
"""Restore os.environ to its original state.
207
:param test: A test instance previously passed to override_os_environ.
209
for var, value in test._original_os_environ.iteritems():
210
# Restore the original value (or delete it if the value has been set to
211
# None in override_os_environ).
212
osutils.set_or_unset_env(var, value)
215
def _clear__type_equality_funcs(test):
216
"""Cleanup bound methods stored on TestCase instances
218
Clear the dict breaking a few (mostly) harmless cycles in the affected
219
unittests released with Python 2.6 and initial Python 2.7 versions.
221
For a few revisions between Python 2.7.1 and Python 2.7.2 that annoyingly
222
shipped in Oneiric, an object with no clear method was used, hence the
223
extra complications, see bug 809048 for details.
225
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
226
if type_equality_funcs is not None:
227
tef_clear = getattr(type_equality_funcs, "clear", None)
228
if tef_clear is None:
229
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
230
if tef_instance_dict is not None:
231
tef_clear = tef_instance_dict.clear
232
if tef_clear is not None:
236
class ExtendedTestResult(testtools.TextTestResult):
145
237
"""Accepts, reports and accumulates the results of running tests.
147
239
Compared to the unittest version this class adds support for
196
288
self._overall_start_time = time.time()
197
289
self._strict = strict
290
self._first_thread_leaker_id = None
291
self._tests_leaking_threads_count = 0
292
self._traceback_from_test = None
199
294
def stopTestRun(self):
200
295
run = self.testsRun
201
296
actionTaken = "Ran"
202
297
stopTime = time.time()
203
298
timeTaken = stopTime - self.startTime
205
self.stream.writeln(self.separator2)
206
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
299
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
300
# the parent class method is similar have to duplicate
301
self._show_list('ERROR', self.errors)
302
self._show_list('FAIL', self.failures)
303
self.stream.write(self.sep2)
304
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
207
305
run, run != 1 and "s" or "", timeTaken))
208
self.stream.writeln()
209
306
if not self.wasSuccessful():
210
307
self.stream.write("FAILED (")
211
308
failed, errored = map(len, (self.failures, self.errors))
218
315
if failed or errored: self.stream.write(", ")
219
316
self.stream.write("known_failure_count=%d" %
220
317
self.known_failure_count)
221
self.stream.writeln(")")
318
self.stream.write(")\n")
223
320
if self.known_failure_count:
224
self.stream.writeln("OK (known_failures=%d)" %
321
self.stream.write("OK (known_failures=%d)\n" %
225
322
self.known_failure_count)
227
self.stream.writeln("OK")
324
self.stream.write("OK\n")
228
325
if self.skip_count > 0:
229
326
skipped = self.skip_count
230
self.stream.writeln('%d test%s skipped' %
327
self.stream.write('%d test%s skipped\n' %
231
328
(skipped, skipped != 1 and "s" or ""))
232
329
if self.unsupported:
233
330
for feature, count in sorted(self.unsupported.items()):
234
self.stream.writeln("Missing feature '%s' skipped %d tests." %
331
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
235
332
(feature, count))
237
334
ok = self.wasStrictlySuccessful()
239
336
ok = self.wasSuccessful()
240
if TestCase._first_thread_leaker_id:
337
if self._first_thread_leaker_id:
241
338
self.stream.write(
242
339
'%s is leaking threads among %d leaking tests.\n' % (
243
TestCase._first_thread_leaker_id,
244
TestCase._leaking_threads_tests))
340
self._first_thread_leaker_id,
341
self._tests_leaking_threads_count))
245
342
# We don't report the main thread as an active one.
246
343
self.stream.write(
247
344
'%d non-main threads were left active in the end.\n'
248
% (TestCase._active_threads - 1))
345
% (len(self._active_threads) - 1))
250
347
def getDescription(self, test):
276
374
def _shortened_test_description(self, test):
278
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
376
what = re.sub(r'^bzrlib\.tests\.', '', what)
379
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
380
# multiple times in a row, because the handler is added for
381
# each test but the container list is shared between cases.
382
# See lp:498869 lp:625574 and lp:637725 for background.
383
def _record_traceback_from_test(self, exc_info):
384
"""Store the traceback from passed exc_info tuple till"""
385
self._traceback_from_test = exc_info[2]
281
387
def startTest(self, test):
282
unittest.TestResult.startTest(self, test)
388
super(ExtendedTestResult, self).startTest(test)
283
389
if self.count == 0:
284
390
self.startTests()
285
392
self.report_test_start(test)
286
393
test.number = self.count
287
394
self._recordTestStartTime()
395
# Make testtools cases give us the real traceback on failure
396
addOnException = getattr(test, "addOnException", None)
397
if addOnException is not None:
398
addOnException(self._record_traceback_from_test)
399
# Only check for thread leaks on bzrlib derived test cases
400
if isinstance(test, TestCase):
401
test.addCleanup(self._check_leaked_threads, test)
403
def stopTest(self, test):
404
super(ExtendedTestResult, self).stopTest(test)
405
# Manually break cycles, means touching various private things but hey
406
getDetails = getattr(test, "getDetails", None)
407
if getDetails is not None:
409
_clear__type_equality_funcs(test)
410
self._traceback_from_test = None
289
412
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')
413
self.report_tests_starting()
414
self._active_threads = threading.enumerate()
416
def _check_leaked_threads(self, test):
417
"""See if any threads have leaked since last call
419
A sample of live threads is stored in the _active_threads attribute,
420
when this method runs it compares the current live threads and any not
421
in the previous sample are treated as having leaked.
423
now_active_threads = set(threading.enumerate())
424
threads_leaked = now_active_threads.difference(self._active_threads)
426
self._report_thread_leak(test, threads_leaked, now_active_threads)
427
self._tests_leaking_threads_count += 1
428
if self._first_thread_leaker_id is None:
429
self._first_thread_leaker_id = test.id()
430
self._active_threads = now_active_threads
308
432
def _recordTestStartTime(self):
309
433
"""Record that a test has started."""
310
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:
434
self._start_datetime = self._now()
319
436
def addError(self, test, err):
320
437
"""Tell result that test finished with an error.
356
471
self._formatTime(benchmark_time),
358
473
self.report_success(test)
359
self._cleanupLogFile(test)
360
unittest.TestResult.addSuccess(self, test)
474
super(ExtendedTestResult, self).addSuccess(test)
361
475
test._log_contents = ''
363
477
def addExpectedFailure(self, test, err):
364
478
self.known_failure_count += 1
365
479
self.report_known_failure(test, err)
481
def addUnexpectedSuccess(self, test, details=None):
482
"""Tell result the test unexpectedly passed, counting as a failure
484
When the minimum version of testtools required becomes 0.9.8 this
485
can be updated to use the new handling there.
487
super(ExtendedTestResult, self).addFailure(test, details=details)
488
self.failure_count += 1
489
self.report_unexpected_success(test,
490
"".join(details["reason"].iter_text()))
367
494
def addNotSupported(self, test, feature):
368
495
"""The test will not be run because of a missing feature.
401
533
raise errors.BzrError("Unknown whence %r" % whence)
403
def report_cleaning_up(self):
535
def report_tests_starting(self):
536
"""Display information before the test run begins"""
537
if getattr(sys, 'frozen', None) is None:
538
bzr_path = osutils.realpath(sys.argv[0])
540
bzr_path = sys.executable
542
'bzr selftest: %s\n' % (bzr_path,))
545
bzrlib.__path__[0],))
547
' bzr-%s python-%s %s\n' % (
548
bzrlib.version_string,
549
bzrlib._format_version_tuple(sys.version_info),
550
platform.platform(aliased=1),
552
self.stream.write('\n')
554
def report_test_start(self, test):
555
"""Display information on the test just about to be run"""
557
def _report_thread_leak(self, test, leaked_threads, active_threads):
558
"""Display information on a test that leaked one or more threads"""
559
# GZ 2010-09-09: A leak summary reported separately from the general
560
# thread debugging would be nice. Tests under subunit
561
# need something not using stream, perhaps adding a
562
# testtools details object would be fitting.
563
if 'threads' in selftest_debug_flags:
564
self.stream.write('%s is leaking, active is now %d\n' %
565
(test.id(), len(active_threads)))
406
567
def startTestRun(self):
407
568
self.startTime = time.time()
551
709
return '%s%s' % (indent, err[1])
553
711
def report_error(self, test, err):
554
self.stream.writeln('ERROR %s\n%s'
712
self.stream.write('ERROR %s\n%s\n'
555
713
% (self._testTimeString(test),
556
714
self._error_summary(err)))
558
716
def report_failure(self, test, err):
559
self.stream.writeln(' FAIL %s\n%s'
717
self.stream.write(' FAIL %s\n%s\n'
560
718
% (self._testTimeString(test),
561
719
self._error_summary(err)))
563
721
def report_known_failure(self, test, err):
564
self.stream.writeln('XFAIL %s\n%s'
722
self.stream.write('XFAIL %s\n%s\n'
565
723
% (self._testTimeString(test),
566
724
self._error_summary(err)))
726
def report_unexpected_success(self, test, reason):
727
self.stream.write(' FAIL %s\n%s: %s\n'
728
% (self._testTimeString(test),
729
"Unexpected success. Should have failed",
568
732
def report_success(self, test):
569
self.stream.writeln(' OK %s' % self._testTimeString(test))
733
self.stream.write(' OK %s\n' % self._testTimeString(test))
570
734
for bench_called, stats in getattr(test, '_benchcalls', []):
571
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
735
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
572
736
stats.pprint(file=self.stream)
573
737
# flush the stream so that we get smooth output. This verbose mode is
574
738
# used to show the output in PQM.
575
739
self.stream.flush()
577
741
def report_skip(self, test, reason):
578
self.stream.writeln(' SKIP %s\n%s'
742
self.stream.write(' SKIP %s\n%s\n'
579
743
% (self._testTimeString(test), reason))
581
745
def report_not_applicable(self, test, reason):
582
self.stream.writeln(' N/A %s\n %s'
746
self.stream.write(' N/A %s\n %s\n'
583
747
% (self._testTimeString(test), reason))
585
749
def report_unsupported(self, test, feature):
586
750
"""test cannot be run because feature is missing."""
587
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
751
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
588
752
%(self._testTimeString(test), feature))
789
975
routine, and to build and check bzr trees.
791
977
In addition to the usual method of overriding tearDown(), this class also
792
allows subclasses to register functions into the _cleanups list, which is
978
allows subclasses to register cleanup functions via addCleanup, which are
793
979
run in order as the object is torn down. It's less likely this will be
794
980
accidentally overlooked.
797
_active_threads = None
798
_leaking_threads_tests = 0
799
_first_thread_leaker_id = None
800
_log_file_name = None
801
984
# record lsprof data when performing benchmark calls.
802
985
_gather_lsprof_in_benchmarks = False
804
987
def __init__(self, methodName='testMethod'):
805
988
super(TestCase, self).__init__(methodName)
807
989
self._directory_isolation = True
808
990
self.exception_handlers.insert(0,
809
991
(UnavailableFeature, self._do_unsupported_or_skip))
827
1008
self._track_transports()
828
1009
self._track_locks()
829
1010
self._clear_debug_flags()
830
TestCase._active_threads = threading.activeCount()
831
self.addCleanup(self._check_leaked_threads)
1011
# Isolate global verbosity level, to make sure it's reproducible
1012
# between tests. We should get rid of this altogether: bug 656694. --
1014
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
1015
# Isolate config option expansion until its default value for bzrlib is
1016
# settled on or a the FIXME associated with _get_expand_default_value
1017
# is addressed -- vila 20110219
1018
self.overrideAttr(config, '_expand_default_value', None)
1019
self._log_files = set()
1020
# Each key in the ``_counters`` dict holds a value for a different
1021
# counter. When the test ends, addDetail() should be used to output the
1022
# counter values. This happens in install_counter_hook().
1024
if 'config_stats' in selftest_debug_flags:
1025
self._install_config_stats_hooks()
1026
# Do not use i18n for tests (unless the test reverses this)
833
1029
def debug(self):
834
1030
# debug a frame up.
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()
1032
# The sys preserved stdin/stdout should allow blackbox tests debugging
1033
pdb.Pdb(stdin=sys.__stdin__, stdout=sys.__stdout__
1034
).set_trace(sys._getframe().f_back)
1036
def discardDetail(self, name):
1037
"""Extend the addDetail, getDetails api so we can remove a detail.
1039
eg. bzr always adds the 'log' detail at startup, but we don't want to
1040
include it for skipped, xfail, etc tests.
1042
It is safe to call this for a detail that doesn't exist, in case this
1043
gets called multiple times.
1045
# We cheat. details is stored in __details which means we shouldn't
1046
# touch it. but getDetails() returns the dict directly, so we can
1048
details = self.getDetails()
1052
def install_counter_hook(self, hooks, name, counter_name=None):
1053
"""Install a counting hook.
1055
Any hook can be counted as long as it doesn't need to return a value.
1057
:param hooks: Where the hook should be installed.
1059
:param name: The hook name that will be counted.
1061
:param counter_name: The counter identifier in ``_counters``, defaults
1064
_counters = self._counters # Avoid closing over self
1065
if counter_name is None:
1067
if _counters.has_key(counter_name):
1068
raise AssertionError('%s is already used as a counter name'
1070
_counters[counter_name] = 0
1071
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1072
lambda: ['%d' % (_counters[counter_name],)]))
1073
def increment_counter(*args, **kwargs):
1074
_counters[counter_name] += 1
1075
label = 'count %s calls' % (counter_name,)
1076
hooks.install_named_hook(name, increment_counter, label)
1077
self.addCleanup(hooks.uninstall_named_hook, name, label)
1079
def _install_config_stats_hooks(self):
1080
"""Install config hooks to count hook calls.
1083
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1084
self.install_counter_hook(config.ConfigHooks, hook_name,
1085
'config.%s' % (hook_name,))
1087
# The OldConfigHooks are private and need special handling to protect
1088
# against recursive tests (tests that run other tests), so we just do
1089
# manually what registering them into _builtin_known_hooks will provide
1091
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1092
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1093
self.install_counter_hook(config.OldConfigHooks, hook_name,
1094
'old_config.%s' % (hook_name,))
853
1096
def _clear_debug_flags(self):
854
1097
"""Prevent externally set debug flags affecting tests.
866
1109
def _clear_hooks(self):
867
1110
# prevent hooks affecting tests
1111
known_hooks = hooks.known_hooks
868
1112
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)
1113
for key, (parent, name) in known_hooks.iter_parent_objects():
1114
current_hooks = getattr(parent, name)
872
1115
self._preserved_hooks[parent] = (name, current_hooks)
1116
self._preserved_lazy_hooks = hooks._lazy_hooks
1117
hooks._lazy_hooks = {}
873
1118
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)
1119
for key, (parent, name) in known_hooks.iter_parent_objects():
1120
factory = known_hooks.get(key)
876
1121
setattr(parent, name, factory())
877
1122
# this hook should always be installed
878
1123
request._install_hook()
1135
1384
'st_mtime did not match')
1136
1385
self.assertEqual(expected.st_ctime, actual.st_ctime,
1137
1386
'st_ctime did not match')
1138
if sys.platform != 'win32':
1387
if sys.platform == 'win32':
1139
1388
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1140
1389
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1141
# odd. Regardless we shouldn't actually try to assert anything
1142
# about their values
1390
# odd. We just force it to always be 0 to avoid any problems.
1391
self.assertEqual(0, expected.st_dev)
1392
self.assertEqual(0, actual.st_dev)
1393
self.assertEqual(0, expected.st_ino)
1394
self.assertEqual(0, actual.st_ino)
1143
1396
self.assertEqual(expected.st_dev, actual.st_dev,
1144
1397
'st_dev did not match')
1145
1398
self.assertEqual(expected.st_ino, actual.st_ino,
1322
1578
self.assertEqual(expected_docstring, obj.__doc__)
1580
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1324
1581
def failUnlessExists(self, path):
1582
return self.assertPathExists(path)
1584
def assertPathExists(self, path):
1325
1585
"""Fail unless path or paths, which may be abs or relative, exist."""
1326
1586
if not isinstance(path, basestring):
1328
self.failUnlessExists(p)
1588
self.assertPathExists(p)
1330
self.failUnless(osutils.lexists(path),path+" does not exist")
1590
self.assertTrue(osutils.lexists(path),
1591
path + " does not exist")
1593
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1332
1594
def failIfExists(self, path):
1595
return self.assertPathDoesNotExist(path)
1597
def assertPathDoesNotExist(self, path):
1333
1598
"""Fail if path or paths, which may be abs or relative, exist."""
1334
1599
if not isinstance(path, basestring):
1336
self.failIfExists(p)
1601
self.assertPathDoesNotExist(p)
1338
self.failIf(osutils.lexists(path),path+" exists")
1603
self.assertFalse(osutils.lexists(path),
1340
1606
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1341
1607
"""A helper for callDeprecated and applyDeprecated.
1453
1720
def _startLogFile(self):
1454
"""Send bzr and test log messages to a temporary file.
1456
The file is removed as the test is torn down.
1458
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1459
self._log_file = os.fdopen(fileno, 'w+')
1460
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1461
self._log_file_name = name
1721
"""Setup a in-memory target for bzr and testcase log messages"""
1722
pseudo_log_file = StringIO()
1723
def _get_log_contents_for_weird_testtools_api():
1724
return [pseudo_log_file.getvalue().decode(
1725
"utf-8", "replace").encode("utf-8")]
1726
self.addDetail("log", content.Content(content.ContentType("text",
1727
"plain", {"charset": "utf8"}),
1728
_get_log_contents_for_weird_testtools_api))
1729
self._log_file = pseudo_log_file
1730
self._log_memento = trace.push_log_file(self._log_file)
1462
1731
self.addCleanup(self._finishLogFile)
1464
1733
def _finishLogFile(self):
1465
"""Finished with the log file.
1467
Close the file and delete it, unless setKeepLogfile was called.
1469
if bzrlib.trace._trace_file:
1734
"""Flush and dereference the in-memory log for this testcase"""
1735
if trace._trace_file:
1470
1736
# flush the log file, to get all content
1471
bzrlib.trace._trace_file.flush()
1472
bzrlib.trace.pop_log_file(self._log_memento)
1473
# Cache the log result and delete the file on disk
1474
self._get_log(False)
1737
trace._trace_file.flush()
1738
trace.pop_log_file(self._log_memento)
1739
# The logging module now tracks references for cleanup so discard ours
1740
del self._log_memento
1476
1742
def thisFailsStrictLockCheck(self):
1477
1743
"""It is known that this test would fail with -Dstrict_locks.
1513
1774
setattr(obj, attr_name, new)
1777
def overrideEnv(self, name, new):
1778
"""Set an environment variable, and reset it after the test.
1780
:param name: The environment variable name.
1782
:param new: The value to set the variable to. If None, the
1783
variable is deleted from the environment.
1785
:returns: The actual variable value.
1787
value = osutils.set_or_unset_env(name, new)
1788
self.addCleanup(osutils.set_or_unset_env, name, value)
1791
def recordCalls(self, obj, attr_name):
1792
"""Monkeypatch in a wrapper that will record calls.
1794
The monkeypatch is automatically removed when the test concludes.
1796
:param obj: The namespace holding the reference to be replaced;
1797
typically a module, class, or object.
1798
:param attr_name: A string for the name of the attribute to
1800
:returns: A list that will be extended with one item every time the
1801
function is called, with a tuple of (args, kwargs).
1805
def decorator(*args, **kwargs):
1806
calls.append((args, kwargs))
1807
return orig(*args, **kwargs)
1808
orig = self.overrideAttr(obj, attr_name, decorator)
1516
1811
def _cleanEnvironment(self):
1518
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1519
'HOME': os.getcwd(),
1520
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1521
# tests do check our impls match APPDATA
1522
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1526
'BZREMAIL': None, # may still be present in the environment
1528
'BZR_PROGRESS_BAR': None,
1530
'BZR_PLUGIN_PATH': None,
1531
'BZR_DISABLE_PLUGINS': None,
1532
'BZR_PLUGINS_AT': None,
1533
'BZR_CONCURRENCY': None,
1534
# Make sure that any text ui tests are consistent regardless of
1535
# the environment the test case is run in; you may want tests that
1536
# test other combinations. 'dumb' is a reasonable guess for tests
1537
# going to a pipe or a StringIO.
1541
'BZR_COLUMNS': '80',
1543
'SSH_AUTH_SOCK': None,
1547
'https_proxy': None,
1548
'HTTPS_PROXY': None,
1553
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1554
# least. If you do (care), please update this comment
1558
'BZR_REMOTE_PATH': None,
1559
# Generally speaking, we don't want apport reporting on crashes in
1560
# the test envirnoment unless we're specifically testing apport,
1561
# so that it doesn't leak into the real system environment. We
1562
# use an env var so it propagates to subprocesses.
1563
'APPORT_DISABLE': '1',
1566
self.addCleanup(self._restoreEnvironment)
1567
for name, value in new_env.iteritems():
1568
self._captureVar(name, value)
1570
def _captureVar(self, name, newvalue):
1571
"""Set an environment variable, and reset it when finished."""
1572
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1574
def _restoreEnvironment(self):
1575
for name, value in self._old_env.iteritems():
1576
osutils.set_or_unset_env(name, value)
1812
for name, value in isolated_environ.iteritems():
1813
self.overrideEnv(name, value)
1578
1815
def _restoreHooks(self):
1579
1816
for klass, (name, hooks) in self._preserved_hooks.items():
1580
1817
setattr(klass, name, hooks)
1818
self._preserved_hooks.clear()
1819
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1820
self._preserved_lazy_hooks.clear()
1582
1822
def knownFailure(self, reason):
1583
"""This test has failed for some known reason."""
1584
raise KnownFailure(reason)
1823
"""Declare that this test fails for a known reason
1825
Tests that are known to fail should generally be using expectedFailure
1826
with an appropriate reverse assertion if a change could cause the test
1827
to start passing. Conversely if the test has no immediate prospect of
1828
succeeding then using skip is more suitable.
1830
When this method is called while an exception is being handled, that
1831
traceback will be used, otherwise a new exception will be thrown to
1832
provide one but won't be reported.
1834
self._add_reason(reason)
1836
exc_info = sys.exc_info()
1837
if exc_info != (None, None, None):
1838
self._report_traceback(exc_info)
1841
raise self.failureException(reason)
1842
except self.failureException:
1843
exc_info = sys.exc_info()
1844
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1845
raise testtools.testcase._ExpectedFailure(exc_info)
1849
def _suppress_log(self):
1850
"""Remove the log info from details."""
1851
self.discardDetail('log')
1586
1853
def _do_skip(self, result, reason):
1854
self._suppress_log()
1587
1855
addSkip = getattr(result, 'addSkip', None)
1588
1856
if not callable(addSkip):
1589
1857
result.addSuccess(result)
1612
1882
self._do_skip(result, reason)
1885
def _report_skip(self, result, err):
1886
"""Override the default _report_skip.
1888
We want to strip the 'log' detail. If we waint until _do_skip, it has
1889
already been formatted into the 'reason' string, and we can't pull it
1892
self._suppress_log()
1893
super(TestCase, self)._report_skip(self, result, err)
1896
def _report_expected_failure(self, result, err):
1899
See _report_skip for motivation.
1901
self._suppress_log()
1902
super(TestCase, self)._report_expected_failure(self, result, err)
1615
1905
def _do_unsupported_or_skip(self, result, e):
1616
1906
reason = e.args[0]
1907
self._suppress_log()
1617
1908
addNotSupported = getattr(result, 'addNotSupported', None)
1618
1909
if addNotSupported is not None:
1619
1910
result.addNotSupported(self, reason)
1645
1936
self._benchtime += time.time() - start
1647
1938
def log(self, *args):
1650
def _get_log(self, keep_log_file=False):
1651
"""Internal helper to get the log from bzrlib.trace for this test.
1653
Please use self.getDetails, or self.get_log to access this in test case
1656
:param keep_log_file: When True, if the log is still a file on disk
1657
leave it as a file on disk. When False, if the log is still a file
1658
on disk, the log file is deleted and the log preserved as
1660
:return: A string containing the log.
1662
if self._log_contents is not None:
1664
self._log_contents.decode('utf8')
1665
except UnicodeDecodeError:
1666
unicodestr = self._log_contents.decode('utf8', 'replace')
1667
self._log_contents = unicodestr.encode('utf8')
1668
return self._log_contents
1670
if bzrlib.trace._trace_file:
1671
# flush the log file, to get all content
1672
bzrlib.trace._trace_file.flush()
1673
if self._log_file_name is not None:
1674
logfile = open(self._log_file_name)
1676
log_contents = logfile.read()
1680
log_contents.decode('utf8')
1681
except UnicodeDecodeError:
1682
unicodestr = log_contents.decode('utf8', 'replace')
1683
log_contents = unicodestr.encode('utf8')
1684
if not keep_log_file:
1686
max_close_attempts = 100
1687
first_close_error = None
1688
while close_attempts < max_close_attempts:
1691
self._log_file.close()
1692
except IOError, ioe:
1693
if ioe.errno is None:
1694
# No errno implies 'close() called during
1695
# concurrent operation on the same file object', so
1696
# retry. Probably a thread is trying to write to
1698
if first_close_error is None:
1699
first_close_error = ioe
1704
if close_attempts > 1:
1706
'Unable to close log file on first attempt, '
1707
'will retry: %s\n' % (first_close_error,))
1708
if close_attempts == max_close_attempts:
1710
'Unable to close log file after %d attempts.\n'
1711
% (max_close_attempts,))
1712
self._log_file = None
1713
# Permit multiple calls to get_log until we clean it up in
1715
self._log_contents = log_contents
1717
os.remove(self._log_file_name)
1719
if sys.platform == 'win32' and e.errno == errno.EACCES:
1720
sys.stderr.write(('Unable to delete log file '
1721
' %r\n' % self._log_file_name))
1724
self._log_file_name = None
1727
return "No log file content and no log file name."
1729
1941
def get_log(self):
1730
1942
"""Get a unicode string containing the log from bzrlib.trace.
2218
def _add_subprocess_log(self, log_file_path):
2219
if len(self._log_files) == 0:
2220
# Register an addCleanup func. We do this on the first call to
2221
# _add_subprocess_log rather than in TestCase.setUp so that this
2222
# addCleanup is registered after any cleanups for tempdirs that
2223
# subclasses might create, which will probably remove the log file
2225
self.addCleanup(self._subprocess_log_cleanup)
2226
# self._log_files is a set, so if a log file is reused we won't grab it
2228
self._log_files.add(log_file_path)
2230
def _subprocess_log_cleanup(self):
2231
for count, log_file_path in enumerate(self._log_files):
2232
# We use buffer_now=True to avoid holding the file open beyond
2233
# the life of this function, which might interfere with e.g.
2234
# cleaning tempdirs on Windows.
2235
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
2236
#detail_content = content.content_from_file(
2237
# log_file_path, buffer_now=True)
2238
with open(log_file_path, 'rb') as log_file:
2239
log_file_bytes = log_file.read()
2240
detail_content = content.Content(content.ContentType("text",
2241
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
2242
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
1997
2245
def _popen(self, *args, **kwargs):
1998
2246
"""Place a call to Popen.
2000
2248
Allows tests to override this method to intercept the calls made to
2001
2249
Popen for introspection.
2003
return Popen(*args, **kwargs)
2251
return subprocess.Popen(*args, **kwargs)
2005
2253
def get_source_path(self):
2006
2254
"""Return the path of the directory containing bzrlib."""
2036
2284
if retcode is not None and retcode != process.returncode:
2037
2285
if process_args is None:
2038
2286
process_args = "(unknown args)"
2039
mutter('Output of bzr %s:\n%s', process_args, out)
2040
mutter('Error for bzr %s:\n%s', process_args, err)
2287
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2288
trace.mutter('Error for bzr %s:\n%s', process_args, err)
2041
2289
self.fail('Command bzr %s failed with retcode %s != %s'
2042
2290
% (process_args, retcode, process.returncode))
2043
2291
return [out, err]
2045
def check_inventory_shape(self, inv, shape):
2046
"""Compare an inventory to a list of expected names.
2293
def check_tree_shape(self, tree, shape):
2294
"""Compare a tree to a list of expected names.
2048
2296
Fail if they are not precisely equal.
2051
2299
shape = list(shape) # copy
2052
for path, ie in inv.entries():
2300
for path, ie in tree.iter_entries_by_dir():
2053
2301
name = path.replace('\\', '/')
2054
2302
if ie.kind == 'directory':
2055
2303
name = name + '/'
2305
pass # ignore root entry
2057
2307
shape.remove(name)
2059
2309
extras.append(name)
2149
2399
class TestCaseWithMemoryTransport(TestCase):
2150
2400
"""Common test class for tests that do not need disk resources.
2152
Tests that need disk resources should derive from TestCaseWithTransport.
2402
Tests that need disk resources should derive from TestCaseInTempDir
2403
orTestCaseWithTransport.
2154
2405
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2156
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2407
For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
2157
2408
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
2409
is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
2410
must exist. However, TestCaseWithMemoryTransport does not offer local file
2411
defaults for the transport in tests, nor does it obey the command line
2161
2412
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.
2415
:cvar TEST_ROOT: Directory containing all temporary directories, plus a
2416
``.bzr`` directory that stops us ascending higher into the filesystem.
2168
2419
TEST_ROOT = None
2378
2640
def make_branch(self, relpath, format=None):
2379
2641
"""Create a branch on the transport at relpath."""
2380
2642
repo = self.make_repository(relpath, format=format)
2381
return repo.bzrdir.create_branch()
2643
return repo.bzrdir.create_branch(append_revisions_only=False)
2645
def get_default_format(self):
2648
def resolve_format(self, format):
2649
"""Resolve an object to a ControlDir format object.
2651
The initial format object can either already be
2652
a ControlDirFormat, None (for the default format),
2653
or a string with the name of the control dir format.
2655
:param format: Object to resolve
2656
:return A ControlDirFormat instance
2659
format = self.get_default_format()
2660
if isinstance(format, basestring):
2661
format = bzrdir.format_registry.make_bzrdir(format)
2383
2664
def make_bzrdir(self, relpath, format=None):
2385
2666
# might be a relative or absolute path
2386
2667
maybe_a_url = self.get_url(relpath)
2387
2668
segments = maybe_a_url.rsplit('/', 1)
2388
t = get_transport(maybe_a_url)
2669
t = _mod_transport.get_transport(maybe_a_url)
2389
2670
if len(segments) > 1 and segments[-1] not in ('', '.'):
2390
2671
t.ensure_base()
2393
if isinstance(format, basestring):
2394
format = bzrdir.format_registry.make_bzrdir(format)
2672
format = self.resolve_format(format)
2395
2673
return format.initialize_on_transport(t)
2396
2674
except errors.UninitializableFormat:
2397
2675
raise TestSkipped("Format %s is not initializable." % format)
2399
def make_repository(self, relpath, shared=False, format=None):
2677
def make_repository(self, relpath, shared=None, format=None):
2400
2678
"""Create a repository on our default transport at relpath.
2402
2680
Note that relpath must be a relative path, not a full url.
2427
2708
test_home_dir = self.test_home_dir
2428
2709
if isinstance(test_home_dir, unicode):
2429
2710
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2430
os.environ['HOME'] = test_home_dir
2431
os.environ['BZR_HOME'] = test_home_dir
2711
self.overrideEnv('HOME', test_home_dir)
2712
self.overrideEnv('BZR_HOME', test_home_dir)
2433
2714
def setUp(self):
2434
2715
super(TestCaseWithMemoryTransport, self).setUp()
2716
# Ensure that ConnectedTransport doesn't leak sockets
2717
def get_transport_from_url_with_cleanup(*args, **kwargs):
2718
t = orig_get_transport_from_url(*args, **kwargs)
2719
if isinstance(t, _mod_transport.ConnectedTransport):
2720
self.addCleanup(t.disconnect)
2723
orig_get_transport_from_url = self.overrideAttr(
2724
_mod_transport, 'get_transport_from_url',
2725
get_transport_from_url_with_cleanup)
2435
2726
self._make_test_root()
2436
2727
self.addCleanup(os.chdir, os.getcwdu())
2437
2728
self.makeAndChdirToTestDir()
3058
class TestDecorator(TestSuite):
3369
class TestDecorator(TestUtil.TestSuite):
3059
3370
"""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
3372
Contains rather than flattening suite passed on construction
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:
3375
def __init__(self, suite=None):
3376
super(TestDecorator, self).__init__()
3377
if suite is not None:
3380
# Don't need subclass run method with suite emptying
3381
run = unittest.TestSuite.run
3090
3384
class CountingDecorator(TestDecorator):
3101
3395
"""A decorator which excludes test matching an exclude pattern."""
3103
3397
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)
3398
super(ExcludeDecorator, self).__init__(
3399
exclude_tests_by_re(suite, exclude_pattern))
3118
3402
class FilterTestsDecorator(TestDecorator):
3119
3403
"""A decorator which filters tests to those matching a pattern."""
3121
3405
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)
3406
super(FilterTestsDecorator, self).__init__(
3407
filter_suite_by_re(suite, pattern))
3136
3410
class RandomDecorator(TestDecorator):
3137
3411
"""A decorator which randomises the order of its tests."""
3139
3413
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()))
3414
random_seed = self.actual_seed(random_seed)
3415
stream.write("Randomizing test order using seed %s\n\n" %
3151
3417
# 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)
3418
random.seed(random_seed)
3419
super(RandomDecorator, self).__init__(randomize_suite(suite))
3158
def actual_seed(self):
3159
if self.random_seed == "now":
3422
def actual_seed(seed):
3160
3424
# We convert the seed to a long to make it reuseable across
3161
3425
# invocations (because the user can reenter it).
3162
self.random_seed = long(time.time())
3426
return long(time.time())
3164
3428
# Convert the seed to a long if we can
3166
self.random_seed = long(self.random_seed)
3431
except (TypeError, ValueError):
3169
return self.random_seed
3172
3436
class TestFirstDecorator(TestDecorator):
3173
3437
"""A decorator which moves named tests to the front."""
3175
3439
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)
3440
super(TestFirstDecorator, self).__init__()
3441
self.addTests(split_suite_by_re(suite, pattern))
3190
3444
def partition_tests(suite, count):
3191
3445
"""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)
3446
# This just assigns tests in a round-robin fashion. On one hand this
3447
# splits up blocks of related tests that might run faster if they shared
3448
# resources, but on the other it avoids assigning blocks of slow tests to
3449
# just one partition. So the slowest partition shouldn't be much slower
3451
partitions = [list() for i in range(count)]
3452
tests = iter_suite_tests(suite)
3453
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3454
partition.append(test)
3203
3458
def workaround_zealous_crypto_random():
3234
3489
ProtocolTestCase.run(self, result)
3236
os.waitpid(self.pid, 0)
3491
pid, status = os.waitpid(self.pid, 0)
3492
# GZ 2011-10-18: If status is nonzero, should report to the result
3493
# that something went wrong.
3238
3495
test_blocks = partition_tests(suite, concurrency)
3496
# Clear the tests from the original suite so it doesn't keep them alive
3497
suite._tests[:] = []
3239
3498
for process_tests in test_blocks:
3240
process_suite = TestSuite()
3241
process_suite.addTests(process_tests)
3499
process_suite = TestUtil.TestSuite(process_tests)
3500
# Also clear each split list so new suite has only reference
3501
process_tests[:] = []
3242
3502
c2pread, c2pwrite = os.pipe()
3243
3503
pid = os.fork()
3245
workaround_zealous_crypto_random()
3506
stream = os.fdopen(c2pwrite, 'wb', 1)
3507
workaround_zealous_crypto_random()
3247
3508
os.close(c2pread)
3248
3509
# Leave stderr and stdout open so we can see test noise
3249
3510
# Close stdin so that the child goes away if it decides to
3250
3511
# read from stdin (otherwise its a roulette to see what
3251
3512
# child actually gets keystrokes for pdb etc).
3252
3513
sys.stdin.close()
3254
stream = os.fdopen(c2pwrite, 'wb', 1)
3255
3514
subunit_result = AutoTimingTestResultDecorator(
3256
TestProtocolClient(stream))
3515
SubUnitBzrProtocolClient(stream))
3257
3516
process_suite.run(subunit_result)
3518
# Try and report traceback on stream, but exit with error even
3519
# if stream couldn't be created or something else goes wrong.
3520
# The traceback is formatted to a string and written in one go
3521
# to avoid interleaving lines from multiple failing children.
3523
stream.write(traceback.format_exc())
3261
3528
os.close(c2pwrite)
3262
3529
stream = os.fdopen(c2pread, 'rb', 1)
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):
3593
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3357
3594
"""Generate profiling data for all activity between start and success.
3359
3596
The profile data is appended to the test's _benchcalls attribute and can
3647
3895
'bzrlib.tests.per_repository',
3648
3896
'bzrlib.tests.per_repository_chk',
3649
3897
'bzrlib.tests.per_repository_reference',
3898
'bzrlib.tests.per_repository_vf',
3650
3899
'bzrlib.tests.per_uifactory',
3651
3900
'bzrlib.tests.per_versionedfile',
3652
3901
'bzrlib.tests.per_workingtree',
3653
3902
'bzrlib.tests.test__annotator',
3654
3903
'bzrlib.tests.test__bencode',
3904
'bzrlib.tests.test__btree_serializer',
3655
3905
'bzrlib.tests.test__chk_map',
3656
3906
'bzrlib.tests.test__dirstate_helpers',
3657
3907
'bzrlib.tests.test__groupcompress',
3685
3935
'bzrlib.tests.test_commit_merge',
3686
3936
'bzrlib.tests.test_config',
3687
3937
'bzrlib.tests.test_conflicts',
3938
'bzrlib.tests.test_controldir',
3688
3939
'bzrlib.tests.test_counted_lock',
3689
3940
'bzrlib.tests.test_crash',
3690
3941
'bzrlib.tests.test_decorators',
3691
3942
'bzrlib.tests.test_delta',
3692
3943
'bzrlib.tests.test_debug',
3693
'bzrlib.tests.test_deprecated_graph',
3694
3944
'bzrlib.tests.test_diff',
3695
3945
'bzrlib.tests.test_directory_service',
3696
3946
'bzrlib.tests.test_dirstate',
3697
3947
'bzrlib.tests.test_email_message',
3698
3948
'bzrlib.tests.test_eol_filters',
3699
3949
'bzrlib.tests.test_errors',
3950
'bzrlib.tests.test_estimate_compressed_size',
3700
3951
'bzrlib.tests.test_export',
3952
'bzrlib.tests.test_export_pot',
3701
3953
'bzrlib.tests.test_extract',
3954
'bzrlib.tests.test_features',
3702
3955
'bzrlib.tests.test_fetch',
3956
'bzrlib.tests.test_fixtures',
3703
3957
'bzrlib.tests.test_fifo_cache',
3704
3958
'bzrlib.tests.test_filters',
3959
'bzrlib.tests.test_filter_tree',
3705
3960
'bzrlib.tests.test_ftp_transport',
3706
3961
'bzrlib.tests.test_foreign',
3707
3962
'bzrlib.tests.test_generate_docs',
3733
3990
'bzrlib.tests.test_lru_cache',
3734
3991
'bzrlib.tests.test_lsprof',
3735
3992
'bzrlib.tests.test_mail_client',
3993
'bzrlib.tests.test_matchers',
3736
3994
'bzrlib.tests.test_memorytree',
3737
3995
'bzrlib.tests.test_merge',
3738
3996
'bzrlib.tests.test_merge3',
3739
3997
'bzrlib.tests.test_merge_core',
3740
3998
'bzrlib.tests.test_merge_directive',
3999
'bzrlib.tests.test_mergetools',
3741
4000
'bzrlib.tests.test_missing',
3742
4001
'bzrlib.tests.test_msgeditor',
3743
4002
'bzrlib.tests.test_multiparent',
3936
4205
# Some tests mentioned in the list are not in the test suite. The
3937
4206
# list may be out of date, report to the tester.
3938
4207
for id in not_found:
3939
bzrlib.trace.warning('"%s" not found in the test suite', id)
4208
trace.warning('"%s" not found in the test suite', id)
3940
4209
for id in duplicates:
3941
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
4210
trace.warning('"%s" is used as an id by several tests', id)
3946
def multiply_scenarios(scenarios_left, scenarios_right):
4215
def multiply_scenarios(*scenarios):
4216
"""Multiply two or more iterables of scenarios.
4218
It is safe to pass scenario generators or iterators.
4220
:returns: A list of compound scenarios: the cross-product of all
4221
scenarios, with the names concatenated and the parameters
4224
return reduce(_multiply_two_scenarios, map(list, scenarios))
4227
def _multiply_two_scenarios(scenarios_left, scenarios_right):
3947
4228
"""Multiply two sets of scenarios.
3949
4230
:returns: the cartesian product of the two sets of scenarios, that is
4100
4394
if test_id != None:
4101
4395
ui.ui_factory.clear_term()
4102
4396
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4397
# Ugly, but the last thing we want here is fail, so bear with it.
4398
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4399
).encode('ascii', 'replace')
4103
4400
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')
4401
% (os.path.basename(dirname), printable_e))
4266
4404
def probe_unicode_in_user_encoding():
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
4437
# Only define SubUnitBzrRunner if subunit is available.
4453
4439
from subunit import TestProtocolClient
4454
4440
from subunit.test_results import AutoTimingTestResultDecorator
4441
class SubUnitBzrProtocolClient(TestProtocolClient):
4443
def stopTest(self, test):
4444
super(SubUnitBzrProtocolClient, self).stopTest(test)
4445
_clear__type_equality_funcs(test)
4447
def addSuccess(self, test, details=None):
4448
# The subunit client always includes the details in the subunit
4449
# stream, but we don't want to include it in ours.
4450
if details is not None and 'log' in details:
4452
return super(SubUnitBzrProtocolClient, self).addSuccess(
4455
4455
class SubUnitBzrRunner(TextTestRunner):
4456
4456
def run(self, test):
4457
4457
result = AutoTimingTestResultDecorator(
4458
TestProtocolClient(self.stream))
4458
SubUnitBzrProtocolClient(self.stream))
4459
4459
test.run(result)
4461
4461
except ImportError:
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()
4465
@deprecated_function(deprecated_in((2, 5, 0)))
4466
def ModuleAvailableFeature(name):
4467
from bzrlib.tests import features
4468
return features.ModuleAvailableFeature(name)
added
removed
bzrlib/tests/__init__.py
