1128
def test_bench_history(self):
1129
# tests that the running the benchmark produces a history file
1130
# containing a timestamp and the revision id of the bzrlib source which
1132
workingtree = _get_bzr_source_tree()
1133
test = TestRunner('dummy_test')
1135
runner = tests.TextTestRunner(stream=self._log_file,
1136
bench_history=output)
1137
result = self.run_test_runner(runner, test)
1138
output_string = output.getvalue()
1139
self.assertContainsRe(output_string, "--date [0-9.]+")
1140
if workingtree is not None:
1141
revision_id = workingtree.get_parent_ids()[0]
1142
self.assertEndsWith(output_string.rstrip(), revision_id)
1144
def assertLogDeleted(self, test):
1145
log = test._get_log()
1146
self.assertEqual("DELETED log file to reduce memory footprint", log)
1147
self.assertEqual('', test._log_contents)
1148
self.assertIs(None, test._log_file_name)
1150
def test_success_log_deleted(self):
1151
"""Successful tests have their log deleted"""
1153
class LogTester(tests.TestCase):
1155
def test_success(self):
1156
self.log('this will be removed\n')
1159
runner = tests.TextTestRunner(stream=sio)
1160
test = LogTester('test_success')
1161
result = self.run_test_runner(runner, test)
1163
self.assertLogDeleted(test)
1165
def test_skipped_log_deleted(self):
1166
"""Skipped tests have their log deleted"""
1168
class LogTester(tests.TestCase):
1170
def test_skipped(self):
1171
self.log('this will be removed\n')
1172
raise tests.TestSkipped()
1175
runner = tests.TextTestRunner(stream=sio)
1176
test = LogTester('test_skipped')
1177
result = self.run_test_runner(runner, test)
1179
self.assertLogDeleted(test)
1181
def test_not_aplicable_log_deleted(self):
1182
"""Not applicable tests have their log deleted"""
1184
class LogTester(tests.TestCase):
1186
def test_not_applicable(self):
1187
self.log('this will be removed\n')
1188
raise tests.TestNotApplicable()
1191
runner = tests.TextTestRunner(stream=sio)
1192
test = LogTester('test_not_applicable')
1193
result = self.run_test_runner(runner, test)
1195
self.assertLogDeleted(test)
1197
def test_known_failure_log_deleted(self):
1198
"""Know failure tests have their log deleted"""
1200
class LogTester(tests.TestCase):
1202
def test_known_failure(self):
1203
self.log('this will be removed\n')
1204
raise tests.KnownFailure()
1207
runner = tests.TextTestRunner(stream=sio)
1208
test = LogTester('test_known_failure')
1209
result = self.run_test_runner(runner, test)
1211
self.assertLogDeleted(test)
1213
def test_fail_log_kept(self):
1214
"""Failed tests have their log kept"""
1216
class LogTester(tests.TestCase):
1218
def test_fail(self):
1219
self.log('this will be kept\n')
1220
self.fail('this test fails')
1223
runner = tests.TextTestRunner(stream=sio)
1224
test = LogTester('test_fail')
1225
result = self.run_test_runner(runner, test)
1227
text = sio.getvalue()
1228
self.assertContainsRe(text, 'this will be kept')
1229
self.assertContainsRe(text, 'this test fails')
1231
log = test._get_log()
1232
self.assertContainsRe(log, 'this will be kept')
1233
self.assertEqual(log, test._log_contents)
1235
def test_error_log_kept(self):
1236
"""Tests with errors have their log kept"""
1238
class LogTester(tests.TestCase):
1240
def test_error(self):
1241
self.log('this will be kept\n')
1242
raise ValueError('random exception raised')
1245
runner = tests.TextTestRunner(stream=sio)
1246
test = LogTester('test_error')
1247
result = self.run_test_runner(runner, test)
1249
text = sio.getvalue()
1250
self.assertContainsRe(text, 'this will be kept')
1251
self.assertContainsRe(text, 'random exception raised')
1253
log = test._get_log()
1254
self.assertContainsRe(log, 'this will be kept')
1255
self.assertEqual(log, test._log_contents)
1223
def test_verbose_test_count(self):
1224
"""A verbose test run reports the right test count at the start"""
1225
suite = TestUtil.TestSuite([
1226
unittest.FunctionTestCase(lambda:None),
1227
unittest.FunctionTestCase(lambda:None)])
1228
self.assertEqual(suite.countTestCases(), 2)
1230
runner = tests.TextTestRunner(stream=stream, verbosity=2)
1231
# Need to use the CountingDecorator as that's what sets num_tests
1232
result = self.run_test_runner(runner, tests.CountingDecorator(suite))
1233
self.assertStartsWith(stream.getvalue(), "running 2 tests")
1235
def test_startTestRun(self):
1236
"""run should call result.startTestRun()"""
1238
class LoggingDecorator(ExtendedToOriginalDecorator):
1239
def startTestRun(self):
1240
ExtendedToOriginalDecorator.startTestRun(self)
1241
calls.append('startTestRun')
1242
test = unittest.FunctionTestCase(lambda:None)
1244
runner = tests.TextTestRunner(stream=stream,
1245
result_decorators=[LoggingDecorator])
1246
result = self.run_test_runner(runner, test)
1247
self.assertLength(1, calls)
1249
def test_stopTestRun(self):
1250
"""run should call result.stopTestRun()"""
1252
class LoggingDecorator(ExtendedToOriginalDecorator):
1253
def stopTestRun(self):
1254
ExtendedToOriginalDecorator.stopTestRun(self)
1255
calls.append('stopTestRun')
1256
test = unittest.FunctionTestCase(lambda:None)
1258
runner = tests.TextTestRunner(stream=stream,
1259
result_decorators=[LoggingDecorator])
1260
result = self.run_test_runner(runner, test)
1261
self.assertLength(1, calls)
1263
def test_unicode_test_output_on_ascii_stream(self):
1264
"""Showing results should always succeed even on an ascii console"""
1265
class FailureWithUnicode(tests.TestCase):
1266
def test_log_unicode(self):
1268
self.fail("Now print that log!")
1270
self.overrideAttr(osutils, "get_terminal_encoding",
1271
lambda trace=False: "ascii")
1272
result = self.run_test_runner(tests.TextTestRunner(stream=out),
1273
FailureWithUnicode("test_log_unicode"))
1274
self.assertContainsRe(out.getvalue(),
1275
"(?:Text attachment: )?log"
1277
"\d+\.\d+ \\\\u2606"
1258
1281
class SampleTestCase(tests.TestCase):
1565
1654
self.assertRaises(AssertionError,
1566
1655
self.assertListRaises, _TestException, success_generator)
1657
def _run_successful_test(self, test):
1658
result = testtools.TestResult()
1660
self.assertTrue(result.wasSuccessful())
1663
def test_overrideAttr_without_value(self):
1664
self.test_attr = 'original' # Define a test attribute
1665
obj = self # Make 'obj' visible to the embedded test
1666
class Test(tests.TestCase):
1669
super(Test, self).setUp()
1670
self.orig = self.overrideAttr(obj, 'test_attr')
1672
def test_value(self):
1673
self.assertEqual('original', self.orig)
1674
self.assertEqual('original', obj.test_attr)
1675
obj.test_attr = 'modified'
1676
self.assertEqual('modified', obj.test_attr)
1678
self._run_successful_test(Test('test_value'))
1679
self.assertEqual('original', obj.test_attr)
1681
def test_overrideAttr_with_value(self):
1682
self.test_attr = 'original' # Define a test attribute
1683
obj = self # Make 'obj' visible to the embedded test
1684
class Test(tests.TestCase):
1687
super(Test, self).setUp()
1688
self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
1690
def test_value(self):
1691
self.assertEqual('original', self.orig)
1692
self.assertEqual('modified', obj.test_attr)
1694
self._run_successful_test(Test('test_value'))
1695
self.assertEqual('original', obj.test_attr)
1697
def test_overrideAttr_with_no_existing_value_and_value(self):
1698
# Do not define the test_attribute
1699
obj = self # Make 'obj' visible to the embedded test
1700
class Test(tests.TestCase):
1703
tests.TestCase.setUp(self)
1704
self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
1706
def test_value(self):
1707
self.assertEqual(tests._unitialized_attr, self.orig)
1708
self.assertEqual('modified', obj.test_attr)
1710
self._run_successful_test(Test('test_value'))
1711
self.assertRaises(AttributeError, getattr, obj, 'test_attr')
1713
def test_overrideAttr_with_no_existing_value_and_no_value(self):
1714
# Do not define the test_attribute
1715
obj = self # Make 'obj' visible to the embedded test
1716
class Test(tests.TestCase):
1719
tests.TestCase.setUp(self)
1720
self.orig = self.overrideAttr(obj, 'test_attr')
1722
def test_value(self):
1723
self.assertEqual(tests._unitialized_attr, self.orig)
1724
self.assertRaises(AttributeError, getattr, obj, 'test_attr')
1726
self._run_successful_test(Test('test_value'))
1727
self.assertRaises(AttributeError, getattr, obj, 'test_attr')
1729
def test_recordCalls(self):
1730
from bzrlib.tests import test_selftest
1731
calls = self.recordCalls(
1732
test_selftest, '_add_numbers')
1733
self.assertEqual(test_selftest._add_numbers(2, 10),
1735
self.assertEqual(calls, [((2, 10), {})])
1738
def _add_numbers(a, b):
1742
class _MissingFeature(features.Feature):
1745
missing_feature = _MissingFeature()
1748
def _get_test(name):
1749
"""Get an instance of a specific example test.
1751
We protect this in a function so that they don't auto-run in the test
1755
class ExampleTests(tests.TestCase):
1757
def test_fail(self):
1758
mutter('this was a failing test')
1759
self.fail('this test will fail')
1761
def test_error(self):
1762
mutter('this test errored')
1763
raise RuntimeError('gotcha')
1765
def test_missing_feature(self):
1766
mutter('missing the feature')
1767
self.requireFeature(missing_feature)
1769
def test_skip(self):
1770
mutter('this test will be skipped')
1771
raise tests.TestSkipped('reason')
1773
def test_success(self):
1774
mutter('this test succeeds')
1776
def test_xfail(self):
1777
mutter('test with expected failure')
1778
self.knownFailure('this_fails')
1780
def test_unexpected_success(self):
1781
mutter('test with unexpected success')
1782
self.expectFailure('should_fail', lambda: None)
1784
return ExampleTests(name)
1787
class TestTestCaseLogDetails(tests.TestCase):
1789
def _run_test(self, test_name):
1790
test = _get_test(test_name)
1791
result = testtools.TestResult()
1795
def test_fail_has_log(self):
1796
result = self._run_test('test_fail')
1797
self.assertEqual(1, len(result.failures))
1798
result_content = result.failures[0][1]
1799
self.assertContainsRe(result_content,
1800
'(?m)^(?:Text attachment: )?log(?:$|: )')
1801
self.assertContainsRe(result_content, 'this was a failing test')
1803
def test_error_has_log(self):
1804
result = self._run_test('test_error')
1805
self.assertEqual(1, len(result.errors))
1806
result_content = result.errors[0][1]
1807
self.assertContainsRe(result_content,
1808
'(?m)^(?:Text attachment: )?log(?:$|: )')
1809
self.assertContainsRe(result_content, 'this test errored')
1811
def test_skip_has_no_log(self):
1812
result = self._run_test('test_skip')
1813
self.assertEqual(['reason'], result.skip_reasons.keys())
1814
skips = result.skip_reasons['reason']
1815
self.assertEqual(1, len(skips))
1817
self.assertFalse('log' in test.getDetails())
1819
def test_missing_feature_has_no_log(self):
1820
# testtools doesn't know about addNotSupported, so it just gets
1821
# considered as a skip
1822
result = self._run_test('test_missing_feature')
1823
self.assertEqual([missing_feature], result.skip_reasons.keys())
1824
skips = result.skip_reasons[missing_feature]
1825
self.assertEqual(1, len(skips))
1827
self.assertFalse('log' in test.getDetails())
1829
def test_xfail_has_no_log(self):
1830
result = self._run_test('test_xfail')
1831
self.assertEqual(1, len(result.expectedFailures))
1832
result_content = result.expectedFailures[0][1]
1833
self.assertNotContainsRe(result_content,
1834
'(?m)^(?:Text attachment: )?log(?:$|: )')
1835
self.assertNotContainsRe(result_content, 'test with expected failure')
1837
def test_unexpected_success_has_log(self):
1838
result = self._run_test('test_unexpected_success')
1839
self.assertEqual(1, len(result.unexpectedSuccesses))
1840
# Inconsistency, unexpectedSuccesses is a list of tests,
1841
# expectedFailures is a list of reasons?
1842
test = result.unexpectedSuccesses[0]
1843
details = test.getDetails()
1844
self.assertTrue('log' in details)
1847
class TestTestCloning(tests.TestCase):
1848
"""Tests that test cloning of TestCases (as used by multiply_tests)."""
1850
def test_cloned_testcase_does_not_share_details(self):
1851
"""A TestCase cloned with clone_test does not share mutable attributes
1852
such as details or cleanups.
1854
class Test(tests.TestCase):
1856
self.addDetail('foo', Content('text/plain', lambda: 'foo'))
1857
orig_test = Test('test_foo')
1858
cloned_test = tests.clone_test(orig_test, orig_test.id() + '(cloned)')
1859
orig_test.run(unittest.TestResult())
1860
self.assertEqual('foo', orig_test.getDetails()['foo'].iter_bytes())
1861
self.assertEqual(None, cloned_test.getDetails().get('foo'))
1863
def test_double_apply_scenario_preserves_first_scenario(self):
1864
"""Applying two levels of scenarios to a test preserves the attributes
1865
added by both scenarios.
1867
class Test(tests.TestCase):
1870
test = Test('test_foo')
1871
scenarios_x = [('x=1', {'x': 1}), ('x=2', {'x': 2})]
1872
scenarios_y = [('y=1', {'y': 1}), ('y=2', {'y': 2})]
1873
suite = tests.multiply_tests(test, scenarios_x, unittest.TestSuite())
1874
suite = tests.multiply_tests(suite, scenarios_y, unittest.TestSuite())
1875
all_tests = list(tests.iter_suite_tests(suite))
1876
self.assertLength(4, all_tests)
1877
all_xys = sorted((t.x, t.y) for t in all_tests)
1878
self.assertEqual([(1, 1), (1, 2), (2, 1), (2, 2)], all_xys)
1569
1881
# NB: Don't delete this; it's not actually from 0.11!
1570
1882
@deprecated_function(deprecated_in((0, 11, 0)))
1725
2065
test_suite_factory=factory)
1726
2066
self.assertEqual([True], factory_called)
1729
class TestKnownFailure(tests.TestCase):
1731
def test_known_failure(self):
1732
"""Check that KnownFailure is defined appropriately."""
1733
# a KnownFailure is an assertion error for compatability with unaware
1735
self.assertIsInstance(tests.KnownFailure(""), AssertionError)
1737
def test_expect_failure(self):
1739
self.expectFailure("Doomed to failure", self.assertTrue, False)
1740
except tests.KnownFailure, e:
1741
self.assertEqual('Doomed to failure', e.args[0])
1743
self.expectFailure("Doomed to failure", self.assertTrue, True)
1744
except AssertionError, e:
1745
self.assertEqual('Unexpected success. Should have failed:'
1746
' Doomed to failure', e.args[0])
2069
"""A test suite factory."""
2070
class Test(tests.TestCase):
2077
return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
2079
def test_list_only(self):
2080
output = self.run_selftest(test_suite_factory=self.factory,
2082
self.assertEqual(3, len(output.readlines()))
2084
def test_list_only_filtered(self):
2085
output = self.run_selftest(test_suite_factory=self.factory,
2086
list_only=True, pattern="Test.b")
2087
self.assertEndsWith(output.getvalue(), "Test.b\n")
2088
self.assertLength(1, output.readlines())
2090
def test_list_only_excludes(self):
2091
output = self.run_selftest(test_suite_factory=self.factory,
2092
list_only=True, exclude_pattern="Test.b")
2093
self.assertNotContainsRe("Test.b", output.getvalue())
2094
self.assertLength(2, output.readlines())
2096
def test_lsprof_tests(self):
2097
self.requireFeature(features.lsprof_feature)
2100
def __call__(test, result):
2102
def run(test, result):
2103
results.append(result)
2104
def countTestCases(self):
2106
self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
2107
self.assertLength(1, results)
2108
self.assertIsInstance(results.pop(), ExtendedToOriginalDecorator)
2110
def test_random(self):
2111
# test randomising by listing a number of tests.
2112
output_123 = self.run_selftest(test_suite_factory=self.factory,
2113
list_only=True, random_seed="123")
2114
output_234 = self.run_selftest(test_suite_factory=self.factory,
2115
list_only=True, random_seed="234")
2116
self.assertNotEqual(output_123, output_234)
2117
# "Randominzing test order..\n\n
2118
self.assertLength(5, output_123.readlines())
2119
self.assertLength(5, output_234.readlines())
2121
def test_random_reuse_is_same_order(self):
2122
# test randomising by listing a number of tests.
2123
expected = self.run_selftest(test_suite_factory=self.factory,
2124
list_only=True, random_seed="123")
2125
repeated = self.run_selftest(test_suite_factory=self.factory,
2126
list_only=True, random_seed="123")
2127
self.assertEqual(expected.getvalue(), repeated.getvalue())
2129
def test_runner_class(self):
2130
self.requireFeature(features.subunit)
2131
from subunit import ProtocolTestCase
2132
stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
2133
test_suite_factory=self.factory)
2134
test = ProtocolTestCase(stream)
2135
result = unittest.TestResult()
2137
self.assertEqual(3, result.testsRun)
2139
def test_starting_with_single_argument(self):
2140
output = self.run_selftest(test_suite_factory=self.factory,
2141
starting_with=['bzrlib.tests.test_selftest.Test.a'],
2143
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
2146
def test_starting_with_multiple_argument(self):
2147
output = self.run_selftest(test_suite_factory=self.factory,
2148
starting_with=['bzrlib.tests.test_selftest.Test.a',
2149
'bzrlib.tests.test_selftest.Test.b'],
2151
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
2152
'bzrlib.tests.test_selftest.Test.b\n',
2155
def check_transport_set(self, transport_server):
2156
captured_transport = []
2157
def seen_transport(a_transport):
2158
captured_transport.append(a_transport)
2159
class Capture(tests.TestCase):
2161
seen_transport(bzrlib.tests.default_transport)
2163
return TestUtil.TestSuite([Capture("a")])
2164
self.run_selftest(transport=transport_server, test_suite_factory=factory)
2165
self.assertEqual(transport_server, captured_transport[0])
2167
def test_transport_sftp(self):
2168
self.requireFeature(features.paramiko)
2169
from bzrlib.tests import stub_sftp
2170
self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
2172
def test_transport_memory(self):
2173
self.check_transport_set(memory.MemoryServer)
2176
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
2177
# Does IO: reads test.list
2179
def test_load_list(self):
2180
# Provide a list with one test - this test.
2181
test_id_line = '%s\n' % self.id()
2182
self.build_tree_contents([('test.list', test_id_line)])
2183
# And generate a list of the tests in the suite.
2184
stream = self.run_selftest(load_list='test.list', list_only=True)
2185
self.assertEqual(test_id_line, stream.getvalue())
2187
def test_load_unknown(self):
2188
# Provide a list with one test - this test.
2189
# And generate a list of the tests in the suite.
2190
err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
2191
load_list='missing file name', list_only=True)
2194
class TestSubunitLogDetails(tests.TestCase, SelfTestHelper):
2196
_test_needs_features = [features.subunit]
2198
def run_subunit_stream(self, test_name):
2199
from subunit import ProtocolTestCase
2201
return TestUtil.TestSuite([_get_test(test_name)])
2202
stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
2203
test_suite_factory=factory)
2204
test = ProtocolTestCase(stream)
2205
result = testtools.TestResult()
2207
content = stream.getvalue()
2208
return content, result
2210
def test_fail_has_log(self):
2211
content, result = self.run_subunit_stream('test_fail')
2212
self.assertEqual(1, len(result.failures))
2213
self.assertContainsRe(content, '(?m)^log$')
2214
self.assertContainsRe(content, 'this test will fail')
2216
def test_error_has_log(self):
2217
content, result = self.run_subunit_stream('test_error')
2218
self.assertContainsRe(content, '(?m)^log$')
2219
self.assertContainsRe(content, 'this test errored')
2221
def test_skip_has_no_log(self):
2222
content, result = self.run_subunit_stream('test_skip')
2223
self.assertNotContainsRe(content, '(?m)^log$')
2224
self.assertNotContainsRe(content, 'this test will be skipped')
2225
self.assertEqual(['reason'], result.skip_reasons.keys())
2226
skips = result.skip_reasons['reason']
2227
self.assertEqual(1, len(skips))
2229
# RemotedTestCase doesn't preserve the "details"
2230
## self.assertFalse('log' in test.getDetails())
2232
def test_missing_feature_has_no_log(self):
2233
content, result = self.run_subunit_stream('test_missing_feature')
2234
self.assertNotContainsRe(content, '(?m)^log$')
2235
self.assertNotContainsRe(content, 'missing the feature')
2236
self.assertEqual(['_MissingFeature\n'], result.skip_reasons.keys())
2237
skips = result.skip_reasons['_MissingFeature\n']
2238
self.assertEqual(1, len(skips))
2240
# RemotedTestCase doesn't preserve the "details"
2241
## self.assertFalse('log' in test.getDetails())
2243
def test_xfail_has_no_log(self):
2244
content, result = self.run_subunit_stream('test_xfail')
2245
self.assertNotContainsRe(content, '(?m)^log$')
2246
self.assertNotContainsRe(content, 'test with expected failure')
2247
self.assertEqual(1, len(result.expectedFailures))
2248
result_content = result.expectedFailures[0][1]
2249
self.assertNotContainsRe(result_content,
2250
'(?m)^(?:Text attachment: )?log(?:$|: )')
2251
self.assertNotContainsRe(result_content, 'test with expected failure')
2253
def test_unexpected_success_has_log(self):
2254
content, result = self.run_subunit_stream('test_unexpected_success')
2255
self.assertContainsRe(content, '(?m)^log$')
2256
self.assertContainsRe(content, 'test with unexpected success')
2257
# GZ 2011-05-18: Old versions of subunit treat unexpected success as a
2258
# success, if a min version check is added remove this
2259
from subunit import TestProtocolClient as _Client
2260
if _Client.addUnexpectedSuccess.im_func is _Client.addSuccess.im_func:
2261
self.expectFailure('subunit treats "unexpectedSuccess"'
2262
' as a plain success',
2263
self.assertEqual, 1, len(result.unexpectedSuccesses))
2264
self.assertEqual(1, len(result.unexpectedSuccesses))
2265
test = result.unexpectedSuccesses[0]
2266
# RemotedTestCase doesn't preserve the "details"
2267
## self.assertTrue('log' in test.getDetails())
2269
def test_success_has_no_log(self):
2270
content, result = self.run_subunit_stream('test_success')
2271
self.assertEqual(1, result.testsRun)
2272
self.assertNotContainsRe(content, '(?m)^log$')
2273
self.assertNotContainsRe(content, 'this test succeeds')
2276
class TestRunBzr(tests.TestCase):
2281
def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
2283
"""Override _run_bzr_core to test how it is invoked by run_bzr.
2285
Attempts to run bzr from inside this class don't actually run it.
2287
We test how run_bzr actually invokes bzr in another location. Here we
2288
only need to test that it passes the right parameters to run_bzr.
2290
self.argv = list(argv)
2291
self.retcode = retcode
2292
self.encoding = encoding
2294
self.working_dir = working_dir
2295
return self.retcode, self.out, self.err
2297
def test_run_bzr_error(self):
2298
self.out = "It sure does!\n"
2299
out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
2300
self.assertEqual(['rocks'], self.argv)
2301
self.assertEqual(34, self.retcode)
2302
self.assertEqual('It sure does!\n', out)
2303
self.assertEqual(out, self.out)
2304
self.assertEqual('', err)
2305
self.assertEqual(err, self.err)
2307
def test_run_bzr_error_regexes(self):
2309
self.err = "bzr: ERROR: foobarbaz is not versioned"
2310
out, err = self.run_bzr_error(
2311
["bzr: ERROR: foobarbaz is not versioned"],
2312
['file-id', 'foobarbaz'])
2314
def test_encoding(self):
2315
"""Test that run_bzr passes encoding to _run_bzr_core"""
2316
self.run_bzr('foo bar')
2317
self.assertEqual(None, self.encoding)
2318
self.assertEqual(['foo', 'bar'], self.argv)
2320
self.run_bzr('foo bar', encoding='baz')
2321
self.assertEqual('baz', self.encoding)
2322
self.assertEqual(['foo', 'bar'], self.argv)
2324
def test_retcode(self):
2325
"""Test that run_bzr passes retcode to _run_bzr_core"""
2326
# Default is retcode == 0
2327
self.run_bzr('foo bar')
2328
self.assertEqual(0, self.retcode)
2329
self.assertEqual(['foo', 'bar'], self.argv)
2331
self.run_bzr('foo bar', retcode=1)
2332
self.assertEqual(1, self.retcode)
2333
self.assertEqual(['foo', 'bar'], self.argv)
2335
self.run_bzr('foo bar', retcode=None)
2336
self.assertEqual(None, self.retcode)
2337
self.assertEqual(['foo', 'bar'], self.argv)
2339
self.run_bzr(['foo', 'bar'], retcode=3)
2340
self.assertEqual(3, self.retcode)
2341
self.assertEqual(['foo', 'bar'], self.argv)
2343
def test_stdin(self):
2344
# test that the stdin keyword to run_bzr is passed through to
2345
# _run_bzr_core as-is. We do this by overriding
2346
# _run_bzr_core in this class, and then calling run_bzr,
2347
# which is a convenience function for _run_bzr_core, so
2349
self.run_bzr('foo bar', stdin='gam')
2350
self.assertEqual('gam', self.stdin)
2351
self.assertEqual(['foo', 'bar'], self.argv)
2353
self.run_bzr('foo bar', stdin='zippy')
2354
self.assertEqual('zippy', self.stdin)
2355
self.assertEqual(['foo', 'bar'], self.argv)
2357
def test_working_dir(self):
2358
"""Test that run_bzr passes working_dir to _run_bzr_core"""
2359
self.run_bzr('foo bar')
2360
self.assertEqual(None, self.working_dir)
2361
self.assertEqual(['foo', 'bar'], self.argv)
2363
self.run_bzr('foo bar', working_dir='baz')
2364
self.assertEqual('baz', self.working_dir)
2365
self.assertEqual(['foo', 'bar'], self.argv)
2367
def test_reject_extra_keyword_arguments(self):
2368
self.assertRaises(TypeError, self.run_bzr, "foo bar",
2369
error_regex=['error message'])
2372
class TestRunBzrCaptured(tests.TestCaseWithTransport):
2373
# Does IO when testing the working_dir parameter.
2375
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2376
a_callable=None, *args, **kwargs):
2378
self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
2379
self.factory = bzrlib.ui.ui_factory
2380
self.working_dir = osutils.getcwd()
2381
stdout.write('foo\n')
2382
stderr.write('bar\n')
2385
def test_stdin(self):
2386
# test that the stdin keyword to _run_bzr_core is passed through to
2387
# apply_redirected as a StringIO. We do this by overriding
2388
# apply_redirected in this class, and then calling _run_bzr_core,
2389
# which calls apply_redirected.
2390
self.run_bzr(['foo', 'bar'], stdin='gam')
2391
self.assertEqual('gam', self.stdin.read())
2392
self.assertTrue(self.stdin is self.factory_stdin)
2393
self.run_bzr(['foo', 'bar'], stdin='zippy')
2394
self.assertEqual('zippy', self.stdin.read())
2395
self.assertTrue(self.stdin is self.factory_stdin)
2397
def test_ui_factory(self):
2398
# each invocation of self.run_bzr should get its
2399
# own UI factory, which is an instance of TestUIFactory,
2400
# with stdin, stdout and stderr attached to the stdin,
2401
# stdout and stderr of the invoked run_bzr
2402
current_factory = bzrlib.ui.ui_factory
2403
self.run_bzr(['foo'])
2404
self.assertFalse(current_factory is self.factory)
2405
self.assertNotEqual(sys.stdout, self.factory.stdout)
2406
self.assertNotEqual(sys.stderr, self.factory.stderr)
2407
self.assertEqual('foo\n', self.factory.stdout.getvalue())
2408
self.assertEqual('bar\n', self.factory.stderr.getvalue())
2409
self.assertIsInstance(self.factory, tests.TestUIFactory)
2411
def test_working_dir(self):
2412
self.build_tree(['one/', 'two/'])
2413
cwd = osutils.getcwd()
2415
# Default is to work in the current directory
2416
self.run_bzr(['foo', 'bar'])
2417
self.assertEqual(cwd, self.working_dir)
2419
self.run_bzr(['foo', 'bar'], working_dir=None)
2420
self.assertEqual(cwd, self.working_dir)
2422
# The function should be run in the alternative directory
2423
# but afterwards the current working dir shouldn't be changed
2424
self.run_bzr(['foo', 'bar'], working_dir='one')
2425
self.assertNotEqual(cwd, self.working_dir)
2426
self.assertEndsWith(self.working_dir, 'one')
2427
self.assertEqual(cwd, osutils.getcwd())
2429
self.run_bzr(['foo', 'bar'], working_dir='two')
2430
self.assertNotEqual(cwd, self.working_dir)
2431
self.assertEndsWith(self.working_dir, 'two')
2432
self.assertEqual(cwd, osutils.getcwd())
2435
class StubProcess(object):
2436
"""A stub process for testing run_bzr_subprocess."""
2438
def __init__(self, out="", err="", retcode=0):
2441
self.returncode = retcode
2443
def communicate(self):
2444
return self.out, self.err
2447
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
2448
"""Base class for tests testing how we might run bzr."""
2451
super(TestWithFakedStartBzrSubprocess, self).setUp()
2452
self.subprocess_calls = []
2454
def start_bzr_subprocess(self, process_args, env_changes=None,
2455
skip_if_plan_to_signal=False,
2457
allow_plugins=False):
2458
"""capture what run_bzr_subprocess tries to do."""
2459
self.subprocess_calls.append({'process_args':process_args,
2460
'env_changes':env_changes,
2461
'skip_if_plan_to_signal':skip_if_plan_to_signal,
2462
'working_dir':working_dir, 'allow_plugins':allow_plugins})
2463
return self.next_subprocess
2466
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
2468
def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
2469
"""Run run_bzr_subprocess with args and kwargs using a stubbed process.
2471
Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
2472
that will return static results. This assertion method populates those
2473
results and also checks the arguments run_bzr_subprocess generates.
2475
self.next_subprocess = process
2477
result = self.run_bzr_subprocess(*args, **kwargs)
2479
self.next_subprocess = None
2480
for key, expected in expected_args.iteritems():
2481
self.assertEqual(expected, self.subprocess_calls[-1][key])
1748
self.fail('Assertion not raised')
1751
class TestFeature(tests.TestCase):
1753
def test_caching(self):
1754
"""Feature._probe is called by the feature at most once."""
1755
class InstrumentedFeature(tests.Feature):
1757
super(InstrumentedFeature, self).__init__()
1760
self.calls.append('_probe')
1762
feature = InstrumentedFeature()
1764
self.assertEqual(['_probe'], feature.calls)
1766
self.assertEqual(['_probe'], feature.calls)
1768
def test_named_str(self):
1769
"""Feature.__str__ should thunk to feature_name()."""
1770
class NamedFeature(tests.Feature):
1771
def feature_name(self):
1773
feature = NamedFeature()
1774
self.assertEqual('symlinks', str(feature))
1776
def test_default_str(self):
1777
"""Feature.__str__ should default to __class__.__name__."""
1778
class NamedFeature(tests.Feature):
1780
feature = NamedFeature()
1781
self.assertEqual('NamedFeature', str(feature))
1784
class TestUnavailableFeature(tests.TestCase):
1786
def test_access_feature(self):
1787
feature = tests.Feature()
1788
exception = tests.UnavailableFeature(feature)
1789
self.assertIs(feature, exception.args[0])
2484
self.next_subprocess = None
2485
for key, expected in expected_args.iteritems():
2486
self.assertEqual(expected, self.subprocess_calls[-1][key])
2489
def test_run_bzr_subprocess(self):
2490
"""The run_bzr_helper_external command behaves nicely."""
2491
self.assertRunBzrSubprocess({'process_args':['--version']},
2492
StubProcess(), '--version')
2493
self.assertRunBzrSubprocess({'process_args':['--version']},
2494
StubProcess(), ['--version'])
2495
# retcode=None disables retcode checking
2496
result = self.assertRunBzrSubprocess({},
2497
StubProcess(retcode=3), '--version', retcode=None)
2498
result = self.assertRunBzrSubprocess({},
2499
StubProcess(out="is free software"), '--version')
2500
self.assertContainsRe(result[0], 'is free software')
2501
# Running a subcommand that is missing errors
2502
self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
2503
{'process_args':['--versionn']}, StubProcess(retcode=3),
2505
# Unless it is told to expect the error from the subprocess
2506
result = self.assertRunBzrSubprocess({},
2507
StubProcess(retcode=3), '--versionn', retcode=3)
2508
# Or to ignore retcode checking
2509
result = self.assertRunBzrSubprocess({},
2510
StubProcess(err="unknown command", retcode=3), '--versionn',
2512
self.assertContainsRe(result[1], 'unknown command')
2514
def test_env_change_passes_through(self):
2515
self.assertRunBzrSubprocess(
2516
{'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
2518
env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
2520
def test_no_working_dir_passed_as_None(self):
2521
self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
2523
def test_no_working_dir_passed_through(self):
2524
self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
2527
def test_run_bzr_subprocess_no_plugins(self):
2528
self.assertRunBzrSubprocess({'allow_plugins': False},
2531
def test_allow_plugins(self):
2532
self.assertRunBzrSubprocess({'allow_plugins': True},
2533
StubProcess(), '', allow_plugins=True)
2536
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
2538
def test_finish_bzr_subprocess_with_error(self):
2539
"""finish_bzr_subprocess allows specification of the desired exit code.
2541
process = StubProcess(err="unknown command", retcode=3)
2542
result = self.finish_bzr_subprocess(process, retcode=3)
2543
self.assertEqual('', result[0])
2544
self.assertContainsRe(result[1], 'unknown command')
2546
def test_finish_bzr_subprocess_ignoring_retcode(self):
2547
"""finish_bzr_subprocess allows the exit code to be ignored."""
2548
process = StubProcess(err="unknown command", retcode=3)
2549
result = self.finish_bzr_subprocess(process, retcode=None)
2550
self.assertEqual('', result[0])
2551
self.assertContainsRe(result[1], 'unknown command')
2553
def test_finish_subprocess_with_unexpected_retcode(self):
2554
"""finish_bzr_subprocess raises self.failureException if the retcode is
2555
not the expected one.
2557
process = StubProcess(err="unknown command", retcode=3)
2558
self.assertRaises(self.failureException, self.finish_bzr_subprocess,
2562
class _DontSpawnProcess(Exception):
2563
"""A simple exception which just allows us to skip unnecessary steps"""
2566
class TestStartBzrSubProcess(tests.TestCase):
2567
"""Stub test start_bzr_subprocess."""
2569
def _subprocess_log_cleanup(self):
2570
"""Inhibits the base version as we don't produce a log file."""
2572
def _popen(self, *args, **kwargs):
2573
"""Override the base version to record the command that is run.
2575
From there we can ensure it is correct without spawning a real process.
2577
self.check_popen_state()
2578
self._popen_args = args
2579
self._popen_kwargs = kwargs
2580
raise _DontSpawnProcess()
2582
def check_popen_state(self):
2583
"""Replace to make assertions when popen is called."""
2585
def test_run_bzr_subprocess_no_plugins(self):
2586
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2587
command = self._popen_args[0]
2588
self.assertEqual(sys.executable, command[0])
2589
self.assertEqual(self.get_bzr_path(), command[1])
2590
self.assertEqual(['--no-plugins'], command[2:])
2592
def test_allow_plugins(self):
2593
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2595
command = self._popen_args[0]
2596
self.assertEqual([], command[2:])
2598
def test_set_env(self):
2599
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2601
def check_environment():
2602
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2603
self.check_popen_state = check_environment
2604
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2605
env_changes={'EXISTANT_ENV_VAR':'set variable'})
2606
# not set in theparent
2607
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2609
def test_run_bzr_subprocess_env_del(self):
2610
"""run_bzr_subprocess can remove environment variables too."""
2611
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2612
def check_environment():
2613
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2614
os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2615
self.check_popen_state = check_environment
2616
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2617
env_changes={'EXISTANT_ENV_VAR':None})
2618
# Still set in parent
2619
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2620
del os.environ['EXISTANT_ENV_VAR']
2622
def test_env_del_missing(self):
2623
self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2624
def check_environment():
2625
self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2626
self.check_popen_state = check_environment
2627
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2628
env_changes={'NON_EXISTANT_ENV_VAR':None})
2630
def test_working_dir(self):
2631
"""Test that we can specify the working dir for the child"""
2632
orig_getcwd = osutils.getcwd
2633
orig_chdir = os.chdir
2637
self.overrideAttr(os, 'chdir', chdir)
2640
self.overrideAttr(osutils, 'getcwd', getcwd)
2641
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2643
self.assertEqual(['foo', 'current'], chdirs)
2645
def test_get_bzr_path_with_cwd_bzrlib(self):
2646
self.get_source_path = lambda: ""
2647
self.overrideAttr(os.path, "isfile", lambda path: True)
2648
self.assertEqual(self.get_bzr_path(), "bzr")
2651
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2652
"""Tests that really need to do things with an external bzr."""
2654
def test_start_and_stop_bzr_subprocess_send_signal(self):
2655
"""finish_bzr_subprocess raises self.failureException if the retcode is
2656
not the expected one.
2658
self.disable_missing_extensions_warning()
2659
process = self.start_bzr_subprocess(['wait-until-signalled'],
2660
skip_if_plan_to_signal=True)
2661
self.assertEqual('running\n', process.stdout.readline())
2662
result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
2664
self.assertEqual('', result[0])
2665
self.assertEqual('bzr: interrupted\n', result[1])
1792
2668
class TestSelftestFiltering(tests.TestCase):
1794
2670
def setUp(self):
1795
tests.TestCase.setUp(self)
2671
super(TestSelftestFiltering, self).setUp()
1796
2672
self.suite = TestUtil.TestSuite()
1797
2673
self.loader = TestUtil.TestLoader()
1798
self.suite.addTest(self.loader.loadTestsFromModuleNames([
1799
'bzrlib.tests.test_selftest']))
2674
self.suite.addTest(self.loader.loadTestsFromModule(
2675
sys.modules['bzrlib.tests.test_selftest']))
1800
2676
self.all_names = _test_ids(self.suite)
1802
2678
def test_condition_id_re(self):
2258
3188
def test_predefined_prefixes(self):
2259
3189
tpr = tests.test_prefix_alias_registry
2260
self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
2261
self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
2262
self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
2263
self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
2264
self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
2265
self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
3190
self.assertEqual('bzrlib', tpr.resolve_alias('bzrlib'))
3191
self.assertEqual('bzrlib.doc', tpr.resolve_alias('bd'))
3192
self.assertEqual('bzrlib.utils', tpr.resolve_alias('bu'))
3193
self.assertEqual('bzrlib.tests', tpr.resolve_alias('bt'))
3194
self.assertEqual('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
3195
self.assertEqual('bzrlib.plugins', tpr.resolve_alias('bp'))
3198
class TestThreadLeakDetection(tests.TestCase):
3199
"""Ensure when tests leak threads we detect and report it"""
3201
class LeakRecordingResult(tests.ExtendedTestResult):
3203
tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
3205
def _report_thread_leak(self, test, leaks, alive):
3206
self.leaks.append((test, leaks))
3208
def test_testcase_without_addCleanups(self):
3209
"""Check old TestCase instances don't break with leak detection"""
3210
class Test(unittest.TestCase):
3213
result = self.LeakRecordingResult()
3215
result.startTestRun()
3217
result.stopTestRun()
3218
self.assertEqual(result._tests_leaking_threads_count, 0)
3219
self.assertEqual(result.leaks, [])
3221
def test_thread_leak(self):
3222
"""Ensure a thread that outlives the running of a test is reported
3224
Uses a thread that blocks on an event, and is started by the inner
3225
test case. As the thread outlives the inner case's run, it should be
3226
detected as a leak, but the event is then set so that the thread can
3227
be safely joined in cleanup so it's not leaked for real.
3229
event = threading.Event()
3230
thread = threading.Thread(name="Leaker", target=event.wait)
3231
class Test(tests.TestCase):
3232
def test_leak(self):
3234
result = self.LeakRecordingResult()
3235
test = Test("test_leak")
3236
self.addCleanup(thread.join)
3237
self.addCleanup(event.set)
3238
result.startTestRun()
3240
result.stopTestRun()
3241
self.assertEqual(result._tests_leaking_threads_count, 1)
3242
self.assertEqual(result._first_thread_leaker_id, test.id())
3243
self.assertEqual(result.leaks, [(test, set([thread]))])
3244
self.assertContainsString(result.stream.getvalue(), "leaking threads")
3246
def test_multiple_leaks(self):
3247
"""Check multiple leaks are blamed on the test cases at fault
3249
Same concept as the previous test, but has one inner test method that
3250
leaks two threads, and one that doesn't leak at all.
3252
event = threading.Event()
3253
thread_a = threading.Thread(name="LeakerA", target=event.wait)
3254
thread_b = threading.Thread(name="LeakerB", target=event.wait)
3255
thread_c = threading.Thread(name="LeakerC", target=event.wait)
3256
class Test(tests.TestCase):
3257
def test_first_leak(self):
3259
def test_second_no_leak(self):
3261
def test_third_leak(self):
3264
result = self.LeakRecordingResult()
3265
first_test = Test("test_first_leak")
3266
third_test = Test("test_third_leak")
3267
self.addCleanup(thread_a.join)
3268
self.addCleanup(thread_b.join)
3269
self.addCleanup(thread_c.join)
3270
self.addCleanup(event.set)
3271
result.startTestRun()
3273
[first_test, Test("test_second_no_leak"), third_test]
3275
result.stopTestRun()
3276
self.assertEqual(result._tests_leaking_threads_count, 2)
3277
self.assertEqual(result._first_thread_leaker_id, first_test.id())
3278
self.assertEqual(result.leaks, [
3279
(first_test, set([thread_b])),
3280
(third_test, set([thread_a, thread_c]))])
3281
self.assertContainsString(result.stream.getvalue(), "leaking threads")
3284
class TestPostMortemDebugging(tests.TestCase):
3285
"""Check post mortem debugging works when tests fail or error"""
3287
class TracebackRecordingResult(tests.ExtendedTestResult):
3289
tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
3290
self.postcode = None
3291
def _post_mortem(self, tb=None):
3292
"""Record the code object at the end of the current traceback"""
3293
tb = tb or sys.exc_info()[2]
3296
while next is not None:
3299
self.postcode = tb.tb_frame.f_code
3300
def report_error(self, test, err):
3302
def report_failure(self, test, err):
3305
def test_location_unittest_error(self):
3306
"""Needs right post mortem traceback with erroring unittest case"""
3307
class Test(unittest.TestCase):
3310
result = self.TracebackRecordingResult()
3312
self.assertEqual(result.postcode, Test.runTest.func_code)
3314
def test_location_unittest_failure(self):
3315
"""Needs right post mortem traceback with failing unittest case"""
3316
class Test(unittest.TestCase):
3318
raise self.failureException
3319
result = self.TracebackRecordingResult()
3321
self.assertEqual(result.postcode, Test.runTest.func_code)
3323
def test_location_bt_error(self):
3324
"""Needs right post mortem traceback with erroring bzrlib.tests case"""
3325
class Test(tests.TestCase):
3326
def test_error(self):
3328
result = self.TracebackRecordingResult()
3329
Test("test_error").run(result)
3330
self.assertEqual(result.postcode, Test.test_error.func_code)
3332
def test_location_bt_failure(self):
3333
"""Needs right post mortem traceback with failing bzrlib.tests case"""
3334
class Test(tests.TestCase):
3335
def test_failure(self):
3336
raise self.failureException
3337
result = self.TracebackRecordingResult()
3338
Test("test_failure").run(result)
3339
self.assertEqual(result.postcode, Test.test_failure.func_code)
3341
def test_env_var_triggers_post_mortem(self):
3342
"""Check pdb.post_mortem is called iff BZR_TEST_PDB is set"""
3344
result = tests.ExtendedTestResult(StringIO(), 0, 1)
3345
post_mortem_calls = []
3346
self.overrideAttr(pdb, "post_mortem", post_mortem_calls.append)
3347
self.overrideEnv('BZR_TEST_PDB', None)
3348
result._post_mortem(1)
3349
self.overrideEnv('BZR_TEST_PDB', 'on')
3350
result._post_mortem(2)
3351
self.assertEqual([2], post_mortem_calls)
2268
3354
class TestRunSuite(tests.TestCase):
2282
3368
tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
2283
3369
self.assertLength(1, calls)
2285
def test_done(self):
2286
"""run_suite should call result.done()"""
2288
def one_more_call(): self.calls += 1
2289
def test_function():
2291
test = unittest.FunctionTestCase(test_function)
2292
class InstrumentedTestResult(tests.ExtendedTestResult):
2293
def done(self): one_more_call()
2294
class MyRunner(tests.TextTestRunner):
2295
def run(self, test):
2296
return InstrumentedTestResult(self.stream, self.descriptions,
2298
tests.run_suite(test, runner_class=MyRunner, stream=StringIO())
2299
self.assertEquals(1, self.calls)
3372
class _Selftest(object):
3373
"""Mixin for tests needing full selftest output"""
3375
def _inject_stream_into_subunit(self, stream):
3376
"""To be overridden by subclasses that run tests out of process"""
3378
def _run_selftest(self, **kwargs):
3380
self._inject_stream_into_subunit(sio)
3381
tests.selftest(stream=sio, stop_on_failure=False, **kwargs)
3382
return sio.getvalue()
3385
class _ForkedSelftest(_Selftest):
3386
"""Mixin for tests needing full selftest output with forked children"""
3388
_test_needs_features = [features.subunit]
3390
def _inject_stream_into_subunit(self, stream):
3391
"""Monkey-patch subunit so the extra output goes to stream not stdout
3393
Some APIs need rewriting so this kind of bogus hackery can be replaced
3394
by passing the stream param from run_tests down into ProtocolTestCase.
3396
from subunit import ProtocolTestCase
3397
_original_init = ProtocolTestCase.__init__
3398
def _init_with_passthrough(self, *args, **kwargs):
3399
_original_init(self, *args, **kwargs)
3400
self._passthrough = stream
3401
self.overrideAttr(ProtocolTestCase, "__init__", _init_with_passthrough)
3403
def _run_selftest(self, **kwargs):
3404
# GZ 2011-05-26: Add a PosixSystem feature so this check can go away
3405
if getattr(os, "fork", None) is None:
3406
raise tests.TestNotApplicable("Platform doesn't support forking")
3407
# Make sure the fork code is actually invoked by claiming two cores
3408
self.overrideAttr(osutils, "local_concurrency", lambda: 2)
3409
kwargs.setdefault("suite_decorators", []).append(tests.fork_decorator)
3410
return super(_ForkedSelftest, self)._run_selftest(**kwargs)
3413
class TestParallelFork(_ForkedSelftest, tests.TestCase):
3414
"""Check operation of --parallel=fork selftest option"""
3416
def test_error_in_child_during_fork(self):
3417
"""Error in a forked child during test setup should get reported"""
3418
class Test(tests.TestCase):
3419
def testMethod(self):
3421
# We don't care what, just break something that a child will run
3422
self.overrideAttr(tests, "workaround_zealous_crypto_random", None)
3423
out = self._run_selftest(test_suite_factory=Test)
3424
# Lines from the tracebacks of the two child processes may be mixed
3425
# together due to the way subunit parses and forwards the streams,
3426
# so permit extra lines between each part of the error output.
3427
self.assertContainsRe(out,
3430
".+ in fork_for_tests\n"
3432
"\s*workaround_zealous_crypto_random\(\)\n"
3437
class TestUncollectedWarnings(_Selftest, tests.TestCase):
3438
"""Check a test case still alive after being run emits a warning"""
3440
class Test(tests.TestCase):
3441
def test_pass(self):
3443
def test_self_ref(self):
3444
self.also_self = self.test_self_ref
3445
def test_skip(self):
3446
self.skip("Don't need")
3448
def _get_suite(self):
3449
return TestUtil.TestSuite([
3450
self.Test("test_pass"),
3451
self.Test("test_self_ref"),
3452
self.Test("test_skip"),
3455
def _run_selftest_with_suite(self, **kwargs):
3456
old_flags = tests.selftest_debug_flags
3457
tests.selftest_debug_flags = old_flags.union(["uncollected_cases"])
3458
gc_on = gc.isenabled()
3462
output = self._run_selftest(test_suite_factory=self._get_suite,
3467
tests.selftest_debug_flags = old_flags
3468
self.assertNotContainsRe(output, "Uncollected test case.*test_pass")
3469
self.assertContainsRe(output, "Uncollected test case.*test_self_ref")
3472
def test_testsuite(self):
3473
self._run_selftest_with_suite()
3475
def test_pattern(self):
3476
out = self._run_selftest_with_suite(pattern="test_(?:pass|self_ref)$")
3477
self.assertNotContainsRe(out, "test_skip")
3479
def test_exclude_pattern(self):
3480
out = self._run_selftest_with_suite(exclude_pattern="test_skip$")
3481
self.assertNotContainsRe(out, "test_skip")
3483
def test_random_seed(self):
3484
self._run_selftest_with_suite(random_seed="now")
3486
def test_matching_tests_first(self):
3487
self._run_selftest_with_suite(matching_tests_first=True,
3488
pattern="test_self_ref$")
3490
def test_starting_with_and_exclude(self):
3491
out = self._run_selftest_with_suite(starting_with=["bt."],
3492
exclude_pattern="test_skip$")
3493
self.assertNotContainsRe(out, "test_skip")
3495
def test_additonal_decorator(self):
3496
out = self._run_selftest_with_suite(
3497
suite_decorators=[tests.TestDecorator])
3500
class TestUncollectedWarningsSubunit(TestUncollectedWarnings):
3501
"""Check warnings from tests staying alive are emitted with subunit"""
3503
_test_needs_features = [features.subunit]
3505
def _run_selftest_with_suite(self, **kwargs):
3506
return TestUncollectedWarnings._run_selftest_with_suite(self,
3507
runner_class=tests.SubUnitBzrRunner, **kwargs)
3510
class TestUncollectedWarningsForked(_ForkedSelftest, TestUncollectedWarnings):
3511
"""Check warnings from tests staying alive are emitted when forking"""
3514
class TestEnvironHandling(tests.TestCase):
3516
def test_overrideEnv_None_called_twice_doesnt_leak(self):
3517
self.assertFalse('MYVAR' in os.environ)
3518
self.overrideEnv('MYVAR', '42')
3519
# We use an embedded test to make sure we fix the _captureVar bug
3520
class Test(tests.TestCase):
3522
# The first call save the 42 value
3523
self.overrideEnv('MYVAR', None)
3524
self.assertEqual(None, os.environ.get('MYVAR'))
3525
# Make sure we can call it twice
3526
self.overrideEnv('MYVAR', None)
3527
self.assertEqual(None, os.environ.get('MYVAR'))
3529
result = tests.TextTestResult(output, 0, 1)
3530
Test('test_me').run(result)
3531
if not result.wasStrictlySuccessful():
3532
self.fail(output.getvalue())
3533
# We get our value back
3534
self.assertEqual('42', os.environ.get('MYVAR'))
3537
class TestIsolatedEnv(tests.TestCase):
3538
"""Test isolating tests from os.environ.
3540
Since we use tests that are already isolated from os.environ a bit of care
3541
should be taken when designing the tests to avoid bootstrap side-effects.
3542
The tests start an already clean os.environ which allow doing valid
3543
assertions about which variables are present or not and design tests around
3547
class ScratchMonkey(tests.TestCase):
3552
def test_basics(self):
3553
# Make sure we know the definition of BZR_HOME: not part of os.environ
3554
# for tests.TestCase.
3555
self.assertTrue('BZR_HOME' in tests.isolated_environ)
3556
self.assertEqual(None, tests.isolated_environ['BZR_HOME'])
3557
# Being part of isolated_environ, BZR_HOME should not appear here
3558
self.assertFalse('BZR_HOME' in os.environ)
3559
# Make sure we know the definition of LINES: part of os.environ for
3561
self.assertTrue('LINES' in tests.isolated_environ)
3562
self.assertEqual('25', tests.isolated_environ['LINES'])
3563
self.assertEqual('25', os.environ['LINES'])
3565
def test_injecting_unknown_variable(self):
3566
# BZR_HOME is known to be absent from os.environ
3567
test = self.ScratchMonkey('test_me')
3568
tests.override_os_environ(test, {'BZR_HOME': 'foo'})
3569
self.assertEqual('foo', os.environ['BZR_HOME'])
3570
tests.restore_os_environ(test)
3571
self.assertFalse('BZR_HOME' in os.environ)
3573
def test_injecting_known_variable(self):
3574
test = self.ScratchMonkey('test_me')
3575
# LINES is known to be present in os.environ
3576
tests.override_os_environ(test, {'LINES': '42'})
3577
self.assertEqual('42', os.environ['LINES'])
3578
tests.restore_os_environ(test)
3579
self.assertEqual('25', os.environ['LINES'])
3581
def test_deleting_variable(self):
3582
test = self.ScratchMonkey('test_me')
3583
# LINES is known to be present in os.environ
3584
tests.override_os_environ(test, {'LINES': None})
3585
self.assertTrue('LINES' not in os.environ)
3586
tests.restore_os_environ(test)
3587
self.assertEqual('25', os.environ['LINES'])
3590
class TestDocTestSuiteIsolation(tests.TestCase):
3591
"""Test that `tests.DocTestSuite` isolates doc tests from os.environ.
3593
Since tests.TestCase alreay provides an isolation from os.environ, we use
3594
the clean environment as a base for testing. To precisely capture the
3595
isolation provided by tests.DocTestSuite, we use doctest.DocTestSuite to
3598
We want to make sure `tests.DocTestSuite` respect `tests.isolated_environ`,
3599
not `os.environ` so each test overrides it to suit its needs.
3603
def get_doctest_suite_for_string(self, klass, string):
3604
class Finder(doctest.DocTestFinder):
3606
def find(*args, **kwargs):
3607
test = doctest.DocTestParser().get_doctest(
3608
string, {}, 'foo', 'foo.py', 0)
3611
suite = klass(test_finder=Finder())
3614
def run_doctest_suite_for_string(self, klass, string):
3615
suite = self.get_doctest_suite_for_string(klass, string)
3617
result = tests.TextTestResult(output, 0, 1)
3619
return result, output
3621
def assertDocTestStringSucceds(self, klass, string):
3622
result, output = self.run_doctest_suite_for_string(klass, string)
3623
if not result.wasStrictlySuccessful():
3624
self.fail(output.getvalue())
3626
def assertDocTestStringFails(self, klass, string):
3627
result, output = self.run_doctest_suite_for_string(klass, string)
3628
if result.wasStrictlySuccessful():
3629
self.fail(output.getvalue())
3631
def test_injected_variable(self):
3632
self.overrideAttr(tests, 'isolated_environ', {'LINES': '42'})
3635
>>> os.environ['LINES']
3638
# doctest.DocTestSuite fails as it sees '25'
3639
self.assertDocTestStringFails(doctest.DocTestSuite, test)
3640
# tests.DocTestSuite sees '42'
3641
self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
3643
def test_deleted_variable(self):
3644
self.overrideAttr(tests, 'isolated_environ', {'LINES': None})
3647
>>> os.environ.get('LINES')
3649
# doctest.DocTestSuite fails as it sees '25'
3650
self.assertDocTestStringFails(doctest.DocTestSuite, test)
3651
# tests.DocTestSuite sees None
3652
self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
3655
class TestSelftestExcludePatterns(tests.TestCase):
3658
super(TestSelftestExcludePatterns, self).setUp()
3659
self.overrideAttr(tests, 'test_suite', self.suite_factory)
3661
def suite_factory(self, keep_only=None, starting_with=None):
3662
"""A test suite factory with only a few tests."""
3663
class Test(tests.TestCase):
3665
# We don't need the full class path
3666
return self._testMethodName
3673
return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
3675
def assertTestList(self, expected, *selftest_args):
3676
# We rely on setUp installing the right test suite factory so we can
3677
# test at the command level without loading the whole test suite
3678
out, err = self.run_bzr(('selftest', '--list') + selftest_args)
3679
actual = out.splitlines()
3680
self.assertEqual(expected, actual)
3682
def test_full_list(self):
3683
self.assertTestList(['a', 'b', 'c'])
3685
def test_single_exclude(self):
3686
self.assertTestList(['b', 'c'], '-x', 'a')
3688
def test_mutiple_excludes(self):
3689
self.assertTestList(['c'], '-x', 'a', '-x', 'b')
3692
class TestCounterHooks(tests.TestCase, SelfTestHelper):
3694
_test_needs_features = [features.subunit]
3697
super(TestCounterHooks, self).setUp()
3698
class Test(tests.TestCase):
3701
super(Test, self).setUp()
3702
self.hooks = hooks.Hooks()
3703
self.hooks.add_hook('myhook', 'Foo bar blah', (2,4))
3704
self.install_counter_hook(self.hooks, 'myhook')
3709
def run_hook_once(self):
3710
for hook in self.hooks['myhook']:
3713
self.test_class = Test
3715
def assertHookCalls(self, expected_calls, test_name):
3716
test = self.test_class(test_name)
3717
result = unittest.TestResult()
3719
self.assertTrue(hasattr(test, '_counters'))
3720
self.assertTrue(test._counters.has_key('myhook'))
3721
self.assertEqual(expected_calls, test._counters['myhook'])
3723
def test_no_hook(self):
3724
self.assertHookCalls(0, 'no_hook')
3726
def test_run_hook_once(self):
3727
tt = features.testtools
3728
if tt.module.__version__ < (0, 9, 8):
3729
raise tests.TestSkipped('testtools-0.9.8 required for addDetail')
3730
self.assertHookCalls(1, 'run_hook_once')
added
removed
bzrlib/tests/test_selftest.py
