97
87
from bzrlib.symbol_versioning import (
98
88
DEPRECATED_PARAMETER,
99
89
deprecated_function,
101
90
deprecated_method,
102
91
deprecated_passed,
104
93
import bzrlib.trace
105
from bzrlib.transport import (
94
from bzrlib.transport import get_transport, pathfilter
110
95
import bzrlib.transport
96
from bzrlib.transport.local import LocalURLServer
97
from bzrlib.transport.memory import MemoryServer
98
from bzrlib.transport.readonly import ReadonlyServer
111
99
from bzrlib.trace import mutter, note
112
from bzrlib.tests import (
100
from bzrlib.tests import TestUtil
116
101
from bzrlib.tests.http_server import HttpServer
117
102
from bzrlib.tests.TestUtil import (
242
222
'%s is leaking threads among %d leaking tests.\n' % (
243
223
TestCase._first_thread_leaker_id,
244
224
TestCase._leaking_threads_tests))
245
# We don't report the main thread as an active one.
247
'%d non-main threads were left active in the end.\n'
248
% (TestCase._active_threads - 1))
250
def getDescription(self, test):
253
def _extractBenchmarkTime(self, testCase, details=None):
226
def _extractBenchmarkTime(self, testCase):
254
227
"""Add a benchmark time for the current test case."""
255
if details and 'benchtime' in details:
256
return float(''.join(details['benchtime'].iter_bytes()))
257
228
return getattr(testCase, "_benchtime", None)
259
230
def _elapsedTestTimeString(self):
322
293
Called from the TestCase run() method when the test
323
294
fails with an unexpected error.
326
unittest.TestResult.addError(self, test, err)
327
self.error_count += 1
328
self.report_error(test, err)
331
self._cleanupLogFile(test)
296
self._testConcluded(test)
297
if isinstance(err[1], TestNotApplicable):
298
return self._addNotApplicable(test, err)
299
elif isinstance(err[1], UnavailableFeature):
300
return self.addNotSupported(test, err[1].args[0])
303
unittest.TestResult.addError(self, test, err)
304
self.error_count += 1
305
self.report_error(test, err)
308
self._cleanupLogFile(test)
333
310
def addFailure(self, test, err):
334
311
"""Tell result that test failed.
336
313
Called from the TestCase run() method when the test
337
314
fails because e.g. an assert() method failed.
340
unittest.TestResult.addFailure(self, test, err)
341
self.failure_count += 1
342
self.report_failure(test, err)
345
self._cleanupLogFile(test)
316
self._testConcluded(test)
317
if isinstance(err[1], KnownFailure):
318
return self._addKnownFailure(test, err)
321
unittest.TestResult.addFailure(self, test, err)
322
self.failure_count += 1
323
self.report_failure(test, err)
326
self._cleanupLogFile(test)
347
def addSuccess(self, test, details=None):
328
def addSuccess(self, test):
348
329
"""Tell result that test completed successfully.
350
331
Called from the TestCase run()
333
self._testConcluded(test)
352
334
if self._bench_history is not None:
353
benchmark_time = self._extractBenchmarkTime(test, details)
335
benchmark_time = self._extractBenchmarkTime(test)
354
336
if benchmark_time is not None:
355
337
self._bench_history.write("%s %s\n" % (
356
338
self._formatTime(benchmark_time),
360
342
unittest.TestResult.addSuccess(self, test)
361
343
test._log_contents = ''
363
def addExpectedFailure(self, test, err):
345
def _testConcluded(self, test):
346
"""Common code when a test has finished.
348
Called regardless of whether it succeded, failed, etc.
352
def _addKnownFailure(self, test, err):
364
353
self.known_failure_count += 1
365
354
self.report_known_failure(test, err)
368
357
"""The test will not be run because of a missing feature.
370
359
# this can be called in two different ways: it may be that the
371
# test started running, and then raised (through requireFeature)
360
# test started running, and then raised (through addError)
372
361
# UnavailableFeature. Alternatively this method can be called
373
# while probing for features before running the test code proper; in
374
# that case we will see startTest and stopTest, but the test will
375
# never actually run.
362
# while probing for features before running the tests; in that
363
# case we will see startTest and stopTest, but the test will never
376
365
self.unsupported.setdefault(str(feature), 0)
377
366
self.unsupported[str(feature)] += 1
378
367
self.report_unsupported(test, feature)
382
371
self.skip_count += 1
383
372
self.report_skip(test, reason)
385
def addNotApplicable(self, test, reason):
386
self.not_applicable_count += 1
387
self.report_not_applicable(test, reason)
374
def _addNotApplicable(self, test, skip_excinfo):
375
if isinstance(skip_excinfo[1], TestNotApplicable):
376
self.not_applicable_count += 1
377
self.report_not_applicable(test, skip_excinfo)
380
except KeyboardInterrupt:
383
self.addError(test, test.exc_info())
385
# seems best to treat this as success from point-of-view of unittest
386
# -- it actually does nothing so it barely matters :)
387
unittest.TestResult.addSuccess(self, test)
388
test._log_contents = ''
390
def printErrorList(self, flavour, errors):
391
for test, err in errors:
392
self.stream.writeln(self.separator1)
393
self.stream.write("%s: " % flavour)
394
self.stream.writeln(self.getDescription(test))
395
if getattr(test, '_get_log', None) is not None:
396
log_contents = test._get_log()
398
self.stream.write('\n')
400
('vvvv[log from %s]' % test.id()).ljust(78,'-'))
401
self.stream.write('\n')
402
self.stream.write(log_contents)
403
self.stream.write('\n')
405
('^^^^[log from %s]' % test.id()).ljust(78,'-'))
406
self.stream.write('\n')
407
self.stream.writeln(self.separator2)
408
self.stream.writeln("%s" % err)
389
410
def _post_mortem(self):
390
411
"""Start a PDB post mortem session."""
490
512
return self._shortened_test_description(test)
492
514
def report_error(self, test, err):
493
self.stream.write('ERROR: %s\n %s\n' % (
515
self.pb.note('ERROR: %s\n %s\n',
494
516
self._test_description(test),
498
520
def report_failure(self, test, err):
499
self.stream.write('FAIL: %s\n %s\n' % (
521
self.pb.note('FAIL: %s\n %s\n',
500
522
self._test_description(test),
504
526
def report_known_failure(self, test, err):
527
self.pb.note('XFAIL: %s\n%s\n',
528
self._test_description(test), err[1])
507
530
def report_skip(self, test, reason):
510
def report_not_applicable(self, test, reason):
533
def report_not_applicable(self, test, skip_excinfo):
513
536
def report_unsupported(self, test, feature):
535
558
def report_test_start(self, test):
537
560
name = self._shortened_test_description(test)
538
width = osutils.terminal_width()
539
if width is not None:
540
# width needs space for 6 char status, plus 1 for slash, plus an
541
# 11-char time string, plus a trailing blank
542
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on
544
self.stream.write(self._ellipsize_to_right(name, width-18))
546
self.stream.write(name)
561
# width needs space for 6 char status, plus 1 for slash, plus an
562
# 11-char time string, plus a trailing blank
563
# when NUMBERED_DIRS: plus 5 chars on test number, plus 1 char on space
564
self.stream.write(self._ellipsize_to_right(name,
565
osutils.terminal_width()-18))
547
566
self.stream.flush()
549
568
def _error_summary(self, err):
578
597
self.stream.writeln(' SKIP %s\n%s'
579
598
% (self._testTimeString(test), reason))
581
def report_not_applicable(self, test, reason):
582
self.stream.writeln(' N/A %s\n %s'
583
% (self._testTimeString(test), reason))
600
def report_not_applicable(self, test, skip_excinfo):
601
self.stream.writeln(' N/A %s\n%s'
602
% (self._testTimeString(test),
603
self._error_summary(skip_excinfo)))
585
605
def report_unsupported(self, test, feature):
586
606
"""test cannot be run because feature is missing."""
606
626
applied left to right - the first element in the list is the
607
627
innermost decorator.
609
# stream may know claim to know to write unicode strings, but in older
610
# pythons this goes sufficiently wrong that it is a bad idea. (
611
# specifically a built in file with encoding 'UTF-8' will still try
612
# to encode using ascii.
613
new_encoding = osutils.get_terminal_encoding()
614
codec = codecs.lookup(new_encoding)
615
if type(codec) is tuple:
619
encode = codec.encode
620
stream = osutils.UnicodeOrBytesToBytesWriter(encode, stream)
621
stream.encoding = new_encoding
622
629
self.stream = unittest._WritelnDecorator(stream)
623
630
self.descriptions = descriptions
624
631
self.verbosity = verbosity
682
# traceback._some_str fails to format exceptions that have the default
683
# __str__ which does an implicit ascii conversion. However, repr() on those
684
# objects works, for all that its not quite what the doctor may have ordered.
685
def _clever_some_str(value):
690
return repr(value).replace('\\n', '\n')
692
return '<unprintable %s object>' % type(value).__name__
694
traceback._some_str = _clever_some_str
697
# deprecated - use self.knownFailure(), or self.expectFailure.
698
KnownFailure = testtools.testcase._ExpectedFailure
698
class KnownFailure(AssertionError):
699
"""Indicates that a test failed in a precisely expected manner.
701
Such failures dont block the whole test suite from passing because they are
702
indicators of partially completed code or of future work. We have an
703
explicit error for them so that we can ensure that they are always visible:
704
KnownFailures are always shown in the output of bzr selftest.
701
708
class UnavailableFeature(Exception):
702
709
"""A feature required for this test was not available.
704
This can be considered a specialised form of SkippedTest.
706
711
The feature should be used to construct the exception.
715
class CommandFailed(Exception):
710
719
class StringIOWrapper(object):
711
720
"""A wrapper around cStringIO which just adds an encoding attribute.
798
807
_leaking_threads_tests = 0
799
808
_first_thread_leaker_id = None
800
809
_log_file_name = None
811
_keep_log_file = False
801
812
# record lsprof data when performing benchmark calls.
802
813
_gather_lsprof_in_benchmarks = False
814
attrs_to_keep = ('id', '_testMethodName', '_testMethodDoc',
815
'_log_contents', '_log_file_name', '_benchtime',
816
'_TestCase__testMethodName', '_TestCase__testMethodDoc',)
804
818
def __init__(self, methodName='testMethod'):
805
819
super(TestCase, self).__init__(methodName)
806
820
self._cleanups = []
821
self._bzr_test_setUp_run = False
822
self._bzr_test_tearDown_run = False
807
823
self._directory_isolation = True
808
self.exception_handlers.insert(0,
809
(UnavailableFeature, self._do_unsupported_or_skip))
810
self.exception_handlers.insert(0,
811
(TestNotApplicable, self._do_not_applicable))
814
super(TestCase, self).setUp()
815
for feature in getattr(self, '_test_needs_features', []):
816
self.requireFeature(feature)
817
self._log_contents = None
818
self.addDetail("log", content.Content(content.ContentType("text",
819
"plain", {"charset": "utf8"}),
820
lambda:[self._get_log(keep_log_file=True)]))
826
unittest.TestCase.setUp(self)
827
self._bzr_test_setUp_run = True
821
828
self._cleanEnvironment()
822
829
self._silenceUI()
823
830
self._startLogFile()
839
846
active = threading.activeCount()
840
847
leaked_threads = active - TestCase._active_threads
841
848
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
850
TestCase._leaking_threads_tests += 1
850
851
if TestCase._first_thread_leaker_id is None:
851
852
TestCase._first_thread_leaker_id = self.id()
856
857
Tests that want to use debug flags can just set them in the
857
858
debug_flags set during setup/teardown.
859
# Start with a copy of the current debug flags we can safely modify.
860
self.overrideAttr(debug, 'debug_flags', set(debug.debug_flags))
860
self._preserved_debug_flags = set(debug.debug_flags)
861
861
if 'allow_debug' not in selftest_debug_flags:
862
862
debug.debug_flags.clear()
863
863
if 'disable_lock_checks' not in selftest_debug_flags:
864
864
debug.debug_flags.add('strict_locks')
865
self.addCleanup(self._restore_debug_flags)
866
867
def _clear_hooks(self):
867
868
# prevent hooks affecting tests
1129
1133
:raises AssertionError: If the expected and actual stat values differ
1130
1134
other than by atime.
1132
self.assertEqual(expected.st_size, actual.st_size,
1133
'st_size did not match')
1134
self.assertEqual(expected.st_mtime, actual.st_mtime,
1135
'st_mtime did not match')
1136
self.assertEqual(expected.st_ctime, actual.st_ctime,
1137
'st_ctime did not match')
1138
if sys.platform != 'win32':
1139
# On Win32 both 'dev' and 'ino' cannot be trusted. In python2.4 it
1140
# 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
1143
self.assertEqual(expected.st_dev, actual.st_dev,
1144
'st_dev did not match')
1145
self.assertEqual(expected.st_ino, actual.st_ino,
1146
'st_ino did not match')
1147
self.assertEqual(expected.st_mode, actual.st_mode,
1148
'st_mode did not match')
1136
self.assertEqual(expected.st_size, actual.st_size)
1137
self.assertEqual(expected.st_mtime, actual.st_mtime)
1138
self.assertEqual(expected.st_ctime, actual.st_ctime)
1139
self.assertEqual(expected.st_dev, actual.st_dev)
1140
self.assertEqual(expected.st_ino, actual.st_ino)
1141
self.assertEqual(expected.st_mode, actual.st_mode)
1150
1143
def assertLength(self, length, obj_with_len):
1151
1144
"""Assert that obj_with_len is of length length."""
1153
1146
self.fail("Incorrect length: wanted %d, got %d for %r" % (
1154
1147
length, len(obj_with_len), obj_with_len))
1156
def assertLogsError(self, exception_class, func, *args, **kwargs):
1157
"""Assert that func(*args, **kwargs) quietly logs a specific exception.
1159
from bzrlib import trace
1161
orig_log_exception_quietly = trace.log_exception_quietly
1164
orig_log_exception_quietly()
1165
captured.append(sys.exc_info())
1166
trace.log_exception_quietly = capture
1167
func(*args, **kwargs)
1169
trace.log_exception_quietly = orig_log_exception_quietly
1170
self.assertLength(1, captured)
1171
err = captured[0][1]
1172
self.assertIsInstance(err, exception_class)
1175
1149
def assertPositive(self, val):
1176
1150
"""Assert that val is greater than 0."""
1177
1151
self.assertTrue(val > 0, 'expected a positive value, but got %s' % val)
1303
1273
m += ": " + msg
1276
def expectFailure(self, reason, assertion, *args, **kwargs):
1277
"""Invoke a test, expecting it to fail for the given reason.
1279
This is for assertions that ought to succeed, but currently fail.
1280
(The failure is *expected* but not *wanted*.) Please be very precise
1281
about the failure you're expecting. If a new bug is introduced,
1282
AssertionError should be raised, not KnownFailure.
1284
Frequently, expectFailure should be followed by an opposite assertion.
1287
Intended to be used with a callable that raises AssertionError as the
1288
'assertion' parameter. args and kwargs are passed to the 'assertion'.
1290
Raises KnownFailure if the test fails. Raises AssertionError if the
1295
self.expectFailure('Math is broken', self.assertNotEqual, 54,
1297
self.assertEqual(42, dynamic_val)
1299
This means that a dynamic_val of 54 will cause the test to raise
1300
a KnownFailure. Once math is fixed and the expectFailure is removed,
1301
only a dynamic_val of 42 will allow the test to pass. Anything other
1302
than 54 or 42 will cause an AssertionError.
1305
assertion(*args, **kwargs)
1306
except AssertionError:
1307
raise KnownFailure(reason)
1309
self.fail('Unexpected success. Should have failed: %s' % reason)
1306
1311
def assertFileEqual(self, content, path):
1307
1312
"""Fail if path does not contain 'content'."""
1308
1313
self.failUnlessExists(path)
1314
1319
self.assertEqualDiff(content, s)
1316
def assertDocstring(self, expected_docstring, obj):
1317
"""Fail if obj does not have expected_docstring"""
1319
# With -OO the docstring should be None instead
1320
self.assertIs(obj.__doc__, None)
1322
self.assertEqual(expected_docstring, obj.__doc__)
1324
1321
def failUnlessExists(self, path):
1325
1322
"""Fail unless path or paths, which may be abs or relative, exist."""
1326
1323
if not isinstance(path, basestring):
1467
1464
Close the file and delete it, unless setKeepLogfile was called.
1469
if bzrlib.trace._trace_file:
1470
# flush the log file, to get all content
1471
bzrlib.trace._trace_file.flush()
1466
if self._log_file is None:
1472
1468
bzrlib.trace.pop_log_file(self._log_memento)
1473
# Cache the log result and delete the file on disk
1474
self._get_log(False)
1469
self._log_file.close()
1470
self._log_file = None
1471
if not self._keep_log_file:
1472
os.remove(self._log_file_name)
1473
self._log_file_name = None
1475
def setKeepLogfile(self):
1476
"""Make the logfile not be deleted when _finishLogFile is called."""
1477
self._keep_log_file = True
1476
1479
def thisFailsStrictLockCheck(self):
1477
1480
"""It is known that this test would fail with -Dstrict_locks.
1495
1498
self._cleanups.append((callable, args, kwargs))
1497
def overrideAttr(self, obj, attr_name, new=_unitialized_attr):
1498
"""Overrides an object attribute restoring it after the test.
1500
:param obj: The object that will be mutated.
1502
:param attr_name: The attribute name we want to preserve/override in
1505
:param new: The optional value we want to set the attribute to.
1507
:returns: The actual attr value.
1509
value = getattr(obj, attr_name)
1510
# The actual value is captured by the call below
1511
self.addCleanup(setattr, obj, attr_name, value)
1512
if new is not _unitialized_attr:
1513
setattr(obj, attr_name, new)
1516
1500
def _cleanEnvironment(self):
1518
1502
'BZR_HOME': None, # Don't inherit BZR_HOME to all the tests.
1556
1536
'ftp_proxy': None,
1557
1537
'FTP_PROXY': None,
1558
1538
'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
1541
self.addCleanup(self._restoreEnvironment)
1567
1542
for name, value in new_env.iteritems():
1568
1543
self._captureVar(name, value)
1570
1545
def _captureVar(self, name, newvalue):
1571
1546
"""Set an environment variable, and reset it when finished."""
1572
self._old_env[name] = osutils.set_or_unset_env(name, newvalue)
1547
self.__old_env[name] = osutils.set_or_unset_env(name, newvalue)
1549
def _restore_debug_flags(self):
1550
debug.debug_flags.clear()
1551
debug.debug_flags.update(self._preserved_debug_flags)
1574
1553
def _restoreEnvironment(self):
1575
for name, value in self._old_env.iteritems():
1554
for name, value in self.__old_env.iteritems():
1576
1555
osutils.set_or_unset_env(name, value)
1578
1557
def _restoreHooks(self):
1586
1565
def _do_skip(self, result, reason):
1587
1566
addSkip = getattr(result, 'addSkip', None)
1588
1567
if not callable(addSkip):
1589
result.addSuccess(result)
1568
result.addError(self, sys.exc_info())
1591
1570
addSkip(self, reason)
1594
def _do_known_failure(self, result, e):
1595
err = sys.exc_info()
1596
addExpectedFailure = getattr(result, 'addExpectedFailure', None)
1597
if addExpectedFailure is not None:
1598
addExpectedFailure(self, err)
1600
result.addSuccess(self)
1603
def _do_not_applicable(self, result, e):
1605
reason = 'No reason given'
1608
addNotApplicable = getattr(result, 'addNotApplicable', None)
1609
if addNotApplicable is not None:
1610
result.addNotApplicable(self, reason)
1612
self._do_skip(result, reason)
1615
def _do_unsupported_or_skip(self, result, e):
1617
addNotSupported = getattr(result, 'addNotSupported', None)
1618
if addNotSupported is not None:
1619
result.addNotSupported(self, reason)
1621
self._do_skip(result, reason)
1572
def run(self, result=None):
1573
if result is None: result = self.defaultTestResult()
1574
for feature in getattr(self, '_test_needs_features', []):
1575
if not feature.available():
1576
result.startTest(self)
1577
if getattr(result, 'addNotSupported', None):
1578
result.addNotSupported(self, feature)
1580
result.addSuccess(self)
1581
result.stopTest(self)
1585
result.startTest(self)
1586
absent_attr = object()
1588
method_name = getattr(self, '_testMethodName', absent_attr)
1589
if method_name is absent_attr:
1591
method_name = getattr(self, '_TestCase__testMethodName')
1592
testMethod = getattr(self, method_name)
1596
if not self._bzr_test_setUp_run:
1598
"test setUp did not invoke "
1599
"bzrlib.tests.TestCase's setUp")
1600
except KeyboardInterrupt:
1603
except TestSkipped, e:
1604
self._do_skip(result, e.args[0])
1608
result.addError(self, sys.exc_info())
1616
except self.failureException:
1617
result.addFailure(self, sys.exc_info())
1618
except TestSkipped, e:
1620
reason = "No reason given."
1623
self._do_skip(result, reason)
1624
except KeyboardInterrupt:
1628
result.addError(self, sys.exc_info())
1632
if not self._bzr_test_tearDown_run:
1634
"test tearDown did not invoke "
1635
"bzrlib.tests.TestCase's tearDown")
1636
except KeyboardInterrupt:
1640
result.addError(self, sys.exc_info())
1643
if ok: result.addSuccess(self)
1645
result.stopTest(self)
1647
except TestNotApplicable:
1648
# Not moved from the result [yet].
1651
except KeyboardInterrupt:
1656
for attr_name in self.attrs_to_keep:
1657
if attr_name in self.__dict__:
1658
saved_attrs[attr_name] = self.__dict__[attr_name]
1659
self.__dict__ = saved_attrs
1663
self._log_contents = ''
1664
self._bzr_test_tearDown_run = True
1665
unittest.TestCase.tearDown(self)
1623
1667
def time(self, callable, *args, **kwargs):
1624
1668
"""Run callable and accrue the time it takes to the benchmark time.
1645
1687
self._benchtime += time.time() - start
1689
def _runCleanups(self):
1690
"""Run registered cleanup functions.
1692
This should only be called from TestCase.tearDown.
1694
# TODO: Perhaps this should keep running cleanups even if
1695
# one of them fails?
1697
# Actually pop the cleanups from the list so tearDown running
1698
# twice is safe (this happens for skipped tests).
1699
while self._cleanups:
1700
cleanup, args, kwargs = self._cleanups.pop()
1701
cleanup(*args, **kwargs)
1647
1703
def log(self, *args):
1650
1706
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
1707
"""Get the log from bzrlib.trace calls from this test.
1656
1709
:param keep_log_file: When True, if the log is still a file on disk
1657
1710
leave it as a file on disk. When False, if the log is still a file
1659
1712
self._log_contents.
1660
1713
: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')
1715
# flush the log file, to get all content
1717
if bzrlib.trace._trace_file:
1718
bzrlib.trace._trace_file.flush()
1719
if self._log_contents:
1720
# XXX: this can hardly contain the content flushed above --vila
1668
1722
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
1723
if self._log_file_name is not None:
1674
1724
logfile = open(self._log_file_name)
1676
1726
log_contents = logfile.read()
1678
1728
logfile.close()
1680
log_contents.decode('utf8')
1681
except UnicodeDecodeError:
1682
unicodestr = log_contents.decode('utf8', 'replace')
1683
log_contents = unicodestr.encode('utf8')
1684
1729
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
1730
self._log_contents = log_contents
1717
1732
os.remove(self._log_file_name)
1779
1783
os.chdir(working_dir)
1783
result = self.apply_redirected(ui.ui_factory.stdin,
1785
bzrlib.commands.run_bzr_catch_user_errors,
1787
except KeyboardInterrupt:
1788
# Reraise KeyboardInterrupt with contents of redirected stdout
1789
# and stderr as arguments, for tests which are interested in
1790
# stdout and stderr and are expecting the exception.
1791
out = stdout.getvalue()
1792
err = stderr.getvalue()
1794
self.log('output:\n%r', out)
1796
self.log('errors:\n%r', err)
1797
raise KeyboardInterrupt(out, err)
1786
result = self.apply_redirected(ui.ui_factory.stdin,
1788
bzrlib.commands.run_bzr_catch_user_errors,
1799
1791
logger.removeHandler(handler)
1800
1792
ui.ui_factory = old_ui_factory
2424
2422
return branchbuilder.BranchBuilder(branch=branch)
2426
2424
def overrideEnvironmentForTesting(self):
2427
test_home_dir = self.test_home_dir
2428
if isinstance(test_home_dir, unicode):
2429
test_home_dir = test_home_dir.encode(sys.getfilesystemencoding())
2430
os.environ['HOME'] = test_home_dir
2431
os.environ['BZR_HOME'] = test_home_dir
2425
os.environ['HOME'] = self.test_home_dir
2426
os.environ['BZR_HOME'] = self.test_home_dir
2433
2428
def setUp(self):
2434
2429
super(TestCaseWithMemoryTransport, self).setUp()
2435
2430
self._make_test_root()
2436
self.addCleanup(os.chdir, os.getcwdu())
2431
_currentdir = os.getcwdu()
2432
def _leaveDirectory():
2433
os.chdir(_currentdir)
2434
self.addCleanup(_leaveDirectory)
2437
2435
self.makeAndChdirToTestDir()
2438
2436
self.overrideEnvironmentForTesting()
2439
2437
self.__readonly_server = None
3296
3283
if not os.path.isfile(bzr_path):
3297
3284
# We are probably installed. Assume sys.argv is the right file
3298
3285
bzr_path = sys.argv[0]
3299
bzr_path = [bzr_path]
3300
if sys.platform == "win32":
3301
# if we're on windows, we can't execute the bzr script directly
3302
bzr_path = [sys.executable] + bzr_path
3303
3286
fd, test_list_file_name = tempfile.mkstemp()
3304
3287
test_list_file = os.fdopen(fd, 'wb', 1)
3305
3288
for test in process_tests:
3306
3289
test_list_file.write(test.id() + '\n')
3307
3290
test_list_file.close()
3309
argv = bzr_path + ['selftest', '--load-list', test_list_file_name,
3292
argv = [bzr_path, 'selftest', '--load-list', test_list_file_name,
3311
3294
if '--no-plugins' in sys.argv:
3312
3295
argv.append('--no-plugins')
3352
3335
def addFailure(self, test, err):
3353
3336
self.result.addFailure(test, err)
3354
ForwardingResult = testtools.ExtendedToOriginalDecorator
3339
class BZRTransformingResult(ForwardingResult):
3341
def addError(self, test, err):
3342
feature = self._error_looks_like('UnavailableFeature: ', err)
3343
if feature is not None:
3344
self.result.addNotSupported(test, feature)
3346
self.result.addError(test, err)
3348
def addFailure(self, test, err):
3349
known = self._error_looks_like('KnownFailure: ', err)
3350
if known is not None:
3351
self.result._addKnownFailure(test, [KnownFailure,
3352
KnownFailure(known), None])
3354
self.result.addFailure(test, err)
3356
def _error_looks_like(self, prefix, err):
3357
"""Deserialize exception and returns the stringify value."""
3361
if isinstance(exc, subunit.RemoteException):
3362
# stringify the exception gives access to the remote traceback
3363
# We search the last line for 'prefix'
3364
lines = str(exc).split('\n')
3365
while lines and not lines[-1]:
3368
if lines[-1].startswith(prefix):
3369
value = lines[-1][len(prefix):]
3357
3373
class ProfileResult(ForwardingResult):
3634
3650
'bzrlib.tests.commands',
3635
3651
'bzrlib.tests.per_branch',
3636
3652
'bzrlib.tests.per_bzrdir',
3637
'bzrlib.tests.per_bzrdir_colo',
3638
'bzrlib.tests.per_foreign_vcs',
3639
3653
'bzrlib.tests.per_interrepository',
3640
3654
'bzrlib.tests.per_intertree',
3641
3655
'bzrlib.tests.per_inventory',
3642
3656
'bzrlib.tests.per_interbranch',
3643
3657
'bzrlib.tests.per_lock',
3644
'bzrlib.tests.per_merger',
3645
3658
'bzrlib.tests.per_transport',
3646
3659
'bzrlib.tests.per_tree',
3647
3660
'bzrlib.tests.per_pack_repository',
3648
3661
'bzrlib.tests.per_repository',
3649
3662
'bzrlib.tests.per_repository_chk',
3650
3663
'bzrlib.tests.per_repository_reference',
3651
'bzrlib.tests.per_uifactory',
3652
3664
'bzrlib.tests.per_versionedfile',
3653
3665
'bzrlib.tests.per_workingtree',
3654
3666
'bzrlib.tests.test__annotator',
3655
'bzrlib.tests.test__bencode',
3656
3667
'bzrlib.tests.test__chk_map',
3657
3668
'bzrlib.tests.test__dirstate_helpers',
3658
3669
'bzrlib.tests.test__groupcompress',
3659
3670
'bzrlib.tests.test__known_graph',
3660
3671
'bzrlib.tests.test__rio',
3661
'bzrlib.tests.test__simple_set',
3662
'bzrlib.tests.test__static_tuple',
3663
3672
'bzrlib.tests.test__walkdirs_win32',
3664
3673
'bzrlib.tests.test_ancestry',
3665
3674
'bzrlib.tests.test_annotate',
3666
3675
'bzrlib.tests.test_api',
3667
3676
'bzrlib.tests.test_atomicfile',
3668
3677
'bzrlib.tests.test_bad_files',
3678
'bzrlib.tests.test_bencode',
3669
3679
'bzrlib.tests.test_bisect_multi',
3670
3680
'bzrlib.tests.test_branch',
3671
3681
'bzrlib.tests.test_branchbuilder',
4039
4042
return new_test
4042
def permute_tests_for_extension(standard_tests, loader, py_module_name,
4044
"""Helper for permutating tests against an extension module.
4046
This is meant to be used inside a modules 'load_tests()' function. It will
4047
create 2 scenarios, and cause all tests in the 'standard_tests' to be run
4048
against both implementations. Setting 'test.module' to the appropriate
4049
module. See bzrlib.tests.test__chk_map.load_tests as an example.
4051
:param standard_tests: A test suite to permute
4052
:param loader: A TestLoader
4053
:param py_module_name: The python path to a python module that can always
4054
be loaded, and will be considered the 'python' implementation. (eg
4055
'bzrlib._chk_map_py')
4056
:param ext_module_name: The python path to an extension module. If the
4057
module cannot be loaded, a single test will be added, which notes that
4058
the module is not available. If it can be loaded, all standard_tests
4059
will be run against that module.
4060
:return: (suite, feature) suite is a test-suite that has all the permuted
4061
tests. feature is the Feature object that can be used to determine if
4062
the module is available.
4065
py_module = __import__(py_module_name, {}, {}, ['NO_SUCH_ATTRIB'])
4067
('python', {'module': py_module}),
4069
suite = loader.suiteClass()
4070
feature = ModuleAvailableFeature(ext_module_name)
4071
if feature.available():
4072
scenarios.append(('C', {'module': feature.module}))
4074
# the compiled module isn't available, so we add a failing test
4075
class FailWithoutFeature(TestCase):
4076
def test_fail(self):
4077
self.requireFeature(feature)
4078
suite.addTest(loader.loadTestsFromTestCase(FailWithoutFeature))
4079
result = multiply_tests(standard_tests, scenarios, suite)
4080
return result, feature
4083
def _rmtree_temp_dir(dirname, test_id=None):
4045
def _rmtree_temp_dir(dirname):
4084
4046
# If LANG=C we probably have created some bogus paths
4085
4047
# which rmtree(unicode) will fail to delete
4086
4048
# so make sure we are using rmtree(str) to delete everything
4190
4149
UnicodeFilenameFeature = _UnicodeFilenameFeature()
4193
class _CompatabilityThunkFeature(Feature):
4194
"""This feature is just a thunk to another feature.
4196
It issues a deprecation warning if it is accessed, to let you know that you
4197
should really use a different feature.
4200
def __init__(self, dep_version, module, name,
4201
replacement_name, replacement_module=None):
4202
super(_CompatabilityThunkFeature, self).__init__()
4203
self._module = module
4204
if replacement_module is None:
4205
replacement_module = module
4206
self._replacement_module = replacement_module
4208
self._replacement_name = replacement_name
4209
self._dep_version = dep_version
4210
self._feature = None
4213
if self._feature is None:
4214
depr_msg = self._dep_version % ('%s.%s'
4215
% (self._module, self._name))
4216
use_msg = ' Use %s.%s instead.' % (self._replacement_module,
4217
self._replacement_name)
4218
symbol_versioning.warn(depr_msg + use_msg, DeprecationWarning)
4219
# Import the new feature and use it as a replacement for the
4221
mod = __import__(self._replacement_module, {}, {},
4222
[self._replacement_name])
4223
self._feature = getattr(mod, self._replacement_name)
4227
return self._feature._probe()
4230
class ModuleAvailableFeature(Feature):
4231
"""This is a feature than describes a module we want to be available.
4233
Declare the name of the module in __init__(), and then after probing, the
4234
module will be available as 'self.module'.
4236
:ivar module: The module if it is available, else None.
4239
def __init__(self, module_name):
4240
super(ModuleAvailableFeature, self).__init__()
4241
self.module_name = module_name
4245
self._module = __import__(self.module_name, {}, {}, [''])
4252
if self.available(): # Make sure the probe has been done
4256
def feature_name(self):
4257
return self.module_name
4260
# This is kept here for compatibility, it is recommended to use
4261
# 'bzrlib.tests.feature.paramiko' instead
4262
ParamikoFeature = _CompatabilityThunkFeature(
4263
deprecated_in((2,1,0)),
4264
'bzrlib.tests.features', 'ParamikoFeature', 'paramiko')
4267
4152
def probe_unicode_in_user_encoding():
4268
4153
"""Try to encode several unicode strings to use in unicode-aware tests.
4269
4154
Return first successfull match.
4349
4251
UTF8Filesystem = _UTF8Filesystem()
4352
class _BreakinFeature(Feature):
4353
"""Does this platform support the breakin feature?"""
4356
from bzrlib import breakin
4357
if breakin.determine_signal() is None:
4359
if sys.platform == 'win32':
4360
# Windows doesn't have os.kill, and we catch the SIGBREAK signal.
4361
# We trigger SIGBREAK via a Console api so we need ctypes to
4362
# access the function
4369
def feature_name(self):
4370
return "SIGQUIT or SIGBREAK w/ctypes on win32"
4373
BreakinFeature = _BreakinFeature()
4376
4254
class _CaseInsCasePresFilenameFeature(Feature):
4377
4255
"""Is the file-system case insensitive, but case-preserving?"""
4428
4306
CaseInsensitiveFilesystemFeature = _CaseInsensitiveFilesystemFeature()
4431
class _CaseSensitiveFilesystemFeature(Feature):
4309
class _SubUnitFeature(Feature):
4310
"""Check if subunit is available."""
4433
4312
def _probe(self):
4434
if CaseInsCasePresFilenameFeature.available():
4436
elif CaseInsensitiveFilesystemFeature.available():
4441
4319
def feature_name(self):
4442
return 'case-sensitive filesystem'
4444
# new coding style is for feature instances to be lowercase
4445
case_sensitive_filesystem_feature = _CaseSensitiveFilesystemFeature()
4448
# Kept for compatibility, use bzrlib.tests.features.subunit instead
4449
SubUnitFeature = _CompatabilityThunkFeature(
4450
deprecated_in((2,1,0)),
4451
'bzrlib.tests.features', 'SubUnitFeature', 'subunit')
4322
SubUnitFeature = _SubUnitFeature()
4452
4323
# Only define SubUnitBzrRunner if subunit is available.
4454
4325
from subunit import TestProtocolClient
4455
from subunit.test_results import AutoTimingTestResultDecorator
4327
from subunit.test_results import AutoTimingTestResultDecorator
4329
AutoTimingTestResultDecorator = lambda x:x
4456
4330
class SubUnitBzrRunner(TextTestRunner):
4457
4331
def run(self, test):
4458
4332
result = AutoTimingTestResultDecorator(
added
removed
bzrlib/tests/__init__.py
