56
55
# nb: check this before importing anything else from within it
57
56
_testtools_version = getattr(testtools, '__version__', ())
58
if _testtools_version < (0, 9, 5):
59
raise ImportError("need at least testtools 0.9.5: %s is %r"
57
if _testtools_version < (0, 9, 2):
58
raise ImportError("need at least testtools 0.9.2: %s is %r"
60
59
% (testtools.__file__, _testtools_version))
61
60
from testtools import content
64
62
from bzrlib import (
68
commands as _mod_commands,
77
plugin as _mod_plugin,
84
77
transport as _mod_transport,
81
import bzrlib.commands
82
import bzrlib.timestamp
84
import bzrlib.inventory
85
import bzrlib.iterablefile
88
88
import bzrlib.lsprof
89
89
except ImportError:
90
90
# lsprof not available
92
from bzrlib.smart import client, request
92
from bzrlib.merge import merge_inner
95
from bzrlib.smart import client, request, server
97
from bzrlib import symbol_versioning
98
from bzrlib.symbol_versioning import (
93
106
from bzrlib.transport import (
110
from bzrlib.trace import mutter, note
97
111
from bzrlib.tests import (
118
134
SUBUNIT_SEEK_SET = 0
119
135
SUBUNIT_SEEK_CUR = 1
121
# These are intentionally brought into this namespace. That way plugins, etc
122
# can just "from bzrlib.tests import TestCase, TestLoader, etc"
123
TestSuite = TestUtil.TestSuite
124
TestLoader = TestUtil.TestLoader
126
# Tests should run in a clean and clearly defined environment. The goal is to
127
# keep them isolated from the running environment as mush as possible. The test
128
# framework ensures the variables defined below are set (or deleted if the
129
# value is None) before a test is run and reset to their original value after
130
# the test is run. Generally if some code depends on an environment variable,
131
# the tests should start without this variable in the environment. There are a
132
# few exceptions but you shouldn't violate this rule lightly.
136
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
137
# tests do check our impls match APPDATA
138
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
142
'BZREMAIL': None, # may still be present in the environment
143
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
144
'BZR_PROGRESS_BAR': None,
145
# This should trap leaks to ~/.bzr.log. This occurs when tests use TestCase
146
# as a base class instead of TestCaseInTempDir. Tests inheriting from
147
# TestCase should not use disk resources, BZR_LOG is one.
148
'BZR_LOG': '/you-should-use-TestCaseInTempDir-if-you-need-a-log-file',
149
'BZR_PLUGIN_PATH': None,
150
'BZR_DISABLE_PLUGINS': None,
151
'BZR_PLUGINS_AT': None,
152
'BZR_CONCURRENCY': None,
153
# Make sure that any text ui tests are consistent regardless of
154
# the environment the test case is run in; you may want tests that
155
# test other combinations. 'dumb' is a reasonable guess for tests
156
# going to a pipe or a StringIO.
162
'SSH_AUTH_SOCK': None,
172
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
173
# least. If you do (care), please update this comment
177
'BZR_REMOTE_PATH': None,
178
# Generally speaking, we don't want apport reporting on crashes in
179
# the test envirnoment unless we're specifically testing apport,
180
# so that it doesn't leak into the real system environment. We
181
# use an env var so it propagates to subprocesses.
182
'APPORT_DISABLE': '1',
186
def override_os_environ(test, env=None):
187
"""Modify os.environ keeping a copy.
189
:param test: A test instance
191
:param env: A dict containing variable definitions to be installed
194
env = isolated_environ
195
test._original_os_environ = dict([(var, value)
196
for var, value in os.environ.iteritems()])
197
for var, value in env.iteritems():
198
osutils.set_or_unset_env(var, value)
199
if var not in test._original_os_environ:
200
# The var is new, add it with a value of None, so
201
# restore_os_environ will delete it
202
test._original_os_environ[var] = None
205
def restore_os_environ(test):
206
"""Restore os.environ to its original state.
208
:param test: A test instance previously passed to override_os_environ.
210
for var, value in test._original_os_environ.iteritems():
211
# Restore the original value (or delete it if the value has been set to
212
# None in override_os_environ).
213
osutils.set_or_unset_env(var, value)
216
class ExtendedTestResult(testtools.TextTestResult):
138
class ExtendedTestResult(unittest._TextTestResult):
217
139
"""Accepts, reports and accumulates the results of running tests.
219
141
Compared to the unittest version this class adds support for
268
190
self._overall_start_time = time.time()
269
191
self._strict = strict
270
self._first_thread_leaker_id = None
271
self._tests_leaking_threads_count = 0
272
self._traceback_from_test = None
274
193
def stopTestRun(self):
275
194
run = self.testsRun
276
195
actionTaken = "Ran"
277
196
stopTime = time.time()
278
197
timeTaken = stopTime - self.startTime
279
# GZ 2010-07-19: Seems testtools has no printErrors method, and though
280
# the parent class method is similar have to duplicate
281
self._show_list('ERROR', self.errors)
282
self._show_list('FAIL', self.failures)
283
self.stream.write(self.sep2)
284
self.stream.write("%s %d test%s in %.3fs\n\n" % (actionTaken,
199
self.stream.writeln(self.separator2)
200
self.stream.writeln("%s %d test%s in %.3fs" % (actionTaken,
285
201
run, run != 1 and "s" or "", timeTaken))
202
self.stream.writeln()
286
203
if not self.wasSuccessful():
287
204
self.stream.write("FAILED (")
288
205
failed, errored = map(len, (self.failures, self.errors))
295
212
if failed or errored: self.stream.write(", ")
296
213
self.stream.write("known_failure_count=%d" %
297
214
self.known_failure_count)
298
self.stream.write(")\n")
215
self.stream.writeln(")")
300
217
if self.known_failure_count:
301
self.stream.write("OK (known_failures=%d)\n" %
218
self.stream.writeln("OK (known_failures=%d)" %
302
219
self.known_failure_count)
304
self.stream.write("OK\n")
221
self.stream.writeln("OK")
305
222
if self.skip_count > 0:
306
223
skipped = self.skip_count
307
self.stream.write('%d test%s skipped\n' %
224
self.stream.writeln('%d test%s skipped' %
308
225
(skipped, skipped != 1 and "s" or ""))
309
226
if self.unsupported:
310
227
for feature, count in sorted(self.unsupported.items()):
311
self.stream.write("Missing feature '%s' skipped %d tests.\n" %
228
self.stream.writeln("Missing feature '%s' skipped %d tests." %
312
229
(feature, count))
314
231
ok = self.wasStrictlySuccessful()
316
233
ok = self.wasSuccessful()
317
if self._first_thread_leaker_id:
234
if TestCase._first_thread_leaker_id:
318
235
self.stream.write(
319
236
'%s is leaking threads among %d leaking tests.\n' % (
320
self._first_thread_leaker_id,
321
self._tests_leaking_threads_count))
237
TestCase._first_thread_leaker_id,
238
TestCase._leaking_threads_tests))
322
239
# We don't report the main thread as an active one.
323
240
self.stream.write(
324
241
'%d non-main threads were left active in the end.\n'
325
% (len(self._active_threads) - 1))
242
% (TestCase._active_threads - 1))
327
244
def getDescription(self, test):
354
270
def _shortened_test_description(self, test):
356
what = re.sub(r'^bzrlib\.tests\.', '', what)
272
what = re.sub(r'^bzrlib\.(tests|benchmarks)\.', '', what)
359
# GZ 2010-10-04: Cloned tests may end up harmlessly calling this method
360
# multiple times in a row, because the handler is added for
361
# each test but the container list is shared between cases.
362
# See lp:498869 lp:625574 and lp:637725 for background.
363
def _record_traceback_from_test(self, exc_info):
364
"""Store the traceback from passed exc_info tuple till"""
365
self._traceback_from_test = exc_info[2]
367
275
def startTest(self, test):
368
super(ExtendedTestResult, self).startTest(test)
276
unittest.TestResult.startTest(self, test)
369
277
if self.count == 0:
370
278
self.startTests()
372
279
self.report_test_start(test)
373
280
test.number = self.count
374
281
self._recordTestStartTime()
375
# Make testtools cases give us the real traceback on failure
376
addOnException = getattr(test, "addOnException", None)
377
if addOnException is not None:
378
addOnException(self._record_traceback_from_test)
379
# Only check for thread leaks on bzrlib derived test cases
380
if isinstance(test, TestCase):
381
test.addCleanup(self._check_leaked_threads, test)
383
def stopTest(self, test):
384
super(ExtendedTestResult, self).stopTest(test)
385
# Manually break cycles, means touching various private things but hey
386
getDetails = getattr(test, "getDetails", None)
387
if getDetails is not None:
389
type_equality_funcs = getattr(test, "_type_equality_funcs", None)
390
if type_equality_funcs is not None:
391
type_equality_funcs.clear()
392
self._traceback_from_test = None
394
283
def startTests(self):
395
self.report_tests_starting()
396
self._active_threads = threading.enumerate()
398
def _check_leaked_threads(self, test):
399
"""See if any threads have leaked since last call
401
A sample of live threads is stored in the _active_threads attribute,
402
when this method runs it compares the current live threads and any not
403
in the previous sample are treated as having leaked.
405
now_active_threads = set(threading.enumerate())
406
threads_leaked = now_active_threads.difference(self._active_threads)
408
self._report_thread_leak(test, threads_leaked, now_active_threads)
409
self._tests_leaking_threads_count += 1
410
if self._first_thread_leaker_id is None:
411
self._first_thread_leaker_id = test.id()
412
self._active_threads = now_active_threads
285
if getattr(sys, 'frozen', None) is None:
286
bzr_path = osutils.realpath(sys.argv[0])
288
bzr_path = sys.executable
290
'bzr selftest: %s\n' % (bzr_path,))
293
bzrlib.__path__[0],))
295
' bzr-%s python-%s %s\n' % (
296
bzrlib.version_string,
297
bzrlib._format_version_tuple(sys.version_info),
298
platform.platform(aliased=1),
300
self.stream.write('\n')
414
302
def _recordTestStartTime(self):
415
303
"""Record that a test has started."""
416
self._start_datetime = self._now()
304
self._start_time = time.time()
306
def _cleanupLogFile(self, test):
307
# We can only do this if we have one of our TestCases, not if
309
setKeepLogfile = getattr(test, 'setKeepLogfile', None)
310
if setKeepLogfile is not None:
418
313
def addError(self, test, err):
419
314
"""Tell result that test finished with an error.
453
350
self._formatTime(benchmark_time),
455
352
self.report_success(test)
456
super(ExtendedTestResult, self).addSuccess(test)
353
self._cleanupLogFile(test)
354
unittest.TestResult.addSuccess(self, test)
457
355
test._log_contents = ''
459
357
def addExpectedFailure(self, test, err):
460
358
self.known_failure_count += 1
461
359
self.report_known_failure(test, err)
463
def addUnexpectedSuccess(self, test, details=None):
464
"""Tell result the test unexpectedly passed, counting as a failure
466
When the minimum version of testtools required becomes 0.9.8 this
467
can be updated to use the new handling there.
469
super(ExtendedTestResult, self).addFailure(test, details=details)
470
self.failure_count += 1
471
self.report_unexpected_success(test,
472
"".join(details["reason"].iter_text()))
476
361
def addNotSupported(self, test, feature):
477
362
"""The test will not be run because of a missing feature.
511
395
raise errors.BzrError("Unknown whence %r" % whence)
513
def report_tests_starting(self):
514
"""Display information before the test run begins"""
515
if getattr(sys, 'frozen', None) is None:
516
bzr_path = osutils.realpath(sys.argv[0])
518
bzr_path = sys.executable
520
'bzr selftest: %s\n' % (bzr_path,))
523
bzrlib.__path__[0],))
525
' bzr-%s python-%s %s\n' % (
526
bzrlib.version_string,
527
bzrlib._format_version_tuple(sys.version_info),
528
platform.platform(aliased=1),
530
self.stream.write('\n')
532
def report_test_start(self, test):
533
"""Display information on the test just about to be run"""
535
def _report_thread_leak(self, test, leaked_threads, active_threads):
536
"""Display information on a test that leaked one or more threads"""
537
# GZ 2010-09-09: A leak summary reported separately from the general
538
# thread debugging would be nice. Tests under subunit
539
# need something not using stream, perhaps adding a
540
# testtools details object would be fitting.
541
if 'threads' in selftest_debug_flags:
542
self.stream.write('%s is leaking, active is now %d\n' %
543
(test.id(), len(active_threads)))
397
def report_cleaning_up(self):
545
400
def startTestRun(self):
546
401
self.startTime = time.time()
687
545
return '%s%s' % (indent, err[1])
689
547
def report_error(self, test, err):
690
self.stream.write('ERROR %s\n%s\n'
548
self.stream.writeln('ERROR %s\n%s'
691
549
% (self._testTimeString(test),
692
550
self._error_summary(err)))
694
552
def report_failure(self, test, err):
695
self.stream.write(' FAIL %s\n%s\n'
553
self.stream.writeln(' FAIL %s\n%s'
696
554
% (self._testTimeString(test),
697
555
self._error_summary(err)))
699
557
def report_known_failure(self, test, err):
700
self.stream.write('XFAIL %s\n%s\n'
558
self.stream.writeln('XFAIL %s\n%s'
701
559
% (self._testTimeString(test),
702
560
self._error_summary(err)))
704
def report_unexpected_success(self, test, reason):
705
self.stream.write(' FAIL %s\n%s: %s\n'
706
% (self._testTimeString(test),
707
"Unexpected success. Should have failed",
710
562
def report_success(self, test):
711
self.stream.write(' OK %s\n' % self._testTimeString(test))
563
self.stream.writeln(' OK %s' % self._testTimeString(test))
712
564
for bench_called, stats in getattr(test, '_benchcalls', []):
713
self.stream.write('LSProf output for %s(%s, %s)\n' % bench_called)
565
self.stream.writeln('LSProf output for %s(%s, %s)' % bench_called)
714
566
stats.pprint(file=self.stream)
715
567
# flush the stream so that we get smooth output. This verbose mode is
716
568
# used to show the output in PQM.
717
569
self.stream.flush()
719
571
def report_skip(self, test, reason):
720
self.stream.write(' SKIP %s\n%s\n'
572
self.stream.writeln(' SKIP %s\n%s'
721
573
% (self._testTimeString(test), reason))
723
575
def report_not_applicable(self, test, reason):
724
self.stream.write(' N/A %s\n %s\n'
576
self.stream.writeln(' N/A %s\n %s'
725
577
% (self._testTimeString(test), reason))
727
579
def report_unsupported(self, test, feature):
728
580
"""test cannot be run because feature is missing."""
729
self.stream.write("NODEP %s\n The feature '%s' is not available.\n"
581
self.stream.writeln("NODEP %s\n The feature '%s' is not available."
730
582
%(self._testTimeString(test), feature))
953
783
routine, and to build and check bzr trees.
955
785
In addition to the usual method of overriding tearDown(), this class also
956
allows subclasses to register cleanup functions via addCleanup, which are
786
allows subclasses to register functions into the _cleanups list, which is
957
787
run in order as the object is torn down. It's less likely this will be
958
788
accidentally overlooked.
791
_active_threads = None
792
_leaking_threads_tests = 0
793
_first_thread_leaker_id = None
794
_log_file_name = None
962
795
# record lsprof data when performing benchmark calls.
963
796
_gather_lsprof_in_benchmarks = False
965
798
def __init__(self, methodName='testMethod'):
966
799
super(TestCase, self).__init__(methodName)
967
801
self._directory_isolation = True
968
802
self.exception_handlers.insert(0,
969
803
(UnavailableFeature, self._do_unsupported_or_skip))
983
821
self._track_transports()
984
822
self._track_locks()
985
823
self._clear_debug_flags()
986
# Isolate global verbosity level, to make sure it's reproducible
987
# between tests. We should get rid of this altogether: bug 656694. --
989
self.overrideAttr(bzrlib.trace, '_verbosity_level', 0)
990
# Isolate config option expansion until its default value for bzrlib is
991
# settled on or a the FIXME associated with _get_expand_default_value
992
# is addressed -- vila 20110219
993
self.overrideAttr(config, '_expand_default_value', None)
994
self._log_files = set()
995
# Each key in the ``_counters`` dict holds a value for a different
996
# counter. When the test ends, addDetail() should be used to output the
997
# counter values. This happens in install_counter_hook().
999
if 'config_stats' in selftest_debug_flags:
1000
self._install_config_stats_hooks()
824
TestCase._active_threads = threading.activeCount()
825
self.addCleanup(self._check_leaked_threads)
1002
827
def debug(self):
1003
828
# debug a frame up.
1005
830
pdb.Pdb().set_trace(sys._getframe().f_back)
1007
def discardDetail(self, name):
1008
"""Extend the addDetail, getDetails api so we can remove a detail.
1010
eg. bzr always adds the 'log' detail at startup, but we don't want to
1011
include it for skipped, xfail, etc tests.
1013
It is safe to call this for a detail that doesn't exist, in case this
1014
gets called multiple times.
1016
# We cheat. details is stored in __details which means we shouldn't
1017
# touch it. but getDetails() returns the dict directly, so we can
1019
details = self.getDetails()
1023
def install_counter_hook(self, hooks, name, counter_name=None):
1024
"""Install a counting hook.
1026
Any hook can be counted as long as it doesn't need to return a value.
1028
:param hooks: Where the hook should be installed.
1030
:param name: The hook name that will be counted.
1032
:param counter_name: The counter identifier in ``_counters``, defaults
1035
_counters = self._counters # Avoid closing over self
1036
if counter_name is None:
1038
if _counters.has_key(counter_name):
1039
raise AssertionError('%s is already used as a counter name'
1041
_counters[counter_name] = 0
1042
self.addDetail(counter_name, content.Content(content.UTF8_TEXT,
1043
lambda: ['%d' % (_counters[counter_name],)]))
1044
def increment_counter(*args, **kwargs):
1045
_counters[counter_name] += 1
1046
label = 'count %s calls' % (counter_name,)
1047
hooks.install_named_hook(name, increment_counter, label)
1048
self.addCleanup(hooks.uninstall_named_hook, name, label)
1050
def _install_config_stats_hooks(self):
1051
"""Install config hooks to count hook calls.
1054
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1055
self.install_counter_hook(config.ConfigHooks, hook_name,
1056
'config.%s' % (hook_name,))
1058
# The OldConfigHooks are private and need special handling to protect
1059
# against recursive tests (tests that run other tests), so we just do
1060
# manually what registering them into _builtin_known_hooks will provide
1062
self.overrideAttr(config, 'OldConfigHooks', config._OldConfigHooks())
1063
for hook_name in ('get', 'set', 'remove', 'load', 'save'):
1064
self.install_counter_hook(config.OldConfigHooks, hook_name,
1065
'old_config.%s' % (hook_name,))
832
def _check_leaked_threads(self):
833
active = threading.activeCount()
834
leaked_threads = active - TestCase._active_threads
835
TestCase._active_threads = active
836
# If some tests make the number of threads *decrease*, we'll consider
837
# that they are just observing old threads dieing, not agressively kill
838
# random threads. So we don't report these tests as leaking. The risk
839
# is that we have false positives that way (the test see 2 threads
840
# going away but leak one) but it seems less likely than the actual
841
# false positives (the test see threads going away and does not leak).
842
if leaked_threads > 0:
843
if 'threads' in selftest_debug_flags:
844
print '%s is leaking, active is now %d' % (self.id(), active)
845
TestCase._leaking_threads_tests += 1
846
if TestCase._first_thread_leaker_id is None:
847
TestCase._first_thread_leaker_id = self.id()
1067
849
def _clear_debug_flags(self):
1068
850
"""Prevent externally set debug flags affecting tests.
1080
862
def _clear_hooks(self):
1081
863
# prevent hooks affecting tests
1082
known_hooks = hooks.known_hooks
1083
864
self._preserved_hooks = {}
1084
for key, (parent, name) in known_hooks.iter_parent_objects():
1085
current_hooks = getattr(parent, name)
865
for key, factory in hooks.known_hooks.items():
866
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
867
current_hooks = hooks.known_hooks_key_to_object(key)
1086
868
self._preserved_hooks[parent] = (name, current_hooks)
1087
self._preserved_lazy_hooks = hooks._lazy_hooks
1088
hooks._lazy_hooks = {}
1089
869
self.addCleanup(self._restoreHooks)
1090
for key, (parent, name) in known_hooks.iter_parent_objects():
1091
factory = known_hooks.get(key)
870
for key, factory in hooks.known_hooks.items():
871
parent, name = hooks.known_hooks_key_to_parent_and_attribute(key)
1092
872
setattr(parent, name, factory())
1093
873
# this hook should always be installed
1094
874
request._install_hook()
1355
1131
'st_mtime did not match')
1356
1132
self.assertEqual(expected.st_ctime, actual.st_ctime,
1357
1133
'st_ctime did not match')
1358
if sys.platform == 'win32':
1134
if sys.platform != 'win32':
1359
1135
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1360
1136
# is 'dev' that varies, in python 2.5 (6?) it is st_ino that is
1361
# odd. We just force it to always be 0 to avoid any problems.
1362
self.assertEqual(0, expected.st_dev)
1363
self.assertEqual(0, actual.st_dev)
1364
self.assertEqual(0, expected.st_ino)
1365
self.assertEqual(0, actual.st_ino)
1137
# odd. Regardless we shouldn't actually try to assert anything
1138
# about their values
1367
1139
self.assertEqual(expected.st_dev, actual.st_dev,
1368
1140
'st_dev did not match')
1369
1141
self.assertEqual(expected.st_ino, actual.st_ino,
1378
1150
length, len(obj_with_len), obj_with_len))
1380
1152
def assertLogsError(self, exception_class, func, *args, **kwargs):
1381
"""Assert that `func(*args, **kwargs)` quietly logs a specific error.
1153
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1155
from bzrlib import trace
1384
1157
orig_log_exception_quietly = trace.log_exception_quietly
1387
1160
orig_log_exception_quietly()
1388
captured.append(sys.exc_info()[1])
1161
captured.append(sys.exc_info())
1389
1162
trace.log_exception_quietly = capture
1390
1163
func(*args, **kwargs)
1392
1165
trace.log_exception_quietly = orig_log_exception_quietly
1393
1166
self.assertLength(1, captured)
1167
err = captured[0][1]
1395
1168
self.assertIsInstance(err, exception_class)
1549
1318
self.assertEqual(expected_docstring, obj.__doc__)
1551
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1552
1320
def failUnlessExists(self, path):
1553
return self.assertPathExists(path)
1555
def assertPathExists(self, path):
1556
1321
"""Fail unless path or paths, which may be abs or relative, exist."""
1557
1322
if not isinstance(path, basestring):
1559
self.assertPathExists(p)
1324
self.failUnlessExists(p)
1561
self.assertTrue(osutils.lexists(path),
1562
path + " does not exist")
1326
self.failUnless(osutils.lexists(path),path+" does not exist")
1564
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4)))
1565
1328
def failIfExists(self, path):
1566
return self.assertPathDoesNotExist(path)
1568
def assertPathDoesNotExist(self, path):
1569
1329
"""Fail if path or paths, which may be abs or relative, exist."""
1570
1330
if not isinstance(path, basestring):
1572
self.assertPathDoesNotExist(p)
1332
self.failIfExists(p)
1574
self.assertFalse(osutils.lexists(path),
1334
self.failIf(osutils.lexists(path),path+" exists")
1577
1336
def _capture_deprecation_warnings(self, a_callable, *args, **kwargs):
1578
1337
"""A helper for callDeprecated and applyDeprecated.
1694
1452
The file is removed as the test is torn down.
1696
pseudo_log_file = StringIO()
1697
def _get_log_contents_for_weird_testtools_api():
1698
return [pseudo_log_file.getvalue().decode(
1699
"utf-8", "replace").encode("utf-8")]
1700
self.addDetail("log", content.Content(content.ContentType("text",
1701
"plain", {"charset": "utf8"}),
1702
_get_log_contents_for_weird_testtools_api))
1703
self._log_file = pseudo_log_file
1704
self._log_memento = trace.push_log_file(self._log_file)
1454
fileno, name = tempfile.mkstemp(suffix='.log', prefix='testbzr')
1455
self._log_file = os.fdopen(fileno, 'w+')
1456
self._log_memento = bzrlib.trace.push_log_file(self._log_file)
1457
self._log_file_name = name
1705
1458
self.addCleanup(self._finishLogFile)
1707
1460
def _finishLogFile(self):
1708
1461
"""Finished with the log file.
1710
Close the file and delete it.
1463
Close the file and delete it, unless setKeepLogfile was called.
1712
if trace._trace_file:
1465
if bzrlib.trace._trace_file:
1713
1466
# flush the log file, to get all content
1714
trace._trace_file.flush()
1715
trace.pop_log_file(self._log_memento)
1467
bzrlib.trace._trace_file.flush()
1468
bzrlib.trace.pop_log_file(self._log_memento)
1469
# Cache the log result and delete the file on disk
1470
self._get_log(False)
1717
1472
def thisFailsStrictLockCheck(self):
1718
1473
"""It is known that this test would fail with -Dstrict_locks.
1746
1509
setattr(obj, attr_name, new)
1749
def overrideEnv(self, name, new):
1750
"""Set an environment variable, and reset it after the test.
1752
:param name: The environment variable name.
1754
:param new: The value to set the variable to. If None, the
1755
variable is deleted from the environment.
1757
:returns: The actual variable value.
1759
value = osutils.set_or_unset_env(name, new)
1760
self.addCleanup(osutils.set_or_unset_env, name, value)
1763
1512
def _cleanEnvironment(self):
1764
for name, value in isolated_environ.iteritems():
1765
self.overrideEnv(name, value)
1514
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1515
'HOME': os.getcwd(),
1516
# bzr now uses the Win32 API and doesn't rely on APPDATA, but the
1517
# tests do check our impls match APPDATA
1518
'BZR_EDITOR': None, # test_msgeditor manipulates this variable
1522
'BZREMAIL': None, # may still be present in the environment
1523
'EMAIL': 'jrandom@example.com', # set EMAIL as bzr does not guess
1524
'BZR_PROGRESS_BAR': None,
1526
'BZR_PLUGIN_PATH': None,
1527
'BZR_DISABLE_PLUGINS': None,
1528
'BZR_PLUGINS_AT': None,
1529
'BZR_CONCURRENCY': None,
1530
# Make sure that any text ui tests are consistent regardless of
1531
# the environment the test case is run in; you may want tests that
1532
# test other combinations. 'dumb' is a reasonable guess for tests
1533
# going to a pipe or a StringIO.
1537
'BZR_COLUMNS': '80',
1539
'SSH_AUTH_SOCK': None,
1543
'https_proxy': None,
1544
'HTTPS_PROXY': None,
1549
# Nobody cares about ftp_proxy, FTP_PROXY AFAIK. So far at
1550
# least. If you do (care), please update this comment
1554
'BZR_REMOTE_PATH': None,
1555
# Generally speaking, we don't want apport reporting on crashes in
1556
# the test envirnoment unless we're specifically testing apport,
1557
# so that it doesn't leak into the real system environment. We
1558
# use an env var so it propagates to subprocesses.
1559
'APPORT_DISABLE': '1',
1562
self.addCleanup(self._restoreEnvironment)
1563
for name, value in new_env.iteritems():
1564
self._captureVar(name, value)
1566
def _captureVar(self, name, newvalue):
1567
"""Set an environment variable, and reset it when finished."""
1568
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1570
def _restoreEnvironment(self):
1571
for name, value in self._old_env.iteritems():
1572
osutils.set_or_unset_env(name, value)
1767
1574
def _restoreHooks(self):
1768
1575
for klass, (name, hooks) in self._preserved_hooks.items():
1769
1576
setattr(klass, name, hooks)
1770
self._preserved_hooks.clear()
1771
bzrlib.hooks._lazy_hooks = self._preserved_lazy_hooks
1772
self._preserved_lazy_hooks.clear()
1774
1578
def knownFailure(self, reason):
1775
1579
"""This test has failed for some known reason."""
1776
1580
raise KnownFailure(reason)
1778
def _suppress_log(self):
1779
"""Remove the log info from details."""
1780
self.discardDetail('log')
1782
1582
def _do_skip(self, result, reason):
1783
self._suppress_log()
1784
1583
addSkip = getattr(result, 'addSkip', None)
1785
1584
if not callable(addSkip):
1786
1585
result.addSuccess(result)
1811
1608
self._do_skip(result, reason)
1814
def _report_skip(self, result, err):
1815
"""Override the default _report_skip.
1817
We want to strip the 'log' detail. If we waint until _do_skip, it has
1818
already been formatted into the 'reason' string, and we can't pull it
1821
self._suppress_log()
1822
super(TestCase, self)._report_skip(self, result, err)
1825
def _report_expected_failure(self, result, err):
1828
See _report_skip for motivation.
1830
self._suppress_log()
1831
super(TestCase, self)._report_expected_failure(self, result, err)
1834
1611
def _do_unsupported_or_skip(self, result, e):
1835
1612
reason = e.args[0]
1836
self._suppress_log()
1837
1613
addNotSupported = getattr(result, 'addNotSupported', None)
1838
1614
if addNotSupported is not None:
1839
1615
result.addNotSupported(self, reason)
1865
1641
self._benchtime += time.time() - start
1867
1643
def log(self, *args):
1646
def _get_log(self, keep_log_file=False):
1647
"""Internal helper to get the log from bzrlib.trace for this test.
1649
Please use self.getDetails, or self.get_log to access this in test case
1652
:param keep_log_file: When True, if the log is still a file on disk
1653
leave it as a file on disk. When False, if the log is still a file
1654
on disk, the log file is deleted and the log preserved as
1656
:return: A string containing the log.
1658
if self._log_contents is not None:
1660
self._log_contents.decode('utf8')
1661
except UnicodeDecodeError:
1662
unicodestr = self._log_contents.decode('utf8', 'replace')
1663
self._log_contents = unicodestr.encode('utf8')
1664
return self._log_contents
1666
if bzrlib.trace._trace_file:
1667
# flush the log file, to get all content
1668
bzrlib.trace._trace_file.flush()
1669
if self._log_file_name is not None:
1670
logfile = open(self._log_file_name)
1672
log_contents = logfile.read()
1676
log_contents.decode('utf8')
1677
except UnicodeDecodeError:
1678
unicodestr = log_contents.decode('utf8', 'replace')
1679
log_contents = unicodestr.encode('utf8')
1680
if not keep_log_file:
1682
max_close_attempts = 100
1683
first_close_error = None
1684
while close_attempts < max_close_attempts:
1687
self._log_file.close()
1688
except IOError, ioe:
1689
if ioe.errno is None:
1690
# No errno implies 'close() called during
1691
# concurrent operation on the same file object', so
1692
# retry. Probably a thread is trying to write to
1694
if first_close_error is None:
1695
first_close_error = ioe
1700
if close_attempts > 1:
1702
'Unable to close log file on first attempt, '
1703
'will retry: %s\n' % (first_close_error,))
1704
if close_attempts == max_close_attempts:
1706
'Unable to close log file after %d attempts.\n'
1707
% (max_close_attempts,))
1708
self._log_file = None
1709
# Permit multiple calls to get_log until we clean it up in
1711
self._log_contents = log_contents
1713
os.remove(self._log_file_name)
1715
if sys.platform == 'win32' and e.errno == errno.EACCES:
1716
sys.stderr.write(('Unable to delete log file '
1717
' %r\n' % self._log_file_name))
1720
self._log_file_name = None
1723
return "No log file content and no log file name."
1870
1725
def get_log(self):
1871
1726
"""Get a unicode string containing the log from bzrlib.trace.
2087
1941
variables. A value of None will unset the env variable.
2088
1942
The values must be strings. The change will only occur in the
2089
1943
child, so you don't need to fix the environment after running.
2090
:param skip_if_plan_to_signal: raise TestSkipped when true and system
2091
doesn't support signalling subprocesses.
1944
:param skip_if_plan_to_signal: raise TestSkipped when true and os.kill
2092
1946
:param allow_plugins: If False (default) pass --no-plugins to bzr.
2093
:param stderr: file to use for the subprocess's stderr. Valid values
2094
are those valid for the stderr argument of `subprocess.Popen`.
2095
Default value is ``subprocess.PIPE``.
2097
1948
:returns: Popen object for the started process.
2099
1950
if skip_if_plan_to_signal:
2100
if os.name != "posix":
2101
raise TestSkipped("Sending signals not supported")
1951
if not getattr(os, 'kill', None):
1952
raise TestSkipped("os.kill not available.")
2103
1954
if env_changes is None:
2104
1955
env_changes = {}
2147
def _add_subprocess_log(self, log_file_path):
2148
if len(self._log_files) == 0:
2149
# Register an addCleanup func. We do this on the first call to
2150
# _add_subprocess_log rather than in TestCase.setUp so that this
2151
# addCleanup is registered after any cleanups for tempdirs that
2152
# subclasses might create, which will probably remove the log file
2154
self.addCleanup(self._subprocess_log_cleanup)
2155
# self._log_files is a set, so if a log file is reused we won't grab it
2157
self._log_files.add(log_file_path)
2159
def _subprocess_log_cleanup(self):
2160
for count, log_file_path in enumerate(self._log_files):
2161
# We use buffer_now=True to avoid holding the file open beyond
2162
# the life of this function, which might interfere with e.g.
2163
# cleaning tempdirs on Windows.
2164
# XXX: Testtools 0.9.5 doesn't have the content_from_file helper
2165
#detail_content = content.content_from_file(
2166
# log_file_path, buffer_now=True)
2167
with open(log_file_path, 'rb') as log_file:
2168
log_file_bytes = log_file.read()
2169
detail_content = content.Content(content.ContentType("text",
2170
"plain", {"charset": "utf8"}), lambda: [log_file_bytes])
2171
self.addDetail("start_bzr_subprocess-log-%d" % (count,),
2174
1995
def _popen(self, *args, **kwargs):
2175
1996
"""Place a call to Popen.
2213
2034
if retcode is not None and retcode != process.returncode:
2214
2035
if process_args is None:
2215
2036
process_args = "(unknown args)"
2216
trace.mutter('Output of bzr %s:\n%s', process_args, out)
2217
trace.mutter('Error for bzr %s:\n%s', process_args, err)
2037
mutter('Output of bzr %s:\n%s', process_args, out)
2038
mutter('Error for bzr %s:\n%s', process_args, err)
2218
2039
self.fail('Command bzr %s failed with retcode %s != %s'
2219
2040
% (process_args, retcode, process.returncode))
2220
2041
return [out, err]
2222
def check_tree_shape(self, tree, shape):
2223
"""Compare a tree to a list of expected names.
2043
def check_inventory_shape(self, inv, shape):
2044
"""Compare an inventory to a list of expected names.
2225
2046
Fail if they are not precisely equal.
2228
2049
shape = list(shape) # copy
2229
for path, ie in tree.iter_entries_by_dir():
2050
for path, ie in inv.entries():
2230
2051
name = path.replace('\\', '/')
2231
2052
if ie.kind == 'directory':
2232
2053
name = name + '/'
2234
pass # ignore root entry
2236
2055
shape.remove(name)
2238
2057
extras.append(name)
2328
2147
class TestCaseWithMemoryTransport(TestCase):
2329
2148
"""Common test class for tests that do not need disk resources.
2331
Tests that need disk resources should derive from TestCaseInTempDir
2332
orTestCaseWithTransport.
2150
Tests that need disk resources should derive from TestCaseWithTransport.
2334
2152
TestCaseWithMemoryTransport sets the TEST_ROOT variable for all bzr tests.
2336
For TestCaseWithMemoryTransport the ``test_home_dir`` is set to the name of
2154
For TestCaseWithMemoryTransport the test_home_dir is set to the name of
2337
2155
a directory which does not exist. This serves to help ensure test isolation
2338
is preserved. ``test_dir`` is set to the TEST_ROOT, as is cwd, because they
2339
must exist. However, TestCaseWithMemoryTransport does not offer local file
2340
defaults for the transport in tests, nor does it obey the command line
2156
is preserved. test_dir is set to the TEST_ROOT, as is cwd, because they
2157
must exist. However, TestCaseWithMemoryTransport does not offer local
2158
file defaults for the transport in tests, nor does it obey the command line
2341
2159
override, so tests that accidentally write to the common directory should
2344
:cvar TEST_ROOT: Directory containing all temporary directories, plus a
2345
``.bzr`` directory that stops us ascending higher into the filesystem.
2162
:cvar TEST_ROOT: Directory containing all temporary directories, plus
2163
a .bzr directory that stops us ascending higher into the filesystem.
2348
2166
TEST_ROOT = None
2610
2428
test_home_dir = self.test_home_dir
2611
2429
if isinstance(test_home_dir, unicode):
2612
2430
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2613
self.overrideEnv('HOME', test_home_dir)
2614
self.overrideEnv('BZR_HOME', test_home_dir)
2431
os.environ['HOME'] = test_home_dir
2432
os.environ['BZR_HOME'] = test_home_dir
2616
2434
def setUp(self):
2617
2435
super(TestCaseWithMemoryTransport, self).setUp()
2618
# Ensure that ConnectedTransport doesn't leak sockets
2619
def get_transport_with_cleanup(*args, **kwargs):
2620
t = orig_get_transport(*args, **kwargs)
2621
if isinstance(t, _mod_transport.ConnectedTransport):
2622
self.addCleanup(t.disconnect)
2625
orig_get_transport = self.overrideAttr(_mod_transport, 'get_transport',
2626
get_transport_with_cleanup)
2627
2436
self._make_test_root()
2628
2437
self.addCleanup(os.chdir, os.getcwdu())
2629
2438
self.makeAndChdirToTestDir()
3395
3196
def partition_tests(suite, count):
3396
3197
"""Partition suite into count lists of tests."""
3397
# This just assigns tests in a round-robin fashion. On one hand this
3398
# splits up blocks of related tests that might run faster if they shared
3399
# resources, but on the other it avoids assigning blocks of slow tests to
3400
# just one partition. So the slowest partition shouldn't be much slower
3402
partitions = [list() for i in range(count)]
3403
tests = iter_suite_tests(suite)
3404
for partition, test in itertools.izip(itertools.cycle(partitions), tests):
3405
partition.append(test)
3199
tests = list(iter_suite_tests(suite))
3200
tests_per_process = int(math.ceil(float(len(tests)) / count))
3201
for block in range(count):
3202
low_test = block * tests_per_process
3203
high_test = low_test + tests_per_process
3204
process_tests = tests[low_test:high_test]
3205
result.append(process_tests)
3409
3209
def workaround_zealous_crypto_random():
3532
class ProfileResult(testtools.ExtendedToOriginalDecorator):
3332
class ForwardingResult(unittest.TestResult):
3334
def __init__(self, target):
3335
unittest.TestResult.__init__(self)
3336
self.result = target
3338
def startTest(self, test):
3339
self.result.startTest(test)
3341
def stopTest(self, test):
3342
self.result.stopTest(test)
3344
def startTestRun(self):
3345
self.result.startTestRun()
3347
def stopTestRun(self):
3348
self.result.stopTestRun()
3350
def addSkip(self, test, reason):
3351
self.result.addSkip(test, reason)
3353
def addSuccess(self, test):
3354
self.result.addSuccess(test)
3356
def addError(self, test, err):
3357
self.result.addError(test, err)
3359
def addFailure(self, test, err):
3360
self.result.addFailure(test, err)
3361
ForwardingResult = testtools.ExtendedToOriginalDecorator
3364
class ProfileResult(ForwardingResult):
3533
3365
"""Generate profiling data for all activity between start and success.
3535
3367
The profile data is appended to the test's _benchcalls attribute and can
3833
3657
'bzrlib.tests.per_repository',
3834
3658
'bzrlib.tests.per_repository_chk',
3835
3659
'bzrlib.tests.per_repository_reference',
3836
'bzrlib.tests.per_repository_vf',
3837
3660
'bzrlib.tests.per_uifactory',
3838
3661
'bzrlib.tests.per_versionedfile',
3839
3662
'bzrlib.tests.per_workingtree',
3840
3663
'bzrlib.tests.test__annotator',
3841
3664
'bzrlib.tests.test__bencode',
3842
'bzrlib.tests.test__btree_serializer',
3843
3665
'bzrlib.tests.test__chk_map',
3844
3666
'bzrlib.tests.test__dirstate_helpers',
3845
3667
'bzrlib.tests.test__groupcompress',
3873
3695
'bzrlib.tests.test_commit_merge',
3874
3696
'bzrlib.tests.test_config',
3875
3697
'bzrlib.tests.test_conflicts',
3876
'bzrlib.tests.test_controldir',
3877
3698
'bzrlib.tests.test_counted_lock',
3878
3699
'bzrlib.tests.test_crash',
3879
3700
'bzrlib.tests.test_decorators',
3880
3701
'bzrlib.tests.test_delta',
3881
3702
'bzrlib.tests.test_debug',
3703
'bzrlib.tests.test_deprecated_graph',
3882
3704
'bzrlib.tests.test_diff',
3883
3705
'bzrlib.tests.test_directory_service',
3884
3706
'bzrlib.tests.test_dirstate',
4139
3951
# Some tests mentioned in the list are not in the test suite. The
4140
3952
# list may be out of date, report to the tester.
4141
3953
for id in not_found:
4142
trace.warning('"%s" not found in the test suite', id)
3954
bzrlib.trace.warning('"%s" not found in the test suite', id)
4143
3955
for id in duplicates:
4144
trace.warning('"%s" is used as an id by several tests', id)
3956
bzrlib.trace.warning('"%s" is used as an id by several tests', id)
4149
def multiply_scenarios(*scenarios):
4150
"""Multiply two or more iterables of scenarios.
4152
It is safe to pass scenario generators or iterators.
4154
:returns: A list of compound scenarios: the cross-product of all
4155
scenarios, with the names concatenated and the parameters
4158
return reduce(_multiply_two_scenarios, map(list, scenarios))
4161
def _multiply_two_scenarios(scenarios_left, scenarios_right):
3961
def multiply_scenarios(scenarios_left, scenarios_right):
4162
3962
"""Multiply two sets of scenarios.
4164
3964
:returns: the cartesian product of the two sets of scenarios, that is
4677
4473
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4476
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4477
SubUnitFeature = _CompatabilityThunkFeature(
4478
deprecated_in((2,1,0)),
4479
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4680
4480
# Only define SubUnitBzrRunner if subunit is available.
4682
4482
from subunit import TestProtocolClient
4683
4483
from subunit.test_results import AutoTimingTestResultDecorator
4684
class SubUnitBzrProtocolClient(TestProtocolClient):
4686
def addSuccess(self, test, details=None):
4687
# The subunit client always includes the details in the subunit
4688
# stream, but we don't want to include it in ours.
4689
if details is not None and 'log' in details:
4691
return super(SubUnitBzrProtocolClient, self).addSuccess(
4694
4484
class SubUnitBzrRunner(TextTestRunner):
4695
4485
def run(self, test):
4696
4486
result = AutoTimingTestResultDecorator(
4697
SubUnitBzrProtocolClient(self.stream))
4487
TestProtocolClient(self.stream))
4698
4488
test.run(result)
4700
4490
except ImportError:
added
removed
bzrlib/tests/__init__.py
