1
# Copyright (C) 2005-2013, 2016 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
"""Tests for the test framework."""
19
from cStringIO 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
61
from bzrlib.repofmt import (
64
from bzrlib.symbol_versioning import (
69
from bzrlib.tests import (
75
from bzrlib.trace import note, mutter
76
from bzrlib.transport import memory
79
def _test_ids(test_suite):
80
"""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):
86
def test_logging(self):
87
"""Test logs are captured when a test fails."""
88
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):
100
def test_unicode_paths(self):
101
self.requireFeature(features.UnicodeFilenameFeature)
103
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):
122
"""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
127
This will be generalised in the future which is why it is in this
128
test file even though it is specific to transport tests at the moment.
131
def test_get_transport_permutations(self):
132
# this checks that get_test_permutations defined by the module is
133
# called by the get_transport_test_permutations function.
134
class MockModule(object):
135
def get_test_permutations(self):
136
return sample_permutation
137
sample_permutation = [(1,2), (3,4)]
138
from bzrlib.tests.per_transport import get_transport_test_permutations
139
self.assertEqual(sample_permutation,
140
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
148
from bzrlib.transport import _get_transport_modules
149
modules = _get_transport_modules()
150
permutation_count = 0
151
for module in modules:
153
permutation_count += len(reduce(getattr,
154
(module + ".get_test_permutations").split('.')[1:],
155
__import__(module))())
156
except errors.DependencyNotPresent:
158
scenarios = transport_test_permutations()
159
self.assertEqual(permutation_count, len(scenarios))
161
def test_scenarios_include_transport_class(self):
162
# This test used to know about all the possible transports and the
163
# 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()
167
# there are at least that many builtin transports
168
self.assertTrue(len(scenarios) > 6)
169
one_scenario = scenarios[0]
170
self.assertIsInstance(one_scenario[0], str)
171
self.assertTrue(issubclass(one_scenario[1]["transport_class"],
172
bzrlib.transport.Transport))
173
self.assertTrue(issubclass(one_scenario[1]["transport_server"],
174
bzrlib.transport.Server))
177
class TestBranchScenarios(tests.TestCase):
179
def test_scenarios(self):
180
# check that constructor parameters are passed through to the adapted
182
from bzrlib.tests.per_branch import make_scenarios
185
formats = [("c", "C"), ("d", "D")]
186
scenarios = make_scenarios(server1, server2, formats)
187
self.assertEqual(2, len(scenarios))
190
{'branch_format': 'c',
191
'bzrdir_format': 'C',
192
'transport_readonly_server': 'b',
193
'transport_server': 'a'}),
195
{'branch_format': 'd',
196
'bzrdir_format': 'D',
197
'transport_readonly_server': 'b',
198
'transport_server': 'a'})],
202
class TestBzrDirScenarios(tests.TestCase):
204
def test_scenarios(self):
205
# check that constructor parameters are passed through to the adapted
207
from bzrlib.tests.per_controldir import make_scenarios
212
scenarios = make_scenarios(vfs_factory, server1, server2, formats)
215
{'bzrdir_format': 'c',
216
'transport_readonly_server': 'b',
217
'transport_server': 'a',
218
'vfs_transport_factory': 'v'}),
220
{'bzrdir_format': 'd',
221
'transport_readonly_server': 'b',
222
'transport_server': 'a',
223
'vfs_transport_factory': 'v'})],
227
class TestRepositoryScenarios(tests.TestCase):
229
def test_formats_to_scenarios(self):
230
from bzrlib.tests.per_repository import formats_to_scenarios
231
formats = [("(c)", remote.RemoteRepositoryFormat()),
232
("(d)", repository.format_registry.get(
233
'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
234
no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
236
vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
237
vfs_transport_factory="vfs")
238
# no_vfs generate scenarios without vfs_transport_factory
240
('RemoteRepositoryFormat(c)',
241
{'bzrdir_format': remote.RemoteBzrDirFormat(),
242
'repository_format': remote.RemoteRepositoryFormat(),
243
'transport_readonly_server': 'readonly',
244
'transport_server': 'server'}),
245
('RepositoryFormat2a(d)',
246
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
247
'repository_format': groupcompress_repo.RepositoryFormat2a(),
248
'transport_readonly_server': 'readonly',
249
'transport_server': 'server'})]
250
self.assertEqual(expected, no_vfs_scenarios)
252
('RemoteRepositoryFormat(c)',
253
{'bzrdir_format': remote.RemoteBzrDirFormat(),
254
'repository_format': remote.RemoteRepositoryFormat(),
255
'transport_readonly_server': 'readonly',
256
'transport_server': 'server',
257
'vfs_transport_factory': 'vfs'}),
258
('RepositoryFormat2a(d)',
259
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
260
'repository_format': groupcompress_repo.RepositoryFormat2a(),
261
'transport_readonly_server': 'readonly',
262
'transport_server': 'server',
263
'vfs_transport_factory': 'vfs'})],
267
class TestTestScenarioApplication(tests.TestCase):
268
"""Tests for the test adaption facilities."""
270
def test_apply_scenario(self):
271
from bzrlib.tests import apply_scenario
272
input_test = TestTestScenarioApplication("test_apply_scenario")
273
# setup two adapted tests
274
adapted_test1 = apply_scenario(input_test,
276
{"bzrdir_format":"bzr_format",
277
"repository_format":"repo_fmt",
278
"transport_server":"transport_server",
279
"transport_readonly_server":"readonly-server"}))
280
adapted_test2 = apply_scenario(input_test,
281
("new id 2", {"bzrdir_format":None}))
282
# input_test should have been altered.
283
self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
284
# the new tests are mutually incompatible, ensuring it has
285
# made new ones, and unspecified elements in the scenario
286
# should not have been altered.
287
self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
288
self.assertEqual("repo_fmt", adapted_test1.repository_format)
289
self.assertEqual("transport_server", adapted_test1.transport_server)
290
self.assertEqual("readonly-server",
291
adapted_test1.transport_readonly_server)
293
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
294
"test_apply_scenario(new id)",
296
self.assertEqual(None, adapted_test2.bzrdir_format)
298
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
299
"test_apply_scenario(new id 2)",
303
class TestInterRepositoryScenarios(tests.TestCase):
305
def test_scenarios(self):
306
# check that constructor parameters are passed through to the adapted
308
from bzrlib.tests.per_interrepository import make_scenarios
311
formats = [("C0", "C1", "C2", "C3"), ("D0", "D1", "D2", "D3")]
312
scenarios = make_scenarios(server1, server2, formats)
315
{'repository_format': 'C1',
316
'repository_format_to': 'C2',
317
'transport_readonly_server': 'b',
318
'transport_server': 'a',
319
'extra_setup': 'C3'}),
321
{'repository_format': 'D1',
322
'repository_format_to': 'D2',
323
'transport_readonly_server': 'b',
324
'transport_server': 'a',
325
'extra_setup': 'D3'})],
329
class TestWorkingTreeScenarios(tests.TestCase):
331
def test_scenarios(self):
332
# check that constructor parameters are passed through to the adapted
334
from bzrlib.tests.per_workingtree import make_scenarios
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')
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
379
# revision_tree_from_workingtree.
381
from bzrlib.tests.per_tree import (
382
_dirstate_tree_from_workingtree,
387
revision_tree_from_workingtree
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):
464
"""A group of tests that test the InterTreeTestAdapter."""
466
def test_scenarios(self):
467
# check that constructor parameters are passed through to the adapted
469
# for InterTree tests we want the machinery to bring up two trees in
470
# each instance: the base one, and the one we are interacting with.
471
# because each optimiser can be direction specific, we need to test
472
# each optimiser in its chosen direction.
473
# unlike the TestProviderAdapter we dont want to automatically add a
474
# parameterized one for WorkingTree - the optimisers will tell us what
476
from bzrlib.tests.per_tree import (
479
from bzrlib.tests.per_intertree import (
482
from bzrlib.workingtree_3 import WorkingTreeFormat3
483
from bzrlib.workingtree_4 import WorkingTreeFormat4
484
input_test = TestInterTreeScenarios(
488
format1 = WorkingTreeFormat4()
489
format2 = WorkingTreeFormat3()
490
formats = [("1", str, format1, format2, "converter1"),
491
("2", int, format2, format1, "converter2")]
492
scenarios = make_scenarios(server1, server2, formats)
493
self.assertEqual(2, len(scenarios))
494
expected_scenarios = [
496
"bzrdir_format": format1._matchingbzrdir,
497
"intertree_class": formats[0][1],
498
"workingtree_format": formats[0][2],
499
"workingtree_format_to": formats[0][3],
500
"mutable_trees_to_test_trees": formats[0][4],
501
"_workingtree_to_test_tree": return_parameter,
502
"transport_server": server1,
503
"transport_readonly_server": server2,
506
"bzrdir_format": format2._matchingbzrdir,
507
"intertree_class": formats[1][1],
508
"workingtree_format": formats[1][2],
509
"workingtree_format_to": formats[1][3],
510
"mutable_trees_to_test_trees": formats[1][4],
511
"_workingtree_to_test_tree": return_parameter,
512
"transport_server": server1,
513
"transport_readonly_server": server2,
516
self.assertEqual(scenarios, expected_scenarios)
519
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
521
def test_home_is_not_working(self):
522
self.assertNotEqual(self.test_dir, self.test_home_dir)
523
cwd = osutils.getcwd()
524
self.assertIsSameRealPath(self.test_dir, cwd)
525
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
527
def test_assertEqualStat_equal(self):
528
from bzrlib.tests.test_dirstate import _FakeStat
529
self.build_tree(["foo"])
530
real = os.lstat("foo")
531
fake = _FakeStat(real.st_size, real.st_mtime, real.st_ctime,
532
real.st_dev, real.st_ino, real.st_mode)
533
self.assertEqualStat(real, fake)
535
def test_assertEqualStat_notequal(self):
536
self.build_tree(["foo", "longname"])
537
self.assertRaises(AssertionError, self.assertEqualStat,
538
os.lstat("foo"), os.lstat("longname"))
540
def test_failUnlessExists(self):
541
"""Deprecated failUnlessExists and failIfExists"""
542
self.applyDeprecated(
543
deprecated_in((2, 4)),
544
self.failUnlessExists, '.')
545
self.build_tree(['foo/', 'foo/bar'])
546
self.applyDeprecated(
547
deprecated_in((2, 4)),
548
self.failUnlessExists, 'foo/bar')
549
self.applyDeprecated(
550
deprecated_in((2, 4)),
551
self.failIfExists, 'foo/foo')
553
def test_assertPathExists(self):
554
self.assertPathExists('.')
555
self.build_tree(['foo/', 'foo/bar'])
556
self.assertPathExists('foo/bar')
557
self.assertPathDoesNotExist('foo/foo')
560
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
562
def test_home_is_non_existant_dir_under_root(self):
563
"""The test_home_dir for TestCaseWithMemoryTransport is missing.
565
This is because TestCaseWithMemoryTransport is for tests that do not
566
need any disk resources: they should be hooked into bzrlib in such a
567
way that no global settings are being changed by the test (only a
568
few tests should need to do that), and having a missing dir as home is
569
an effective way to ensure that this is the case.
571
self.assertIsSameRealPath(
572
self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
574
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
576
def test_cwd_is_TEST_ROOT(self):
577
self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
578
cwd = osutils.getcwd()
579
self.assertIsSameRealPath(self.test_dir, cwd)
581
def test_BZR_HOME_and_HOME_are_bytestrings(self):
582
"""The $BZR_HOME and $HOME environment variables should not be unicode.
584
See https://bugs.launchpad.net/bzr/+bug/464174
586
self.assertIsInstance(os.environ['BZR_HOME'], str)
587
self.assertIsInstance(os.environ['HOME'], str)
589
def test_make_branch_and_memory_tree(self):
590
"""In TestCaseWithMemoryTransport we should not make the branch on disk.
592
This is hard to comprehensively robustly test, so we settle for making
593
a branch and checking no directory was created at its relpath.
595
tree = self.make_branch_and_memory_tree('dir')
596
# Guard against regression into MemoryTransport leaking
597
# files to disk instead of keeping them in memory.
598
self.assertFalse(osutils.lexists('dir'))
599
self.assertIsInstance(tree, memorytree.MemoryTree)
601
def test_make_branch_and_memory_tree_with_format(self):
602
"""make_branch_and_memory_tree should accept a format option."""
603
format = bzrdir.BzrDirMetaFormat1()
604
format.repository_format = repository.format_registry.get_default()
605
tree = self.make_branch_and_memory_tree('dir', format=format)
606
# Guard against regression into MemoryTransport leaking
607
# files to disk instead of keeping them in memory.
608
self.assertFalse(osutils.lexists('dir'))
609
self.assertIsInstance(tree, memorytree.MemoryTree)
610
self.assertEqual(format.repository_format.__class__,
611
tree.branch.repository._format.__class__)
613
def test_make_branch_builder(self):
614
builder = self.make_branch_builder('dir')
615
self.assertIsInstance(builder, branchbuilder.BranchBuilder)
616
# Guard against regression into MemoryTransport leaking
617
# files to disk instead of keeping them in memory.
618
self.assertFalse(osutils.lexists('dir'))
620
def test_make_branch_builder_with_format(self):
621
# Use a repo layout that doesn't conform to a 'named' layout, to ensure
622
# that the format objects are used.
623
format = bzrdir.BzrDirMetaFormat1()
624
repo_format = repository.format_registry.get_default()
625
format.repository_format = repo_format
626
builder = self.make_branch_builder('dir', format=format)
627
the_branch = builder.get_branch()
628
# Guard against regression into MemoryTransport leaking
629
# files to disk instead of keeping them in memory.
630
self.assertFalse(osutils.lexists('dir'))
631
self.assertEqual(format.repository_format.__class__,
632
the_branch.repository._format.__class__)
633
self.assertEqual(repo_format.get_format_string(),
634
self.get_transport().get_bytes(
635
'dir/.bzr/repository/format'))
637
def test_make_branch_builder_with_format_name(self):
638
builder = self.make_branch_builder('dir', format='knit')
639
the_branch = builder.get_branch()
640
# Guard against regression into MemoryTransport leaking
641
# files to disk instead of keeping them in memory.
642
self.assertFalse(osutils.lexists('dir'))
643
dir_format = controldir.format_registry.make_bzrdir('knit')
644
self.assertEqual(dir_format.repository_format.__class__,
645
the_branch.repository._format.__class__)
646
self.assertEqual('Bazaar-NG Knit Repository Format 1',
647
self.get_transport().get_bytes(
648
'dir/.bzr/repository/format'))
650
def test_dangling_locks_cause_failures(self):
651
class TestDanglingLock(tests.TestCaseWithMemoryTransport):
652
def test_function(self):
653
t = self.get_transport_from_path('.')
654
l = lockdir.LockDir(t, 'lock')
657
test = TestDanglingLock('test_function')
659
total_failures = result.errors + result.failures
660
if self._lock_check_thorough:
661
self.assertEqual(1, len(total_failures))
663
# When _lock_check_thorough is disabled, then we don't trigger a
665
self.assertEqual(0, len(total_failures))
668
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
669
"""Tests for the convenience functions TestCaseWithTransport introduces."""
671
def test_get_readonly_url_none(self):
672
from bzrlib.transport.readonly import ReadonlyTransportDecorator
673
self.vfs_transport_factory = memory.MemoryServer
674
self.transport_readonly_server = None
675
# calling get_readonly_transport() constructs a decorator on the url
677
url = self.get_readonly_url()
678
url2 = self.get_readonly_url('foo/bar')
679
t = transport.get_transport_from_url(url)
680
t2 = transport.get_transport_from_url(url2)
681
self.assertIsInstance(t, ReadonlyTransportDecorator)
682
self.assertIsInstance(t2, ReadonlyTransportDecorator)
683
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
685
def test_get_readonly_url_http(self):
686
from bzrlib.tests.http_server import HttpServer
687
from bzrlib.transport.http import HttpTransportBase
688
self.transport_server = test_server.LocalURLServer
689
self.transport_readonly_server = HttpServer
690
# calling get_readonly_transport() gives us a HTTP server instance.
691
url = self.get_readonly_url()
692
url2 = self.get_readonly_url('foo/bar')
693
# the transport returned may be any HttpTransportBase subclass
694
t = transport.get_transport_from_url(url)
695
t2 = transport.get_transport_from_url(url2)
696
self.assertIsInstance(t, HttpTransportBase)
697
self.assertIsInstance(t2, HttpTransportBase)
698
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
700
def test_is_directory(self):
701
"""Test assertIsDirectory assertion"""
702
t = self.get_transport()
703
self.build_tree(['a_dir/', 'a_file'], transport=t)
704
self.assertIsDirectory('a_dir', t)
705
self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
706
self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
708
def test_make_branch_builder(self):
709
builder = self.make_branch_builder('dir')
710
rev_id = builder.build_commit()
711
self.assertPathExists('dir')
712
a_dir = controldir.ControlDir.open('dir')
713
self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
714
a_branch = a_dir.open_branch()
715
builder_branch = builder.get_branch()
716
self.assertEqual(a_branch.base, builder_branch.base)
717
self.assertEqual((1, rev_id), builder_branch.last_revision_info())
718
self.assertEqual((1, rev_id), a_branch.last_revision_info())
721
class TestTestCaseTransports(tests.TestCaseWithTransport):
724
super(TestTestCaseTransports, self).setUp()
725
self.vfs_transport_factory = memory.MemoryServer
727
def test_make_bzrdir_preserves_transport(self):
728
t = self.get_transport()
729
result_bzrdir = self.make_bzrdir('subdir')
730
self.assertIsInstance(result_bzrdir.transport,
731
memory.MemoryTransport)
732
# should not be on disk, should only be in memory
733
self.assertPathDoesNotExist('subdir')
736
class TestChrootedTest(tests.ChrootedTestCase):
738
def test_root_is_root(self):
739
t = transport.get_transport_from_url(self.get_readonly_url())
741
self.assertEqual(url, t.clone('..').base)
744
class TestProfileResult(tests.TestCase):
746
def test_profiles_tests(self):
747
self.requireFeature(features.lsprof_feature)
748
terminal = testtools.testresult.doubles.ExtendedTestResult()
749
result = tests.ProfileResult(terminal)
750
class Sample(tests.TestCase):
752
self.sample_function()
753
def sample_function(self):
757
case = terminal._events[0][1]
758
self.assertLength(1, case._benchcalls)
759
# We must be able to unpack it as the test reporting code wants
760
(_, _, _), stats = case._benchcalls[0]
761
self.assertTrue(callable(stats.pprint))
764
class TestTestResult(tests.TestCase):
766
def check_timing(self, test_case, expected_re):
767
result = bzrlib.tests.TextTestResult(self._log_file,
771
capture = testtools.testresult.doubles.ExtendedTestResult()
772
test_case.run(MultiTestResult(result, capture))
773
run_case = capture._events[0][1]
774
timed_string = result._testTimeString(run_case)
775
self.assertContainsRe(timed_string, expected_re)
777
def test_test_reporting(self):
778
class ShortDelayTestCase(tests.TestCase):
779
def test_short_delay(self):
781
def test_short_benchmark(self):
782
self.time(time.sleep, 0.003)
783
self.check_timing(ShortDelayTestCase('test_short_delay'),
785
# if a benchmark time is given, we now show just that time followed by
787
self.check_timing(ShortDelayTestCase('test_short_benchmark'),
790
def test_unittest_reporting_unittest_class(self):
791
# getting the time from a non-bzrlib test works ok
792
class ShortDelayTestCase(unittest.TestCase):
793
def test_short_delay(self):
795
self.check_timing(ShortDelayTestCase('test_short_delay'),
798
def _time_hello_world_encoding(self):
799
"""Profile two sleep calls
801
This is used to exercise the test framework.
803
self.time(unicode, 'hello', errors='replace')
804
self.time(unicode, 'world', errors='replace')
806
def test_lsprofiling(self):
807
"""Verbose test result prints lsprof statistics from test cases."""
808
self.requireFeature(features.lsprof_feature)
809
result_stream = StringIO()
810
result = bzrlib.tests.VerboseTestResult(
815
# we want profile a call of some sort and check it is output by
816
# addSuccess. We dont care about addError or addFailure as they
817
# are not that interesting for performance tuning.
818
# make a new test instance that when run will generate a profile
819
example_test_case = TestTestResult("_time_hello_world_encoding")
820
example_test_case._gather_lsprof_in_benchmarks = True
821
# execute the test, which should succeed and record profiles
822
example_test_case.run(result)
823
# lsprofile_something()
824
# if this worked we want
825
# LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
826
# CallCount Recursive Total(ms) Inline(ms) module:lineno(function)
827
# (the lsprof header)
828
# ... an arbitrary number of lines
829
# and the function call which is time.sleep.
830
# 1 0 ??? ??? ???(sleep)
831
# and then repeated but with 'world', rather than 'hello'.
832
# this should appear in the output stream of our test result.
833
output = result_stream.getvalue()
834
self.assertContainsRe(output,
835
r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
836
self.assertContainsRe(output,
837
r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
838
self.assertContainsRe(output,
839
r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
840
self.assertContainsRe(output,
841
r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
843
def test_uses_time_from_testtools(self):
844
"""Test case timings in verbose results should use testtools times"""
846
class TimeAddedVerboseTestResult(tests.VerboseTestResult):
847
def startTest(self, test):
848
self.time(datetime.datetime.utcfromtimestamp(1.145))
849
super(TimeAddedVerboseTestResult, self).startTest(test)
850
def addSuccess(self, test):
851
self.time(datetime.datetime.utcfromtimestamp(51.147))
852
super(TimeAddedVerboseTestResult, self).addSuccess(test)
853
def report_tests_starting(self): pass
855
self.get_passing_test().run(TimeAddedVerboseTestResult(sio, 0, 2))
856
self.assertEndsWith(sio.getvalue(), "OK 50002ms\n")
858
def test_known_failure(self):
859
"""Using knownFailure should trigger several result actions."""
860
class InstrumentedTestResult(tests.ExtendedTestResult):
861
def stopTestRun(self): pass
862
def report_tests_starting(self): pass
863
def report_known_failure(self, test, err=None, details=None):
864
self._call = test, 'known failure'
865
result = InstrumentedTestResult(None, None, None, None)
866
class Test(tests.TestCase):
867
def test_function(self):
868
self.knownFailure('failed!')
869
test = Test("test_function")
871
# it should invoke 'report_known_failure'.
872
self.assertEqual(2, len(result._call))
873
self.assertEqual(test.id(), result._call[0].id())
874
self.assertEqual('known failure', result._call[1])
875
# we dont introspec the traceback, if the rest is ok, it would be
876
# exceptional for it not to be.
877
# it should update the known_failure_count on the object.
878
self.assertEqual(1, result.known_failure_count)
879
# the result should be successful.
880
self.assertTrue(result.wasSuccessful())
882
def test_verbose_report_known_failure(self):
883
# verbose test output formatting
884
result_stream = StringIO()
885
result = bzrlib.tests.VerboseTestResult(
890
_get_test("test_xfail").run(result)
891
self.assertContainsRe(result_stream.getvalue(),
892
"\n\\S+\\.test_xfail\\s+XFAIL\\s+\\d+ms\n"
893
"\\s*(?:Text attachment: )?reason"
898
def get_passing_test(self):
899
"""Return a test object that can't be run usefully."""
902
return unittest.FunctionTestCase(passing_test)
904
def test_add_not_supported(self):
905
"""Test the behaviour of invoking addNotSupported."""
906
class InstrumentedTestResult(tests.ExtendedTestResult):
907
def stopTestRun(self): pass
908
def report_tests_starting(self): pass
909
def report_unsupported(self, test, feature):
910
self._call = test, feature
911
result = InstrumentedTestResult(None, None, None, None)
912
test = SampleTestCase('_test_pass')
913
feature = features.Feature()
914
result.startTest(test)
915
result.addNotSupported(test, feature)
916
# it should invoke 'report_unsupported'.
917
self.assertEqual(2, len(result._call))
918
self.assertEqual(test, result._call[0])
919
self.assertEqual(feature, result._call[1])
920
# the result should be successful.
921
self.assertTrue(result.wasSuccessful())
922
# it should record the test against a count of tests not run due to
924
self.assertEqual(1, result.unsupported['Feature'])
925
# and invoking it again should increment that counter
926
result.addNotSupported(test, feature)
927
self.assertEqual(2, result.unsupported['Feature'])
929
def test_verbose_report_unsupported(self):
930
# verbose test output formatting
931
result_stream = StringIO()
932
result = bzrlib.tests.VerboseTestResult(
937
test = self.get_passing_test()
938
feature = features.Feature()
939
result.startTest(test)
940
prefix = len(result_stream.getvalue())
941
result.report_unsupported(test, feature)
942
output = result_stream.getvalue()[prefix:]
943
lines = output.splitlines()
944
# We don't check for the final '0ms' since it may fail on slow hosts
945
self.assertStartsWith(lines[0], 'NODEP')
946
self.assertEqual(lines[1],
947
" The feature 'Feature' is not available.")
949
def test_unavailable_exception(self):
950
"""An UnavailableFeature being raised should invoke addNotSupported."""
951
class InstrumentedTestResult(tests.ExtendedTestResult):
952
def stopTestRun(self): pass
953
def report_tests_starting(self): pass
954
def addNotSupported(self, test, feature):
955
self._call = test, feature
956
result = InstrumentedTestResult(None, None, None, None)
957
feature = features.Feature()
958
class Test(tests.TestCase):
959
def test_function(self):
960
raise tests.UnavailableFeature(feature)
961
test = Test("test_function")
963
# it should invoke 'addNotSupported'.
964
self.assertEqual(2, len(result._call))
965
self.assertEqual(test.id(), result._call[0].id())
966
self.assertEqual(feature, result._call[1])
967
# and not count as an error
968
self.assertEqual(0, result.error_count)
970
def test_strict_with_unsupported_feature(self):
971
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
973
test = self.get_passing_test()
974
feature = "Unsupported Feature"
975
result.addNotSupported(test, feature)
976
self.assertFalse(result.wasStrictlySuccessful())
977
self.assertEqual(None, result._extractBenchmarkTime(test))
979
def test_strict_with_known_failure(self):
980
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
982
test = _get_test("test_xfail")
984
self.assertFalse(result.wasStrictlySuccessful())
985
self.assertEqual(None, result._extractBenchmarkTime(test))
987
def test_strict_with_success(self):
988
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
990
test = self.get_passing_test()
991
result.addSuccess(test)
992
self.assertTrue(result.wasStrictlySuccessful())
993
self.assertEqual(None, result._extractBenchmarkTime(test))
995
def test_startTests(self):
996
"""Starting the first test should trigger startTests."""
997
class InstrumentedTestResult(tests.ExtendedTestResult):
999
def startTests(self): self.calls += 1
1000
result = InstrumentedTestResult(None, None, None, None)
1001
def test_function():
1003
test = unittest.FunctionTestCase(test_function)
1005
self.assertEqual(1, result.calls)
1007
def test_startTests_only_once(self):
1008
"""With multiple tests startTests should still only be called once"""
1009
class InstrumentedTestResult(tests.ExtendedTestResult):
1011
def startTests(self): self.calls += 1
1012
result = InstrumentedTestResult(None, None, None, None)
1013
suite = unittest.TestSuite([
1014
unittest.FunctionTestCase(lambda: None),
1015
unittest.FunctionTestCase(lambda: None)])
1017
self.assertEqual(1, result.calls)
1018
self.assertEqual(2, result.count)
1021
class TestRunner(tests.TestCase):
1023
def dummy_test(self):
1026
def run_test_runner(self, testrunner, test):
1027
"""Run suite in testrunner, saving global state and restoring it.
1029
This current saves and restores:
1030
TestCaseInTempDir.TEST_ROOT
1032
There should be no tests in this file that use
1033
bzrlib.tests.TextTestRunner without using this convenience method,
1034
because of our use of global state.
1036
old_root = tests.TestCaseInTempDir.TEST_ROOT
1038
tests.TestCaseInTempDir.TEST_ROOT = None
1039
return testrunner.run(test)
1041
tests.TestCaseInTempDir.TEST_ROOT = old_root
1043
def test_known_failure_failed_run(self):
1044
# run a test that generates a known failure which should be printed in
1045
# the final output when real failures occur.
1046
class Test(tests.TestCase):
1047
def known_failure_test(self):
1048
self.expectFailure('failed', self.assertTrue, False)
1049
test = unittest.TestSuite()
1050
test.addTest(Test("known_failure_test"))
1052
raise AssertionError('foo')
1053
test.addTest(unittest.FunctionTestCase(failing_test))
1055
runner = tests.TextTestRunner(stream=stream)
1056
result = self.run_test_runner(runner, test)
1057
lines = stream.getvalue().splitlines()
1058
self.assertContainsRe(stream.getvalue(),
1059
'(?sm)^bzr selftest.*$'
1061
'^======================================================================\n'
1062
'^FAIL: failing_test\n'
1063
'^----------------------------------------------------------------------\n'
1064
'Traceback \\(most recent call last\\):\n'
1065
' .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1066
' raise AssertionError\\(\'foo\'\\)\n'
1068
'^----------------------------------------------------------------------\n'
1070
'FAILED \\(failures=1, known_failure_count=1\\)'
1073
def test_known_failure_ok_run(self):
1074
# run a test that generates a known failure which should be printed in
1076
class Test(tests.TestCase):
1077
def known_failure_test(self):
1078
self.knownFailure("Never works...")
1079
test = Test("known_failure_test")
1081
runner = tests.TextTestRunner(stream=stream)
1082
result = self.run_test_runner(runner, test)
1083
self.assertContainsRe(stream.getvalue(),
1086
'Ran 1 test in .*\n'
1088
'OK \\(known_failures=1\\)\n')
1090
def test_unexpected_success_bad(self):
1091
class Test(tests.TestCase):
1092
def test_truth(self):
1093
self.expectFailure("No absolute truth", self.assertTrue, True)
1094
runner = tests.TextTestRunner(stream=StringIO())
1095
result = self.run_test_runner(runner, Test("test_truth"))
1096
self.assertContainsRe(runner.stream.getvalue(),
1098
"FAIL: \\S+\.test_truth\n"
1101
"\\s*(?:Text attachment: )?reason"
1107
"Ran 1 test in .*\n"
1109
"FAILED \\(failures=1\\)\n\\Z")
1111
def test_result_decorator(self):
1114
class LoggingDecorator(ExtendedToOriginalDecorator):
1115
def startTest(self, test):
1116
ExtendedToOriginalDecorator.startTest(self, test)
1117
calls.append('start')
1118
test = unittest.FunctionTestCase(lambda:None)
1120
runner = tests.TextTestRunner(stream=stream,
1121
result_decorators=[LoggingDecorator])
1122
result = self.run_test_runner(runner, test)
1123
self.assertLength(1, calls)
1125
def test_skipped_test(self):
1126
# run a test that is skipped, and check the suite as a whole still
1128
# skipping_test must be hidden in here so it's not run as a real test
1129
class SkippingTest(tests.TestCase):
1130
def skipping_test(self):
1131
raise tests.TestSkipped('test intentionally skipped')
1132
runner = tests.TextTestRunner(stream=self._log_file)
1133
test = SkippingTest("skipping_test")
1134
result = self.run_test_runner(runner, test)
1135
self.assertTrue(result.wasSuccessful())
1137
def test_skipped_from_setup(self):
1139
class SkippedSetupTest(tests.TestCase):
1142
calls.append('setUp')
1143
self.addCleanup(self.cleanup)
1144
raise tests.TestSkipped('skipped setup')
1146
def test_skip(self):
1147
self.fail('test reached')
1150
calls.append('cleanup')
1152
runner = tests.TextTestRunner(stream=self._log_file)
1153
test = SkippedSetupTest('test_skip')
1154
result = self.run_test_runner(runner, test)
1155
self.assertTrue(result.wasSuccessful())
1156
# Check if cleanup was called the right number of times.
1157
self.assertEqual(['setUp', 'cleanup'], calls)
1159
def test_skipped_from_test(self):
1161
class SkippedTest(tests.TestCase):
1164
super(SkippedTest, self).setUp()
1165
calls.append('setUp')
1166
self.addCleanup(self.cleanup)
1168
def test_skip(self):
1169
raise tests.TestSkipped('skipped test')
1172
calls.append('cleanup')
1174
runner = tests.TextTestRunner(stream=self._log_file)
1175
test = SkippedTest('test_skip')
1176
result = self.run_test_runner(runner, test)
1177
self.assertTrue(result.wasSuccessful())
1178
# Check if cleanup was called the right number of times.
1179
self.assertEqual(['setUp', 'cleanup'], calls)
1181
def test_not_applicable(self):
1182
# run a test that is skipped because it's not applicable
1183
class Test(tests.TestCase):
1184
def not_applicable_test(self):
1185
raise tests.TestNotApplicable('this test never runs')
1187
runner = tests.TextTestRunner(stream=out, verbosity=2)
1188
test = Test("not_applicable_test")
1189
result = self.run_test_runner(runner, test)
1190
self._log_file.write(out.getvalue())
1191
self.assertTrue(result.wasSuccessful())
1192
self.assertTrue(result.wasStrictlySuccessful())
1193
self.assertContainsRe(out.getvalue(),
1194
r'(?m)not_applicable_test * N/A')
1195
self.assertContainsRe(out.getvalue(),
1196
r'(?m)^ this test never runs')
1198
def test_unsupported_features_listed(self):
1199
"""When unsupported features are encountered they are detailed."""
1200
class Feature1(features.Feature):
1201
def _probe(self): return False
1202
class Feature2(features.Feature):
1203
def _probe(self): return False
1204
# create sample tests
1205
test1 = SampleTestCase('_test_pass')
1206
test1._test_needs_features = [Feature1()]
1207
test2 = SampleTestCase('_test_pass')
1208
test2._test_needs_features = [Feature2()]
1209
test = unittest.TestSuite()
1213
runner = tests.TextTestRunner(stream=stream)
1214
result = self.run_test_runner(runner, test)
1215
lines = stream.getvalue().splitlines()
1218
"Missing feature 'Feature1' skipped 1 tests.",
1219
"Missing feature 'Feature2' skipped 1 tests.",
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):
1283
def _test_pass(self):
1286
class _TestException(Exception):
1290
class TestTestCase(tests.TestCase):
1291
"""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
def test_debug_flags_sanitised(self):
1337
"""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
# we could set something and run a test that will check
1342
# it gets santised, but this is probably sufficient for now:
1343
# 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)
1419
def inner_test(self):
1420
# the inner child test
1423
def outer_child(self):
1424
# the outer child test
1426
self.inner_test = TestTestCase("inner_child")
1427
result = self.make_test_result()
1428
self.inner_test.run(result)
1429
note("outer finish")
1430
self.addCleanup(osutils.delete_any, self._log_file_name)
1432
def test_trace_nesting(self):
1433
# this tests that each test case nests its trace facility correctly.
1434
# we do this by running a test case manually. That test case (A)
1435
# should setup a new log, log content to it, setup a child case (B),
1436
# which should log independently, then case (A) should log a trailer
1438
# we do two nested children so that we can verify the state of the
1439
# logs after the outer child finishes is correct, which a bad clean
1440
# up routine in tearDown might trigger a fault in our test with only
1441
# one child, we should instead see the bad result inside our test with
1443
# the outer child test
1444
original_trace = bzrlib.trace._trace_file
1445
outer_test = TestTestCase("outer_child")
1446
result = self.make_test_result()
1447
outer_test.run(result)
1448
self.assertEqual(original_trace, bzrlib.trace._trace_file)
1450
def method_that_times_a_bit_twice(self):
1451
# call self.time twice to ensure it aggregates
1452
self.time(time.sleep, 0.007)
1453
self.time(time.sleep, 0.007)
1455
def test_time_creates_benchmark_in_result(self):
1456
"""Test that the TestCase.time() method accumulates a benchmark time."""
1457
sample_test = TestTestCase("method_that_times_a_bit_twice")
1458
output_stream = StringIO()
1459
result = bzrlib.tests.VerboseTestResult(
1463
sample_test.run(result)
1464
self.assertContainsRe(
1465
output_stream.getvalue(),
1468
def test_hooks_sanitised(self):
1469
"""The bzrlib hooks should be sanitised by setUp."""
1470
# Note this test won't fail with hooks that the core library doesn't
1471
# use - but it trigger with a plugin that adds hooks, so its still a
1472
# useful warning in that case.
1473
self.assertEqual(bzrlib.branch.BranchHooks(), bzrlib.branch.Branch.hooks)
1475
bzrlib.smart.server.SmartServerHooks(),
1476
bzrlib.smart.server.SmartTCPServer.hooks)
1478
bzrlib.commands.CommandHooks(), bzrlib.commands.Command.hooks)
1480
def test__gather_lsprof_in_benchmarks(self):
1481
"""When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1483
Each self.time() call is individually and separately profiled.
1485
self.requireFeature(features.lsprof_feature)
1486
# overrides the class member with an instance member so no cleanup
1488
self._gather_lsprof_in_benchmarks = True
1489
self.time(time.sleep, 0.000)
1490
self.time(time.sleep, 0.003)
1491
self.assertEqual(2, len(self._benchcalls))
1492
self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
1493
self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1494
self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1495
self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1496
del self._benchcalls[:]
1498
def test_knownFailure(self):
1499
"""Self.knownFailure() should raise a KnownFailure exception."""
1500
self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1502
def test_open_bzrdir_safe_roots(self):
1503
# even a memory transport should fail to open when its url isn't
1505
# Manually set one up (TestCase doesn't and shouldn't provide magic
1507
transport_server = memory.MemoryServer()
1508
transport_server.start_server()
1509
self.addCleanup(transport_server.stop_server)
1510
t = transport.get_transport_from_url(transport_server.get_url())
1511
controldir.ControlDir.create(t.base)
1512
self.assertRaises(errors.BzrError,
1513
controldir.ControlDir.open_from_transport, t)
1514
# But if we declare this as safe, we can open the bzrdir.
1515
self.permit_url(t.base)
1516
self._bzr_selftest_roots.append(t.base)
1517
controldir.ControlDir.open_from_transport(t)
1519
def test_requireFeature_available(self):
1520
"""self.requireFeature(available) is a no-op."""
1521
class Available(features.Feature):
1522
def _probe(self):return True
1523
feature = Available()
1524
self.requireFeature(feature)
1526
def test_requireFeature_unavailable(self):
1527
"""self.requireFeature(unavailable) raises UnavailableFeature."""
1528
class Unavailable(features.Feature):
1529
def _probe(self):return False
1530
feature = Unavailable()
1531
self.assertRaises(tests.UnavailableFeature,
1532
self.requireFeature, feature)
1534
def test_run_no_parameters(self):
1535
test = SampleTestCase('_test_pass')
1538
def test_run_enabled_unittest_result(self):
1539
"""Test we revert to regular behaviour when the test is enabled."""
1540
test = SampleTestCase('_test_pass')
1541
class EnabledFeature(object):
1542
def available(self):
1544
test._test_needs_features = [EnabledFeature()]
1545
result = unittest.TestResult()
1547
self.assertEqual(1, result.testsRun)
1548
self.assertEqual([], result.errors)
1549
self.assertEqual([], result.failures)
1551
def test_run_disabled_unittest_result(self):
1552
"""Test our compatability for disabled tests with unittest results."""
1553
test = SampleTestCase('_test_pass')
1554
class DisabledFeature(object):
1555
def available(self):
1557
test._test_needs_features = [DisabledFeature()]
1558
result = unittest.TestResult()
1560
self.assertEqual(1, result.testsRun)
1561
self.assertEqual([], result.errors)
1562
self.assertEqual([], result.failures)
1564
def test_run_disabled_supporting_result(self):
1565
"""Test disabled tests behaviour with support aware results."""
1566
test = SampleTestCase('_test_pass')
1567
class DisabledFeature(object):
1568
def __eq__(self, other):
1569
return isinstance(other, DisabledFeature)
1570
def available(self):
1572
the_feature = DisabledFeature()
1573
test._test_needs_features = [the_feature]
1574
class InstrumentedTestResult(unittest.TestResult):
1576
unittest.TestResult.__init__(self)
1578
def startTest(self, test):
1579
self.calls.append(('startTest', test))
1580
def stopTest(self, test):
1581
self.calls.append(('stopTest', test))
1582
def addNotSupported(self, test, feature):
1583
self.calls.append(('addNotSupported', test, feature))
1584
result = InstrumentedTestResult()
1586
case = result.calls[0][1]
1588
('startTest', case),
1589
('addNotSupported', case, 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)))
1883
def sample_deprecated_function():
1884
"""A deprecated function to test applyDeprecated with."""
1888
def sample_undeprecated_function(a_param):
1889
"""A undeprecated function to test applyDeprecated with."""
1892
class ApplyDeprecatedHelper(object):
1893
"""A helper class for ApplyDeprecated tests."""
1895
@deprecated_method(deprecated_in((0, 11, 0)))
1896
def sample_deprecated_method(self, param_one):
1897
"""A deprecated method for testing with."""
1900
def sample_normal_method(self):
1901
"""A undeprecated method."""
1903
@deprecated_method(deprecated_in((0, 10, 0)))
1904
def sample_nested_deprecation(self):
1905
return sample_deprecated_function()
1908
class TestExtraAssertions(tests.TestCase):
1909
"""Tests for new test assertions in bzrlib test suite"""
1911
def test_assert_isinstance(self):
1912
self.assertIsInstance(2, int)
1913
self.assertIsInstance(u'', basestring)
1914
e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1915
self.assertEqual(str(e),
1916
"None is an instance of <type 'NoneType'> rather than <type 'int'>")
1917
self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1918
e = self.assertRaises(AssertionError,
1919
self.assertIsInstance, None, int, "it's just not")
1920
self.assertEqual(str(e),
1921
"None is an instance of <type 'NoneType'> rather than <type 'int'>"
1924
def test_assertEndsWith(self):
1925
self.assertEndsWith('foo', 'oo')
1926
self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1928
def test_assertEqualDiff(self):
1929
e = self.assertRaises(AssertionError,
1930
self.assertEqualDiff, '', '\n')
1931
self.assertEqual(str(e),
1932
# Don't blink ! The '+' applies to the second string
1933
'first string is missing a final newline.\n+ \n')
1934
e = self.assertRaises(AssertionError,
1935
self.assertEqualDiff, '\n', '')
1936
self.assertEqual(str(e),
1937
# Don't blink ! The '-' applies to the second string
1938
'second string is missing a final newline.\n- \n')
1941
class TestDeprecations(tests.TestCase):
1943
def test_applyDeprecated_not_deprecated(self):
1944
sample_object = ApplyDeprecatedHelper()
1945
# calling an undeprecated callable raises an assertion
1946
self.assertRaises(AssertionError, self.applyDeprecated,
1947
deprecated_in((0, 11, 0)),
1948
sample_object.sample_normal_method)
1949
self.assertRaises(AssertionError, self.applyDeprecated,
1950
deprecated_in((0, 11, 0)),
1951
sample_undeprecated_function, "a param value")
1952
# calling a deprecated callable (function or method) with the wrong
1953
# expected deprecation fails.
1954
self.assertRaises(AssertionError, self.applyDeprecated,
1955
deprecated_in((0, 10, 0)),
1956
sample_object.sample_deprecated_method, "a param value")
1957
self.assertRaises(AssertionError, self.applyDeprecated,
1958
deprecated_in((0, 10, 0)),
1959
sample_deprecated_function)
1960
# calling a deprecated callable (function or method) with the right
1961
# expected deprecation returns the functions result.
1962
self.assertEqual("a param value",
1963
self.applyDeprecated(deprecated_in((0, 11, 0)),
1964
sample_object.sample_deprecated_method, "a param value"))
1965
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
1966
sample_deprecated_function))
1967
# calling a nested deprecation with the wrong deprecation version
1968
# fails even if a deeper nested function was deprecated with the
1970
self.assertRaises(AssertionError, self.applyDeprecated,
1971
deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
1972
# calling a nested deprecation with the right deprecation value
1973
# returns the calls result.
1974
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
1975
sample_object.sample_nested_deprecation))
1977
def test_callDeprecated(self):
1978
def testfunc(be_deprecated, result=None):
1979
if be_deprecated is True:
1980
symbol_versioning.warn('i am deprecated', DeprecationWarning,
1983
result = self.callDeprecated(['i am deprecated'], testfunc, True)
1984
self.assertIs(None, result)
1985
result = self.callDeprecated([], testfunc, False, 'result')
1986
self.assertEqual('result', result)
1987
self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1988
self.callDeprecated([], testfunc, be_deprecated=False)
1991
class TestWarningTests(tests.TestCase):
1992
"""Tests for calling methods that raise warnings."""
1994
def test_callCatchWarnings(self):
1996
warnings.warn("this is your last warning")
1998
wlist, result = self.callCatchWarnings(meth, 1, 2)
1999
self.assertEqual(3, result)
2000
# would like just to compare them, but UserWarning doesn't implement
2003
self.assertIsInstance(w0, UserWarning)
2004
self.assertEqual("this is your last warning", str(w0))
2007
class TestConvenienceMakers(tests.TestCaseWithTransport):
2008
"""Test for the make_* convenience functions."""
2010
def test_make_branch_and_tree_with_format(self):
2011
# we should be able to supply a format to make_branch_and_tree
2012
self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
2013
self.assertIsInstance(bzrlib.controldir.ControlDir.open('a')._format,
2014
bzrlib.bzrdir.BzrDirMetaFormat1)
2016
def test_make_branch_and_memory_tree(self):
2017
# we should be able to get a new branch and a mutable tree from
2018
# TestCaseWithTransport
2019
tree = self.make_branch_and_memory_tree('a')
2020
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://'))
2028
tree = self.make_branch_and_tree('t1')
2029
base = tree.bzrdir.root_transport.base
2030
self.assertStartsWith(base, 'file://')
2031
self.assertEqual(tree.bzrdir.root_transport,
2032
tree.branch.bzrdir.root_transport)
2033
self.assertEqual(tree.bzrdir.root_transport,
2034
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):
2055
"""Tests of bzrlib.tests.selftest."""
2057
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
2060
factory_called.append(True)
2061
return TestUtil.TestSuite()
2064
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
2065
test_suite_factory=factory)
2066
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])
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):
2671
super(TestSelftestFiltering, self).setUp()
2672
self.suite = TestUtil.TestSuite()
2673
self.loader = TestUtil.TestLoader()
2674
self.suite.addTest(self.loader.loadTestsFromModule(
2675
sys.modules['bzrlib.tests.test_selftest']))
2676
self.all_names = _test_ids(self.suite)
2678
def test_condition_id_re(self):
2679
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2680
'test_condition_id_re')
2681
filtered_suite = tests.filter_suite_by_condition(
2682
self.suite, tests.condition_id_re('test_condition_id_re'))
2683
self.assertEqual([test_name], _test_ids(filtered_suite))
2685
def test_condition_id_in_list(self):
2686
test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
2687
'test_condition_id_in_list']
2688
id_list = tests.TestIdList(test_names)
2689
filtered_suite = tests.filter_suite_by_condition(
2690
self.suite, tests.condition_id_in_list(id_list))
2691
my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
2692
re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
2693
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2695
def test_condition_id_startswith(self):
2696
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))
2706
def test_condition_isinstance(self):
2707
filtered_suite = tests.filter_suite_by_condition(
2708
self.suite, tests.condition_isinstance(self.__class__))
2709
class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2710
re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
2711
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2713
def test_exclude_tests_by_condition(self):
2714
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2715
'test_exclude_tests_by_condition')
2716
filtered_suite = tests.exclude_tests_by_condition(self.suite,
2717
lambda x:x.id() == excluded_name)
2718
self.assertEqual(len(self.all_names) - 1,
2719
filtered_suite.countTestCases())
2720
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2721
remaining_names = list(self.all_names)
2722
remaining_names.remove(excluded_name)
2723
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2725
def test_exclude_tests_by_re(self):
2726
self.all_names = _test_ids(self.suite)
2727
filtered_suite = tests.exclude_tests_by_re(self.suite,
2728
'exclude_tests_by_re')
2729
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2730
'test_exclude_tests_by_re')
2731
self.assertEqual(len(self.all_names) - 1,
2732
filtered_suite.countTestCases())
2733
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2734
remaining_names = list(self.all_names)
2735
remaining_names.remove(excluded_name)
2736
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2738
def test_filter_suite_by_condition(self):
2739
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2740
'test_filter_suite_by_condition')
2741
filtered_suite = tests.filter_suite_by_condition(self.suite,
2742
lambda x:x.id() == test_name)
2743
self.assertEqual([test_name], _test_ids(filtered_suite))
2745
def test_filter_suite_by_re(self):
2746
filtered_suite = tests.filter_suite_by_re(self.suite,
2747
'test_filter_suite_by_r')
2748
filtered_names = _test_ids(filtered_suite)
2749
self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
2750
'TestSelftestFiltering.test_filter_suite_by_re'])
2752
def test_filter_suite_by_id_list(self):
2753
test_list = ['bzrlib.tests.test_selftest.'
2754
'TestSelftestFiltering.test_filter_suite_by_id_list']
2755
filtered_suite = tests.filter_suite_by_id_list(
2756
self.suite, tests.TestIdList(test_list))
2757
filtered_names = _test_ids(filtered_suite)
2760
['bzrlib.tests.test_selftest.'
2761
'TestSelftestFiltering.test_filter_suite_by_id_list'])
2763
def test_filter_suite_by_id_startswith(self):
2764
# By design this test may fail if another test is added whose name also
2765
# begins with one of the start value used.
2766
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2767
start1 = klass + 'test_filter_suite_by_id_starts'
2768
start2 = klass + 'test_filter_suite_by_id_li'
2769
test_list = [klass + 'test_filter_suite_by_id_list',
2770
klass + 'test_filter_suite_by_id_startswith',
2772
filtered_suite = tests.filter_suite_by_id_startswith(
2773
self.suite, [start1, start2])
2776
_test_ids(filtered_suite),
2779
def test_preserve_input(self):
2780
# NB: Surely this is something in the stdlib to do this?
2781
self.assertTrue(self.suite is tests.preserve_input(self.suite))
2782
self.assertTrue("@#$" is tests.preserve_input("@#$"))
2784
def test_randomize_suite(self):
2785
randomized_suite = tests.randomize_suite(self.suite)
2786
# randomizing should not add or remove test names.
2787
self.assertEqual(set(_test_ids(self.suite)),
2788
set(_test_ids(randomized_suite)))
2789
# Technically, this *can* fail, because random.shuffle(list) can be
2790
# equal to list. Trying multiple times just pushes the frequency back.
2791
# As its len(self.all_names)!:1, the failure frequency should be low
2792
# enough to ignore. RBC 20071021.
2793
# It should change the order.
2794
self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
2795
# But not the length. (Possibly redundant with the set test, but not
2797
self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
2799
def test_split_suit_by_condition(self):
2800
self.all_names = _test_ids(self.suite)
2801
condition = tests.condition_id_re('test_filter_suite_by_r')
2802
split_suite = tests.split_suite_by_condition(self.suite, condition)
2803
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2804
'test_filter_suite_by_re')
2805
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2806
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2807
remaining_names = list(self.all_names)
2808
remaining_names.remove(filtered_name)
2809
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2811
def test_split_suit_by_re(self):
2812
self.all_names = _test_ids(self.suite)
2813
split_suite = tests.split_suite_by_re(self.suite,
2814
'test_filter_suite_by_r')
2815
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2816
'test_filter_suite_by_re')
2817
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2818
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2819
remaining_names = list(self.all_names)
2820
remaining_names.remove(filtered_name)
2821
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2824
class TestCheckTreeShape(tests.TestCaseWithTransport):
2826
def test_check_tree_shape(self):
2827
files = ['a', 'b/', 'b/c']
2828
tree = self.make_branch_and_tree('.')
2829
self.build_tree(files)
2833
self.check_tree_shape(tree, files)
2838
class TestBlackboxSupport(tests.TestCase):
2839
"""Tests for testsuite blackbox features."""
2841
def test_run_bzr_failure_not_caught(self):
2842
# When we run bzr in blackbox mode, we want any unexpected errors to
2843
# propagate up to the test suite so that it can show the error in the
2844
# usual way, and we won't get a double traceback.
2845
e = self.assertRaises(
2847
self.run_bzr, ['assert-fail'])
2848
# make sure we got the real thing, not an error from somewhere else in
2849
# the test framework
2850
self.assertEqual('always fails', str(e))
2851
# check that there's no traceback in the test log
2852
self.assertNotContainsRe(self.get_log(), r'Traceback')
2854
def test_run_bzr_user_error_caught(self):
2855
# Running bzr in blackbox mode, normal/expected/user errors should be
2856
# caught in the regular way and turned into an error message plus exit
2858
transport_server = memory.MemoryServer()
2859
transport_server.start_server()
2860
self.addCleanup(transport_server.stop_server)
2861
url = transport_server.get_url()
2862
self.permit_url(url)
2863
out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
2864
self.assertEqual(out, '')
2865
self.assertContainsRe(err,
2866
'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2869
class TestTestLoader(tests.TestCase):
2870
"""Tests for the test loader."""
2872
def _get_loader_and_module(self):
2873
"""Gets a TestLoader and a module with one test in it."""
2874
loader = TestUtil.TestLoader()
2876
class Stub(tests.TestCase):
2879
class MyModule(object):
2881
MyModule.a_class = Stub
2883
return loader, module
2885
def test_module_no_load_tests_attribute_loads_classes(self):
2886
loader, module = self._get_loader_and_module()
2887
self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
2889
def test_module_load_tests_attribute_gets_called(self):
2890
loader, module = self._get_loader_and_module()
2891
# 'self' is here because we're faking the module with a class. Regular
2892
# load_tests do not need that :)
2893
def load_tests(self, standard_tests, module, loader):
2894
result = loader.suiteClass()
2895
for test in tests.iter_suite_tests(standard_tests):
2896
result.addTests([test, test])
2898
# add a load_tests() method which multiplies the tests from the module.
2899
module.__class__.load_tests = load_tests
2900
self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
2902
def test_load_tests_from_module_name_smoke_test(self):
2903
loader = TestUtil.TestLoader()
2904
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2905
self.assertEqual(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2908
def test_load_tests_from_module_name_with_bogus_module_name(self):
2909
loader = TestUtil.TestLoader()
2910
self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
2913
class TestTestIdList(tests.TestCase):
2915
def _create_id_list(self, test_list):
2916
return tests.TestIdList(test_list)
2918
def _create_suite(self, test_id_list):
2920
class Stub(tests.TestCase):
2924
def _create_test_id(id):
2927
suite = TestUtil.TestSuite()
2928
for id in test_id_list:
2929
t = Stub('test_foo')
2930
t.id = _create_test_id(id)
2934
def _test_ids(self, test_suite):
2935
"""Get the ids for the tests in a test suite."""
2936
return [t.id() for t in tests.iter_suite_tests(test_suite)]
2938
def test_empty_list(self):
2939
id_list = self._create_id_list([])
2940
self.assertEqual({}, id_list.tests)
2941
self.assertEqual({}, id_list.modules)
2943
def test_valid_list(self):
2944
id_list = self._create_id_list(
2945
['mod1.cl1.meth1', 'mod1.cl1.meth2',
2946
'mod1.func1', 'mod1.cl2.meth2',
2948
'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
2950
self.assertTrue(id_list.refers_to('mod1'))
2951
self.assertTrue(id_list.refers_to('mod1.submod1'))
2952
self.assertTrue(id_list.refers_to('mod1.submod2'))
2953
self.assertTrue(id_list.includes('mod1.cl1.meth1'))
2954
self.assertTrue(id_list.includes('mod1.submod1'))
2955
self.assertTrue(id_list.includes('mod1.func1'))
2957
def test_bad_chars_in_params(self):
2958
id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
2959
self.assertTrue(id_list.refers_to('mod1'))
2960
self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
2962
def test_module_used(self):
2963
id_list = self._create_id_list(['mod.class.meth'])
2964
self.assertTrue(id_list.refers_to('mod'))
2965
self.assertTrue(id_list.refers_to('mod.class'))
2966
self.assertTrue(id_list.refers_to('mod.class.meth'))
2968
def test_test_suite_matches_id_list_with_unknown(self):
2969
loader = TestUtil.TestLoader()
2970
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2971
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
2973
not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
2974
self.assertEqual(['bogus'], not_found)
2975
self.assertEqual([], duplicates)
2977
def test_suite_matches_id_list_with_duplicates(self):
2978
loader = TestUtil.TestLoader()
2979
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2980
dupes = loader.suiteClass()
2981
for test in tests.iter_suite_tests(suite):
2983
dupes.addTest(test) # Add it again
2985
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
2986
not_found, duplicates = tests.suite_matches_id_list(
2988
self.assertEqual([], not_found)
2989
self.assertEqual(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2993
class TestTestSuite(tests.TestCase):
2995
def test__test_suite_testmod_names(self):
2996
# Test that a plausible list of test module names are returned
2997
# by _test_suite_testmod_names.
2998
test_list = tests._test_suite_testmod_names()
3000
'bzrlib.tests.blackbox',
3001
'bzrlib.tests.per_transport',
3002
'bzrlib.tests.test_selftest',
3006
def test__test_suite_modules_to_doctest(self):
3007
# Test that a plausible list of modules to doctest is returned
3008
# by _test_suite_modules_to_doctest.
3009
test_list = tests._test_suite_modules_to_doctest()
3011
# When docstrings are stripped, there are no modules to doctest
3012
self.assertEqual([], test_list)
3019
def test_test_suite(self):
3020
# test_suite() loads the entire test suite to operate. To avoid this
3021
# overhead, and yet still be confident that things are happening,
3022
# we temporarily replace two functions used by test_suite with
3023
# test doubles that supply a few sample tests to load, and check they
3026
def testmod_names():
3027
calls.append("testmod_names")
3029
'bzrlib.tests.blackbox.test_branch',
3030
'bzrlib.tests.per_transport',
3031
'bzrlib.tests.test_selftest',
3033
self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
3035
calls.append("modules_to_doctest")
3038
return ['bzrlib.timestamp']
3039
self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
3040
expected_test_list = [
3042
'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
3043
('bzrlib.tests.per_transport.TransportTests'
3044
'.test_abspath(LocalTransport,LocalURLServer)'),
3045
'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
3046
# plugins can't be tested that way since selftest may be run with
3049
if __doc__ is not None:
3050
expected_test_list.extend([
3051
# modules_to_doctest
3052
'bzrlib.timestamp.format_highres_date',
3054
suite = tests.test_suite()
3055
self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
3057
self.assertSubset(expected_test_list, _test_ids(suite))
3059
def test_test_suite_list_and_start(self):
3060
# We cannot test this at the same time as the main load, because we want
3061
# to know that starting_with == None works. So a second load is
3062
# incurred - note that the starting_with parameter causes a partial load
3063
# rather than a full load so this test should be pretty quick.
3064
test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
3065
suite = tests.test_suite(test_list,
3066
['bzrlib.tests.test_selftest.TestTestSuite'])
3067
# test_test_suite_list_and_start is not included
3068
self.assertEqual(test_list, _test_ids(suite))
3071
class TestLoadTestIdList(tests.TestCaseInTempDir):
3073
def _create_test_list_file(self, file_name, content):
3074
fl = open(file_name, 'wt')
3078
def test_load_unknown(self):
3079
self.assertRaises(errors.NoSuchFile,
3080
tests.load_test_id_list, 'i_do_not_exist')
3082
def test_load_test_list(self):
3083
test_list_fname = 'test.list'
3084
self._create_test_list_file(test_list_fname,
3085
'mod1.cl1.meth1\nmod2.cl2.meth2\n')
3086
tlist = tests.load_test_id_list(test_list_fname)
3087
self.assertEqual(2, len(tlist))
3088
self.assertEqual('mod1.cl1.meth1', tlist[0])
3089
self.assertEqual('mod2.cl2.meth2', tlist[1])
3091
def test_load_dirty_file(self):
3092
test_list_fname = 'test.list'
3093
self._create_test_list_file(test_list_fname,
3094
' mod1.cl1.meth1\n\nmod2.cl2.meth2 \n'
3096
tlist = tests.load_test_id_list(test_list_fname)
3097
self.assertEqual(4, len(tlist))
3098
self.assertEqual('mod1.cl1.meth1', tlist[0])
3099
self.assertEqual('', tlist[1])
3100
self.assertEqual('mod2.cl2.meth2', tlist[2])
3101
self.assertEqual('bar baz', tlist[3])
3104
class TestFilteredByModuleTestLoader(tests.TestCase):
3106
def _create_loader(self, test_list):
3107
id_filter = tests.TestIdList(test_list)
3108
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3111
def test_load_tests(self):
3112
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
3113
loader = self._create_loader(test_list)
3114
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3115
self.assertEqual(test_list, _test_ids(suite))
3117
def test_exclude_tests(self):
3118
test_list = ['bogus']
3119
loader = self._create_loader(test_list)
3120
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3121
self.assertEqual([], _test_ids(suite))
3124
class TestFilteredByNameStartTestLoader(tests.TestCase):
3126
def _create_loader(self, name_start):
3127
def needs_module(name):
3128
return name.startswith(name_start) or name_start.startswith(name)
3129
loader = TestUtil.FilteredByModuleTestLoader(needs_module)
3132
def test_load_tests(self):
3133
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
3134
loader = self._create_loader('bzrlib.tests.test_samp')
3136
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3137
self.assertEqual(test_list, _test_ids(suite))
3139
def test_load_tests_inside_module(self):
3140
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
3141
loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
3143
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3144
self.assertEqual(test_list, _test_ids(suite))
3146
def test_exclude_tests(self):
3147
test_list = ['bogus']
3148
loader = self._create_loader('bogus')
3150
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')
added
removed
bzrlib/tests/test_selftest.py
