50
54
# nb: check this before importing anything else from within it
51
55
_testtools_version = getattr(testtools, '__version__', ())
52
if _testtools_version < (0, 9, 5):
53
raise ImportError("need at least testtools 0.9.5: %s is %r"
56
if _testtools_version < (0, 9, 2):
57
raise ImportError("need at least testtools 0.9.2: %s is %r"
54
58
% (testtools.__file__, _testtools_version))
55
59
from testtools import content
58
61
from bzrlib import (
62
commands as _mod_commands,
71
plugin as _mod_plugin,
78
transport as _mod_transport,
79
import bzrlib.commands
80
import bzrlib.timestamp
82
import bzrlib.inventory
83
import bzrlib.iterablefile
82
86
import bzrlib.lsprof
83
87
except ImportError:
84
88
# lsprof not available
86
from bzrlib.smart import client, request
87
from bzrlib.transport import (
90
from bzrlib.merge import merge_inner
93
from bzrlib.smart import client, request, server
95
from bzrlib import symbol_versioning
91
96
from bzrlib.symbol_versioning import (
92
98
deprecated_function,
95
from bzrlib.tests import (
104
from bzrlib.transport import get_transport, pathfilter
105
import bzrlib.transport
106
from bzrlib.transport.local import LocalURLServer
107
from bzrlib.transport.memory import MemoryServer
108
from bzrlib.transport.readonly import ReadonlyServer
109
from bzrlib.trace import mutter, note
110
from bzrlib.tests import TestUtil
111
from bzrlib.tests.http_server import HttpServer
112
from bzrlib.tests.TestUtil import (
116
from bzrlib.tests.treeshape import build_tree_contents
100
117
from bzrlib.ui import NullProgressView
101
118
from bzrlib.ui.text import TextUIFactory
119
import bzrlib.version_info_formats.format_custom
120
from bzrlib.workingtree import WorkingTree, WorkingTreeFormat2
103
122
# Mark this python module as being part of the implementation
104
123
# of unittest: this gives us better tracebacks where the last
105
124
# shown frame is the test code, not our assertXYZ.
108
default_transport = test_server.LocalURLServer
111
_unitialized_attr = object()
112
"""A sentinel needed to act as a default value in a method signature."""
127
default_transport = LocalURLServer
115
129
# Subunit result codes, defined here to prevent a hard dependency on subunit.
116
130
SUBUNIT_SEEK_SET = 0
117
131
SUBUNIT_SEEK_CUR = 1
119
# These are intentionally brought into this namespace. That way plugins, etc
120
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
121
TestSuite = TestUtil.TestSuite
122
TestLoader = TestUtil.TestLoader
124
# Tests should run in a clean and clearly defined environment. The goal is to
125
# keep them isolated from the running environment as mush as possible. The test
126
# framework ensures the variables defined below are set (or deleted if the
127
# value is None) before a test is run and reset to their original value after
128
# the test is run. Generally if some code depends on an environment variable,
129
# the tests should start without this variable in the environment. There are a
130
# few exceptions but you shouldn't violate this rule lightly.
134
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
135
# tests do check our impls match APPDATA
136
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
140
'BZREMAIL': None, # may still be present in the environment
141
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
142
'BZR_PROGRESS_BAR': None,
143
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
144
# as a base class instead of TestCaseInTempDir. Tests inheriting from
145
# TestCase should not use disk resources, BZR_LOG is one.
146
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
147
'BZR_PLUGIN_PATH': None,
148
'BZR_DISABLE_PLUGINS': None,
149
'BZR_PLUGINS_AT': None,
150
'BZR_CONCURRENCY': None,
151
# Make sure that any text ui tests are consistent regardless of
152
# the environment the test case is run in; you may want tests that
153
# test other combinations. 'dumb' is a reasonable guess for tests
154
# going to a pipe or a StringIO.
160
'SSH_AUTH_SOCK': None,
170
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
171
# least. If you do (care), please update this comment
175
'BZR_REMOTE_PATH': None,
176
# Generally speaking, we don't want apport reporting on crashes in
177
# the test envirnoment unless we're specifically testing apport,
178
# so that it doesn't leak into the real system environment. We
179
# use an env var so it propagates to subprocesses.
180
'APPORT_DISABLE': '1',
184
def override_os_environ(test, env=None):
185
"""Modify os.environ keeping a copy.
187
:param test: A test instance
189
:param env: A dict containing variable definitions to be installed
192
env = isolated_environ
193
test._original_os_environ = dict([(var, value)
194
for var, value in os.environ.iteritems()])
195
for var, value in env.iteritems():
196
osutils.set_or_unset_env(var, value)
197
if var not in test._original_os_environ:
198
# The var is new, add it with a value of None, so
199
# restore_os_environ will delete it
200
test._original_os_environ[var] = None
203
def restore_os_environ(test):
204
"""Restore os.environ to its original state.
206
:param test: A test instance previously passed to override_os_environ.
208
for var, value in test._original_os_environ.iteritems():
209
# Restore the original value (or delete it if the value has been set to
210
# None in override_os_environ).
211
osutils.set_or_unset_env(var, value)
214
class ExtendedTestResult(testtools.TextTestResult):
134
class ExtendedTestResult(unittest._TextTestResult):
215
135
"""Accepts, reports and accumulates the results of running tests.
217
137
Compared to the unittest version this class adds support for
293
208
if failed or errored: self.stream.write(", ")
294
209
self.stream.write("known_failure_count=%d" %
295
210
self.known_failure_count)
296
self.stream.write(")\n")
211
self.stream.writeln(")")
298
213
if self.known_failure_count:
299
self.stream.write("OK (known_failures=%d)\n" %
214
self.stream.writeln("OK (known_failures=%d)" %
300
215
self.known_failure_count)
302
self.stream.write("OK\n")
217
self.stream.writeln("OK")
303
218
if self.skip_count > 0:
304
219
skipped = self.skip_count
305
self.stream.write('%d test%s skipped\n' %
220
self.stream.writeln('%d test%s skipped' %
306
221
(skipped, skipped != 1 and "s" or ""))
307
222
if self.unsupported:
308
223
for feature, count in sorted(self.unsupported.items()):
309
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
224
self.stream.writeln("Missing feature '%s' skipped %d tests." %
310
225
(feature, count))
312
227
ok = self.wasStrictlySuccessful()
314
229
ok = self.wasSuccessful()
315
if self._first_thread_leaker_id:
230
if TestCase._first_thread_leaker_id:
316
231
self.stream.write(
317
232
'%s is leaking threads among %d leaking tests.\n' % (
318
self._first_thread_leaker_id,
319
self._tests_leaking_threads_count))
233
TestCase._first_thread_leaker_id,
234
TestCase._leaking_threads_tests))
320
235
# We don't report the main thread as an active one.
321
236
self.stream.write(
322
237
'%d non-main threads were left active in the end.\n'
323
% (len(self._active_threads) - 1))
325
def getDescription(self, test):
238
% (TestCase._active_threads - 1))
328
240
def _extractBenchmarkTime(self, testCase, details=None):
329
241
"""Add a benchmark time for the current test case."""
352
263
def _shortened_test_description(self, test):
354
what = re.sub(r'^bzrlib\.tests\.', '', what)
265
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
357
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
358
# multiple times in a row, because the handler is added for
359
# each test but the container list is shared between cases.
360
# See lp:498869 lp:625574 and lp:637725 for background.
361
def _record_traceback_from_test(self, exc_info):
362
"""Store the traceback from passed exc_info tuple till"""
363
self._traceback_from_test = exc_info[2]
365
268
def startTest(self, test):
366
super(ExtendedTestResult, self).startTest(test)
269
unittest.TestResult.startTest(self, test)
367
270
if self.count == 0:
368
271
self.startTests()
370
272
self.report_test_start(test)
371
273
test.number = self.count
372
274
self._recordTestStartTime()
373
# Make testtools cases give us the real traceback on failure
374
addOnException = getattr(test, "addOnException", None)
375
if addOnException is not None:
376
addOnException(self._record_traceback_from_test)
377
# Only check for thread leaks on bzrlib derived test cases
378
if isinstance(test, TestCase):
379
test.addCleanup(self._check_leaked_threads, test)
381
def stopTest(self, test):
382
super(ExtendedTestResult, self).stopTest(test)
383
# Manually break cycles, means touching various private things but hey
384
getDetails = getattr(test, "getDetails", None)
385
if getDetails is not None:
387
# Clear _type_equality_funcs to try to stop TestCase instances
388
# from wasting memory. 'clear' is not available in all Python
389
# versions (bug 809048)
390
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
391
if type_equality_funcs is not None:
392
tef_clear = getattr(type_equality_funcs, "clear", None)
393
if tef_clear is None:
394
tef_instance_dict = getattr(type_equality_funcs, "__dict__", None)
395
if tef_instance_dict is not None:
396
tef_clear = tef_instance_dict.clear
397
if tef_clear is not None:
399
self._traceback_from_test = None
401
276
def startTests(self):
402
self.report_tests_starting()
403
self._active_threads = threading.enumerate()
405
def _check_leaked_threads(self, test):
406
"""See if any threads have leaked since last call
408
A sample of live threads is stored in the _active_threads attribute,
409
when this method runs it compares the current live threads and any not
410
in the previous sample are treated as having leaked.
412
now_active_threads = set(threading.enumerate())
413
threads_leaked = now_active_threads.difference(self._active_threads)
415
self._report_thread_leak(test, threads_leaked, now_active_threads)
416
self._tests_leaking_threads_count += 1
417
if self._first_thread_leaker_id is None:
418
self._first_thread_leaker_id = test.id()
419
self._active_threads = now_active_threads
278
if getattr(sys, 'frozen', None) is None:
279
bzr_path = osutils.realpath(sys.argv[0])
281
bzr_path = sys.executable
283
'bzr selftest: %s\n' % (bzr_path,))
286
bzrlib.__path__[0],))
288
' bzr-%s python-%s %s\n' % (
289
bzrlib.version_string,
290
bzrlib._format_version_tuple(sys.version_info),
291
platform.platform(aliased=1),
293
self.stream.write('\n')
421
295
def _recordTestStartTime(self):
422
296
"""Record that a test has started."""
423
self._start_datetime = self._now()
297
self._start_time = time.time()
299
def _cleanupLogFile(self, test):
300
# We can only do this if we have one of our TestCases, not if
302
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
303
if setKeepLogfile is not None:
425
306
def addError(self, test, err):
426
307
"""Tell result that test finished with an error.
460
343
self._formatTime(benchmark_time),
462
345
self.report_success(test)
463
super(ExtendedTestResult, self).addSuccess(test)
346
self._cleanupLogFile(test)
347
unittest.TestResult.addSuccess(self, test)
464
348
test._log_contents = ''
466
350
def addExpectedFailure(self, test, err):
467
351
self.known_failure_count += 1
468
352
self.report_known_failure(test, err)
470
def addUnexpectedSuccess(self, test, details=None):
471
"""Tell result the test unexpectedly passed, counting as a failure
473
When the minimum version of testtools required becomes 0.9.8 this
474
can be updated to use the new handling there.
476
super(ExtendedTestResult, self).addFailure(test, details=details)
477
self.failure_count += 1
478
self.report_unexpected_success(test,
479
"".join(details["reason"].iter_text()))
483
354
def addNotSupported(self, test, feature):
484
355
"""The test will not be run because of a missing feature.
518
388
raise errors.BzrError("Unknown whence %r" % whence)
520
def report_tests_starting(self):
521
"""Display information before the test run begins"""
522
if getattr(sys, 'frozen', None) is None:
523
bzr_path = osutils.realpath(sys.argv[0])
525
bzr_path = sys.executable
527
'bzr selftest: %s\n' % (bzr_path,))
530
bzrlib.__path__[0],))
532
' bzr-%s python-%s %s\n' % (
533
bzrlib.version_string,
534
bzrlib._format_version_tuple(sys.version_info),
535
platform.platform(aliased=1),
537
self.stream.write('\n')
539
def report_test_start(self, test):
540
"""Display information on the test just about to be run"""
542
def _report_thread_leak(self, test, leaked_threads, active_threads):
543
"""Display information on a test that leaked one or more threads"""
544
# GZ 2010-09-09: A leak summary reported separately from the general
545
# thread debugging would be nice. Tests under subunit
546
# need something not using stream, perhaps adding a
547
# testtools details object would be fitting.
548
if 'threads' in selftest_debug_flags:
549
self.stream.write('%s is leaking, active is now %d\n' %
550
(test.id(), len(active_threads)))
390
def report_cleaning_up(self):
552
393
def startTestRun(self):
553
394
self.startTime = time.time()
694
538
return '%s%s' % (indent, err[1])
696
540
def report_error(self, test, err):
697
self.stream.write('ERROR %s\n%s\n'
541
self.stream.writeln('ERROR %s\n%s'
698
542
% (self._testTimeString(test),
699
543
self._error_summary(err)))
701
545
def report_failure(self, test, err):
702
self.stream.write(' FAIL %s\n%s\n'
546
self.stream.writeln(' FAIL %s\n%s'
703
547
% (self._testTimeString(test),
704
548
self._error_summary(err)))
706
550
def report_known_failure(self, test, err):
707
self.stream.write('XFAIL %s\n%s\n'
551
self.stream.writeln('XFAIL %s\n%s'
708
552
% (self._testTimeString(test),
709
553
self._error_summary(err)))
711
def report_unexpected_success(self, test, reason):
712
self.stream.write(' FAIL %s\n%s: %s\n'
713
% (self._testTimeString(test),
714
"Unexpected success. Should have failed",
717
555
def report_success(self, test):
718
self.stream.write(' OK %s\n' % self._testTimeString(test))
556
self.stream.writeln(' OK %s' % self._testTimeString(test))
719
557
for bench_called, stats in getattr(test, '_benchcalls', []):
720
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
558
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
721
559
stats.pprint(file=self.stream)
722
560
# flush the stream so that we get smooth output. This verbose mode is
723
561
# used to show the output in PQM.
724
562
self.stream.flush()
726
564
def report_skip(self, test, reason):
727
self.stream.write(' SKIP %s\n%s\n'
565
self.stream.writeln(' SKIP %s\n%s'
728
566
% (self._testTimeString(test), reason))
730
568
def report_not_applicable(self, test, reason):
731
self.stream.write(' N/A %s\n %s\n'
569
self.stream.writeln(' N/A %s\n %s'
732
570
% (self._testTimeString(test), reason))
734
572
def report_unsupported(self, test, feature):
735
573
"""test cannot be run because feature is missing."""
736
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
574
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
737
575
%(self._testTimeString(test), feature))
990
818
self._track_transports()
991
819
self._track_locks()
992
820
self._clear_debug_flags()
993
# Isolate global verbosity level, to make sure it's reproducible
994
# between tests. We should get rid of this altogether: bug 656694. --
996
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
997
# Isolate config option expansion until its default value for bzrlib is
998
# settled on or a the FIXME associated with _get_expand_default_value
999
# is addressed -- vila 20110219
1000
self.overrideAttr(config, '_expand_default_value', None)
1001
self._log_files = set()
1002
# Each key in the ``_counters`` dict holds a value for a different
1003
# counter. When the test ends, addDetail() should be used to output the
1004
# counter values. This happens in install_counter_hook().
1006
if 'config_stats' in selftest_debug_flags:
1007
self._install_config_stats_hooks()
821
TestCase._active_threads = threading.activeCount()
822
self.addCleanup(self._check_leaked_threads)
1009
824
def debug(self):
1010
825
# debug a frame up.
1012
827
pdb.Pdb().set_trace(sys._getframe().f_back)
1014
def discardDetail(self, name):
1015
"""Extend the addDetail, getDetails api so we can remove a detail.
1017
eg. bzr always adds the 'log' detail at startup, but we don't want to
1018
include it for skipped, xfail, etc tests.
1020
It is safe to call this for a detail that doesn't exist, in case this
1021
gets called multiple times.
1023
# We cheat. details is stored in __details which means we shouldn't
1024
# touch it. but getDetails() returns the dict directly, so we can
1026
details = self.getDetails()
1030
def install_counter_hook(self, hooks, name, counter_name=None):
1031
"""Install a counting hook.
1033
Any hook can be counted as long as it doesn't need to return a value.
1035
:param hooks: Where the hook should be installed.
1037
:param name: The hook name that will be counted.
1039
:param counter_name: The counter identifier in ``_counters``, defaults
1042
_counters = self._counters # Avoid closing over self
1043
if counter_name is None:
1045
if _counters.has_key(counter_name):
1046
raise AssertionError('%s is already used as a counter name'
1048
_counters[counter_name] = 0
1049
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1050
lambda: ['%d' % (_counters[counter_name],)]))
1051
def increment_counter(*args, **kwargs):
1052
_counters[counter_name] += 1
1053
label = 'count %s calls' % (counter_name,)
1054
hooks.install_named_hook(name, increment_counter, label)
1055
self.addCleanup(hooks.uninstall_named_hook, name, label)
1057
def _install_config_stats_hooks(self):
1058
"""Install config hooks to count hook calls.
1061
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1062
self.install_counter_hook(config.ConfigHooks, hook_name,
1063
'config.%s' % (hook_name,))
1065
# The OldConfigHooks are private and need special handling to protect
1066
# against recursive tests (tests that run other tests), so we just do
1067
# manually what registering them into _builtin_known_hooks will provide
1069
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1070
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1071
self.install_counter_hook(config.OldConfigHooks, hook_name,
1072
'old_config.%s' % (hook_name,))
829
def _check_leaked_threads(self):
830
active = threading.activeCount()
831
leaked_threads = active - TestCase._active_threads
832
TestCase._active_threads = active
833
# If some tests make the number of threads *decrease*, we'll consider
834
# that they are just observing old threads dieing, not agressively kill
835
# random threads. So we don't report these tests as leaking. The risk
836
# is that we have false positives that way (the test see 2 threads
837
# going away but leak one) but it seems less likely than the actual
838
# false positives (the test see threads going away and does not leak).
839
if leaked_threads > 0:
840
TestCase._leaking_threads_tests += 1
841
if TestCase._first_thread_leaker_id is None:
842
TestCase._first_thread_leaker_id = self.id()
1074
844
def _clear_debug_flags(self):
1075
845
"""Prevent externally set debug flags affecting tests.
1077
847
Tests that want to use debug flags can just set them in the
1078
848
debug_flags set during setup/teardown.
1080
# Start with a copy of the current debug flags we can safely modify.
1081
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
850
self._preserved_debug_flags = set(debug.debug_flags)
1082
851
if 'allow_debug' not in selftest_debug_flags:
1083
852
debug.debug_flags.clear()
1084
853
if 'disable_lock_checks' not in selftest_debug_flags:
1085
854
debug.debug_flags.add('strict_locks')
855
self.addCleanup(self._restore_debug_flags)
1087
857
def _clear_hooks(self):
1088
858
# prevent hooks affecting tests
1089
known_hooks = hooks.known_hooks
1090
859
self._preserved_hooks = {}
1091
for key, (parent, name) in known_hooks.iter_parent_objects():
1092
current_hooks = getattr(parent, name)
860
for key, factory in hooks.known_hooks.items():
861
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
862
current_hooks = hooks.known_hooks_key_to_object(key)
1093
863
self._preserved_hooks[parent] = (name, current_hooks)
1094
self._preserved_lazy_hooks = hooks._lazy_hooks
1095
hooks._lazy_hooks = {}
1096
864
self.addCleanup(self._restoreHooks)
1097
for key, (parent, name) in known_hooks.iter_parent_objects():
1098
factory = known_hooks.get(key)
865
for key, factory in hooks.known_hooks.items():
866
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
1099
867
setattr(parent, name, factory())
1100
868
# this hook should always be installed
1101
869
request._install_hook()
1548
1304
self.assertEqualDiff(content, s)
1550
def assertDocstring(self, expected_docstring, obj):
1551
"""Fail if obj does not have expected_docstring"""
1553
# With -OO the docstring should be None instead
1554
self.assertIs(obj.__doc__, None)
1556
self.assertEqual(expected_docstring, obj.__doc__)
1558
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1559
1306
def failUnlessExists(self, path):
1560
return self.assertPathExists(path)
1562
def assertPathExists(self, path):
1563
1307
"""Fail unless path or paths, which may be abs or relative, exist."""
1564
1308
if not isinstance(path, basestring):
1566
self.assertPathExists(p)
1310
self.failUnlessExists(p)
1568
self.assertTrue(osutils.lexists(path),
1569
path + " does not exist")
1312
self.failUnless(osutils.lexists(path),path+" does not exist")
1571
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1572
1314
def failIfExists(self, path):
1573
return self.assertPathDoesNotExist(path)
1575
def assertPathDoesNotExist(self, path):
1576
1315
"""Fail if path or paths, which may be abs or relative, exist."""
1577
1316
if not isinstance(path, basestring):
1579
self.assertPathDoesNotExist(p)
1318
self.failIfExists(p)
1581
self.assertFalse(osutils.lexists(path),
1320
self.failIf(osutils.lexists(path),path+" exists")
1584
1322
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1585
1323
"""A helper for callDeprecated and applyDeprecated.
1701
1438
The file is removed as the test is torn down.
1703
pseudo_log_file = StringIO()
1704
def _get_log_contents_for_weird_testtools_api():
1705
return [pseudo_log_file.getvalue().decode(
1706
"utf-8", "replace").encode("utf-8")]
1707
self.addDetail("log", content.Content(content.ContentType("text",
1708
"plain", {"charset": "utf8"}),
1709
_get_log_contents_for_weird_testtools_api))
1710
self._log_file = pseudo_log_file
1711
self._log_memento = trace.push_log_file(self._log_file)
1440
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1441
self._log_file = os.fdopen(fileno, 'w+')
1442
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1443
self._log_file_name = name
1712
1444
self.addCleanup(self._finishLogFile)
1714
1446
def _finishLogFile(self):
1715
1447
"""Finished with the log file.
1717
Close the file and delete it.
1449
Close the file and delete it, unless setKeepLogfile was called.
1719
if trace._trace_file:
1451
if bzrlib.trace._trace_file:
1720
1452
# flush the log file, to get all content
1721
trace._trace_file.flush()
1722
trace.pop_log_file(self._log_memento)
1453
bzrlib.trace._trace_file.flush()
1454
bzrlib.trace.pop_log_file(self._log_memento)
1455
# Cache the log result and delete the file on disk
1456
self._get_log(False)
1724
1458
def thisFailsStrictLockCheck(self):
1725
1459
"""It is known that this test would fail with -Dstrict_locks.
1735
1469
debug.debug_flags.discard('strict_locks')
1737
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1738
"""Overrides an object attribute restoring it after the test.
1740
:note: This should be used with discretion; you should think about
1741
whether it's better to make the code testable without monkey-patching.
1743
:param obj: The object that will be mutated.
1745
:param attr_name: The attribute name we want to preserve/override in
1748
:param new: The optional value we want to set the attribute to.
1750
:returns: The actual attr value.
1752
value = getattr(obj, attr_name)
1753
# The actual value is captured by the call below
1754
self.addCleanup(setattr, obj, attr_name, value)
1755
if new is not _unitialized_attr:
1756
setattr(obj, attr_name, new)
1759
def overrideEnv(self, name, new):
1760
"""Set an environment variable, and reset it after the test.
1762
:param name: The environment variable name.
1764
:param new: The value to set the variable to. If None, the
1765
variable is deleted from the environment.
1767
:returns: The actual variable value.
1769
value = osutils.set_or_unset_env(name, new)
1770
self.addCleanup(osutils.set_or_unset_env, name, value)
1773
def recordCalls(self, obj, attr_name):
1774
"""Monkeypatch in a wrapper that will record calls.
1776
The monkeypatch is automatically removed when the test concludes.
1778
:param obj: The namespace holding the reference to be replaced;
1779
typically a module, class, or object.
1780
:param attr_name: A string for the name of the attribute to
1782
:returns: A list that will be extended with one item every time the
1783
function is called, with a tuple of (args, kwargs).
1787
def decorator(*args, **kwargs):
1788
calls.append((args, kwargs))
1789
return orig(*args, **kwargs)
1790
orig = self.overrideAttr(obj, attr_name, decorator)
1471
def addCleanup(self, callable, *args, **kwargs):
1472
"""Arrange to run a callable when this case is torn down.
1474
Callables are run in the reverse of the order they are registered,
1475
ie last-in first-out.
1477
self._cleanups.append((callable, args, kwargs))
1793
1479
def _cleanEnvironment(self):
1794
for name, value in isolated_environ.iteritems():
1795
self.overrideEnv(name, value)
1481
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1482
'HOME': os.getcwd(),
1483
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1484
# tests do check our impls match APPDATA
1485
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1489
'BZREMAIL': None, # may still be present in the environment
1491
'BZR_PROGRESS_BAR': None,
1493
'BZR_PLUGIN_PATH': None,
1494
'BZR_CONCURRENCY': None,
1495
# Make sure that any text ui tests are consistent regardless of
1496
# the environment the test case is run in; you may want tests that
1497
# test other combinations. 'dumb' is a reasonable guess for tests
1498
# going to a pipe or a StringIO.
1502
'BZR_COLUMNS': '80',
1504
'SSH_AUTH_SOCK': None,
1508
'https_proxy': None,
1509
'HTTPS_PROXY': None,
1514
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1515
# least. If you do (care), please update this comment
1519
'BZR_REMOTE_PATH': None,
1522
self.addCleanup(self._restoreEnvironment)
1523
for name, value in new_env.iteritems():
1524
self._captureVar(name, value)
1526
def _captureVar(self, name, newvalue):
1527
"""Set an environment variable, and reset it when finished."""
1528
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1530
def _restore_debug_flags(self):
1531
debug.debug_flags.clear()
1532
debug.debug_flags.update(self._preserved_debug_flags)
1534
def _restoreEnvironment(self):
1535
for name, value in self.__old_env.iteritems():
1536
osutils.set_or_unset_env(name, value)
1797
1538
def _restoreHooks(self):
1798
1539
for klass, (name, hooks) in self._preserved_hooks.items():
1799
1540
setattr(klass, name, hooks)
1800
self._preserved_hooks.clear()
1801
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1802
self._preserved_lazy_hooks.clear()
1804
1542
def knownFailure(self, reason):
1805
"""Declare that this test fails for a known reason
1807
Tests that are known to fail should generally be using expectedFailure
1808
with an appropriate reverse assertion if a change could cause the test
1809
to start passing. Conversely if the test has no immediate prospect of
1810
succeeding then using skip is more suitable.
1812
When this method is called while an exception is being handled, that
1813
traceback will be used, otherwise a new exception will be thrown to
1814
provide one but won't be reported.
1816
self._add_reason(reason)
1818
exc_info = sys.exc_info()
1819
if exc_info != (None, None, None):
1820
self._report_traceback(exc_info)
1823
raise self.failureException(reason)
1824
except self.failureException:
1825
exc_info = sys.exc_info()
1826
# GZ 02-08-2011: Maybe cleanup this err.exc_info attribute too?
1827
raise testtools.testcase._ExpectedFailure(exc_info)
1831
def _suppress_log(self):
1832
"""Remove the log info from details."""
1833
self.discardDetail('log')
1543
"""This test has failed for some known reason."""
1544
raise KnownFailure(reason)
1835
1546
def _do_skip(self, result, reason):
1836
self._suppress_log()
1837
1547
addSkip = getattr(result, 'addSkip', None)
1838
1548
if not callable(addSkip):
1839
1549
result.addSuccess(result)
1918
1605
self._benchtime += time.time() - start
1920
1607
def log(self, *args):
1610
def _get_log(self, keep_log_file=False):
1611
"""Internal helper to get the log from bzrlib.trace for this test.
1613
Please use self.getDetails, or self.get_log to access this in test case
1616
:param keep_log_file: When True, if the log is still a file on disk
1617
leave it as a file on disk. When False, if the log is still a file
1618
on disk, the log file is deleted and the log preserved as
1620
:return: A string containing the log.
1622
if self._log_contents is not None:
1624
self._log_contents.decode('utf8')
1625
except UnicodeDecodeError:
1626
unicodestr = self._log_contents.decode('utf8', 'replace')
1627
self._log_contents = unicodestr.encode('utf8')
1628
return self._log_contents
1630
if bzrlib.trace._trace_file:
1631
# flush the log file, to get all content
1632
bzrlib.trace._trace_file.flush()
1633
if self._log_file_name is not None:
1634
logfile = open(self._log_file_name)
1636
log_contents = logfile.read()
1640
log_contents.decode('utf8')
1641
except UnicodeDecodeError:
1642
unicodestr = log_contents.decode('utf8', 'replace')
1643
log_contents = unicodestr.encode('utf8')
1644
if not keep_log_file:
1645
self._log_file.close()
1646
self._log_file = None
1647
# Permit multiple calls to get_log until we clean it up in
1649
self._log_contents = log_contents
1651
os.remove(self._log_file_name)
1653
if sys.platform == 'win32' and e.errno == errno.EACCES:
1654
sys.stderr.write(('Unable to delete log file '
1655
' %r\n' % self._log_file_name))
1658
self._log_file_name = None
1661
return "No log file content and no log file name."
1923
1663
def get_log(self):
1924
1664
"""Get a unicode string containing the log from bzrlib.trace.
2200
def _add_subprocess_log(self, log_file_path):
2201
if len(self._log_files) == 0:
2202
# Register an addCleanup func. We do this on the first call to
2203
# _add_subprocess_log rather than in TestCase.setUp so that this
2204
# addCleanup is registered after any cleanups for tempdirs that
2205
# subclasses might create, which will probably remove the log file
2207
self.addCleanup(self._subprocess_log_cleanup)
2208
# self._log_files is a set, so if a log file is reused we won't grab it
2210
self._log_files.add(log_file_path)
2212
def _subprocess_log_cleanup(self):
2213
for count, log_file_path in enumerate(self._log_files):
2214
# We use buffer_now=True to avoid holding the file open beyond
2215
# the life of this function, which might interfere with e.g.
2216
# cleaning tempdirs on Windows.
2217
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
2218
#detail_content = content.content_from_file(
2219
# log_file_path, buffer_now=True)
2220
with open(log_file_path, 'rb') as log_file:
2221
log_file_bytes = log_file.read()
2222
detail_content = content.Content(content.ContentType("text",
2223
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
2224
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
2227
1931
def _popen(self, *args, **kwargs):
2228
1932
"""Place a call to Popen.
2230
1934
Allows tests to override this method to intercept the calls made to
2231
1935
Popen for introspection.
2233
return subprocess.Popen(*args, **kwargs)
1937
return Popen(*args, **kwargs)
2235
1939
def get_source_path(self):
2236
1940
"""Return the path of the directory containing bzrlib."""
2266
1970
if retcode is not None and retcode != process.returncode:
2267
1971
if process_args is None:
2268
1972
process_args = "(unknown args)"
2269
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2270
trace.mutter('Error for bzr %s:\n%s', process_args, err)
1973
mutter('Output of bzr %s:\n%s', process_args, out)
1974
mutter('Error for bzr %s:\n%s', process_args, err)
2271
1975
self.fail('Command bzr %s failed with retcode %s != %s'
2272
1976
% (process_args, retcode, process.returncode))
2273
1977
return [out, err]
2275
def check_tree_shape(self, tree, shape):
2276
"""Compare a tree to a list of expected names.
1979
def check_inventory_shape(self, inv, shape):
1980
"""Compare an inventory to a list of expected names.
2278
1982
Fail if they are not precisely equal.
2281
1985
shape = list(shape) # copy
2282
for path, ie in tree.iter_entries_by_dir():
1986
for path, ie in inv.entries():
2283
1987
name = path.replace('\\', '/')
2284
1988
if ie.kind == 'directory':
2285
1989
name = name + '/'
2287
pass # ignore root entry
2289
1991
shape.remove(name)
2291
1993
extras.append(name)
2381
2089
class TestCaseWithMemoryTransport(TestCase):
2382
2090
"""Common test class for tests that do not need disk resources.
2384
Tests that need disk resources should derive from TestCaseInTempDir
2385
orTestCaseWithTransport.
2092
Tests that need disk resources should derive from TestCaseWithTransport.
2387
2094
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2389
For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
2096
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2390
2097
a directory which does not exist. This serves to help ensure test isolation
2391
is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
2392
must exist. However, TestCaseWithMemoryTransport does not offer local file
2393
defaults for the transport in tests, nor does it obey the command line
2098
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2099
must exist. However, TestCaseWithMemoryTransport does not offer local
2100
file defaults for the transport in tests, nor does it obey the command line
2394
2101
override, so tests that accidentally write to the common directory should
2397
:cvar TEST_ROOT: Directory containing all temporary directories, plus a
2398
``.bzr`` directory that stops us ascending higher into the filesystem.
2104
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2105
a .bzr directory that stops us ascending higher into the filesystem.
2401
2108
TEST_ROOT = None
2667
2367
test_home_dir = self.test_home_dir
2668
2368
if isinstance(test_home_dir, unicode):
2669
2369
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2670
self.overrideEnv('HOME', test_home_dir)
2671
self.overrideEnv('BZR_HOME', test_home_dir)
2370
os.environ['HOME'] = test_home_dir
2371
os.environ['BZR_HOME'] = test_home_dir
2673
2373
def setUp(self):
2674
2374
super(TestCaseWithMemoryTransport, self).setUp()
2675
# Ensure that ConnectedTransport doesn't leak sockets
2676
def get_transport_from_url_with_cleanup(*args, **kwargs):
2677
t = orig_get_transport_from_url(*args, **kwargs)
2678
if isinstance(t, _mod_transport.ConnectedTransport):
2679
self.addCleanup(t.disconnect)
2682
orig_get_transport_from_url = self.overrideAttr(
2683
_mod_transport, 'get_transport_from_url',
2684
get_transport_from_url_with_cleanup)
2685
2375
self._make_test_root()
2686
self.addCleanup(os.chdir, os.getcwdu())
2376
_currentdir = os.getcwdu()
2377
def _leaveDirectory():
2378
os.chdir(_currentdir)
2379
self.addCleanup(_leaveDirectory)
2687
2380
self.makeAndChdirToTestDir()
2688
2381
self.overrideEnvironmentForTesting()
2689
2382
self.__readonly_server = None
3453
3134
def partition_tests(suite, count):
3454
3135
"""Partition suite into count lists of tests."""
3455
# This just assigns tests in a round-robin fashion. On one hand this
3456
# splits up blocks of related tests that might run faster if they shared
3457
# resources, but on the other it avoids assigning blocks of slow tests to
3458
# just one partition. So the slowest partition shouldn't be much slower
3460
partitions = [list() for i in range(count)]
3461
tests = iter_suite_tests(suite)
3462
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3463
partition.append(test)
3467
def workaround_zealous_crypto_random():
3468
"""Crypto.Random want to help us being secure, but we don't care here.
3470
This workaround some test failure related to the sftp server. Once paramiko
3471
stop using the controversial API in Crypto.Random, we may get rid of it.
3474
from Crypto.Random import atfork
3137
tests = list(iter_suite_tests(suite))
3138
tests_per_process = int(math.ceil(float(len(tests)) / count))
3139
for block in range(count):
3140
low_test = block * tests_per_process
3141
high_test = low_test + tests_per_process
3142
process_tests = tests[low_test:high_test]
3143
result.append(process_tests)
3480
3147
def fork_for_tests(suite):
3590
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3254
class ForwardingResult(unittest.TestResult):
3256
def __init__(self, target):
3257
unittest.TestResult.__init__(self)
3258
self.result = target
3260
def startTest(self, test):
3261
self.result.startTest(test)
3263
def stopTest(self, test):
3264
self.result.stopTest(test)
3266
def startTestRun(self):
3267
self.result.startTestRun()
3269
def stopTestRun(self):
3270
self.result.stopTestRun()
3272
def addSkip(self, test, reason):
3273
self.result.addSkip(test, reason)
3275
def addSuccess(self, test):
3276
self.result.addSuccess(test)
3278
def addError(self, test, err):
3279
self.result.addError(test, err)
3281
def addFailure(self, test, err):
3282
self.result.addFailure(test, err)
3283
ForwardingResult = testtools.ExtendedToOriginalDecorator
3286
class ProfileResult(ForwardingResult):
3591
3287
"""Generate profiling data for all activity between start and success.
3593
3289
The profile data is appended to the test's _benchcalls attribute and can
3925
3608
'bzrlib.tests.test_chunk_writer',
3926
3609
'bzrlib.tests.test_clean_tree',
3927
3610
'bzrlib.tests.test_cleanup',
3928
'bzrlib.tests.test_cmdline',
3929
3611
'bzrlib.tests.test_commands',
3930
3612
'bzrlib.tests.test_commit',
3931
3613
'bzrlib.tests.test_commit_merge',
3932
3614
'bzrlib.tests.test_config',
3933
3615
'bzrlib.tests.test_conflicts',
3934
'bzrlib.tests.test_controldir',
3935
3616
'bzrlib.tests.test_counted_lock',
3936
3617
'bzrlib.tests.test_crash',
3937
3618
'bzrlib.tests.test_decorators',
3938
3619
'bzrlib.tests.test_delta',
3939
3620
'bzrlib.tests.test_debug',
3621
'bzrlib.tests.test_deprecated_graph',
3940
3622
'bzrlib.tests.test_diff',
3941
3623
'bzrlib.tests.test_directory_service',
3942
3624
'bzrlib.tests.test_dirstate',
3966
3644
'bzrlib.tests.test_http',
3967
3645
'bzrlib.tests.test_http_response',
3968
3646
'bzrlib.tests.test_https_ca_bundle',
3969
'bzrlib.tests.test_i18n',
3970
3647
'bzrlib.tests.test_identitymap',
3971
3648
'bzrlib.tests.test_ignores',
3972
3649
'bzrlib.tests.test_index',
3973
'bzrlib.tests.test_import_tariff',
3974
3650
'bzrlib.tests.test_info',
3975
3651
'bzrlib.tests.test_inv',
3976
3652
'bzrlib.tests.test_inventory_delta',
3977
3653
'bzrlib.tests.test_knit',
3978
3654
'bzrlib.tests.test_lazy_import',
3979
3655
'bzrlib.tests.test_lazy_regex',
3980
'bzrlib.tests.test_library_state',
3981
3656
'bzrlib.tests.test_lock',
3982
3657
'bzrlib.tests.test_lockable_files',
3983
3658
'bzrlib.tests.test_lockdir',
4199
3859
# Some tests mentioned in the list are not in the test suite. The
4200
3860
# list may be out of date, report to the tester.
4201
3861
for id in not_found:
4202
trace.warning('"%s" not found in the test suite', id)
3862
bzrlib.trace.warning('"%s" not found in the test suite', id)
4203
3863
for id in duplicates:
4204
trace.warning('"%s" is used as an id by several tests', id)
3864
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
4209
def multiply_scenarios(*scenarios):
4210
"""Multiply two or more iterables of scenarios.
4212
It is safe to pass scenario generators or iterators.
4214
:returns: A list of compound scenarios: the cross-product of all
4215
scenarios, with the names concatenated and the parameters
4218
return reduce(_multiply_two_scenarios, map(list, scenarios))
4221
def _multiply_two_scenarios(scenarios_left, scenarios_right):
3869
def multiply_scenarios(scenarios_left, scenarios_right):
4222
3870
"""Multiply two sets of scenarios.
4224
3872
:returns: the cartesian product of the two sets of scenarios, that is
4388
4023
if test_id != None:
4389
4024
ui.ui_factory.clear_term()
4390
4025
sys.stderr.write('\nWhile running: %s\n' % (test_id,))
4391
# Ugly, but the last thing we want here is fail, so bear with it.
4392
printable_e = str(e).decode(osutils.get_user_encoding(), 'replace'
4393
).encode('ascii', 'replace')
4394
4026
sys.stderr.write('Unable to remove testing dir %s\n%s'
4395
% (os.path.basename(dirname), printable_e))
4027
% (os.path.basename(dirname), e))
4030
class Feature(object):
4031
"""An operating system Feature."""
4034
self._available = None
4036
def available(self):
4037
"""Is the feature available?
4039
:return: True if the feature is available.
4041
if self._available is None:
4042
self._available = self._probe()
4043
return self._available
4046
"""Implement this method in concrete features.
4048
:return: True if the feature is available.
4050
raise NotImplementedError
4053
if getattr(self, 'feature_name', None):
4054
return self.feature_name()
4055
return self.__class__.__name__
4058
class _SymlinkFeature(Feature):
4061
return osutils.has_symlinks()
4063
def feature_name(self):
4066
SymlinkFeature = _SymlinkFeature()
4069
class _HardlinkFeature(Feature):
4072
return osutils.has_hardlinks()
4074
def feature_name(self):
4077
HardlinkFeature = _HardlinkFeature()
4080
class _OsFifoFeature(Feature):
4083
return getattr(os, 'mkfifo', None)
4085
def feature_name(self):
4086
return 'filesystem fifos'
4088
OsFifoFeature = _OsFifoFeature()
4091
class _UnicodeFilenameFeature(Feature):
4092
"""Does the filesystem support Unicode filenames?"""
4096
# Check for character combinations unlikely to be covered by any
4097
# single non-unicode encoding. We use the characters
4098
# - greek small letter alpha (U+03B1) and
4099
# - braille pattern dots-123456 (U+283F).
4100
os.stat(u'\u03b1\u283f')
4101
except UnicodeEncodeError:
4103
except (IOError, OSError):
4104
# The filesystem allows the Unicode filename but the file doesn't
4108
# The filesystem allows the Unicode filename and the file exists,
4112
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4115
class _CompatabilityThunkFeature(Feature):
4116
"""This feature is just a thunk to another feature.
4118
It issues a deprecation warning if it is accessed, to let you know that you
4119
should really use a different feature.
4122
def __init__(self, module, name, this_name, dep_version):
4123
super(_CompatabilityThunkFeature, self).__init__()
4124
self._module = module
4126
self._this_name = this_name
4127
self._dep_version = dep_version
4128
self._feature = None
4131
if self._feature is None:
4132
msg = (self._dep_version % self._this_name) + (
4133
' Use %s.%s instead.' % (self._module, self._name))
4134
symbol_versioning.warn(msg, DeprecationWarning)
4135
mod = __import__(self._module, {}, {}, [self._name])
4136
self._feature = getattr(mod, self._name)
4140
return self._feature._probe()
4143
class ModuleAvailableFeature(Feature):
4144
"""This is a feature than describes a module we want to be available.
4146
Declare the name of the module in __init__(), and then after probing, the
4147
module will be available as 'self.module'.
4149
:ivar module: The module if it is available, else None.
4152
def __init__(self, module_name):
4153
super(ModuleAvailableFeature, self).__init__()
4154
self.module_name = module_name
4158
self._module = __import__(self.module_name, {}, {}, [''])
4165
if self.available(): # Make sure the probe has been done
4169
def feature_name(self):
4170
return self.module_name
4173
# This is kept here for compatibility, it is recommended to use
4174
# 'bzrlib.tests.feature.paramiko' instead
4175
ParamikoFeature = _CompatabilityThunkFeature('bzrlib.tests.features',
4176
'paramiko', 'bzrlib.tests.ParamikoFeature', deprecated_in((2,1,0)))
4398
4179
def probe_unicode_in_user_encoding():
4212
class _HTTPSServerFeature(Feature):
4213
"""Some tests want an https Server, check if one is available.
4215
Right now, the only way this is available is under python2.6 which provides
4226
def feature_name(self):
4227
return 'HTTPSServer'
4230
HTTPSServerFeature = _HTTPSServerFeature()
4233
class _UnicodeFilename(Feature):
4234
"""Does the filesystem support Unicode filenames?"""
4239
except UnicodeEncodeError:
4241
except (IOError, OSError):
4242
# The filesystem allows the Unicode filename but the file doesn't
4246
# The filesystem allows the Unicode filename and the file exists,
4250
UnicodeFilename = _UnicodeFilename()
4253
class _UTF8Filesystem(Feature):
4254
"""Is the filesystem UTF-8?"""
4257
if osutils._fs_enc.upper() in ('UTF-8', 'UTF8'):
4261
UTF8Filesystem = _UTF8Filesystem()
4264
class _BreakinFeature(Feature):
4265
"""Does this platform support the breakin feature?"""
4268
from bzrlib import breakin
4269
if breakin.determine_signal() is None:
4271
if sys.platform == 'win32':
4272
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4273
# We trigger SIGBREAK via a Console api so we need ctypes to
4274
# access the function
4281
def feature_name(self):
4282
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4285
BreakinFeature = _BreakinFeature()
4288
class _CaseInsCasePresFilenameFeature(Feature):
4289
"""Is the file-system case insensitive, but case-preserving?"""
4292
fileno, name = tempfile.mkstemp(prefix='MixedCase')
4294
# first check truly case-preserving for created files, then check
4295
# case insensitive when opening existing files.
4296
name = osutils.normpath(name)
4297
base, rel = osutils.split(name)
4298
found_rel = osutils.canonical_relpath(base, name)
4299
return (found_rel == rel
4300
and os.path.isfile(name.upper())
4301
and os.path.isfile(name.lower()))
4306
def feature_name(self):
4307
return "case-insensitive case-preserving filesystem"
4309
CaseInsCasePresFilenameFeature = _CaseInsCasePresFilenameFeature()
4312
class _CaseInsensitiveFilesystemFeature(Feature):
4313
"""Check if underlying filesystem is case-insensitive but *not* case
4316
# Note that on Windows, Cygwin, MacOS etc, the file-systems are far
4317
# more likely to be case preserving, so this case is rare.
4320
if CaseInsCasePresFilenameFeature.available():
4323
if TestCaseWithMemoryTransport.TEST_ROOT is None:
4324
root = osutils.mkdtemp(prefix='testbzr-', suffix='.tmp')
4325
TestCaseWithMemoryTransport.TEST_ROOT = root
4327
root = TestCaseWithMemoryTransport.TEST_ROOT
4328
tdir = osutils.mkdtemp(prefix='case-sensitive-probe-', suffix='',
4330
name_a = osutils.pathjoin(tdir, 'a')
4331
name_A = osutils.pathjoin(tdir, 'A')
4333
result = osutils.isdir(name_A)
4334
_rmtree_temp_dir(tdir)
4337
def feature_name(self):
4338
return 'case-insensitive filesystem'
4340
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4343
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4344
SubUnitFeature = _CompatabilityThunkFeature('bzrlib.tests.features', 'subunit',
4345
'bzrlib.tests.SubUnitFeature', deprecated_in((2,1,0)))
4431
4346
# Only define SubUnitBzrRunner if subunit is available.
4433
4348
from subunit import TestProtocolClient
4434
4349
from subunit.test_results import AutoTimingTestResultDecorator
4435
class SubUnitBzrProtocolClient(TestProtocolClient):
4437
def addSuccess(self, test, details=None):
4438
# The subunit client always includes the details in the subunit
4439
# stream, but we don't want to include it in ours.
4440
if details is not None and 'log' in details:
4442
return super(SubUnitBzrProtocolClient, self).addSuccess(
4445
4350
class SubUnitBzrRunner(TextTestRunner):
4446
4351
def run(self, test):
4447
4352
result = AutoTimingTestResultDecorator(
4448
SubUnitBzrProtocolClient(self.stream))
4353
TestProtocolClient(self.stream))
4449
4354
test.run(result)
4451
4356
except ImportError:
4455
@deprecated_function(deprecated_in((2, 5, 0)))
4456
def ModuleAvailableFeature(name):
4457
from bzrlib.tests import features
4458
return features.ModuleAvailableFeature(name)
added
removed
bzrlib/tests/__init__.py
