1
# Copyright (C) 2005-2011 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
29
from testtools import (
30
ExtendedToOriginalDecorator,
33
from testtools.content import Content
34
from testtools.content_type import ContentType
35
from testtools.matchers import (
39
import testtools.tests.helpers
58
from bzrlib.repofmt import (
61
from bzrlib.symbol_versioning import (
66
from bzrlib.tests import (
72
from bzrlib.trace import note, mutter
73
from bzrlib.transport import memory
76
def _test_ids(test_suite):
77
"""Get the ids for the tests in a test suite."""
78
return [t.id() for t in tests.iter_suite_tests(test_suite)]
81
class MetaTestLog(tests.TestCase):
83
def test_logging(self):
84
"""Test logs are captured when a test fails."""
85
self.log('a test message')
86
details = self.getDetails()
88
self.assertThat(log.content_type, Equals(ContentType(
89
"text", "plain", {"charset": "utf8"})))
90
self.assertThat(u"".join(log.iter_text()), Equals(self.get_log()))
91
self.assertThat(self.get_log(),
92
DocTestMatches(u"...a test message\n", doctest.ELLIPSIS))
95
class TestUnicodeFilename(tests.TestCase):
97
def test_probe_passes(self):
98
"""UnicodeFilename._probe passes."""
99
# We can't test much more than that because the behaviour depends
101
tests.UnicodeFilename._probe()
104
class TestTreeShape(tests.TestCaseInTempDir):
106
def test_unicode_paths(self):
107
self.requireFeature(tests.UnicodeFilename)
109
filename = u'hell\u00d8'
110
self.build_tree_contents([(filename, 'contents of hello')])
111
self.assertPathExists(filename)
114
class TestClassesAvailable(tests.TestCase):
115
"""As a convenience we expose Test* classes from bzrlib.tests"""
117
def test_test_case(self):
118
from bzrlib.tests import TestCase
120
def test_test_loader(self):
121
from bzrlib.tests import TestLoader
123
def test_test_suite(self):
124
from bzrlib.tests import TestSuite
127
class TestTransportScenarios(tests.TestCase):
128
"""A group of tests that test the transport implementation adaption core.
130
This is a meta test that the tests are applied to all available
133
This will be generalised in the future which is why it is in this
134
test file even though it is specific to transport tests at the moment.
137
def test_get_transport_permutations(self):
138
# this checks that get_test_permutations defined by the module is
139
# called by the get_transport_test_permutations function.
140
class MockModule(object):
141
def get_test_permutations(self):
142
return sample_permutation
143
sample_permutation = [(1,2), (3,4)]
144
from bzrlib.tests.per_transport import get_transport_test_permutations
145
self.assertEqual(sample_permutation,
146
get_transport_test_permutations(MockModule()))
148
def test_scenarios_include_all_modules(self):
149
# this checks that the scenario generator returns as many permutations
150
# as there are in all the registered transport modules - we assume if
151
# this matches its probably doing the right thing especially in
152
# combination with the tests for setting the right classes below.
153
from bzrlib.tests.per_transport import transport_test_permutations
154
from bzrlib.transport import _get_transport_modules
155
modules = _get_transport_modules()
156
permutation_count = 0
157
for module in modules:
159
permutation_count += len(reduce(getattr,
160
(module + ".get_test_permutations").split('.')[1:],
161
__import__(module))())
162
except errors.DependencyNotPresent:
164
scenarios = transport_test_permutations()
165
self.assertEqual(permutation_count, len(scenarios))
167
def test_scenarios_include_transport_class(self):
168
# This test used to know about all the possible transports and the
169
# order they were returned but that seems overly brittle (mbp
171
from bzrlib.tests.per_transport import transport_test_permutations
172
scenarios = transport_test_permutations()
173
# there are at least that many builtin transports
174
self.assertTrue(len(scenarios) > 6)
175
one_scenario = scenarios[0]
176
self.assertIsInstance(one_scenario[0], str)
177
self.assertTrue(issubclass(one_scenario[1]["transport_class"],
178
bzrlib.transport.Transport))
179
self.assertTrue(issubclass(one_scenario[1]["transport_server"],
180
bzrlib.transport.Server))
183
class TestBranchScenarios(tests.TestCase):
185
def test_scenarios(self):
186
# check that constructor parameters are passed through to the adapted
188
from bzrlib.tests.per_branch import make_scenarios
191
formats = [("c", "C"), ("d", "D")]
192
scenarios = make_scenarios(server1, server2, formats)
193
self.assertEqual(2, len(scenarios))
196
{'branch_format': 'c',
197
'bzrdir_format': 'C',
198
'transport_readonly_server': 'b',
199
'transport_server': 'a'}),
201
{'branch_format': 'd',
202
'bzrdir_format': 'D',
203
'transport_readonly_server': 'b',
204
'transport_server': 'a'})],
208
class TestBzrDirScenarios(tests.TestCase):
210
def test_scenarios(self):
211
# check that constructor parameters are passed through to the adapted
213
from bzrlib.tests.per_controldir import make_scenarios
218
scenarios = make_scenarios(vfs_factory, server1, server2, formats)
221
{'bzrdir_format': 'c',
222
'transport_readonly_server': 'b',
223
'transport_server': 'a',
224
'vfs_transport_factory': 'v'}),
226
{'bzrdir_format': 'd',
227
'transport_readonly_server': 'b',
228
'transport_server': 'a',
229
'vfs_transport_factory': 'v'})],
233
class TestRepositoryScenarios(tests.TestCase):
235
def test_formats_to_scenarios(self):
236
from bzrlib.tests.per_repository import formats_to_scenarios
237
formats = [("(c)", remote.RemoteRepositoryFormat()),
238
("(d)", repository.format_registry.get(
239
'Bazaar repository format 2a (needs bzr 1.16 or later)\n'))]
240
no_vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
242
vfs_scenarios = formats_to_scenarios(formats, "server", "readonly",
243
vfs_transport_factory="vfs")
244
# no_vfs generate scenarios without vfs_transport_factory
246
('RemoteRepositoryFormat(c)',
247
{'bzrdir_format': remote.RemoteBzrDirFormat(),
248
'repository_format': remote.RemoteRepositoryFormat(),
249
'transport_readonly_server': 'readonly',
250
'transport_server': 'server'}),
251
('RepositoryFormat2a(d)',
252
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
253
'repository_format': groupcompress_repo.RepositoryFormat2a(),
254
'transport_readonly_server': 'readonly',
255
'transport_server': 'server'})]
256
self.assertEqual(expected, no_vfs_scenarios)
258
('RemoteRepositoryFormat(c)',
259
{'bzrdir_format': remote.RemoteBzrDirFormat(),
260
'repository_format': remote.RemoteRepositoryFormat(),
261
'transport_readonly_server': 'readonly',
262
'transport_server': 'server',
263
'vfs_transport_factory': 'vfs'}),
264
('RepositoryFormat2a(d)',
265
{'bzrdir_format': bzrdir.BzrDirMetaFormat1(),
266
'repository_format': groupcompress_repo.RepositoryFormat2a(),
267
'transport_readonly_server': 'readonly',
268
'transport_server': 'server',
269
'vfs_transport_factory': 'vfs'})],
273
class TestTestScenarioApplication(tests.TestCase):
274
"""Tests for the test adaption facilities."""
276
def test_apply_scenario(self):
277
from bzrlib.tests import apply_scenario
278
input_test = TestTestScenarioApplication("test_apply_scenario")
279
# setup two adapted tests
280
adapted_test1 = apply_scenario(input_test,
282
{"bzrdir_format":"bzr_format",
283
"repository_format":"repo_fmt",
284
"transport_server":"transport_server",
285
"transport_readonly_server":"readonly-server"}))
286
adapted_test2 = apply_scenario(input_test,
287
("new id 2", {"bzrdir_format":None}))
288
# input_test should have been altered.
289
self.assertRaises(AttributeError, getattr, input_test, "bzrdir_format")
290
# the new tests are mutually incompatible, ensuring it has
291
# made new ones, and unspecified elements in the scenario
292
# should not have been altered.
293
self.assertEqual("bzr_format", adapted_test1.bzrdir_format)
294
self.assertEqual("repo_fmt", adapted_test1.repository_format)
295
self.assertEqual("transport_server", adapted_test1.transport_server)
296
self.assertEqual("readonly-server",
297
adapted_test1.transport_readonly_server)
299
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
300
"test_apply_scenario(new id)",
302
self.assertEqual(None, adapted_test2.bzrdir_format)
304
"bzrlib.tests.test_selftest.TestTestScenarioApplication."
305
"test_apply_scenario(new id 2)",
309
class TestInterRepositoryScenarios(tests.TestCase):
311
def test_scenarios(self):
312
# check that constructor parameters are passed through to the adapted
314
from bzrlib.tests.per_interrepository import make_scenarios
317
formats = [("C0", "C1", "C2", "C3"), ("D0", "D1", "D2", "D3")]
318
scenarios = make_scenarios(server1, server2, formats)
321
{'repository_format': 'C1',
322
'repository_format_to': 'C2',
323
'transport_readonly_server': 'b',
324
'transport_server': 'a',
325
'extra_setup': 'C3'}),
327
{'repository_format': 'D1',
328
'repository_format_to': 'D2',
329
'transport_readonly_server': 'b',
330
'transport_server': 'a',
331
'extra_setup': 'D3'})],
335
class TestWorkingTreeScenarios(tests.TestCase):
337
def test_scenarios(self):
338
# check that constructor parameters are passed through to the adapted
340
from bzrlib.tests.per_workingtree import make_scenarios
343
formats = [workingtree_4.WorkingTreeFormat4(),
344
workingtree_3.WorkingTreeFormat3(),]
345
scenarios = make_scenarios(server1, server2, formats)
347
('WorkingTreeFormat4',
348
{'bzrdir_format': formats[0]._matchingbzrdir,
349
'transport_readonly_server': 'b',
350
'transport_server': 'a',
351
'workingtree_format': formats[0]}),
352
('WorkingTreeFormat3',
353
{'bzrdir_format': formats[1]._matchingbzrdir,
354
'transport_readonly_server': 'b',
355
'transport_server': 'a',
356
'workingtree_format': formats[1]})],
360
class TestTreeScenarios(tests.TestCase):
362
def test_scenarios(self):
363
# the tree implementation scenario generator is meant to setup one
364
# instance for each working tree format, and one additional instance
365
# that will use the default wt format, but create a revision tree for
366
# the tests. this means that the wt ones should have the
367
# workingtree_to_test_tree attribute set to 'return_parameter' and the
368
# revision one set to revision_tree_from_workingtree.
370
from bzrlib.tests.per_tree import (
371
_dirstate_tree_from_workingtree,
376
revision_tree_from_workingtree
380
formats = [workingtree_4.WorkingTreeFormat4(),
381
workingtree_3.WorkingTreeFormat3(),]
382
scenarios = make_scenarios(server1, server2, formats)
383
self.assertEqual(7, len(scenarios))
384
default_wt_format = workingtree.format_registry.get_default()
385
wt4_format = workingtree_4.WorkingTreeFormat4()
386
wt5_format = workingtree_4.WorkingTreeFormat5()
387
expected_scenarios = [
388
('WorkingTreeFormat4',
389
{'bzrdir_format': formats[0]._matchingbzrdir,
390
'transport_readonly_server': 'b',
391
'transport_server': 'a',
392
'workingtree_format': formats[0],
393
'_workingtree_to_test_tree': return_parameter,
395
('WorkingTreeFormat3',
396
{'bzrdir_format': formats[1]._matchingbzrdir,
397
'transport_readonly_server': 'b',
398
'transport_server': 'a',
399
'workingtree_format': formats[1],
400
'_workingtree_to_test_tree': return_parameter,
403
{'_workingtree_to_test_tree': revision_tree_from_workingtree,
404
'bzrdir_format': default_wt_format._matchingbzrdir,
405
'transport_readonly_server': 'b',
406
'transport_server': 'a',
407
'workingtree_format': default_wt_format,
409
('DirStateRevisionTree,WT4',
410
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
411
'bzrdir_format': wt4_format._matchingbzrdir,
412
'transport_readonly_server': 'b',
413
'transport_server': 'a',
414
'workingtree_format': wt4_format,
416
('DirStateRevisionTree,WT5',
417
{'_workingtree_to_test_tree': _dirstate_tree_from_workingtree,
418
'bzrdir_format': wt5_format._matchingbzrdir,
419
'transport_readonly_server': 'b',
420
'transport_server': 'a',
421
'workingtree_format': wt5_format,
424
{'_workingtree_to_test_tree': preview_tree_pre,
425
'bzrdir_format': default_wt_format._matchingbzrdir,
426
'transport_readonly_server': 'b',
427
'transport_server': 'a',
428
'workingtree_format': default_wt_format}),
430
{'_workingtree_to_test_tree': preview_tree_post,
431
'bzrdir_format': default_wt_format._matchingbzrdir,
432
'transport_readonly_server': 'b',
433
'transport_server': 'a',
434
'workingtree_format': default_wt_format}),
436
self.assertEqual(expected_scenarios, scenarios)
439
class TestInterTreeScenarios(tests.TestCase):
440
"""A group of tests that test the InterTreeTestAdapter."""
442
def test_scenarios(self):
443
# check that constructor parameters are passed through to the adapted
445
# for InterTree tests we want the machinery to bring up two trees in
446
# each instance: the base one, and the one we are interacting with.
447
# because each optimiser can be direction specific, we need to test
448
# each optimiser in its chosen direction.
449
# unlike the TestProviderAdapter we dont want to automatically add a
450
# parameterized one for WorkingTree - the optimisers will tell us what
452
from bzrlib.tests.per_tree import (
455
from bzrlib.tests.per_intertree import (
458
from bzrlib.workingtree_3 import WorkingTreeFormat3
459
from bzrlib.workingtree_4 import WorkingTreeFormat4
460
input_test = TestInterTreeScenarios(
464
format1 = WorkingTreeFormat4()
465
format2 = WorkingTreeFormat3()
466
formats = [("1", str, format1, format2, "converter1"),
467
("2", int, format2, format1, "converter2")]
468
scenarios = make_scenarios(server1, server2, formats)
469
self.assertEqual(2, len(scenarios))
470
expected_scenarios = [
472
"bzrdir_format": format1._matchingbzrdir,
473
"intertree_class": formats[0][1],
474
"workingtree_format": formats[0][2],
475
"workingtree_format_to": formats[0][3],
476
"mutable_trees_to_test_trees": formats[0][4],
477
"_workingtree_to_test_tree": return_parameter,
478
"transport_server": server1,
479
"transport_readonly_server": server2,
482
"bzrdir_format": format2._matchingbzrdir,
483
"intertree_class": formats[1][1],
484
"workingtree_format": formats[1][2],
485
"workingtree_format_to": formats[1][3],
486
"mutable_trees_to_test_trees": formats[1][4],
487
"_workingtree_to_test_tree": return_parameter,
488
"transport_server": server1,
489
"transport_readonly_server": server2,
492
self.assertEqual(scenarios, expected_scenarios)
495
class TestTestCaseInTempDir(tests.TestCaseInTempDir):
497
def test_home_is_not_working(self):
498
self.assertNotEqual(self.test_dir, self.test_home_dir)
499
cwd = osutils.getcwd()
500
self.assertIsSameRealPath(self.test_dir, cwd)
501
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
503
def test_assertEqualStat_equal(self):
504
from bzrlib.tests.test_dirstate import _FakeStat
505
self.build_tree(["foo"])
506
real = os.lstat("foo")
507
fake = _FakeStat(real.st_size, real.st_mtime, real.st_ctime,
508
real.st_dev, real.st_ino, real.st_mode)
509
self.assertEqualStat(real, fake)
511
def test_assertEqualStat_notequal(self):
512
self.build_tree(["foo", "longname"])
513
self.assertRaises(AssertionError, self.assertEqualStat,
514
os.lstat("foo"), os.lstat("longname"))
516
def test_failUnlessExists(self):
517
"""Deprecated failUnlessExists and failIfExists"""
518
self.applyDeprecated(
519
deprecated_in((2, 4)),
520
self.failUnlessExists, '.')
521
self.build_tree(['foo/', 'foo/bar'])
522
self.applyDeprecated(
523
deprecated_in((2, 4)),
524
self.failUnlessExists, 'foo/bar')
525
self.applyDeprecated(
526
deprecated_in((2, 4)),
527
self.failIfExists, 'foo/foo')
529
def test_assertPathExists(self):
530
self.assertPathExists('.')
531
self.build_tree(['foo/', 'foo/bar'])
532
self.assertPathExists('foo/bar')
533
self.assertPathDoesNotExist('foo/foo')
536
class TestTestCaseWithMemoryTransport(tests.TestCaseWithMemoryTransport):
538
def test_home_is_non_existant_dir_under_root(self):
539
"""The test_home_dir for TestCaseWithMemoryTransport is missing.
541
This is because TestCaseWithMemoryTransport is for tests that do not
542
need any disk resources: they should be hooked into bzrlib in such a
543
way that no global settings are being changed by the test (only a
544
few tests should need to do that), and having a missing dir as home is
545
an effective way to ensure that this is the case.
547
self.assertIsSameRealPath(
548
self.TEST_ROOT + "/MemoryTransportMissingHomeDir",
550
self.assertIsSameRealPath(self.test_home_dir, os.environ['HOME'])
552
def test_cwd_is_TEST_ROOT(self):
553
self.assertIsSameRealPath(self.test_dir, self.TEST_ROOT)
554
cwd = osutils.getcwd()
555
self.assertIsSameRealPath(self.test_dir, cwd)
557
def test_BZR_HOME_and_HOME_are_bytestrings(self):
558
"""The $BZR_HOME and $HOME environment variables should not be unicode.
560
See https://bugs.launchpad.net/bzr/+bug/464174
562
self.assertIsInstance(os.environ['BZR_HOME'], str)
563
self.assertIsInstance(os.environ['HOME'], str)
565
def test_make_branch_and_memory_tree(self):
566
"""In TestCaseWithMemoryTransport we should not make the branch on disk.
568
This is hard to comprehensively robustly test, so we settle for making
569
a branch and checking no directory was created at its relpath.
571
tree = self.make_branch_and_memory_tree('dir')
572
# Guard against regression into MemoryTransport leaking
573
# files to disk instead of keeping them in memory.
574
self.assertFalse(osutils.lexists('dir'))
575
self.assertIsInstance(tree, memorytree.MemoryTree)
577
def test_make_branch_and_memory_tree_with_format(self):
578
"""make_branch_and_memory_tree should accept a format option."""
579
format = bzrdir.BzrDirMetaFormat1()
580
format.repository_format = repository.format_registry.get_default()
581
tree = self.make_branch_and_memory_tree('dir', format=format)
582
# Guard against regression into MemoryTransport leaking
583
# files to disk instead of keeping them in memory.
584
self.assertFalse(osutils.lexists('dir'))
585
self.assertIsInstance(tree, memorytree.MemoryTree)
586
self.assertEqual(format.repository_format.__class__,
587
tree.branch.repository._format.__class__)
589
def test_make_branch_builder(self):
590
builder = self.make_branch_builder('dir')
591
self.assertIsInstance(builder, branchbuilder.BranchBuilder)
592
# Guard against regression into MemoryTransport leaking
593
# files to disk instead of keeping them in memory.
594
self.assertFalse(osutils.lexists('dir'))
596
def test_make_branch_builder_with_format(self):
597
# Use a repo layout that doesn't conform to a 'named' layout, to ensure
598
# that the format objects are used.
599
format = bzrdir.BzrDirMetaFormat1()
600
repo_format = repository.format_registry.get_default()
601
format.repository_format = repo_format
602
builder = self.make_branch_builder('dir', format=format)
603
the_branch = builder.get_branch()
604
# Guard against regression into MemoryTransport leaking
605
# files to disk instead of keeping them in memory.
606
self.assertFalse(osutils.lexists('dir'))
607
self.assertEqual(format.repository_format.__class__,
608
the_branch.repository._format.__class__)
609
self.assertEqual(repo_format.get_format_string(),
610
self.get_transport().get_bytes(
611
'dir/.bzr/repository/format'))
613
def test_make_branch_builder_with_format_name(self):
614
builder = self.make_branch_builder('dir', format='knit')
615
the_branch = builder.get_branch()
616
# Guard against regression into MemoryTransport leaking
617
# files to disk instead of keeping them in memory.
618
self.assertFalse(osutils.lexists('dir'))
619
dir_format = bzrdir.format_registry.make_bzrdir('knit')
620
self.assertEqual(dir_format.repository_format.__class__,
621
the_branch.repository._format.__class__)
622
self.assertEqual('Bazaar-NG Knit Repository Format 1',
623
self.get_transport().get_bytes(
624
'dir/.bzr/repository/format'))
626
def test_dangling_locks_cause_failures(self):
627
class TestDanglingLock(tests.TestCaseWithMemoryTransport):
628
def test_function(self):
629
t = self.get_transport('.')
630
l = lockdir.LockDir(t, 'lock')
633
test = TestDanglingLock('test_function')
635
total_failures = result.errors + result.failures
636
if self._lock_check_thorough:
637
self.assertEqual(1, len(total_failures))
639
# When _lock_check_thorough is disabled, then we don't trigger a
641
self.assertEqual(0, len(total_failures))
644
class TestTestCaseWithTransport(tests.TestCaseWithTransport):
645
"""Tests for the convenience functions TestCaseWithTransport introduces."""
647
def test_get_readonly_url_none(self):
648
from bzrlib.transport.readonly import ReadonlyTransportDecorator
649
self.vfs_transport_factory = memory.MemoryServer
650
self.transport_readonly_server = None
651
# calling get_readonly_transport() constructs a decorator on the url
653
url = self.get_readonly_url()
654
url2 = self.get_readonly_url('foo/bar')
655
t = transport.get_transport(url)
656
t2 = transport.get_transport(url2)
657
self.assertIsInstance(t, ReadonlyTransportDecorator)
658
self.assertIsInstance(t2, ReadonlyTransportDecorator)
659
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
661
def test_get_readonly_url_http(self):
662
from bzrlib.tests.http_server import HttpServer
663
from bzrlib.transport.http import HttpTransportBase
664
self.transport_server = test_server.LocalURLServer
665
self.transport_readonly_server = HttpServer
666
# calling get_readonly_transport() gives us a HTTP server instance.
667
url = self.get_readonly_url()
668
url2 = self.get_readonly_url('foo/bar')
669
# the transport returned may be any HttpTransportBase subclass
670
t = transport.get_transport(url)
671
t2 = transport.get_transport(url2)
672
self.assertIsInstance(t, HttpTransportBase)
673
self.assertIsInstance(t2, HttpTransportBase)
674
self.assertEqual(t2.base[:-1], t.abspath('foo/bar'))
676
def test_is_directory(self):
677
"""Test assertIsDirectory assertion"""
678
t = self.get_transport()
679
self.build_tree(['a_dir/', 'a_file'], transport=t)
680
self.assertIsDirectory('a_dir', t)
681
self.assertRaises(AssertionError, self.assertIsDirectory, 'a_file', t)
682
self.assertRaises(AssertionError, self.assertIsDirectory, 'not_here', t)
684
def test_make_branch_builder(self):
685
builder = self.make_branch_builder('dir')
686
rev_id = builder.build_commit()
687
self.assertPathExists('dir')
688
a_dir = bzrdir.BzrDir.open('dir')
689
self.assertRaises(errors.NoWorkingTree, a_dir.open_workingtree)
690
a_branch = a_dir.open_branch()
691
builder_branch = builder.get_branch()
692
self.assertEqual(a_branch.base, builder_branch.base)
693
self.assertEqual((1, rev_id), builder_branch.last_revision_info())
694
self.assertEqual((1, rev_id), a_branch.last_revision_info())
697
class TestTestCaseTransports(tests.TestCaseWithTransport):
700
super(TestTestCaseTransports, self).setUp()
701
self.vfs_transport_factory = memory.MemoryServer
703
def test_make_bzrdir_preserves_transport(self):
704
t = self.get_transport()
705
result_bzrdir = self.make_bzrdir('subdir')
706
self.assertIsInstance(result_bzrdir.transport,
707
memory.MemoryTransport)
708
# should not be on disk, should only be in memory
709
self.assertPathDoesNotExist('subdir')
712
class TestChrootedTest(tests.ChrootedTestCase):
714
def test_root_is_root(self):
715
t = transport.get_transport(self.get_readonly_url())
717
self.assertEqual(url, t.clone('..').base)
720
class TestProfileResult(tests.TestCase):
722
def test_profiles_tests(self):
723
self.requireFeature(test_lsprof.LSProfFeature)
724
terminal = testtools.tests.helpers.ExtendedTestResult()
725
result = tests.ProfileResult(terminal)
726
class Sample(tests.TestCase):
728
self.sample_function()
729
def sample_function(self):
733
case = terminal._events[0][1]
734
self.assertLength(1, case._benchcalls)
735
# We must be able to unpack it as the test reporting code wants
736
(_, _, _), stats = case._benchcalls[0]
737
self.assertTrue(callable(stats.pprint))
740
class TestTestResult(tests.TestCase):
742
def check_timing(self, test_case, expected_re):
743
result = bzrlib.tests.TextTestResult(self._log_file,
747
capture = testtools.tests.helpers.ExtendedTestResult()
748
test_case.run(MultiTestResult(result, capture))
749
run_case = capture._events[0][1]
750
timed_string = result._testTimeString(run_case)
751
self.assertContainsRe(timed_string, expected_re)
753
def test_test_reporting(self):
754
class ShortDelayTestCase(tests.TestCase):
755
def test_short_delay(self):
757
def test_short_benchmark(self):
758
self.time(time.sleep, 0.003)
759
self.check_timing(ShortDelayTestCase('test_short_delay'),
761
# if a benchmark time is given, we now show just that time followed by
763
self.check_timing(ShortDelayTestCase('test_short_benchmark'),
766
def test_unittest_reporting_unittest_class(self):
767
# getting the time from a non-bzrlib test works ok
768
class ShortDelayTestCase(unittest.TestCase):
769
def test_short_delay(self):
771
self.check_timing(ShortDelayTestCase('test_short_delay'),
774
def _time_hello_world_encoding(self):
775
"""Profile two sleep calls
777
This is used to exercise the test framework.
779
self.time(unicode, 'hello', errors='replace')
780
self.time(unicode, 'world', errors='replace')
782
def test_lsprofiling(self):
783
"""Verbose test result prints lsprof statistics from test cases."""
784
self.requireFeature(test_lsprof.LSProfFeature)
785
result_stream = StringIO()
786
result = bzrlib.tests.VerboseTestResult(
791
# we want profile a call of some sort and check it is output by
792
# addSuccess. We dont care about addError or addFailure as they
793
# are not that interesting for performance tuning.
794
# make a new test instance that when run will generate a profile
795
example_test_case = TestTestResult("_time_hello_world_encoding")
796
example_test_case._gather_lsprof_in_benchmarks = True
797
# execute the test, which should succeed and record profiles
798
example_test_case.run(result)
799
# lsprofile_something()
800
# if this worked we want
801
# LSProf output for <built in function unicode> (['hello'], {'errors': 'replace'})
802
# CallCount Recursive Total(ms) Inline(ms) module:lineno(function)
803
# (the lsprof header)
804
# ... an arbitrary number of lines
805
# and the function call which is time.sleep.
806
# 1 0 ??? ??? ???(sleep)
807
# and then repeated but with 'world', rather than 'hello'.
808
# this should appear in the output stream of our test result.
809
output = result_stream.getvalue()
810
self.assertContainsRe(output,
811
r"LSProf output for <type 'unicode'>\(\('hello',\), {'errors': 'replace'}\)")
812
self.assertContainsRe(output,
813
r" *CallCount *Recursive *Total\(ms\) *Inline\(ms\) *module:lineno\(function\)\n")
814
self.assertContainsRe(output,
815
r"( +1 +0 +0\.\d+ +0\.\d+ +<method 'disable' of '_lsprof\.Profiler' objects>\n)?")
816
self.assertContainsRe(output,
817
r"LSProf output for <type 'unicode'>\(\('world',\), {'errors': 'replace'}\)\n")
819
def test_uses_time_from_testtools(self):
820
"""Test case timings in verbose results should use testtools times"""
822
class TimeAddedVerboseTestResult(tests.VerboseTestResult):
823
def startTest(self, test):
824
self.time(datetime.datetime.utcfromtimestamp(1.145))
825
super(TimeAddedVerboseTestResult, self).startTest(test)
826
def addSuccess(self, test):
827
self.time(datetime.datetime.utcfromtimestamp(51.147))
828
super(TimeAddedVerboseTestResult, self).addSuccess(test)
829
def report_tests_starting(self): pass
831
self.get_passing_test().run(TimeAddedVerboseTestResult(sio, 0, 2))
832
self.assertEndsWith(sio.getvalue(), "OK 50002ms\n")
834
def test_known_failure(self):
835
"""A KnownFailure being raised should trigger several result actions."""
836
class InstrumentedTestResult(tests.ExtendedTestResult):
837
def stopTestRun(self): pass
838
def report_tests_starting(self): pass
839
def report_known_failure(self, test, err=None, details=None):
840
self._call = test, 'known failure'
841
result = InstrumentedTestResult(None, None, None, None)
842
class Test(tests.TestCase):
843
def test_function(self):
844
raise tests.KnownFailure('failed!')
845
test = Test("test_function")
847
# it should invoke 'report_known_failure'.
848
self.assertEqual(2, len(result._call))
849
self.assertEqual(test.id(), result._call[0].id())
850
self.assertEqual('known failure', result._call[1])
851
# we dont introspec the traceback, if the rest is ok, it would be
852
# exceptional for it not to be.
853
# it should update the known_failure_count on the object.
854
self.assertEqual(1, result.known_failure_count)
855
# the result should be successful.
856
self.assertTrue(result.wasSuccessful())
858
def test_verbose_report_known_failure(self):
859
# verbose test output formatting
860
result_stream = StringIO()
861
result = bzrlib.tests.VerboseTestResult(
866
test = self.get_passing_test()
867
result.startTest(test)
868
prefix = len(result_stream.getvalue())
869
# the err parameter has the shape:
870
# (class, exception object, traceback)
871
# KnownFailures dont get their tracebacks shown though, so we
873
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
874
result.report_known_failure(test, err)
875
output = result_stream.getvalue()[prefix:]
876
lines = output.splitlines()
877
self.assertContainsRe(lines[0], r'XFAIL *\d+ms$')
878
if sys.version_info > (2, 7):
879
self.expectFailure("_ExpectedFailure on 2.7 loses the message",
880
self.assertNotEqual, lines[1], ' ')
881
self.assertEqual(lines[1], ' foo')
882
self.assertEqual(2, len(lines))
884
def get_passing_test(self):
885
"""Return a test object that can't be run usefully."""
888
return unittest.FunctionTestCase(passing_test)
890
def test_add_not_supported(self):
891
"""Test the behaviour of invoking addNotSupported."""
892
class InstrumentedTestResult(tests.ExtendedTestResult):
893
def stopTestRun(self): pass
894
def report_tests_starting(self): pass
895
def report_unsupported(self, test, feature):
896
self._call = test, feature
897
result = InstrumentedTestResult(None, None, None, None)
898
test = SampleTestCase('_test_pass')
899
feature = tests.Feature()
900
result.startTest(test)
901
result.addNotSupported(test, feature)
902
# it should invoke 'report_unsupported'.
903
self.assertEqual(2, len(result._call))
904
self.assertEqual(test, result._call[0])
905
self.assertEqual(feature, result._call[1])
906
# the result should be successful.
907
self.assertTrue(result.wasSuccessful())
908
# it should record the test against a count of tests not run due to
910
self.assertEqual(1, result.unsupported['Feature'])
911
# and invoking it again should increment that counter
912
result.addNotSupported(test, feature)
913
self.assertEqual(2, result.unsupported['Feature'])
915
def test_verbose_report_unsupported(self):
916
# verbose test output formatting
917
result_stream = StringIO()
918
result = bzrlib.tests.VerboseTestResult(
923
test = self.get_passing_test()
924
feature = tests.Feature()
925
result.startTest(test)
926
prefix = len(result_stream.getvalue())
927
result.report_unsupported(test, feature)
928
output = result_stream.getvalue()[prefix:]
929
lines = output.splitlines()
930
# We don't check for the final '0ms' since it may fail on slow hosts
931
self.assertStartsWith(lines[0], 'NODEP')
932
self.assertEqual(lines[1],
933
" The feature 'Feature' is not available.")
935
def test_unavailable_exception(self):
936
"""An UnavailableFeature being raised should invoke addNotSupported."""
937
class InstrumentedTestResult(tests.ExtendedTestResult):
938
def stopTestRun(self): pass
939
def report_tests_starting(self): pass
940
def addNotSupported(self, test, feature):
941
self._call = test, feature
942
result = InstrumentedTestResult(None, None, None, None)
943
feature = tests.Feature()
944
class Test(tests.TestCase):
945
def test_function(self):
946
raise tests.UnavailableFeature(feature)
947
test = Test("test_function")
949
# it should invoke 'addNotSupported'.
950
self.assertEqual(2, len(result._call))
951
self.assertEqual(test.id(), result._call[0].id())
952
self.assertEqual(feature, result._call[1])
953
# and not count as an error
954
self.assertEqual(0, result.error_count)
956
def test_strict_with_unsupported_feature(self):
957
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
959
test = self.get_passing_test()
960
feature = "Unsupported Feature"
961
result.addNotSupported(test, feature)
962
self.assertFalse(result.wasStrictlySuccessful())
963
self.assertEqual(None, result._extractBenchmarkTime(test))
965
def test_strict_with_known_failure(self):
966
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
968
test = self.get_passing_test()
969
err = (tests.KnownFailure, tests.KnownFailure('foo'), None)
970
result.addExpectedFailure(test, err)
971
self.assertFalse(result.wasStrictlySuccessful())
972
self.assertEqual(None, result._extractBenchmarkTime(test))
974
def test_strict_with_success(self):
975
result = bzrlib.tests.TextTestResult(self._log_file, descriptions=0,
977
test = self.get_passing_test()
978
result.addSuccess(test)
979
self.assertTrue(result.wasStrictlySuccessful())
980
self.assertEqual(None, result._extractBenchmarkTime(test))
982
def test_startTests(self):
983
"""Starting the first test should trigger startTests."""
984
class InstrumentedTestResult(tests.ExtendedTestResult):
986
def startTests(self): self.calls += 1
987
result = InstrumentedTestResult(None, None, None, None)
990
test = unittest.FunctionTestCase(test_function)
992
self.assertEquals(1, result.calls)
994
def test_startTests_only_once(self):
995
"""With multiple tests startTests should still only be called once"""
996
class InstrumentedTestResult(tests.ExtendedTestResult):
998
def startTests(self): self.calls += 1
999
result = InstrumentedTestResult(None, None, None, None)
1000
suite = unittest.TestSuite([
1001
unittest.FunctionTestCase(lambda: None),
1002
unittest.FunctionTestCase(lambda: None)])
1004
self.assertEquals(1, result.calls)
1005
self.assertEquals(2, result.count)
1008
class TestUnicodeFilenameFeature(tests.TestCase):
1010
def test_probe_passes(self):
1011
"""UnicodeFilenameFeature._probe passes."""
1012
# We can't test much more than that because the behaviour depends
1014
tests.UnicodeFilenameFeature._probe()
1017
class TestRunner(tests.TestCase):
1019
def dummy_test(self):
1022
def run_test_runner(self, testrunner, test):
1023
"""Run suite in testrunner, saving global state and restoring it.
1025
This current saves and restores:
1026
TestCaseInTempDir.TEST_ROOT
1028
There should be no tests in this file that use
1029
bzrlib.tests.TextTestRunner without using this convenience method,
1030
because of our use of global state.
1032
old_root = tests.TestCaseInTempDir.TEST_ROOT
1034
tests.TestCaseInTempDir.TEST_ROOT = None
1035
return testrunner.run(test)
1037
tests.TestCaseInTempDir.TEST_ROOT = old_root
1039
def test_known_failure_failed_run(self):
1040
# run a test that generates a known failure which should be printed in
1041
# the final output when real failures occur.
1042
class Test(tests.TestCase):
1043
def known_failure_test(self):
1044
self.expectFailure('failed', self.assertTrue, False)
1045
test = unittest.TestSuite()
1046
test.addTest(Test("known_failure_test"))
1049
test.addTest(unittest.FunctionTestCase(failing_test))
1051
runner = tests.TextTestRunner(stream=stream)
1052
result = self.run_test_runner(runner, test)
1053
lines = stream.getvalue().splitlines()
1054
self.assertContainsRe(stream.getvalue(),
1055
'(?sm)^bzr selftest.*$'
1057
'^======================================================================\n'
1058
'^FAIL: failing_test\n'
1059
'^----------------------------------------------------------------------\n'
1060
'Traceback \\(most recent call last\\):\n'
1061
' .*' # File .*, line .*, in failing_test' - but maybe not from .pyc
1062
' self.fail\\(\'foo\'\\)\n'
1064
'^----------------------------------------------------------------------\n'
1066
'FAILED \\(failures=1, known_failure_count=1\\)'
1069
def test_known_failure_ok_run(self):
1070
# run a test that generates a known failure which should be printed in
1072
class Test(tests.TestCase):
1073
def known_failure_test(self):
1074
self.expectFailure('failed', self.assertTrue, False)
1075
test = Test("known_failure_test")
1077
runner = tests.TextTestRunner(stream=stream)
1078
result = self.run_test_runner(runner, test)
1079
self.assertContainsRe(stream.getvalue(),
1082
'Ran 1 test in .*\n'
1084
'OK \\(known_failures=1\\)\n')
1086
def test_result_decorator(self):
1089
class LoggingDecorator(ExtendedToOriginalDecorator):
1090
def startTest(self, test):
1091
ExtendedToOriginalDecorator.startTest(self, test)
1092
calls.append('start')
1093
test = unittest.FunctionTestCase(lambda:None)
1095
runner = tests.TextTestRunner(stream=stream,
1096
result_decorators=[LoggingDecorator])
1097
result = self.run_test_runner(runner, test)
1098
self.assertLength(1, calls)
1100
def test_skipped_test(self):
1101
# run a test that is skipped, and check the suite as a whole still
1103
# skipping_test must be hidden in here so it's not run as a real test
1104
class SkippingTest(tests.TestCase):
1105
def skipping_test(self):
1106
raise tests.TestSkipped('test intentionally skipped')
1107
runner = tests.TextTestRunner(stream=self._log_file)
1108
test = SkippingTest("skipping_test")
1109
result = self.run_test_runner(runner, test)
1110
self.assertTrue(result.wasSuccessful())
1112
def test_skipped_from_setup(self):
1114
class SkippedSetupTest(tests.TestCase):
1117
calls.append('setUp')
1118
self.addCleanup(self.cleanup)
1119
raise tests.TestSkipped('skipped setup')
1121
def test_skip(self):
1122
self.fail('test reached')
1125
calls.append('cleanup')
1127
runner = tests.TextTestRunner(stream=self._log_file)
1128
test = SkippedSetupTest('test_skip')
1129
result = self.run_test_runner(runner, test)
1130
self.assertTrue(result.wasSuccessful())
1131
# Check if cleanup was called the right number of times.
1132
self.assertEqual(['setUp', 'cleanup'], calls)
1134
def test_skipped_from_test(self):
1136
class SkippedTest(tests.TestCase):
1139
tests.TestCase.setUp(self)
1140
calls.append('setUp')
1141
self.addCleanup(self.cleanup)
1143
def test_skip(self):
1144
raise tests.TestSkipped('skipped test')
1147
calls.append('cleanup')
1149
runner = tests.TextTestRunner(stream=self._log_file)
1150
test = SkippedTest('test_skip')
1151
result = self.run_test_runner(runner, test)
1152
self.assertTrue(result.wasSuccessful())
1153
# Check if cleanup was called the right number of times.
1154
self.assertEqual(['setUp', 'cleanup'], calls)
1156
def test_not_applicable(self):
1157
# run a test that is skipped because it's not applicable
1158
class Test(tests.TestCase):
1159
def not_applicable_test(self):
1160
raise tests.TestNotApplicable('this test never runs')
1162
runner = tests.TextTestRunner(stream=out, verbosity=2)
1163
test = Test("not_applicable_test")
1164
result = self.run_test_runner(runner, test)
1165
self._log_file.write(out.getvalue())
1166
self.assertTrue(result.wasSuccessful())
1167
self.assertTrue(result.wasStrictlySuccessful())
1168
self.assertContainsRe(out.getvalue(),
1169
r'(?m)not_applicable_test * N/A')
1170
self.assertContainsRe(out.getvalue(),
1171
r'(?m)^ this test never runs')
1173
def test_unsupported_features_listed(self):
1174
"""When unsupported features are encountered they are detailed."""
1175
class Feature1(tests.Feature):
1176
def _probe(self): return False
1177
class Feature2(tests.Feature):
1178
def _probe(self): return False
1179
# create sample tests
1180
test1 = SampleTestCase('_test_pass')
1181
test1._test_needs_features = [Feature1()]
1182
test2 = SampleTestCase('_test_pass')
1183
test2._test_needs_features = [Feature2()]
1184
test = unittest.TestSuite()
1188
runner = tests.TextTestRunner(stream=stream)
1189
result = self.run_test_runner(runner, test)
1190
lines = stream.getvalue().splitlines()
1193
"Missing feature 'Feature1' skipped 1 tests.",
1194
"Missing feature 'Feature2' skipped 1 tests.",
1198
def test_verbose_test_count(self):
1199
"""A verbose test run reports the right test count at the start"""
1200
suite = TestUtil.TestSuite([
1201
unittest.FunctionTestCase(lambda:None),
1202
unittest.FunctionTestCase(lambda:None)])
1203
self.assertEqual(suite.countTestCases(), 2)
1205
runner = tests.TextTestRunner(stream=stream, verbosity=2)
1206
# Need to use the CountingDecorator as that's what sets num_tests
1207
result = self.run_test_runner(runner, tests.CountingDecorator(suite))
1208
self.assertStartsWith(stream.getvalue(), "running 2 tests")
1210
def test_startTestRun(self):
1211
"""run should call result.startTestRun()"""
1213
class LoggingDecorator(ExtendedToOriginalDecorator):
1214
def startTestRun(self):
1215
ExtendedToOriginalDecorator.startTestRun(self)
1216
calls.append('startTestRun')
1217
test = unittest.FunctionTestCase(lambda:None)
1219
runner = tests.TextTestRunner(stream=stream,
1220
result_decorators=[LoggingDecorator])
1221
result = self.run_test_runner(runner, test)
1222
self.assertLength(1, calls)
1224
def test_stopTestRun(self):
1225
"""run should call result.stopTestRun()"""
1227
class LoggingDecorator(ExtendedToOriginalDecorator):
1228
def stopTestRun(self):
1229
ExtendedToOriginalDecorator.stopTestRun(self)
1230
calls.append('stopTestRun')
1231
test = unittest.FunctionTestCase(lambda:None)
1233
runner = tests.TextTestRunner(stream=stream,
1234
result_decorators=[LoggingDecorator])
1235
result = self.run_test_runner(runner, test)
1236
self.assertLength(1, calls)
1238
def test_unicode_test_output_on_ascii_stream(self):
1239
"""Showing results should always succeed even on an ascii console"""
1240
class FailureWithUnicode(tests.TestCase):
1241
def test_log_unicode(self):
1243
self.fail("Now print that log!")
1245
self.overrideAttr(osutils, "get_terminal_encoding",
1246
lambda trace=False: "ascii")
1247
result = self.run_test_runner(tests.TextTestRunner(stream=out),
1248
FailureWithUnicode("test_log_unicode"))
1249
self.assertContainsRe(out.getvalue(),
1250
"Text attachment: log\n"
1252
"\d+\.\d+ \\\\u2606\n"
1256
class SampleTestCase(tests.TestCase):
1258
def _test_pass(self):
1261
class _TestException(Exception):
1265
class TestTestCase(tests.TestCase):
1266
"""Tests that test the core bzrlib TestCase."""
1268
def test_assertLength_matches_empty(self):
1270
self.assertLength(0, a_list)
1272
def test_assertLength_matches_nonempty(self):
1274
self.assertLength(3, a_list)
1276
def test_assertLength_fails_different(self):
1278
self.assertRaises(AssertionError, self.assertLength, 1, a_list)
1280
def test_assertLength_shows_sequence_in_failure(self):
1282
exception = self.assertRaises(AssertionError, self.assertLength, 2,
1284
self.assertEqual('Incorrect length: wanted 2, got 3 for [1, 2, 3]',
1287
def test_base_setUp_not_called_causes_failure(self):
1288
class TestCaseWithBrokenSetUp(tests.TestCase):
1290
pass # does not call TestCase.setUp
1293
test = TestCaseWithBrokenSetUp('test_foo')
1294
result = unittest.TestResult()
1296
self.assertFalse(result.wasSuccessful())
1297
self.assertEqual(1, result.testsRun)
1299
def test_base_tearDown_not_called_causes_failure(self):
1300
class TestCaseWithBrokenTearDown(tests.TestCase):
1302
pass # does not call TestCase.tearDown
1305
test = TestCaseWithBrokenTearDown('test_foo')
1306
result = unittest.TestResult()
1308
self.assertFalse(result.wasSuccessful())
1309
self.assertEqual(1, result.testsRun)
1311
def test_debug_flags_sanitised(self):
1312
"""The bzrlib debug flags should be sanitised by setUp."""
1313
if 'allow_debug' in tests.selftest_debug_flags:
1314
raise tests.TestNotApplicable(
1315
'-Eallow_debug option prevents debug flag sanitisation')
1316
# we could set something and run a test that will check
1317
# it gets santised, but this is probably sufficient for now:
1318
# if someone runs the test with -Dsomething it will error.
1320
if self._lock_check_thorough:
1321
flags.add('strict_locks')
1322
self.assertEqual(flags, bzrlib.debug.debug_flags)
1324
def change_selftest_debug_flags(self, new_flags):
1325
self.overrideAttr(tests, 'selftest_debug_flags', set(new_flags))
1327
def test_allow_debug_flag(self):
1328
"""The -Eallow_debug flag prevents bzrlib.debug.debug_flags from being
1329
sanitised (i.e. cleared) before running a test.
1331
self.change_selftest_debug_flags(set(['allow_debug']))
1332
bzrlib.debug.debug_flags = set(['a-flag'])
1333
class TestThatRecordsFlags(tests.TestCase):
1334
def test_foo(nested_self):
1335
self.flags = set(bzrlib.debug.debug_flags)
1336
test = TestThatRecordsFlags('test_foo')
1337
test.run(self.make_test_result())
1338
flags = set(['a-flag'])
1339
if 'disable_lock_checks' not in tests.selftest_debug_flags:
1340
flags.add('strict_locks')
1341
self.assertEqual(flags, self.flags)
1343
def test_disable_lock_checks(self):
1344
"""The -Edisable_lock_checks flag disables thorough checks."""
1345
class TestThatRecordsFlags(tests.TestCase):
1346
def test_foo(nested_self):
1347
self.flags = set(bzrlib.debug.debug_flags)
1348
self.test_lock_check_thorough = nested_self._lock_check_thorough
1349
self.change_selftest_debug_flags(set())
1350
test = TestThatRecordsFlags('test_foo')
1351
test.run(self.make_test_result())
1352
# By default we do strict lock checking and thorough lock/unlock
1354
self.assertTrue(self.test_lock_check_thorough)
1355
self.assertEqual(set(['strict_locks']), self.flags)
1356
# Now set the disable_lock_checks flag, and show that this changed.
1357
self.change_selftest_debug_flags(set(['disable_lock_checks']))
1358
test = TestThatRecordsFlags('test_foo')
1359
test.run(self.make_test_result())
1360
self.assertFalse(self.test_lock_check_thorough)
1361
self.assertEqual(set(), self.flags)
1363
def test_this_fails_strict_lock_check(self):
1364
class TestThatRecordsFlags(tests.TestCase):
1365
def test_foo(nested_self):
1366
self.flags1 = set(bzrlib.debug.debug_flags)
1367
self.thisFailsStrictLockCheck()
1368
self.flags2 = set(bzrlib.debug.debug_flags)
1369
# Make sure lock checking is active
1370
self.change_selftest_debug_flags(set())
1371
test = TestThatRecordsFlags('test_foo')
1372
test.run(self.make_test_result())
1373
self.assertEqual(set(['strict_locks']), self.flags1)
1374
self.assertEqual(set(), self.flags2)
1376
def test_debug_flags_restored(self):
1377
"""The bzrlib debug flags should be restored to their original state
1378
after the test was run, even if allow_debug is set.
1380
self.change_selftest_debug_flags(set(['allow_debug']))
1381
# Now run a test that modifies debug.debug_flags.
1382
bzrlib.debug.debug_flags = set(['original-state'])
1383
class TestThatModifiesFlags(tests.TestCase):
1385
bzrlib.debug.debug_flags = set(['modified'])
1386
test = TestThatModifiesFlags('test_foo')
1387
test.run(self.make_test_result())
1388
self.assertEqual(set(['original-state']), bzrlib.debug.debug_flags)
1390
def make_test_result(self):
1391
"""Get a test result that writes to the test log file."""
1392
return tests.TextTestResult(self._log_file, descriptions=0, verbosity=1)
1394
def inner_test(self):
1395
# the inner child test
1398
def outer_child(self):
1399
# the outer child test
1401
self.inner_test = TestTestCase("inner_child")
1402
result = self.make_test_result()
1403
self.inner_test.run(result)
1404
note("outer finish")
1405
self.addCleanup(osutils.delete_any, self._log_file_name)
1407
def test_trace_nesting(self):
1408
# this tests that each test case nests its trace facility correctly.
1409
# we do this by running a test case manually. That test case (A)
1410
# should setup a new log, log content to it, setup a child case (B),
1411
# which should log independently, then case (A) should log a trailer
1413
# we do two nested children so that we can verify the state of the
1414
# logs after the outer child finishes is correct, which a bad clean
1415
# up routine in tearDown might trigger a fault in our test with only
1416
# one child, we should instead see the bad result inside our test with
1418
# the outer child test
1419
original_trace = bzrlib.trace._trace_file
1420
outer_test = TestTestCase("outer_child")
1421
result = self.make_test_result()
1422
outer_test.run(result)
1423
self.assertEqual(original_trace, bzrlib.trace._trace_file)
1425
def method_that_times_a_bit_twice(self):
1426
# call self.time twice to ensure it aggregates
1427
self.time(time.sleep, 0.007)
1428
self.time(time.sleep, 0.007)
1430
def test_time_creates_benchmark_in_result(self):
1431
"""Test that the TestCase.time() method accumulates a benchmark time."""
1432
sample_test = TestTestCase("method_that_times_a_bit_twice")
1433
output_stream = StringIO()
1434
result = bzrlib.tests.VerboseTestResult(
1438
sample_test.run(result)
1439
self.assertContainsRe(
1440
output_stream.getvalue(),
1443
def test_hooks_sanitised(self):
1444
"""The bzrlib hooks should be sanitised by setUp."""
1445
# Note this test won't fail with hooks that the core library doesn't
1446
# use - but it trigger with a plugin that adds hooks, so its still a
1447
# useful warning in that case.
1448
self.assertEqual(bzrlib.branch.BranchHooks(), bzrlib.branch.Branch.hooks)
1450
bzrlib.smart.server.SmartServerHooks(),
1451
bzrlib.smart.server.SmartTCPServer.hooks)
1453
bzrlib.commands.CommandHooks(), bzrlib.commands.Command.hooks)
1455
def test__gather_lsprof_in_benchmarks(self):
1456
"""When _gather_lsprof_in_benchmarks is on, accumulate profile data.
1458
Each self.time() call is individually and separately profiled.
1460
self.requireFeature(test_lsprof.LSProfFeature)
1461
# overrides the class member with an instance member so no cleanup
1463
self._gather_lsprof_in_benchmarks = True
1464
self.time(time.sleep, 0.000)
1465
self.time(time.sleep, 0.003)
1466
self.assertEqual(2, len(self._benchcalls))
1467
self.assertEqual((time.sleep, (0.000,), {}), self._benchcalls[0][0])
1468
self.assertEqual((time.sleep, (0.003,), {}), self._benchcalls[1][0])
1469
self.assertIsInstance(self._benchcalls[0][1], bzrlib.lsprof.Stats)
1470
self.assertIsInstance(self._benchcalls[1][1], bzrlib.lsprof.Stats)
1471
del self._benchcalls[:]
1473
def test_knownFailure(self):
1474
"""Self.knownFailure() should raise a KnownFailure exception."""
1475
self.assertRaises(tests.KnownFailure, self.knownFailure, "A Failure")
1477
def test_open_bzrdir_safe_roots(self):
1478
# even a memory transport should fail to open when its url isn't
1480
# Manually set one up (TestCase doesn't and shouldn't provide magic
1482
transport_server = memory.MemoryServer()
1483
transport_server.start_server()
1484
self.addCleanup(transport_server.stop_server)
1485
t = transport.get_transport(transport_server.get_url())
1486
bzrdir.BzrDir.create(t.base)
1487
self.assertRaises(errors.BzrError,
1488
bzrdir.BzrDir.open_from_transport, t)
1489
# But if we declare this as safe, we can open the bzrdir.
1490
self.permit_url(t.base)
1491
self._bzr_selftest_roots.append(t.base)
1492
bzrdir.BzrDir.open_from_transport(t)
1494
def test_requireFeature_available(self):
1495
"""self.requireFeature(available) is a no-op."""
1496
class Available(tests.Feature):
1497
def _probe(self):return True
1498
feature = Available()
1499
self.requireFeature(feature)
1501
def test_requireFeature_unavailable(self):
1502
"""self.requireFeature(unavailable) raises UnavailableFeature."""
1503
class Unavailable(tests.Feature):
1504
def _probe(self):return False
1505
feature = Unavailable()
1506
self.assertRaises(tests.UnavailableFeature,
1507
self.requireFeature, feature)
1509
def test_run_no_parameters(self):
1510
test = SampleTestCase('_test_pass')
1513
def test_run_enabled_unittest_result(self):
1514
"""Test we revert to regular behaviour when the test is enabled."""
1515
test = SampleTestCase('_test_pass')
1516
class EnabledFeature(object):
1517
def available(self):
1519
test._test_needs_features = [EnabledFeature()]
1520
result = unittest.TestResult()
1522
self.assertEqual(1, result.testsRun)
1523
self.assertEqual([], result.errors)
1524
self.assertEqual([], result.failures)
1526
def test_run_disabled_unittest_result(self):
1527
"""Test our compatability for disabled tests with unittest results."""
1528
test = SampleTestCase('_test_pass')
1529
class DisabledFeature(object):
1530
def available(self):
1532
test._test_needs_features = [DisabledFeature()]
1533
result = unittest.TestResult()
1535
self.assertEqual(1, result.testsRun)
1536
self.assertEqual([], result.errors)
1537
self.assertEqual([], result.failures)
1539
def test_run_disabled_supporting_result(self):
1540
"""Test disabled tests behaviour with support aware results."""
1541
test = SampleTestCase('_test_pass')
1542
class DisabledFeature(object):
1543
def __eq__(self, other):
1544
return isinstance(other, DisabledFeature)
1545
def available(self):
1547
the_feature = DisabledFeature()
1548
test._test_needs_features = [the_feature]
1549
class InstrumentedTestResult(unittest.TestResult):
1551
unittest.TestResult.__init__(self)
1553
def startTest(self, test):
1554
self.calls.append(('startTest', test))
1555
def stopTest(self, test):
1556
self.calls.append(('stopTest', test))
1557
def addNotSupported(self, test, feature):
1558
self.calls.append(('addNotSupported', test, feature))
1559
result = InstrumentedTestResult()
1561
case = result.calls[0][1]
1563
('startTest', case),
1564
('addNotSupported', case, the_feature),
1569
def test_start_server_registers_url(self):
1570
transport_server = memory.MemoryServer()
1571
# A little strict, but unlikely to be changed soon.
1572
self.assertEqual([], self._bzr_selftest_roots)
1573
self.start_server(transport_server)
1574
self.assertSubset([transport_server.get_url()],
1575
self._bzr_selftest_roots)
1577
def test_assert_list_raises_on_generator(self):
1578
def generator_which_will_raise():
1579
# This will not raise until after the first yield
1581
raise _TestException()
1583
e = self.assertListRaises(_TestException, generator_which_will_raise)
1584
self.assertIsInstance(e, _TestException)
1586
e = self.assertListRaises(Exception, generator_which_will_raise)
1587
self.assertIsInstance(e, _TestException)
1589
def test_assert_list_raises_on_plain(self):
1590
def plain_exception():
1591
raise _TestException()
1594
e = self.assertListRaises(_TestException, plain_exception)
1595
self.assertIsInstance(e, _TestException)
1597
e = self.assertListRaises(Exception, plain_exception)
1598
self.assertIsInstance(e, _TestException)
1600
def test_assert_list_raises_assert_wrong_exception(self):
1601
class _NotTestException(Exception):
1604
def wrong_exception():
1605
raise _NotTestException()
1607
def wrong_exception_generator():
1610
raise _NotTestException()
1612
# Wrong exceptions are not intercepted
1613
self.assertRaises(_NotTestException,
1614
self.assertListRaises, _TestException, wrong_exception)
1615
self.assertRaises(_NotTestException,
1616
self.assertListRaises, _TestException, wrong_exception_generator)
1618
def test_assert_list_raises_no_exception(self):
1622
def success_generator():
1626
self.assertRaises(AssertionError,
1627
self.assertListRaises, _TestException, success)
1629
self.assertRaises(AssertionError,
1630
self.assertListRaises, _TestException, success_generator)
1632
def test_overrideAttr_without_value(self):
1633
self.test_attr = 'original' # Define a test attribute
1634
obj = self # Make 'obj' visible to the embedded test
1635
class Test(tests.TestCase):
1638
tests.TestCase.setUp(self)
1639
self.orig = self.overrideAttr(obj, 'test_attr')
1641
def test_value(self):
1642
self.assertEqual('original', self.orig)
1643
self.assertEqual('original', obj.test_attr)
1644
obj.test_attr = 'modified'
1645
self.assertEqual('modified', obj.test_attr)
1647
test = Test('test_value')
1648
test.run(unittest.TestResult())
1649
self.assertEqual('original', obj.test_attr)
1651
def test_overrideAttr_with_value(self):
1652
self.test_attr = 'original' # Define a test attribute
1653
obj = self # Make 'obj' visible to the embedded test
1654
class Test(tests.TestCase):
1657
tests.TestCase.setUp(self)
1658
self.orig = self.overrideAttr(obj, 'test_attr', new='modified')
1660
def test_value(self):
1661
self.assertEqual('original', self.orig)
1662
self.assertEqual('modified', obj.test_attr)
1664
test = Test('test_value')
1665
test.run(unittest.TestResult())
1666
self.assertEqual('original', obj.test_attr)
1669
class _MissingFeature(tests.Feature):
1672
missing_feature = _MissingFeature()
1675
def _get_test(name):
1676
"""Get an instance of a specific example test.
1678
We protect this in a function so that they don't auto-run in the test
1682
class ExampleTests(tests.TestCase):
1684
def test_fail(self):
1685
mutter('this was a failing test')
1686
self.fail('this test will fail')
1688
def test_error(self):
1689
mutter('this test errored')
1690
raise RuntimeError('gotcha')
1692
def test_missing_feature(self):
1693
mutter('missing the feature')
1694
self.requireFeature(missing_feature)
1696
def test_skip(self):
1697
mutter('this test will be skipped')
1698
raise tests.TestSkipped('reason')
1700
def test_success(self):
1701
mutter('this test succeeds')
1703
def test_xfail(self):
1704
mutter('test with expected failure')
1705
self.knownFailure('this_fails')
1707
def test_unexpected_success(self):
1708
mutter('test with unexpected success')
1709
self.expectFailure('should_fail', lambda: None)
1711
return ExampleTests(name)
1714
class TestTestCaseLogDetails(tests.TestCase):
1716
def _run_test(self, test_name):
1717
test = _get_test(test_name)
1718
result = testtools.TestResult()
1722
def test_fail_has_log(self):
1723
result = self._run_test('test_fail')
1724
self.assertEqual(1, len(result.failures))
1725
result_content = result.failures[0][1]
1726
self.assertContainsRe(result_content, 'Text attachment: log')
1727
self.assertContainsRe(result_content, 'this was a failing test')
1729
def test_error_has_log(self):
1730
result = self._run_test('test_error')
1731
self.assertEqual(1, len(result.errors))
1732
result_content = result.errors[0][1]
1733
self.assertContainsRe(result_content, 'Text attachment: log')
1734
self.assertContainsRe(result_content, 'this test errored')
1736
def test_skip_has_no_log(self):
1737
result = self._run_test('test_skip')
1738
self.assertEqual(['reason'], result.skip_reasons.keys())
1739
skips = result.skip_reasons['reason']
1740
self.assertEqual(1, len(skips))
1742
self.assertFalse('log' in test.getDetails())
1744
def test_missing_feature_has_no_log(self):
1745
# testtools doesn't know about addNotSupported, so it just gets
1746
# considered as a skip
1747
result = self._run_test('test_missing_feature')
1748
self.assertEqual([missing_feature], result.skip_reasons.keys())
1749
skips = result.skip_reasons[missing_feature]
1750
self.assertEqual(1, len(skips))
1752
self.assertFalse('log' in test.getDetails())
1754
def test_xfail_has_no_log(self):
1755
result = self._run_test('test_xfail')
1756
self.assertEqual(1, len(result.expectedFailures))
1757
result_content = result.expectedFailures[0][1]
1758
self.assertNotContainsRe(result_content, 'Text attachment: log')
1759
self.assertNotContainsRe(result_content, 'test with expected failure')
1761
def test_unexpected_success_has_log(self):
1762
result = self._run_test('test_unexpected_success')
1763
self.assertEqual(1, len(result.unexpectedSuccesses))
1764
# Inconsistency, unexpectedSuccesses is a list of tests,
1765
# expectedFailures is a list of reasons?
1766
test = result.unexpectedSuccesses[0]
1767
details = test.getDetails()
1768
self.assertTrue('log' in details)
1771
class TestTestCloning(tests.TestCase):
1772
"""Tests that test cloning of TestCases (as used by multiply_tests)."""
1774
def test_cloned_testcase_does_not_share_details(self):
1775
"""A TestCase cloned with clone_test does not share mutable attributes
1776
such as details or cleanups.
1778
class Test(tests.TestCase):
1780
self.addDetail('foo', Content('text/plain', lambda: 'foo'))
1781
orig_test = Test('test_foo')
1782
cloned_test = tests.clone_test(orig_test, orig_test.id() + '(cloned)')
1783
orig_test.run(unittest.TestResult())
1784
self.assertEqual('foo', orig_test.getDetails()['foo'].iter_bytes())
1785
self.assertEqual(None, cloned_test.getDetails().get('foo'))
1787
def test_double_apply_scenario_preserves_first_scenario(self):
1788
"""Applying two levels of scenarios to a test preserves the attributes
1789
added by both scenarios.
1791
class Test(tests.TestCase):
1794
test = Test('test_foo')
1795
scenarios_x = [('x=1', {'x': 1}), ('x=2', {'x': 2})]
1796
scenarios_y = [('y=1', {'y': 1}), ('y=2', {'y': 2})]
1797
suite = tests.multiply_tests(test, scenarios_x, unittest.TestSuite())
1798
suite = tests.multiply_tests(suite, scenarios_y, unittest.TestSuite())
1799
all_tests = list(tests.iter_suite_tests(suite))
1800
self.assertLength(4, all_tests)
1801
all_xys = sorted((t.x, t.y) for t in all_tests)
1802
self.assertEqual([(1, 1), (1, 2), (2, 1), (2, 2)], all_xys)
1805
# NB: Don't delete this; it's not actually from 0.11!
1806
@deprecated_function(deprecated_in((0, 11, 0)))
1807
def sample_deprecated_function():
1808
"""A deprecated function to test applyDeprecated with."""
1812
def sample_undeprecated_function(a_param):
1813
"""A undeprecated function to test applyDeprecated with."""
1816
class ApplyDeprecatedHelper(object):
1817
"""A helper class for ApplyDeprecated tests."""
1819
@deprecated_method(deprecated_in((0, 11, 0)))
1820
def sample_deprecated_method(self, param_one):
1821
"""A deprecated method for testing with."""
1824
def sample_normal_method(self):
1825
"""A undeprecated method."""
1827
@deprecated_method(deprecated_in((0, 10, 0)))
1828
def sample_nested_deprecation(self):
1829
return sample_deprecated_function()
1832
class TestExtraAssertions(tests.TestCase):
1833
"""Tests for new test assertions in bzrlib test suite"""
1835
def test_assert_isinstance(self):
1836
self.assertIsInstance(2, int)
1837
self.assertIsInstance(u'', basestring)
1838
e = self.assertRaises(AssertionError, self.assertIsInstance, None, int)
1839
self.assertEquals(str(e),
1840
"None is an instance of <type 'NoneType'> rather than <type 'int'>")
1841
self.assertRaises(AssertionError, self.assertIsInstance, 23.3, int)
1842
e = self.assertRaises(AssertionError,
1843
self.assertIsInstance, None, int, "it's just not")
1844
self.assertEquals(str(e),
1845
"None is an instance of <type 'NoneType'> rather than <type 'int'>"
1848
def test_assertEndsWith(self):
1849
self.assertEndsWith('foo', 'oo')
1850
self.assertRaises(AssertionError, self.assertEndsWith, 'o', 'oo')
1852
def test_assertEqualDiff(self):
1853
e = self.assertRaises(AssertionError,
1854
self.assertEqualDiff, '', '\n')
1855
self.assertEquals(str(e),
1856
# Don't blink ! The '+' applies to the second string
1857
'first string is missing a final newline.\n+ \n')
1858
e = self.assertRaises(AssertionError,
1859
self.assertEqualDiff, '\n', '')
1860
self.assertEquals(str(e),
1861
# Don't blink ! The '-' applies to the second string
1862
'second string is missing a final newline.\n- \n')
1865
class TestDeprecations(tests.TestCase):
1867
def test_applyDeprecated_not_deprecated(self):
1868
sample_object = ApplyDeprecatedHelper()
1869
# calling an undeprecated callable raises an assertion
1870
self.assertRaises(AssertionError, self.applyDeprecated,
1871
deprecated_in((0, 11, 0)),
1872
sample_object.sample_normal_method)
1873
self.assertRaises(AssertionError, self.applyDeprecated,
1874
deprecated_in((0, 11, 0)),
1875
sample_undeprecated_function, "a param value")
1876
# calling a deprecated callable (function or method) with the wrong
1877
# expected deprecation fails.
1878
self.assertRaises(AssertionError, self.applyDeprecated,
1879
deprecated_in((0, 10, 0)),
1880
sample_object.sample_deprecated_method, "a param value")
1881
self.assertRaises(AssertionError, self.applyDeprecated,
1882
deprecated_in((0, 10, 0)),
1883
sample_deprecated_function)
1884
# calling a deprecated callable (function or method) with the right
1885
# expected deprecation returns the functions result.
1886
self.assertEqual("a param value",
1887
self.applyDeprecated(deprecated_in((0, 11, 0)),
1888
sample_object.sample_deprecated_method, "a param value"))
1889
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 11, 0)),
1890
sample_deprecated_function))
1891
# calling a nested deprecation with the wrong deprecation version
1892
# fails even if a deeper nested function was deprecated with the
1894
self.assertRaises(AssertionError, self.applyDeprecated,
1895
deprecated_in((0, 11, 0)), sample_object.sample_nested_deprecation)
1896
# calling a nested deprecation with the right deprecation value
1897
# returns the calls result.
1898
self.assertEqual(2, self.applyDeprecated(deprecated_in((0, 10, 0)),
1899
sample_object.sample_nested_deprecation))
1901
def test_callDeprecated(self):
1902
def testfunc(be_deprecated, result=None):
1903
if be_deprecated is True:
1904
symbol_versioning.warn('i am deprecated', DeprecationWarning,
1907
result = self.callDeprecated(['i am deprecated'], testfunc, True)
1908
self.assertIs(None, result)
1909
result = self.callDeprecated([], testfunc, False, 'result')
1910
self.assertEqual('result', result)
1911
self.callDeprecated(['i am deprecated'], testfunc, be_deprecated=True)
1912
self.callDeprecated([], testfunc, be_deprecated=False)
1915
class TestWarningTests(tests.TestCase):
1916
"""Tests for calling methods that raise warnings."""
1918
def test_callCatchWarnings(self):
1920
warnings.warn("this is your last warning")
1922
wlist, result = self.callCatchWarnings(meth, 1, 2)
1923
self.assertEquals(3, result)
1924
# would like just to compare them, but UserWarning doesn't implement
1927
self.assertIsInstance(w0, UserWarning)
1928
self.assertEquals("this is your last warning", str(w0))
1931
class TestConvenienceMakers(tests.TestCaseWithTransport):
1932
"""Test for the make_* convenience functions."""
1934
def test_make_branch_and_tree_with_format(self):
1935
# we should be able to supply a format to make_branch_and_tree
1936
self.make_branch_and_tree('a', format=bzrlib.bzrdir.BzrDirMetaFormat1())
1937
self.assertIsInstance(bzrlib.bzrdir.BzrDir.open('a')._format,
1938
bzrlib.bzrdir.BzrDirMetaFormat1)
1940
def test_make_branch_and_memory_tree(self):
1941
# we should be able to get a new branch and a mutable tree from
1942
# TestCaseWithTransport
1943
tree = self.make_branch_and_memory_tree('a')
1944
self.assertIsInstance(tree, bzrlib.memorytree.MemoryTree)
1946
def test_make_tree_for_local_vfs_backed_transport(self):
1947
# make_branch_and_tree has to use local branch and repositories
1948
# when the vfs transport and local disk are colocated, even if
1949
# a different transport is in use for url generation.
1950
self.transport_server = test_server.FakeVFATServer
1951
self.assertFalse(self.get_url('t1').startswith('file://'))
1952
tree = self.make_branch_and_tree('t1')
1953
base = tree.bzrdir.root_transport.base
1954
self.assertStartsWith(base, 'file://')
1955
self.assertEquals(tree.bzrdir.root_transport,
1956
tree.branch.bzrdir.root_transport)
1957
self.assertEquals(tree.bzrdir.root_transport,
1958
tree.branch.repository.bzrdir.root_transport)
1961
class SelfTestHelper(object):
1963
def run_selftest(self, **kwargs):
1964
"""Run selftest returning its output."""
1966
old_transport = bzrlib.tests.default_transport
1967
old_root = tests.TestCaseWithMemoryTransport.TEST_ROOT
1968
tests.TestCaseWithMemoryTransport.TEST_ROOT = None
1970
self.assertEqual(True, tests.selftest(stream=output, **kwargs))
1972
bzrlib.tests.default_transport = old_transport
1973
tests.TestCaseWithMemoryTransport.TEST_ROOT = old_root
1978
class TestSelftest(tests.TestCase, SelfTestHelper):
1979
"""Tests of bzrlib.tests.selftest."""
1981
def test_selftest_benchmark_parameter_invokes_test_suite__benchmark__(self):
1984
factory_called.append(True)
1985
return TestUtil.TestSuite()
1988
self.apply_redirected(out, err, None, bzrlib.tests.selftest,
1989
test_suite_factory=factory)
1990
self.assertEqual([True], factory_called)
1993
"""A test suite factory."""
1994
class Test(tests.TestCase):
2001
return TestUtil.TestSuite([Test("a"), Test("b"), Test("c")])
2003
def test_list_only(self):
2004
output = self.run_selftest(test_suite_factory=self.factory,
2006
self.assertEqual(3, len(output.readlines()))
2008
def test_list_only_filtered(self):
2009
output = self.run_selftest(test_suite_factory=self.factory,
2010
list_only=True, pattern="Test.b")
2011
self.assertEndsWith(output.getvalue(), "Test.b\n")
2012
self.assertLength(1, output.readlines())
2014
def test_list_only_excludes(self):
2015
output = self.run_selftest(test_suite_factory=self.factory,
2016
list_only=True, exclude_pattern="Test.b")
2017
self.assertNotContainsRe("Test.b", output.getvalue())
2018
self.assertLength(2, output.readlines())
2020
def test_lsprof_tests(self):
2021
self.requireFeature(test_lsprof.LSProfFeature)
2024
def __call__(test, result):
2026
def run(test, result):
2027
self.assertIsInstance(result, ExtendedToOriginalDecorator)
2028
calls.append("called")
2029
def countTestCases(self):
2031
self.run_selftest(test_suite_factory=Test, lsprof_tests=True)
2032
self.assertLength(1, calls)
2034
def test_random(self):
2035
# test randomising by listing a number of tests.
2036
output_123 = self.run_selftest(test_suite_factory=self.factory,
2037
list_only=True, random_seed="123")
2038
output_234 = self.run_selftest(test_suite_factory=self.factory,
2039
list_only=True, random_seed="234")
2040
self.assertNotEqual(output_123, output_234)
2041
# "Randominzing test order..\n\n
2042
self.assertLength(5, output_123.readlines())
2043
self.assertLength(5, output_234.readlines())
2045
def test_random_reuse_is_same_order(self):
2046
# test randomising by listing a number of tests.
2047
expected = self.run_selftest(test_suite_factory=self.factory,
2048
list_only=True, random_seed="123")
2049
repeated = self.run_selftest(test_suite_factory=self.factory,
2050
list_only=True, random_seed="123")
2051
self.assertEqual(expected.getvalue(), repeated.getvalue())
2053
def test_runner_class(self):
2054
self.requireFeature(features.subunit)
2055
from subunit import ProtocolTestCase
2056
stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
2057
test_suite_factory=self.factory)
2058
test = ProtocolTestCase(stream)
2059
result = unittest.TestResult()
2061
self.assertEqual(3, result.testsRun)
2063
def test_starting_with_single_argument(self):
2064
output = self.run_selftest(test_suite_factory=self.factory,
2065
starting_with=['bzrlib.tests.test_selftest.Test.a'],
2067
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n',
2070
def test_starting_with_multiple_argument(self):
2071
output = self.run_selftest(test_suite_factory=self.factory,
2072
starting_with=['bzrlib.tests.test_selftest.Test.a',
2073
'bzrlib.tests.test_selftest.Test.b'],
2075
self.assertEqual('bzrlib.tests.test_selftest.Test.a\n'
2076
'bzrlib.tests.test_selftest.Test.b\n',
2079
def check_transport_set(self, transport_server):
2080
captured_transport = []
2081
def seen_transport(a_transport):
2082
captured_transport.append(a_transport)
2083
class Capture(tests.TestCase):
2085
seen_transport(bzrlib.tests.default_transport)
2087
return TestUtil.TestSuite([Capture("a")])
2088
self.run_selftest(transport=transport_server, test_suite_factory=factory)
2089
self.assertEqual(transport_server, captured_transport[0])
2091
def test_transport_sftp(self):
2092
self.requireFeature(features.paramiko)
2093
from bzrlib.tests import stub_sftp
2094
self.check_transport_set(stub_sftp.SFTPAbsoluteServer)
2096
def test_transport_memory(self):
2097
self.check_transport_set(memory.MemoryServer)
2100
class TestSelftestWithIdList(tests.TestCaseInTempDir, SelfTestHelper):
2101
# Does IO: reads test.list
2103
def test_load_list(self):
2104
# Provide a list with one test - this test.
2105
test_id_line = '%s\n' % self.id()
2106
self.build_tree_contents([('test.list', test_id_line)])
2107
# And generate a list of the tests in the suite.
2108
stream = self.run_selftest(load_list='test.list', list_only=True)
2109
self.assertEqual(test_id_line, stream.getvalue())
2111
def test_load_unknown(self):
2112
# Provide a list with one test - this test.
2113
# And generate a list of the tests in the suite.
2114
err = self.assertRaises(errors.NoSuchFile, self.run_selftest,
2115
load_list='missing file name', list_only=True)
2118
class TestSubunitLogDetails(tests.TestCase, SelfTestHelper):
2120
_test_needs_features = [features.subunit]
2122
def run_subunit_stream(self, test_name):
2123
from subunit import ProtocolTestCase
2125
return TestUtil.TestSuite([_get_test(test_name)])
2126
stream = self.run_selftest(runner_class=tests.SubUnitBzrRunner,
2127
test_suite_factory=factory)
2128
test = ProtocolTestCase(stream)
2129
result = testtools.TestResult()
2131
content = stream.getvalue()
2132
return content, result
2134
def test_fail_has_log(self):
2135
content, result = self.run_subunit_stream('test_fail')
2136
self.assertEqual(1, len(result.failures))
2137
self.assertContainsRe(content, '(?m)^log$')
2138
self.assertContainsRe(content, 'this test will fail')
2140
def test_error_has_log(self):
2141
content, result = self.run_subunit_stream('test_error')
2142
self.assertContainsRe(content, '(?m)^log$')
2143
self.assertContainsRe(content, 'this test errored')
2145
def test_skip_has_no_log(self):
2146
content, result = self.run_subunit_stream('test_skip')
2147
self.assertNotContainsRe(content, '(?m)^log$')
2148
self.assertNotContainsRe(content, 'this test will be skipped')
2149
self.assertEqual(['reason'], result.skip_reasons.keys())
2150
skips = result.skip_reasons['reason']
2151
self.assertEqual(1, len(skips))
2153
# RemotedTestCase doesn't preserve the "details"
2154
## self.assertFalse('log' in test.getDetails())
2156
def test_missing_feature_has_no_log(self):
2157
content, result = self.run_subunit_stream('test_missing_feature')
2158
self.assertNotContainsRe(content, '(?m)^log$')
2159
self.assertNotContainsRe(content, 'missing the feature')
2160
self.assertEqual(['_MissingFeature\n'], result.skip_reasons.keys())
2161
skips = result.skip_reasons['_MissingFeature\n']
2162
self.assertEqual(1, len(skips))
2164
# RemotedTestCase doesn't preserve the "details"
2165
## self.assertFalse('log' in test.getDetails())
2167
def test_xfail_has_no_log(self):
2168
content, result = self.run_subunit_stream('test_xfail')
2169
self.assertNotContainsRe(content, '(?m)^log$')
2170
self.assertNotContainsRe(content, 'test with expected failure')
2171
self.assertEqual(1, len(result.expectedFailures))
2172
result_content = result.expectedFailures[0][1]
2173
self.assertNotContainsRe(result_content, 'Text attachment: log')
2174
self.assertNotContainsRe(result_content, 'test with expected failure')
2176
def test_unexpected_success_has_log(self):
2177
content, result = self.run_subunit_stream('test_unexpected_success')
2178
self.assertContainsRe(content, '(?m)^log$')
2179
self.assertContainsRe(content, 'test with unexpected success')
2180
self.expectFailure('subunit treats "unexpectedSuccess"'
2181
' as a plain success',
2182
self.assertEqual, 1, len(result.unexpectedSuccesses))
2183
self.assertEqual(1, len(result.unexpectedSuccesses))
2184
test = result.unexpectedSuccesses[0]
2185
# RemotedTestCase doesn't preserve the "details"
2186
## self.assertTrue('log' in test.getDetails())
2188
def test_success_has_no_log(self):
2189
content, result = self.run_subunit_stream('test_success')
2190
self.assertEqual(1, result.testsRun)
2191
self.assertNotContainsRe(content, '(?m)^log$')
2192
self.assertNotContainsRe(content, 'this test succeeds')
2195
class TestRunBzr(tests.TestCase):
2200
def _run_bzr_core(self, argv, retcode=0, encoding=None, stdin=None,
2202
"""Override _run_bzr_core to test how it is invoked by run_bzr.
2204
Attempts to run bzr from inside this class don't actually run it.
2206
We test how run_bzr actually invokes bzr in another location. Here we
2207
only need to test that it passes the right parameters to run_bzr.
2209
self.argv = list(argv)
2210
self.retcode = retcode
2211
self.encoding = encoding
2213
self.working_dir = working_dir
2214
return self.retcode, self.out, self.err
2216
def test_run_bzr_error(self):
2217
self.out = "It sure does!\n"
2218
out, err = self.run_bzr_error(['^$'], ['rocks'], retcode=34)
2219
self.assertEqual(['rocks'], self.argv)
2220
self.assertEqual(34, self.retcode)
2221
self.assertEqual('It sure does!\n', out)
2222
self.assertEquals(out, self.out)
2223
self.assertEqual('', err)
2224
self.assertEquals(err, self.err)
2226
def test_run_bzr_error_regexes(self):
2228
self.err = "bzr: ERROR: foobarbaz is not versioned"
2229
out, err = self.run_bzr_error(
2230
["bzr: ERROR: foobarbaz is not versioned"],
2231
['file-id', 'foobarbaz'])
2233
def test_encoding(self):
2234
"""Test that run_bzr passes encoding to _run_bzr_core"""
2235
self.run_bzr('foo bar')
2236
self.assertEqual(None, self.encoding)
2237
self.assertEqual(['foo', 'bar'], self.argv)
2239
self.run_bzr('foo bar', encoding='baz')
2240
self.assertEqual('baz', self.encoding)
2241
self.assertEqual(['foo', 'bar'], self.argv)
2243
def test_retcode(self):
2244
"""Test that run_bzr passes retcode to _run_bzr_core"""
2245
# Default is retcode == 0
2246
self.run_bzr('foo bar')
2247
self.assertEqual(0, self.retcode)
2248
self.assertEqual(['foo', 'bar'], self.argv)
2250
self.run_bzr('foo bar', retcode=1)
2251
self.assertEqual(1, self.retcode)
2252
self.assertEqual(['foo', 'bar'], self.argv)
2254
self.run_bzr('foo bar', retcode=None)
2255
self.assertEqual(None, self.retcode)
2256
self.assertEqual(['foo', 'bar'], self.argv)
2258
self.run_bzr(['foo', 'bar'], retcode=3)
2259
self.assertEqual(3, self.retcode)
2260
self.assertEqual(['foo', 'bar'], self.argv)
2262
def test_stdin(self):
2263
# test that the stdin keyword to run_bzr is passed through to
2264
# _run_bzr_core as-is. We do this by overriding
2265
# _run_bzr_core in this class, and then calling run_bzr,
2266
# which is a convenience function for _run_bzr_core, so
2268
self.run_bzr('foo bar', stdin='gam')
2269
self.assertEqual('gam', self.stdin)
2270
self.assertEqual(['foo', 'bar'], self.argv)
2272
self.run_bzr('foo bar', stdin='zippy')
2273
self.assertEqual('zippy', self.stdin)
2274
self.assertEqual(['foo', 'bar'], self.argv)
2276
def test_working_dir(self):
2277
"""Test that run_bzr passes working_dir to _run_bzr_core"""
2278
self.run_bzr('foo bar')
2279
self.assertEqual(None, self.working_dir)
2280
self.assertEqual(['foo', 'bar'], self.argv)
2282
self.run_bzr('foo bar', working_dir='baz')
2283
self.assertEqual('baz', self.working_dir)
2284
self.assertEqual(['foo', 'bar'], self.argv)
2286
def test_reject_extra_keyword_arguments(self):
2287
self.assertRaises(TypeError, self.run_bzr, "foo bar",
2288
error_regex=['error message'])
2291
class TestRunBzrCaptured(tests.TestCaseWithTransport):
2292
# Does IO when testing the working_dir parameter.
2294
def apply_redirected(self, stdin=None, stdout=None, stderr=None,
2295
a_callable=None, *args, **kwargs):
2297
self.factory_stdin = getattr(bzrlib.ui.ui_factory, "stdin", None)
2298
self.factory = bzrlib.ui.ui_factory
2299
self.working_dir = osutils.getcwd()
2300
stdout.write('foo\n')
2301
stderr.write('bar\n')
2304
def test_stdin(self):
2305
# test that the stdin keyword to _run_bzr_core is passed through to
2306
# apply_redirected as a StringIO. We do this by overriding
2307
# apply_redirected in this class, and then calling _run_bzr_core,
2308
# which calls apply_redirected.
2309
self.run_bzr(['foo', 'bar'], stdin='gam')
2310
self.assertEqual('gam', self.stdin.read())
2311
self.assertTrue(self.stdin is self.factory_stdin)
2312
self.run_bzr(['foo', 'bar'], stdin='zippy')
2313
self.assertEqual('zippy', self.stdin.read())
2314
self.assertTrue(self.stdin is self.factory_stdin)
2316
def test_ui_factory(self):
2317
# each invocation of self.run_bzr should get its
2318
# own UI factory, which is an instance of TestUIFactory,
2319
# with stdin, stdout and stderr attached to the stdin,
2320
# stdout and stderr of the invoked run_bzr
2321
current_factory = bzrlib.ui.ui_factory
2322
self.run_bzr(['foo'])
2323
self.assertFalse(current_factory is self.factory)
2324
self.assertNotEqual(sys.stdout, self.factory.stdout)
2325
self.assertNotEqual(sys.stderr, self.factory.stderr)
2326
self.assertEqual('foo\n', self.factory.stdout.getvalue())
2327
self.assertEqual('bar\n', self.factory.stderr.getvalue())
2328
self.assertIsInstance(self.factory, tests.TestUIFactory)
2330
def test_working_dir(self):
2331
self.build_tree(['one/', 'two/'])
2332
cwd = osutils.getcwd()
2334
# Default is to work in the current directory
2335
self.run_bzr(['foo', 'bar'])
2336
self.assertEqual(cwd, self.working_dir)
2338
self.run_bzr(['foo', 'bar'], working_dir=None)
2339
self.assertEqual(cwd, self.working_dir)
2341
# The function should be run in the alternative directory
2342
# but afterwards the current working dir shouldn't be changed
2343
self.run_bzr(['foo', 'bar'], working_dir='one')
2344
self.assertNotEqual(cwd, self.working_dir)
2345
self.assertEndsWith(self.working_dir, 'one')
2346
self.assertEqual(cwd, osutils.getcwd())
2348
self.run_bzr(['foo', 'bar'], working_dir='two')
2349
self.assertNotEqual(cwd, self.working_dir)
2350
self.assertEndsWith(self.working_dir, 'two')
2351
self.assertEqual(cwd, osutils.getcwd())
2354
class StubProcess(object):
2355
"""A stub process for testing run_bzr_subprocess."""
2357
def __init__(self, out="", err="", retcode=0):
2360
self.returncode = retcode
2362
def communicate(self):
2363
return self.out, self.err
2366
class TestWithFakedStartBzrSubprocess(tests.TestCaseWithTransport):
2367
"""Base class for tests testing how we might run bzr."""
2370
tests.TestCaseWithTransport.setUp(self)
2371
self.subprocess_calls = []
2373
def start_bzr_subprocess(self, process_args, env_changes=None,
2374
skip_if_plan_to_signal=False,
2376
allow_plugins=False):
2377
"""capture what run_bzr_subprocess tries to do."""
2378
self.subprocess_calls.append({'process_args':process_args,
2379
'env_changes':env_changes,
2380
'skip_if_plan_to_signal':skip_if_plan_to_signal,
2381
'working_dir':working_dir, 'allow_plugins':allow_plugins})
2382
return self.next_subprocess
2385
class TestRunBzrSubprocess(TestWithFakedStartBzrSubprocess):
2387
def assertRunBzrSubprocess(self, expected_args, process, *args, **kwargs):
2388
"""Run run_bzr_subprocess with args and kwargs using a stubbed process.
2390
Inside TestRunBzrSubprocessCommands we use a stub start_bzr_subprocess
2391
that will return static results. This assertion method populates those
2392
results and also checks the arguments run_bzr_subprocess generates.
2394
self.next_subprocess = process
2396
result = self.run_bzr_subprocess(*args, **kwargs)
2398
self.next_subprocess = None
2399
for key, expected in expected_args.iteritems():
2400
self.assertEqual(expected, self.subprocess_calls[-1][key])
2403
self.next_subprocess = None
2404
for key, expected in expected_args.iteritems():
2405
self.assertEqual(expected, self.subprocess_calls[-1][key])
2408
def test_run_bzr_subprocess(self):
2409
"""The run_bzr_helper_external command behaves nicely."""
2410
self.assertRunBzrSubprocess({'process_args':['--version']},
2411
StubProcess(), '--version')
2412
self.assertRunBzrSubprocess({'process_args':['--version']},
2413
StubProcess(), ['--version'])
2414
# retcode=None disables retcode checking
2415
result = self.assertRunBzrSubprocess({},
2416
StubProcess(retcode=3), '--version', retcode=None)
2417
result = self.assertRunBzrSubprocess({},
2418
StubProcess(out="is free software"), '--version')
2419
self.assertContainsRe(result[0], 'is free software')
2420
# Running a subcommand that is missing errors
2421
self.assertRaises(AssertionError, self.assertRunBzrSubprocess,
2422
{'process_args':['--versionn']}, StubProcess(retcode=3),
2424
# Unless it is told to expect the error from the subprocess
2425
result = self.assertRunBzrSubprocess({},
2426
StubProcess(retcode=3), '--versionn', retcode=3)
2427
# Or to ignore retcode checking
2428
result = self.assertRunBzrSubprocess({},
2429
StubProcess(err="unknown command", retcode=3), '--versionn',
2431
self.assertContainsRe(result[1], 'unknown command')
2433
def test_env_change_passes_through(self):
2434
self.assertRunBzrSubprocess(
2435
{'env_changes':{'new':'value', 'changed':'newvalue', 'deleted':None}},
2437
env_changes={'new':'value', 'changed':'newvalue', 'deleted':None})
2439
def test_no_working_dir_passed_as_None(self):
2440
self.assertRunBzrSubprocess({'working_dir': None}, StubProcess(), '')
2442
def test_no_working_dir_passed_through(self):
2443
self.assertRunBzrSubprocess({'working_dir': 'dir'}, StubProcess(), '',
2446
def test_run_bzr_subprocess_no_plugins(self):
2447
self.assertRunBzrSubprocess({'allow_plugins': False},
2450
def test_allow_plugins(self):
2451
self.assertRunBzrSubprocess({'allow_plugins': True},
2452
StubProcess(), '', allow_plugins=True)
2455
class TestFinishBzrSubprocess(TestWithFakedStartBzrSubprocess):
2457
def test_finish_bzr_subprocess_with_error(self):
2458
"""finish_bzr_subprocess allows specification of the desired exit code.
2460
process = StubProcess(err="unknown command", retcode=3)
2461
result = self.finish_bzr_subprocess(process, retcode=3)
2462
self.assertEqual('', result[0])
2463
self.assertContainsRe(result[1], 'unknown command')
2465
def test_finish_bzr_subprocess_ignoring_retcode(self):
2466
"""finish_bzr_subprocess allows the exit code to be ignored."""
2467
process = StubProcess(err="unknown command", retcode=3)
2468
result = self.finish_bzr_subprocess(process, retcode=None)
2469
self.assertEqual('', result[0])
2470
self.assertContainsRe(result[1], 'unknown command')
2472
def test_finish_subprocess_with_unexpected_retcode(self):
2473
"""finish_bzr_subprocess raises self.failureException if the retcode is
2474
not the expected one.
2476
process = StubProcess(err="unknown command", retcode=3)
2477
self.assertRaises(self.failureException, self.finish_bzr_subprocess,
2481
class _DontSpawnProcess(Exception):
2482
"""A simple exception which just allows us to skip unnecessary steps"""
2485
class TestStartBzrSubProcess(tests.TestCase):
2487
def check_popen_state(self):
2488
"""Replace to make assertions when popen is called."""
2490
def _popen(self, *args, **kwargs):
2491
"""Record the command that is run, so that we can ensure it is correct"""
2492
self.check_popen_state()
2493
self._popen_args = args
2494
self._popen_kwargs = kwargs
2495
raise _DontSpawnProcess()
2497
def test_run_bzr_subprocess_no_plugins(self):
2498
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [])
2499
command = self._popen_args[0]
2500
self.assertEqual(sys.executable, command[0])
2501
self.assertEqual(self.get_bzr_path(), command[1])
2502
self.assertEqual(['--no-plugins'], command[2:])
2504
def test_allow_plugins(self):
2505
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2507
command = self._popen_args[0]
2508
self.assertEqual([], command[2:])
2510
def test_set_env(self):
2511
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2513
def check_environment():
2514
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2515
self.check_popen_state = check_environment
2516
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2517
env_changes={'EXISTANT_ENV_VAR':'set variable'})
2518
# not set in theparent
2519
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2521
def test_run_bzr_subprocess_env_del(self):
2522
"""run_bzr_subprocess can remove environment variables too."""
2523
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2524
def check_environment():
2525
self.assertFalse('EXISTANT_ENV_VAR' in os.environ)
2526
os.environ['EXISTANT_ENV_VAR'] = 'set variable'
2527
self.check_popen_state = check_environment
2528
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2529
env_changes={'EXISTANT_ENV_VAR':None})
2530
# Still set in parent
2531
self.assertEqual('set variable', os.environ['EXISTANT_ENV_VAR'])
2532
del os.environ['EXISTANT_ENV_VAR']
2534
def test_env_del_missing(self):
2535
self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2536
def check_environment():
2537
self.assertFalse('NON_EXISTANT_ENV_VAR' in os.environ)
2538
self.check_popen_state = check_environment
2539
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2540
env_changes={'NON_EXISTANT_ENV_VAR':None})
2542
def test_working_dir(self):
2543
"""Test that we can specify the working dir for the child"""
2544
orig_getcwd = osutils.getcwd
2545
orig_chdir = os.chdir
2553
osutils.getcwd = getcwd
2555
self.assertRaises(_DontSpawnProcess, self.start_bzr_subprocess, [],
2558
osutils.getcwd = orig_getcwd
2560
os.chdir = orig_chdir
2561
self.assertEqual(['foo', 'current'], chdirs)
2563
def test_get_bzr_path_with_cwd_bzrlib(self):
2564
self.get_source_path = lambda: ""
2565
self.overrideAttr(os.path, "isfile", lambda path: True)
2566
self.assertEqual(self.get_bzr_path(), "bzr")
2569
class TestActuallyStartBzrSubprocess(tests.TestCaseWithTransport):
2570
"""Tests that really need to do things with an external bzr."""
2572
def test_start_and_stop_bzr_subprocess_send_signal(self):
2573
"""finish_bzr_subprocess raises self.failureException if the retcode is
2574
not the expected one.
2576
self.disable_missing_extensions_warning()
2577
process = self.start_bzr_subprocess(['wait-until-signalled'],
2578
skip_if_plan_to_signal=True)
2579
self.assertEqual('running\n', process.stdout.readline())
2580
result = self.finish_bzr_subprocess(process, send_signal=signal.SIGINT,
2582
self.assertEqual('', result[0])
2583
self.assertEqual('bzr: interrupted\n', result[1])
2586
class TestFeature(tests.TestCase):
2588
def test_caching(self):
2589
"""Feature._probe is called by the feature at most once."""
2590
class InstrumentedFeature(tests.Feature):
2592
super(InstrumentedFeature, self).__init__()
2595
self.calls.append('_probe')
2597
feature = InstrumentedFeature()
2599
self.assertEqual(['_probe'], feature.calls)
2601
self.assertEqual(['_probe'], feature.calls)
2603
def test_named_str(self):
2604
"""Feature.__str__ should thunk to feature_name()."""
2605
class NamedFeature(tests.Feature):
2606
def feature_name(self):
2608
feature = NamedFeature()
2609
self.assertEqual('symlinks', str(feature))
2611
def test_default_str(self):
2612
"""Feature.__str__ should default to __class__.__name__."""
2613
class NamedFeature(tests.Feature):
2615
feature = NamedFeature()
2616
self.assertEqual('NamedFeature', str(feature))
2619
class TestUnavailableFeature(tests.TestCase):
2621
def test_access_feature(self):
2622
feature = tests.Feature()
2623
exception = tests.UnavailableFeature(feature)
2624
self.assertIs(feature, exception.args[0])
2627
simple_thunk_feature = tests._CompatabilityThunkFeature(
2628
deprecated_in((2, 1, 0)),
2629
'bzrlib.tests.test_selftest',
2630
'simple_thunk_feature','UnicodeFilename',
2631
replacement_module='bzrlib.tests'
2634
class Test_CompatibilityFeature(tests.TestCase):
2636
def test_does_thunk(self):
2637
res = self.callDeprecated(
2638
['bzrlib.tests.test_selftest.simple_thunk_feature was deprecated'
2639
' in version 2.1.0. Use bzrlib.tests.UnicodeFilename instead.'],
2640
simple_thunk_feature.available)
2641
self.assertEqual(tests.UnicodeFilename.available(), res)
2644
class TestModuleAvailableFeature(tests.TestCase):
2646
def test_available_module(self):
2647
feature = tests.ModuleAvailableFeature('bzrlib.tests')
2648
self.assertEqual('bzrlib.tests', feature.module_name)
2649
self.assertEqual('bzrlib.tests', str(feature))
2650
self.assertTrue(feature.available())
2651
self.assertIs(tests, feature.module)
2653
def test_unavailable_module(self):
2654
feature = tests.ModuleAvailableFeature('bzrlib.no_such_module_exists')
2655
self.assertEqual('bzrlib.no_such_module_exists', str(feature))
2656
self.assertFalse(feature.available())
2657
self.assertIs(None, feature.module)
2660
class TestSelftestFiltering(tests.TestCase):
2663
tests.TestCase.setUp(self)
2664
self.suite = TestUtil.TestSuite()
2665
self.loader = TestUtil.TestLoader()
2666
self.suite.addTest(self.loader.loadTestsFromModule(
2667
sys.modules['bzrlib.tests.test_selftest']))
2668
self.all_names = _test_ids(self.suite)
2670
def test_condition_id_re(self):
2671
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2672
'test_condition_id_re')
2673
filtered_suite = tests.filter_suite_by_condition(
2674
self.suite, tests.condition_id_re('test_condition_id_re'))
2675
self.assertEqual([test_name], _test_ids(filtered_suite))
2677
def test_condition_id_in_list(self):
2678
test_names = ['bzrlib.tests.test_selftest.TestSelftestFiltering.'
2679
'test_condition_id_in_list']
2680
id_list = tests.TestIdList(test_names)
2681
filtered_suite = tests.filter_suite_by_condition(
2682
self.suite, tests.condition_id_in_list(id_list))
2683
my_pattern = 'TestSelftestFiltering.*test_condition_id_in_list'
2684
re_filtered = tests.filter_suite_by_re(self.suite, my_pattern)
2685
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2687
def test_condition_id_startswith(self):
2688
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2689
start1 = klass + 'test_condition_id_starts'
2690
start2 = klass + 'test_condition_id_in'
2691
test_names = [ klass + 'test_condition_id_in_list',
2692
klass + 'test_condition_id_startswith',
2694
filtered_suite = tests.filter_suite_by_condition(
2695
self.suite, tests.condition_id_startswith([start1, start2]))
2696
self.assertEqual(test_names, _test_ids(filtered_suite))
2698
def test_condition_isinstance(self):
2699
filtered_suite = tests.filter_suite_by_condition(
2700
self.suite, tests.condition_isinstance(self.__class__))
2701
class_pattern = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2702
re_filtered = tests.filter_suite_by_re(self.suite, class_pattern)
2703
self.assertEqual(_test_ids(re_filtered), _test_ids(filtered_suite))
2705
def test_exclude_tests_by_condition(self):
2706
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2707
'test_exclude_tests_by_condition')
2708
filtered_suite = tests.exclude_tests_by_condition(self.suite,
2709
lambda x:x.id() == excluded_name)
2710
self.assertEqual(len(self.all_names) - 1,
2711
filtered_suite.countTestCases())
2712
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2713
remaining_names = list(self.all_names)
2714
remaining_names.remove(excluded_name)
2715
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2717
def test_exclude_tests_by_re(self):
2718
self.all_names = _test_ids(self.suite)
2719
filtered_suite = tests.exclude_tests_by_re(self.suite,
2720
'exclude_tests_by_re')
2721
excluded_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2722
'test_exclude_tests_by_re')
2723
self.assertEqual(len(self.all_names) - 1,
2724
filtered_suite.countTestCases())
2725
self.assertFalse(excluded_name in _test_ids(filtered_suite))
2726
remaining_names = list(self.all_names)
2727
remaining_names.remove(excluded_name)
2728
self.assertEqual(remaining_names, _test_ids(filtered_suite))
2730
def test_filter_suite_by_condition(self):
2731
test_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2732
'test_filter_suite_by_condition')
2733
filtered_suite = tests.filter_suite_by_condition(self.suite,
2734
lambda x:x.id() == test_name)
2735
self.assertEqual([test_name], _test_ids(filtered_suite))
2737
def test_filter_suite_by_re(self):
2738
filtered_suite = tests.filter_suite_by_re(self.suite,
2739
'test_filter_suite_by_r')
2740
filtered_names = _test_ids(filtered_suite)
2741
self.assertEqual(filtered_names, ['bzrlib.tests.test_selftest.'
2742
'TestSelftestFiltering.test_filter_suite_by_re'])
2744
def test_filter_suite_by_id_list(self):
2745
test_list = ['bzrlib.tests.test_selftest.'
2746
'TestSelftestFiltering.test_filter_suite_by_id_list']
2747
filtered_suite = tests.filter_suite_by_id_list(
2748
self.suite, tests.TestIdList(test_list))
2749
filtered_names = _test_ids(filtered_suite)
2752
['bzrlib.tests.test_selftest.'
2753
'TestSelftestFiltering.test_filter_suite_by_id_list'])
2755
def test_filter_suite_by_id_startswith(self):
2756
# By design this test may fail if another test is added whose name also
2757
# begins with one of the start value used.
2758
klass = 'bzrlib.tests.test_selftest.TestSelftestFiltering.'
2759
start1 = klass + 'test_filter_suite_by_id_starts'
2760
start2 = klass + 'test_filter_suite_by_id_li'
2761
test_list = [klass + 'test_filter_suite_by_id_list',
2762
klass + 'test_filter_suite_by_id_startswith',
2764
filtered_suite = tests.filter_suite_by_id_startswith(
2765
self.suite, [start1, start2])
2768
_test_ids(filtered_suite),
2771
def test_preserve_input(self):
2772
# NB: Surely this is something in the stdlib to do this?
2773
self.assertTrue(self.suite is tests.preserve_input(self.suite))
2774
self.assertTrue("@#$" is tests.preserve_input("@#$"))
2776
def test_randomize_suite(self):
2777
randomized_suite = tests.randomize_suite(self.suite)
2778
# randomizing should not add or remove test names.
2779
self.assertEqual(set(_test_ids(self.suite)),
2780
set(_test_ids(randomized_suite)))
2781
# Technically, this *can* fail, because random.shuffle(list) can be
2782
# equal to list. Trying multiple times just pushes the frequency back.
2783
# As its len(self.all_names)!:1, the failure frequency should be low
2784
# enough to ignore. RBC 20071021.
2785
# It should change the order.
2786
self.assertNotEqual(self.all_names, _test_ids(randomized_suite))
2787
# But not the length. (Possibly redundant with the set test, but not
2789
self.assertEqual(len(self.all_names), len(_test_ids(randomized_suite)))
2791
def test_split_suit_by_condition(self):
2792
self.all_names = _test_ids(self.suite)
2793
condition = tests.condition_id_re('test_filter_suite_by_r')
2794
split_suite = tests.split_suite_by_condition(self.suite, condition)
2795
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2796
'test_filter_suite_by_re')
2797
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2798
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2799
remaining_names = list(self.all_names)
2800
remaining_names.remove(filtered_name)
2801
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2803
def test_split_suit_by_re(self):
2804
self.all_names = _test_ids(self.suite)
2805
split_suite = tests.split_suite_by_re(self.suite,
2806
'test_filter_suite_by_r')
2807
filtered_name = ('bzrlib.tests.test_selftest.TestSelftestFiltering.'
2808
'test_filter_suite_by_re')
2809
self.assertEqual([filtered_name], _test_ids(split_suite[0]))
2810
self.assertFalse(filtered_name in _test_ids(split_suite[1]))
2811
remaining_names = list(self.all_names)
2812
remaining_names.remove(filtered_name)
2813
self.assertEqual(remaining_names, _test_ids(split_suite[1]))
2816
class TestCheckTreeShape(tests.TestCaseWithTransport):
2818
def test_check_tree_shape(self):
2819
files = ['a', 'b/', 'b/c']
2820
tree = self.make_branch_and_tree('.')
2821
self.build_tree(files)
2825
self.check_tree_shape(tree, files)
2830
class TestBlackboxSupport(tests.TestCase):
2831
"""Tests for testsuite blackbox features."""
2833
def test_run_bzr_failure_not_caught(self):
2834
# When we run bzr in blackbox mode, we want any unexpected errors to
2835
# propagate up to the test suite so that it can show the error in the
2836
# usual way, and we won't get a double traceback.
2837
e = self.assertRaises(
2839
self.run_bzr, ['assert-fail'])
2840
# make sure we got the real thing, not an error from somewhere else in
2841
# the test framework
2842
self.assertEquals('always fails', str(e))
2843
# check that there's no traceback in the test log
2844
self.assertNotContainsRe(self.get_log(), r'Traceback')
2846
def test_run_bzr_user_error_caught(self):
2847
# Running bzr in blackbox mode, normal/expected/user errors should be
2848
# caught in the regular way and turned into an error message plus exit
2850
transport_server = memory.MemoryServer()
2851
transport_server.start_server()
2852
self.addCleanup(transport_server.stop_server)
2853
url = transport_server.get_url()
2854
self.permit_url(url)
2855
out, err = self.run_bzr(["log", "%s/nonexistantpath" % url], retcode=3)
2856
self.assertEqual(out, '')
2857
self.assertContainsRe(err,
2858
'bzr: ERROR: Not a branch: ".*nonexistantpath/".\n')
2861
class TestTestLoader(tests.TestCase):
2862
"""Tests for the test loader."""
2864
def _get_loader_and_module(self):
2865
"""Gets a TestLoader and a module with one test in it."""
2866
loader = TestUtil.TestLoader()
2868
class Stub(tests.TestCase):
2871
class MyModule(object):
2873
MyModule.a_class = Stub
2875
return loader, module
2877
def test_module_no_load_tests_attribute_loads_classes(self):
2878
loader, module = self._get_loader_and_module()
2879
self.assertEqual(1, loader.loadTestsFromModule(module).countTestCases())
2881
def test_module_load_tests_attribute_gets_called(self):
2882
loader, module = self._get_loader_and_module()
2883
# 'self' is here because we're faking the module with a class. Regular
2884
# load_tests do not need that :)
2885
def load_tests(self, standard_tests, module, loader):
2886
result = loader.suiteClass()
2887
for test in tests.iter_suite_tests(standard_tests):
2888
result.addTests([test, test])
2890
# add a load_tests() method which multiplies the tests from the module.
2891
module.__class__.load_tests = load_tests
2892
self.assertEqual(2, loader.loadTestsFromModule(module).countTestCases())
2894
def test_load_tests_from_module_name_smoke_test(self):
2895
loader = TestUtil.TestLoader()
2896
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2897
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2900
def test_load_tests_from_module_name_with_bogus_module_name(self):
2901
loader = TestUtil.TestLoader()
2902
self.assertRaises(ImportError, loader.loadTestsFromModuleName, 'bogus')
2905
class TestTestIdList(tests.TestCase):
2907
def _create_id_list(self, test_list):
2908
return tests.TestIdList(test_list)
2910
def _create_suite(self, test_id_list):
2912
class Stub(tests.TestCase):
2916
def _create_test_id(id):
2919
suite = TestUtil.TestSuite()
2920
for id in test_id_list:
2921
t = Stub('test_foo')
2922
t.id = _create_test_id(id)
2926
def _test_ids(self, test_suite):
2927
"""Get the ids for the tests in a test suite."""
2928
return [t.id() for t in tests.iter_suite_tests(test_suite)]
2930
def test_empty_list(self):
2931
id_list = self._create_id_list([])
2932
self.assertEquals({}, id_list.tests)
2933
self.assertEquals({}, id_list.modules)
2935
def test_valid_list(self):
2936
id_list = self._create_id_list(
2937
['mod1.cl1.meth1', 'mod1.cl1.meth2',
2938
'mod1.func1', 'mod1.cl2.meth2',
2940
'mod1.submod2.cl1.meth1', 'mod1.submod2.cl2.meth2',
2942
self.assertTrue(id_list.refers_to('mod1'))
2943
self.assertTrue(id_list.refers_to('mod1.submod1'))
2944
self.assertTrue(id_list.refers_to('mod1.submod2'))
2945
self.assertTrue(id_list.includes('mod1.cl1.meth1'))
2946
self.assertTrue(id_list.includes('mod1.submod1'))
2947
self.assertTrue(id_list.includes('mod1.func1'))
2949
def test_bad_chars_in_params(self):
2950
id_list = self._create_id_list(['mod1.cl1.meth1(xx.yy)'])
2951
self.assertTrue(id_list.refers_to('mod1'))
2952
self.assertTrue(id_list.includes('mod1.cl1.meth1(xx.yy)'))
2954
def test_module_used(self):
2955
id_list = self._create_id_list(['mod.class.meth'])
2956
self.assertTrue(id_list.refers_to('mod'))
2957
self.assertTrue(id_list.refers_to('mod.class'))
2958
self.assertTrue(id_list.refers_to('mod.class.meth'))
2960
def test_test_suite_matches_id_list_with_unknown(self):
2961
loader = TestUtil.TestLoader()
2962
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2963
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',
2965
not_found, duplicates = tests.suite_matches_id_list(suite, test_list)
2966
self.assertEquals(['bogus'], not_found)
2967
self.assertEquals([], duplicates)
2969
def test_suite_matches_id_list_with_duplicates(self):
2970
loader = TestUtil.TestLoader()
2971
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
2972
dupes = loader.suiteClass()
2973
for test in tests.iter_suite_tests(suite):
2975
dupes.addTest(test) # Add it again
2977
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing',]
2978
not_found, duplicates = tests.suite_matches_id_list(
2980
self.assertEquals([], not_found)
2981
self.assertEquals(['bzrlib.tests.test_sampler.DemoTest.test_nothing'],
2985
class TestTestSuite(tests.TestCase):
2987
def test__test_suite_testmod_names(self):
2988
# Test that a plausible list of test module names are returned
2989
# by _test_suite_testmod_names.
2990
test_list = tests._test_suite_testmod_names()
2992
'bzrlib.tests.blackbox',
2993
'bzrlib.tests.per_transport',
2994
'bzrlib.tests.test_selftest',
2998
def test__test_suite_modules_to_doctest(self):
2999
# Test that a plausible list of modules to doctest is returned
3000
# by _test_suite_modules_to_doctest.
3001
test_list = tests._test_suite_modules_to_doctest()
3003
# When docstrings are stripped, there are no modules to doctest
3004
self.assertEqual([], test_list)
3011
def test_test_suite(self):
3012
# test_suite() loads the entire test suite to operate. To avoid this
3013
# overhead, and yet still be confident that things are happening,
3014
# we temporarily replace two functions used by test_suite with
3015
# test doubles that supply a few sample tests to load, and check they
3018
def testmod_names():
3019
calls.append("testmod_names")
3021
'bzrlib.tests.blackbox.test_branch',
3022
'bzrlib.tests.per_transport',
3023
'bzrlib.tests.test_selftest',
3025
self.overrideAttr(tests, '_test_suite_testmod_names', testmod_names)
3027
calls.append("modules_to_doctest")
3030
return ['bzrlib.timestamp']
3031
self.overrideAttr(tests, '_test_suite_modules_to_doctest', doctests)
3032
expected_test_list = [
3034
'bzrlib.tests.blackbox.test_branch.TestBranch.test_branch',
3035
('bzrlib.tests.per_transport.TransportTests'
3036
'.test_abspath(LocalTransport,LocalURLServer)'),
3037
'bzrlib.tests.test_selftest.TestTestSuite.test_test_suite',
3038
# plugins can't be tested that way since selftest may be run with
3041
if __doc__ is not None:
3042
expected_test_list.extend([
3043
# modules_to_doctest
3044
'bzrlib.timestamp.format_highres_date',
3046
suite = tests.test_suite()
3047
self.assertEqual(set(["testmod_names", "modules_to_doctest"]),
3049
self.assertSubset(expected_test_list, _test_ids(suite))
3051
def test_test_suite_list_and_start(self):
3052
# We cannot test this at the same time as the main load, because we want
3053
# to know that starting_with == None works. So a second load is
3054
# incurred - note that the starting_with parameter causes a partial load
3055
# rather than a full load so this test should be pretty quick.
3056
test_list = ['bzrlib.tests.test_selftest.TestTestSuite.test_test_suite']
3057
suite = tests.test_suite(test_list,
3058
['bzrlib.tests.test_selftest.TestTestSuite'])
3059
# test_test_suite_list_and_start is not included
3060
self.assertEquals(test_list, _test_ids(suite))
3063
class TestLoadTestIdList(tests.TestCaseInTempDir):
3065
def _create_test_list_file(self, file_name, content):
3066
fl = open(file_name, 'wt')
3070
def test_load_unknown(self):
3071
self.assertRaises(errors.NoSuchFile,
3072
tests.load_test_id_list, 'i_do_not_exist')
3074
def test_load_test_list(self):
3075
test_list_fname = 'test.list'
3076
self._create_test_list_file(test_list_fname,
3077
'mod1.cl1.meth1\nmod2.cl2.meth2\n')
3078
tlist = tests.load_test_id_list(test_list_fname)
3079
self.assertEquals(2, len(tlist))
3080
self.assertEquals('mod1.cl1.meth1', tlist[0])
3081
self.assertEquals('mod2.cl2.meth2', tlist[1])
3083
def test_load_dirty_file(self):
3084
test_list_fname = 'test.list'
3085
self._create_test_list_file(test_list_fname,
3086
' mod1.cl1.meth1\n\nmod2.cl2.meth2 \n'
3088
tlist = tests.load_test_id_list(test_list_fname)
3089
self.assertEquals(4, len(tlist))
3090
self.assertEquals('mod1.cl1.meth1', tlist[0])
3091
self.assertEquals('', tlist[1])
3092
self.assertEquals('mod2.cl2.meth2', tlist[2])
3093
self.assertEquals('bar baz', tlist[3])
3096
class TestFilteredByModuleTestLoader(tests.TestCase):
3098
def _create_loader(self, test_list):
3099
id_filter = tests.TestIdList(test_list)
3100
loader = TestUtil.FilteredByModuleTestLoader(id_filter.refers_to)
3103
def test_load_tests(self):
3104
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
3105
loader = self._create_loader(test_list)
3106
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3107
self.assertEquals(test_list, _test_ids(suite))
3109
def test_exclude_tests(self):
3110
test_list = ['bogus']
3111
loader = self._create_loader(test_list)
3112
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3113
self.assertEquals([], _test_ids(suite))
3116
class TestFilteredByNameStartTestLoader(tests.TestCase):
3118
def _create_loader(self, name_start):
3119
def needs_module(name):
3120
return name.startswith(name_start) or name_start.startswith(name)
3121
loader = TestUtil.FilteredByModuleTestLoader(needs_module)
3124
def test_load_tests(self):
3125
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
3126
loader = self._create_loader('bzrlib.tests.test_samp')
3128
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3129
self.assertEquals(test_list, _test_ids(suite))
3131
def test_load_tests_inside_module(self):
3132
test_list = ['bzrlib.tests.test_sampler.DemoTest.test_nothing']
3133
loader = self._create_loader('bzrlib.tests.test_sampler.Demo')
3135
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3136
self.assertEquals(test_list, _test_ids(suite))
3138
def test_exclude_tests(self):
3139
test_list = ['bogus']
3140
loader = self._create_loader('bogus')
3142
suite = loader.loadTestsFromModuleName('bzrlib.tests.test_sampler')
3143
self.assertEquals([], _test_ids(suite))
3146
class TestTestPrefixRegistry(tests.TestCase):
3148
def _get_registry(self):
3149
tp_registry = tests.TestPrefixAliasRegistry()
3152
def test_register_new_prefix(self):
3153
tpr = self._get_registry()
3154
tpr.register('foo', 'fff.ooo.ooo')
3155
self.assertEquals('fff.ooo.ooo', tpr.get('foo'))
3157
def test_register_existing_prefix(self):
3158
tpr = self._get_registry()
3159
tpr.register('bar', 'bbb.aaa.rrr')
3160
tpr.register('bar', 'bBB.aAA.rRR')
3161
self.assertEquals('bbb.aaa.rrr', tpr.get('bar'))
3162
self.assertThat(self.get_log(),
3163
DocTestMatches("...bar...bbb.aaa.rrr...BB.aAA.rRR",
3166
def test_get_unknown_prefix(self):
3167
tpr = self._get_registry()
3168
self.assertRaises(KeyError, tpr.get, 'I am not a prefix')
3170
def test_resolve_prefix(self):
3171
tpr = self._get_registry()
3172
tpr.register('bar', 'bb.aa.rr')
3173
self.assertEquals('bb.aa.rr', tpr.resolve_alias('bar'))
3175
def test_resolve_unknown_alias(self):
3176
tpr = self._get_registry()
3177
self.assertRaises(errors.BzrCommandError,
3178
tpr.resolve_alias, 'I am not a prefix')
3180
def test_predefined_prefixes(self):
3181
tpr = tests.test_prefix_alias_registry
3182
self.assertEquals('bzrlib', tpr.resolve_alias('bzrlib'))
3183
self.assertEquals('bzrlib.doc', tpr.resolve_alias('bd'))
3184
self.assertEquals('bzrlib.utils', tpr.resolve_alias('bu'))
3185
self.assertEquals('bzrlib.tests', tpr.resolve_alias('bt'))
3186
self.assertEquals('bzrlib.tests.blackbox', tpr.resolve_alias('bb'))
3187
self.assertEquals('bzrlib.plugins', tpr.resolve_alias('bp'))
3190
class TestThreadLeakDetection(tests.TestCase):
3191
"""Ensure when tests leak threads we detect and report it"""
3193
class LeakRecordingResult(tests.ExtendedTestResult):
3195
tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
3197
def _report_thread_leak(self, test, leaks, alive):
3198
self.leaks.append((test, leaks))
3200
def test_testcase_without_addCleanups(self):
3201
"""Check old TestCase instances don't break with leak detection"""
3202
class Test(unittest.TestCase):
3205
result = self.LeakRecordingResult()
3207
result.startTestRun()
3209
result.stopTestRun()
3210
self.assertEqual(result._tests_leaking_threads_count, 0)
3211
self.assertEqual(result.leaks, [])
3213
def test_thread_leak(self):
3214
"""Ensure a thread that outlives the running of a test is reported
3216
Uses a thread that blocks on an event, and is started by the inner
3217
test case. As the thread outlives the inner case's run, it should be
3218
detected as a leak, but the event is then set so that the thread can
3219
be safely joined in cleanup so it's not leaked for real.
3221
event = threading.Event()
3222
thread = threading.Thread(name="Leaker", target=event.wait)
3223
class Test(tests.TestCase):
3224
def test_leak(self):
3226
result = self.LeakRecordingResult()
3227
test = Test("test_leak")
3228
self.addCleanup(thread.join)
3229
self.addCleanup(event.set)
3230
result.startTestRun()
3232
result.stopTestRun()
3233
self.assertEqual(result._tests_leaking_threads_count, 1)
3234
self.assertEqual(result._first_thread_leaker_id, test.id())
3235
self.assertEqual(result.leaks, [(test, set([thread]))])
3236
self.assertContainsString(result.stream.getvalue(), "leaking threads")
3238
def test_multiple_leaks(self):
3239
"""Check multiple leaks are blamed on the test cases at fault
3241
Same concept as the previous test, but has one inner test method that
3242
leaks two threads, and one that doesn't leak at all.
3244
event = threading.Event()
3245
thread_a = threading.Thread(name="LeakerA", target=event.wait)
3246
thread_b = threading.Thread(name="LeakerB", target=event.wait)
3247
thread_c = threading.Thread(name="LeakerC", target=event.wait)
3248
class Test(tests.TestCase):
3249
def test_first_leak(self):
3251
def test_second_no_leak(self):
3253
def test_third_leak(self):
3256
result = self.LeakRecordingResult()
3257
first_test = Test("test_first_leak")
3258
third_test = Test("test_third_leak")
3259
self.addCleanup(thread_a.join)
3260
self.addCleanup(thread_b.join)
3261
self.addCleanup(thread_c.join)
3262
self.addCleanup(event.set)
3263
result.startTestRun()
3265
[first_test, Test("test_second_no_leak"), third_test]
3267
result.stopTestRun()
3268
self.assertEqual(result._tests_leaking_threads_count, 2)
3269
self.assertEqual(result._first_thread_leaker_id, first_test.id())
3270
self.assertEqual(result.leaks, [
3271
(first_test, set([thread_b])),
3272
(third_test, set([thread_a, thread_c]))])
3273
self.assertContainsString(result.stream.getvalue(), "leaking threads")
3276
class TestPostMortemDebugging(tests.TestCase):
3277
"""Check post mortem debugging works when tests fail or error"""
3279
class TracebackRecordingResult(tests.ExtendedTestResult):
3281
tests.ExtendedTestResult.__init__(self, StringIO(), 0, 1)
3282
self.postcode = None
3283
def _post_mortem(self, tb=None):
3284
"""Record the code object at the end of the current traceback"""
3285
tb = tb or sys.exc_info()[2]
3288
while next is not None:
3291
self.postcode = tb.tb_frame.f_code
3292
def report_error(self, test, err):
3294
def report_failure(self, test, err):
3297
def test_location_unittest_error(self):
3298
"""Needs right post mortem traceback with erroring unittest case"""
3299
class Test(unittest.TestCase):
3302
result = self.TracebackRecordingResult()
3304
self.assertEqual(result.postcode, Test.runTest.func_code)
3306
def test_location_unittest_failure(self):
3307
"""Needs right post mortem traceback with failing unittest case"""
3308
class Test(unittest.TestCase):
3310
raise self.failureException
3311
result = self.TracebackRecordingResult()
3313
self.assertEqual(result.postcode, Test.runTest.func_code)
3315
def test_location_bt_error(self):
3316
"""Needs right post mortem traceback with erroring bzrlib.tests case"""
3317
class Test(tests.TestCase):
3318
def test_error(self):
3320
result = self.TracebackRecordingResult()
3321
Test("test_error").run(result)
3322
self.assertEqual(result.postcode, Test.test_error.func_code)
3324
def test_location_bt_failure(self):
3325
"""Needs right post mortem traceback with failing bzrlib.tests case"""
3326
class Test(tests.TestCase):
3327
def test_failure(self):
3328
raise self.failureException
3329
result = self.TracebackRecordingResult()
3330
Test("test_failure").run(result)
3331
self.assertEqual(result.postcode, Test.test_failure.func_code)
3333
def test_env_var_triggers_post_mortem(self):
3334
"""Check pdb.post_mortem is called iff BZR_TEST_PDB is set"""
3336
result = tests.ExtendedTestResult(StringIO(), 0, 1)
3337
post_mortem_calls = []
3338
self.overrideAttr(pdb, "post_mortem", post_mortem_calls.append)
3339
self.overrideEnv('BZR_TEST_PDB', None)
3340
result._post_mortem(1)
3341
self.overrideEnv('BZR_TEST_PDB', 'on')
3342
result._post_mortem(2)
3343
self.assertEqual([2], post_mortem_calls)
3346
class TestRunSuite(tests.TestCase):
3348
def test_runner_class(self):
3349
"""run_suite accepts and uses a runner_class keyword argument."""
3350
class Stub(tests.TestCase):
3353
suite = Stub("test_foo")
3355
class MyRunner(tests.TextTestRunner):
3356
def run(self, test):
3358
return tests.ExtendedTestResult(self.stream, self.descriptions,
3360
tests.run_suite(suite, runner_class=MyRunner, stream=StringIO())
3361
self.assertLength(1, calls)
3364
class TestEnvironHandling(tests.TestCase):
3366
def test_overrideEnv_None_called_twice_doesnt_leak(self):
3367
self.assertFalse('MYVAR' in os.environ)
3368
self.overrideEnv('MYVAR', '42')
3369
# We use an embedded test to make sure we fix the _captureVar bug
3370
class Test(tests.TestCase):
3372
# The first call save the 42 value
3373
self.overrideEnv('MYVAR', None)
3374
self.assertEquals(None, os.environ.get('MYVAR'))
3375
# Make sure we can call it twice
3376
self.overrideEnv('MYVAR', None)
3377
self.assertEquals(None, os.environ.get('MYVAR'))
3379
result = tests.TextTestResult(output, 0, 1)
3380
Test('test_me').run(result)
3381
if not result.wasStrictlySuccessful():
3382
self.fail(output.getvalue())
3383
# We get our value back
3384
self.assertEquals('42', os.environ.get('MYVAR'))
3387
class TestIsolatedEnv(tests.TestCase):
3388
"""Test isolating tests from os.environ.
3390
Since we use tests that are already isolated from os.environ a bit of care
3391
should be taken when designing the tests to avoid bootstrap side-effects.
3392
The tests start an already clean os.environ which allow doing valid
3393
assertions about which variables are present or not and design tests around
3397
class ScratchMonkey(tests.TestCase):
3402
def test_basics(self):
3403
# Make sure we know the definition of BZR_HOME: not part of os.environ
3404
# for tests.TestCase.
3405
self.assertTrue('BZR_HOME' in tests.isolated_environ)
3406
self.assertEquals(None, tests.isolated_environ['BZR_HOME'])
3407
# Being part of isolated_environ, BZR_HOME should not appear here
3408
self.assertFalse('BZR_HOME' in os.environ)
3409
# Make sure we know the definition of LINES: part of os.environ for
3411
self.assertTrue('LINES' in tests.isolated_environ)
3412
self.assertEquals('25', tests.isolated_environ['LINES'])
3413
self.assertEquals('25', os.environ['LINES'])
3415
def test_injecting_unknown_variable(self):
3416
# BZR_HOME is known to be absent from os.environ
3417
test = self.ScratchMonkey('test_me')
3418
tests.override_os_environ(test, {'BZR_HOME': 'foo'})
3419
self.assertEquals('foo', os.environ['BZR_HOME'])
3420
tests.restore_os_environ(test)
3421
self.assertFalse('BZR_HOME' in os.environ)
3423
def test_injecting_known_variable(self):
3424
test = self.ScratchMonkey('test_me')
3425
# LINES is known to be present in os.environ
3426
tests.override_os_environ(test, {'LINES': '42'})
3427
self.assertEquals('42', os.environ['LINES'])
3428
tests.restore_os_environ(test)
3429
self.assertEquals('25', os.environ['LINES'])
3431
def test_deleting_variable(self):
3432
test = self.ScratchMonkey('test_me')
3433
# LINES is known to be present in os.environ
3434
tests.override_os_environ(test, {'LINES': None})
3435
self.assertTrue('LINES' not in os.environ)
3436
tests.restore_os_environ(test)
3437
self.assertEquals('25', os.environ['LINES'])
3440
class TestDocTestSuiteIsolation(tests.TestCase):
3441
"""Test that `tests.DocTestSuite` isolates doc tests from os.environ.
3443
Since tests.TestCase alreay provides an isolation from os.environ, we use
3444
the clean environment as a base for testing. To precisely capture the
3445
isolation provided by tests.DocTestSuite, we use doctest.DocTestSuite to
3448
We want to make sure `tests.DocTestSuite` respect `tests.isolated_environ`,
3449
not `os.environ` so each test overrides it to suit its needs.
3453
def get_doctest_suite_for_string(self, klass, string):
3454
class Finder(doctest.DocTestFinder):
3456
def find(*args, **kwargs):
3457
test = doctest.DocTestParser().get_doctest(
3458
string, {}, 'foo', 'foo.py', 0)
3461
suite = klass(test_finder=Finder())
3464
def run_doctest_suite_for_string(self, klass, string):
3465
suite = self.get_doctest_suite_for_string(klass, string)
3467
result = tests.TextTestResult(output, 0, 1)
3469
return result, output
3471
def assertDocTestStringSucceds(self, klass, string):
3472
result, output = self.run_doctest_suite_for_string(klass, string)
3473
if not result.wasStrictlySuccessful():
3474
self.fail(output.getvalue())
3476
def assertDocTestStringFails(self, klass, string):
3477
result, output = self.run_doctest_suite_for_string(klass, string)
3478
if result.wasStrictlySuccessful():
3479
self.fail(output.getvalue())
3481
def test_injected_variable(self):
3482
self.overrideAttr(tests, 'isolated_environ', {'LINES': '42'})
3485
>>> os.environ['LINES']
3488
# doctest.DocTestSuite fails as it sees '25'
3489
self.assertDocTestStringFails(doctest.DocTestSuite, test)
3490
# tests.DocTestSuite sees '42'
3491
self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
3493
def test_deleted_variable(self):
3494
self.overrideAttr(tests, 'isolated_environ', {'LINES': None})
3497
>>> os.environ.get('LINES')
3499
# doctest.DocTestSuite fails as it sees '25'
3500
self.assertDocTestStringFails(doctest.DocTestSuite, test)
3501
# tests.DocTestSuite sees None
3502
self.assertDocTestStringSucceds(tests.IsolatedDocTestSuite, test)
added
removed
bzrlib/tests/test_selftest.py
