13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""Tests for the test framework."""
19
from cStringIO import StringIO
21
from StringIO import StringIO
30
from testtools import (
31
ExtendedToOriginalDecorator,
34
from testtools.content import Content
35
from testtools.content_type import ContentType
36
from testtools.matchers import (
40
import testtools.testresult.doubles
43
28
from bzrlib import (
61
from bzrlib.repofmt import (
37
from bzrlib.progress import _BaseProgressBar
38
from bzrlib.repofmt import weaverepo
64
39
from bzrlib.symbol_versioning import (
69
44
from bzrlib.tests import (
75
from bzrlib.trace import note, mutter
76
from bzrlib.transport import memory
51
TestCaseWithMemoryTransport,
52
TestCaseWithTransport,
61
exclude_tests_by_condition,
63
filter_suite_by_condition,
68
split_suite_by_condition,
73
from bzrlib.tests.test_sftp_transport import TestCaseWithSFTPServer
74
from bzrlib.tests.TestUtil import _load_module_by_name
75
from bzrlib.trace import note
76
from bzrlib.transport.memory import MemoryServer, MemoryTransport
77
from bzrlib.version import _get_bzr_source_tree
79
80
def _test_ids(test_suite):
80
81
"""Get the ids for the tests in a test suite."""
81
return [t.id() for t in tests.iter_suite_tests(test_suite)]
84
class MetaTestLog(tests.TestCase):
82
return [t.id() for t in iter_suite_tests(test_suite)]
85
class SelftestTests(TestCase):
87
def test_import_tests(self):
88
mod = _load_module_by_name('bzrlib.tests.test_selftest')
89
self.assertEqual(mod.SelftestTests, SelftestTests)
91
def test_import_test_failure(self):
92
self.assertRaises(ImportError,
96
class MetaTestLog(TestCase):
86
98
def test_logging(self):
87
99
"""Test logs are captured when a test fails."""
88
100
self.log('a test message')
89
details = self.getDetails()
91
self.assertThat(log.content_type, Equals(ContentType(
92
"text", "plain", {"charset": "utf8"})))
93
self.assertThat(u"".join(log.iter_text()), Equals(self.get_log()))
94
self.assertThat(self.get_log(),
95
DocTestMatches(u"...a test message\n", doctest.ELLIPSIS))
98
class TestTreeShape(tests.TestCaseInTempDir):
101
self._log_file.flush()
102
self.assertContainsRe(self._get_log(keep_log_file=True),
106
class TestTreeShape(TestCaseInTempDir):
100
108
def test_unicode_paths(self):
101
self.requireFeature(features.UnicodeFilenameFeature)
103
109
filename = u'hell\u00d8'
104
self.build_tree_contents([(filename, 'contents of hello')])
105
self.assertPathExists(filename)
108
class TestClassesAvailable(tests.TestCase):
109
"""As a convenience we expose Test* classes from bzrlib.tests"""
111
def test_test_case(self):
112
from bzrlib.tests import TestCase
114
def test_test_loader(self):
115
from bzrlib.tests import TestLoader
117
def test_test_suite(self):
118
from bzrlib.tests import TestSuite
121
class TestTransportScenarios(tests.TestCase):
111
self.build_tree_contents([(filename, 'contents of hello')])
112
except UnicodeEncodeError:
113
raise TestSkipped("can't build unicode working tree in "
114
"filesystem encoding %s" % sys.getfilesystemencoding())
115
self.failUnlessExists(filename)
118
class TestTransportProviderAdapter(TestCase):
122
119
"""A group of tests that test the transport implementation adaption core.
124
This is a meta test that the tests are applied to all available
121
This is a meta test that the tests are applied to all available
127
This will be generalised in the future which is why it is in this
124
This will be generalised in the future which is why it is in this
128
125
test file even though it is specific to transport tests at the moment.
131
128
def test_get_transport_permutations(self):
132
129
# this checks that get_test_permutations defined by the module is
133
# called by the get_transport_test_permutations function.
130
# called by the adapter get_transport_test_permutations method.
134
131
class MockModule(object):
135
132
def get_test_permutations(self):
136
133
return sample_permutation
137
134
sample_permutation = [(1,2), (3,4)]
138
from bzrlib.tests.per_transport import get_transport_test_permutations
135
from bzrlib.tests.test_transport_implementations \
136
import TransportTestProviderAdapter
137
adapter = TransportTestProviderAdapter()
139
138
self.assertEqual(sample_permutation,
140
get_transport_test_permutations(MockModule()))
139
adapter.get_transport_test_permutations(MockModule()))
142
def test_scenarios_include_all_modules(self):
143
# this checks that the scenario generator returns as many permutations
144
# as there are in all the registered transport modules - we assume if
145
# this matches its probably doing the right thing especially in
146
# combination with the tests for setting the right classes below.
147
from bzrlib.tests.per_transport import transport_test_permutations
141
def test_adapter_checks_all_modules(self):
142
# this checks that the adapter returns as many permutations as there
143
# are in all the registered transport modules - we assume if this
144
# matches its probably doing the right thing especially in combination
145
# with the tests for setting the right classes below.
146
from bzrlib.tests.test_transport_implementations \
147
import TransportTestProviderAdapter
148
148
from bzrlib.transport import _get_transport_modules
149
149
modules = _get_transport_modules()
150
150
permutation_count = 0
151
151
for module in modules:
153
permutation_count += len(reduce(getattr,
153
permutation_count += len(reduce(getattr,
154
154
(module + ".get_test_permutations").split('.')[1:],
155
155
__import__(module))())
156
156
except errors.DependencyNotPresent:
158
scenarios = transport_test_permutations()
159
self.assertEqual(permutation_count, len(scenarios))
158
input_test = TestTransportProviderAdapter(
159
"test_adapter_sets_transport_class")
160
adapter = TransportTestProviderAdapter()
161
self.assertEqual(permutation_count,
162
len(list(iter(adapter.adapt(input_test)))))
161
def test_scenarios_include_transport_class(self):
164
def test_adapter_sets_transport_class(self):
165
# Check that the test adapter inserts a transport and server into the
162
168
# This test used to know about all the possible transports and the
163
169
# order they were returned but that seems overly brittle (mbp
165
from bzrlib.tests.per_transport import transport_test_permutations
166
scenarios = transport_test_permutations()
171
from bzrlib.tests.test_transport_implementations \
172
import TransportTestProviderAdapter
173
scenarios = TransportTestProviderAdapter().scenarios
167
174
# there are at least that many builtin transports
168
175
self.assertTrue(len(scenarios) > 6)
169
176
one_scenario = scenarios[0]
290
338
self.assertEqual("readonly-server",
291
339
adapted_test1.transport_readonly_server)
292
340
self.assertEqual(
293
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
294
"test_apply_scenario(new id)",
341
"bzrlib.tests.test_selftest.TestTestScenarioApplier."
342
"test_adapt_test_to_scenario(new id)",
295
343
adapted_test1.id())
296
344
self.assertEqual(None, adapted_test2.bzrdir_format)
297
345
self.assertEqual(
298
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
299
"test_apply_scenario(new id 2)",
346
"bzrlib.tests.test_selftest.TestTestScenarioApplier."
347
"test_adapt_test_to_scenario(new id 2)",
300
348
adapted_test2.id())
303
class TestInterRepositoryScenarios(tests.TestCase):
351
class TestInterRepositoryProviderAdapter(TestCase):
352
"""A group of tests that test the InterRepository test adapter."""
305
def test_scenarios(self):
354
def test_adapted_tests(self):
306
355
# check that constructor parameters are passed through to the adapted
308
from bzrlib.tests.per_interrepository import make_scenarios
357
from bzrlib.tests.interrepository_implementations import \
358
InterRepositoryTestProviderAdapter
311
formats = [("C0", "C1", "C2", "C3"), ("D0", "D1", "D2", "D3")]
312
scenarios = make_scenarios(server1, server2, formats)
361
formats = [(str, "C1", "C2"), (int, "D1", "D2")]
362
adapter = InterRepositoryTestProviderAdapter(server1, server2, formats)
313
363
self.assertEqual([
315
{'repository_format': 'C1',
365
{'interrepo_class': str,
366
'repository_format': 'C1',
316
367
'repository_format_to': 'C2',
317
368
'transport_readonly_server': 'b',
318
'transport_server': 'a',
319
'extra_setup': 'C3'}),
321
{'repository_format': 'D1',
369
'transport_server': 'a'}),
371
{'interrepo_class': int,
372
'repository_format': 'D1',
322
373
'repository_format_to': 'D2',
323
374
'transport_readonly_server': 'b',
324
'transport_server': 'a',
325
'extra_setup': 'D3'})],
329
class TestWorkingTreeScenarios(tests.TestCase):
375
'transport_server': 'a'})],
376
adapter.formats_to_scenarios(formats))
379
class TestWorkingTreeProviderAdapter(TestCase):
380
"""A group of tests that test the workingtree implementation test adapter."""
331
382
def test_scenarios(self):
332
383
# check that constructor parameters are passed through to the adapted
334
from bzrlib.tests.per_workingtree import make_scenarios
385
from bzrlib.tests.workingtree_implementations \
386
import WorkingTreeTestProviderAdapter
337
formats = [workingtree_4.WorkingTreeFormat4(),
338
workingtree_3.WorkingTreeFormat3(),
339
workingtree_4.WorkingTreeFormat6()]
340
scenarios = make_scenarios(server1, server2, formats,
341
remote_server='c', remote_readonly_server='d',
342
remote_backing_server='e')
389
formats = [("c", "C"), ("d", "D")]
390
adapter = WorkingTreeTestProviderAdapter(server1, server2, formats)
343
391
self.assertEqual([
344
('WorkingTreeFormat4',
345
{'bzrdir_format': formats[0]._matchingbzrdir,
346
'transport_readonly_server': 'b',
347
'transport_server': 'a',
348
'workingtree_format': formats[0]}),
349
('WorkingTreeFormat3',
350
{'bzrdir_format': formats[1]._matchingbzrdir,
351
'transport_readonly_server': 'b',
352
'transport_server': 'a',
353
'workingtree_format': formats[1]}),
354
('WorkingTreeFormat6',
355
{'bzrdir_format': formats[2]._matchingbzrdir,
356
'transport_readonly_server': 'b',
357
'transport_server': 'a',
358
'workingtree_format': formats[2]}),
359
('WorkingTreeFormat6,remote',
360
{'bzrdir_format': formats[2]._matchingbzrdir,
361
'repo_is_remote': True,
362
'transport_readonly_server': 'd',
363
'transport_server': 'c',
364
'vfs_transport_factory': 'e',
365
'workingtree_format': formats[2]}),
369
class TestTreeScenarios(tests.TestCase):
371
def test_scenarios(self):
372
# the tree implementation scenario generator is meant to setup one
373
# instance for each working tree format, one additional instance
374
# that will use the default wt format, but create a revision tree for
375
# the tests, and one more that uses the default wt format as a
376
# lightweight checkout of a remote repository. This means that the wt
377
# ones should have the workingtree_to_test_tree attribute set to
378
# 'return_parameter' and the revision one set to
393
{'bzrdir_format': 'C',
394
'transport_readonly_server': 'b',
395
'transport_server': 'a',
396
'workingtree_format': 'c'}),
398
{'bzrdir_format': 'D',
399
'transport_readonly_server': 'b',
400
'transport_server': 'a',
401
'workingtree_format': 'd'})],
405
class TestTreeProviderAdapter(TestCase):
406
"""Test the setup of tree_implementation tests."""
408
def test_adapted_tests(self):
409
# the tree implementation adapter is meant to setup one instance for
410
# each working tree format, and one additional instance that will
411
# use the default wt format, but create a revision tree for the tests.
412
# this means that the wt ones should have the workingtree_to_test_tree
413
# attribute set to 'return_parameter' and the revision one set to
379
414
# revision_tree_from_workingtree.
381
from bzrlib.tests.per_tree import (
382
_dirstate_tree_from_workingtree,
416
from bzrlib.tests.tree_implementations import (
417
TreeTestProviderAdapter,
386
418
return_parameter,
387
419
revision_tree_from_workingtree
421
from bzrlib.workingtree import WorkingTreeFormat, WorkingTreeFormat3
422
input_test = TestTreeProviderAdapter(
423
"test_adapted_tests")
391
smart_server = test_server.SmartTCPServer_for_testing
392
smart_readonly_server = test_server.ReadonlySmartTCPServer_for_testing
393
mem_server = memory.MemoryServer
394
formats = [workingtree_4.WorkingTreeFormat4(),
395
workingtree_3.WorkingTreeFormat3(),]
396
scenarios = make_scenarios(server1, server2, formats)
397
self.assertEqual(8, len(scenarios))
398
default_wt_format = workingtree.format_registry.get_default()
399
wt4_format = workingtree_4.WorkingTreeFormat4()
400
wt5_format = workingtree_4.WorkingTreeFormat5()
401
wt6_format = workingtree_4.WorkingTreeFormat6()
402
expected_scenarios = [
403
('WorkingTreeFormat4',
404
{'bzrdir_format': formats[0]._matchingbzrdir,
405
'transport_readonly_server': 'b',
406
'transport_server': 'a',
407
'workingtree_format': formats[0],
408
'_workingtree_to_test_tree': return_parameter,
410
('WorkingTreeFormat3',
411
{'bzrdir_format': formats[1]._matchingbzrdir,
412
'transport_readonly_server': 'b',
413
'transport_server': 'a',
414
'workingtree_format': formats[1],
415
'_workingtree_to_test_tree': return_parameter,
417
('WorkingTreeFormat6,remote',
418
{'bzrdir_format': wt6_format._matchingbzrdir,
419
'repo_is_remote': True,
420
'transport_readonly_server': smart_readonly_server,
421
'transport_server': smart_server,
422
'vfs_transport_factory': mem_server,
423
'workingtree_format': wt6_format,
424
'_workingtree_to_test_tree': return_parameter,
427
{'_workingtree_to_test_tree': revision_tree_from_workingtree,
428
'bzrdir_format': default_wt_format._matchingbzrdir,
429
'transport_readonly_server': 'b',
430
'transport_server': 'a',
431
'workingtree_format': default_wt_format,
433
('DirStateRevisionTree,WT4',
434
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
435
'bzrdir_format': wt4_format._matchingbzrdir,
436
'transport_readonly_server': 'b',
437
'transport_server': 'a',
438
'workingtree_format': wt4_format,
440
('DirStateRevisionTree,WT5',
441
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
442
'bzrdir_format': wt5_format._matchingbzrdir,
443
'transport_readonly_server': 'b',
444
'transport_server': 'a',
445
'workingtree_format': wt5_format,
448
{'_workingtree_to_test_tree': preview_tree_pre,
449
'bzrdir_format': default_wt_format._matchingbzrdir,
450
'transport_readonly_server': 'b',
451
'transport_server': 'a',
452
'workingtree_format': default_wt_format}),
454
{'_workingtree_to_test_tree': preview_tree_post,
455
'bzrdir_format': default_wt_format._matchingbzrdir,
456
'transport_readonly_server': 'b',
457
'transport_server': 'a',
458
'workingtree_format': default_wt_format}),
460
self.assertEqual(expected_scenarios, scenarios)
463
class TestInterTreeScenarios(tests.TestCase):
426
formats = [("c", "C"), ("d", "D")]
427
adapter = TreeTestProviderAdapter(server1, server2, formats)
428
suite = adapter.adapt(input_test)
429
tests = list(iter(suite))
430
# XXX We should not have tests fail as we add more scenarios
432
self.assertEqual(5, len(tests))
433
# this must match the default format setp up in
434
# TreeTestProviderAdapter.adapt
435
default_format = WorkingTreeFormat3
436
self.assertEqual(tests[0].workingtree_format, formats[0][0])
437
self.assertEqual(tests[0].bzrdir_format, formats[0][1])
438
self.assertEqual(tests[0].transport_server, server1)
439
self.assertEqual(tests[0].transport_readonly_server, server2)
440
self.assertEqual(tests[0]._workingtree_to_test_tree, return_parameter)
441
self.assertEqual(tests[1].workingtree_format, formats[1][0])
442
self.assertEqual(tests[1].bzrdir_format, formats[1][1])
443
self.assertEqual(tests[1].transport_server, server1)
444
self.assertEqual(tests[1].transport_readonly_server, server2)
445
self.assertEqual(tests[1]._workingtree_to_test_tree, return_parameter)
446
self.assertIsInstance(tests[2].workingtree_format, default_format)
447
#self.assertEqual(tests[2].bzrdir_format,
448
# default_format._matchingbzrdir)
449
self.assertEqual(tests[2].transport_server, server1)
450
self.assertEqual(tests[2].transport_readonly_server, server2)
451
self.assertEqual(tests[2]._workingtree_to_test_tree,
452
revision_tree_from_workingtree)
455
class TestInterTreeProviderAdapter(TestCase):
464
456
"""A group of tests that test the InterTreeTestAdapter."""
466
def test_scenarios(self):
458
def test_adapted_tests(self):
467
459
# check that constructor parameters are passed through to the adapted
469
461
# for InterTree tests we want the machinery to bring up two trees in
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"
1281
class SampleTestCase(tests.TestCase):
1152
def test_bench_history(self):
1153
# tests that the running the benchmark produces a history file
1154
# containing a timestamp and the revision id of the bzrlib source which
1156
workingtree = _get_bzr_source_tree()
1157
test = TestRunner('dummy_test')
1159
runner = TextTestRunner(stream=self._log_file, bench_history=output)
1160
result = self.run_test_runner(runner, test)
1161
output_string = output.getvalue()
1162
self.assertContainsRe(output_string, "--date [0-9.]+")
1163
if workingtree is not None:
1164
revision_id = workingtree.get_parent_ids()[0]
1165
self.assertEndsWith(output_string.rstrip(), revision_id)
1167
def assertLogDeleted(self, test):
1168
log = test._get_log()
1169
self.assertEqual("DELETED log file to reduce memory footprint", log)
1170
self.assertEqual('', test._log_contents)
1171
self.assertIs(None, test._log_file_name)
1173
def test_success_log_deleted(self):
1174
"""Successful tests have their log deleted"""
1176
class LogTester(TestCase):
1178
def test_success(self):
1179
self.log('this will be removed\n')
1181
sio = cStringIO.StringIO()
1182
runner = TextTestRunner(stream=sio)
1183
test = LogTester('test_success')
1184
result = self.run_test_runner(runner, test)
1186
self.assertLogDeleted(test)
1188
def test_skipped_log_deleted(self):
1189
"""Skipped tests have their log deleted"""
1191
class LogTester(TestCase):
1193
def test_skipped(self):
1194
self.log('this will be removed\n')
1195
raise tests.TestSkipped()
1197
sio = cStringIO.StringIO()
1198
runner = TextTestRunner(stream=sio)
1199
test = LogTester('test_skipped')
1200
result = self.run_test_runner(runner, test)
1202
self.assertLogDeleted(test)
1204
def test_not_aplicable_log_deleted(self):
1205
"""Not applicable tests have their log deleted"""
1207
class LogTester(TestCase):
1209
def test_not_applicable(self):
1210
self.log('this will be removed\n')
1211
raise tests.TestNotApplicable()
1213
sio = cStringIO.StringIO()
1214
runner = TextTestRunner(stream=sio)
1215
test = LogTester('test_not_applicable')
1216
result = self.run_test_runner(runner, test)
1218
self.assertLogDeleted(test)
1220
def test_known_failure_log_deleted(self):
1221
"""Know failure tests have their log deleted"""
1223
class LogTester(TestCase):
1225
def test_known_failure(self):
1226
self.log('this will be removed\n')
1227
raise tests.KnownFailure()
1229
sio = cStringIO.StringIO()
1230
runner = TextTestRunner(stream=sio)
1231
test = LogTester('test_known_failure')
1232
result = self.run_test_runner(runner, test)
1234
self.assertLogDeleted(test)
1236
def test_fail_log_kept(self):
1237
"""Failed tests have their log kept"""
1239
class LogTester(TestCase):
1241
def test_fail(self):
1242
self.log('this will be kept\n')
1243
self.fail('this test fails')
1245
sio = cStringIO.StringIO()
1246
runner = TextTestRunner(stream=sio)
1247
test = LogTester('test_fail')
1248
result = self.run_test_runner(runner, test)
1250
text = sio.getvalue()
1251
self.assertContainsRe(text, 'this will be kept')
1252
self.assertContainsRe(text, 'this test fails')
1254
log = test._get_log()
1255
self.assertContainsRe(log, 'this will be kept')
1256
self.assertEqual(log, test._log_contents)
1258
def test_error_log_kept(self):
1259
"""Tests with errors have their log kept"""
1261
class LogTester(TestCase):
1263
def test_error(self):
1264
self.log('this will be kept\n')
1265
raise ValueError('random exception raised')
1267
sio = cStringIO.StringIO()
1268
runner = TextTestRunner(stream=sio)
1269
test = LogTester('test_error')
1270
result = self.run_test_runner(runner, test)
1272
text = sio.getvalue()
1273
self.assertContainsRe(text, 'this will be kept')
1274
self.assertContainsRe(text, 'random exception raised')
1276
log = test._get_log()
1277
self.assertContainsRe(log, 'this will be kept')
1278
self.assertEqual(log, test._log_contents)
1281
class SampleTestCase(TestCase):
1283
1283
def _test_pass(self):
1286
class _TestException(Exception):
1290
class TestTestCase(tests.TestCase):
1287
class TestTestCase(TestCase):
1291
1288
"""Tests that test the core bzrlib TestCase."""
1293
def test_assertLength_matches_empty(self):
1295
self.assertLength(0, a_list)
1297
def test_assertLength_matches_nonempty(self):
1299
self.assertLength(3, a_list)
1301
def test_assertLength_fails_different(self):
1303
self.assertRaises(AssertionError, self.assertLength, 1, a_list)
1305
def test_assertLength_shows_sequence_in_failure(self):
1307
exception = self.assertRaises(AssertionError, self.assertLength, 2,
1309
self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
1312
def test_base_setUp_not_called_causes_failure(self):
1313
class TestCaseWithBrokenSetUp(tests.TestCase):
1315
pass # does not call TestCase.setUp
1318
test = TestCaseWithBrokenSetUp('test_foo')
1319
result = unittest.TestResult()
1321
self.assertFalse(result.wasSuccessful())
1322
self.assertEqual(1, result.testsRun)
1324
def test_base_tearDown_not_called_causes_failure(self):
1325
class TestCaseWithBrokenTearDown(tests.TestCase):
1327
pass # does not call TestCase.tearDown
1330
test = TestCaseWithBrokenTearDown('test_foo')
1331
result = unittest.TestResult()
1333
self.assertFalse(result.wasSuccessful())
1334
self.assertEqual(1, result.testsRun)
1336
1290
def test_debug_flags_sanitised(self):
1337
1291
"""The bzrlib debug flags should be sanitised by setUp."""
1338
if 'allow_debug' in tests.selftest_debug_flags:
1339
raise tests.TestNotApplicable(
1340
'-Eallow_debug option prevents debug flag sanitisation')
1341
1292
# we could set something and run a test that will check
1342
1293
# it gets santised, but this is probably sufficient for now:
1343
1294
# if someone runs the test with -Dsomething it will error.
1345
if self._lock_check_thorough:
1346
flags.add('strict_locks')
1347
self.assertEqual(flags, bzrlib.debug.debug_flags)
1349
def change_selftest_debug_flags(self, new_flags):
1350
self.overrideAttr(tests, 'selftest_debug_flags', set(new_flags))
1352
def test_allow_debug_flag(self):
1353
"""The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1354
sanitised (i.e. cleared) before running a test.
1356
self.change_selftest_debug_flags(set(['allow_debug']))
1357
bzrlib.debug.debug_flags = set(['a-flag'])
1358
class TestThatRecordsFlags(tests.TestCase):
1359
def test_foo(nested_self):
1360
self.flags = set(bzrlib.debug.debug_flags)
1361
test = TestThatRecordsFlags('test_foo')
1362
test.run(self.make_test_result())
1363
flags = set(['a-flag'])
1364
if 'disable_lock_checks' not in tests.selftest_debug_flags:
1365
flags.add('strict_locks')
1366
self.assertEqual(flags, self.flags)
1368
def test_disable_lock_checks(self):
1369
"""The -Edisable_lock_checks flag disables thorough checks."""
1370
class TestThatRecordsFlags(tests.TestCase):
1371
def test_foo(nested_self):
1372
self.flags = set(bzrlib.debug.debug_flags)
1373
self.test_lock_check_thorough = nested_self._lock_check_thorough
1374
self.change_selftest_debug_flags(set())
1375
test = TestThatRecordsFlags('test_foo')
1376
test.run(self.make_test_result())
1377
# By default we do strict lock checking and thorough lock/unlock
1379
self.assertTrue(self.test_lock_check_thorough)
1380
self.assertEqual(set(['strict_locks']), self.flags)
1381
# Now set the disable_lock_checks flag, and show that this changed.
1382
self.change_selftest_debug_flags(set(['disable_lock_checks']))
1383
test = TestThatRecordsFlags('test_foo')
1384
test.run(self.make_test_result())
1385
self.assertFalse(self.test_lock_check_thorough)
1386
self.assertEqual(set(), self.flags)
1388
def test_this_fails_strict_lock_check(self):
1389
class TestThatRecordsFlags(tests.TestCase):
1390
def test_foo(nested_self):
1391
self.flags1 = set(bzrlib.debug.debug_flags)
1392
self.thisFailsStrictLockCheck()
1393
self.flags2 = set(bzrlib.debug.debug_flags)
1394
# Make sure lock checking is active
1395
self.change_selftest_debug_flags(set())
1396
test = TestThatRecordsFlags('test_foo')
1397
test.run(self.make_test_result())
1398
self.assertEqual(set(['strict_locks']), self.flags1)
1399
self.assertEqual(set(), self.flags2)
1401
def test_debug_flags_restored(self):
1402
"""The bzrlib debug flags should be restored to their original state
1403
after the test was run, even if allow_debug is set.
1405
self.change_selftest_debug_flags(set(['allow_debug']))
1406
# Now run a test that modifies debug.debug_flags.
1407
bzrlib.debug.debug_flags = set(['original-state'])
1408
class TestThatModifiesFlags(tests.TestCase):
1410
bzrlib.debug.debug_flags = set(['modified'])
1411
test = TestThatModifiesFlags('test_foo')
1412
test.run(self.make_test_result())
1413
self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1415
def make_test_result(self):
1416
"""Get a test result that writes to the test log file."""
1417
return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1295
self.assertEqual(set(), bzrlib.debug.debug_flags)
1419
1297
def inner_test(self):
1420
1298
# the inner child test
1583
1439
self.calls.append(('addNotSupported', test, feature))
1584
1440
result = InstrumentedTestResult()
1585
1441
test.run(result)
1586
case = result.calls[0][1]
1587
1442
self.assertEqual([
1588
('startTest', case),
1589
('addNotSupported', case, the_feature),
1443
('startTest', test),
1444
('addNotSupported', test, the_feature),
1594
def test_start_server_registers_url(self):
1595
transport_server = memory.MemoryServer()
1596
# A little strict, but unlikely to be changed soon.
1597
self.assertEqual([], self._bzr_selftest_roots)
1598
self.start_server(transport_server)
1599
self.assertSubset([transport_server.get_url()],
1600
self._bzr_selftest_roots)
1602
def test_assert_list_raises_on_generator(self):
1603
def generator_which_will_raise():
1604
# This will not raise until after the first yield
1606
raise _TestException()
1608
e = self.assertListRaises(_TestException, generator_which_will_raise)
1609
self.assertIsInstance(e, _TestException)
1611
e = self.assertListRaises(Exception, generator_which_will_raise)
1612
self.assertIsInstance(e, _TestException)
1614
def test_assert_list_raises_on_plain(self):
1615
def plain_exception():
1616
raise _TestException()
1619
e = self.assertListRaises(_TestException, plain_exception)
1620
self.assertIsInstance(e, _TestException)
1622
e = self.assertListRaises(Exception, plain_exception)
1623
self.assertIsInstance(e, _TestException)
1625
def test_assert_list_raises_assert_wrong_exception(self):
1626
class _NotTestException(Exception):
1629
def wrong_exception():
1630
raise _NotTestException()
1632
def wrong_exception_generator():
1635
raise _NotTestException()
1637
# Wrong exceptions are not intercepted
1638
self.assertRaises(_NotTestException,
1639
self.assertListRaises, _TestException, wrong_exception)
1640
self.assertRaises(_NotTestException,
1641
self.assertListRaises, _TestException, wrong_exception_generator)
1643
def test_assert_list_raises_no_exception(self):
1647
def success_generator():
1651
self.assertRaises(AssertionError,
1652
self.assertListRaises, _TestException, success)
1654
self.assertRaises(AssertionError,
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)
1881
# NB: Don't delete this; it's not actually from 0.11!
1882
@deprecated_function(deprecated_in((0, 11, 0)))
1450
@symbol_versioning.deprecated_function(zero_eleven)
1883
1451
def sample_deprecated_function():
1884
1452
"""A deprecated function to test applyDeprecated with."""
2019
1563
tree = self.make_branch_and_memory_tree('a')
2020
1564
self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
2022
def test_make_tree_for_local_vfs_backed_transport(self):
2023
# make_branch_and_tree has to use local branch and repositories
2024
# when the vfs transport and local disk are colocated, even if
2025
# a different transport is in use for url generation.
2026
self.transport_server = test_server.FakeVFATServer
2027
self.assertFalse(self.get_url('t1').startswith('file://'))
1567
class TestSFTPMakeBranchAndTree(TestCaseWithSFTPServer):
1569
def test_make_tree_for_sftp_branch(self):
1570
"""Transports backed by local directories create local trees."""
2028
1572
tree = self.make_branch_and_tree('t1')
2029
1573
base = tree.bzrdir.root_transport.base
2030
self.assertStartsWith(base, 'file://')
2031
self.assertEqual(tree.bzrdir.root_transport,
1574
self.failIf(base.startswith('sftp'),
1575
'base %r is on sftp but should be local' % base)
1576
self.assertEquals(tree.bzrdir.root_transport,
2032
1577
tree.branch.bzrdir.root_transport)
2033
self.assertEqual(tree.bzrdir.root_transport,
1578
self.assertEquals(tree.bzrdir.root_transport,
2034
1579
tree.branch.repository.bzrdir.root_transport)
2037
class SelfTestHelper(object):
2039
def run_selftest(self, **kwargs):
2040
"""Run selftest returning its output."""
2042
old_transport = bzrlib.tests.default_transport
2043
old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
2044
tests.TestCaseWithMemoryTransport.TEST_ROOT = None
2046
self.assertEqual(True, tests.selftest(stream=output, **kwargs))
2048
bzrlib.tests.default_transport = old_transport
2049
tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
2054
class TestSelftest(tests.TestCase, SelfTestHelper):
1582
class TestSelftest(TestCase):
2055
1583
"""Tests of bzrlib.tests.selftest."""
2057
1585
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
2058
1586
factory_called = []
2060
1588
factory_called.append(True)
2061
return TestUtil.TestSuite()
2062
1590
out = StringIO()
2063
1591
err = StringIO()
2064
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1592
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
2065
1593
test_suite_factory=factory)
2066
1594
self.assertEqual([True], factory_called)
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])
1597
class TestKnownFailure(TestCase):
1599
def test_known_failure(self):
1600
"""Check that KnownFailure is defined appropriately."""
1601
# a KnownFailure is an assertion error for compatability with unaware
1603
self.assertIsInstance(KnownFailure(""), AssertionError)
1605
def test_expect_failure(self):
1607
self.expectFailure("Doomed to failure", self.assertTrue, False)
1608
except KnownFailure, e:
1609
self.assertEqual('Doomed to failure', e.args[0])
1611
self.expectFailure("Doomed to failure", self.assertTrue, True)
1612
except AssertionError, e:
1613
self.assertEqual('Unexpected success. Should have failed:'
1614
' Doomed to failure', e.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])
2668
class TestSelftestFiltering(tests.TestCase):
1616
self.fail('Assertion not raised')
1619
class TestFeature(TestCase):
1621
def test_caching(self):
1622
"""Feature._probe is called by the feature at most once."""
1623
class InstrumentedFeature(Feature):
1625
Feature.__init__(self)
1628
self.calls.append('_probe')
1630
feature = InstrumentedFeature()
1632
self.assertEqual(['_probe'], feature.calls)
1634
self.assertEqual(['_probe'], feature.calls)
1636
def test_named_str(self):
1637
"""Feature.__str__ should thunk to feature_name()."""
1638
class NamedFeature(Feature):
1639
def feature_name(self):
1641
feature = NamedFeature()
1642
self.assertEqual('symlinks', str(feature))
1644
def test_default_str(self):
1645
"""Feature.__str__ should default to __class__.__name__."""
1646
class NamedFeature(Feature):
1648
feature = NamedFeature()
1649
self.assertEqual('NamedFeature', str(feature))
1652
class TestUnavailableFeature(TestCase):
1654
def test_access_feature(self):
1656
exception = UnavailableFeature(feature)
1657
self.assertIs(feature, exception.args[0])
1660
class TestSelftestFiltering(TestCase):
2670
1662
def setUp(self):
2671
super(TestSelftestFiltering, self).setUp()
2672
1663
self.suite = TestUtil.TestSuite()
2673
1664
self.loader = TestUtil.TestLoader()
2674
self.suite.addTest(self.loader.loadTestsFromModule(
2675
sys.modules['bzrlib.tests.test_selftest']))
1665
self.suite.addTest(self.loader.loadTestsFromModuleNames([
1666
'bzrlib.tests.test_selftest']))
2676
1667
self.all_names = _test_ids(self.suite)
2678
1669
def test_condition_id_re(self):
2679
1670
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2680
1671
'test_condition_id_re')
2681
filtered_suite = tests.filter_suite_by_condition(
2682
self.suite, tests.condition_id_re('test_condition_id_re'))
1672
filtered_suite = filter_suite_by_condition(self.suite,
1673
condition_id_re('test_condition_id_re'))
2683
1674
self.assertEqual([test_name], _test_ids(filtered_suite))
2685
1676
def test_condition_id_in_list(self):
2686
1677
test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
2687
1678
'test_condition_id_in_list']
2688
1679
id_list = tests.TestIdList(test_names)
2689
filtered_suite = tests.filter_suite_by_condition(
1680
filtered_suite = filter_suite_by_condition(
2690
1681
self.suite, tests.condition_id_in_list(id_list))
2691
1682
my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
2692
re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
1683
re_filtered = filter_suite_by_re(self.suite, my_pattern)
2693
1684
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2695
1686
def test_condition_id_startswith(self):
2696
1687
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2697
start1 = klass + 'test_condition_id_starts'
2698
start2 = klass + 'test_condition_id_in'
2699
test_names = [ klass + 'test_condition_id_in_list',
2700
klass + 'test_condition_id_startswith',
2702
filtered_suite = tests.filter_suite_by_condition(
2703
self.suite, tests.condition_id_startswith([start1, start2]))
2704
self.assertEqual(test_names, _test_ids(filtered_suite))
1688
start = klass + 'test_condition_id_starts'
1689
test_names = [klass + 'test_condition_id_startswith']
1690
filtered_suite = filter_suite_by_condition(
1691
self.suite, tests.condition_id_startswith(start))
1692
my_pattern = 'TestSelftestFiltering.*test_condition_id_startswith'
1693
re_filtered = filter_suite_by_re(self.suite, my_pattern)
1694
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2706
1696
def test_condition_isinstance(self):
2707
filtered_suite = tests.filter_suite_by_condition(
2708
self.suite, tests.condition_isinstance(self.__class__))
1697
filtered_suite = filter_suite_by_condition(self.suite,
1698
condition_isinstance(self.__class__))
2709
1699
class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2710
re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
1700
re_filtered = filter_suite_by_re(self.suite, class_pattern)
2711
1701
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2713
1703
def test_exclude_tests_by_condition(self):
2714
1704
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2715
1705
'test_exclude_tests_by_condition')
2716
filtered_suite = tests.exclude_tests_by_condition(self.suite,
1706
filtered_suite = exclude_tests_by_condition(self.suite,
2717
1707
lambda x:x.id() == excluded_name)
2718
1708
self.assertEqual(len(self.all_names) - 1,
2719
1709
filtered_suite.countTestCases())
3134
2056
loader = self._create_loader('bzrlib.tests.test_samp')
3136
2058
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3137
self.assertEqual(test_list, _test_ids(suite))
2059
self.assertEquals(test_list, _test_ids(suite))
3139
2061
def test_load_tests_inside_module(self):
3140
2062
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
3141
2063
loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
3143
2065
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3144
self.assertEqual(test_list, _test_ids(suite))
2066
self.assertEquals(test_list, _test_ids(suite))
3146
2068
def test_exclude_tests(self):
3147
2069
test_list = ['bogus']
3148
2070
loader = self._create_loader('bogus')
3150
2072
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3151
self.assertEqual([], _test_ids(suite))
3154
class TestTestPrefixRegistry(tests.TestCase):
3156
def _get_registry(self):
3157
tp_registry = tests.TestPrefixAliasRegistry()
3160
def test_register_new_prefix(self):
3161
tpr = self._get_registry()
3162
tpr.register('foo', 'fff.ooo.ooo')
3163
self.assertEqual('fff.ooo.ooo', tpr.get('foo'))
3165
def test_register_existing_prefix(self):
3166
tpr = self._get_registry()
3167
tpr.register('bar', 'bbb.aaa.rrr')
3168
tpr.register('bar', 'bBB.aAA.rRR')
3169
self.assertEqual('bbb.aaa.rrr', tpr.get('bar'))
3170
self.assertThat(self.get_log(),
3171
DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR",
3174
def test_get_unknown_prefix(self):
3175
tpr = self._get_registry()
3176
self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
3178
def test_resolve_prefix(self):
3179
tpr = self._get_registry()
3180
tpr.register('bar', 'bb.aa.rr')
3181
self.assertEqual('bb.aa.rr', tpr.resolve_alias('bar'))
3183
def test_resolve_unknown_alias(self):
3184
tpr = self._get_registry()
3185
self.assertRaises(errors.BzrCommandError,
3186
tpr.resolve_alias, 'I am not a prefix')
3188
def test_predefined_prefixes(self):
3189
tpr = tests.test_prefix_alias_registry
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)
3354
class TestRunSuite(tests.TestCase):
3356
def test_runner_class(self):
3357
"""run_suite accepts and uses a runner_class keyword argument."""
3358
class Stub(tests.TestCase):
3361
suite = Stub("test_foo")
3363
class MyRunner(tests.TextTestRunner):
3364
def run(self, test):
3366
return tests.ExtendedTestResult(self.stream, self.descriptions,
3368
tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
3369
self.assertLength(1, 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')
2073
self.assertEquals([], _test_ids(suite))
added
removed
bzrlib/tests/test_selftest.py
